---
schema_version: "1"
id: b046490bcb2c7ed9c8420f77b973e62db6a09662ae70f3dc908a2d2ff1d16f78
title: RecordActionDeployment
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_recordactiondeployment.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recordactiondeployment.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 8bbd6cd0899ed6d03054ea5b7792534b24eafdd6ecb38c1ca75fe0cea657ce94
description: Represents configuration settings for the Actions & Recommendations, Action Launcher, and Bulk Action Panel components. For example, you can have a deployment that specifies which types of actions to display, default actions for channels, and the actions that users can add at runtime. If the component shows Next Best Action recommendations, the deployment configures which strategies to use and how recommendations appear. This type extends the Metadata metadata type and inherits its fullName field.
---
# RecordActionDeployment

Represents configuration settings for the Actions & Recommendations, Action Launcher, and Bulk Action Panel components. For example, you can have a deployment that specifies which types of actions to display, default actions for channels, and the actions that users can add at runtime. If the component shows Next Best Action recommendations, the deployment configures which strategies to use and how recommendations appear. This type extends the Metadata metadata type and inherits its fullName field.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

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.

## File Suffix and Directory Location

RecordActionDeployment values are stored in the developer\_name.deployment file in the recordActionDeployments directory.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

We don’t recommend programmatically changing the API name of a RecordActionDeployment.

## Version

