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

BatchCalcJobDefinition

データ処理エンジン定義を表します。

親種別

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

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

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

バージョン

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

特別なアクセスルール

このメタデータ型を使用するには、次のいずれかのライセンスが必要です。

  • ロイヤルティ管理
  • Financial Services Cloud
  • 払い戻し管理
  • Manufacturing Cloud
  • Net Zero Cloud

項目

項目名 項目の型 説明
aggregates BatchCalcJob​​​Aggregate[] データ処理エンジンの集計ノードのコレクション。
appends BatchCalcJobUnion[] データ処理エンジンの追加ノードのコレクション。
customNodes BatchCalcJobCustomNode[] データ処理エンジンのカスタムノードのコレクション。API バージョン 57.0 以降で使用できます。
datasources BatchCalcJob​Datasource[] データ処理エンジンのデータソースノードのコレクション。
description string データ処理エンジン定義の説明。
executionPlatformType ExecutionPlatformType(string 型の列挙) データ処理エンジン定義の実行に使用するプラットフォーム。有効な値は、次のとおりです。
  • CRMA
  • CDP

API バージョン 59.0 以降で利用できます。

filters BatchCalcJobFilter[] データ処理エンジン定義の検索条件ノードのコレクション。
forecasts BatchCalcJobForecast[] データ処理エンジン定義の販売予測ノードのコレクション。

API バージョン 58.0 以降で使用できます。

hierarchyPaths BatchCalcJobHierarchyPath[] データ処理エンジン定義の階層パスノードのコレクション。
isTemplate boolean テンプレートのデータ処理エンジン定義であるかどうかを示します。
joins BatchCalcJobSource​Join[] データ処理エンジンの結合ノードのコレクション。
label string データ処理エンジン定義の表示ラベル。
parameters BatchCalcJobParameter[] データ処理エンジンの入力変数のコレクション。
processType BatchCalcProcessType (string 型の列挙) データ処理エンジンのプロセス種別。有効な値は、次のとおりです。
  • AdvancedAccountForecast
  • DataProcessingEngine
  • FSCHierarchyRollUp
  • Loyalty
  • LoyaltyPartnerManagement
  • LoyaltyPointsAggregation
  • NetZero
  • ProgramBasedBusiness
  • Rebates
  • AccountingSubledger — この値は、内部使用のために予約されています。
  • ProviderSearch — この値は、内部使用のために予約されています。
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​​​CustomNode

データ処理エンジンのカスタムノードのコレクションを表します。カスタムノードは、カスタムアクションを追加する場合に使用します。

項目

項目名 項目の型 説明
description string カスタムノードの説明。
extensionName string 必須。拡張ノードの名前。
extensionNamespace string 必須。拡張ノードの名前空間。
label string 必須。カスタムノードの表示ラベル。
name string 必須。カスタムノードの名前。
parameters BatchCalcJob​​​CustomNodeParameter[] 拡張ノードの項目の対応付け。
sources string[] 拡張ノードのソース。

BatchCalcJob​​​CustomNodeParameter

拡張ノードの項目の対応付けを表します。

項目

項目名 項目の型 説明
name string 必須。パラメーターの名前。
value 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 必須。ソースノードの名前。

BatchCalcJobForecast

データ処理エンジンの販売予測ノードに関連する項目のコレクションを表します。API バージョン 58.0 以降で使用できます。

項目

項目名 項目の型 説明
accuracyPercent BatchCalcJobFrcstAccuracy (string 型の列挙)

販売予測のエラーの原因となる間隔の比率。

可能な値は次のとおりです。

  • Eighty
  • NinetyFive
  • None

デフォルト値は None です。

aggregationFields BtchCalcJobFrcstAggrFld[] 予測する項目のリスト。
dateFieldName string 必須。

指定された販売予測の長さで値を予測するために使用されるソースノードからの日付項目。

description string 販売予測ノードの説明。
forecastModelType BatchCalcJobFrcstModel (string 型の列挙) データを予測するために使用されるモデル。

可能な値は次のとおりです。

  • Additive
  • Auto
  • Multiplicative

デフォルト値は Auto です。

forecastPeriodCount int 販売予測データを生成する期間数。たとえば、販売予測期間種別として [年-月] を選択し、予測期間数として [4] を選択すると、次の 4 か月の販売予測結果が生成されます。

最小値は 1 (デフォルト)、最大値は 100 です。

forecastPeriodType BatchCalcJobFrcstPeriodType (string 型の列挙) 必須。

販売予測結果で日付項目値をグループ化する販売予測期間の種別。

可能な値は次のとおりです。

  • FiscalYear
  • FiscalYearMonth
  • FiscalYearQuarter
  • FiscalYearWeek
  • Year
  • YearMonth
  • YearMonthDay
  • YearQuarter
  • YearWeek
groupFields BatchCalcJobFrcstGrpFld[] 販売予測ノードで処理されるデータをグループ化するための取得元項目。
label string 必須。

UI の販売予測ノードの名前。

name string 必須。

