BatchCalcJobDefinition

Represents a Data Processing Engine definition.

This type extends Metadata and inherits its fields.

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

Introduced in API version 51.0.

To know the products and user permissions needed to access this type, See product availability and user permissions for Data Processing Engine.

  • Type: BatchCalcJobActivity[]
  • Required: No
  • Introduced: API version 68.0
  • Description: Collection of reusable activities, such as a data stream run or an activation trigger, that can be referenced across steps in a data processing engine definition.
  • Type: BatchCalcJobAggregate[]
  • Required: No
  • Description: Collection of aggregate nodes in a data processing engine.
  • Type: string
  • Required: No
  • Introduced: API version 68.0
  • Description: API version in which the data processing engine definition is created. For example, 68.0.
  • Type: BatchCalcJobUnion[]
  • Required: No
  • Description: Collection of append nodes in a data processing engine.
  • Type: BatchCalcJobAtomicWriteback[]
  • Required: No
  • Introduced: API version 62.0
  • Description: Collection of composite writeback nodes in a data processing engine definition.
  • Type: CurrencyConversion (enumeration of type string)
  • Required: No
  • Introduced: API version 67.0
  • Description: Specifies the currency conversion type for the data processing engine definition.
  • Type: BatchCalcJobCustomNode[]
  • Required: No
  • Introduced: API version 57.0
  • Description: Collection of custom nodes in a data processing engine.
  • Type: string
  • Required: No
  • Introduced: API version 60.0
  • Description: Stores the Data Space API Name from .
  • Type: BatchCalcJobDefRunMode (enumeration of type string)
  • Required: No
  • Description: Specifies the execution mode in a data processing engine.
  • Possible values:
    • Batch
    • OnDemand

  • Type: BatchCalcJobDefType (enumeration of type string)

  • Required: No

  • Description: Type of data processing engine definition.

    Available in API version 68.0 and later.

  • Possible values:

    • Calcservice
    • DataStudio
  • Type: string
  • Required: No
  • Description: Description of a data processing engine definition.
  • Type: boolean
  • Required: No
  • Introduced: API version 65.0
  • Description: Indicates whether the error file includes a complete list of all failed writeback records (true) or not (false). The default value is false, and only the first instance of a failure is recorded in the error file. If set to true, all failed records are recorded in the error file for the writeback node.

  • Type: ExecutionPlatformObjectType (enumeration of type string)

  • Required: No

  • Description: The execution platform object type that’s used during the read, transform, and writeback process for the Data Processing Engine definition.

    Available in API version 65.0 and later.

  • Possible values:

    • CalculatedInsightsObject
    • DataLakeObject
    • DataModelObject
    • None

  • Type: ExecutionPlatformType (enumeration of type string)

  • Required: No

  • Description: The platform that’s used to run the Data Processing Engine definition.

    Available in API version 59.0 and later.

  • Possible values:

    • CRMA
    • CDP
    • CORE
  • Type: BatchCalcJobFilter[]
  • Required: No
  • Description: Collection of filter nodes in a data processing engine. definition.
  • Type: BatchCalcJobForecast[]
  • Required: No
  • Introduced: API version 58.0
  • Description: Collection of forecast nodes in a data processing engine. definition.
  • Type: BatchCalcJobHierarchyPath[]
  • Required: No
  • Description: Collection of hierarchy path nodes in a data processing engine definition.
  • Type: boolean
  • Required: No
  • Description: Indicates whether it’s a template data processing engine definition.
  • Type: string
  • Required: No
  • Description: The label of a data processing engine definition.
  • Type: BatchCalcJobParameter[]
  • Required: No
  • Description: Collection of input variables in a data processing engine.
  • Type: BatchCalcProcessType (enumeration of type string)
  • Required: No
  • Description: The process type of a data processing engine. These process types may be available to you depending on your industry solution and permission sets.
  • Possible values:
    • AccountingPeriodClosure
    • AccountingSubledger — This value is reserved for internal use.
    • AccrualsAndPayoutEngine
    • ActionableList
    • AdvancedAccountForecast
    • AutomotiveFoundation
    • BenefitManagement
    • BillingSchedulesforInvoiceGeneration
    • CDPEnrichment
    • ChannelInventoryManagement — Available in API version 63.0 and later.
    • CollectionPlan — Available in API version 65.0 and later.
    • ContextService — Available in API version 67.0 and later.
    • CriteriaBsdSearchAndFilter
    • DataProcessingEngine
    • DecisionMatrixDataUpload
    • Decisiontable
    • Education
    • EmployeeService — Available in API version 63.0 and later.
    • EnergyUtilitiesSales
    • FinancialSummaryRollup
    • FlexibleHierarchy
    • ForeignExchangeGainLossCalculations — Available in API version 65.0 and later.
    • FSCHierarchyRollUp
    • Fundraising — Available in API version 64.0 and later.
    • FundraisingRollups — Available in API version 63.0 and later.
    • GeneralLedgerAccountBalancesSummary — Available in API version 65.0 and later.
    • InventoryBatchSearch — Available in API version 65.0 and later.
    • InventorySearch — Available in API version 65.0 and later.
    • InvoiceGeneration
    • Loyalty
    • LegalEntityAccountingPeriodClosureAdvanced — Available in API version 63.0 and later.
    • LifeSciencesCommercialTerritoryAlignment — Available in API version 63.0 and later.
    • LifeSciencesCustomerEngagement — Available in API version 64.0 and later.
    • LoyaltyPartnerManagement
    • LoyaltyPointsAggregation
    • MediaAdSales
    • NextGenForecasting — Available in API version 64.0 and earlier.
    • NetZero
    • PatientServicesProgram — Available in API version 64.0 and later.
    • PennyPerfectPricing — Available in API version 68.0 and later.
    • PlanningAndForecasting
    • PnmRosterFileUpload
    • PriceProtection
    • ProductCatalogManagement
    • ProgramBasedBusiness
    • ProviderSearch — This value is reserved for internal use.
    • PublicSector — Available in API version 68.0 and later.
    • Rebates
    • RebateAndAccrualManagementAdvanced
    • Recruitment
    • RevenueTransactionManagement — Available in API version 63.0 and later.
    • SalesAgreement — Available in API version 63.0 and later.
    • TestAtomicWritebackScale — Available in API version 64.0 and later.
    • TestProcessType
    • UsageManagement
  • Type: BatchJobDefinitionStatus (enumeration of type string)
  • Required: Yes
  • Description: Status of a data processing engine definition.
  • Possible values:
    • Active
    • Inactive
  • Type: BatchCalcJobStep[]
  • Required: No
  • Introduced: API version 68.0
  • Description: Collection of steps that group related activities in a data processing engine definition.
  • Type: CurrencyIsoCode (enumeration of type string)
  • Required: No
  • Introduced: API version 67.0
  • Description: ISO code of the target currency for currency conversion in the data processing engine definition.
  • Type: BatchCalcJobTransform[]
  • Required: No
  • Description: Collection of data transformation nodes in a data processing engine.
  • Type: BatchCalcJobWritebackObject[]
  • Required: No
  • Description: Collection of writeback objects in which the results of the data processing engine are written back.

