Common Action Element Properties

Label

The label on the button, or, if running remotely, the heading of the Action block.

Validation

Determines whether validation runs on the step before the action is invoked. When set to Step, the action button will be clickable once all required fields within the step contain valid input. Select None to bypass validation.

Invoke Mode

Configure the response behavior of the action.

Default: The Action blocks the UI with a loading spinner.

Non-Blocking: 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.

Fire and Forget: 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.

Conditional View

All Action elements support conditional view. See Conditionally Display Omniscript Elements.

Pub/Sub

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 Messaging Framework for Omniscripts.

Session Storage

Send information to a Session Storage object using key-value pairs. A session storage object clears when a page session ends. See Messaging Framework for Omniscripts.

Window Post Message

Send information from an element to a window object in key-value pairs. SeeMessaging Framework for Omniscripts.

Show a message during execution

Enable Action Message in the designer for a managed package

Enables an input of custom action messages.

Next Label on Failure

Failure Next Label in the designer for a managed package

Label of the continue button if the Action fails.

Previous Label on Failure

Failure Go Back Label in the designer for a managed package

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.

Success Message

Post Message in the designer for a managed package

Message displayed upon success.

Send JSON Path

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.

Send JSON Node

This property allows you to specify the root node name in the outgoing response. For example, if your Omniscript had a Customer node at the root, you could relabel the node to CustomerAccount.

Pre-Transform Data Mapper

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.

Post-Transform Data Mapper

Works identically to the Pre-Transform, except the transformation is applied to the response body before merging into the Data JSON.

Response JSON Path

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).

Response JSON Node

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.

Default

The Action blocks the UI with a loading spinner.

Non-Blocking

The Action runs asynchronously, and the response is applied to the UI. Pre and Post Data Mapper transforms, and large attachments are not supported.

Fire and Forget

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.