BotTemplate | Metadata API Developer Guide

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

BotTemplate components have the suffix .botTemplate and are stored in the botTemplates folder.

Version

BotTemplate components are available in API version 55.0 and later.

Special Access Rules

BotTemplate is available only if Chat and Einstein Bots are enabled in your org.

Fields

Field Name	Description
botDialogGroups	Field Type BotDialogGroup[] Description The list of dialog groups in this bot template.
botDialogs	Field Type BotDialog[] Description The list of dialogs in this bot template.
conversationLanguages	Field Type string Description Required. Specifies the language of the bot template.
contextVariables	Field Type ConversationContextVariable[] Description Represents the context variables that enable your bot to gather customer information regardless of channel.
conversationGoals	Field Type ConversationDefinitionGoal[] Description The list of goals in this bot template. Available in API version 57.0 and later.
conversationSystemDialogs	Field Type ConversationSystemDialog[] Description A system function assigned to a dialog.
conversationVariables	Field Type ConversationVariable[] Description A container that stores a specific piece of data collected from the customer. You can use variables within dialog actions as both inputs and outputs.
description	Field Type string Description A description of the bot template.
entryDialog	Field Type string Description A reference to the first dialog that the bot presents to your customer. For example, `Welcome`.
icon	Field Type string Description The icon used to identify the template.
mainMenuDialog	Field Type string Description A reference to the dialog identified as the main menu dialog. For example, `Main Menu`.
masterLabel	Field Type string Description Required. A user-friendly label for BotTemplate, which is defined when the BotTemplate is created.
mlDomain	Field Type LocalMlDomain Description Required. Represents the Einstein Intent Set that groups intents, entities, and variables associated with a template.
richContentEnabled	Field Type boolean Description Indicates whether the template is available for enhanced bots (`true`) or for standard bots (`false`). The default is `false`.

BotDialogGroup

The list of dialog groups in this bot template.

Field Name	Description
description	Field Type string Description A description of the bot dialog group.
developerName	Field Type string Description Required. This unique name prevents conflicts with other dialog groups associated with the same bot template. This name can contain only underscores and alphanumeric characters. The name must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
label	Field Type string Description Required. A label that identifies the dialog group throughout the Salesforce user interface.

BotDialog

The list of dialogs in this bot template.

Field Name	Description
botDialogGroup	Field Type string Description The bot dialog group that contains this bot dialog.
botSteps	Field Type BotStep[] Description A list of steps that are executed as part of the dialog.
description	Field Type string Description A description of the bot dialog.
developerName	Field Type string Description Required. This unique name prevents conflicts with other dialogs associated with the same bot template. This name can contain only underscores and alphanumeric characters. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
isPlaceholderDialog	Reserved for Future Use
label	Field Type string Description Required. A label that identifies the dialog throughout the Salesforce user interface.
mlIntent	Field Type string Description The name of the intent associated with a dialog.
mlIntentTrainingEnabled	Field Type boolean Description Indicates whether Einstein is turned on to train an intent model for the dialog intent (`true`) or turned off for the exact match option (`false`). The default value is `false`.
showInFooterMenu	Field Type boolean Description Indicates whether to show this dialog in the Bot Options menu. The default value is `false`.

BotStep

A step that is executed as part of the dialog.

