この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

BatchCalcJobDefinition

データ処理エンジン定義を表します。Metadata メタデータ型を拡張し、その fullName ���目を継承します。

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

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

バージョン

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

特別なアクセスルール

このメタデータ型を使用するには、次のいずれかのライセンスが必要です。
  • ロイヤルティ管理
  • Financial Services Cloud
  • 払い戻し管理
  • Manufacturing Cloud

項目

項目名 項目の型 説明
aggregates BatchCalcJob​​​Aggregate[] データ処理エンジンの集計ノードのコレクション。
appends BatchCalcJobUnion[] データ処理エンジンの追加ノードのコレクション。
datasources BatchCalcJob​Datasource[] データ処理エンジンのデータソースノードのコレクション。
description string データ処理エンジン定義の説明。
filters BatchCalcJobFilter[] データ処理エンジン定義の検索条件ノードのコレクション。
hierarchyPaths BatchCalcJobHierarchyPath[] データ処理エンジン定義の階層パスノードのコレクション。
isTemplate boolean これがテンプレートのデータ処理エンジン定義であるかどうかを示します。
joins BatchCalcJobSource​Join[] データ処理エンジンの結合ノードのコレクション。
label string データ処理エンジン定義の表示ラベル。
parameters BatchCalcJobParameter[] データ処理エンジンの入力変数のコレクション。
processType BatchCalcProcessType (string 型の列挙) データ処理エンジンのプロセス種別。有効な値は、次のとおりです。
  • DataProcessingEngine
  • Rebates
  • FSCHierarchyRollUp
  • Loyalty
  • AdvancedAccountForecast
  • LoyaltyPointsAggregation
status BatchJobDefinition​Status (string 型の列挙) データ処理エンジン定義の状況。有効な値は、次のとおりです。
  • Active
  • Inactive
transforms BatchCalcJobTransform[] データ処理エンジンのデータ変換ノードのコレクション。
writebacks BatchCalcJobWriteback​Object[] データ処理エンジンの結果がライトバックされるライトバックオブジェクトのコレクション。

BatchCalcJob​​​Aggregate

データ処理エンジンの集計ノードに関連する項目のコレクションを表します。

項目

項目名 項目の型 説明
description string 集計ノードの説明。
fields BatchCalcJob​AggregateField[] 必須。集計項目のコレクション。
groupBy string[] 必須。集計ノードでデータをグループ化するために使用される項目のコレクション。
label string 必須。集計ノードの表示ラベル。
name string 必須。集計ノードの名前。
sourceName string 必須。ソースノードの名前。

BatchCalcJob​AggregateField

データ処理エンジンの集計ノードの集計項目に関連する項目のコレクションを表します。

項目

項目名 項目の型 説明
aggregateFunction BatchCalcJobAggregateFunction (string 型の列挙) 必須。集計に使用される関数。
有効な値は、次のとおりです。
  • Unique — 一意の値の数。
  • Sum — すべての値の合計。
  • Max — 最大値。
  • Min — 最小値。
  • Avg — 平均として計算された平均値。
  • Std — 標準偏差。
  • Stdp — 母分散の標準偏差。
  • Var — 分散。
  • VarP — 母集団の分散。
  • Count — 値の総数。
alias string 必須。集計項目を参照するためにデータ処理エンジン内の後続ノードが使用する名前。
sourceFieldName string 必須。集計が計算されるソースノード項目。

BatchCalcJob​Datasource

データ処理エンジンのデータソースノードに関連する項目のコレクションを表します。

項目

項目名 項目の型 説明
description string データソースノードの説明。
fields BatchCalcJob​DatasourceField[] 必須。データソース項目のコレクション。
label string 必須。データソースノードの表示ラベル。
name string 必須。データソースノードの名前。
sourceName string 必須。データソースノードがデータを抽出する標準オブジェクトまたはカスタムオブジェクトの名前。
type BatchCalcJobSource​Type (string 型の列挙) 必須。ソースオブジェクト項目のオブジェクトの種別。サポートされている値は、StandardObject です。

BatchCalcJob​DatasourceField

データ処理エンジンのデータソースノードで選択されたソースオブジェクト項目に関連する項目のコレクションを表します。

項目

項目名 項目の型 説明
alias string データソース項目を参照するためにデータ処理エンジン内の後続ノードが使用する名前。項目名が参照の場合は必須です。
name string 必須。項目の名前。次のいずれかになります。
  • 関連するデータソースオブジェクトで選択されたソース項目の名前。
  • 子のレベルが 3 であるネストされた参照オブジェクトからの名前。

BatchCalcJobFilter

