DecisionMatrixDefinition

Represents a definition of a decision matrix.

This type extends Metadata and inherits its fields.

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

Introduced in API version 55.0.

• Type: string
• Required: No
• Description: Describes a decision matrix definition.

• Type: string
• Required: No
• Description: A key for grouping matrix rows in different versions, such as a geographic region or a product code.

• 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: string
• Required: No
• 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: DecisionMatrixType (enumeration of type string)
• Required: No
• Description: The type of a decision matrix.

• Type: DecisionMatrixDefinitionVersion[]
• Required: No
• Description: Represents an array of decision matrix version definitions in a decision matrix. This array must contain at least one version.

Represents a definition of a decision matrix version.

This type extends Metadata and inherits its fields.

• Type: DecisionMatrixDefinitionVersionColumn[]
• Required: No
• Description: Represents an array of columns in a decision matrix definition version.

• Type: string
• Required: No
• Description: The full name of a decision matrix version.

• Type: dateTime
• Required: No
• Description: The date until which a decision matrix definition version is available for use.

• Type: string
• Required: No
• 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.

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

• Type: int
• Required: No
• Introduced: API version 64.0
• 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.

• Type: dateTime
• Required: Yes
• Description: Required.

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

• Type: string
• Required: No
• 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.

• Type: int
• Required: Yes
• Description: Required.

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

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

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

• Type: int
• Required: Yes
• Description: Required.

• Type: boolean
• Required: Yes
• Description: Required.

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

• Type: string
• Required: No
• Description: A list of values that define range boundaries.

• Type: string
• Required: No
• Description: The wildcard value such as ALL.

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>68.0</version>
9</Package>

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.