販売予測ノードの一意の名前。

periodStartDateName string 必須。

販売予測期間の開始日。

seasonality BatchCalcJobFrcstSeasonality (string 型の列挙)

毎年同じ時期に発生する周期的変動を表します。

可能な値は次のとおりです。

  • Two
  • Three
  • Four
  • Five
  • Six
  • Seven
  • Eight
  • Nine
  • Ten
  • Eleven
  • Twelve
  • Thirteen
  • Fourteen
  • Fifteen
  • Sixteen
  • Seventeen
  • Eighteen
  • Nineteen
  • Twenty
  • TwentyOne
  • TwentyTwo
  • TwentyThree
  • TwentyFour
  • Auto
  • None

デフォルト値は None です。

shouldExcludeLastPeriod boolean ソースノードの最後の期間に不完全なデータがある場合、その期間を無視するか (true)、否か (false) を示します。

デフォルト値は false です。

sourceName string 必須。

ソースノードの名前。

データシンクノードと登録ノード以外であれば、どのノードでもソースにすることができます。

BtchCalcJobFrcstAggrFld

販売予測ノードで予測する項目のリストを表します。

項目名 項目の型 説明
aggregateFunction BatchCalcJobAggregateFunction (string 型の列挙) 必須。

集計項目の関数。

可能な値は次のとおりです。

  • Avg
  • Count
  • Max
  • Min
  • Std
  • StdP
  • Sum
  • Unique
  • Var
  • VarP
aggregationResultLabel string 必須。

ソースノード項目に適用される集計関数から生成された集計結果の名前。

fieldName string 必須。

取得元項目の名前。

BatchCalcJobFrcstGrpFld

販売予測ノードで処理されるデータをグループ化するための取得元項目を表します。

項目名 項目の型 説明
fieldName string 必須。

販売予測ノードで処理されるデータをグループ化するための取得元項目の名前。

groupBy string データをグループ化する値のカンマ区切りのリスト。

取得元項目のデータ型が Date または DateTime のときに必要です。

可能な値は次のとおりです。

  • Second
  • Second Epoch
  • Minute
  • Hour
  • Day
  • Day Epoch
  • Week
  • Month
  • Quarter
  • Year

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)、否か (false) を示します。True に設定すると、共通項目がない 2 つのデータセットを結合できます。
label string 必須。一括処理計算ジョブの結合の表示ラベル。
name string 必須。一括処理計算ジョブの結合の名前。
sources string[] ソースノードの名前。

BatchCalcJobWriteback​Object

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

項目

項目名 項目の型 説明
description string 一括処理計算ジョブのライトバックオブジェクトの説明。
fields BatchCalcJobWriteback​Mapping[] ライトバック項目のコレクション。
filterCondition string ユーザーの書き戻しデータセットのレコードを絞り込む条件。検索条件の例としては、ユーザー ID、フェーズ名、およびユーザーが所有するレコードのみを返すセキュリティポリシーなどがあります。

API バージョン 57.0 以降で利用できます。

folderName string 書き戻しデータセットが保存されるフォルダー。API バージョン 57.0 以降で利用できます。
isChangedRow boolean ライトバックオブジェクトの行が変更されたかどうかを示します。True に設定すると、変更された行がライトバックされます。
label string 必須。ライトバックオブジェクトの名前。
name string 必須。一括処理計算ジョブのライトバックオブジェクトの名前。
operationType BatchCalcJobWriteback​Opn (string 型の列挙) 指定された操作の種別。

有効な値は、次のとおりです。

  • Delete — この値は API バージョン 56.0 以降で使用できます。
  • Insert
  • Update
  • Upsert
sharingInheritanceObjectName string 行レベルの共有継承設定の適用元のソースオブジェクト名。API バージョン 57.0 以降で利用できます。
sourceName string 必須。ライトバックオブジェクトに関連付けられているソースノードの名前。
storageType BatchCalcJobWriteback​Type (string 型の列挙) ソースノードに保存されたデータを使用する場所を指定します。API バージョン 57.0 以降で利用できます。

有効な値は、次のとおりです。

  • sObject
  • Analytics

デフォルト値は sObject です。

targetObjectName string 必須。データ処理エンジンによって挿入または更新/挿入されたオブジェクト。
writebackSequence integer データ処理エンジンによって対象オブジェクトが更新された順序。
writebackUser string 対象オブジェクトの更新可能なオブジェクトと項目を決定する権限を持つユーザーの ID。

BatchCalcJobWriteback​Mapping

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

項目

項目名 項目の型 説明
parentName string 参照オブジェクトの名前。relationshipName 項目が定義されている場合にのみ必要です。
relationshipName string 参照関係の名前。
runtimeParameter boolean ランタイムパラメーターからのソース項目が、true か、false かを示します。デフォルト値は false です。

API バージョン 59.0 以降で利用できます。

sourceFieldName string 必須。ライトバックされるソースノードの項目の名前。
targetFieldName string 結果がライトバックされる sObject 項目の名前。

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

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