Field Name	Description
booleanFilter	Field Type string Description This field is reserved for future use.
botInvocation	Field Type BotInvocation Description Bot Invocation used by a BotStep of type `Invocation`.
botMessages	Field Type BotMessage[] Description List of bot messages used by a BotStep of type `Message`.
botNavigation	Field Type BotNavigation Description Bot Navigation used by a BotStep of type `Navigation`.
botStepConditions	Field Type BotStepCondition[] Description List of BotStep conditions associated with a BotStep of type `Group`.
botSteps	Field Type BotStep[] Description List of BotSteps associated to a Bot Step of type `Group`.
botVariableOperation	Field Type BotVariableOperation Description Bot Variable Operation used by a BotStep of type `VariableOperation`.
conversationRecordLookup	Field Type ConversationRecordLookup Description A lookup action to the Conversation record.
conversationStepGoalMappings	Field Type ConversationDefinitionStepGoalMapping[] Description The API name of a goal used by a BotStep of type GoalStep. Available in API version 57.0 and later.
conversationSystemMessage	Field Type ConversationSystemMessage Description System messages that represent an action for a BotStep, such as transferring to an agent or ending a chat.
messageDefinition	Field Type ConversationDefinitionRichMessage Description List of configuration details used by a BotStep that references a messaging component.
stepIdentifier	Field Type string Description A unique key that identifies a step within a dialog. It is used to link translated labels to labels within the step. This field is recommended for all step records and is required for translated step labels. If a step is created via the UI, the stepIdentifier is automatically generated. If a step is created via API, the stepIdentifier must be provided. The stepIdentifier can contain letters, numbers, dashes, and underscores, up to 255 characters.
type	Field Type BotStepType (enumeration of type string) Description Required. Values are: `GoalStep`(Available in API version 57.0 and later.) `Group` `Invocation` `Message` `Navigation` `RecordLookup` `RichMessage` `SystemMessage` `VariableOperation` `Wait`

BotInvocation

Bot Invocation used by a BotStep of type Invocation.

Field Name	Description
invocationActionName	Field Type string Description The name of the invocable action used by a Bot Invocation.
invocationActionType	Field Type ConversationInvocableTargetType (enumeration of type string) Description Available dialog action types are: `apex` `externalService` `flow` `logFeedback` `logGoalAchieved` (Deprecated in API version 57.0.) `standardInvocableAction`
invocationMappings	Field Type BotInvocationMapping[] Description List of Bot Invocation Mappings for a Bot Invocation.

BotInvocationMapping

List of Bot Invocation Mappings for a Bot Invocation.

Field Name	Description
parameterName	Field Type string Description Required. Name of an Input/Output parameter of the parent Bot Invocation target.
recordName	Field Type string Description Name of the record that is used as part of an Invocation mapping.
type	Field Type BotInvocationMappingType (enumeration of type string) Description Required. Values are: `Input` `Output`
value	Field Type string Description Literal value to be assigned to the specified parameter.
variableName	Field Type string Description Name of the Bot Variable that is used as part of an Invocation mapping.
variableType	Field Type ConversationVariableType (enumeration of type string) Description This field relates to the type of variable used in this invocation mapping. Values are: `ContextVariable` `ConversationVariable`

BotMessage

A bot message used by a BotStep of type Message.

Field Name	Description
message	Field Type string Description Required. Message to display as part of an outgoing message from the bot to the customer.
messageIdentifier	Field Type string Description A unique key that identifies a message within a dialog. It is used to link translated labels to labels within the message. This field is recommended for all message records and is required for translated message labels. If a message is created via the UI, the messageIdentifier is automatically generated. If a message is created via API, the messageIdentifier must be provided. messageIdentifier can contain letters, numbers, dashes, and underscores, up to 255 characters.

Field Name

Description

message

Field Type: string
Description: Required.
Message to display as part of an outgoing message from the bot to the customer.

messageIdentifier

Field Type: string
Description: A unique key that identifies a message within a dialog. It is used to link translated labels to labels within the message. This field is recommended for all message records and is required for translated message labels.
If a message is created via the UI, the messageIdentifier is automatically generated. If a message is created via API, the messageIdentifier must be provided. messageIdentifier can contain letters, numbers, dashes, and underscores, up to 255 characters.

BotNavigation

Bot navigation used by a BotStep of type Navigation.

Field Name	Description
botNavigationLinks	Field Type BotNavigationLink[] Description List of Bot Navigation links associated with a Bot Navigation of type `Call` or `Redirect`.
type	Field Type BotNavigationType (enumeration of type string) Description Required. Values are: `Call` `Redirect` `TransferToAgent`

BotNavigationLink

List of Bot Navigation links associated with a Bot Navigation of type Call or Redirect.

