---
schema_version: "1"
id: 7083d2eba1fb9104373cf0b8e0a0eb6e1d1e0662c4e277956d26584efd0b8967
title: Common Action Element Properties
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/os_common_action_element_properties_11090.md
canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.os_common_action_element_properties_11090.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: 3fac407eaeb51d34abd6b220bb536148c2eee48cc0bf0959c49eb24cb47473a4
description: Review information about Omniscript action element properties.
products:
  - Omnistudio
release: "264"
---
# Common Action Element Properties

Review information about Omniscript action element properties.

## Common Action Properties

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
          <colgroup>
            <col style="width:50%">
            <col style="width:50%">
          </colgroup>
          <thead class="slds-text-title_caps ">
            <tr class="">
              <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d107087e45">
                <p style="margin-bottom:0;">Property</p>
              </th>
              <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d107087e51">
                <p style="margin-bottom:0;">Description</p>
              </th>
            </tr>
          </thead>
          <tbody>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e45 ">
                <p style="margin-bottom:0;">
                  <strong class="uicontrol">Label</strong>
                </p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e51 ">
                <p style="margin-bottom:0;">The label on the button, or, if running remotely, the heading of the
                  Action block.</p>
              </td>

            </tr>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e45 ">
                <p style="margin-bottom:0;">
                  <strong class="uicontrol">Validation</strong>
                </p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e51 ">
                <p style="margin-bottom:0;">Determines whether validation runs on the step before the action is
                  invoked. When set to <strong class="uicontrol">Step</strong>, the action button will
                  be clickable once all required fields within the step contain valid
                  input. Select <strong class="uicontrol">None</strong> to bypass validation.</p>
              </td>

            </tr>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e45 ">
                <p style="margin-bottom:0;">
                  <strong class="uicontrol">Invoke Mode</strong>
                </p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e51 ">
                <p>Configure the response behavior of the action.</p>
                <p><strong class="uicontrol">Default</strong>: The Action blocks the UI with a loading
                  spinner.</p>
                <p><strong class="uicontrol">Non-Blocking</strong>: The Action runs asynchronously, and
                  the response is applied to the UI. Pre and Post Omnistudio Data Mapper
                  transforms, and large attachments are not supported.</p>
                <p style="margin-bottom:0;"><strong class="uicontrol">Fire and Forge</strong>t: The Action runs asynchronously
                  with no callback to the UI. Pre and Post Data Mapper transforms, and
                  large attachments are not supported. A response will still appear in the
                  debug console but will not be applied to the Data JSON.</p>
              </td>

            </tr>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e45 ">
                <p style="margin-bottom:0;">
                  <strong class="uicontrol">Conditional View</strong>
                </p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e51 ">
                <p style="margin-bottom:0;">All Action elements support conditional view. See <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_conditionally_display_elements_using_the_conditional_view_property_19389.htm&amp;release=264.0.0&amp;type=5" title="With the Conditional View property, you can hide an element or a group of elements in a block or step based on certain conditions. Every step, block, or element supports at least one conditional view. Elements contain up to three conditional view options depending on the type of element. For example, an action outside of a step doesn’t have a Read-Only option since the action isn’t visible.">Conditionally Display Omniscript Elements</a>.</p>
              </td>

            </tr>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e45 ">
                <p style="margin-bottom:0;">
                  <strong class="uicontrol">Pub/Sub</strong>
                </p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e51 ">
                <p style="margin-bottom:0;">Communicate with Omniscript from a custom LWC by sending key-value pairs.
                  Use the events passed in the key-value pairs to trigger custom behavior
                  in a component. See <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_messaging_framework_11452.htm&amp;release=264.0.0&amp;type=5" title="Communicate between an Omniscript, windows, Lightning web components, and Omniscript elements with window post messages, session storage messages, and PubSub messaging.">Messaging Framework for Omniscripts</a>.</p>
              </td>

            </tr>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e45 ">
                <p style="margin-bottom:0;">
                  <strong class="uicontrol">Session Storage</strong>
                </p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e51 ">
                <p style="margin-bottom:0;">Send information to a Session Storage object using key-value pairs. A
                  session storage object clears when a page session ends. See <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_messaging_framework_11452.htm&amp;release=264.0.0&amp;type=5" title="Communicate between an Omniscript, windows, Lightning web components, and Omniscript elements with window post messages, session storage messages, and PubSub messaging.">Messaging Framework for Omniscripts</a>.</p>
              </td>

            </tr>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e45 ">
                <p style="margin-bottom:0;">
                  <strong class="uicontrol">Window Post Message</strong>
                </p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e51 ">
                <p style="margin-bottom:0;">Send information from an element to a window object in key-value pairs.
                  See<a href="https://help.salesforce.com/s/articleView?id=xcloud.os_messaging_framework_11452.htm&amp;release=264.0.0&amp;type=5" title="Communicate between an Omniscript, windows, Lightning web components, and Omniscript elements with window post messages, session storage messages, and PubSub messaging.">Messaging Framework for Omniscripts</a>.</p>
              </td>

            </tr>
          </tbody>
        </table>

