ジョブ/バッチ情報取得処理

オペレーション名

ジョブ/バッチ情報取得

機能概要

指定したジョブのジョブ情報取得(Getting Job Details)および、バッチ情報リスト取得(Getting Information for All Batches in a Job)のリクエストを発行します。
指定したジョブの情報は、コンポーネント変数より取得することができます。
また、バッチ情報リストは、出力スキーマより取得することができます。

本コンポーネントはBulk APIの最小単位のオペレーションを実現する機能となります。
ジョブ作成、バッチ作成、バッチ結果の取得、ジョブのクローズまで一括で行う[Bulkデータ書き込み(INSERT)]などの機能を使用する場合であれば、一般的に本コンポーネントを使用する必要はありません。

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

「Salesforce Developer Documentation」-(https://developer.salesforce.com/docs)
- Bulk API Developer's Guide

データモデル

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

プロパティ

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

基本設定

項目名	必須/省略可	変数の使用	説明	備考
名前	必須	使用不可	スクリプトキャンバス上での名前を入力します。

必須設定

項目名	必須/省略可	変数の使用	説明	備考
接続先	必須	使用不可	グローバルリソースを選択します。グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。 [追加]: 新規にグローバルリソースを追加します。 [一覧の編集]: 「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
ジョブID	必須	使用可	指定するジョブのIDを入力します。

データ処理方式

項目名	必須/省略可	変数の使用	説明	備考
データ処理方式	必須	使用不可	データ処理方式を選択します。 [スクリプトの設定を使用する]:(デフォルト) スクリプトプロパティの大容量データ処理の設定をアダプタに使用します。 [大容量データ処理を行わない]: 大容量データ処理を行いません。 [大容量データ処理を行う]: 大容量データ処理を行います。

項目名	必須/省略可	変数の使用	説明	備考
コメント	省略可	使用不可	このアダプタの簡単な説明を記述することができます。説明を記述すると、仕様書に反映させることができます。

スキーマ

入力スキーマ

ありません。

出力スキーマ

取得したジョブに含まれるバッチ情報を出力します。

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>batchId</column>
    <column>numberRecordsProcessed</column>
    <column>createdDate</column>
    <column>state</column>
    <column>stateMessage</column>
    <column>systemModstamp</column>
    <column>numberRecordsFailed</column>
    <column>apexProcessingTime</column>
    <column>apiActiveProcessingTime</column>
    <column>totalProcessingTime</column>
  </row>
  <row>
    :
  </row>
</table>

要素名	列名	説明	備考
row	-	ジョブに含まれるバッチの件数分繰り返します。
column	batchId	バッチIDを出力します。
	numberRecordsProcessed	バッチの処理済みレコード件数を出力します。
	createdDate	バッチの開始時刻を出力します。
	state	バッチの状況を出力します。 [Queued]:処理はまだ始まっていません。 [InProgress]:現在処理されています。 [Completed]:処理は完了しています。 [Failed]:処理に失敗しました。[stateMessage]を確認してください。 [Not Processed]:処理前にジョブが中止されました。
	stateMessage	バッチの状態メッセージを出力します。
	systemModstamp	バッチのSystemModstampを出力します。
	numberRecordsFailed	バッチで正常に処理されなかったレコード件数を出力します。	API 18.0 の場合、未対応バージョンのためスキーマは表示されません。
	apexProcessingTime	バッチに関連するトリガおよび他のプロセスの処理時間（ミリ秒）が格納されます。	API 18.0 の場合、未対応バージョンのためスキーマは表示されません。
	apiActiveProcessingTime	指定したバッチの処理時間（ミリ秒）が格納されます。バッチがキューで処理を待機している時間や、逐次化および並列化に要する時間は含まれません。	API 18.0 の場合、未対応バージョンのためスキーマは表示されません。
	totalProcessingTime	指定したバッチの合計処理時間（ミリ秒）が格納されます。バッチがキューで処理を待機している時間は含まれません。	API 18.0 の場合、未対応バージョンのためスキーマは表示されません。

Mapperでのスキーマ読み込み

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

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

大容量データ処理

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

トランザクション

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

PSPでの使用について

PSPでは使用できません。

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

コンポーネント変数名	説明	備考
job_id	指定したジョブのIDが格納されます。	デフォルト値はnullです。
object	指定したジョブのオブジェクトAPI名が格納されます。	デフォルト値はnullです。
external_id_field_name	指定したジョブの外部ID項目API名が格納されます。	デフォルト値はnullです。
concurrency_mode	指定したジョブの同時実行モードが格納されます。	デフォルト値はnullです。
content_type	指定したジョブのコンテンツタイプが格納されます。	デフォルト値はnullです。
state	指定したジョブの状況が格納されます。	デフォルト値はnullです。
operation	指定したジョブのオペレーション種類が格納されます。	デフォルト値はnullです。
created_by_id	指定したジョブの作成者IDが格納されます。	デフォルト値はnullです。
created_date	指定したジョブの作成時刻が格納されます。	デフォルト値はnullです。
number_batches_completed	指定したジョブの完了したバッチ数が格納されます。	デフォルト値はnullです。
number_batches_queued	指定したジョブのキューにあるバッチ数が格納されます。	デフォルト値はnullです。
number_batches_failed	指定したジョブの失敗したバッチ数が格納されます。	デフォルト値はnullです。
number_batches_progress	指定したジョブの処理中のバッチ数が格納されます。	デフォルト値はnullです。
number_batches_total	指定したジョブの総バッチ数が格納されます。	デフォルト値はnullです。
number_records_processed	指定したジョブの処理済みレコード数が格納されます。	デフォルト値はnullです。
number_records_failed	指定したジョブで正常に処理されなかったレコード数が格納されます。	デフォルト値はnullです。 API 18.0 の場合、未対応バージョンのため値が格納されません。
number_retries	指定したジョブの再試行回数が格納されます。	デフォルト値はnullです。
apex_processing_time	指定したジョブに関連するトリガおよび他のプロセスの処理時間（ミリ秒）が格納されます。	デフォルト値はnullです。 API 18.0 の場合、未対応バージョンのため値が格納されません。
api_active_processing_time	指定したジョブの処理時間（ミリ秒）が格納されます。ジョブがキューで処理を待機している時間や、逐次化および並列化に要する時間は含まれません。	デフォルト値はnullです。 API 18.0 の場合、未対応バージョンのため値が格納されません。
total_processing_time	指定したジョブの合計処理時間（ミリ秒）が格納されます。ジョブがキューで処理を待機している時間は含まれません。	デフォルト値はnullです。 API 18.0 の場合、未対応バージョンのため値が格納されません。
system_modstamp	指定したジョブのシステム時刻が格納されます。	デフォルト値は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のバージョンにより、格納される内容が変わる可能性があります。

仕様制限

本アダプタによるデータ読み取り・書き込みの操作を行うには、Salesforceの組織がAPIを公開している必要があります。

各テーブルに対するデータ読み取り・書き込みなどの操作権限、およびデータのアクセスコントロールは、すべてSalesforce側のプロファイル、共有ルールの設定、およびAPI仕様に依存します。

主な例外

例外名	原因	対策
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	SalesforceBulkアダプタのプロパティの設定値が不正です。	エラーメッセージを確認し、設定内容をご確認ください。
com.sforce.soap.partner.fault.LoginFault	Salesforceへのログインに失敗しました。	ExceptionCodeまたは、エラーメッセージを確認し、Salesforceの関連ドキュメントなどに対象のエラーに関する情報がないか確認してください。
com.sforce.async.AsyncApiException	SalesforceBulkアダプタにて実行したジョブまたはバッチにてエラーが発生しました。	ExceptionCodeまたは、エラーメッセージを確認し、Salesforceの関連ドキュメントなどに対象のエラーに関する情報がないか確認してください。