Field Name	Description
label	Field Type string Description Label displayed when more than one Bot Navigation Link is available under a Bot Navigation of type `Redirect`. The target dialog label is used when no label is provided.
targetBotDialog	Field Type string Description Name of the target dialog to be called as part of this Bot Navigation Link.
targetVariable	Field Type string Description In the Redirect to Dialog Rule Action, the ID of the target object variable to be called as part of this Bot Navigation link. Available in API version 57.0 and later.
targetVariableType	Field Type ConversationVariableType (enumeration of type string) Description In the Redirect to Dialog Rule Action, the type of variable referred to in targetVariable. Available in API version 57.0 and later. Values are: `ContextVariable` `ConversationVariable`

BotStepCondition

List of BotStep conditions associated with a BotStep of type Group.

Field Name	Description
leftOperandName	Field Type string Description Required. Name of the variable used as the left side of the condition operation.
leftOperandType	Field Type ConversationVariableType (enumeration of type string) Description Required. Type of the variable used as the left side of the condition operation. Values are: `ContextVariable` `ConversationVariable`
operatorType	Field Type BotStepConditionOperatorType (enumeration of type string) Description Required. Values are: `Equals` `GreaterThan` `GreaterThanOrEqualTo` `IsNotSet` `IsSet` `LessThan` `LessThanOrEqualTo` `NotEquals`
rightOperandValue	Field Type string Description Value that is used as the right side of the condition operation. This value is ignored when using `IsSet` and `IsNotSet` operators.

BotVariableOperation

Bot variable operation used by a BotStep of type VariableOperation.

Field Name	Description
askCollectIfSet	Field Type boolean Description If `true`, the bot runs a Bot Variable Operation of type `Collect` regardless of whether the variable already has a value. When a value exists for a variable, the bot asks the user for the relevant information, and the bot overwrites the existing value with the user-provided value. If `false`, the bot skips variables with an existing value and maintains the existing value. The default is `false`.
autoSelectIfSingleChoice	Field Type boolean Description If `true`, the bot automatically selects the answer in the conversation flow when only one button choice is available in a Bot Variable Operation of type `Collect` and a quickReplyType value of `Dynamic`. If `false`, the bot presents the single button choice and waits for the user’s response. The default is `false`.
botInvocation	Field Type BotInvocation Description Bot Invocation used to provide Dynamic choices by a Bot Variable Operation of type `Collect` and quickReplyType of `Dynamic`.
botMessages	Field Type BotMessage[] Description List of Bot Messages used as prompt messages by a Bot Variable Operation of type `Collect`.
botQuickReplyOptions	Field Type BotQuickReplyOption[] Description List of static choice options used by a Bot Variable Operation of type `Collect` and quickReplyType of `Static`.
botVariableOperands	Field Type BotVariableOperand[] Description List of Bot Variable Operands associated with a Bot Variable of type `Set` or `Unset`.
invalidInputBotNavigation	Field Type BotNavigation Description Bot Navigation used by a Bot Variable Operation of type `Collect`. This navigation is executed when the associated Bot Invocation doesn’t return any options.
optionalCollect	Field Type boolean Description If `true`, the bot asks the repair attempts once and then moves on to the next dialog step. The default value is `false`.
quickReplyOptionTemplate	Field Type string Description Formula template used to resolve a label for Dynamic choice options of type `Object`.
quickReplyType	Field Type BotQuickReplyType (enumeration of type string) Description Values are: `Dynamic` `Static`
quickReplyWidgetType	Field Type BotWidgetType (enumeration of type string) Description Values are: `Buttons` `Menu`
retryMessages	Field Type BotMessage[] Description In Conversation Repair, the messages assigned to repair attempts.
sourceVariableName	Field Type string Description Name of the source VariableName used in the variable operation.
sourceVariableType	Field Type ConversationVariableType (enumeration of type string) Description This name defines the data type of VariableName used in the variable operation. Values are: `ContextVariable` `ConversationVariable`
successMessages	Field Type BotMessage[] Description In a File dialog step, the message displayed to the customer as part of type `CollectAttachment` to confirm a successful file upload. Available in API version 57.0 and later.
type	Field Type BotVariableOperationType (enumeration of type string) Description Required. Values are: `Collect` `CollectAttachment` (Available in API version 57.0 and later.) `Set` `SetConversationLanguage` `Unset`
variableOperationIdentifier	Field Type string Description A unique key that identifies a variable operation within a dialog. It is used to link translated labels to labels within the variable operation. This field is recommended for all variable operation records and is required for translated variable operation labels. If a variable operation is created via the UI, the variableOperationIdentifier is automatically generated. If a variable operation is created via API, the variableOperationIdentifier must be provided. variableOperationIdentifier can contain letters, numbers, dashes, and underscores, up to 255 characters.