## User Message Properties

Actions that run remotely and between steps, or before the first Step is run, contain these User Message properties.

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
          <colgroup>
            <col>
            <col>
          </colgroup>
          <thead class="slds-text-title_caps ">
            <tr class="">
              <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d107087e259">
                <p style="margin-bottom:0;">Property</p>
              </th>
              <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d107087e265">
                <p style="margin-bottom:0;">Description</p>
              </th>
            </tr>
          </thead>
          <tbody>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e259 ">
                <p>
                  <strong class="uicontrol">Show a message during execution</strong>
                </p>
                <p style="margin-bottom:0;"><strong class="uicontrol">Enable Action Message</strong> in the designer for a
                  managed package</p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e265 ">
                <p style="margin-bottom:0;">Enables an input of custom action messages.</p>
              </td>

            </tr>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e259 ">
                <p>
                  <strong class="uicontrol">Next Label on Failure</strong>
                </p>
                <p style="margin-bottom:0;"><strong class="uicontrol">Failure Next Label</strong> in the designer for a managed
                  package</p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e265 ">
                <p style="margin-bottom:0;">Label of the continue button if the Action fails.</p>
              </td>

            </tr>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e259 ">
                <p>
                  <strong class="uicontrol">Previous Label on Failure</strong>
                </p>
                <p style="margin-bottom:0;"><strong class="uicontrol">Failure Go Back Label</strong> in the designer for a
                  managed package</p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e265 ">
                <p style="margin-bottom:0;">Label of the Go Back button if the Action fails. The default behavior
                  enables users to return to the previous Step unless there are no previous
                  steps.</p>
              </td>

            </tr>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e259 ">
                <p>
                  <strong class="uicontrol">Success Message</strong>
                </p>
                <p style="margin-bottom:0;"><strong class="uicontrol">Post Message</strong> in the designer for a managed
                  package</p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e265 ">
                <p style="margin-bottom:0;">Message displayed upon success.</p>
              </td>

            </tr>
          </tbody>
        </table>

## Send and Response Transformations

