ExplainabilityActionVersion

Represents the explainability action version 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

ExplainabilityActionVersion components have the suffix .explainabilityActionVersion and are stored in the explainabilityActionVersion folder.

Version

ExplainabilityActionVersion components are available in API version 57.0 and later.

Fields

actionLogMessageTemplate

Field Type: string
Description: The custom message template that is registered by the application.

actionSpecification

Field Type: string
Description: Required. The explainability specification of the application’s action log that’s generated at runtime and stored as a JSON file.

active

Field Type: boolean
Description: Required. Indicates whether the explainability action version is active and can be used as a specification in the application’s action logs.

definitionVersion

Field Type: int
Description: Required. The version of the explainability action definition.

description

Field Type: string
Description: The description of the explainability action version record.

explainabilityActionDef

Field Type: string
Description: Required. The explainability definition of the explainability action log that’s generated by the associated application’s action.

masterLabel

Field Type: string
Description: Required. A user-friendly name for ExplainabilityActionVersion, which is defined when the ExplainabilityActionVersion is created.

Declarative Metadata Sample Definition

The following is an example of an ExplainabilityActionVersion component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ExplainabilityActionVersion
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<masterLabel>ActionVersion1</masterLabel>
5	<explainabilityActionDef>ActionDef</explainabilityActionDef>
6	<description>Version Description</description>
7	<actionSpecification>Test action specification</actionSpecification>
8	<active>false</active>
9	<actionLogMessageTemplate>Test template</actionLogMessageTemplate>
10	<definitionVersion>1</definitionVersion>
11</ExplainabilityActionVersion>

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	<types>
18		<members>*</members>
19		<name>ExplainabilityActionVersion</name>
20	</types>
21	<version>57.0</version>
22</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.