Represents a reusable activity, such as a data stream run or an activation trigger, that can be referenced across steps in a data processing engine definition.

This type extends BatchCalcJobAbstractMetadataValue and inherits its fields.

  • Type: string
  • Required: Yes
  • Introduced: API version 68.0
  • Description: Required. Unique name that identifies the activity in a step.

  • Type: BatchCalcJobActivityType (enumeration of type string)

  • Required: Yes

  • Description: Required. Type of activity performed in a step.

    Available in API version 68.0 and later.

  • Possible values:

    • RefreshDataGraphActivity
    • RefreshSegmentActivity
    • RunCalculatedInsightsActivity
    • RunDataStreamActivity
    • RunDataTransformActivity
    • RunIdentityResolutionActivity
    • TriggerActivationActivity
  • Type: string
  • Required: No
  • Introduced: API version 68.0
  • Description: User-defined name for the activity.
  • Type: string
  • Required: Yes
  • Introduced: API version 68.0
  • Description: Required. Unique API name of the activity.

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

This type extends BatchCalcJobAbstractMetadataValue and inherits its fields.

  • Type: string
  • Required: No
  • Description: Description of an aggregate node.
  • Type: string[]
  • Required: No
  • Description: Required. Collections of fields used to group data in an aggregate node.
  • Type: string
  • Required: Yes
  • Description: Required. Label of an aggregate node.
  • Type: string
  • Required: Yes
  • Description: Required. Name of an aggregate node.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the source node.

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

  • Type: BatchCalcJobAggregateFunction (enumeration of type string)
  • Required: Yes
  • Description: Required. Function used for aggregation.
  • Possible values:
    • 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.
  • Type: string
  • Required: Yes
  • Description: Required. Name that subsequent nodes within the data processing engine use to refer to the aggregate field.
  • Type: string
  • Required: Yes
  • Description: Required. Source node field on which the aggregate is calculated.

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