BotQuickReplyOption

List of static choice options used by a bot variable operation of type Collect and quickReplyType of Static.

Field Name	Description
literalValue	Field Type string Description Required. Value to be displayed as a menu or button choice to your customer.
quickReplyOptionIdentifier	Field Type string Description A unique key that identifies a quick reply option within a dialog. It is used to link translated labels to labels within the quick reply option. This field is recommended for all quick reply option records and is required for translated quick reply option labels. If a quick reply option is created via the UI, the quickReplyOptionIdentifier is automatically generated. If a message is created via API, the quickReplyOptionIdentifier must be provided. quickReplyOptionIdentifier can contain letters, numbers, dashes, and underscores, up to 255 characters.

Field Name

Description

literalValue

Field Type: string
Description: Required.
Value to be displayed as a menu or button choice to your customer.

quickReplyOptionIdentifier

Field Type: string
Description: A unique key that identifies a quick reply option within a dialog. It is used to link translated labels to labels within the quick reply option. This field is recommended for all quick reply option records and is required for translated quick reply option labels.
If a quick reply option is created via the UI, the quickReplyOptionIdentifier is automatically generated. If a message is created via API, the quickReplyOptionIdentifier must be provided. quickReplyOptionIdentifier can contain letters, numbers, dashes, and underscores, up to 255 characters.

BotVariableOperand

List of bot variable operands associated with a bot variable of type Set or Unset.

Field Name	Description
disableAutoFill	Field Type boolean Description Disables auto-fill behavior for a bot variable under a bot variable operation of type `Collect`.
sourceName	Field Type string Description Name of the source CustomField or MlSlotClass used in the variable operation.
sourceType	Field Type ConversationVariableOperandSourceType (enumeration of type string) Description Values are: `BotDefinition` `ContextVariable` `ConversationVariable` `FlowDefinition` `MlSlotClass` `Queue` `StandardConversationVariable` `StandardMlSlotClass` `Value`
sourceValue	Field Type string Description Literal value used as the source for this variable operation.
targetName	Field Type string Description Required. Name of the target variable used in the variable operation.
targetType	Field Type ConversationVariableType (enumeration of type string) Description Required. Type of the target used in the variable operation. Values are: `ContextVariable` `ConversationVariable`

ConversationRecordLookup

Information related to the linked conversation. Currently only works on Lightning Knowledge.

Field Name	Description
SObjectType	Field Type string Description Required. Specifies the SObjectType of the ID stored in a bot variable.
conditions	Field Type ConversationRecordLookupCondition[] Description The conditions associated with this lookup.
filterLogic	Field Type string Description The logical operator that connects the conditions. Values are: `And` `Or`
lookupFields	Field Type ConversationRecordLookupField[] Description Definition of the fields that are used for this lookup.
maxLookupResults	Field Type int Description Required. The maximum number of records to return (1-3).
sortFieldName	Field Type string Description The name of the field used to sort the lookup results.
sortOrder	Field Type SortOrder (enumeration of type string) Description The display order of the lookup results. Values are: `Asc` `Desc`
sourceVariableName	Field Type string Description The input for this lookup operation.
sourceVariableType	Field Type ConversationVariableType (enumeration of type string) Description Type of the target used in the variable operation. Values are: `ContextVariable` `ConversationVariable`
targetVariableName	Field Type string Description Required. The variable that holds the results of this lookup.

