ExpressionSetDefinition

Represents an expression set definition.

Before deploying an expression set or an expression set version to a target org, review these Expression Set Migration Considerations.

This type extends Metadata and inherits its fields.

ExpressionSetDefinition components have the suffix .expressionSetDefinition and are stored in the expressionSetDefinition folder.

Introduced in API version 55.0.

  • Type: string
  • Required: No
  • Type: string[]
  • Required: No
  • Introduced: API version 59.0
  • Description: The context definition associated with the expression set definition.
  • Type: string
  • Required: No
  • Description: The description of an expression set definition.
  • Type: ExpsSetExecutionMode (enumeration of type string)
  • Required: No
  • Description: Specifies the execution mode for the expression set definition.
  • Possible values:
    • Cloud
    • Local
  • Type: ExpsSetExecutionScale (enumeration of type string)
  • Required: No
  • Description: Specifies the scale of the inputs that an expression set processes. The scale determines where the expression set is executed.
  • Possible values:
    • High
    • Low
  • Type: ExpsSetInterfaceSourceType (enumeration of type string)
  • Required: No
  • Description: The interface source type designed by the consuming cloud that’s making a customized expression set builder available to its users.
  • Type: string
  • Required: Yes
  • Description: Required.
  • Type: ExpsSetProcessType (enumeration of type string)
  • Required: No
  • Description: The process type that uses the expression set rule.
  • Type: ResourceInitializationType (enumeration of type string)
  • Required: No
  • Description: Indicates whether the initial value of expression set variables and context tags is null or a default value.
  • Type: boolean
  • Required: No
  • Description: Defines whether an expression set is a template or not.
  • Type: ExpsSetType (enumeration of type string)
  • Required: No
  • Description: The type of the expression set definition.
  • Possible values:
    • Custom
    • Standard
  • Type: ExpsSetUsageSubtype (enumeration of type string)
  • Required: No
  • Description: The subtype of the industry that’s using the expression set definition. If no value is specified, the field defaults to null.

  • Type: ExpressionSetDefinitionVersion[]

  • Required: No

  • Description: Represents an array of expression set version definitions in an expression set.

    This array must contain at least one version.

  • Type: string
  • Required: Yes
  • Type: string
  • Required: Yes

Represents an advanced condition step.

  • Type: string
  • Required: Yes
  • Description: Required.
  • Type: string
  • Required: No
  • Description: An error message for a failed advanced condition.
  • Type: string
  • Required: No
  • Description: An expression set definition version variable associated with the result of a step.
  • Type: string
  • Required: No
  • Description: A success message for a successful advanced condition.

Represents an aggregation step.

  • Type: string
  • Required: Yes
  • Description: Required.
  • Type: ExpsSetAggregationFunction (enumeration of type string)
  • Required: Yes
  • Description: Required.
  • Type: string
  • Required: Yes
  • Description: Required.

Represents an assignment step.

  • Type: string
  • Required: Yes
  • Type: string
  • Required: Yes
  • Description: Required.

Represents a criterion defined in an advanced condition.

  • Type: ExpsSetConditionOperator (enumeration of type string)
  • Required: Yes
  • Description: Required.
  • Type: int
  • Required: Yes
  • Description: Required.
  • Type: string
  • Required: Yes
  • Description: Required.
  • Type: string
  • Required: No
  • Description: Specifies the condition of a criterion.
  • Type: ExpsSetValueType (enumeration of type string)
  • Required: No
  • Description: Specifies the type of value.

Represents a condition in a condition step.

  • Type: string
  • Required: No
  • Description: An error message for a failed condition.
  • Type: string
  • Required: Yes
  • Description: Required.
  • Type: string
  • Required: No
  • Description: The expression set definition version variable associated with the result of a step.
  • Type: string
  • Required: No
  • Description: A success message for a successful condition.

Represents a custom element in an expression set.

Introduced in API version 56.0.

Represents a decision table or decision matrix in a step.

  • Type: string
  • Required: Yes
  • Description: Required.
  • Type: string
  • Required: Yes
  • Description: Required.

Represents a definition of an expression set version.

