機能:マッピング管理

connect for Pleasanter機能

connect for Pleasanterのマッピング管理ついて説明します。

概要

  • connect for Pleasanter」のマッピング管理は、外部サービスからPleasanterへデータ同期を行うために必要な情報を以下管理サイトに設定します。
  • CFP基本設定管理サイト:PleasanterのAPIキー・エラー通知先等を管理
  • CFPサービス管理サイト:外部サイトのREST API情報等を管理
  • CFPマッピング管理サイト:外部サイト項目とPleasanter項目のマッピング情報等を管理

CFP基本設定管理サイト

  • PleasanterのAPIキー等を管理するためサイトのアクセス制御はシステム管理者等に限定してください
項目名備考
状況Status・本データを使用してデータ連携を行う場合は「900:使用中」を選択します
・使用しない場合は「100:未使用」を選択してください
基本設定名Title・本データの名前を設定してください
 例:connect for Pleasanter基本情報
APIキーDescriptionA・PleasanterのAPIキーを設定します
・APIキーの作成方法は開発者向け機能:API:APIキーの作成を参照してください
UTCオフセットNumA・協定世界時(UTC)と各地域のローカル時刻との時差(ズレ)を表す値を設定してください
・JST(日本時間)なら9を設定してください
Slack通知URLDescriptionB・エラー時のSlack通知URLを設定してください
・未設定の場合はSlack通知は行いません
Slackに通知できるように設定するを参照してください
パラメータ設定:Notification.jsonを参照してください
・メールアドレスDescriptionC・エラー時に通知するメールアドレスを設定してください
・未設定の場合はメール送信は行いません
プリザンターからメールを送信できるように設定するを参照して下さい
項目名備考

CFPサービス管理サイト

  • 外部サイトのAPI仕様を参照し設定してください
  • リクエスト情報に認証情報等を管理するためサイトのアクセス制御はシステム管理者等に限定してください
項目名備考
CFP基本設定管理ClassA・CFP基本設定管理情報を選択してください
 例:connect for Pleasanter基本情報
状況Status・本データを使用してデータ連携を行う場合は「900:使用中」を選択します
・使用しない場合は「100:未使用」を選択してください
サービス名Title・データ連携先のサービス名を設定します
 例:Salesforce
認証タイプClassB・外部サービスの認証タイプを選択してください
 例:OAuth2_Password
BaseURLDescriptionA・ベースURLを設定してください
 例:https://login.salesforce.com
リクエスト情報DescriptionB・ヘッダー、認証情報等をJSONで設定してください
例:SalesforceのOAuth2_Passwordの場合
{
 "auth": {
  "clientId": "Salesforceのコンシューマ鍵",
  "clientSecret": "Salesforceのコンシューマの秘密",
  "username": "Salesforceのログインユーザー名",
  "password": "ログインパスワード",
  "securityToken": "セキュリティトークン"
 },
 "headers": {
  "Content-Type": "application/json"
 }
}
項目名備考

CFPマッピング管理サイト

  • レスポンスに影響する制御情報等を管理するためサイトのアクセス制御はシステム管理者等に限定してください
項目名備考
CFPサービス管理ClassA・CFPサービス管理を選択してください
 例:Salesforce
状況Status・本データを使用してデータ連携を行う場合は「900:使用中」を選択します
・使用しない場合は「100:未使用」を選択してください
マッピング名Title・マッピング名を設定します
 例:取引先
取得対象リソースClassB・エンドポイント / テーブル名 / パス等の取得対象リソースを設定してください
 例:Account
最大取得ページ数NumB・タイムアウト保護機能として、外部サイトからのデータ取得処理を制御します
・最大取得ページ数に0を設定すると無制限(上限なし)でデータを取得します
・例1:最大取得ページ数:1、リクエスト情報のpar_page:100の場合、100件超のデータが存在しても100件取得して処理を終了します
・例2:最大取得ページ数:2、リクエスト情報のpar_page:100の場合、200件取得して処理を終了します
・例3:最大取得ページ数:1、リクエスト情報のpar_pageがない場合、デフォルトの件数を取得して処理を終了します
・例4:最大取得ページ数:0、リクエスト情報のpar_page:100の場合、全データを取得しますがタイムアウトになる可能性があります
※スケジュール同期(テナント管理>サーバースクリプト)、オンデマンド同期(サイト>テーブルの管理>サーバースクリプト)のタイムアウトをエンドポイント単位に適切な値を設定したうえで最大取得ページ数を設定してください
PleasanterサイトIDNumA・連携先のPleasanterサイトIDを設定してください
 例:1234
※サイトIDは「サイト機能:サイト設定の閲覧と変更」を参照してください
マッピング情報DescriptionA・外部サイト項目とPleasanterサイト項目のマッピング情報をJSONで設定してください
例:SalesforceのAccountとPleasanterの取引先サイト
{ "Id": "ClassZ", "Name": "Title", "Account_Furigana__c": "ClassA", "Account_Ryaku__c": "ClassC", "Type": "ClassD", "Industry": "ClassE", "Industry_Classification__c": "ClassX",・・・ }
プライマリーキーDescriptionB・重複キーをJSONで設定してください
例:SalesforceのAccountの重複キー「Id」にマッピングされてるPleasanterの取引先サイトの「ClassZ」
[ "ClassZ" ]
※複合キーの場合はカンマ区切りで複数指定してください
更新処理件数NumC・一括更新API実行時の1更新辺りの処理件数を設定してください
・デフォルトは100件です
・「パラメータ設定:General.json」の「BulkUpsertMax」で設定した値以下で設定してください
・一括更新API方式(BulkUpsert)は開発者向け機能:API:テーブル操作:レコード一括作成・更新を参照してください
・外部サービス連携先のAPIコール数以下で設定してください
 例:Salesforceの場合、API 要求の制限と割り当てを参照してください
※スケジュール同期(テナント管理>サーバースクリプト)、オンデマンド同期(サイト>テーブルの管理>サーバースクリプト)のタイムアウトをエンドポイント単位に適切な値を設定したうえで更新処理件数を設定してください
前回結果ステータスDescriptionC・データ同期結果が設定されます
・DONE_999:処理完了_999件更新済
・MORE_999:処理中断_999件更新済(最大取得ページ数に達したため処理中断)
・EMPTY_0:更新データなし
・ERROR:エラー発生
前回処理時間DescriptionD・データ同期処理時間が設定されます
・Total:処理時間
・Fetch:データ取得時間 (取得件数)
・Upsert:データ更新時間(更新処理件数)
・Timestamp:処理開始時間 (JST)
※タイムアウト値やデータ取得・更新パラメータのチューニングに活用
前回同期日時DateA・Open-Meteo API等の更新日時を持たない場合はオペレーション日時が設定されます
・Salesforce等の更新日時を持つ場合は、同期したデータの中で最新データの更新日時が設定されます
・次回の同期時に、本前回同期日時を基準に差分データ(新規・更新分)を取得します
・全件取得する場合は日付をクリアしてください
・日付をクリアした場合は「2000/1/1/ 00:00:00」からデータを取得します
・なお、オンデマンド同期は、本前回同期日時をデータ取得開始日時としてデフォルト表示します
・データ取得開始日時をクリアした場合も「2000/1/1/ 00:00:00」からデータを取得します
・「2000/1/1/ 00:00:00」以前のデータを取得したい場合は日時を指定してください
項目名備考

お問い合わせ

「connect for Pleasanter」のデモや製品に関するお問合せはお気軽にご相談ください。

タイトルとURLをコピーしました