項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
接続先 |
必須 |
使用不可 |
グローバルリソースを選択します。
グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。
- [追加]:
新規にグローバルリソースを追加します。
- [一覧の編集]:
「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
|
|
テーブル名 |
必須 |
使用不可 |
Salesforceのテーブル名を選択します。 |
|
スキーマ定義 |
必須 |
- |
データ書き込みを行うCSVデータのヘッダ行とする項目を設定します。 |
- 指定した「ID」のレコードを更新する機能となるため、「ID」を選択している必要があります。
- Salesforceに対して書き込みが必要な項目に限定(不要な項目をスキーマ定義から除く)することにより、処理効率が向上します。
- データ型が「base64」と定義された項目を扱うことはできません。このような項目が選択されている場合、エラーが発生します。
|
スキーマ定義/ラベル |
必須 |
使用不可 |
[テーブル名]で指定したテーブルの列のラベル名を表示します。 |
|
スキーマ定義/API |
必須 |
使用不可 |
[テーブル名]で指定したテーブルの列のAPI名を表示します。 |
|
スキーマ定義/型 |
必須 |
使用不可 |
[テーブル名]で指定したテーブルの列のデータ型を表示します。 |
|
スキーマ定義/Null設定 |
省略可 |
使用不可 |
入力データがnullまたは空文字であった場合、文字列「#N/A」に置き換えるかどうかを項目単位に選択します。
- [チェックあり]:
この項目の置き換えを行います。
- [チェックなし]:
この項目の置き換えを行いません。
|
- [項目単位に設定する]で[チェックあり]にした場合、有効になります。
|
リレーションシップ項目定義 |
省略可 |
- |
スキーマ定義にリレーション項目が存在する場合、外部キーによる更新を行うための項目を設定します。 |
- リレーション先オブジェクトの外部キー項目を選択することにより、リレーション関係を持たせたデータの受け渡しが可能となります。
詳細については、「リレーションシップ項目定義」を参照してください。
- API 43.0以降のグローバルリソースを選択している場合、多態的な項目による更新が可能となります。
多態的な項目は、[リレーション用カラムAPI名]で指定します。
多態的な項目の詳細はSalesforceのドキュメントをご確認ください。
|
リレーションシップ項目定義/元項目API名 |
必須 |
使用不可 |
[テーブル名]で指定したテーブルのリレーション項目の列のAPI名を表示します。 |
|
リレーションシップ項目定義/リレーションシップ名 |
必須 |
使用不可 |
[テーブル名]で指定したテーブルのリレーション項目の列のリレーションシップ名を表示します。 |
|
リレーションシップ項目定義/オブジェクトAPI名 |
省略可 |
使用不可 |
[テーブル名]で指定したテーブルのリレーション項目の列のリレーション先のオブジェクトのAPI名を選択します。 |
|
リレーションシップ項目定義/リレーション用カラムAPI名 |
省略可 |
使用不可 |
[テーブル名]で指定したテーブルのリレーション項目の列のリレーション先オブジェクトの外部キー項目を選択します。 |
- 省略した場合、リレーション先オブジェクトの該当レコードのIDを受け渡す仕様となります。
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
Null/空文字を"#N/A"へ置き換える |
必須 |
使用不可 |
入力データがnullまたは空文字であった場合、文字列「#N/A」に置き換えるかどうかを選択します。
- [チェックあり]:(デフォルト)
置き換えを行います。
- [チェックなし]:
置き換えを行いません。
|
- APIの仕様として、nullで更新する場合は文字列「#N/A」を指定する必要があります。
|
項目単位に設定する |
省略可 |
使用不可 |
[Null/空文字を"#N/A"へ置き換える]を項目単位に設定するかどうかを選択します。
項目単位の設定は、[スキーマ定義/Null設定]で行います。
- [チェックあり]:
項目単位に設定を行います。
- [チェックなし]:(デフォルト)
項目単位に設定を行いません。
|
- API 53.0以降のグローバルリソースを選択している場合のみ有効になります。
- [Null/空文字を"#N/A"へ置き換える]で[チェックあり]にした場合、有効になります。
|
バッチサイズ |
必須 |
使用可 |
1つのバッチに登録するレコード件数の上限を入力します。 |
- デフォルト値は「2000」です。
- 「1」以上「10000」以下の値が指定できます。範囲以外の値が指定された場合、エラーが発生します。
- 本アダプタの仕様として、100,000件のデータを書き込むケースで、バッチサイズを2,000と設定した場合、50のバッチを作成します。
ただし、1つのバッチがAPIの制限値である10MBを超えてしまう場合は、指定したバッチサイズ以下でバッチを作成します。
- API 50.0以降かつ、[API種別]が[Bulk API 2.0]のグローバルリソースを選択している場合、表示されません。
APIの仕様により、バッチの管理はSalesforceで自動的に行われるため指定できません。
|
同時実行モード |
必須 |
使用不可 |
ジョブの同時実行モードを選択します。
- [並列]:(デフォルト)
並列モードでジョブを作成します。
- [順次]:
順次モードでジョブを作成します。
|
- 並列処理を行うと、データベースの競合が生じる可能性があります。競合が激しいと、読み込みが失敗することがあります。
順次モードを使用すれば、バッチは1つずつ確実に処理されます。ただし、このオプションを使用すると、読み込みの処理時間が大幅に増える場合があります。
- API 50.0以降かつ、[API種別]が[Bulk API 2.0]のグローバルリソースを選択している場合、表示されません。
APIの仕様により、並列モードで実行されます。
|
実行後ジョブ状況 |
必須 |
使用不可 |
作成したジョブを、実行後にクローズするかどうかを選択します。
- [クローズする]:(デフォルト)
実行後にジョブをクローズします。
- [クローズしない]:
実行後にジョブをクローズしません。状況はオープンのままとなります。
|
- API 50.0以降かつ、[API種別]が[Bulk API 2.0]のグローバルリソースを選択している場合、表示されません。
APIの仕様により、ジョブはクローズされます。
|
処理完了を待ちバッチ結果を取得する |
必須 |
使用不可 |
作成した処理が完了するまで状況を監視し、結果を取得するかどうかを選択します。
- [チェックあり]:(デフォルト)
処理結果を取得します。取得した結果は出力スキーマから後続に渡すことができます。
- [チェックなし]:
処理結果を取得しません。
|
- チェックありとした場合、スキーマ定義に指定した項目および結果情報の項目をテーブルモデル型のデータとして後続に受け渡すことができます。
- 取得する情報については、「スキーマ」を参照してください。
- 使用例については、「結果取得使用例」を参照してください。
- 選択しているグローバルリソースの内容により項目名が異なります。
- API 43.0以前
[処理完了を待ちバッチ結果を取得する]と表示されます。
- API 50.0以降かつ、[API種別]が[Bulk API]
[処理完了を待ちバッチ結果を取得する]と表示されます。
- API 50.0以降かつ、[API種別]が[Bulk API 2.0]
[処理完了を待ち結果を取得する]と表示されます。
|
処理完了を待ち結果を取得する |
監視開始までの待機時間(秒) |
省略可 |
使用可 |
処理状況の監視を開始するまでの待機時間を、秒で入力します。 |
- デフォルト値は「3」です。
- [処理完了を待ちバッチ結果を取得する]または[処理完了を待ち結果を取得する]にチェックを入れた場合のみ有効になります。
- 3以上10800以下が指定可能です。範囲以外の値が指定された場合、エラーが発生します。
|
バッチ状況監視間隔(秒) |
省略可 |
使用可 |
処理が完了しているか確認する間隔を、秒で入力します。 |
- デフォルト値は「10」です。
- [処理完了を待ちバッチ結果を取得する]または[処理完了を待ち結果を取得する]にチェックを入れた場合のみ有効になります。
- 10以上600以下が指定可能です。範囲以外の値が指定された場合、エラーが発生します。
- 選択しているグローバルリソースの内容により項目名が異なります。
- API 43.0以前
[バッチ状況監視間隔(秒)]と表示されます。
- API 50.0以降かつ、[API種別]が[Bulk API]
[バッチ状況監視間隔(秒)]と表示されます。
- API 50.0以降かつ、[API種別]が[Bulk API 2.0]
[処理状況監視間隔(秒)]と表示されます。
|
処理状況監視間隔(秒) |
エラー結果のレコードのみ出力する |
省略可 |
使用不可 |
取得した処理結果からエラーレコード(未処理レコードを含む)のみ出力します。
- [チェックあり]:
エラーレコードのみ出力します。
- [チェックなし]:(デフォルト)
すべてのレコードを出力します。
|
- API 43.0以降のグローバルリソースを選択しているかつ、[処理完了を待ちバッチ結果を取得する]または[処理完了を待ち結果を取得する]にチェックを入れた場合のみ有効になります。
- API 40.0以前の場合は無効となり、取得した処理結果からすべてのレコードを出力します。
|
要素名 |
列名(ラベル/API) |
説明 |
備考 |
row |
- |
入力スキーマに渡されたデータ件数分繰り返します。 |
- [処理完了を待ちバッチ結果を取得する]または[処理完了を待ち結果を取得する]にチェックを入れない場合、0件となります。
|
column |
結果情報_入力行番号/RESULT_inputRowNumber |
入力スキーマに渡されたデータ内のノードの位置に基づいて番号を出力します。 |
|
結果情報_バッチ_ID/RESULT_BATCH_id |
レコードが処理されたバッチのIDを出力します。 |
- API 50.0以降かつ、[API種別]が[Bulk API 2.0]のグローバルリソースを選択している場合、nullとなります。
|
結果情報_バッチ_状況/RESULT_BATCH_state |
レコードが処理されたバッチの状況を出力します。
- [Completed]:処理は完了しています。
- [Failed]:処理に失敗しました。[結果情報_バッチ_状態メッセージ/RESULT_BATCH_stateMessage]を確認してください。
|
- [Completed]の場合においても、レコード単位に結果は異なります。
結果情報_レコードの内容を確認してください。
- API 50.0以降かつ、[API種別]が[Bulk API 2.0]のグローバルリソースを選択している場合、nullとなります。
|
結果情報_バッチ_状態メッセージ/RESULT_BATCH_stateMessage |
レコードが処理されたバッチの状態メッセージを出力します。 |
- API 50.0以降かつ、[API種別]が[Bulk API 2.0]のグローバルリソースを選択している場合、nullとなります。
|
結果情報_レコード_ID/RESULT_ROW_id |
レコードのIDを出力します。 |
|
結果情報_レコード_成功フラグ/RESULT_ROW_success |
レコードの成功フラグを出力します。
- [true]:処理に成功しました。
- [false]:処理に失敗しました。[結果情報_レコード_エラーメッセージ/RESULT_ROW_error]を確認してください。
|
- [結果情報_バッチ_状況/RESULT_BATCH_state]が[Completed]でない場合、[false]となります。
API 50.0以降かつ、[API種別]が[Bulk API 2.0]のグローバルリソースを選択している場合、エラーレコード(未処理レコードを含む)は、[false]となります。
|
結果情報_レコード_作成フラグ/RESULT_ROW_created |
レコードの新規作成フラグを出力します。
- [true]:レコードが新規作成されました。
- [false]:レコードの新規作成は行われませんでした。
|
|
結果情報_レコード_エラーメッセージ/RESULT_ROW_error |
レコードのエラーメッセージを出力します。 |
- 処理結果が取得できない場合、処理の状態メッセージを出力します。
|
コンポーネント変数名 |
説明 |
備考 |
job_id |
作成したジョブのIDが格納されます。 |
- デフォルト値はnullです。
- 入力データの件数または、容量に応じて繰り返しジョブを作成すると、複数のジョブのIDがカンマ区切りで格納されます。
|
read_count |
入力データの件数が格納されます。 |
|
created_batch_count |
作成したバッチの件数が格納されます。 |
- デフォルト値はnullです。
- API 50.0以降かつ、[API種別]が[Bulk API 2.0]のグローバルリソースを選択している場合、値が格納されません。
|
get_result_success_count |
処理に成功したデータの件数が格納されます。 |
- デフォルト値はnullです。
- [処理完了を待ちバッチ結果を取得する]または[処理完了を待ち結果を取得する]にチェックを入れない場合、値が格納されません。
|
get_result_error_count |
処理に失敗したデータの件数が格納されます。 |
- デフォルト値はnullです。
- [処理完了を待ちバッチ結果を取得する]または[処理完了を待ち結果を取得する]にチェックを入れない場合、値が格納されません。
|
server_url |
ログイン後のエンドポイントURLが格納されます。 |
|
session_id |
セッションIDが格納されます。 |
|
message_category |
エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。 |
|
message_code |
エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。 |
|
message_level |
エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。 |
|
operation_api_exception_code |
APIエラー発生時、発生したエラーのExceptionCodeが格納されます。 |
- デフォルト値はnullです。
- APIエラー以外のエラー発生時は、値が格納されません。
- DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
|
operation_error_message |
エラー発生時、発生したエラーのメッセージが格納されます。 |
- デフォルト値はnullです。
- DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
|
operation_error_trace |
エラー発生時、発生したエラーのトレース情報が格納されます。 |
- デフォルト値はnullです。
- DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
|
画像内の番号 |
名称 |
説明 |
備考 |
(1) |
必須処理 |
プロパティの設定値に関わらず、必須で実行される処理です。 |
|
(2) |
ジョブ/バッチ情報取得、バッチ結果取得の実行有無を選択 |
[Bulkオペレーション設定]タブの[処理完了を待ちバッチ結果を取得する]の値によって、実行有無を選択することができます。 |
- [処理完了を待ちバッチ結果を取得する]にチェックを入れた場合、処理が行われます。
|
(3) |
ジョブ更新(クローズ)の実行有無を選択 |
[Bulkオペレーション設定]タブの[実行後ジョブ状況]の値によって、実行有無を選択することができます。 |
- [実行後ジョブ状況]に「クローズする」を選択した場合、処理が行われます。
|
(4) |
バッチ作成の繰り返し |
入力データの件数または、容量に応じて繰り返しバッチ作成を行います。 |
|
(5) |
ジョブ/バッチ情報取得の繰り返し |
処理が完了するまで[Bulkオペレーション設定]タブの[バッチ状況監視間隔(秒)]の値の間隔で繰り返しジョブ/バッチ情報取得を行います。 |
|
(6) |
バッチ結果取得の繰り返し |
(4)で作成されたバッチ件数分繰り返しバッチ結果取得を行います。 |
|
例外名 |
原因 |
対策 |
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[] |
[接続先]が指定されていません。 |
[接続先]を指定してください。 |
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[<グローバルリソース名>] |
[接続先]で選択されたリソース定義が見つかりません。 |
[接続先]で指定したグローバルリソースを確認してください。 |
java.net.UnknownHostException |
グローバルリソースで指定したPROXYサーバが見つからない例外です。 |
PROXYサーバの状態を確認して下さい。または、[接続先]で指定したグローバルリソースの[Proxyホスト]を確認してください。 |
java.net.SocketTimeoutException connect timed out |
Salesforceに接続中にタイムアウトが発生しました。 |
ネットワークの状態、Salesforceのサーバの状態を確認してください。または、[接続先]で指定したグローバルリソースの[Connectionタイムアウト(秒)]を確認してください。 |
java.net.SocketTimeoutException Read timed out |
Salesforceに接続後、サーバからの応答までにタイムアウトが発生しました。 |
ネットワークの状態、Salesforceのサーバの状態を確認してください。または、[接続先]で指定したグローバルリソースの[タイムアウト(秒)]を確認してください。 |
jp.co.headsol.salesforce.adapter.exception.SalesforceAdapterIllegalArgumentException |
Salesforce Bulkアダプタのプロパティの設定値が不正です。 |
エラーメッセージを確認し、設定内容をご確認ください。 |
com.sforce.soap.partner.fault.LoginFault |
Salesforceへのログインに失敗しました。 |
ExceptionCodeまたは、エラーメッセージを確認し、Salesforceの関連ドキュメントなどに対象のエラーに関する情報がないか確認してください。 |
com.sforce.async.AsyncApiException |
Salesforce Bulkアダプタにて実行したジョブまたはバッチにてエラーが発生しました。 |
ExceptionCodeまたは、エラーメッセージを確認し、Salesforceの関連ドキュメントなどに対象のエラーに関する情報がないか確認してください。 |
jp.co.terrasky.salesforce.bulk.api.rest.exception.RestApiException |
Salesforce Bulkアダプタにて実行した処理にてエラーが発生しました。 |
ExceptionCodeまたは、エラーメッセージを確認し、Salesforceの関連ドキュメントなどに対象のエラーに関する情報がないか確認してください。 |