This type extends BatchCalcJobAbstractMetadataValue and inherits its fields.

  • Type: string
  • Required: No
  • Description: Description of the composite writeback object.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the composite writeback object.
  • Type: string
  • Required: Yes
  • Description: Required. API name of the composite writeback object.
  • Type: int
  • Required: No
  • Description: Sequence in which the data processing engine executes the composite write back node.

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

  • Type: string
  • Required: No
  • Introduced: API version 63.0
  • Description: Field name that’s associated with the child writeback object in a composite writeback relationship.
  • Type: string
  • Required: No
  • Description: Name of the child writeback object that’s associated with the writeback relationship.
  • Type: string
  • Required: No
  • Introduced: API version 63.0
  • Description: Field name that’s associated with the parent writeback object in a composite writeback relationship.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the parent writeback object that’s associated with the writeback relationship.
  • Type: string
  • Required: No
  • Introduced: API version 64.0
  • Description: Describes the relationship between the child and parent writeback objects in a composite writeback node.
  • Type: int
  • Required: Yes
  • Description: Sequence number of the writeback node that’s associated with its parent node in the relationship.

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

This type extends BatchCalcJobAbstractMetadataValue and inherits its fields.

  • Type: string
  • Required: No
  • Description: Description of a custom node.
  • Type: string
  • Required: Yes
  • Description: Required. Name of an extension node.
  • Type: string
  • Required: Yes
  • Description: Required. Namespace of an extension node.
  • Type: string
  • Required: Yes
  • Description: Required. Label of a custom node.
  • Type: string
  • Required: Yes
  • Description: Required. Name of a custom node.
  • Type: string[]
  • Required: No
  • Description: Sources of an extension node.

Represents the field mappings of an extension node.

  • Type: string
  • Required: Yes
  • Description: Required. Name of a parameter.
  • Type: string
  • Required: No
  • Description: Required. Value of a parameter.

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

This type extends BatchCalcJobAbstractMetadataValue and inherits its fields.

  • Type: BatchCalcJobCSVDelimiter (enumeration of type string)

  • Required: No

  • Description: Specifies the field separator to read fields from a CSV file record.

    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.

  • Possible values:

    • COMMA
    • BACKQUOTE
    • CARET
    • PIPE
    • SEMICOLON
    • TAB
  • Type: string
  • Required: No
  • Description: Description of a data source node.
  • Type: string
  • Required: No
  • Description: Specifies the source of the file or file storage system.
  • Type: string
  • Required: No
  • Description: The file path for the specified file.

  • Type: BatchCalcJobFileSource (enumeration of type string)

  • Required: No

  • Description: Specifies the source of the file or file storage system.

    Possible value is:

  • Possible values:

    • ContentManagement
  • Type: string
  • Required: Yes
  • Description: Required. Label of a data source node.
  • Type: string
  • Required: Yes
  • Description: Required. Name of a data source node.
  • Type: string
  • Required: No
  • Introduced: API version 67.0
  • Description: Name of the parent data source node.
  • Type: string
  • Required: Yes
  • Description: Required. Name of a standard or custom object from which the data source node extracts data.

  • Type: BatchCalcJobSubtype (enumeration of type string)

  • Required: No

  • Description: Specifies the subtype of the data source. Use this field to identify data source nodes that reference context nodes or similar structures.

    Valid value is:

    Available in API version 67.0 and later.

  • Possible values:

    • ContextNode
  • Type: BatchCalcJobDatasourceType (enumeration of type string)
  • Required: Yes
  • Description: Required. Type of object for the source object field. Supported values are: .
  • Possible values:
    • Analytics
    • CalculatedInsightsObject
    • Context — Available in API version 67.0 and later.
    • CRMObject
    • CSV
    • DataLakeObject
    • DataModelObject
    • StandardObject

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

  • Type: string
  • Required: No
  • Description: Name that subsequent nodes within the data processing engine use to refer to the data source field. Required when the field name is lookup.
  • Type: BatchCalcJobDataType (enumeration of type string)
  • Required: No
  • Description: Specifies the data type of the input field when using a CSV file as a data source.
  • Possible values:
    • Boolean — Available in API version 65.0 and later.
    • Date
    • DateTime
    • MultiValue
    • Numeric
    • Text
  • Type: boolean
  • Required: No
  • Description: Indicates whether a column name is the primary key (true) or not (false) for the Data Cloud CSV file.

  • Type: string

  • Required: Yes

  • Description: 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.

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

