Common Action Element Properties (Managed Package)

Label

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

Redirect Page Name

Custom redirect page name. Upon success, the script navigates to this page. Leave blank to bypass the redirect page.

Redirect Template URL

HTML template of the redirect page. Vlocity provides templates for redirect pages, or you can create your own.

Validation Required

Determines whether validation runs on the script or Step before the Action is invoked. Select Submit to validate the entire script or Step to validate only the Step that the button is on. When set to Step, the Action 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.

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.

Session Storage

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

Window Post Message

Send information from an element to a window object in key-value pairs.

Tracking Business Category

Define a business category for a tracking entry. For example, eCommerce.

Tracking Business Event

Define a business tracking event for a tracking entry. For example, Payment Plan.

Enable Action Message

Enables an input of custom action messages.

Enable Default Abort

Enables the Abort functionality to override the default Go Back functionality. Users will then only be able to abort the Omniscript if the Action fails.

Failure NextLabel

Label of the continue button if the Action fails, and the Enable Default Abort checkbox is checked.

Failure Abort Label

Label of the abort button if the Action fails, and the Enable Default Abort checkbox is checked.

Failure Abort Message

Confirmation message displayed after user clicks abort button.

Failure Go Back Label

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, or the Enable Default Abort checkbox has been checked.

In Progress Message:

Message displayed while the Action is being executed. This property is exclusive to Angular Omniscripts.

Post Message

Message displayed upon success.

Redirect Next Label

Label of the next button on the redirect page.

Redirect Next Width

Width of the next button on the redirect page.

Validation Required

Whether to check the validation of the script before the Action is invoked. Default is Submit. Leave blank to bypass validation.

Control Width

Controls the width of the button.

Redirect Previous Label

The label of the previous button on the redirect page.

Redirect Previous Width

The width of the previous button on the redirect page.

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.