ConversationRecordLookupCondition

List of conditions associated with a ConversationRecordLookup.

Field Name	Description
leftOperand	Field Type string Description Required. Field on which the condition operation takes place.
operatorType	Field Type string Description Required. The operator applied to the leftOperand. Values are: `Equals` `NotEquals` `IsSet` `IsNotSet` `GreaterThan` `LessThan` `GreaterThanOrEqualTo` `LessThanOrEqualTo`
rightOperandName	Field Type string Description The name of the variable to compare against.
rightOperandType	Field Type ConversationVariableType (enumeration of type string) Description The type of the variable to compare against. Values are: `ContextVariable` `ConversationVariable`
rightOperandValue	Field Type string Description The custom value to compare against. This value is ignored when using `IsSet` and `IsNotSet` operators.
sortOrder	Field Type int Description Required. Order in which the conditions are applied.

ConversationRecordLookupField

The fields used in a conversation record lookup.

Field Name	Description
fieldName	Field Type string Description Required. Defines the field names used in the Conversation Lookup function.

ConversationDefinitionStepGoalMapping

Represents the association between a goal and a BotStep. A goal can be associated with only one BotStep and one dialog at a time. Available in API version 57.0 and later.

Field Name	Description
goalName	Field Type string Description The API name of the goal.

ConversationSystemMessage

System messages that represent an action for a Bot Step, such as transferring to an agent or ending a chat.

Field Name	Description
systemMessageMappings	Field Type ConversationSystemMessageMapping[] Description Defines the type of system message to be sent.
type	Field Type ConversationSystemMessageType (enumeration of type string) Description Required. This field defines the values available for a system message. Values are: `EndChat` `Transfer`

ConversationSystemMessageMapping

List of mappings that indicate additional information provided for the system message.

Field Name	Description
mappingType	Field Type ConversationMappingType (enumeration of type string) Description Required. Defines the type of mapping used in the record. Values are: `Input` `Output`
parameterType	Field Type ConversationSystemMessageParamType (enumeration of type string) Description Required. Defines the type of parameter the value is mapped to. Values are: `Transfer`
variableName	Field Type string Description Required. Name of the variable that contains the value passed to the system message.

ConversationDefinitionRichMessage

Represents the configuration details for referencing a messaging component, such as an enhanced link.

Field Name	Description
messageDefinitionMappings	Field Type BotInvocationMapping[] Description List of mappings for referencing a messaging component. Includes any input parameters and their values. Optionally, specifies the conversation variable for storing any outputs. Input parameter values can be either static values or references to conversation or context variables.
messageDefinitionName	Field Type string Description Required. The API name of the messaging component referenced by the bot.

ConversationContextVariable

A context variable local to the current bot.

Field Name	Description
SObjectType	Field Type string Description Valid values are: `BotDefinition` `Queue`
contextVariableMappings	Field Type ConversationContextVariableMapping[] Description Represents the mapping between a context variable, channel type, and sObject field.
dataType	Field Type ConversationDataType (enumeration of type string) Description Required. Reprsents the data type of the context variable. Values are: `Boolean` `Currency` `Date` `DateTime` `Id` `Number` `Object` `Text`
developerName	Field Type string Description Required. Represents the name of the context variable. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
label	Field Type string Description Required. A label that identifies the context variable throughout the Salesforce user interface.

ConversationContextVariableMapping

Represents the mapping between a context variable, channel type, and sObject field.

Field Name	Description
SObjectType	Field Type string Description Required. SObject type for the field property defined as part of the mapping. Values are: `LiveChatTranscript` `MessagingEndUser` `MessagingSession`
fieldName	Field Type string Description Required. The API name of an SObject field to be used as part of the mapping.
messageType	Field Type MessageType (enumeration of type string) Description Required. Represents the channel, either SMS messaging or Chat. Values are: `Alexa` `AppleBusinessChat` `EmbeddedMessaging` `Facebook` `GoogleHome` `Line` `Omega` `Phone` `Text` `Voice` `WeChat` `WebChat` `WhatsApp`

