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

オペレーション名

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

機能概要

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

抽出条件は、SOQL(Sforce Object Query Language)で指定しますが、本コンポーネントではSOQLを直接記述することなく設定することが可能です。
ただし、WHERE句以降については直接記述することができます。

本コンポーネントでは、子-親リレーション(child-to-parent relationships)および、関数を使用することができます。
子オブジェクトから見た親オブジェクトの項目を「リレーション名.リレーション先項目名」の形式で1階層上のオブジェクトまで取得することができます。
また、スキーマ定義で選択した項目に関数を指定することができ、集計条件(GROUP BY句など)を合わせて指定することで、集計条件に基づいた関数の結果を取得することができます。

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

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

データモデル

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

プロパティ

変数の使用については、「変数」を参照してください。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
接続先 必須 使用不可 グローバルリソースを選択します。
グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
  • API 18.0以降のグローバルリソースが選択可能です。
  • テーブル名 必須 使用不可 Salesforceのテーブル名を選択します。  
    スキーマ定義 必須 - Salesforceから読み取りを行う項目を設定します。
    • 後続の処理で必要となる項目に限定(不要な項目をスキーマ定義から除く)することにより、処理効率が向上します。
    スキーマ定義/ラベル 必須 使用不可 [テーブル名]で指定したテーブルの列、または親テーブルの列のラベル名を表示します。  
    スキーマ定義/API 必須 使用不可 [テーブル名]で指定したテーブルの列、または親テーブルの列のAPI名を表示します。  
    スキーマ定義/型 必須 使用不可 [テーブル名]で指定したテーブルの列、または親テーブルの列のデータ型を表示します。  
    スキーマ定義/関数 必須 使用不可 [テーブル名]で指定したテーブルの列、または親テーブルの列に集計関数を指定できます。
    • SUM関数の場合「SUM」、MAX関数の場合「MAX」のように設定します。
    • SUM関数やAVG関数などの集計結果が数値の精度を越える場合、値が正しく取得できないことがあります。
    SOQL(検索条件) 省略可 使用可 [テーブル名]で選択を行ったテーブルに対する検索条件(Where文)を指定します。
    • 構文の詳細については、Salesforce APIドキュメントを参照してください。
    プロパティアクション
    項目名 説明 備考
    スキーマの作成 Salesforceから読み取りを行う項目の追加・削除を行うことができます。
    設定方法については、「スキーマの作成」を参照してください。
     
    SOQLの作成 [テーブル名]で選択したテーブルに対する検索条件の指定をサポートします。
    設定方法については、「SOQLの作成」を参照してください。
     
    抽出テスト 指定したスキーマ、検索条件、集計条件を元にクエリーを実行します。結果として取得した件数が表示されます。
    • 次の場合には実行することができません。
      • スキーマ定義が設定されていない場合
      • 検索条件、関数、集計条件に変数が指定されている場合
    オプション設定
    項目名 必須/省略可 変数の使用 説明 備考
    集計条件 省略可 使用可 [テーブル名]で選択を行ったテーブル、または親テーブルに対して集計を行う場合の集計条件(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回に分けて取得します。
    プロパティアクション
    項目名 説明 備考
    テーブル情報の表示 操作を行っているオブジェクトのテーブル構造を確認できます。
    テーブル構造の参照方法については、「テーブル情報の表示」を参照してください。
    • 他のオブジェクトのテーブル構造を確認したい場合、[全テーブル情報の読み込み]をクリックしてください。
    全テーブル情報の読み込み 取得可能なすべてのテーブル構造を取得します。
    実行後に、[テーブル情報の表示]から取得した内容を確認することができます。
     
    ファイルからスキーマ定義を読み取り ファイルチューザでファイルを選択して、そのファイルの1行目にカンマ区切りで指定された項目(API)を読み取り、スキーマ定義として設定します。
    • 選択するファイルのエンコードは「UTF-8」を指定してください。
    ファイル出力設定
    項目名 必須/省略可 変数の使用 説明 備考
    Base64項目出力形式 必須 - データ型がBase64である項目に対してのデータ出力形式を指定します。
    • [Base64データ]:(デフォルト)
      出力スキーマに読み取ったBase64データをそのまま渡します。
    • [ファイル出力]:
      ファイルとして出力します。
      出力スキーマには出力したファイルパスを渡します。
    • 読み取りスキーマにデータ型がBase64である項目を含まない場合は、[Base64データ]を選択してください。
    ディレクトリ 省略可 使用可 書き込みを行うディレクトリを入力します。
    [参照]ボタンを押下するとディレクトリチューザが起動し、ディレクトリの選択ができます。
    • [Base64項目出力形式][ファイル出力]を選択した場合、有効になります。
    • ファイルパスはDataSpider Cloudファイルシステムの絶対パスで指定してください。
    • パス区切り文字「/」以外のDataSpider Cloudファイルシステムの使用禁止文字は使用できません。
    データ項目 省略可 使用不可 [スキーマ定義]に含まれる項目から、データ型がBase64である項目を選択します。
    • [Base64項目出力形式][ファイル出力]を選択した場合、有効になります。
    • [スキーマ定義]にデータ型がBase64である項目が含まれている必要があります。
    ファイル名入力方法 省略可 - 出力するファイル名の入力方法を選択します。
    • [項目から選択する]:(デフォルト)
      [スキーマ定義]に含まれる項目から、ファイル名とする項目を選択します。
    • [文字列を入力する]:
      ファイル名とする文字列を入力します。
    • [Base64項目出力形式][ファイル出力]を選択した場合、有効になります。
    ファイル名 省略可 使用不可 出力するファイル名を指定します。
    • [Base64項目出力形式][ファイル出力]を選択した場合、有効になります。
    • [ファイル名入力方法][項目から選択する]を選択した場合、選択リストとなります。
    • [ファイル名入力方法][文字列を入力する]を選択した場合、テキストフィールドとなります。この場合、変数は使用可となります。
    • DataSpider Cloudファイルシステムの使用禁止文字が含まれる場合、ファイル出力時にアンダースコア(_)に変換されます。
    付加文字入力方法 省略可 - 出力するファイル名に付加する文字の入力方法を選択します。
    • [付加しない]:(デフォルト)
      ファイル名に文字の付加を行いません。
    • [項目から選択する]:
      [スキーマ定義]に含まれる項目から、付加文字とする項目を選択します。
    • [文字列を入力する]:
      付加する文字列を入力します。
    • [Base64項目出力形式][ファイル出力]を選択した場合、有効になります。
    付加文字 省略可 使用不可 出力するファイル名に付加する文字を指定します。
    • [Base64項目出力形式][ファイル出力]を選択した場合かつ、[付加文字入力方法][項目から選択する]または[文字列を入力する]を選択した場合、有効になります。
    • [付加文字入力方法][項目から選択する]を選択した場合、選択リストとなります。
    • [付加文字入力方法][文字列を入力する]を選択した場合、テキストフィールドとなります。この場合、変数は使用可となります。
    • DataSpider Cloudファイルシステムの使用禁止文字が含まれる場合、ファイル出力時にアンダースコア(_)に変換されます。
    付加位置 省略可 - 出力するファイル名に付加する文字の位置を選択します。
    • [先頭]:(デフォルト)
      ファイル名の先頭に付加します。
    • [末尾]:
      ファイル名の末尾に付加します。ファイル名に拡張子が含まれる場合、ドット(.)の前の位置に付加します。
    • [Base64項目出力形式][ファイル出力]を選択した場合かつ、[付加文字入力方法][項目から選択する]または[文字列を入力する]を選択した場合、有効になります。
    区切り文字 省略可 使用可 出力するファイル名と、付加する文字の区切り文字を入力します。
    区切り文字が必要でない場合、省略することが可能です。
    • [Base64項目出力形式][ファイル出力]を選択した場合かつ、[付加文字入力方法][項目から選択する]または[文字列を入力する]を選択した場合、有効になります。
    • DataSpider Cloudファイルシステムの使用禁止文字が含まれる場合、ファイル出力時にアンダースコア(_)に変換されます。
    拡張子入力方法 省略可 - 出力するファイル名の拡張子の入力方法を選択します。
    • [ファイル名に含む]:(デフォルト)
      ファイル名に拡張子を含めて指定します。
    • [項目から選択する]:
      [スキーマ定義]に含まれる項目から、拡張子とする項目を選択します。
    • [文字列を入力する]:
      拡張子とする文字列を入力します。
    • [Base64項目出力形式][ファイル出力]を選択した場合、有効になります。
    拡張子 省略可 使用不可 出力するファイル名の拡張子を指定します。
    • [Base64項目出力形式][ファイル出力]を選択した場合かつ、[拡張子入力方法][項目から選択する]または[文字列を入力する]を選択した場合、有効になります。
    • [拡張子入力方法][項目から選択する]を選択した場合、選択リストとなります。
    • [拡張子入力方法][文字列を入力する]を選択した場合、テキストフィールドとなります。この場合、変数は使用可となります。
    • DataSpider Cloudファイルシステムの使用禁止文字が含まれる場合、ファイル出力時にアンダースコア(_)に変換されます。
    • 大文字が含まれる場合、ファイル出力時に小文字に変換されます。
    • 指定された文字にドット(.)が含まれない場合、自動的に付加されます。
    データ処理方式
    項目名 必須/省略可 変数の使用 説明 備考
    データ処理方式 必須 使用不可 データ処理方式を選択します。
    • [スクリプトの設定を使用する]:(デフォルト)
      スクリプトプロパティの大容量データ処理の設定をアダプタに使用します。
    • [大容量データ処理を行わない]:
      大容量データ処理を行いません。
    • [大容量データ処理を行う]:
      大容量データ処理を行います。
     
    コメント
    項目名 必須/省略可 変数の使用 説明 備考
    コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
    説明を記述すると、仕様書に反映させることができます。
     

    スキーマ

    入力スキーマ

    ありません。

    出力スキーマ

    [スキーマ定義]の設定により、カラム数が異なります。
    スキーマ構造については、「テーブルモデル型のスキーマ」を参照してください。

    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エラー以外のエラー発生時は、値が格納されません。
    • DataSpider Cloudのバージョンにより、格納される内容が変わる可能性があります。
    operation_error_message エラー発生時、発生したエラーのメッセージが格納されます。
    • デフォルト値はnullです。
    • DataSpider Cloudのバージョンにより、格納される内容が変わる可能性があります。
    operation_error_trace エラー発生時、発生したエラーのトレース情報が格納されます。
    • デフォルト値はnullです。
    • DataSpider Cloudのバージョンにより、格納される内容が変わる可能性があります。

    スキーマの作成

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



    画像内の番号 名称 説明 備考
    (1) 選択済み項目 Salesforceから読み取り、または書き込みを行う項目を選択します。  
    (2) 未選択の項目 Salesforceから読み取り、または書き込みを行わない項目を選択します。
    • 列名上部のフィールドに値を入力・選択することで項目を絞り込むことができます。
      テキストフィールドの場合、入力した値の前方一致で絞り込まれます。

    SOQLの作成

    Salesforceから読み取るデータの抽出条件を指定することができます。



    画像内の番号 名称 説明 備考
    (1) 条件項目の選択 検索条件に利用したい項目を選択するための一覧です。
    • 列名上部のフィールドに値を入力・選択することで項目を絞り込むことができます。
      テキストフィールドの場合、入力した値の前方一致で絞り込まれます。
    (2) 検索条件の指定 検索条件に利用したい項目を選択し、選択した項目ごとに条件式を指定できます。  
    (3) SOQL(検索条件:WHERE) [検索条件の指定]で指定された条件を表示します。
    • 表示された条件を直接編集することも可能です。

    テーブル情報の表示

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



    画像内の番号 名称 説明 備考
    (1) テーブル名 テーブル構造の表示を行うテーブルを選択します。  
    (2) テーブル情報 選択したテーブルに対する、操作可能なオペレーションを表示します。  
    (3) 桁数 項目の桁数を表示します。  
    (4) 外部ID 対象項目が外部IDとして設定されているか否かを表します。  
    (5) 追加可能 データ追加時に値を設定することが可能か否かを表します。  
    (6) 更新可能 データ更新時に値を設定することが可能か否かを表します。  
    (7) Null許可 データ追加、更新時にNullが許容されるか否かを表します。  
    (8) 初期値有無 データ追加時にSalesforceが初期値を自動設定するか否かを表します。  
    (9) 参照先 参照関係または主従関係の項目の場合、参照先のオブジェクト名を表示します。  

    仕様制限

    主な例外

    例外名 原因 対策
    ResourceNotFoundException
    リソース定義が見つかりませんでした。名前:[]
    [接続先]が指定されていません。 [接続先]を指定してください。
    ResourceNotFoundException
    リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]
    [接続先]で選択されたリソース定義が見つかりません。 [接続先]で指定したグローバルリソースを確認してください。
    java.net.UnknownHostException グローバルリソースで指定したPROXYサーバが見つからない例外です。 PROXYサーバの状態を確認して下さい。または、[接続先]で指定したグローバルリソースの[Proxyホスト]を確認してください。
    • API23.0以前
      org.apache.commons.httpclient.HttpConnection$ConnectionTimeoutException
    • API26.0以降
      java.net.SocketTimeoutException
      connect timed out
    Salesforceに接続中にタイムアウトが発生しました。 ネットワークの状態、Salesforceのサーバの状態を確認してください。または、[接続先]で指定したグローバルリソースの[Connectionタイムアウト(秒)]を確認してください。
    • API23.0以前
      org.apache.commons.httpclient.HttpRecoverableException
      java.net.SocketTimeoutException: Read timed out
    • API26.0以降
      java.net.SocketTimeoutException
      Read timed out
    Salesforceに接続後、サーバからの応答までにタイムアウトが発生しました。 ネットワークの状態、Salesforceのサーバの状態を確認してください。または、[接続先]で指定したグローバルリソースの[タイムアウト(秒)]を確認してください。
    jp.co.headsol.salesforce.adapter.exception.SalesforceAdapterIllegalArgumentException Salesforceアダプタのプロパティの設定値が不正です。 エラーメッセージを確認し、設定内容をご確認ください。
    com.sforce.soap.partner.fault.LoginFault Salesforceへのログインに失敗しました。 ExceptionCodeまたは、エラーメッセージを確認し、Salesforceの関連ドキュメントなどに対象のエラーに関する情報がないか確認してください。
    com.sforce.soap.partner.fault.InvalidFieldFault 実行したSOQLに含まれる項目が不正です。 ExceptionCodeまたは、エラーメッセージを確認し、Salesforceの関連ドキュメントなどに対象のエラーに関する情報がないか確認してください。
    com.sforce.soap.partner.fault.MalformedQueryFault 実行したSOQLが不正です。 ExceptionCodeまたは、エラーメッセージを確認し、Salesforceの関連ドキュメントなどに対象のエラーに関する情報がないか確認してください。
    com.sforce.soap.partner.fault.UnexpectedErrorFault Salesforceへの処理実行中に、予期しない例外が発生しました。 ExceptionCodeまたは、エラーメッセージを確認し、Salesforceの関連ドキュメントなどに対象のエラーに関する情報がないか確認してください。

    注意事項