Newer Version Available

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

ExplainabilityActionDefinition

Represents the definition of the explainability action log that is generated by the associated application's action.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

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

File Suffix and Directory Location

ExplainabilityActionDefinition components have the suffix .explainabilityActionDefinition and are stored in the explainabilityActionDefinition folder.

Version

ExplainabilityActionDefinition components are available in API version 57.0 and later.

Fields

Field Name Description
actionLogSchemaType
Field Type
ActionLogSchemaType (enumeration of type string)
Description

Required.

The action log schema type of the application.

Possible values are:

  • ExpressionSet
  • Other
applicationSubtype
Field Type
string
Description

Required.

The subtype of the associated application for which the explainability log is generated.
applicationType
Field Type
EASAppType (enumeration of type string)
Description

Required.

The type of the application for which the explainability log is generated.

Possible values are:

  • ActionableEventOrch (Available in API version 61.0 and later.)
  • HealthCloud
  • IndustriesDroOrderProcess (Available in API version 61.0 and later.)
  • IndustryServiceExcellence
  • Loyalty
  • OmniAnalytics (Available in API version 61.0 and later.)
  • PublicSector
description
Field Type
string
Description
The description of the explainability action definition record.
internal
Field Type
boolean
Description

Required.

Indicates whether the explainability action definition record is created internally by the Salesforce platform (true) or not (false).

The default value is false.

masterLabel
Field Type
string
Description

Required.

A user-friendly name for ExplainabilityActionDefinition, which is defined when the ExplainabilityActionDefinition is created.
processType
Field Type
string
Description

Required.

The process type of the explainability action definition.

Declarative Metadata Sample Definition

The following is an example of an ExplainabilityActionDefinition component.

1<?xml version="1.0" encoding="UTF-8"?>
2
3<ExplainabilityActionDefinition
4	xmlns="http://soap.sforce.com/2006/04/metadata">
5	<masterLabel>ActionDefinition1</masterLabel>
6	<description>Action Definition 1</description>
7	<applicationType>PublicSector</applicationType>
8	<applicationSubtype>testType</applicationSubtype>
9	<processType>testType</processType>
10	<actionLogSchemaType>ExpressionSet</actionLogSchemaType>
11	<internal>true</internal>
12</ExplainabilityActionDefinition>
The following is an example package.xml that references the previous definition.
1<?xml version="1.0" encoding="UTF-8"?>
2
3<Package
4	xmlns="http://soap.sforce.com/2006/04/metadata">
5	<types>
6		<members>*</members>
7		<name>ApplicationSubtypeDefinition</name>
8	</types>
9	<types>
10		<members>*</members>
11		<name>BusinessProcessTypeDefinition</name>
12	</types>
13	<types>
14		<members>*</members>
15		<name>ExplainabilityActionDefinition</name>
16	</types>
17	<version>57.0</version>
18</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.