データ処理エンジンの検索条件ノードに関連する項目のコレクションを表します。

項目

項目名 項目の型 説明
criteria BatchCalcJobFilter​Criteria[] 検索条件ノードの検索条件のコレクション。

この項目は、isDynamicFilterFalse に設定されている場合は必須です。

メモ

description string 一括処理計算ジョブの検索条件の説明。
filterCondition string 検索条件を適用するために指定されたロジック。

この項目は、isDynamicFilterFalse に設定されている場合は必須です。

メモ

filterParameterName string 種別が検索条件のパラメータの名前。
isDynamicFilter boolean 検索条件が動的であるかどうかを示します。値が True に設定されている場合、検索条件は、実行時に filterParameterName を使用して渡されます。
label string 必須。検索条件ノードの表示ラベル。
name string 必須。検索条件ノードの名前。
sourceName string 必須。ソースノードの名前。

BatchCalcJobHierarchyPath

データ処理エンジン定義の階層パスノードのコレクションを表します。

項目

項目名 項目の型 説明
description string 階層パスノードの説明。
hierarchyFieldName string 必須。階層パスを含んだ項目名。
isSelfFieldValueIncluded boolean 自己値を計算済みの階層パスに含めるか (true) 否か (false) を示します。
label string 必須。階層パスノードのラベル。
name string 必須。階層パスノードの名前。
parentFieldName string 必須。階層パスを計算するための親項目の名前。
selfFieldName string 必須。階層パスを計算する自己項目名。
sourceName string 必須。ソースノードの名前。

BatchCalcJobFilter​Criteria

データ処理エンジンの検索条件ノードの検索条件に関連する項目のコレクションを表します。

項目

項目名 項目の型 説明
inputVariable string 条件として使用する入力変数の名前。
operator BatchCalcJobFilter​Operator (string 型の列挙) 必須。検索条件に指定された演算子。
有効な値は、次のとおりです。
  • Equals
  • NotEquals
  • GreaterThan
  • GreaterThanOrEqual
  • LessThan
  • LessThanOrEqual
  • StartsWith
  • EndsWith
  • Contains
  • DoesNotContain
  • IsNull
  • IsNotNull
  • In
  • NotIn
sequence integer 必須。検索条件ノードの条件を参照するために使用される連番。
sourceFieldName string 必須。条件を適用するためのソースノードからの項目の名前。
value string ソースノードからのデータを絞り込むために使用される値。

BatchCalcJobParameter

データ処理エンジンの入力変数に関連する項目のコレクションを表します。

項目

項目名 項目の型 説明
dataType BatchCalcJobParameter​DataType (string 型の列挙) 必須。パラメータのデータ型。有効な値は、次のとおりです。
  • Text
  • Numeric
  • Date
  • DateTime
  • Filter
defaultValue string パラメータのデフォルト値。
description string 一括処理計算ジョブのパラメータの説明。
isMultiValue boolean パラメータにさまざまな値があるか (true)、否か (false) を示します。この項目は、Text データ型でのみサポートされます。
label string 必須。一括処理計算ジョブのパラメータの表示ラベル。
name string 必須。一括処理計算ジョブのパラメータの名前。

BatchCalcJobSource​Join

データ処理エンジンの結合ノードに関連する項目のコレクションを表します。

項目

項目名 項目の型 説明
description string 結合ノードの説明。
fields BatchCalcJobJoin​ResultField[] 結合ノードの項目のコレクション。
joinKeys BatchCalcJobJoin​Key[] 結合ノードのプライマリソースノードと 2 番目のソースノードからの項目の対応付けのコレクション。
label string 必須。結合ノードの表示ラベル。
name string 必須。結合ノードの名前。
primarySourceName string 必須。ノードにプライマリソースノードとして関連付けられている名前。
secondarySourceName string 必須。ノードに 2 番目のソースノードとして関連付けられている名前。
type BatchCalcJobSource​JoinType (string 型の列挙) 必須。プライマリソースノードと 2 番目のソースノード間に指定された結合の種別。有効な値は、次のとおりです。
  • LeftOuter
  • RightOuter
  • Inner
  • Outer
  • Lookup

BatchCalcJobJoin​Key

データ処理エンジンの結合ノードの最初のソースノードと 2 番目のソースノードからの項目の対応付けに関連する項目のコレクションを表します。

項目

項目名 項目の型 説明
primarySourceFieldName string 必須。プライマリソースノードの対応付けられた項目名。
secondarySourceFieldName string 必須。2 番目のソースノードの対応付けられた項目名。

BatchCalcJobJoin​ResultField

データ処理エンジンの結合ノードの結果項目セットに関連する項目のコレクションを表します。

