バッチ作成処理

オペレーション名

バッチ作成

機能概要

入力データを元にCSV形式のデータを作成し、指定したジョブに対してバッチ作成(Adding a Batch to a Job)のリクエストを発行します。
作成したバッチの情報は、出力スキーマから取得することができます。

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

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

データモデル

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

プロパティ

変数の使用については、「変数」を参照してください。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  
入力データ 必須 使用不可 スクリプトキャンバス上にあるコンポーネントを選択します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
接続先 必須 使用不可 グローバルリソースを選択します。
グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
 
ジョブID 必須 使用可 バッチを作成するジョブのIDを入力します。  
テーブル名 必須 使用不可 指定したジョブのオブジェクトに対応したSalesforceのテーブル名を選択します。  
スキーマ定義 必須 - バッチに登録するCSVデータのヘッダ行とする項目を設定します。
  • ジョブのオペレーション種類によって必要な項目が異なります。
    • 「UPDATE」の場合、「Id」を含む必要があります。
    • 「UPSERT」の場合、ジョブに指定されている「外部ID項目」を含む必要があります。
    • 「DELETE」の場合、「Id」のみとします。
  • Salesforceに対して書き込みが必要な項目に限定(不要な項目をスキーマ定義から除く)することにより、処理効率が向上します。
  • データ型が「base64」と定義された項目を扱うことはできません。このような項目が選択されている場合、エラーが発生します。
スキーマ定義/ラベル 必須 使用不可 [テーブル名]で指定したテーブルの列のラベル名を表示します。  
スキーマ定義/API 必須 使用不可 [テーブル名]で指定したテーブルの列のAPI名を表示します。  
スキーマ定義/型 必須 使用不可 [テーブル名]で指定したテーブルの列のデータ型を表示します。  
リレーションシップ項目定義 省略可 - スキーマ定義にリレーション項目が存在する場合、外部キーによる更新を行うための項目を設定します。
  • リレーション先オブジェクトの外部キー項目を選択することにより、リレーション関係を持たせたデータの受け渡しが可能となります。
    詳細については、「リレーションシップ項目定義」を参照してください。
  • API 43.0以降のグローバルリソースを選択している場合、多態的な項目による更新が可能となります。
    多態的な項目は、[リレーション用カラムAPI名]で指定します。
    多態的な項目の詳細はSalesforceのドキュメントをご確認ください。
リレーションシップ項目定義/元項目API名 必須 使用不可 [テーブル名]で指定したテーブルのリレーション項目の列のAPI名を表示します。  
リレーションシップ項目定義/リレーションシップ名 必須 使用不可 [テーブル名]で指定したテーブルのリレーション項目の列のリレーションシップ名を表示します。  
リレーションシップ項目定義/オブジェクトAPI名 省略可 使用不可 [テーブル名]で指定したテーブルのリレーション項目の列のリレーション先のオブジェクトのAPI名を選択します。  
リレーションシップ項目定義/リレーション用カラムAPI名 省略可 使用不可 [テーブル名]で指定したテーブルのリレーション項目の列のリレーション先オブジェクトの外部キー項目を選択します。
  • 省略した場合、リレーション先オブジェクトの該当レコードのIDを受け渡す仕様となります。
プロパティアクション
項目名 説明 備考
スキーマの作成 バッチに登録するCSVデータのヘッダ行の追加・削除を行うことができます。
設定方法については、「スキーマの作成」を参照してください。
 
オプション設定
項目名 必須/省略可 変数の使用 説明 備考
Null/空文字を"#N/A"へ置き換える 必須 使用不可 入力データがnullまたは空文字であった場合、文字列「#N/A」に置き換えるかどうかを選択します。
  • [チェックあり]:(デフォルト)
    置き換えを行います。
  • [チェックなし]:
    置き換えを行いません。
  • APIの仕様として、nullで更新する場合は文字列「#N/A」を指定する必要があります。
バッチサイズ 必須 使用可 1つのバッチに登録するレコード件数の上限を入力します。

  • デフォルト値は「2000」です。
  • 「1」以上「10000」以下の値が指定できます。範囲以外の値が指定された場合、エラーが発生します。
  • 本アダプタの仕様として、100,000件のデータを書き込むケースで、バッチサイズを2,000と設定した場合、50のバッチを作成します。
    ただし、1つのバッチがAPIの制限値である「10MB」を超えてしまう場合は、指定したバッチサイズ以下でバッチを作成します。
