Metadata API Developer Guide
jNewer Version Available
RecordActionDeployment
Represents a deployment that contains settings
for a Guided Action List. Each deployment specifies channel defaults and actions that users
can add at runtime. This type extends the Metadata
metadata type and inherits its fullName field.
File Suffix and Directory Location
RecordActionDeployment values are stored in the developer_name.deployment file in the recordActionDeployments directory.
Version
RecordActionDeployment is available in API version 45.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| channelConfigurations | RecordActionDeploymentChannel | Specifies configuration settings for different channels in a Guided Action list deployment. |
| masterLabel | string | Required. Specifies the name of the deployment. |
| selectableItems | RecordActionSelectableItem | Specifies the actions available for users to add to a Guided Action List at runtime. |
RecordActionDeploymentChannel
Specifies channel defaults for a Guided Action List component. The component displays channel defaults when the list is otherwise empty.
| Field Name | Field Type | Description |
|---|---|---|
| channel | ChannelSource (enumeration of type string) | Required. Specifies the channel. Valid values are Phone, Chat, or Other. |
| channelItems | RecordActionDefaultItem | Specifies default actions for a channel and attributes for each action, such as whether the action is pinned to the list top or bottom, or whether an action is considered mandatory. |
| isAutopopEnabled | boolean | Specifies whether the first guided action in the list is launched when the record page opens. If true, the first action is launched. The default value is false. |
RecordActionDefaultItem
Represents actions and attributes specified as channel defaults in a deployment.
| Field Name | Field Type | Description |
|---|---|---|
| action | string | Required. Specifies the API name of an action. For example, the API name of a flow, such as Verify_Information. |
| isMandatory | boolean | Specifies whether the action is marked as mandatory. The default value is false. |
| isUiRemoveHidden | boolean | Specifies whether the ability to remove the guided action is hidden in the UI. The default value is false. If true, the UI hides the ability to remove the action. |
| position | int | Required. Indicates the order of the guided action among all actions associated with this record. |
| pinned | PinnedAction (enumeration of type string) | Required. Indicates whether the action is pinned to a region. Valid values are Top, Bottom, or None. The default value is None (unpinned). |
| type | RecordActionType (enumeration of type string) | Required. The type of guided action that's associated with the record. The only supported value and the default is Flow. |
RecordActionSelectableItem
Specifies channel defaults for a Guided Action List component. The component displays channel defaults only when the list is otherwise empty.
| Field Name | Field Type | Description |
|---|---|---|
| action | string | Required. Specifies the API name of an action. For example, the API name of a flow, such as Verify_Information. |
| type | RecordActionType (enumeration of type string) | Required. The type of guided action that's associated with the record. The only supported value and the default is Flow. |