ConversationDefinitionGoal

A goal included in the bot template. Available in API version 57.0 and later.

Field Name	Description
developerName	Field Type string Description Required. A unique name that prevents conflicts with other goals associated with the same bot template. This name can contain only underscores and alphanumeric characters. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
label	Field Type string Description Required. A label that identifies the goal throughout the Salesforce user interface. This label can contain only underscores and alphanumeric characters. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

ConversationSystemDialog

A system function assigned to a dialog.

Field Name	Description
dialog	Field Type string Description Required. The dialog name triggered when this system event fires.
type	Field Type ConversationSystemDialogType (enumeration of type string) Description Required. The type of system event. Values are: `Disambiguation` (Reserved for Future Use) `DisambiguationFailed` (Reserved for Future Use) `ErrorHandling` `KnowledgeFallback` `TransferFailed`

ConversationVariable

A container that stores a specific piece of data collected from the customer. You can use variables within dialog actions as both inputs and outputs.

Field Name	Description
SObjectType	Field Type string Description Specifies the SObjectType of the ID stored in a bot variable. Values are: `BotDefinition` `Queue`
collectionType	Field Type ConversationVariableCollectionType (enumeration of type string) Description This field defines whether a variable is designated as a List Variable. Values are: `List`
dataType	Field Type ConversationDataType (enumeration of type string) Description Required. Values are: `Boolean` `Currency` `Date` `DateTime` `Id` `Number` `Object` `Text`
developerName	Field Type string Description Required. This name can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
label	Field Type string Description Required. Label that identifies a variable throughout the Salesforce user interface.

LocalMlDomain

An Einstein Intent Set local to the current bot template.

Field Name	Description
label	Field Type string Description Required. Label that represents an Einstein Intent Set local to the current bot template throughout the Salesforce user interface.
mlIntents	Field Type MlIntent[] Description List of intents associated with this local intent set.
mlSlotClasses	Field Type MlSlotClass[] Description List of entities associated with this local intent set.
name	Field Type string Description Required. This unique name prevents conflicts with other local Einstein Intent Sets. This name can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.

MlIntent

An intent in an Einstein Intent Set.

Field Name	Description
description	Field Type string Description Einstein Intent Set description.
developerName	Field Type string Description Required. This unique name prevents conflicts with other Einstein Intent Sets associated with the same bot template. This name can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
label	Field Type string Description Required. Einstein Intent Set name.
mlIntentUtterances	Field Type MlIntentUtterance[] Description List of customer inputs for this intent.
relatedMlIntents	Field Type MlRelatedIntent[] Description List of intents within an Einstein Intent Set used to expand customer inputs for this intent. Only intents within local Einstein Intent Sets have related intents.

MlIntentUtterance

A customer input for this intent.

Field Name	Description
language	Field Type Language (enumeration of type string) Description The language of the MlIntentUtterance.
utterance	Field Type string Description Required. A customer input or natural language query that triggers the parent intent and prompts the bot to run the dialog associated with this intent.

MlRelatedIntent

An intent in an Einstein Intent Set used to expand customer inputs for this intent. Only intents within local Einstein Intent Sets have related intents.

Field Name	Description
relatedMlIntent	Field Type string Description Required. Name of the intent that is used to extend the customer inputs of the current parent intent.

MlSlotClass

An entity in this Einstein Intent Set.

Field Name	Description
dataType	Field Type MlSlotClassDataType (enumeration of type string) Description Required. A list of the data types available for the MISlotClass. Values are: `Boolean` `Currency` `Date` `DateTime` `Number` `Text`
description	Field Type string Description A description of an Einstein Bot entity.
developerName	Field Type string Description Required. This unique name prevents conflicts with other entities in an Einstein Intent Set. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
extractionRegex	Field Type string Description Regular expression used to extract an entity when the type is set to `Pattern`.
extractionType	Field Type MlSlotClassExtractionType (enumeration of type string) Description Values are: `Pattern` `Value`
label	Field Type string Description Required. Label that identifies an entity throughout the Salesforce user interface.
mlSlotClassValues	Field Type MlSlotClassValue[] Description List of entity values associated with an entity of type `Value`.

