BatchProcessJobDefinition | メタデータ API 開発者ガイド

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

ファイルのサフィックスおよびディレクトリの場所

BatchProcessJobDefinition コンポーネントのサフィックスは .batchProcessJobDefinition で、batchProcessJobDefinitions フォルダに保存されます。

バージョン

BatchProcessJobDefinition コンポーネントは、API バージョン 51.0 以降で使用できます。

特別なアクセスルール

このメタデータ型を使用するには、Salesforce 組織に Loyalty Management または Rebate Management ライセンスが必要です。ロイヤルティプログラムプロセス種別は、ロイヤルティ管理が有効な組織でのみ使用できます。

項目

項目名	項目の型	説明
batchSize	integer	必須。各一括管理ジョブで処理できるレコード数。フロー種別の一括管理ジョブは最大 2000 レコードまで処理でき、プログラムプロセス種別の一括管理ジョブは最大 250 レコードまで処理できます。
dataSource	BatchDataSource[]	必須。一括管理ジョブでレコードを処理する情報源。
description	string	一括管理ジョブの説明 (最大 255 文字)。
executionProcessApiName	string	一括管理ジョブによって実行する必要があるプロセスの API 参照名。この項目は、API バージョン 55.0 以降で使用できます。一括処理ジョブの種別がフローの場合、一括処理ジョブで実行する必要がある有効なフローの API 名を入力します。一括処理ジョブの種別がロイヤリティプログラムプロセスの場合、次の該当するものを入力します。一括処理で取引記録レコードを処理する際に、TransactionJournal 種別の適用可能で有効なロイヤルティプログラムプロセスを適用する場合には、Transaction_Journals を入力します。一括処理ジョブでロイヤルティプログラムプロセスを実行し、対象メンバーのランクを評価する場合には、TierProcessing 種別の有効なロイヤルティプロセスの API 参照名を入力します。API 参照名は、プロセス名、プロセス種別、ポイントプログラム名の 3 つを連続する 2 つのアンダースコアで区切ったものです。たとえば、プロセス名が「Update Member Tier」、プロセス種別が「TierProcessing」、ロイヤルティプログラム名が「Inner Circle」の場合、プロセスの API 参照名は`「Update Member Tier__TierProcessing__Inner Circle」`となります。
flowApiName	string	一括管理ジョブによって実行する必要がある、有効なフロープロセスの API 参照名。フロー API 名は、`executionProcessApiName` 項目で指定するか、`flowApiName` 項目で指定します。メモ
flowInputVariable	string	一括処理ジョブでレコードを一意に識別するために使用される、関連付けられたフローの入力変数。
masterLabel	string	必須。一括管理ジョブの名前 (最大 80 文字)。
processGroup	string	必須。一括管理ジョブでレコードを処理するグループの名前。
retryCount	integer	必須。この一括管理ジョブが失敗した場合に再実行する回数。最大再試行回数は 3 回です。有効な値は 1 ～ 3 です。
retryInterval	integer	必須。一括管理ジョブが失敗した場合に再実行するまでの時間 (ミリ秒)。有効な値は 1,000 ～ 10,000 です。
status	string	一括管理ジョブの状況を示します。有効な値は、`Active` および `Inactive` です。
type	string (string 型の列挙)	一括管理��ョブで実行する必要があるプロセスの種別。この項目は、API バージョン 55.0 以降で使用できます。有効な値は、次のとおりです。 `Flow` `ロイヤルティプログラムプロセス`

BatchDataSource

一括管理ジョブでレコードを処理する情報源を表します。

項目

項目名	項目の型	説明
condition	string	必須。レコードを絞り込むために定義された条件。
criteria	string	処理するレコードを絞り込むために使用される検索条件の種別。
filters	BatchDataSrcFilterCriteria[]	一括管理ジョブで処理するレコードを決定する検索条件。
sourceObject	string	必須。一括処理ジョブでレコードを処理するオブジェクトの API 参照名。一括処理ジョブの種別がロイヤリティプログラムプロセスの場合、この取得元オブジェクトは次の条件に該当するオブジェクトにする必要があります。一括処理ジョブを使用し、適用可能なロイヤルティプログラムプロセスを適用することにより取引記録を処理する場合には、TransactionJournal を指定します。 executionProcessApiName 項目で指定されたロイヤルティプログラムプロセスにより、ロイヤルティプログラムメンバーのランクを評価する必要がある場合は、そのメンバーの詳細を保存するオブジェクトを指定します。
sourceObjectField	string	一括処理ジョブが実行されるレコードを一意に識別する取得元オブジェクト項目の API 参照名。この項目は、API バージョン 57.0 以降で使用できます。この項目は、一括処理ジョブの種別がロイヤルティプログラムプロセスで、executionProcessApiName 項目に TierProcess 種別の有効なロイヤルティプログラムプロセスが指定されている場合にのみ適用されます。LoyaltyProgramMember オブジェクトを参照し、ランクを評価する必要があるメンバーを一意に特定する項目の API 参照名を指定します。