This type extends Metadata and inherits its fields.

  • Type: int
  • Required: No
  • Description: Number of decimal places to be used in the results of calculation steps that involve context variables.
  • Type: string
  • Required: No
  • Description: Describes the version of an expression set definition.
  • Type: dateTime
  • Required: No
  • Description: The date until which the expression set definition is available for use.
  • Type: string
  • Required: No
  • Description: The full name of an expression set definition.
  • Type: ExpsSetInterfaceSourceType (enumeration of type string)
  • Required: No
  • Description: The interface source type designed by the consuming cloud that’s making a customized expression set builder available to its users.
  • Type: string
  • Required: Yes
  • Description: Required.
  • Type: ExpsSetProcessType (enumeration of type string)
  • Required: No
  • Introduced: API version 67.0
  • Description: The process type that uses the expression set rule.
  • Type: int
  • Required: No
  • Introduced: API version 62.0
  • Description: The rank of the Expression Set Definition Version. When more than one enabled version matches an expression set call, and the start date time to end date time spans overlap, the version with the highest rank is chosen.
  • Type: boolean
  • Required: No
  • Introduced: API version 56.0
  • Description: Indicates whether the decision explanation is exposed to external users (true) or not (false). The default value is false.
  • Type: dateTime
  • Required: Yes
  • Description: Required.
  • Type: ExpsSetStatus (enumeration of type string)
  • Required: Yes
  • Description: Required.
  • Type: ExpressionSetStep[]
  • Required: No
  • Description: Represents an array of steps created in an expression set version.
  • Type: boolean
  • Required: No
  • Description: Indicates whether the API call originated from the design time builder or a package.

This field is for internal use only.
  • Type: ExpressionSetVariable[]
  • Required: No
  • Description: Represents an array of variables in an expression set version.
  • Type: int
  • Required: Yes
  • Description: Required.

Represents a parameter within a custom element of an expression set.

Introduced in API version 56.0.

  • Type: string
  • Required: No
  • Description: The data type of the custom element parameter.

  • Type: boolean

  • Required: Yes

  • Description: Required.

    Indicates whether the custom element parameter is input (true) or not (false).

  • Type: string

  • Required: Yes

  • Description: Required.

    The name of the custom element parameter.

  • Type: boolean

  • Required: Yes

  • Description: Required.

    Indicates whether the custom element parameter is output (true) or not (false).

  • Type: ExpsSetValueType (enumeration of type string)

  • Required: No

  • Description: The type of custom element parameter.

    Values are:

  • Possible values:

    • Formula
    • Literal
    • Lookup
    • Parameter
    • PickList

  • Type: string

  • Required: Yes

  • Description: Required.

    The name of the expression set variable.

