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

オペレーション名

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

機能概要

SOAP API の query() または、queryAll() を使用してデータを読み取ります。

 

抽出条件は、SOQL(Sforce Object Query Language)で指定しますが、本コンポーネントではSOQLを直接記述することなく設定することが可能です。

ただし、WHERE句以降については直接記述することができます。

 

本コンポーネントでは、子-親リレーション(child-to-parent relationships)および、関数を使用することができます。

子オブジェクトから見た親オブジェクトの項目を「リレーション名.リレーション先項目名」の形式で1階層上のオブジェクトまで取得することができます。

また、スキーマ定義で選択した項目に関数を指定することができ、集計条件(GROUP BY句など)を合わせて指定することで、集計条件に基づいた関数の結果を取得することができます。

注意

親-子リレーション、2階層以上の子-親リレーションは使用することができません。

 

= 備考 =

本コンポーネントが使用するAPI仕様については、コネクションリソースで選択したバージョンのAPIドキュメントを以下のリンク先ページより参照してください。

  • 「Salesforce Developer Documentation」-(https://developer.salesforce.com/docs)

    • SOAP API Developer's Guide

    • Force.com SOQL and SOSL Reference

データモデル

本コンポーネントのデータモデルはテーブルモデル型です。

プロパティ

= 備考 =

変数の使用については、「変数」を参照してください。

基本設定

項目名

必須/省略可

変数の使用

説明

備考

名前

必須

使用不可

スクリプトキャンバス上での名前を入力します。

 

必須設定

項目名

必須/省略可

変数の使用

説明

備考

接続先

必須

使用不可

コネクションリソースを選択します。

[追加]

新規にコネクションリソースを追加します。

[一覧の編集]

> HULFT INTEGRATE > コネクションで、コネクションリソースの設定を編集することができます。

  • API 18.0以降のコネクションリソースが選択可能です。

テーブル名

必須

使用不可

Salesforceのテーブル名を選択します。

 

項目一覧テーブル絞込

必須

使用不可

[テーブル名]で選択したSalesforceテーブル(オブジェクト)から参照可能なリレーションオブジェクト名を選択します。

 

ソート

必須

使用不可

項目一覧を選択した方法で並び替えます。

[選択昇順]
[選択降順]
[ラベル昇順]
[ラベル降順]
[API昇順]

(デフォルト)

[API降順]
[型昇順]
[型降順]

 

項目一覧

必須

-

[テーブル名]で選択したSalesforceテーブル内の項目一覧を表示します。

追加可能な項目のみ表示されます。

項目一覧/選択

省略可

使用不可

[スキーマ定義]として選択する列のチェックボックスにチェックを入れます。

 

項目一覧/ラベル

必須

使用不可

[テーブル名]で選択したテーブルの列、または親テーブルの列のラベル名を表示します。

 

項目一覧/API

必須

使用不可

[テーブル名]で選択したテーブルの列、または親テーブルの列のAPI名を表示します。

 

項目一覧/型

必須

使用不可

[テーブル名]で選択したテーブルの列、または親テーブルの列のデータ型を表示します。

 

スキーマ定義

必須

-

スキーマ定義として選択したテーブルの列の一覧が表示されます。

注意

後続の処理で必要となる項目に限定(不要な項目をスキーマ定義から除く)することにより、処理効率が向上します。

スキーマ定義/ラベル

必須

使用不可

スキーマ定義として選択したテーブルの列のラベル名を表示します。

 

スキーマ定義/API

必須

使用不可

スキーマ定義として選択したテーブルの列、または親テーブルの列のAPI名を表示します。

 

スキーマ定義/型

必須

使用不可

スキーマ定義として選択したテーブルの列、または親テーブルの列のデータ型を表示します。

 

スキーマ定義/集計条件

省略可

使用不可

スキーマ定義として選択したテーブルの列、または親テーブルの列に集計関数を指定できます。

[SUM]
[MAX]
[MIN]
[AVG]
[COUNT]
[COUNT_DISTINCT]

 

プロパティアクション

項目名

説明

備考

↓選択

[項目一覧/選択]列にチェックがある項目を[スキーマ定義]に設定します。

 

オプション設定

項目名

必須/省略可

変数の使用

説明

備考

SOQL(検索条件)

必須

使用可

[テーブル名]で選択を行ったテーブルに対する検索条件(Where文)を指定します。

構文の詳細については、Salesforce APIドキュメントを参照してください。

集計条件

省略可

使用可

[テーブル名]で選択を行ったテーブル、または親テーブルに対して集計を行う場合の集計条件(GROUP BY句など)を指定します。

  • 例えばGROUP BY句を指定したい場合、「GROUP BY」から記述します。

  • 構文の詳細については、Salesforce APIドキュメントを参照してください。

カラム名タイプ

必須

使用不可

マッピングでスキーマを表示する際のカラム名の表示タイプを選択します。

[ラベル]

Salesforceで定義されたラベル名(項目名)で表示します。

[API]

(デフォルト)

Salesforceで定義されたAPI参照名で表示します。

 

削除レコードの読み取り(queryAll)

必須

-

Salesforceから削除されたデータを読み取るかどうかを設定します。

(読み取りする場合、queryAllサービスを用いた読み取りを行います。)

[読み取りしない]

(デフォルト)

Salesforceで削除されたデータを読み取りません。

[読み取りする]

Salesforceで削除されたデータを読み取ります。

注意

[読み取りする]を選択した場合、ゴミ箱から削除されたデータが削除後も24時間前後読み取られることがあります。

バッチサイズ

必須

使用可

Salesforceからのデータ読み取り結果を取得する際のバッチサイズを入力します。

  • デフォルト値は「2000」です。

  • 「1」以上「2000」以下の値が指定できます。範囲以外の値が指定された場合、エラーが発生します。

  • APIの仕様では「200」未満の値を許容していません。この値を指定した場合の動作はAPIの仕様に依存します。

  • 使用環境によりますが、一般的にバッチサイズを大きくすることにより、データの読み取り効率は向上します。

注意

SalesforceのAPI仕様として、10,000件のデータを読み取るケースで、バッチサイズを2000と設定した場合、データ結果セットを5回に分けて取得します。

プロパティアクション

項目名

説明

備考

抽出テスト

指定した検索条件と集計条件で処理が実行できるかどうかを確認します。

  • [SOQL(検索条件)]および[集計条件]が指定されていない場合、実行することができません。

コメント

項目名

必須/省略可

変数の使用

説明

備考

コメント

省略可

使用不可

このコネクターの簡単な説明を記述することができます。

 

スキーマ

入力スキーマ

ありません。

出力スキーマ

[スキーマ定義]の設定により、カラム数が異なります。

= 備考 =

スキーマ構造については、「テーブルモデル型 」を参照してください。

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。

= 備考 =

詳細については、「スキーマ編集」を参照してください。

大容量データ処理

大容量データ処理に対応していません。

PSPでの使用について

PSPでは使用できません。

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

コンポーネント変数名

説明

備考

count

読み取ったデータの件数が格納されます。

  • デフォルト値はnullです。

server_url

ログイン後のエンドポイントURLが格納されます。

  • デフォルト値はnullです。

session_id

セッションIDが格納されます。

  • デフォルト値はnullです。

message_category

エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。

  • デフォルト値はnullです。

message_code

エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。

  • デフォルト値はnullです。

message_level

エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。

  • デフォルト値はnullです。

operation_api_exception_code

APIエラー発生時、発生したエラーのExceptionCodeが格納されます。

  • デフォルト値はnullです。

  • APIエラー以外のエラー発生時は、値が格納されません。

operation_error_message

エラー発生時、発生したエラーのメッセージが格納されます。

  • デフォルト値はnullです。

operation_error_trace

エラー発生時、発生したエラーのトレース情報が格納されます。

  • デフォルト値はnullです。

メッセージコード、例外メッセージ、制限事項

コネクター

メッセージコード

エラーメッセージ

制限事項

Salesforce(旧) コネクターのメッセージおよび制限事項

check

check

check