Skip Navigation

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

DecisionMatrixDefinition

Represents a definition of a decision matrix.

Before deploying a decision matrix or a decision matrix version to a target org, review these decision matrix migration considerations.

Note

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

File Suffix and Directory Location

DecisionMatrixDefinition components have the suffix .decisionMatrixDefinition and are stored in the decisionMatrixDefinition folder.

Version

DecisionMatrixDefinition components are available in API version 55.0 and later.

Fields

Field Name	Description
description	Field Type string Description Describes a decision matrix definition.
groupKey	Field Type string Description A key for grouping matrix rows in different versions, such as a geographic region or a product code.
label	Field Type string Description Required. The UI label of a decision matrix definition.
processType	Field Type ExpsSetProcessType (enumeration of type string) Description The process type that uses the expression set rule. Valid values are: `Bre` `GpaCalculation` `InsuranceClaimProcessing`—Available in API version 65.0 and later. `ItServiceManagement`—Available in API version 65.0 and later. `PlanCostCalculation` `RatingDiscovery` `StudentInformationSystem`—Available in API version 65.0 and later. `StudentSuccess` When Business Rules Engine is enabled for a Salesforce instance, the default value is '`Bre`’. Other usage types may be available to you depending on your industry solution and permission sets. Note Available in API version 59.0 and later.
subGroupKey	Field Type string Description A subgroup key for grouping matrix rows in different versions, such as a geographic region or a product code. For example, if the groupKey is `Country`, the subGroupKey can be `State` or `Province`.
type	Field Type DecisionMatrixType (enumeration of type string) Description The type of a decision matrix. Valid values are: `Grouped` `Standard`
versions	Field Type DecisionMatrixDefinitionVersion[] Description Represents an array of decision matrix version definitions in a decision matrix. This array must contain at least one version.

DecisionMatrixDefinitionVersion

Represents a definition of a decision matrix version.

Field Name	Description
columns	Field Type DecisionMatrixDefinitionVersionColumn[] Description Represents an array of columns in a decision matrix definition version.
decisionMatrixDefinition	Field Type string Description The full name of a decision matrix version.
endDate	Field Type dateTime Description The date until which a decision matrix definition version is available for use.
groupKeyValue	Field Type string Description The value of the groupKey for a decision matrix definition version. For example, if the groupKey is `Country`, the groupKeyValue can be `United States`.
label	Field Type string Description Required. The UI label of a decision matrix definition version.
rank	Field Type int Description The rank of the Decision Matrix Definition Version. When more than one enabled version matches a decision matrix call, and the start date time to end date time spans overlap, the version with the highest rank is chosen. Available in API version 64.0 and later.
startDate	Field Type dateTime Description Required. The date from when a decision matrix definition version is available for use.
status	Field Type DecisionMatrixDefStatus (enumeration of type string) Description Required. Specifies the status of a decision matrix definition version. Valid values are: `Active` `Draft` `Inactive` `InvalidDraft` `Obsolete`
subGroupKeyValue	Field Type string Description The value of the subgroup key for a decision matrix definition version. For example, if the subGroupKey is `State` or `Province`, the subGroupKeyValue can be `California`.
versionNumber	Field Type int Description Required. The version number of a decision matrix definition.

DecisionMatrixDefinitionVersionColumn

Represents a definition of a column in a decision matrix definition version.

Field Name	Description
columnType	Field Type DecisionMatrixColumnType (enumeration of type string) Description Required. Specifies whether a column is for an input or output. Valid values are: `Input` `Output`
dataType	Field Type DecisionMatrixDataType (enumeration of type string) Description Required. The type of data that’s stored in a column. Valid values are: `Boolean` `Currency` `Number` `NumberRange` `Percent` `Text` `TextRange`
displaySequence	Field Type int Description Required. Represents the position of a column in the column order.
isWildcardColumn	Field Type boolean Description Required. Specifies whether a column stores a wildcard value (`true`) or not (`false`). The default value is `false`.
name	Field Type string Description Required. The full name of a decision matrix definition version column.
rangeValue	Field Type string Description A list of values that define range boundaries.
wildcardValue	Field Type string Description The wildcard value such as `ALL`.

Declarative Metadata Sample Definition

The following is an example of a DecisionMatrixDefinition component.

1<?xml version="1.0" encoding="UTF-8"?>
2<DecisionMatrixDefinition
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<label>HealthCloudUM_ValidRegions</label>
5	<type>Standard</type>
6	<versions>
7		<fullName>HealthCloudUM_ValidRegions_V1</fullName>
8		<columns>
9			<columnType>Input</columnType>
10			<dataType>Text</dataType>
11			<displaySequence>2</displaySequence>
12			<isWildcardColumn>false</isWildcardColumn>
13			<name>State</name>
14		</columns>
15		<columns>
16			<columnType>Input</columnType>
17			<dataType>Text</dataType>
18			<displaySequence>1</displaySequence>
19			<isWildcardColumn>false</isWildcardColumn>
20			<name>City</name>
21		</columns>
22		<columns>
23			<columnType>Output</columnType>
24			<dataType>Boolean</dataType>
25			<displaySequence>3</displaySequence>
26			<isWildcardColumn>false</isWildcardColumn>
27			<name>IsValid</name>
28		</columns>
29		<decisionMatrixDefinition>HealthCloudUM_ValidRegions</decisionMatrixDefinition>
30		<label>HealthCloudUM_ValidRegions V1</label>
31		<startDate>2022-05-02T13:04:06.000Z</startDate>
32		<status>Draft</status>
33		<versionNumber>1</versionNumber>
34	</versions>
35</DecisionMatrixDefinition>

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>DecisionMatrixDefinition</name>
7	</types>
8	<version>67.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.