BatchDataSrcFilterCriteria

一括管理ジョブで処理するレコードを決定する検索条件を表します。

項目

項目名	項目の型	説明
dynamicValueType	string	検索条件として使用する入力変数のデータ型。
fieldName	string	必須。レコードの絞り込みに使用される項目の名前。
fieldValue	string	必須。絞り込む項目の値。`isDynamicValue` が `False` に設定されている場合は項目を指定します。
isDynamicValue	boolean	必須。検索条件が動的であるかどうかを示します。
operator	string (string 型の列挙)	必須。検索条件に指定される演算子。有効な値は、次のとおりです。 `equals` `excludes` `greaterThan` `greaterThanOrEqualTo` `in` `includes` `lessThan` `LessThanOrEqualTo` `GreaterOrEqual` `like` `notEquals` `notIn`
sequenceNo	integer	必須。検索条件の条件を参照するために使用される連番。

宣言的なメタデータの定義のサンプル

BatchProcessJobDefinition コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<BatchProcessJobDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3   <batchSize>10</batchSize>
4   <dataSource>
5      <condition>1</condition>
6      <criteria>all</criteria>
7      <filters>
8         <dynamicValue>false</dynamicValue>
9         <dynamicValueType>string</dynamicValueType>
10         <fieldName>Name</fieldName>
11         <fieldValue>abcd</fieldValue>
12         <operator>equals</operator>
13         <sequenceNo>1</sequenceNo>
14      </filters>
15      <sourceObject>Account</sourceObject>
16   </dataSource>
17   <flowApiName>Flow1</flowApiName>
18   <flowInputVariable>recordId</flowInputVariable>
19   <masterLabel>BatchJob1</masterLabel>
20   <processGroup>Loyalty</processGroup>
21   <retryCount>2</retryCount>
22   <retryInterval>1000</retryInterval>
23   <status>Inactive</status>
24   <description>test</description>
25   <type>Flow</type>
26   <executionProcessApiName>testFlow</executionProcessApiName>
27</BatchProcessJobDefinition>

メタデータ API で使用されるフローオブジェクトの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3   ~ Copyright 2020 Salesforce, Inc.
4   ~ All Rights Reserved
5   ~ Company Confidential
6-->
7<Flow xmlns="http://soap.sforce.com/2006/04/metadata">
8   <apiVersion>51.0</apiVersion>
9   <interviewLabel>Flow1 {!$Flow.CurrentDateTime}</interviewLabel>
10   <label>Flow1</label>
11   <processMetadataValues>
12      <name>BuilderType</name>
13      <value>
14         <stringValue>LightningFlowBuilder</stringValue>
15      </value>
16   </processMetadataValues>
17   <processMetadataValues>
18      <name>OriginBuilderType</name>
19      <value>
20         <stringValue>LightningFlowBuilder</stringValue>
21      </value>
22   </processMetadataValues>
23   <processType>AutoLaunchedFlow</processType>
24   <recordLookups>
25      <name>getAcc</name>
26      <label>getAcc</label>
27      <locationX>614</locationX>
28      <locationY>465</locationY>
29      <assignNullValuesIfNoRecordsFound>false</assignNullValuesIfNoRecordsFound>
30      <filterLogic>and</filterLogic>
31      <filters>
32         <field>Id</field>
33         <operator>EqualTo</operator>
34         <value>
35            <elementReference>recordId</elementReference>
36         </value>
37      </filters>
38      <getFirstRecordOnly>true</getFirstRecordOnly>
39      <object>Account</object>
40      <storeOutputAutomatically>true</storeOutputAutomatically>
41   </recordLookups>
42   <start>
43      <locationX>73</locationX>
44      <locationY>213</locationY>
45      <connector>
46         <targetReference>getAcc</targetReference>
47      </connector>
48   </start>
49   <status>Draft</status>
50   <variables>
51      <name>recordId</name>
52      <dataType>String</dataType>
53      <isCollection>false</isCollection>
54      <isInput>true</isInput>
55      <isOutput>false</isOutput>
56   </variables>
57</Flow>

前の定義を参照する package.xml の例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3   <types>
4      <members>*</members>
5      <name>BatchProcessJobDefinition</name>
6   </types>
7   <types>
8      <members>Flow1</members>
9      <name>Flow</name>
10   </types>
11   <version>51.0</version>
12</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。