This type extends BatchCalcJobAbstractMetadataValue and inherits its fields.

  • Type: BatchCalcJobFilterCriteria[]

  • Required: No

  • Description: Collection of filter criteria in a filter node.

    The field is required when isDynamicFilter is set to False.

  • Type: string
  • Required: No
  • Description: Description of the batch calculation job filter.

  • Type: string

  • Required: No

  • Description: Logic that is specified to apply the filter conditions.

    The field is required when isDynamicFilter is set to False.

  • Type: string
  • Required: No
  • Description: Name of the parameter of type filter.
  • Type: boolean
  • Required: No
  • Description: Indicates whether the filter criteria is dynamic. If value is set to True, filter criteria is passed in runtime with filterParameterName.
  • Type: string
  • Required: Yes
  • Description: Required. Label of the filter node.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the filter node.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the source node.

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

  • Type: string
  • Required: No
  • Description: Name of the input variable used as a filter.
  • Type: BatchCalcJobFilterOperator (enumeration of type string)
  • Required: Yes
  • Description: Required. Operator that is specified in the filter condition.
  • Possible values:
    • Equals
    • NotEquals
    • GreaterThan
    • GreaterThanOrEqual
    • LessThan
    • LessThanOrEqual
    • StartsWith
    • EndsWith
    • Contains
    • DoesNotContain
    • IsNull
    • IsNotNull
    • In
    • NotIn
  • Type: int
  • Required: Yes
  • Description: Required. Sequence number used to refer the criteria in a filter node.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the field from the source node to apply the filter.
  • Type: string
  • Required: No
  • Description: Value used to filter data from the source node.

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

This type extends BatchCalcJobAbstractMetadataValue and inherits its fields.

  • Type: BatchCalcJobFrcstAccuracy (enumeration of type string)

  • Required: No

  • Description: The interval percentage to account for errors in forecasts.

    The default value is None.

  • Possible values:

    • Eighty
    • NinetyFive
    • None

  • Type: string

  • Required: Yes

  • Description: Required.

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

  • Type: string
  • Required: No
  • Description: The description of the forecast node.

  • Type: BatchCalcJobFrcstModel (enumeration of type string)

  • Required: No

  • Description: The model used to forecast data.

    The default value is Auto.

  • Possible values:

    • Additive
    • Auto
    • Multiplicative

  • Type: int

  • Required: No

  • Description: 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.

  • Type: BatchCalcJobFrcstPeriodType (enumeration of type string)

  • Required: Yes

  • Description: Required.

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

  • Possible values:

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

  • Type: string

  • Required: Yes

  • Description: Required.

    The name of the forecast node in the UI.

  • Type: string

  • Required: Yes

  • Description: Required.

    A unique name for the forecast node.

  • Type: string

  • Required: Yes

  • Description: Required.

    The start date of the forecast period.

  • Type: BatchCalcJobFrcstSeasonality (enumeration of type string)

  • Required: No

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

    The default value is None.

  • Possible values:

    • 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

  • Type: boolean

  • Required: No

  • Description: 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.

  • Type: string

  • Required: Yes

  • Description: Required.

    The name of the source node.

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

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

  • Type: string

  • Required: Yes

  • Description: Required.

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

  • Type: string

  • Required: No

  • Description: 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

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

