ExplainabilityMsgTemplate

Represents information about the template that contains the decision explanation message for a specified expression set step type.

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

ExplainabilityMsgTemplate components have the suffix .explainabilityMsgTemplate and are stored in the ExplainabilityMsgTemplates folder.

Version 

Introduced in API version 56.0.

Fields 

evaluationResult 

  • Type: EvaluationResult (enumeration of type string)

  • Required: Yes

  • Description: Required.

    The type of result for which the message template can be used. The step type for which the result is evaluated can be a condition, conditional group, or branch.

  • Possible values:

    • Failed
    • Passed
    • NoResult

expressionSetStepType 

  • Type: ExpressionSetStepType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    The step type in an expression set that uses the explainability message template.

  • Possible values:

    • Aggregation
    • Branch
    • BusinessElement
    • Calculation
    • Condition
    • DecisionTableLookup
    • ListEnabledGroup
    • ListFilter
    • MatrixLookup
    • ReferenceProcedure

expsSetProcessType 

  • Type: ExpsSetProcessType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    The type of industry that’s using the expression set.

  • Possible values:

    • 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

isDefault 

  • Type: boolean
  • Required: No
  • Description: Indicates whether the decision explainer template for a specified step type is default (true) or not (false).

masterLabel 

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

message 

  • Type: string

  • Required: Yes

  • Description: Required.

    The message associated with the template for a specific expression set step type.

Declarative Metadata Sample Definition 

The following is an example of an ExplainabilityMsgTemplate component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ExplainabilityMsgTemplate
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<evaluationResult>Passed</evaluationResult>
5	<expressionSetStepType>Condition</expressionSetStepType>
6	<expsSetProcessType>ProductQualification</expsSetProcessType>
7	<isDefault>false</isDefault>
8	<masterLabel>ML EMT testDM</masterLabel>
9	<message>EMT Testing</message>
10</ExplainabilityMsgTemplate>

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>ExplainabilityMsgTemplate</name>
7	</types>
8	<version>68.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.