データ読み取り(子→親リレーション)処理

オペレーション名

データ読み取り(子→親リレーション)

機能概要

SOQL(Sforce Object Query Language)を用いてデータを読み取ります。
データの読み取りの際、子オブジェクトから見た親オブジェクトの項目を「リレーション名.リレーション先項目名」の形式で1階層上のオブジェクトまで取得することができます。
また、スキーマ定義にて選択した項目に集計関数を用いることができ、集計条件(GROUP BY句など)を合わせて指定することで、集計条件に基づいた集計関数の結果を取得することができます。

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

データモデル

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

プロパティ

基本設定

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

必須設定

項目名 必須/省略可 変数の使用 説明 補足
接続先 必須 使用不可 グローバルリソースを選択します。
グローバルリソースの設定方法については「グローバルリソースのプロパティ」を参照してください。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」プロパティにて、グローバルリソースの設定を編集することができます。
  • 以下のAPIが使用可能です。
    • API18.0
テーブル名 必須 使用不可 Salesforceのテーブル名を選択します。  
SQL(検索条件) 省略可 使用可 [テーブル名]で選択を行ったテーブルに対する検索条件(Where文)を指定します。
  • 構文の詳細については、Salesforce APIドキュメントを参照してください。
スキーマ定義 必須
-
Salesforceから読み取りを行う項目を設定します。
  • 後続の処理で必要となる項目に限定(不要な項目をスキーマ定義から除く)することにより、処理効率が向上します。
スキーマ定義/ラベル 必須 使用不可 [テーブル名]で指定したテーブルの列、または親テーブルの列のラベル名を表示します。  
スキーマ定義/API 必須 使用不可 [テーブル名]で指定したテーブルの列、または親テーブルの列のAPI名を表示します。  
スキーマ定義/型 必須 使用不可 [テーブル名]で指定したテーブルの列、または親テーブルの列のデータ型を表示します。  
スキーマ定義/関数 必須 使用不可 [テーブル名]で指定したテーブルの列、または親テーブルの列に集計関数を指定できます。
  • SUM関数の場合「SUM」、MAX関数の場合「MAX」のように設定します。
  • SUM関数やAVG関数などの集計結果が数値の精度を越える場合、値が正しく取得できないことがあります。
集計条件 省略可 使用可 [テーブル名]で選択を行ったテーブル、または親テーブルに対して集計を行う場合の集計条件(GROUP BY句など)を指定します。
  • 構文の詳細については、Salesforce APIドキュメントを参照してください。
プロパティアクション
項目名 説明 補足
SQLの作成 [テーブル名]で選択したテーブルに対する検索条件の指定をサポートします。
設定方法については、「SQLの作成」を参照してください。
 
スキーマの作成 Salesforceから読み取りを行う項目の追加・削除を行うことができます。
設定方法については、「スキーマの作成」を参照してください。
 

オプション設定

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

データ処理方式

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

コメント

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

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

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

SQLの作成

テーブル読み取り(子→親リレーション)処理では、Salesforceから読み取るデータの抽出条件を指定することができます。

スキーマの作成

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

テーブル情報の表示

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