MlSlotClassValue

An entity value associated with an entity of type Value.

Field Name	Description
synonymGroup	Field Type SynonymGroup[] Description Represents a list of terms or synonyms for the current entity value.
value	Field Type string Description Required. Single value used to extract an entity of type `Value`.

SynonymGroup

Represents a group of synonymous words or phrases.

Field Name	Description
languages	Field Type Language[] (enumeration of type string) Description Specifies the languages the value list applies to. If value list items are specific to a single language, specify only that language. If the value list items apply to multiple languages, specify multiple languages for one value list.
terms	Field Type string[] Description A word or phrase synonymous with other terms in the value list.

Declarative Metadata Sample Definition

The following is an example of a BotTemplate component.

1<?xml version="1.0" encoding="UTF-8"?>
2<BotTemplate xmlns="http://soap.sforce.com/2006/04/metadata">
3    <botDialogGroups>
4        <developerName>dialog_group1</developerName>
5        <label>dialog group1</label>
6    </botDialogGroups>
7    <botDialogs>
8        <developerName>Test_Dialog_1</developerName>
9        <label>Test_Dialog_1</label>
10        <showInFooterMenu>false</showInFooterMenu>
11    </botDialogs>
12    <botDialogs>
13        <developerName>Test_Dialog_2</developerName>
14        <label>Test_Dialog_2</label>
15        <showInFooterMenu>false</showInFooterMenu>
16    </botDialogs>
17    <botDialogs>
18        <botSteps>
19            <botMessages>
20                <message>Hi! I&apos;m your helpful bot.</message>
21                <messageIdentifier>m1</messageIdentifier>
22            </botMessages>
23            <stepIdentifier>s1</stepIdentifier>
24            <type>Message</type>
25        </botSteps>
26        <botSteps>
27           <conversationRecordLookup>
28               <SObjectType>Account</SObjectType>
29               <conditions>
30                   <leftOperand>Account.Phone</leftOperand>
31                   <operatorType>Equal</operatorType>
32                   <rightOperandValue>Value</rightOperandValue>
33                   <sortOrder>0</sortOrder>
34               </conditions>
35               <lookupFields>
36                   <fieldName>Account.Phone</fieldName>
37               </lookupFields>
38               <lookupFields>
39                   <fieldName>Account.OwnerId</fieldName>
40               </lookupFields>
41               <maxLookupResults>1</maxLookupResults>
42               <sourceVariableName>_LastCustomerInput</sourceVariableName>
43               <sourceVariableType>ConversationVariable</sourceVariableType>
44               <targetVariableName>MyCustomVariable</targetVariableName>
45           </conversationRecordLookup>
46           <stepIdentifier>s2</stepIdentifier>
47           <type>RecordLookup</type>
48        </botSteps>
49        <botSteps>
50            <botNavigation>
51                <botNavigationLinks>
52                    <targetBotDialog>Main_Menu</targetBotDialog>
53                </botNavigationLinks>
54                <type>Redirect</type>
55            </botNavigation>
56            <stepIdentifier>s3</stepIdentifier>
57            <type>Navigation</type>
58        </botSteps>
59        <developerName>Welcome</developerName>
60        <label>Welcome</label>
61        <mlIntent>Welcome</mlIntent>
62        <showInFooterMenu>false</showInFooterMenu>
63    </botDialogs>
64    <botDialogs>
65        <botSteps>
66            <stepIdentifier>s4</stepIdentifier>
67            <type>Wait</type>
68        </botSteps>
69        <developerName>Main_Menu</developerName>
70        <label>Main Menu</label>
71        <mlIntent>Main_Menu</mlIntent>
72        <showInFooterMenu>false</showInFooterMenu>
73    </botDialogs>
74    <botDialogs>
75        <botSteps>
76            <botMessages>
77                <message>Goodbye! Click the &quot;End Chat&quot; button to end this chat</message>
78                <messageIdentifier>m2</messageIdentifier>
79            </botMessages>
80            <stepIdentifier>s6</stepIdentifier>
81            <type>Message</type>
82        </botSteps>
83        <botSteps>
84            <stepIdentifier>s7</stepIdentifier>
85            <type>Wait</type>
86        </botSteps>
87        <developerName>End_Chat</developerName>
88        <label>End Chat</label>
89        <mlIntent>End_Chat</mlIntent>
90        <showInFooterMenu>false</showInFooterMenu>
91    </botDialogs>
92    <botDialogs>
93        <botSteps>
94            <botMessages>
95                <message>Unfortunately, there are no agents available at the moment</message>
96                <messageIdentifier>m3</messageIdentifier>
97            </botMessages>
98            <stepIdentifier>s8</stepIdentifier>
99            <type>Message</type>
100        </botSteps>
101        <botSteps>
102            <stepIdentifier>s9</stepIdentifier>
103            <type>Wait</type>
104        </botSteps>
105        <developerName>No_Agent_Available</developerName>
106        <label>No Agent</label>
107        <showInFooterMenu>false</showInFooterMenu>
108    </botDialogs>
109    <contextVariables>
110        <contextVariableMappings>
111            <SObjectType>LiveChatTranscript</SObjectType>
112            <fieldName>LiveChatTranscript.ChatKey</fieldName>
113            <messageType>WebChat</messageType>
114        </contextVariableMappings>
115        <dataType>Text</dataType>
116        <developerName>ChatKey</developerName>
117        <label>Chat Key</label>
118    </contextVariables>
119    <conversationLanguages>en_US</conversationLanguages>
120    <conversationSystemDialogs>
121        <dialog>No_Agent_Available</dialog>
122        <type>TransferFailed</type>
123    </conversationSystemDialogs>
124    <conversationSystemDialogs>
125        <dialog>Test_Dialog_1</dialog>
126        <type>ErrorHandling</type>
127    </conversationSystemDialogs>
128    <conversationVariables>
129        <dataType>Text</dataType>
130        <developerName>TestVariableXYZ</developerName>
131        <label>TestVariableXYZ</label>
132    </conversationVariables>
133    <conversationVariables>
134        <collectionType>List</collectionType>
135        <dataType>Object</dataType>
136        <developerName>MyCustomVariable</developerName>
137        <label>MyCustomVariable</label>
138    </conversationVariables>
139    <description>Description of BotTemplate</description>
140    <entryDialog>Test_Dialog_1</entryDialog>
141    <icon>AA8qwqXXXXX</icon>
142    <mainMenuDialog>Test_Dialog_2</mainMenuDialog>
143    <masterLabel>Astro Bot</masterLabel>
144    <mlDomain>
145        <label>Astro Bot</label>
146        <mlIntents>
147            <developerName>End_Chat</developerName>
148            <label>End Chat</label>
149            <mlIntentUtterances>
150                <utterance>Utterance1</utterance>
151                <language>es</language>
152            </mlIntentUtterances>
153            <mlIntentUtterances>
154                <utterance>Utterance2</utterance>
155                <language>es</language>
156            </mlIntentUtterances>
157            <mlIntentUtterances>
158                <utterance>Utterance3</utterance>
159                <language>es</language>
160            </mlIntentUtterances>
161        </mlIntents>
162        <mlIntents>
163            <developerName>Main_Menu</developerName>
164            <label>Main Menu</label>
165            <description>Main Menu Intent</description>
166        </mlIntents>
167        <mlIntents>
168            <developerName>Welcome</developerName>
169            <label>Welcome</label>
170            <description>Welcome Intent</description>
171        </mlIntents>
172        <name>Astro_Bot_ld1</name>
173    </mlDomain>
174    <richContentEnabled>true</richContentEnabled>
175</BotTemplate>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>BotTemplate</name>
6    </types>
7    <version>55.0</version>
8</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.