Send and Response Transformations are properties available on a variety of Omniscript remote actions. They provide flexibility in trimming and reparenting the request and response JSON. For more information on how to use Send and Response Transformations, see [Manipulating JSON with the Send and Response Transformations Property](https://help.salesforce.com/s/articleView?id=xcloud.os_manipulate_json_with_the_send_response_transformations_properties_22367.htm&release=264.0.0&type=5 "Specify and transform the input and output JSON of Omniscripts or Integration Procedures with the Send and Response Transformation properties. The Send properties transform the input; the Response properties transform the output.").

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
          <colgroup>
            <col>
            <col>
          </colgroup>
          <thead class="slds-text-title_caps ">
            <tr class="">
              <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d107087e396">
                <p style="margin-bottom:0;">Property</p>
              </th>
              <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d107087e402">
                <p style="margin-bottom:0;">Description</p>
              </th>
            </tr>
          </thead>
          <tbody>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e396 ">
                <p style="margin-bottom:0;">
                  <strong class="uicontrol">Send JSON Path</strong>
                </p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e402 ">
                <p style="margin-bottom:0;">This property enables one node of the Omniscript Data JSON to be sent, rather than the entire JSON. Specify the node name in this property.</p>
              </td>

            </tr>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e396 ">
                <p style="margin-bottom:0;">
                  <strong class="uicontrol">Send JSON Node</strong>
                </p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e402 ">
                <p style="margin-bottom:0;">This property allows you to specify the root node name in the outgoing response. For example, if your Omniscript had a <kbd>Customer</kbd> node at the root, you could relabel the node to <kbd>CustomerAccount</kbd>.</p>
              </td>

            </tr>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e396 ">
                <p style="margin-bottom:0;">
                  <strong class="uicontrol">Pre-Transform Data Mapper</strong>
                </p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e402 ">
                <p style="margin-bottom:0;">In situations where a more complete transformation of the JSON is required, you can specify a Data Mapper transform interface. The service will run on the server, and then return the request body to the client for sending.</p>
              </td>

            </tr>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e396 ">
                <p style="margin-bottom:0;">
                  <strong class="uicontrol">Post-Transform Data Mapper</strong>
                </p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e402 ">
                <p style="margin-bottom:0;">Works identically to the Pre-Transform, except the transformation is applied to the response body before merging into the Data JSON.</p>
              </td>

            </tr>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e396 ">
                <p style="margin-bottom:0;">
                  <strong class="uicontrol">Response JSON Path</strong>
                </p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e402 ">
                <p style="margin-bottom:0;">This property allows you to trim the incoming JSON. For example, if the response has a three-level hierarchy, and you only want one of the nodes, you can specific the path you like to extract. The syntax is node:node:node (colon-separated).</p>
              </td>

            </tr>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e396 ">
                <p style="margin-bottom:0;">
                  <strong class="uicontrol">Response JSON Node</strong>
                </p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e402 ">
                <p style="margin-bottom:0;">This property allows you to reparent the incoming JSON to a node within the Omniscript JSON. Specific the Omniscript element name which will be the new root node for the response JSON.</p>
              </td>

            </tr>
          </tbody>
        </table>

## Selecting an Invoke Mode

Enable actions to run asynchronously, block users from advancing to a future Step, and modify by selecting an invoke mode.

Invoke Mode enables you to configure the response behavior of an action. It is available in:

- Remote Action
- Integration Procedure Action

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
          <colgroup>
            <col>
            <col>
          </colgroup>
          <thead class="slds-text-title_caps ">
            <tr class="">
              <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d107087e567">
                <p style="margin-bottom:0;">Property</p>
              </th>
              <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d107087e573">
                <p style="margin-bottom:0;">Description</p>
              </th>
            </tr>
          </thead>
          <tbody>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e567 ">
                <p style="margin-bottom:0;">
                  <strong class="uicontrol">Default</strong>
                </p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e573 ">
                <p style="margin-bottom:0;">The Action blocks the UI with a loading spinner.</p>
              </td>

            </tr>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e567 ">
                <p style="margin-bottom:0;">
                  <strong class="uicontrol">Non-Blocking</strong>
                </p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e573 ">
                <p style="margin-bottom:0;">The Action runs asynchronously, and the response is applied to the UI. Pre and Post Data Mapper transforms, and large attachments are not supported.</p>
              </td>

            </tr>
            <tr class="">
              <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e567 ">
                <p style="margin-bottom:0;">
                  <strong class="uicontrol">Fire and Forget</strong>
                </p>
              </td>

              <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d107087e573 ">
                <p style="margin-bottom:0;">The Action runs asynchronously with no callback to the UI. Pre and Post Data Mapper transforms, and large attachments are not supported. A response will still appear in the debug console but will not be applied to the Data JSON.</p>
              </td>

            </tr>
          </tbody>
        </table>

## Extra Payload

Extra payload is an additional property available for the actions listed below. The Omniscript can set up extra payload to be sent while making the call. This property supports merge fields.It is available in:

- Remote Action
- Integration Procedure Action
- HTTP Action

## Add an Action Message

Display an action message beneath the loading spinner while the action is running.

1. In an Action, expand the User Messages property.
2. Check **Enable Action Message**.
3. In **Action Message**, enter a custom message, or leave the default message.