Newer Version Available

This content describes an older version of this product. View Latest

ExplainabilityMsgTemplate

Represents the template that contains the decision explanation message for a specified element type. This object is available in API version 56.0 and later.

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), search(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Fields

Field Details
DeveloperName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The developer name of the explainability message template.
ExpressionSetStepType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
The step type in an expression set that uses the explainability message template. This is a required field.
Possible values are:
  • Aggregation
  • Branch
  • BusinessKnowledgeModel—Business Knowledge Model
  • Calculation
  • Condition
  • DecisionTableLookup—Decision Table Lookup
  • DefaultLane—Default Lane
  • GroupMatrixLookup—Group Matrix Lookup
  • MatrixLookup—Matrix Lookup
  • ReferenceProcedure—Sub Expression
The default value is Calculation.
IsDefault
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the explainability message template for a specified step type is default (true) or not (false).
The default value is false.
Language
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The language in which the message in the explainability message template is created.
Possible values are:
  • da—Danish
  • de—German
  • en_US—English
  • es—Spanish
  • es_MX—Spanish (Mexico)
  • fi—Finnish
  • fr—French
  • it—Italian
  • ja—Japanese
  • ko—Korean
  • nl_NL—Dutch
  • no—Norwegian
  • pt_BR—Portuguese (Brazil)
  • ru—Russian
  • sv—Swedish
  • th—Thai
  • zh_CN—Chinese (Simplified)
  • zh_TW—Chinese (Traditional)
MasterLabel
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The label of the explainability message template.
Message
Type
textarea
Properties
Create, Filter, Sort, Update
Description
The message associated with the template for a specific expression set step type. This is a required field.
ResultType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
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. This is a required field.
Possible values are:
  • Failed
  • Passed
The default value is Passed.