Salesforce Docs Portal

SearchResultActionConfig

Represents a collection of fields to set up the actions that a user can perform on results returned by criteria-based search.
Important

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.

Parent Type

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

File Suffix and Directory Location

SearchResultActionConfig components have the suffix .SearchResultActionConfigSettings and are stored in the SearchResultActionConfigSettings folder.

Version

SearchResultActionConfig components are available in API version 59.0 and later.

Special Access Rules

This type is available if Criteria-Based Search and Filter is enabled in your org.

Fields

actionReference

  • Field Type: string
  • Description: Required.

    The action that a user can launch for a search result. Specify the ID of an instance that corresponds to your action type.

actionScope

  • Field Type: SearchResultActionScope (enumeration of type string)
  • Description: Required.

    Specifies the scope of the action that the user can launch.

  • Possible values:
    • Global—Select to apply the action to all record types in the search result.
    • Inline—Select to restrict the action to a single record. Available in API version 64.0 and later.

actionType

  • Field Type: SearchResultActionType (enumeration of type string)
  • Description: Required.

    Specifies the type of action that a user can launch.

  • Possible values:
    • FlowDefinition
    • LightningWebComponent
    • OmniScript—Available in API version 60.0 and later.

agentConfirmationMessage

  • Field Type: string
  • Description: The confirmation message displayed to the agent. The character limit is 255. Available in API version 64.0 and later.

description

  • Field Type: string
  • Description: The description of the search result action configuration.

isAiAction

  • Type: boolean
  • Description: Indicates whether the current action uses generative AI (true) or not (false). Available in API version 64.0 and later.
  • Default value: false

masterLabel

  • Field Type: string
  • Description: Required.

    The name of the action that's displayed in the search page.

Declarative Metadata Sample Definition

The following is an example of a SearchResultActionConfig component.

<?xml version="1.0" encoding="UTF-8"?>
<SearchResultActionConfig xmlns="http://soap.sforce.com/2006/04/metadata">
    <actionReference>setup_service_experience__Create_Case</actionReference>
    <actionScope>Global</actionScope>
    <actionType>FlowDefinition</actionType>
    <agentConfirmationMessage>test confirmation message</agentConfirmationMessage>
    <description>Screen flow to create a case.</description>
    <isAiAction>true</isAiAction>
    <masterLabel>Create a Case</masterLabel>
</SearchResultActionConfig>

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">
    <types>
        <members>*</members>
        <name>SearchResultActionConfig</name>
    </types>
    <version>59.0</version>
</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.