BatchCalcJobDefinition

Represents a Data Processing Engine definition.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

BatchCalcJobDefinition components have the suffix .batchCalcJobDefinition and are stored in the batchCalcJobDefinitions folder.

Version

BatchCalcJobDefinition components are available in API version 51.0 and later.

Special Access Rules

To use this metadata type, one of these licenses is required:

  • Loyalty Management
  • Financial Services Cloud
  • Rebate Management
  • Manufacturing Cloud
  • Net Zero Cloud

Fields

Field Name Field Type Description
aggregates BatchCalcJob​​​Aggregate[] Collection of aggregate nodes in a data processing engine.
appends BatchCalcJobUnion[] Collection of append nodes in a data processing engine.
atomicWritebacks BatchCalcJobAtomicWriteBack[] Collection of atomic writeback nodes in a data processing engine definition. Available in API version 62.0 and later.
customNodes BatchCalcJobCustomNode[] Collection of custom nodes in a data processing engine. Available in API version 57.0 and later.
dataSpaceApiName string Stores the Data Space API Name from Data Cloud. Available in API version 60.0 and later.
datasources BatchCalcJob​Datasource[] Collection of data source nodes in a data processing engine.
definitionRunMode BatchCalcJobDefRunMode(enumeration of type string) Specifies the execution mode in a data processing engine. Valid values are:
  • Batch
  • OnDemand
description string Description of a data processing engine definition.
executionPlatformType ExecutionPlatformType(enumeration of type string) The platform that's used to run the Data Processing Engine definition. Valid values are:
  • CRMA
  • CDP
  • CORE

Available in API version 59.0 and later.

filters BatchCalcJobFilter[] Collection of filter nodes in a data processing engine. definition.
forecasts BatchCalcJobForecast[] Collection of forecast nodes in a data processing engine. definition.

Available in API version 58.0 and later.

hierarchyPaths BatchCalcJobHierarchyPath[] Collection of hierarchy path nodes in a data processing engine definition.
isTemplate boolean Indicates whether it’s a template data processing engine definition.
joins BatchCalcJobSource​Join[] Collection of join nodes in a data processing engine.
label string The label of a data processing engine definition.
parameters BatchCalcJobParameter[] Collection of input variables in a data processing engine.
processType BatchCalcProcessType (enumeration of type string) The process type of a data processing engine. Valid values are:
  • UsageManagement
  • AccountingPeriodClosure
  • AccountingSubledger—This value is reserved for internal use.
  • ActionableList
  • AdvancedAccountForecast
  • BenefitManagement
  • BillingSchedulesforInvoiceGeneration
  • CDPEnrichment
  • ChannelInventoryManagement—Available in API version 63.0 and later.
  • CriteriaBsdSearchAndFilter
  • DataProcessingEngine
  • DecisionMatrixDataUpload
  • Decisiontable
  • Education
  • EmployeeService—Available in API version 63.0 and later.
  • FinancialSummaryRollup
  • FSCHierarchyRollUp
  • FundraisingRollups—Available in API version 63.0 and later.
  • InvoiceGeneration
  • Loyalty
  • LegalEntityAccountingPeriodClosureAdvanced—Available in API version 63.0 and later.
  • LifeSciencbatchcalesCommercialTerritoryAlignment—Available in API version 63.0 and later.
  • LoyaltyPartnerManagement
  • LoyaltyPointsAggregation
  • NextGenForecasting
  • NetZero
  • PnmRosterFileUpload
  • PriceProtection
  • ProductCatalogManagement
  • ProgramBasedBusiness
  • ProviderSearch—This value is reserved for internal use.
  • Rebates
  • Recruitment
  • RevenueTransactionManagement—Available in API version 63.0 and later.
  • SalesAgreement—Available in API version 63.0 and later.
  • TestProcessType
status BatchJobDefinition​Status (enumeration of type string) Status of a data processing engine definition. Valid values are:
  • Active
  • Inactive
transforms BatchCalcJobTransform[] Collection of data transformation nodes in a data processing engine.
writebacks BatchCalcJobWriteback​Object[] Collection of writeback objects in which the results of the data processing engine are written back.

BatchCalcJob​​​Aggregate

Represents a collection of fields relating to an aggregate node in a data processing engine.

Fields