RecordActionDeployment is available in API version 45.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d797855e98">Field Name</th>

              <th class="featureTableHeader  " id="d797855e101">Field Type</th>

              <th class="featureTableHeader  " id="d797855e104">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">channelConfigurations</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type"><a class="xref" href="#recordActionDeploymentChannel">RecordActionDeploymentChannel</a></td>

              <td class="entry" headers="d797855e104" data-title="Description">Specifies configuration settings for different channels in an Actions &amp;
                Recommendations deployment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">componentName</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type">ComponentName (enumeration of type string)</td>

              <td class="entry" headers="d797855e104" data-title="Description">Specifies the name of the component used in the deployment: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">ActionsAndRecommendations</samp>—0
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">ActionLauncher</samp>—1
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">BulkActionPanel</samp>—2. This value is
                    available in API version 60.0 and later
                  </li>

                </ul>
                For example, a value of 1 indicates that 1 is stored in the database if Action
                Launcher is used to create a deployment. Available in API version 56.0 and
                later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">deploymentContexts</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type"><a class="xref" href="#recordActionDeploymentContext">RecordActionDeploymentContext</a></td>

              <td class="entry" headers="d797855e104" data-title="Description">Specifies the object context for quick actions and Next Best Action strategies.
                Available in API version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">hasComponents</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d797855e104" data-title="Description">Indicates whether the record actions deployment includes components (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 61.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">hasGuidedActions</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d797855e104" data-title="Description">Specifies that the component shows standard actions; for example, flows and
                quick actions. Available in API version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name">hasOmniscripts</td>

              <td class="entry" headers="d797855e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d797855e104" data-title="Description">Indicates whether the record actions deployment includes OmniScripts (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in API version 56.0 and later. The default value is
                <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">hasRecommendations</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d797855e104" data-title="Description">Specifies that the component shows recommendations from a Next Best Action
                strategy. Available in API version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type">string</td>

              <td class="entry" headers="d797855e104" data-title="Description">Required. Specifies the name of the deployment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">recommendation</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type">
                <a class="xref" href="#recordActionRecommendation">RecordActionRecommendation</a>
              </td>

              <td class="entry" headers="d797855e104" data-title="Description">Specifies settings for how Next Best Action recommendations appear in the
                component. Available in API version 46.0 and later.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">selectableItems</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type"><a class="xref" href="#recordActionDeploymentSelectableItems">RecordActionDeploymentSelectableItems</a></td>

              <td class="entry" headers="d797855e104" data-title="Description">Specifies the actions that users can add at runtime.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e98" data-title="Field Name"><span class="keyword parmname">shouldLaunchActionOnReject</span></td>

              <td class="entry" headers="d797855e101" data-title="Field Type">boolean</td>

              <td class="entry" headers="d797855e104" data-title="Description">Required. If <samp class="codeph nolang">true</samp>, launch the flow when
                the recommendation is rejected
 by the agent. Available in API version 48.0 and
                later.</td>

            </tr>

          </tbody>

        </table>

## RecordActionDefaultItem

Represents actions and attributes specified as channel defaults in a deployment.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d797855e325">Field Name</th>

              <th class="featureTableHeader  " id="d797855e328">Field Type</th>

              <th class="featureTableHeader  " id="d797855e331">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d797855e325" data-title="Field Name"><span class="keyword parmname">action</span></td>

              <td class="entry" headers="d797855e328" data-title="Field Type">string </td>

              <td class="entry" headers="d797855e331" data-title="Description">Required. Specifies the API name of an action. For example, the API name of a
                flow, such as <samp class="codeph nolang">Verify_Information</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e325" data-title="Field Name"><span class="keyword parmname">isMandatory</span></td>

              <td class="entry" headers="d797855e328" data-title="Field Type">boolean</td>

              <td class="entry" headers="d797855e331" data-title="Description">Specifies whether the action is marked as mandatory. The default value is
                <samp class="codeph nolang">false</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e325" data-title="Field Name"><span class="keyword parmname">isUiRemoveHidden</span></td>

              <td class="entry" headers="d797855e328" data-title="Field Type">boolean</td>

              <td class="entry" headers="d797855e331" data-title="Description">Specifies whether the remove option is hidden in the UI. The default value is
                false. If <samp class="codeph nolang">true</samp>, the UI hides the ability to
                remove the action from the list. </td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e325" data-title="Field Name"><span class="keyword parmname">pinned</span></td>

              <td class="entry" headers="d797855e328" data-title="Field Type">PinnedAction (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d797855e331" data-title="Description">Required. Indicates whether the action is pinned to the <samp class="codeph nolang">Top</samp> or <samp class="codeph nolang">Bottom</samp>,
                or unpinned (<samp class="codeph nolang">None</samp>). The default value is
                <samp class="codeph nolang">None</samp>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e325" data-title="Field Name"><span class="keyword parmname">position</span></td>

              <td class="entry" headers="d797855e328" data-title="Field Type">int</td>

              <td class="entry" headers="d797855e331" data-title="Description">Required. Indicates the order of the action among all actions associated with
                this record.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e325" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d797855e328" data-title="Field Type">RecordActionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d797855e331" data-title="Description">Required. The type of action that’s associated with the record. Valid values
                are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Flow</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">QuickAction</samp> (Available in API version
                    46.0 and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OmniScript</samp> (Available in API version 56.0
                    and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LWC</samp> (Available in API version 62.0 and
                    later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SvcCatalogItemDef</samp> (Available in API
                    version 62.0 and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">WebLink</samp> (Available in API version 62.0
                    and later.)
                  </li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## RecordActionDeploymentChannel

Specifies channel-specific defaults to show in the Actions & Recommendations component. The component displays the channel defaults when the list is otherwise empty.

| Field Name | Field Type | Description |  |
| --- | --- | --- | --- |
| channel | ChannelSource ([enumeration](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title) of type string) | Required. Specifies the channel. Valid values are Phone, Chat, or Default. |  |
| channelItems | [RecordActionDefaultItem](#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 action in the list is launched when the record page opens. If true, the first action is launched. The default value is false. |  |

## RecordActionDeploymentContext

Specifies an object that provides context for quick actions and Next Best Action strategies. When the component appears on this type of page, it includes object-specific quick actions and uses an object-specific strategy to filter recommendations. Available in API version 46.0 and later.

![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png)

#### Note

We support a maximum of 10 objects that provide context within a deployment.

| Field Name | Field Type | Description |
| --- | --- | --- |
| entityName | string | Required. Specifies the API name of an object to use as context. |
| recommendationStrategy | string | Specifies the API name of a Next Best Action strategy that overrides the default strategy on this page. A strategy is a metadata type [RecommendationStrategy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recommendationstrategy.htm "Represents a recommendation strategy. Recommendation strategies are applications, similar to data flows, that determine a set of recommendations to be delivered to the client through data retrieval, branching, and logic operations."). |

## RecordActionRecommendation

Specifies settings to display Next Best Action recommendations in the component. Available in API version 46.0 and later.

| Field Name | Field Type | Description |
| --- | --- | --- |
| defaultStrategy | string | Specifies the API name of the default Next Best Action strategy, which is a metadata type, [RecommendationStrategy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recommendationstrategy.htm "Represents a recommendation strategy. Recommendation strategies are applications, similar to data flows, that determine a set of recommendations to be delivered to the client through data retrieval, branching, and logic operations."). |
| hasDescription | boolean | Required. If true, display the description for the recommendation. |
| hasImage | boolean | Required. If true, display the image for the recommendation. |
| hasRejectAction | boolean | Required. If true, display the label that the user clicks to reject the recommendation. |
| hasTitle | boolean | Required. If true, display the title for the recommendation. |
| maxDisplayRecommendations | int | Required. Specifies the maximum number of recommendations to display. Valid values are 1–4. |

## RecordActionSelectableItem

Represents the set of actions available for users to add to the component at runtime.

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d797855e829">Field Name</th>

              <th class="featureTableHeader  " id="d797855e832">Field Type</th>

              <th class="featureTableHeader  " id="d797855e835">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d797855e829" data-title="Field Name"><span class="keyword parmname">action</span></td>

              <td class="entry" headers="d797855e832" data-title="Field Type">string</td>

              <td class="entry" headers="d797855e835" data-title="Description">Required. Specifies the API name of an action. For example, the API name of a
                flow, such as <samp class="codeph nolang">Verify_Information</samp>.</td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e829" data-title="Field Name"><span class="keyword parmname">type</span></td>

              <td class="entry" headers="d797855e832" data-title="Field Type">RecordActionType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d797855e835" data-title="Description">Required. The type of action that’s associated with the record. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Flow</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">QuickAction</samp> (Available in API version
                    46.0 and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OmniScript</samp> (Available in API version 56.0
                    and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">LWC</samp> (Available in API version 62.0 and
                    later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">SvcCatalogItemDef</samp> (Available in API
                    version 62.0 and later.)
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">WebLink</samp> (Available in API version 62.0
                    and later.)
                  </li>

                </ul>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e829" data-title="Field Name"><span class="keyword parmname">isFrequentAction</span></td>

              <td class="entry" headers="d797855e832" data-title="Field Type">boolean</td>

              <td class="entry" headers="d797855e835" data-title="Description">Indicates whether an action is frequently accessed by users (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Available in version 57.0 and later. <p class="p">This field applies only
                  to Action Launcher.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d797855e829" data-title="Field Name">frequentActionSequenceNbr</td>

              <td class="entry" headers="d797855e832" data-title="Field Type">integer</td>

              <td class="entry" headers="d797855e835" data-title="Description">The sequence number that's assigned to a frequently used action that's shown on
                Action Launcher. Available in version 57.0 and later. <p class="p" id="note_bmb_l3v_wvb"><a name="note_bmb_l3v_wvb"><!-- --></a>This
                  field applies only to Action Launcher.&nbsp;</p>
              </td>

            </tr>

          </tbody>

        </table>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

## Declarative Metadata Sample Definition

The following is a sample of a recordActionDeployment file.

<RecordActionDeployment xmlns="http://soap.sforce.com/2006/04/metadata">
    <channelConfigurations\>
        <channel\>Phone</channel\>
        <channelItems\>
            <action\>Sample\_Flow</action\>
            <isMandatory\>false</isMandatory\>
            <isUiRemoveHidden\>false</isUiRemoveHidden\>
            <position\>1</position\>
            <pinned\>Top</pinned\>
            <type\>Flow</type\>
        </channelItems\>
        <channelItems\>
            <action\>Another\_Sample\_Flow</action\>
            <isMandatory\>false</isMandatory\>
            <isUiRemoveHidden\>true</isUiRemoveHidden\>
            <position\>2</position\>
            <pinned\>Top</pinned\>
            <type\>Flow</type\>
        </channelItems\>
        <isAutopopEnabled\>true</isAutopopEnabled\>
    </channelConfigurations\>
    <masterLabel\>Sample Deployment</masterLabel\>
    <selectableItems\>
        <action\>Sample\_Flow</action\>
        <type\>Flow</type\>
        <isFrequentAction\>true</isFrequentAction\>
        <frequentActionSequenceNbr\>1</frequentActionSequenceNbr\>
    </selectableItems\>
    <selectableItems\>
        <action\>Sample\_Flow\_2</action\>
        <type\>Flow</type\>
        <isFrequentAction\>false</isFrequentAction\>
    </selectableItems\>
    <hasGuidedActions\>true</hasGuidedActions\>
    <hasRecommendations\>true</hasRecommendations\>
    <recommendation\>
        <defaultStrategy\>Sample\_Global\_Strategy</defaultStrategy\>
        <maxDisplayRecommendations\>4</maxDisplayRecommendations\>
        <hasImage\>true</hasImage\>
        <hasDescription\>true</hasDescription\>
        <hasRejectAction\>true</hasRejectAction\>
        <hasTitle\>true</hasTitle\>
    </recommendation\>
    <deploymentContexts\>
        <entityName\>Case</entityName\>
        <recommendationStrategy\>Sample\_Case\_Strategy</recommendationStrategy\>
    </deploymentContexts\>
    <deploymentContexts\>
        <entityName\>Account</entityName\>
        <recommendationStrategy\>Sample\_Acc\_Strategy</recommendationStrategy\>
    </deploymentContexts\>
</RecordActionDeployment\>

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

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <fullName\>SecondTest</fullName\>
    <types\>
        <members\>Sample\_Flow</members\>
        <members\>Another\_Sample\_Flow</members\>
        <members\>Sample\_Flow\_2</members\>
        <name\>Flow</name\>
    </types\>
    <types\>
        <members\>SampleDeployment</members\>
        <name\>RecordActionDeployment</name\>
    </types\>
    <version\>45.0</version\>
</Package\>

#### See Also

- [RecommendationStrategy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_recommendationstrategy.htm "Represents a recommendation strategy. Recommendation strategies are applications, similar to data flows, that determine a set of recommendations to be delivered to the client through data retrieval, branching, and logic operations.")