BatchProcessJobDefinition
一括管理ジョブ定義の詳細を表します。Metadata メタデータ型を拡張し、その fullName 項目を継承します。
ファイルのサフィックスおよびディレクトリの場所
BatchProcessJobDefinition コンポーネントのサフィックスは .batchProcessJobDefinition で、batchProcessJobDefinitions フォルダに保存されます。
バージョン
BatchProcessJobDefinition コンポーネントは、API バージョン 51.0 以降で使用できます。
特別なアクセスルール
このメタデータ型を使用するには、Salesforce 組織に Loyalty Management または Rebate Management ライセンスが必要です。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| batchSize | integer | 必須。各一括管理ジョブで処理できるレコード数。各一括処理ジョブは、最大 200 件のレコードを処理できます。 |
| dataSource | BatchDataSource[] | 必須。一括管理ジョブでレコードを処理する情報源。 |
| description | string | 一括管理ジョブの説明 (最大 255 文字)。 |
| flowApiName | string | 必須。一括処理ジョブを実行する有効なフロープロセスの API 参照名。 |
| flowInputVariable | string | 必須。一括処理ジョブで使用される、関連付けられているフローの入力変数。 |
| masterLabel | string | 必須。一括管理ジョブの名前 (最大 80 文字)。 |
| processGroup | string | 必須。一括管理ジョブでレコードを処理するグループの名前。 |
| retryCount | integer | 必須。この一括管理ジョブが失敗した場合に再実行する回数。最大再試行回数は 3 回です。有効な値は 1 ~ 3 です。 |
| retryInterval | integer | 必須。一括管理ジョブが失敗し��場合に再実行するまでの時�� (ミリ秒)。有効な値は 1,000 ~ 10,000 です。 |
| status | string | 一括管理ジョブの状況を示します。有効な値は、Active および Inactive です。 |
一括管理ジョブでレコードを処理する情報源を表します。
項目
| 項目名 | 項目の型 | 説明 |
|---|---|---|
| condition | string | 必須。レコードを絞り込むために定義された条件。 |
| criteria | string | 処理するレコードを絞り込むために使用される検索条件の種別。 |
| filters | BatchDataSrcFilterCriteria[] | 一括管理ジョブで処理するレコードを決定する検索条件。 |
| sourceObject | string | 必須。一括処理ジョブでレコードを処理するオブジェクトの API 参照名。 |
一括管理ジョブで処理するレコードを決定する検索条件を表します。
項目
宣言的なメタデータの定義のサンプル
BatchProcessJobDefinition コンポーネントの例を次に示します。
メタデータ API で使用されるフローオブジェクトの例を次に示します。
前の定義を参照する package.xml の例を次に示します。
マニフェストファイル内のワイルドカードのサポート
このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。