カラム名タイプ 必須 使用不可 マッピングでスキーマを表示する際のカラム名の表示タイプを選択します。
  • [ラベル]:
    Salesforceで定義されたラベル名(項目名)で表示します。
  • [API]:(デフォルト)
    Salesforceで定義されたAPI参照名で表示します。
 
プロパティアクション
項目名 説明 備考
テーブル情報の表示 操作を行っているオブジェクトのテーブル構造を確認できます。
テーブル構造の参照方法については、「テーブル情報の表示」を参照してください。
  • 他のオブジェクトのテーブル構造を確認したい場合、[全テーブル情報の読み込み]をクリックしてください。
全テーブル情報の読み込み 取得可能なすべてのテーブル構造を取得します。
実行後に、[テーブル情報の表示]から取得した内容を確認することができます。
 
ファイルからスキーマ定義を読み取り ファイルチューザでファイルを選択して、そのファイルの1行目にカンマ区切りで指定された項目(API)を読み取り、スキーマ定義として設定します。
  • 選択するファイルのエンコードは「UTF-8」を指定してください。
データ処理方式
項目名 必須/省略可 変数の使用 説明 備考
データ処理方式 必須 使用不可 データ処理方式を選択します。
  • [スクリプトの設定を使用する]:(デフォルト)
    スクリプトプロパティの大容量データ処理の設定をアダプタに使用します。
  • [大容量データ処理を行わない]:
    大容量データ処理を行いません。
  • [大容量データ処理を行う]:
    大容量データ処理を行います。
 
コメント
項目名 必須/省略可 変数の使用 説明 備考
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。
 

スキーマ

入力スキーマ

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

出力スキーマ

作成したバッチの情報を設定します。
(以下、「ラベル/API」という形式で表記)

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>バッチID/batchId</column>
    <column>状況/state</column>
    <column>状態メッセージ/stateMessage</column>
    <column>開始時刻/createdDate</column>
    <column>投入レコード件数/inputRecordCount</column>
  </row>
  <row>
    :
  </row>
</table>
要素名 列名(ラベル/API) 説明 備考
row
-
作成したバッチの件数分繰り返します。  
column バッチID/batchId バッチIDを出力します。  
状況/state バッチの状況を出力します。
  • [Queued]:処理はまだ始まっていません。
  • [InProgress]:現在処理されています。
  • [Completed]:処理は完了しています。
  • [Failed]:処理に失敗しました。[stateMessage]を確認してください。
  • [Not Processed]:処理前にジョブが中止されました。
 
状態メッセージ/stateMessage バッチの状態メッセージを出力します。  
開始時刻/createdDate バッチの開始時刻を出力します。  
投入レコード件数/inputRecordCount バッチに投入したレコード件数を出力します。  

Mapperでのスキーマ読み込み

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

大容量データ処理

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

トランザクション

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

PSPでの使用について

PSPでは使用できません。

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

コンポーネント変数名 説明 備考
job_id 指定したジョブのIDが格納されます。
  • デフォルト値はnullです。
read_count 入力データの件数が格納されます。
  • デフォルト値はnullです。
created_batch_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のバージョンにより、格納される内容が変わる可能性があります。

リレーションシップ項目定義

参照項目(Reference項目)の更新処理では、通常、参照先オブジェクトのIDをMapperにて受け渡して更新しますが、当設定を行うことにより、参照先オブジェクトの外部キー項目の値をMapperにて受け渡すことで、外部キーに対応するレコードのIDを自動で取得し更新することが可能となります。

スキーマの作成

バッチに登録するCSVデータのヘッダ行とする項目をスキーマの作成で指定することができます。
処理に必要な項目のみを指定することにより、Salesforceに対する通信データ量を削減することができ、一般的に処理効率が向上します。
Salesforceへ書き込み(追加・更新)を行なう場合、「追加不可」または「更新不可」の項目は未選択にする必要があります。



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

テーブル情報の表示

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



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

仕様制限

主な例外

例外名 原因 対策
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の関連ドキュメントなどに対象のエラーに関する情報がないか確認してください。

注意事項