Field Name Field Type Description
description string Description of an aggregate node.
fields BatchCalcJob​AggregateField[] Required. Collection of aggregation fields.
groupBy string[] Required. Collections of fields used to group data in an aggregate node.
label string Required. Label of an aggregate node.
name string Required. Name of an aggregate node.
sourceName string Required. Name of the source node.

BatchCalcJob​AggregateField

Represents a collection of fields relating to an aggregation field in an aggregate node of a data processing engine.

Fields

Field Name Field Type Description
aggregateFunction BatchCalcJobAggregateFunction (enumeration of type string) Required. Function used for aggregation.

Valid values are:

  • Unique—A count of unique values.
  • Sum—The sum of all values.
  • Max—The largest value.
  • Min—The smallest value.
  • Avg—The average value, calculated as the mean.
  • Std—The standard deviation.
  • Stdp—A standard deviation with population variance.
  • Var—The variance.
  • VarP—The variance with population.
  • Count—The total count of values.
alias string Required. Name that subsequent nodes within the data processing engine use to refer to the aggregate field.
sourceFieldName string Required. Source node field on which the aggregate is calculated.

BatchCalcJobAtomicWriteback

Represents a node in a DPE definition that stores the details about the relationship between the writeback nodes and the atomic writeback operations between the nodes.

Field Name Field Type Description
description string Description of the atomic writeback object.
label string Required. Name of the atomic writeback object.
name string Required. API name of the atomic writeback object.
writebackObject​Relationships BatchCalcJobAtomicWritebackRelationship[] Specifies the relationship between the writeback objects that are involved in the writeback operation.
writebackSequence int Sequence in which the data processing engine executes the atomic write back node.

BatchCalcJobAtomicWritebackRelationship

Represents the relationships between the writeback objects that are involved in an atomic writeback operation. It captures the relationships between these objects and the sequence in which they should be processed.

Field Name Field Type Description
childWriteback​ObjectField string Field name that's associated with the child writeback object in an atomic writeback relationship. Available in API version 63.0 and later.
childWriteback​ObjectName string Name of the child writeback object that's associated with the writeback relationship.
parentWriteback​ObjectField string Field name that's associated with the parent writeback object in an atomic writeback relationship. Available in API version 63.0 and later.
parentWriteback​ObjectName string Required. Name of the parent writeback object that's associated with the writeback relationship.
sequenceNumber int Sequence number of the writeback node that's associated with its parent node in the relationship.

BatchCalcJob​​​CustomNode

Represents a collection of custom nodes in a data processing engine. Use a custom node to add a custom action.

Fields

Field Name Field Type Description
description string Description of a custom node.
extensionName string Required. Name of an extension node.
extensionNamespace string Required. Namespace of an extension node.
label string Required. Label of a custom node.
name string Required. Name of a custom node.
parameters BatchCalcJob​​​CustomNodeParameter[] The field mappings of an extension node.
sources string[] Sources of an extension node.

BatchCalcJob​​​CustomNodeParameter

Represents the field mappings of an extension node.

Fields

Field Name Field Type Description
name string Required. Name of a parameter.
value string Required. Value of a parameter.

BatchCalcJob​Datasource

Represents a collection of fields relating to a data source node in a data processing engine.

Fields

Field Name Field Type Description
CSVDelimiter ​BatchCalcJobCSVDelimiter (enumeration of type string) Specifies the field separator to read fields from a CSV file record.

Possible values are:

  • COMMA
  • BACKQUOTE
  • CARET
  • PIPE
  • SEMICOLON
  • TAB

The default value is COMMA.

The same delimiter value used for the CSV file can’t be used within any of the column values in the file. If you mistakenly use the same delimiter value in column values, it can cause data parsing issues.

description string Description of a data source node.
fields BatchCalcJob​DatasourceField[] Required. Collection of data source fields.
fileIdentifier string Specifies the source of the file or file storage system.
filePath string The file path for the specified file.
fileSource BatchCalcJobFileSource (enumeration of type string) Specifies the source of the file or file storage system.

Possible value is:

  • ContentManagement
label string Required. Label of a data source node.
name string Required. Name of a data source node.
sourceName string Required. Name of a standard or custom object from which the data source node extracts data.
type BatchCalcJobDataSource​Type (enumeration of type string) Required. Type of object for the source object field. Supported values are:
  • Analytics
  • CalculatedInsightsObject
  • CRMObject
  • CSV
  • DataModelObject
  • StandardObject
.

BatchCalcJob​DatasourceField

