ExpressionSetDefinition

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

Note

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

File Suffix and Directory Location

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

Version

ExpressionSetDefinition components are available in API version 55.0 and later.

Fields

Field Name	Description
description	Field Type string Description The description of an expression set definition.
label	Field Type string Description Required. The UI label of an expression set definition.
processType	Field Type ExpsSetProcessType (enumeration of type string) Description The process type that uses the expression set rule. Valid values are: `Bre`—Business Rules Engine `TransactionJournal` `TierProcessing` `CustomLoyalty`
template	Field Type boolean Description Defines whether an expression set is a template or not.
versions	Field Type ExpressionSetDefinitionVersion[] Description Represents an array of expression set version definitions in an expression set. This array must contain at least one version. Note

ExpressionSetDefinitionVersion

Represents a definition of an expression set version.

Field Name	Description
description	Field Type string Description Describes the version of an expression set definition.
endDate	Field Type dateTime Description The date until which the expression set definition is available for use.
expressionSetDefinition	Field Type string Description The full name of an expression set definition.
label	Field Type string Description Required. The UI label of an expression set definition.
shouldShowExplExternally	Field Type boolean Description Indicates whether the decision explanation is exposed to external users (`true`) or not (`false`). The default value is `false`. Available in API version 56.0 and later.
startDate	Field Type dateTime Description Required. The date from when the expression set definition is available for use.
status	Field Type ExpsSetStatus (enumeration of type string) Description Required. The status of an expression set definition. Possible values are: `Active` `Draft` `Inactive` `InvalidDraft` `Obsolete`
steps	Field Type ExpressionSetStep[] Description Represents an array of steps created in an expression set version.
uiTier	Field Type boolean Description Indicates whether the API call originated from the design time builder or a package. This field is for internal use only. Note
variables	Field Type ExpressionSetVariable[] Description Represents an array of variables in an expression set version.
versionNumber	Field Type int Description Required. The version number of an expression set definition.

ExpressionSetStep

Represents a step in an expression set version.

Field Name	Description
actionType	Field Type BusinessKnowledgeModel (enumeration of type string) Description Specifies the type of action this step executes. Valid values are: `AssignParameterValues` `AssignBadgeToMember` `BreAggregator` `BreAggregatorAssignment` `CheckMemberBadgeAssignment` `ChangeMemberTier` `CreditPoints` `Crud` `DebitPoints` `GetMemberAttributesValues` `GetOutputsFromDecisionMatrix` `GetOutputsFromDecisionTable` `GetMemberAttributesValues` `GetMemberPointBalance` `GetMemberPromotions` `GetMemberTier` `IncreaseUsageForCumulativePromotion` `IssueVoucher` `IncreaseUsageForCumulativePromotion` `RunFlow` `RunProgramProcess` `TestCustomElement` `UpdateUsageForCumulativePromotion` `UpdatePointBalance` `UpdateCurrentValueForMemberAttribute`
advancedCondition	Field Type ExpressionSetAdvancedCondition Description Represents an advanced condition step.
aggregation	Field Type ExpressionSetAggregation Description Represents an aggregation step.
assignment	Field Type ExpressionSetAssignment Description Represents an assignment step.
conditionExpression	Field Type ExpressionSetConditionExpression Description Represents a condition step.
customElement	Field Type ExpressionSetCustomElement Description Represents a custom element step that contains the input and output mappings. Available in API version 56.0 and later.
decisionTable	Field Type ExpressionSetDecisionTable Description Represents a decision matrix or decision table step.
description	Field Type string Description Describes an expression set definition version step.
failedExplainerTemplate	Field Type string Description The explainability message template that’s used when the result type of a condition step in an expression set is Failed.
label	Field Type string Description Required. The UI label of an expression set definition version step.
name	Field Type string Description Required. The full name of an expression set definition version step.
parentStep	Field Type string Description The name of the parent step in an expression set definition version that’s associated with a step.
passedExplainerTemplate	Field Type string Description The explainability message template that’s used when the result type of a condition step in an expression set is Passed.
resultIncluded	Field Type boolean Description Indicates whether the step output must be included in the expression result (true) or not (false).
sequenceNumber	Field Type int Description Required. The sequence number of a step in an expression set definition version.
shouldExposExecPathMsgOnly	Field Type boolean Description Indicates whether the message in the explainability message template is exposed for only the branch path that was run.
shouldExposeConditionDetails	Field Type boolean Description Indicates whether the details of the condition are shown in the decision explanation.
shouldShowExplExternally	Field Type boolean Description Indicates whether the decision explanations are shown to external users.
stepType	Field Type ExpsSetStepType (enumeration of type string) Description Required. Specifies the type of step in an expression set definition version. Valid values are: `AdvancedCondition` `Branch` `BusinessKnowledgeModel` `Condition` `DefaultPath` `SubExpression`
subExpression	Field Type ExpressionSetSubExpression Description Represents a sub expression step.

