検索パラメータ形成処理

オペレーション名

検索パラメータ形成

機能概要

設定された条件式と入力データをもとに、SOQL(Salesforce Object Query Language)のWHERE句に使用する文字列を形成します。
SOQLの形成をサポートする機能であり、SOQL構文の妥当性は保証されません。

データモデル

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

プロパティ

変数の使用については、「変数」を参照してください。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  
入力データ 必須 使用不可 スクリプトキャンバス上にあるコンポーネントを選択します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
接続先 必須 使用不可 グローバルリソースを選択します。
グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
 
テーブル名 必須 使用不可 Salesforceのテーブル名を選択します。  
パラメータタイプ 必須 使用不可 形成する構文の種類を選択します。
  • [IN句のパラメータ]:(デフォルト)
    IN句のパラメータを形成します。
    • 例: Name IN('AAA','BBB','CCC',,,)
  • [AND,ORの繰り返し]:
    ANDやORの組み合わせを繰り返す条件式を形成します。
    • 例: (Name = 'AAA') OR (Name = 'BBB') OR (Name = 'CCC'),,,
 
折り返し文字数 必須 使用可 1件の形成文字列の文字数上限を設定します。
文字数が上限を超える場合、複数件の結果を出力します。
  • デフォルト値は「19500」です。
  • 「20」以上「19950」以下の値が指定できます。範囲以外の値が指定された場合、エラーが発生します。
  • API仕様により、SOQLの文字数上限は20,000文字となっています。
条件項目名の指定方法 必須 使用不可 条件で使用する項目名の指定方法を選択します。
  • [選択する]:(デフォルト)
    選択リストより選択します。
  • [直接入力する]:
    テキストフィールドに直接入力します。
  • [選択する]を選択した場合、実行時に選択した項目の存在チェックが行われます。
  • [直接入力する]を選択した場合、実行時に入力した項目の存在チェックは行われません。
  • 選択リストに表示されない項目を条件指定したい場合、[直接入力する]を選択することで、自由に入力指定することができます。
プロパティアクション
項目名 説明 備考
テーブル情報の表示 操作を行っているオブジェクトのテーブル構造を確認できます。
テーブル構造の参照方法については、「テーブル情報の表示」を参照してください。
  • 他のオブジェクトのテーブル構造を確認したい場合、[全テーブル情報の読み込み]をクリックしてください。
全テーブル情報の読み込み 取得可能なすべてのテーブル構造を取得します。
実行後に、[テーブル情報の表示]から取得した内容を確認することができます。
 
IN句のパラメータ
項目名 必須/省略可 変数の使用 説明 備考
条件項目 省略可 使用可 条件として指定する項目を選択または入力します。
  • [パラメータタイプ][IN句のパラメータ]を選択した場合のみ有効となります。
  • [条件項目名の指定方法][選択する]を選択した場合、選択リストとなります。
  • [条件項目名の指定方法][直接入力する]を選択した場合、テキストフィールドとなります。
値をシングルクォートで囲う 省略可 使用不可 入力データから渡された値を、シングルクォートで囲うかどうかを指定します。
  • [チェックあり]:(デフォルト)
    値をシングルクォートで囲います。
  • [チェックなし]:
    値をシングルクォートで囲いません。
  • [パラメータタイプ][IN句のパラメータ]を選択した場合のみ有効となります。
予約文字をエスケープする 省略可 使用不可 入力データから渡された値に含まれる予約文字を、エスケープするかどうかを指定します。
  • [チェックあり]:(デフォルト)
    予約文字をエスケープします。
  • [チェックなし]:
    予約文字をエスケープしません。
  • [パラメータタイプ][IN句のパラメータ]を選択した場合のみ有効となります。
  • 予約文字は、「'」(シングルクォート)と「\」(バックスラッシュ)です。
    • 例:「Bob's BBQ」をエスケープする場合「Bob\'s BBQ」と表記します。
NULL/空文字を除外する 省略可 使用不可 入力データから渡された値がNULLまたは空文字の場合、除外するかどうかを指定します。
  • [チェックあり]:
    NULLまたは空文字の値を除外します。
  • [チェックなし]:(デフォルト)
    NULLまたは空文字の値を除外しません。
    「null」という文字列に置き換えます。
  • [パラメータタイプ][IN句のパラメータ]を選択した場合のみ有効となります。
AND,ORの繰り返し
項目名 必須/省略可 変数の使用 説明 備考
条件式 省略可 - 列を指定します。

各列は以下のボタンで操作することができます。
  • [追加]:
    列を追加します。
  • [上へ]:
    選択している列の順序を一つ上に上げます。
  • [下へ]:
    選択している列の順序を一つ下に下げます。
  • [削除]:
    列を削除します。
  • [パラメータタイプ][AND,ORの繰り返し]を選択した場合のみ有効となります。
  • [条件式]で設定した[API]がMapperの入力スキーマに表示されます。
条件式/NOT 省略可 使用不可 NOT句を挿入するかどうかを選択します。
  • [ブランク]:(デフォルト)
    NOT句を挿入しません。
  • [NOT]:
    NOT句を挿入します。
 