Represents a collection of fields relating to a source object field that are selected in the data source node of a data processing engine.

Fields

Field Name Field Type Description
alias string Name that subsequent nodes within the data processing engine use to refer to the data source field. Required when the field name is lookup.
dataType BatchCalcJobDataType (enumeration of type string) Specifies the data type of the input field when using a CSV file as a data source.

Possible values are:

  • Text
  • Numeric
  • Date
  • DateTime
  • MultiValue
isPrimaryKey boolean Indicates whether a column name is the primary key (true) or not (false) for the Data Cloud CSV file.
name string Required. Name of the field. Can be either of the following:
  • Name of the source field selected in the associated data source object.
  • Name from a nested lookup object with three child levels.

BatchCalcJobFilter

Represents a collection of fields relating to a filter node in a data processing engine.

Fields

Field Name Field Type Description
criteria BatchCalcJobFilter​Criteria[] Collection of filter criteria in a filter node.

The field is required when isDynamicFilter is set to False.

description string Description of the batch calculation job filter.
filterCondition string Logic that is specified to apply the filter conditions.

The field is required when isDynamicFilter is set to False.

filterParameterName string Name of the parameter of type filter.
isDynamicFilter boolean Indicates whether the filter criteria is dynamic. If value is set to True, filter criteria is passed in runtime with filterParameterName.
label string Required. Label of the filter node.
name string Required. Name of the filter node.
sourceName string Required. Name of the source node.

BatchCalcJobForecast

Represents a collection of fields relating to a forecast node in a data processing engine. Available in API version 58.0 and later.

Fields

Field Name Field Type Description
accuracyPercent BatchCalcJobFrcstAccuracy (enumeration of type string)

The interval percentage to account for errors in forecasts.

Possible values are:

  • Eighty
  • NinetyFive
  • None

The default value is None.

aggregationFields BtchCalcJobFrcstAggrFld[] The list of fields to forecast.
dateFieldName string Required.

The date field from the source node used to forecast values for the specified forecast length.

description string The description of the forecast node.
forecastModelType BatchCalcJobFrcstModel (enumeration of type string) The model used to forecast data.

Possible values are:

  • Additive
  • Auto
  • Multiplicative

The default value is Auto.

forecastPeriodCount int The number of time periods to generate forecast data. For example, if you select Year-Month as the forecast period type, and 4 as the forecast period count, the forecast results are generated for the next 4 months.

The minimum and the default count is 1, and the maximum is 100.

forecastPeriodType BatchCalcJobFrcstPeriodType (enumeration of type string) Required.

The type of forecast period to group date field values in the forecast results.

Possible values are:

  • FiscalYear
  • FiscalYearMonth
  • FiscalYearQuarter
  • FiscalYearWeek
  • Year
  • YearMonth
  • YearMonthDay
  • YearQuarter
  • YearWeek
groupFields BatchCalcJobFrcstGrpFld[] The source fields for grouping the data to be processed by the forecast node.
label string Required.

The name of the forecast node in the UI.

name string Required.

A unique name for the forecast node.

periodStartDateName string Required.

The start date of the forecast period.

seasonality BatchCalcJobFrcstSeasonality (enumeration of type string)

Represents the periodic fluctuations that occur around the same time every year.

Possible values are:

  • 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

The default value is None.

shouldExcludeLastPeriod boolean Indicates whether to ignore the last period in the source node when it has incomplete data (true) or not (false).

The default value is false.

sourceName string Required.

The name of the source node.

A source can be any node other than the datasink and register node.

BtchCalcJobFrcstAggrFld

Represents a list of fields to forecast in a forecast node.

Field Name Field Type Description
aggregateFunction BatchCalcJobAggregateFunction (enumeration of type string) Required.

The function of the aggregate field.

Possible values are:

  • Avg
  • Count
  • Max
  • Min
  • Std
  • StdP
  • Sum
  • Unique
  • Var
  • VarP
aggregationResultLabel string Required.

The name of the aggregation result generated from the aggregation function that’s applied to the source node field.

fieldName string Required.

The name of the source field.

BatchCalcJobFrcstGrpFld

Represents source fields for grouping the data to be processed by the forecast node.

Field Name Field Type Description
fieldName string Required.

The name of the source field to group the data to be processed by the forecast node.

groupBy string A comma-separated list of values to group data by.

Required when the source field type is Date or DateTime.

Possible values are:

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

BatchCalcJobHierarchyPath