ExpressionSetAdvancedCondition

Represents an advanced condition step.

Field Name	Description
conditionLogic	Field Type string Description Required. The condition that’s defined for an advanced condition.
criteria	Field Type ExpressionSetConditionCriteria [] Description Represents an array of criteria defined in the advanced condition.
errorMessage	Field Type string Description An error message for a failed advanced condition.
resultParameter	Field Type string Description An expression set definition version variable associated with the result of a step.
successMessage	Field Type string Description A success message for a successful advanced condition.

ExpressionSetConditionCriteria

Represents a criterion defined in an advanced condition.

Field Name	Description
operator	Field Type ExpsSetConditionOperator (enumeration of type string) Description Required. Specifies the operator for evaluating an expression. Valid values are: `Contains` `DoesNotContain` `Equals` `GreaterThan` `GreaterThanOrEquals` `IsNull` `IsNotNull` `LessThan` `LessThanOrEquals` `NoEquals`
sequenceNumber	Field Type int Description Required. The position of the condition in a step that contains multiple conditions.
sourceFieldName	Field Type string Description Required. The expression set definition version variable associated with the result of a condition criterion.
value	Field Type string Description Specifies the condition of a criterion.
valueType	Field Type ExpsSetValueType (enumeration of type string) Description Specifies the type of value. Valid values are: `Formula` `Literal` `Lookup` `Parameter` `Picklist`

ExpressionSetAggregation

Represents an aggregation step.

Field Name	Description
aggregatedParameter	Field Type string Description Required. The expression set definition version variable associated with the result of a condition criterion.
aggregateFunction	Field Type ExpsSetAggregationFunction (enumeration of type string) Description Required. Specifies the aggregation function used in a step. Valid values are: `Avg` `Max` `Min` `Sum`
expression	Field Type string Description Required. Specifies the expression of an aggregation.

ExpressionSetAssignment

Represents an assignment step.

Field Name	Description
aggregatedParameter	Field Type string Description Required. The expression set definition version variable associated with a step detail.
expression	Field Type string Description Required. The expression that’s defined for a step.

ExpressionSetConditionExpression

Represents a condition in a condition step.

Field Name	Description
errorMessage	Field Type string Description An error message for a failed condition.
expression	Field Type string Description Required. The expression that’s defined for a step.
resultParameter	Field Type string Description The expression set definition version variable associated with the result of a step.
successMessage	Field Type string Description A success message for a successful condition.

ExpressionSetCustomElement

Represents a custom element in an expression set. Available in API version 56.0 and later.

Field Name	Description
parameters	Field Type ExpressionSetElementParameter[] Description Represents the list of parameters in custom element

ExpressionSetElementParameter

Represents a parameter within a custom element of an expression set. Available in API version 56.0 and later.

Field Name	Description
input	Field Type boolean Description Required. Indicates whether the custom element parameter is input (`true`) or not (`false`). The default value is `true`.
name	Field Type string Description Required. The name of the custom element parameter.
output	Field Type boolean Description Required. Indicates whether the custom element parameter is output (`true`) or not (`false`). The default value is `true`.
type	Field Type ExpsSetValueType (enumeration of type string) Description The type of custom element parameter. Values are: `Formula` `Literal` `Lookup` `Parameter` `PickList` The default value is `Parameter`.
value	Field Type string Description Required. The name of the expression set variable.

