Configure Omniscript Settings

Configure optional settings for your Omniscript in the Setup panel of the Omniscript Designer, such as making your Omniscript reusable or enabling logging.

Default Setup Properties

Default setup properties apply to your entire Omniscript and aren’t included in each element’s properties.

Note
Note

After updating or configuring Omniscripts, allow 15–20 minutes for updates to appear, even after clearing your cache. If you see any errors or if old versions load, contact Salesforce support to enable the Template API setting. This helps updates show up faster and more reliably.

Default Setup Property

Description

Task Documentation

Enable reusable

If checked, enables the Omniscript to be embedded in another Omniscript.

Embed an Omniscript in Another Omniscript

Enable SEO

Makes your Omniscript's URL available to search engines.

Enable SEO for Omniscripts

Set the currency code

Overrides the default currency by configuring the currency code field. By default, Omniscript uses the org default currency in single-currency orgs and the user's currency in multi-currency orgs.

Configure an Omniscript's Currency Code

Fetch picklist values at script load

If selected, enables picklist values to be retrieved at script load. If deselected, picklists are fetched at design time. Sometimes, the Omniscript can’t retrieve the picklist values because it reached the Apex CPU limits. In that case, deselect the checkbox and reactivate the Omniscript. If you later add more values, deactivate and reactivate the Omniscript to refresh the data.

Populating Picklist Values in Omniscript Inputs from Apex

Seed data JSON

Enables the Omniscript to be seeded with JSON data on launch. The property doesn’t allow for referencing other data with the %element% syntax or use of expressions. For more robust functionality, see Set Values in an Omniscript.

Seed Data Into an Omniscript

Enable unload warning

Triggers a Leave Site? warning when reloading, navigating away, or closing the window.

None available

Enable logging metrics

Sends data to Salesforce about which Omniscript elements are used at runtime. The data doesn't include hidden actions and steps, and it doesn't collect user data.

None available

Enable logging metrics for hidden actions and steps

Sends data to Salesforce about which Omniscript hidden actions and steps are used at runtime. The data doesn't collect user data. By default, the property isn't selected due to possible decreased performance.

None available

Set the console tab title and icon

Applies text and an icon to the console tab where the Omniscript is embedded. These settings apply only if the Omniscript owns the entire tab or subtab. They aren't used if the Omniscript is embedded on a page with other components.

None available

Setup Properties

Setup property sections include sets of properties that apply to a specific configuration, such as displaying Knowledge Base articles in your Omniscript.

Setup Property

Description

Task Documentation

Step Chart Options

Hide the step chart or choose where to display it relative to your Omniscript.

Configure Step Chart for an Omniscript

Cancel Options

Enable cancel functionality and configure how the cancel behavior executes.

Configure Omniscript Cancel Options

Save Options

Enable users to save an Omniscript for later use.

Save and Resume an Omniscript

Knowledge Options

Enable Knowledge Articles to be displayed in or alongside your Omniscript.

Integrate Salesforce Knowledge with Omniscript

Error Messages

Set a default error message or simplify error messages for users.

Customize Omniscript Error Messages

Messaging Framework

Pass information using Pub/Sub, windowPostMessage, and Session Storage.

Messaging Framework for Omniscripts

Styling Options

Customize the design of your Omniscript using custom style sheets, design tokens, and a scroll animation.

Custom Styles for Omniscripts