データ読み取り(レプリケーション)処理

オペレーション名

データ読み取り(レプリケーション)

機能概要

getUpdated、getDeletedサービスを使用してデータを読み取ります。
getUpdated、getDeletedサービスは、Salesforceである期間内に追加、修正、削除されたデータの読み取りを行うサービスです。

本オペレーションが使用するSalesforceのAPI仕様については、以下のドキュメント(英語)を参照してください。
Standalone版では使用できません。

データモデル

本コンポーネントのデータモデルはテーブルモデル型です。
入出力のスキーマについては「テーブルモデル型のスキーマ」を参照してください。

プロパティ

基本設定

項目名 必須/省略可 変数の使用 説明 補足
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  

必須設定

項目名 必須/省略可 変数の使用 説明 補足
接続先 必須 使用不可 グローバルリソースを選択します。
グローバルリソースの設定方法については「グローバルリソースのプロパティ」を参照してください。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」プロパティにて、グローバルリソースの設定を編集することができます。
  • 以下のAPIが使用可能です。
    • API7.0
    • API14.0
    • API18.0
テーブル名 必須 使用不可 Salesforceのテーブル名を選択します。  
レプリケーション対象 必須 使用不可 レプリケーション対象を選択します。
  • [追加・更新データ]:(デフォルト)
    最終更新日タブで指定した期間内に追加・更新されたデータを読み取ります。
  • [削除データ]:
    最終更新日タブで指定した期間内に削除されたデータを読み取ります。
 
スキーマ定義 必須
-
Salesforceから読み取りを行う項目を設定します。
  • [レプリケーション対象][削除データ]を選択した場合、スキーマ定義は固定値になります。
  • 後続の処理で必要となる項目に限定(不要な項目をスキーマ定義から除く)することにより、処理効率が向上します。
スキーマ定義/ラベル 必須 使用不可 [テーブル名]で指定したテーブルの列のラベル名を表示します。  
スキーマ定義/API 必須 使用不可 [テーブル名]で指定したテーブルの列のAPI名を表示します。  
スキーマ定義/型 必須 使用不可 [テーブル名]で指定したテーブルの列のデータ型を表示します。  
プロパティアクション
項目名 説明 補足
スキーマの作成 Salesforceから読み取りを行う項目の追加・削除を行うことができます。
設定方法については、「スキーマの作成」を参照してください。
 

オプション設定

項目名 必須/省略可 変数の使用 説明 補足
カラム名タイプ 必須 使用不可 マッピングでスキーマを表示する際のカラム名の表示タイプを選択します。
  • [ラベル]:
    Salesforceで定義されたラベル名(項目名)で表示します。
  • [API]:(デフォルト)
    Salesforceで定義されたAPI参照名で表示します。
 
クエリーバッチサイズ 必須 使用可 Salesforceからのデータ読み取り結果を取得する際のバッチサイズを入力します。
  • [レプリケーション対象][追加・更新データ]が選択されている場合に使用されます。
  • デフォルト値は「2000」です。
  • 「1」以上「2000」以下が値が指定できます。範囲以外の値が指定された場合、例外をスローします。
  • 使用環境によりますが、一般的にバッチサイズを大きくすることにより、データの読み取り効率は向上します。
  • SalesforceのAPI仕様として、10,000件のデータを読み取るケースで、バッチサイズを2000と設定した場合、データ結果セットを5回に分けて取得します。
プロパティアクション
項目名 説明 補足
テーブル情報の表示 [接続先]で選択されているSalesforceのテーブル構造を確認できます。
テーブル構造の参照方法については、「テーブル情報の表示」を参照してください。
 

最終更新日

項目名 必須/省略可 変数の使用 説明 補足
最終更新日From 必須 使用可 Salesforceで追加・更新、または削除された日時の範囲を入力します。
  • API仕様により、30日を超える日時の指定はできません。
  • 30日を越えた日時が指定された場合、例外がスローされます。
最終更新日To 必須 使用可 Salesforceで追加・更新、または削除された日時の範囲を入力します。  

データ処理方式

項目名 必須/省略可 変数の使用 説明 補足
データ処理方式 必須 使用不可 データ処理方式を選択します。
  • [スクリプトの設定を使用する]:(デフォルト)
    スクリプトプロパティの大容量データ処理の設定をアダプタに使用します。
  • [大容量データ処理を行わない]:
    大容量データ処理を行いません。
  • [大容量データ処理を行う]:
    大容量データ処理を行います。
 

コメント

項目名 必須/省略可 変数の使用 説明 補足
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。
 

使用できるコンポーネント変数

コンポーネント変数名 説明
count Salesforceから読み取りを行ったデータの行数を返します。
operation_api_exception_code APIエラーが発生したときに、ExceptionCodeを返します。
APIエラー以外のエラーが発生した場合にはnullを返します。
バージョンにより、内容が変わる可能性があります。
operation_error_message エラーが発生したときのエラーメッセージを返します。
バージョンにより、内容が変わる可能性があります。
operation_error_trace エラーが発生したときのトレース情報を返します。
バージョンにより、内容が変わる可能性があります。

スキーマの作成

Salesforceから読み取りを行うデータ項目、または書き込みを行うデータ項目をスキーマの作成で指定することができます。
処理に必要な項目のみを指定することにより、Salesforceに対する通信データ量を削減することができ、一般的に処理効率が向上します。

テーブル情報の表示

Salesforceのテーブルに対する操作可能な処理、およびテーブルのフィールド属性を確認することができます。
また、フィールド情報については、印刷することも可能です。