項目

項目名 項目の型 説明
alias string 必須。結果項目を参照するためにデータ処理エンジン定義内の後続ノードが使用する名前。
sourceFieldName string 必須。プライマリデータソースまたは 2 番目のデータソースからの項目の名前。
sourceName string 必須。プライマリデータソースまたは 2 番目のデータソースのソースノード。

BatchCalcJobTransform

データ処理エンジンのデータ変換に関連する項目のコレクションを表します。

項目

項目名 項目の型 説明
description string 一括処理計算ジョブの変換の説明。
droppedFields BatchCalcJobTransform​DroppedField[] データ変換で削除された項目のコレクション。変換種別が Slice のときに使用できます。
expressionFields BatchCalcJobTransform​AddedField[] データ変換の数式項目のコレクション。変換種別が Expression のときに使用できます。
label string 必須。一括処理計算ジョブの変換の表示ラベル。
name string 必須。一括処理計算ジョブの変換の名前。
orderBy BatchCalcJobOrderByField[] 各パーティショングループ内のレコードを並び替えるために使用する項目のコレクション。
partitionBy string[] ソースデータをパーティショングループに分けるために使用する項目のグループ。
sourceName string 必須。ソースノードの名前。
transformType BatchCalcJobTransform​Type (string 型の列挙) 必須。変換の種別。
有効な値は、次のとおりです。
  • computeRelative — この変換では、同じパーティショングループの値に基づいて値が計算されます。
  • Expression — この変換では、同じレコード内の項目の既存の値に基づいて値が計算されます。
  • Slice — この変換では、ソースノードから項目が削除されます。

BatchCalcJobTransform​DroppedField

データ処理エンジンのデータ変換で削除された項目に関連する項目のコレクションを表します。

項目

項目名 項目の型 説明
sourceFieldName string 必須。削除された項目の名前。

BatchCalcJobTransform​AddedField

データ処理エンジンのデータ変換の数式に関連する項目のコレクションを表します。

項目

項目名 項目の型 説明
alias string 必須。データ処理エンジン内の後続ノードが変換ノードに対して使用する名前。
dataType BatchCalcJobData​Type (string 型の列挙) 必須。数式のデータ型。
有効な値は、次のとおりです。
  • Text
  • Numeric
  • Date
  • DateTime
decimalPlaces integer 値の小数点の右側の桁数。Numeric データ型で必要です。
expression string 必須。ユーザが定義した数式。
length integer 小数部の桁数を含む値の合計長。Text および Numeric のデータ型で必要です。

BatchCalcJobOrderByField

パーティション化されたデータを並び変えるために使用する項目のコレクションを表します。

項目

項目名 項目の型 説明
name string 必須。データの並び替えに使用される項目の名前。
orderType BatchCalcJobOrderType(string 型の列挙) データの並び替え順。
有効な値は、次のとおりです。
  • Ascending
  • Descending

BatchCalcJobUnion

データ処理エンジンの 2 つのノードからのデータの結合に関連する項目のコレクションを表します。

項目

項目名 項目の型 説明
description string 一括処理計算ジョブの結合の説明。
isDisjointedSchema boolean 結合が 2 つのばらばらのデータセットの結合であるかどうかを示します。True に設定すると、共通項目がない 2 つのデータセットを結合できます。
label string 必須。一括処理計算ジョブの結合の表示ラベル。
name string 必須。一括処理計算ジョブの結合の名前。
sources string[] ソースノードの名前。

BatchCalcJobWriteback​Object

データ処理エンジンの結果がライトバックされるオブジェクトに関連する項目のコレクションを表します。

項目

項目名 項目の型 説明
description string 一括処理計算ジョブのライトバックオブジェクトの説明。
fields BatchCalcJobWriteback​Mapping[] ライトバック項目のコレクション。
isChangedRow boolean ライトバックオブジェクトの行が変更されたかどうかを示します。True に設定すると、変更された行がライトバックされます。
label string 必須。ライトバックオブジェクトの名前。
name string 必須。一括処理���算ジョブのライトバックオブジェクトの名前。
operationType BatchCalcJobWriteback​Opn (string 型の列挙) 必須。指定された操作の種別。
有効な値は、次のとおりです。
  • Insert
  • Update
  • Upsert
sourceName string 必須。ライトバックオブジェクトに関連付けられているソースノードの名前。
targetObjectName string 必須。データ処理エンジンによって挿入または更新/挿入されたオブジェクト。
writebackSequence integer データ処理エンジンによって対象オブジェクトが更新された順序。
writebackUser string 対象オブジェクトの更新可能なオブジェクトと項目を決定する権限を持つユーザの ID。