ExpressionSetDecisionTable

Represents a decision table or decision matrix in a step.

Field Name	Description
decisionTableName	Field Type string Description Required. The decision matrix or decision table name used in a step.
type	Field Type string Description Required. The type in a step. It can be a decision table or decision matrix.

ExpressionSetSubExpression

Represents a sub expression in a step.

Field Name	Description
expressionSet	Field Type string Description Required. The sub expression name used in a step.

ExpressionSetVariable

Represents a definition of an expression set variable.

Field Name	Description
collection	Field Type boolean Description Indicates whether a variable stores a collection of values (`true`) or not (`false`).
dataType	Field Type ExpsSetDataType (enumeration of type string) Description Required. The data type of an expression set variable. Valid values are: `ActionOutput` `Boolean` `Currency` `Date` `DateTime` `DecisionMatrix` `DecisionTable` `Numeric` `Percent` `Sobject` `SubExpression` `Text`
decimalPlaces	Field Type int Description The decimal digits in the currency, number, or percent data type for an expression set variable.
description	Field Type string Description The description of the variable used in an expression set.
fields	Field Type ExpressionSetVariableField [] Description Represents an array of fields in an object that is used as a variable in an expression set.
input	Field Type boolean Description Indicates whether an expression set variable is used as an input (`true`) in an expression or not (`false`).
lookupName	Field Type string Description The API name of a decision matrix, a decision table, or a sub expression.
lookupType	Field Type ExpsSetVariableLookupType (enumeration of type string) Description The type of the lookup used in an expression set definition. Valid values are: `DecisionMatrix` `DecisionTable` `SubExpression`
name	Field Type string Description Required. The full name of the variable used in an expression set definition.
objectName	Field Type string Description The name of the sObject.
output	Field Type boolean Description Indicates whether an expression set variable is used as an output in an expression(`true`) or not (`false`).
resultStep	Field Type string Description The step that produces the expression set variable.
type	Field Type ExpsSetVariableType (enumeration of type string) Description Required. The type of variable in an expression set definition. Valid values are: `Constant` `Formula` `Variable`
value	Field Type string Description Represents a constant value or a formula. It stores the default value of a variable. Note

ExpressionSetVariableField

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

Field Name	Description
dataType	Field Type ExpsSetDataType (enumeration of type string) Description Required. Specifies the type of data stored in an expression set variable. Valid values are: `ActionOutput` `Boolean` `Currency` `Date` `DateTime` `DecisionMatrix` `DecisionTable` `Numeric` `Percent` `Sobject` `SubExpression` `Text`
decimalPlaces	Field Type int Description The decimal digits in the currency, number, or percent data type for an expression set variable.
fields	Field Type ExpressionSetVariableField [] Description Represents an array of fields in an object that is used as a variable in an expression set.
lookupName	Field Type string Description The API name of a decision matrix, a decision table, or a sub expression.
lookupType	Field Type ExpsSetVariableLookupType (enumeration of type string) Description Required. The type of lookup used in an expression set definition. Valid values are: `DecisionMatrix` `DecisionTable` `SubExpression`
name	Field Type string Description Required. The full name of the field used in an expression set variable.
objectName	Field Type string Description The name of the sObject.

Declarative Metadata Sample Definition