Represents a step in an expression set version.

  • Type: BusinessKnowledgeModel (enumeration of type string)
  • Required: No
  • Description: Specifies the type of action this step executes.
  • Possible values:
    • AiAcceleratorSubscriberChurnPrediction
    • ApexAction
    • ApexListAction — (Available in API version 64.0 and later.)
    • AssetDiscovery
    • AssignBadgeToMember
    • AssignParameterValues
    • AssignmentElement
    • AssignmentRuleCustomQueue — (Available in API version 65.0 and later.)
    • AssignmentRuleCustomUser — (Available in API version 65.0 and later.)
    • AteprlRecordCreator — (Available in API version 65.0 and later.)
    • AttributeAdjustmentMatrix
    • AttributeDiscount
    • AutomatedClaimsProcessingValidation
    • BaseRate
    • BindingObjectRateAdjustmentResolution — (Available in API version 64.0 and later.)
    • BindingObjectRateCardEntryResolution — (Available in API version 64.0 and later.)
    • BreAggregator
    • BreAggregatorAssignment
    • BreakdownLineMapping — (Available in API version 64.0 and later.)
    • BundleDiscount
    • CalculateQuantity — (Available in API version 64.0 and later.)
    • ChangeMemberTier
    • CheckMemberBadgeAssignment
    • CommercePricing — (Available in API version 62.0 and later.)
    • CommitmentAdjustment — (Available in API version 65.0 and later.)
    • ComplianceCheck
    • ComplianceControlLog — (Available in API version 62.0 and later.)
    • Constraint — (Available in API version 64.0 and later.)
    • CreditPoints
    • Crud
    • DebitPoints
    • DerivedPricing
    • DiscountDistributionService
    • DiscoverySettings — (Available in API version 64.0 and later.)
    • DynamicRulesExecutor — (Available in API version 65.0 and later.)
    • EvaluateCategoryDisqualification — (Available in API version 62.0 and later.)
    • EvaluateCategoryQualification — (Available in API version 62.0 and later.)
    • EvaluateDisqualification
    • EvaluateQualification
    • FormulaBasedPricing
    • FormulaBasedRating — (Available in API version 62.0 and later.)
    • GetCustomerPromotionAttrValue — (Available in API version 64.0 and later.)
    • GetMemberAttributesValues
    • GetMemberPartnerLinkageStatus
    • GetMemberPointBalance
    • GetMemberPromotions
    • GetMemberTier
    • GetOutputsFromDecisionMatrix
    • GetOutputsFromDecisionTable
    • GetUserData
    • GroupingAndAggregatePricing
    • GroupingAndAggregateRating — (Available in API version 62.0 and later.)
    • IncreaseUsageForCumulativePromotion
    • IntegrationOrchestration
    • InterNodeDataCopy
    • IssueExtendedReward — (Available in API version 64.0 and later.)
    • IssueVoucher
    • ListGroup
    • ListGroupCalculation
    • ListPrice
    • ManualDiscount
    • ManualRatingDiscount — (Available in API version 62.0 and later.)
    • MapProduct
    • MinimumPrice — (Available in API version 62.0 and later.)
    • MultiRecipientProductQualification — (Available in API version 64.0 and later.)
    • NegotiatedBaseRate — (Available in API version 64.0 and later.)
    • NegotiatedRateCardEntryResolution — (Available in API version 64.0 and later.)
    • NegotiatedTierAdjustment — (Available in API version 64.0 and later.)
    • NegotiatedVolumeAdjustment — (Available in API version 64.0 and later.)
    • PredictiveAI
    • PriceAdjustmentMatrix
    • PriceGuidance — (Available in API version 64.0 and later.)
    • PriceRevision — (Available in API version 65.0 and later.)
    • PricingPropagation — (Available in API version 65.0 and later.)
    • PricingSettings
    • PromotionExecution — (Available in API version 65.0 and later.)
    • PromotionsDiscount
    • Proration
    • RateAdjustmentByAttributeResolution — (Available in API version 62.0 and later.)
    • RateAdjustmentByTierResolution — (Available in API version 62.0 and later.)
    • RateAdjustmentMatrix — (Available in API version 62.0 and later.)
    • RateAssignment — (Available in API version 62.0 and later.)
    • RateCardEntryResolution — (Available in API version 62.0 and later.)
    • RateCardResolution — (Available in API version 62.0 and later.)
    • RatingAttributeDiscount
    • RatingBreakdownLineMapping — (Available in API version 65.0 and later.)
    • RatingRoundingValues — (Available in API version 62.0 and later.)
    • RatingSetting
    • RatingTierDiscount
    • RatingVolumeDiscount
    • RecordAction
    • RecordAlert
    • RedeemVoucher
    • RoundingValues
    • RuleFetch
    • RunFlow
    • RunProgramProcess
    • SampleBusinessElementWithContext
    • SampleCustomElementWithExpressionAndListFilter
    • SampleDynamicCustomElement
    • SampleJavaBasedTaxCalculatorCustomElement
    • SampleTaxCalculatorCustomElement
    • SendMail
    • StopPricing
    • StopRating — (Available in API version 62.0 and later.)
    • SubscriptionPricing
    • TermGpaCalculation — (Available in API version 64.0 and later.)
    • TermGpaReporting — (Available in API version 64.0 and later.)
    • TestCustomElement
    • UpdateCurrentValueForMemberAttribute
    • UpdateCustomerPromotionAttrValue — (Available in API version 64.0 and later.)
    • UpdatePointBalance
    • UpdateUsageForCumulativePromotion
    • UpsertRecord — (Available in API version 64.0 and later.)
    • VolumeDiscount
    • VolumeTierDiscount
  • Type: ExpressionSetCustomElement
  • Required: No
  • Introduced: API version 56.0
  • Description: Represents a custom element step that contains the input and output mappings.
  • Type: string
  • Required: No
  • Description: Describes an expression set definition version step.
  • Type: string
  • Required: No
  • Description: The explainability message template that’s used when the result type of a condition step in an expression set is Failed.

  • Type: ExplainabilityMessageTemplateTokenMapping[]

  • Required: No

  • Description: List of the token resource mappings of the failed explainability message template.

    Available in API version 59.0 and later.

  • Possible values:

    • expressionSetMessageToken
    • resourceReference

  • Type: boolean

  • Required: No

  • Introduced: API version 67.0

  • Description: Indicates whether the step has nested explainability (

    ) or not (

    ).

  • Type: string
  • Required: Yes
  • Description: Required.
  • Type: string
  • Required: Yes
  • Description: Required.
  • Type: string
  • Required: No
  • Introduced: API version 59.0
  • Description: The explainability message template that’s used when the result type of a condition step in an expression set is No Result.

  • Type: ExplainabilityMessageTemplateTokenMapping[]

  • Required: No

  • Description: List of the token resource mappings of the no result explainability message template.

    Available in API version 59.0 and later.

  • Possible values:

    • expressionSetMessageToken
    • resourceReference
  • Type: string
  • Required: No
  • Description: The name of the parent step in an expression set definition version that’s associated with a step.
  • Type: string
  • Required: No
  • Description: The explainability message template that’s used when the result type of a condition step in an expression set is Passed.

  • Type: ExplainabilityMessageTemplateTokenMapping[]

  • Required: No

  • Description: List of the token resource mappings of the passed explainability message template.

    Available in API version 59.0 and later.

  • Possible values:

    • expressionSetMessageToken
    • resourceReference
  • Type: boolean
  • Required: No
  • Description: Indicates whether the step output must be included in the expression result (true) or not (false).
  • Type: int
  • Required: Yes
  • Description: Required.
  • Type: boolean
  • Required: No
  • Description: Indicates whether the details of the condition are shown in the decision explanation.
  • Type: boolean
  • Required: No
  • Description: Indicates whether the message in the explainability message template is exposed for only the branch path that was run.
  • Type: boolean
  • Required: No
  • Description: Indicates whether the decision explanations are shown to external users.
  • Type: ExpsSetStepType (enumeration of type string)
  • Required: Yes
  • Description: Required.

