データ読み取り(SOQL実行)処理(旧)
オペレーション名
データ読み取り(SOQL実行)
機能概要
SOAP API の query() または、queryAll() を使用してデータを読み取ります。
SOQL(Sforce Object Query Language)を直接記述することが可能です。
そのため、SOQLの構文の記述方法について理解している必要があります。
本コンポーネントが使用するAPI仕様については、コネクションリソースで選択したバージョンのAPIドキュメントを以下のリンク先ページより参照してください。
-
「Salesforce Developer Documentation」-(https://developer.salesforce.com/docs)
-
SOAP API Developer's Guide
-
Force.com SOQL and SOSL Reference
-
データモデル
本コンポーネントのデータモデルはプロパティの内容により、テーブルモデル型またはXML型となります。
プロパティ
変数の使用については、「変数」を参照してください。
基本設定
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
名前 |
必須 |
使用不可 |
スクリプトキャンバス上での名前を入力します。 |
|
必須設定
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
接続先 |
必須 |
使用不可 |
コネクションリソースを選択します。
|
|
|
SOQL |
必須 |
使用可 |
Salesforceへ発行するSOQL文を入力します。 |
|
|
スキーマ定義 |
必須 |
- |
発行したSOQLのレスポンスから取得するスキーマを設定します。 各列は以下のボタンで操作することができます。
|
|
|
スキーマ定義/ラベル |
必須 |
使用可 |
SOQLのレスポンスから取得するスキーマ名を入力します。 通常、SELECT句に指定した項目名を入力します。 |
注意
|
|
スキーマ定義/API |
省略可 |
使用可 |
スキーマのAPI名を入力します。 |
|
|
スキーマ定義/型 |
必須 |
使用不可 |
スキーマのデータ型を選択します。 |
注意
選択された型への変換に失敗する場合、実行時に例外が発生します。
|
> プロパティアクション
|
項目名 |
説明 |
備考 |
|---|---|---|
|
抽出テスト |
入力したSOQLを実行します。結果として取得した件数が表示されます。 |
|
|
入力したSOQLを実行してレスポンスから情報を読み取り、[スキーマ定義]に設定します。 |
注意
|
オプション設定
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
削除レコードの読み取り |
必須 |
- |
Salesforceから削除されたデータを読み取るかどうかを設定します。 (読み取りする場合、queryAllサービスを用いた読み取りを行います。)
|
注意
データ読み取り(クエリー)による削除レコード読み取り処理では、ゴミ箱から削除されたデータが削除後も24時間前後読み取られることがありますのでご注意ください。 |
|
バッチサイズ |
必須 |
使用可 |
Salesforceからのデータ読み取り結果を取得する際のバッチサイズを入力します。 |
注意
SalesforceのAPI仕様として、10,000件のデータを読み取るケースで、バッチサイズを2000と設定した場合、データ結果セットを5回に分けて取得します。 |
コメント
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
コメント |
省略可 |
使用不可 |
このコネクターの簡単な説明を記述することができます。 |
|
ありません。
[スキーマ定義]の設定により、データモデル型が異なります。
-
親-子リレーションを使用しない場合
テーブルモデル型となります。
= 備考 =スキーマ構造については、「テーブルモデル型 」を参照してください。
-
親-子リレーションを使用する場合
XML型となります。
大容量データ処理
大容量データ処理に対応していません。
PSPでの使用について
PSPでは使用できません。
使用できるコンポーネント変数
|
コンポーネント変数名 |
説明 |
備考 |
|---|---|---|
|
count |
読み取ったデータの件数が格納されます。 |
|
|
object_name |
読み取ったオブジェクト名が格納されます。 |
注意
|
|
server_url |
ログイン後のエンドポイントURLが格納されます。 |
|
|
session_id |
セッションIDが格納されます。 |
|
|
message_category |
エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。 |
|
|
message_code |
エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。 |
|
|
message_level |
エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。 |
|
|
operation_api_exception_code |
APIエラー発生時、発生したエラーのExceptionCodeが格納されます。 |
|
|
operation_error_message |
エラー発生時、発生したエラーのメッセージが格納されます。 |
|
|
operation_error_trace |
エラー発生時、発生したエラーのトレース情報が格納されます。 |
|
メッセージコード、例外メッセージ、制限事項
|
コネクター |
メッセージコード |
エラーメッセージ |
制限事項 |
|---|---|---|---|
|
|
|
|