The following is an example of an ExpressionSetDefinition component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ExpressionSetDefinition
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<description />
5	<label>E1test</label>
6	<processType>TestProcess</processType>
7	<template>false</template>
8	<urls />
9	<versions>
10		<fullName>E1test_V1</fullName>
11		<description />
12		<endDate />
13		<expressionSetDefinition>E1test</expressionSetDefinition>
14		<label>E1test V1</label>
15		<shouldShowExplExternally>false</shouldShowExplExternally>
16		<startDate>2022-07-15T05:44:49.000+0000</startDate>
17		<status>Draft</status>
18		<steps>
19			<actionType>TestCustomElement</actionType>
20			<advancedCondition />
21			<aggregation />
22			<assignment />
23			<conditionExpression />
24			<customElement>
25				<parameters>
26					<input>true</input>
27					<name>Dividend</name>
28					<output>false</output>
29					<value>var2</value>
30					</parameters>
31				<parameters>
32					<input>true</input>
33					<name>Divisor</name>
34					<output>false</output>
35					<value>var3</value>
36				</parameters>
37				<parameters>
38					<input>false</input>
39					<name>Answer</name>
40					<output>true</output>
41					<value>var4</value>
42				</parameters>
43			</customElement>
44			<decisionTable />
45			<description />
46			<failedExplainerTemplate />
47			<label>Business Element</label>
48			<name>BusinessElement</name>
49			<parentStep />
50			<passedExplainerTemplate />
51			<resultIncluded>false</resultIncluded>
52			<sequenceNumber>2</sequenceNumber>
53			<shouldExposExecPathMsgOnly>true</shouldExposExecPathMsgOnly>
54			<shouldExposeConditionDetails>false</shouldExposeConditionDetails>
55			<shouldShowExplExternally>false</shouldShowExplExternally>
56			<stepType>BusinessKnowledgeModel</stepType>
57			<subExpression />
58		</steps>
59		<steps>
60			<actionType>AssignParameterValues</actionType>
61			<advancedCondition />
62			<aggregation />
63			<assignment>
64				<assignedParameter>var1</assignedParameter>
65				<expression>10</expression>
66			</assignment>
67			<conditionExpression />
68			<customElement />
69			<decisionTable />
70			<description />
71			<failedExplainerTemplate />
72			<label>Calculation</label>
73			<name>Calculation</name>
74			<parentStep />
75			<passedExplainerTemplate />
76			<resultIncluded>false</resultIncluded>
77			<sequenceNumber>1</sequenceNumber>
78			<shouldExposExecPathMsgOnly>true</shouldExposExecPathMsgOnly>
79			<shouldExposeConditionDetails>false</shouldExposeConditionDetails>
80			<shouldShowExplExternally>false</shouldShowExplExternally>
81			<stepType>BusinessKnowledgeModel</stepType>
82			<subExpression />
83		</steps>
84		<uiTier />
85		<urls />
86		<variables>
87			<collection>false</collection>
88			<dataType>Numeric</dataType>
89			<decimalPlaces>2</decimalPlaces>
90			<description>var1</description>
91			<fields />
92			<input>true</input>
93			<lookupName />
94			<lookupType />
95			<name>var2</name>
96			<objectName />
97			<output>false</output>
98			<resultStep />
99			<type>Variable</type>
100			<value />
101		</variables>
102		<variables>
103			<collection>false</collection>
104			<dataType>Numeric</dataType>
105			<decimalPlaces>2</decimalPlaces>
106			<description>var1</description>
107			<fields />
108			<input>false</input>
109			<lookupName />
110			<lookupType />
111			<name>var1</name>
112			<objectName />
113			<output>false</output>
114			<resultStep />
115			<type>Variable</type>
116			<value />
117		</variables>
118		<variables>
119			<collection>false</collection>
120			<dataType>Numeric</dataType>
121			<decimalPlaces>2</decimalPlaces>
122			<description>var1</description>
123			<fields />
124			<input>false</input>
125			<lookupName />
126			<lookupType />
127			<name>var4</name>
128			<objectName />
129			<output>false</output>
130			<resultStep />
131			<type>Variable</type>
132			<value />
133		</variables>
134		<variables>
135			<collection>false</collection>
136			<dataType>Numeric</dataType>
137			<decimalPlaces>2</decimalPlaces>
138			<description>var1</description>
139			<fields />
140			<input>true</input>
141			<lookupName />
142			<lookupType />
143			<name>var3</name>
144			<objectName />
145			<output>false</output>
146			<resultStep />
147			<type>Variable</type>
148			<value />
149		</variables>
150		<versionNumber>1</versionNumber>
151	</versions>
152</ExpressionSetDefinition>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Package
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<types>
5		<members>*</members>
6		<name>ExpressionSetDefinition</name>
7	</types>
8	<version>58.0</version>
9</Package>

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.

Metadata API Developer Guide