BatchCalcJobWriteback​Mapping

結果および対象オブジェクトの項目間の対応付けに関連する項目のコレクションを表します。

項目

項目名 項目の型 説明
parentName string 参照オブジェクトの名前。relationshipName 項目が定義されている場合にのみ必要です。
relationshipName string 参照関係の名前。
sourceFieldName string 必須。ライトバックされるソースノードの項目の名前。
targetFieldName string 必須。結果がライトバックされる sObject 項目の名前。

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

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

1<?xml version="1.0" encoding="UTF-8"?>
2<BatchCalcJobDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3   <aggregates>
4      <description>Aggregate Description</description>
5      <fields>
6         <aggregateFunction>Count</aggregateFunction>
7         <alias>NameCount</alias>
8         <sourceFieldName>Name</sourceFieldName>
9      </fields>
10      <groupBy>ContactId</groupBy>
11      <groupBy>Name</groupBy>
12      <label>AggregateOpportunities</label>
13      <name>AggregateOpportunities</name>
14      <sourceName>Opportunity</sourceName>
15   </aggregates>
16   <appends>
17      <description>Append desc</description>
18      <isDisjointedSchema>true</isDisjointedSchema>
19      <label>AppendAllAccounts</label>
20      <name>AppendAllAccounts</name>
21      <sources>AccountsOfManufacturingIndustry</sources>
22      <sources>MediaIndustry</sources>
23   </appends>
24   <datasources>
25      <description>Desc Contact</description>
26      <fields>
27         <alias>Id</alias>
28         <name>Id</name>
29      </fields>
30      <fields>
31         <alias>LastName</alias>
32         <name>LastName</name>
33      </fields>
34      <label>Contact</label>
35      <name>Contact</name>
36      <sourceName>Contact</sourceName>
37      <type>StandardObject</type>
38   </datasources>
39   <datasources>
40      <fields>
41         <alias>Name</alias>
42         <name>Name</name>
43      </fields>
44      <fields>
45         <alias>ContactId</alias>
46         <name>ContactId</name>
47      </fields>
48      <label>Opportunity</label>
49      <name>Opportunity</name>
50      <sourceName>Opportunity</sourceName>
51      <type>StandardObject</type>
52   </datasources>
53   <description>Calculates and creates transaction journal records based on the orders placed by the loyalty program members. The transaction journals are used to accrue points to the member.</description>
54   <filters>
55      <criteria>
56         <operator>Equals</operator>
57         <sequence>1</sequence>
58         <sourceFieldName>LastName</sourceFieldName>
59         <value>Salesforce</value>
60      </criteria>
61      <description>Filter Desc</description>
62      <filterCondition>1</filterCondition>
63      <isDynamicFilter>false</isDynamicFilter>
64      <label>AccountsOfManufacturingIndustry</label>
65      <name>AccountsOfManufacturingIndustry</name>
66      <sourceName>AccountOpportunities</sourceName>
67   </filters>
68   <hierarchyPaths>
69      <description>Hierarchy Path Node</description>
70      <hierarchyFieldName>Hierarchy_Path</hierarchyFieldName>
71      <isSelfFieldValueIncluded>true</isSelfFieldValueIncluded>
72      <label>Get Hierarchy</label>
73      <name>Get_Hierarchy</name>
74      <parentFieldName>ContactId</parentFieldName>
75      <selfFieldName>LastName</selfFieldName>
76       <sourceName>AppendAllAccounts</sourceName>
77   </hierarchyPaths>
78   <isTemplate>false</isTemplate>
79   <joins>
80      <description>Left Outer Join</description>
81      <fields>
82         <alias>ContactId</alias>
83         <sourceFieldName>Id</sourceFieldName>
84         <sourceName>Contact</sourceName>
85      </fields>
86      <fields>
87         <alias>LastName</alias>
88         <sourceFieldName>LastName</sourceFieldName>
89         <sourceName>Contact</sourceName>
90      </fields>
91      <fields>
92         <alias>NameCount</alias>
93         <sourceFieldName>NameCount</sourceFieldName>
94         <sourceName>AggregateOpportunities</sourceName>
95      </fields>
96      <fields>
97         <alias>OpportunityName</alias>
98         <sourceFieldName>Name</sourceFieldName>
99         <sourceName>AggregateOpportunities</sourceName>
100      </fields>
101      <joinKeys>
102         <primarySourceFieldName>Id</primarySourceFieldName>
103         <secondarySourceFieldName>ContactId</secondarySourceFieldName>
104      </joinKeys>
105      <label>AccountOpportunities</label>
106      <name>AccountOpportunities</name>
107      <primarySourceName>Contact</primarySourceName>
108      <secondarySourceName>AggregateOpportunities</secondarySourceName>
109      <type>LeftOuter</type>
110   </joins>
111   <label>Create Transaction Journals Based on Orders</label>
112   <parameters>
113      <dataType>Date</dataType>
114      <defaultValue>2020-01-01</defaultValue>
115      <description>Desc TextParameter</description>
116      <isMultiValue>false</isMultiValue>
117      <label>DateParameter</label>
118      <name>DateParameter</name>
119   </parameters>
120   <parameters>
121      <dataType>Filter</dataType>
122      <defaultValue>{&quot;filterCondition&quot;: &quot;1 AND 2&quot;, &quot;criteria&quot;: [{&quot;sourceFieldName&quot;: &quot;NameCount&quot;,&quot;operator&quot;: &quot;GreaterThan&quot;,&quot;value&quot;: &quot;20&quot;,&quot;sequence&quot;: &quot;1&quot;}, {&quot;sourceFieldName&quot;: &quot;Name&quot;,&quot;operator&quot;: &quot;Equals&quot;,&quot;value&quot;: &quot;Salesforce&quot;,&quot;sequence&quot;: &quot;2&quot;}]}</defaultValue>
123      <isMultiValue>false</isMultiValue>
124      <label>FilterParameter</label>
125      <name>FilterParameter</name>
126     </parameters>
127     <parameters>
128      <dataType>Numeric</dataType>
129      <defaultValue>5000</defaultValue>
130      <description>Desc TextParameter</description>
131      <isMultiValue>false</isMultiValue>
132      <label>NumericParameter</label>
133      <name>NumericParameter</name>
134   </parameters>
135   <parameters>
136      <dataType>Text</dataType>
137      <defaultValue>@salesforce.com</defaultValue>
138      <description>Desc TextParameter</description>
139      <isMultiValue>false</isMultiValue>
140      <label>TextParameter</label>
141      <name>TextParameter</name>
142   </parameters>
143   <processType>DataProcessingEngine</processType>
144   <status>Inactive</status>
145   <transforms>
146      <description>transforms Desc</description>
147      <expressionFields>
148         <alias>NewLastName</alias>
149         <dataType>Text</dataType>
150         <expression>{LastName} + {$TextParameter}</expression>
151             <length>80</length>
152      </expressionFields>
153      <label>ManufacturingIndustry</label>
154      <name>ManufacturingIndustry</name>
155      <sourceName>AccountsOfManufacturingIndustry</sourceName>
156      <transformationType>Expression</transformationType>
157   </transforms>
158   <transforms>
159      <droppedFields>
160         <sourceFieldName>NewLastName</sourceFieldName>
161      </droppedFields>
162      <label>MediaIndustry</label>
163      <name>MediaIndustry</name>
164      <sourceName>ManufacturingIndustry</sourceName>
165      <transformationType>Slice</transformationType>
166   </transforms>
167   <transforms>
168      <description>compute relative transforms Desc</description>
169      <expressionFields>
170         <alias>NewLastName</alias>
171         <dataType>Text</dataType>
172         <expression>rank()</expression>
173         <length>80</length>
174      </expressionFields>
175      <label>ComputeRelativeManufacturingIndustry</label>
176      <name>ComputeRelativeManufacturingIndustry</name>
177      <orderBy>
178         <name>LastName</name>
179         <orderType>Ascending</orderType>
180      </orderBy>
181      <partitionBy>LastName</partitionBy>
182      <sourceName>MediaIndustry</sourceName>
183      <transformationType>ComputeRelative</transformationType>
184   </transforms>
185   <writebacks>
186      <fields>
187         <sourceFieldName>LastName</sourceFieldName>
188         <targetFieldName>LastName</targetFieldName>
189      </fields>
190      <isChangedRow>false</isChangedRow>
191      <label>exportToContact</label>
192      <name>exportToContact</name>
193      <description>Export To Contact</description>
194      <operationType>Insert</operationType>
195      <sourceName>AppendAllAccounts</sourceName>
196      <targetObjectName>Contact</targetObjectName>
197      <writebackSequence>1</writebackSequence>
198   </writebacks>
199</BatchCalcJobDefinition>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3   ~ Copyright 2020 salesforce.com, inc.
4   ~ All Rights Reserved
5   ~ Company Confidential
6-->
7<Package xmlns="http://soap.sforce.com/2006/04/metadata">
8   <types>
9      <members>*</members>
10      <name>BatchCalcJobDefinition</name>
11   </types>
12   <version>51.0</version>
13</Package>

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

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