Represents a collection of hierarchy path nodes in a data processing engine definition.

Fields

Field Name Field Type Description
description string Description of the hierarchy path node.
hierarchyFieldName string Required. Field name that contains the hierarchy path.
isSelfFieldValueIncluded boolean Indicates whether the self value is included in the calculated hierarchy path (True) or not (False).
label string Required. Label of the hierarchy path node.
name string Required. Name of the hierarchy path node.
parentFieldName string Required. Parent field name to calculate hierarchy path.
selfFieldName string Required. Self field name to calculate hierarchy path.
sourceName string Required. Name of the source node.

BatchCalcJobFilter​Criteria

Represents a collection of fields relating to a filter condition in a filter node in a data processing engine.

Fields

Field Name Field Type Description
inputVariable string Name of the input variable used as a filter.
operator BatchCalcJobFilter​Operator (enumeration of type string) Required. Operator that is specified in the filter condition.

Valid values are:

  • Equals
  • NotEquals
  • GreaterThan
  • GreaterThanOrEqual
  • LessThan
  • LessThanOrEqual
  • StartsWith
  • EndsWith
  • Contains
  • DoesNotContain
  • IsNull
  • IsNotNull
  • In
  • NotIn
sequence integer Required. Sequence number used to refer the criteria in a filter node.
sourceFieldName string Required. Name of the field from the source node to apply the filter.
value string Value used to filter data from the source node.

BatchCalcJobParameter

Represents a collection of fields relating to an input variable in a data processing engine.

Fields

Field Name Field Type Description
dataType BatchCalcJobParameter​DataType (enumeration of type string) Required. Data type of the parameter. Valid values are:
  • Date
  • DateTime
  • Expression
  • FileIdentifier
  • Filter
  • Numeric
  • Text
defaultValue string Default value of the parameter.
description string Description of the batch calculation job parameter.
isMultiValue boolean Indicates whether the parameter has different values (True) or not (False). This field is supported only for the Text data type.
label string Required. Label of the batch calculation job parameter.
name string Required. Name of the batch calculation job parameter.

BatchCalcJobSource​Join

Represents a collection of fields relating to a join node in a data processing engine.

Fields

Field Name Field Type Description
description string Description of the join node.
fields BatchCalcJobJoin​ResultField[] Collection of fields in a join node.
joinKeys BatchCalcJobJoin​Key[] Collection of mapping of fields from the primary source node and the second source node in a join node.
label string Required. Label of the join node.
name string Required. Name of the join node.
primarySourceName string Required. Name associated with the node as the primary source node.
secondarySourceName string Required. Name associated with the node as the secondary source node.
type BatchCalcJobSource​JoinType (enumeration of type string) Required. Type of join specified between the primary source node and secondary source node. Valid values are:
  • LeftOuter
  • RightOuter
  • Inner
  • Outer
  • Lookup

BatchCalcJobJoin​Key

Represents a collection of fields relating to a mapping of fields from the first source node and second source node in a join node of a data processing engine.

Fields

Field Name Field Type Description
primarySourceFieldName string Required. Mapped field name of the primary source node.
secondarySourceFieldName string Required. Mapped field name of the secondary source node.

BatchCalcJobJoin​ResultField

Represents a collection of fields relating to a set of resultant fields in a join node of a data processing engine.

Fields

Field Name Field Type Description
alias string Required. Name that subsequent nodes within the data processing engine definition use to refer to the resultant field.
sourceFieldName string Required. Name of field from the primary or secondary data source.
sourceName string Required. Source node of the primary or secondary data source.

BatchCalcJobTransform

Represents a collection of fields relating to a data transformation in a data processing engine.

Fields

Field Name Field Type Description
description string The description of the batch calculation job transform.
droppedFields BatchCalcJobTransform​DroppedField[] The collection of dropped fields in a data transformation. Available when the transformation type is Slice.
expressionFields BatchCalcJobTransform​AddedField[] The collection of formula fields in a data transformation. Available when the transformation type is Expression.
label string Required. The label of the batch calculation job transform.
name string Required. The name of the batch calculation job transform.
orderBy BatchCalcJobOrderByField[] A collection of fields that’s used to sort the records within each partition group.
partitionBy string[] A group of fields that’s used to partition the source data into partition groups.
sourceName string Required. Name of the source node.
transformType BatchCalcJobTransform​Type (enumeration of type string) Required. The type of transformation.