条件式/前括弧 省略可 使用不可 前括弧を選択します。
  • [ブランク]:(デフォルト)
    前括弧を挿入しません。
  • [(]:
    「(」を挿入します。
  • [((]:
    「((」を挿入します。
  • [(((]:
    「(((」を挿入します。
 
条件式/API 省略可 使用可 条件とする項目API名を選択または入力します。
  • [条件項目名の指定方法][選択する]を選択した場合、選択リストとなります。
  • [条件項目名の指定方法][直接入力する]を選択した場合、テキストフィールドとなります。
条件式/演算子 省略可 使用可 演算子を選択します。
  • [=]:(デフォルト)
    「=」を挿入します。
  • [!=]:
    「!=」を挿入します。
  • [<]:
    「<」を挿入します。
  • [<=]:
    「<=」を挿入します。
  • [>]:
    「>」を挿入します。
  • [>=]:
    「>=」を挿入します。
 
条件式/後括弧 省略可 使用不可 後括弧を選択します。
  • [ブランク]:(デフォルト)
    後括弧を挿入しません。
  • [)]:
    「)」を挿入します。
  • [))]:
    「))」を挿入します。
  • [)))]:
    「)))」を挿入します。
 
条件式/AND/OR 省略可 使用不可 条件式内の行を連結する論理演算子を選択します。
  • [ブランク]:(デフォルト)
    挿入しません。
  • [AND]:
    AND句を挿入します。
  • [OR]:
    OR句を挿入します。
 
条件式/シングルクォート 省略可 使用不可 入力データから渡された値を、シングルクォートで囲うかどうかを指定します。
  • [チェックあり]:(デフォルト)
    値をシングルクォートで囲います。
  • [チェックなし]:
    値をシングルクォートで囲いません。
 
条件式/エスケープ 省略可 使用不可 入力データから渡された値に含まれる予約文字を、エスケープするかどうかを指定します。
  • [チェックあり]:(デフォルト)
    予約文字をエスケープします。
  • [チェックなし]:
    予約文字をエスケープしません。
  • 予約文字は、「'」(シングルクォート)と「\」(バックスラッシュ)です。
    • 例:「Bob's BBQ」をエスケープする場合「Bob\'s BBQ」と表記します。
繰り返す論理演算 省略可 使用不可 入力データごとに生成される条件式を連結する論理演算子を選択します。
  • [AND]:(デフォルト)
    AND句で連結します。
  • [OR]:
    OR句で連結します。
  • [パラメータタイプ][IN句のパラメータ]を選択した場合のみ有効となります。
プロパティアクション
項目名 説明 備考
形成レビュー 設定した条件式をもとに、形成される文字列を確認することができます。
  • ?{param_(n)}と表示される箇所には入力スキーマで渡される値が代入されます。
データ処理方式
項目名 必須/省略可 変数の使用 説明 備考
データ処理方式 必須 使用不可 データ処理方式を選択します。
  • [スクリプトの設定を使用する]:(デフォルト)
    スクリプトプロパティの大容量データ処理の設定をアダプタに使用します。
  • [大容量データ処理を行わない]:
    大容量データ処理を行いません。
  • [大容量データ処理を行う]:
    大容量データ処理を行います。
 
コメント
項目名 必須/省略可 変数の使用 説明 備考
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。
 

スキーマ

入力スキーマ

[パラメータタイプ]の設定により異なります。

出力スキーマ


<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>formed_parameter</column>
  </row>
  <row>
    :
  </row>
</table>

要素名 列名(ラベル/API) 説明 備考
row
-
受け取るデータ行数分繰り返します。  
column formed_parameter 形成した文字列が出力されます。  

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。
詳細については、「スキーマ編集」を参照してください。

大容量データ処理

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

トランザクション

トランザクションはサポートしていません。

PSPでの使用について

PSPでは使用できません。

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

コンポーネント変数名 説明 備考
input_count 入力データの件数が格納されます。
  • デフォルト値はnullです。
output_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エラー以外のエラー発生時は、値が格納されません。
  • SkyOnDemandのバージョンにより、格納される内容が変わる可能性があります。
operation_error_message エラー発生時、発生したエラーのメッセージが格納されます。
  • デフォルト値はnullです。
  • SkyOnDemandのバージョンにより、格納される内容が変わる可能性があります。
operation_error_trace エラー発生時、発生したエラーのトレース情報が格納されます。
  • デフォルト値はnullです。
  • SkyOnDemandのバージョンにより、格納される内容が変わる可能性があります。

検索パラメータ形成使用例

複数の値から、検索条件として使用する文字列を形成することができます。[折り返し文字数]に指定した文字数以内で1つの検索パラメータを形成するため、結果は複数件出力されます。。

テーブル情報の表示

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.UnexpectedErrorFault Salesforceへの処理実行中に、予期しない例外が発生しました。 ExceptionCodeまたは、エラーメッセージを確認し、Salesforceの関連ドキュメントなどに対象のエラーに関する情報がないか確認してください。

注意事項