This type extends BatchCalcJobAbstractMetadataValue and inherits its fields.

  • Type: string
  • Required: No
  • Description: Description of the hierarchy path node.
  • Type: string
  • Required: Yes
  • Description: Required. Field name that contains the hierarchy path.
  • Type: boolean
  • Required: No
  • Introduced: API version 67.0
  • Description: Indicates whether aggregation is required for the hierarchy path node (true) or not (false).
  • Type: boolean
  • Required: No
  • Description: Indicates whether the self value is included in the calculated hierarchy path (True) or not (False).
  • Type: string
  • Required: Yes
  • Description: Required. Label of the hierarchy path node.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the hierarchy path node.
  • Type: string
  • Required: Yes
  • Description: Required. Parent field name to calculate hierarchy path.
  • Type: double
  • Required: No
  • Introduced: API version 264.0
  • Description: Multiplication factor used for the rollup calculation in the hierarchy path node.
  • Type: string
  • Required: No
  • Introduced: API version 67.0
  • Description: Field name used for rollup percentage calculation in the hierarchy path.
  • Type: string
  • Required: Yes
  • Description: Required. Self field name to calculate hierarchy path.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the source node.

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

  • Type: string
  • Required: No

  • Type: BatchCalcJobHierPathAggrFunc (enumeration of type string)

  • Required: Yes

  • Description: Required. Function used to aggregate values across the hierarchy path.

    Available in API version 67.0 and later.

  • Possible values:

    • Count
    • Sum
  • Type: string
  • Required: Yes
  • Type: boolean
  • Required: No
  • Introduced: API version 68.0
  • Description: Indicates whether to exclude the parent record’s value from the hierarchical aggregation (true) or include it (false). The default value is false. This field is supported only when definitionRunMode is OnDemand.

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.

  • Type: string
  • Required: Yes
  • Description: Required. Mapped field name of the primary source node.
  • Type: string
  • Required: Yes
  • Description: Required. Mapped field name of the secondary source node.

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

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

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

  • Type: string
  • Required: Yes
  • Description: Required. Name of the field that is used to sort data.

  • Type: BatchCalcJobOrderType (enumeration of type string)

  • Required: Yes

  • Description: Order in which the data is sorted.

    Valid values are:

    • Ascending
    • Descending

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

This type extends BatchCalcJobAbstractMetadataValue and inherits its fields.

  • Type: BatchCalcJobParameterDataType (enumeration of type string)
  • Required: Yes
  • Description: Required. Data type of the parameter.
  • Possible values:
    • Date
    • DateTime
    • Expression
    • FileIdentifier
    • Filter
    • Numeric
    • Text
  • Type: string
  • Required: No
  • Description: Default value of the parameter.
  • Type: string
  • Required: No
  • Description: Description of the batch calculation job parameter.
  • Type: boolean
  • Required: Yes
  • Description: Indicates whether the parameter has different values (True) or not (False). This field is supported only for the Text data type.
  • Type: string
  • Required: Yes
  • Description: Required. Label of the batch calculation job parameter.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the batch calculation job parameter.

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

This type extends BatchCalcJobAbstractMetadataValue and inherits its fields.

  • Type: string
  • Required: No
  • Description: Description of the join node.
  • Type: boolean
  • Required: No
  • Introduced: API version 67.0
  • Description: Indicates whether the lookup join returns multiple values (true) or not (false).
  • Type: BatchCalcJobJoinKey[]
  • Required: No
  • Description: Collection of mapping of fields from the primary source node and the second source node in a join node.
  • Type: string
  • Required: Yes
  • Description: Required. Label of the join node.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the join node.
  • Type: string
  • Required: Yes
  • Description: Required. Name associated with the node as the primary source node.
  • Type: string
  • Required: Yes
  • Description: Required. Name associated with the node as the secondary source node.
  • Type: BatchCalcJobSourceJoinType (enumeration of type string)
  • Required: Yes
  • Description: Required. Type of join specified between the primary source node and secondary source node.
  • Possible values:
    • LeftOuter
    • RightOuter
    • Inner
    • Outer
    • Lookup

