Bulkデータ書き込み(DELETE)処理(旧)

オペレーション名

Bulkデータ書き込み(DELETE)

機能概要

入力データを元に、Bulk APIを使用したDELETE処理を行います。

ジョブ作成、バッチ作成、バッチ結果の取得、ジョブのクローズまで一括で行います。

DELETE処理では、データ削除時のキー項目にSalesforceのIDを指定します。

 

= 備考 =

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

  • 「Salesforce Developer Documentation」-(https://developer.salesforce.com/docs)

    • Bulk API Developer's Guide

データモデル

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

プロパティ

= 備考 =

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

基本設定

項目名

必須/省略可

変数の使用

説明

備考

名前

必須

使用不可

スクリプトキャンバス上での名前を入力します。

 

入力データ

必須

使用不可

スクリプトキャンバス上にあるコンポーネントを選択します。

 

必須設定

項目名

必須/省略可

変数の使用

説明

備考

接続先

必須

使用不可

コネクションリソースを選択します。

[追加]

新規にコネクションリソースを追加します。

[一覧の編集]

> HULFT INTEGRATE > コネクションで、コネクションリソースの設定を編集することができます。

 

テーブル名

必須

使用不可

Salesforceのテーブル名を選択します。

 

スキーマ定義

必須

-

バッチに登録するCSVデータのヘッダ行とする項目として「ID」が選択されています。編集を行うことはできません。

 

スキーマ定義/ラベル

必須

使用不可

入力スキーマ項目のラベル名を表示します。

 

スキーマ定義/API

必須

使用不可

入力スキーマ項目のAPI名を表示します。

 

スキーマ定義/型

必須

使用不可

入力スキーマ項目のデータ型を表示します。

 

オプション設定

項目名

必須/省略可

変数の使用

説明

備考

HardDelete(物理削除)

必須

使用不可

物理削除(HardDelete)を行うかどうかを選択します。

[チェックあり]

オペレーション種類をHardDeleteとして実行します。

[チェックなし]

(デフォルト)

オペレーション種類をDeleteとして実行します。

  • API 23.0以降で指定可能です。

注意

チェックありとした場合、削除されたレコードはごみ箱に保存されません。代わりに、即座に削除の対象となります。

この操作の権限である「Bulk API の物理削除」は、デフォルトでは無効になっており、システム管理者によって有効にする必要があります。

物理削除を行うには、Salesforce ユーザライセンスが必要です。

カラム名タイプ

必須

使用不可

マッピングでスキーマを表示する際のカラム名の表示タイプを選択します。

[ラベル]

Salesforceで定義されたラベル名(項目名)で表示します。

[API]

(デフォルト)

Salesforceで定義されたAPI参照名で表示します。

 

バッチサイズ

必須

使用可

1つのバッチに登録するレコード件数の上限を入力します。

  • デフォルト値は「2000」です。

  • 「1」以上「10000」以下の値が指定できます。範囲以外の値が指定された場合、エラーが発生します。

注意

本コネクターの仕様として、100,000件のデータを書き込むケースで、バッチサイズを2,000と設定した場合、50のバッチを作成します。

ただし、1つのバッチがAPIの制限値である10MBを超えてしまう場合は、指定したバッチサイズ以下でバッチを作成します。

同時実行モード

必須

使用不可

ジョブの同時実行モードを選択します。

[並列]

(デフォルト)

並列モードでジョブを作成します。

[順次]

順次モードでジョブを作成します。

注意

並列処理を行うと、データベースの競合が生じる可能性があります。競合が激しいと、読み込みが失敗することがあります。

順次モードを使用すれば、バッチは1つずつ確実に処理されます。ただし、このオプションを使用すると、読み込みの処理時間が大幅に増える場合があります。

処理完了を待ちバッチ結果を取得する

必須

使用不可

作成したバッチが完了するまで状況を監視し、バッチ結果を取得するかどうかを選択します。

[チェックあり]

(デフォルト)

バッチ結果を取得します。取得したバッチ結果は出力スキーマから後続に渡すことができます。

[チェックなし]

バッチ結果を取得しません。

  • チェックありとした場合、スキーマ定義に指定した項目および結果情報の項目をテーブルモデル型のデータとして後続に受け渡すことができます。

  • 取得する情報については、「スキーマ」を参照してください。

監視開始までの待機時間(秒)

省略可

使用可

バッチ状況の監視を開始するまでの待機時間を、秒で入力します。

  • デフォルト値は「3」です。

  • [処理完了を待ちバッチ結果を取得する]にチェックを入れた場合のみ有効になります。

  • 3以上10800以下が指定可能です。範囲以外の値が指定された場合、エラーが発生します。

バッチ状況監視間隔(秒)

省略可

使用可

バッチ情報を取得し処理が完了しているか判断する間隔を、秒で入力します。

  • デフォルト値は「10」です。

  • [処理完了を待ちバッチ結果を取得する]にチェックを入れた場合のみ有効になります。

  • 10以上600以下が指定可能です。範囲以外の値が指定された場合、エラーが発生します。

最大監視時間(秒)

必須

使用不可

バッチ状況の最大監視時間を、秒で入力します。

  • デフォルト値は「14400」です。

  • [処理完了を待ちバッチ結果を取得する]にチェックを入れた場合のみ有効になります。

  • 1以上が指定可能です。範囲以外の値が指定された場合、エラーが発生します。

コメント

項目名

必須/省略可

変数の使用

説明

備考

コメント

省略可

使用不可

このコネクターの簡単な説明を記述することができます。

 

スキーマ

入力スキーマ

(以下、「ラベル/API」という形式で表記)

 

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

要素名

列名

説明

備考

row

-

入力データ件数分繰り返します。

 

column

ID/id

SalesforceのIDを渡します。

 

出力スキーマ

入力スキーマのカラムに、バッチ結果の情報が付与されます。

(以下、「ラベル/API」という形式で表記)

 

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>ID/Id</column>
    <column>結果情報_入力行番号/RESULT_inputRowNumber</column>
    <column>結果情報_バッチ_ID/RESULT_BATCH_id</column>
    <column>結果情報_バッチ_状況/RESULT_BATCH_state</column>
    <column>結果情報_バッチ_状態メッセージ/RESULT_BATCH_stateMessage</column>
    <column>結果情報_レコード_ID/RESULT_ROW_id</column>
    <column>結果情報_レコード_成功フラグ/RESULT_ROW_success</column>
    <column>結果情報_レコード_作成フラグ/RESULT_ROW_created</column>
    <column>結果情報_レコード_エラーメッセージ/RESULT_ROW_error</column>
  </row>
  <row>
    :
  </row>
</table>

要素名

列名(ラベル/API)

説明

備考

row

-

入力スキーマに渡されたデータ件数分繰り返します。

  • [処理完了を待ちバッチ結果を取得する]にチェックを入れない場合、0件となります。

column

ID/id

入力スキーマに渡されたIDを出力します。

 

結果情報_入力行番号/RESULT_inputRowNumber

入力スキーマに渡されたデータ内のノードの位置に基づいて番号を出力します。

 

結果情報_バッチ_ID/RESULT_BATCH_id

レコードが処理されたバッチのIDを出力します。

 

結果情報_バッチ_状況/RESULT_BATCH_state

レコードが処理されたバッチの状況を出力します。

[Completed]

処理は完了しています。

[Failed]

処理に失敗しました。[結果情報_バッチ_状態メッセージ/RESULT_BATCH_stateMessage]を確認してください。

  • [Completed]の場合においても、レコード単位に結果は異なります。

    結果情報_レコードの内容を確認してください。

結果情報_バッチ_状態メッセージ/RESULT_BATCH_stateMessage

レコードが処理されたバッチの状態メッセージを出力します。

 

結果情報_レコード_ID/RESULT_ROW_id

レコードのIDを出力します。

 

結果情報_レコード_成功フラグ/RESULT_ROW_success

レコードの成功フラグを出力します。

[true]

処理に成功しました。

[false]

処理に失敗しました。

[結果情報_レコード_エラーメッセージ/RESULT_ROW_error]を確認してください。

  • [結果情報_バッチ_状況/RESULT_BATCH_state][Completed]でない場合、[false]となります。

結果情報_レコード_作成フラグ/RESULT_ROW_created

レコードの新規作成フラグを出力します。

[true]

レコードが新規作成されました。

[false]

レコードの新規作成は行われませんでした。

 

結果情報_レコード_エラーメッセージ/RESULT_ROW_error

レコードのエラーメッセージを出力します。バッチ結果が取得できない場合、レコードが処理されたバッチの状態メッセージを出力します。

 

Mapperでのスキーマ読み込み

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

= 備考 =

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

大容量データ処理

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

トランザクション

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

PSPでの使用について

PSPでは使用できません。

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

コンポーネント変数名

説明

備考

job_id

作成したジョブのIDが格納されます。

  • デフォルト値はnullです。

read_count

入力データの件数が格納されます。

  • デフォルト値はnullです。

created_batch_count

作成したバッチの件数が格納されます。

  • デフォルト値はnullです。

get_result_success_count

処理に成功したデータの件数が格納されます。

  • デフォルト値はnullです。

  • [処理完了を待ちバッチ結果を取得する]にチェックを入れない場合、値が格納されません。

get_result_error_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エラー以外のエラー発生時は、値が格納されません。

operation_error_message

エラー発生時、発生したエラーのメッセージが格納されます。

  • デフォルト値はnullです。

operation_error_trace

エラー発生時、発生したエラーのトレース情報が格納されます。

  • デフォルト値はnullです。

メッセージコード、例外メッセージ、制限事項

コネクター

メッセージコード

エラーメッセージ

制限事項

Salesforce(旧) コネクターのメッセージおよび制限事項

check

check

check