Valid values are:

  • ComputeRelative—This transformation calculates values based on values of the same partition group.
  • Expression—This transformation calculates values based on existing values of fields in the same record.
  • Slice—This transformation removes fields from the source node.

BatchCalcJobTransform​DroppedField

Represents a collection of fields relating to a dropped field in a data transformation of a data processing engine.

Fields

Field Name Field Type Description
sourceFieldName string Required. Name of the field that is dropped.

BatchCalcJobTransform​AddedField

Represents a collection of fields relating to a formula in a data transformation of a data processing engine.

Fields

Field Name Field Type Description
alias string Required. Name that subsequent nodes within the data processing engine use to the transform node.
dataType BatchCalcJobDataType (enumeration of type string) Required. Data type of the formula.

Valid values are:

  • Text
  • Numeric
  • Date
  • DateTime
  • MultiValue
decimalPlaces integer Number of digits to the right of a decimal point in the value. Required for the Numeric data type.
expression string Required. Formula defined by the user.
length integer Total length of the value including the decimal places. Required for data types: Text and Numeric.

BatchCalcJobOrderByField

Represents a collection of fields that are used to sort the partitioned data.

Fields

Field Name Field Type Description
name string Required. Name of the field that is used to sort data.
orderType BatchCalcJobOrderType(enumeration of type string) Order in which the data is sorted.

Valid values are:

  • Ascending
  • Descending

BatchCalcJobUnion

Represents a collection of fields relating to the union of data from two nodes in a data processing engine.

Fields

Field Name Field Type Description
description string Description of the batch calculation job union.
isDisjointedSchema boolean Indicates whether the union is of two disjointed datasets (true) or not (false). Set to True to allow joining of two datasets having no common fields.
label string Required. Label of the batch calculation job union.
name string Required. Name of the batch calculation job union.
sources string[] Names of the source nodes.

BatchCalcJobWriteback​Object

Represents a collection of fields relating to the object in which the results of the data processing engine are written back.

Fields

Field Name Field Type Description
description string Descriptions of the batch calculation job writeback object.
externalId​FieldName string Unique external field ID for the target object name.

Available in API version 60.0 and later.

fields BatchCalcJobWriteback​Mapping[] Collection of the writeback fields.
filterCondition string The condition that filters the records from a writeback dataset for a user. Examples of a filter condition include a user ID, stage name, and a security policy that returns only the records that a user owns.

Available in API version 57.0 and later.

folderName string The folder where the writeback dataset is saved. Available in API version 57.0 and later.
isChangedRow boolean Indicates whether a row in the write back object is changed. Set to True to write back the changed rows.
isExistingDataset boolean Indicates whether a CRM Application (CRMA) dataset or a Data Cloud Data Lake object is present (true) or will be created (false). Available in API version 62.0 and later.
label string Required. Name of the write back object.
name string Required. Name of the batch calculation job write back object.
operationType BatchCalcJobWriteback​Opn (enumeration of type string) Type of operation specified.

Valid values are:

  • Delete—This value is available in API version 56.0 and later.
  • Insert
  • Overwrite—Available only when storageType is DataLakeObject. This value is available in API version 60.0 and later.
  • Update
  • Upsert
sharingInheritanceObjectName string The name of the source object from which the row-level sharing inheritance settings are applied. Available in API version 57.0 and later.
sourceName string Required. Name of the source node associated with the write back object.
storageType BatchCalcJobWriteback​Type (enumeration of type string) Specifies where you want to use the data stored in the source node. Available in API version 57.0 and later.

Valid values are:

  • Analytics
  • DataLakeObject
  • sObject

The default value is sObject.

targetObjectName string Required. Object that is inserted or upserted by the data processing engine.
writebackSequence integer Sequence in which the target object is updated by the data processing engine.
writebackUser string ID of the user whose permissions decide which objects and fields of the target object can be updated.

BatchCalcJobWriteback​Mapping

Represents a collection of fields relating to the mapping between results and the fields in the target object.

Fields

Field Name Field Type Description
parentName string Name of the lookup object. Required only when the relationshipName field is defined.
relationshipName string Name of the lookup relationship.
runtimeParameter boolean Indicates whether the source field from runtime parameter is true or false. The default value is false.

Available in API version 59.0 and later.

sourceFieldName string Required. Name of the field in the source node that is written back.
targetFieldName string Name of the sObject field to which the results are written back.

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.