Represents a stage in a data processing engine definition. A step groups related activities that must be completed before the definition advances to the next step.

This type extends BatchCalcJobAbstractMetadataValue and inherits its fields.

  • Type: string
  • Required: No
  • Introduced: API version 68.0
  • Description: User-defined name for the step.
  • Type: string
  • Required: No
  • Introduced: API version 68.0
  • Description: Unique API name that identifies the step.
  • Type: BatchCalcJobStepProcNode[]
  • Required: No
  • Introduced: API version 68.0
  • Description: Collection of process nodes that associate activities with the step.
  • Type: string[]
  • Required: No
  • Introduced: API version 68.0
  • Description: Collection of source node names associated with the step.

Represents the association between a step and an activity that runs in that step. The sequence number defines the execution order of activities in a step.

  • Type: string
  • Required: Yes
  • Introduced: API version 68.0
  • Description: Required. Action that represents the activity in the step.
  • Type: int
  • Required: No
  • Introduced: API version 68.0
  • Description: Execution order of the activity in the step.

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

This type extends BatchCalcJobAbstractMetadataValue and inherits its fields.

  • Type: string
  • Required: No
  • Description: The description of the batch calculation job transform.
  • Type: BatchCalcJobTransformDroppedField[]
  • Required: No
  • Description: The collection of dropped fields in a data transformation. Available when the transformation type is Slice.
  • Type: BatchCalcJobTransformAddedField[]
  • Required: No
  • Description: The collection of formula fields in a data transformation. Available when the transformation type is Expression.
  • Type: string
  • Required: Yes
  • Description: Required. The label of the batch calculation job transform.
  • Type: string
  • Required: Yes
  • Description: Required. The name of the batch calculation job transform.
  • Type: BatchCalcJobOrderByField[]
  • Required: No
  • Description: A collection of fields that’s used to sort the records within each partition group.
  • Type: string[]
  • Required: No
  • Description: A group of fields that’s used to partition the source data into partition groups.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the source node.
  • Type: BatchCalcJobTransformType (enumeration of type string)
  • Required: Yes
  • Type: BatchCalcJobTransform​Type (enumeration of type string)
  • Required: Yes
  • Description: Required. The type of transformation.
  • Possible values:
    • 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.

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

  • Type: string
  • Required: Yes
  • Description: Required. Name that subsequent nodes within the data processing engine use to the transform node.
  • Type: BatchCalcJobDataType (enumeration of type string)
  • Required: Yes
  • Description: Required. Data type of the formula.
  • Possible values:
    • Boolean — Available in API version 65.0 and later.
    • Date
    • DateTime
    • MultiValue
    • Numeric
    • Text
  • Type: int
  • Required: No
  • Description: Number of digits to the right of a decimal point in the value. Required for the Numeric data type.
  • Type: int
  • Required: No
  • Introduced: API version 68.0
  • Description: The order in which this expression is evaluated in its parent formula node. Values start at 1 and must be continuous. This field can be null for legacy formulas.
  • Type: string
  • Required: Yes
  • Description: Required. Formula defined by the user.
  • Type: int
  • Required: No
  • Description: Total length of the value including the decimal places. Required for data types: Text and Numeric.

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

  • Type: string
  • Required: Yes
  • Description: Required. Name of the field that is dropped.

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