Represents a sub expression in a step.

  • Type: string
  • Required: Yes
  • Description: Required.

Represents a definition of an expression set variable.

  • Type: boolean
  • Required: No
  • Description: Indicates whether a variable stores a collection of values (true) or not (false).
  • Type: ExpsSetDataType (enumeration of type string)
  • Required: Yes
  • Description: Required.
  • Type: int
  • Required: No
  • Description: The decimal digits in the currency, number, or percent data type for an expression set variable.
  • Type: string
  • Required: No
  • Description: The description of the variable used in an expression set.
  • Type: ExpressionSetVariableField[]
  • Required: No
  • Description: Represents an array of fields in an object that’s used as a variable in an expression set.
  • Type: boolean
  • Required: No
  • Description: Indicates whether an expression set variable is used as an input (true) in an expression or not (false).
  • Type: string
  • Required: No
  • Description: The API name of a decision matrix, a decision table, or a sub expression.
  • Type: ExpsSetVariableLookupType (enumeration of type string)
  • Required: No
  • Description: The type of the lookup used in an expression set definition.
  • Type: string
  • Required: Yes
  • Description: Required.
  • Type: string
  • Required: No
  • Description: The name of the sObject.
  • Type: boolean
  • Required: No
  • Description: Indicates whether an expression set variable is used as an output in an expression(true) or not (false).
  • Type: string
  • Required: No
  • Description: The name of the parent node in the standard context definition for the local context node or attribute.
  • Type: string
  • Required: No
  • Description: The name of the parent local node for a local context node or attribute.
  • Type: string
  • Required: No
  • Description: The step that produces the expression set variable.
  • Type: ExpsSetVariableType (enumeration of type string)
  • Required: Yes
  • Description: Required.
  • Type: string
  • Required: No
  • Description: Represents a constant value or a formula.

Represents a definition of a field in an object that’s used as a variable in an expression set.

  • Type: ExpsSetDataType (enumeration of type string)
  • Required: Yes
  • Description: Required.
  • Type: int
  • Required: No
  • Description: The decimal digits in the currency, number, or percent data type for an expression set variable.
  • Type: ExpressionSetVariableField[]
  • Required: No
  • Description: Represents an array of fields in an object that’s used as a variable in an expression set.
  • Type: string
  • Required: No
  • Description: The API name of a decision matrix, a decision table, or a sub expression.
  • Type: ExpsSetVariableLookupType (enumeration of type string)
  • Required: No
  • Description: Required.
  • Type: string
  • Required: Yes
  • Description: Required.
  • Type: string
  • Required: No
  • Description: The name of the sObject.

The following is an example of an ExpressionSetDefinition 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.