This type extends BatchCalcJobAbstractMetadataValue and inherits its fields.

  • Type: string
  • Required: No
  • Description: Description of the batch calculation job union.
  • Type: boolean
  • Required: No
  • Description: 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.
  • Type: string
  • Required: Yes
  • Description: Required. Label of the batch calculation job union.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the batch calculation job union.
  • Type: string[]
  • Required: No
  • Description: Names of the source nodes.

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

  • Type: BatchCalcJobWritebackKeyType (enumeration of type string)
  • Required: No
  • Introduced: API version 64.0
  • Description: Target field type on the writeback object.
  • Possible values:
    • EventTimeField — Available in API version 67.0 and later.
    • ParentRecordIdentifierField — Available in API version 67.0 and later.
    • PrimaryKey
    • QualifierKey
    • RecordIdentifierField — Available in API version 67.0 and later.
  • Type: boolean
  • Required: No
  • Introduced: API version 64.0
  • Description: Indicates whether the target field value on the writeback object is autogenerated (true) or not (false).
  • Type: string
  • Required: No
  • Description: Name of the lookup object. Required only when the relationshipName field is defined.
  • Type: string
  • Required: No
  • Description: Name of the lookup relationship.
  • Type: boolean
  • Required: No
  • Introduced: API version 59.0
  • Description: Indicates whether the source field from runtime parameter is true or false. The default value is false.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the field in the source node that is written back.
  • Type: string
  • Required: No
  • Description: Name of the sObject field to which the results are written back.

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

This type extends BatchCalcJobAbstractMetadataValue and inherits its fields.

  • Type: boolean
  • Required: No
  • Introduced: API version 64.0
  • Description: Indicates whether the non-editable fields are included in field mapping when the action type is upsert. The default value is false.
  • Type: string
  • Required: No
  • Description: Descriptions of the batch calculation job writeback object.
  • Type: string
  • Required: No
  • Introduced: API version 60.0
  • Description: Unique external field ID for the target object name.
  • Type: string
  • Required: No
  • Introduced: API version 57.0
  • Description: 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.
  • Type: string
  • Required: No
  • Introduced: API version 57.0
  • Description: The folder where the writeback dataset is saved.
  • Type: string
  • Required: No
  • Description: Reserved for future use.
  • Type: boolean
  • Required: No
  • Description: Indicates whether a row in the write back object is changed. Set to True to write back the changed rows.
  • Type: boolean
  • Required: No
  • Introduced: API version 62.0
  • Description: Indicates whether a CRM Application (CRMA) dataset or a Data Lake object is present (true) or will be created (false).
  • Type: BatchCalcJobWbJsonStructType (enumeration of type string)
  • Required: No
  • Introduced: API version 67.0
  • Description: JSON structure type for the writeback object.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the write back object.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the batch calculation job write back object.
  • Type: BatchCalcJobWritebackOpn (enumeration of type string)
  • Required: No
  • Description: Type of operation specified.
  • Possible values:
    • 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
  • Type: string
  • Required: No
  • Introduced: API version 57.0
  • Description: The name of the source object from which the row-level sharing inheritance settings are applied.
  • Type: boolean
  • Required: No
  • Introduced: API version 65.0
  • Description: Indicates whether target Data Lake Object or Salesforce Object is created in Salesforce (true) or not (false).
  • Type: boolean
  • Required: No
  • Description: Reserved for future use.
  • Type: string
  • Required: Yes
  • Description: Required. Name of the source node associated with the write back object.
  • Type: BatchCalcJobWritebackType (enumeration of type string)
  • Required: No
  • Introduced: API version 57.0
  • Description: Specifies where you want to use the data stored in the source node. The default value is sObject.
  • Possible values:
    • Analytics
    • DataLakeObject
    • sObject
  • Type: BatchCalcJobWbTargetObjCateg (enumeration of type string)
  • Required: No
  • Introduced: API version 67.0
  • Description: Category of the target object for the writeback operation.
  • Type: string
  • Required: Yes
  • Description: Required. Object that is inserted or upserted by the data processing engine.
  • Type: int
  • Required: No
  • Type: int
  • Required: No
  • Description: Sequence in which the target object is updated by the data processing engine.
  • Type: string
  • Required: No
  • Description: ID of the user whose permissions decide which objects and fields of the target object can be updated.

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

  • Type: BatchCalcJobAggregateFunction (enumeration of type string)

  • Required: Yes

  • Description: Required.

    The function of the aggregate field.

  • Possible values:

    • Avg
    • Count
    • Max
    • Min
    • Std
    • StdP
    • Sum
    • Unique
    • Var
    • VarP

  • Type: string

  • Required: Yes

  • Description: Required.

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

  • Type: string

  • Required: Yes

  • Description: Required.

    The name of the source field.

The following is an example of a BatchCalcJobDefinition component.

The following is an example package.xml that references the previous definition.

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.