You are here:
Setup and Script Configuration Reference (Managed Package)
For the managed package runtime, the Script Configuration defines the name, type, subtype, language, and currency of an Omniscript. The Script Configuration also provides multiple configuration options to define both the appearance and behavior of the Omniscript further.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
Beginning with the Vlocity Insurance and Health Spring '20, the Vlocity LWC Omniscript designer enables you to preview dynamic web forms as you build them using a drag interface with WYSIWYG editing.
When creating or editing an Omniscript in the designer, see script configuration properties in the Setup panel.
Setup Properties Exclusive to the LWC Omniscript Designer
Property |
Description |
|---|---|
Custom Lightning Stylesheet File Name |
Enter the name of a static resource that contains a CSS file to apply custom SLDS styling. |
Custom Newport Stylesheet File Name |
Enter the name of a static resource that contains a CSS file to apply custom Newport styling. |
Default Error Message |
Sets a script-wide default error message that displays if an error message for a specific action doesn’t exist. |
Enable SEO |
Make your Omniscript's URL available to search engines. |
Fixed Footer On Mobile |
Sets footer buttons to a fixed position on mobile devices. |
Lightning Design System Design Token Overrides |
Override Salesforce's Lightning Design System design tokens. |
Scroll Animation |
Select On to add a smooth scroll animation to your Omniscript. |
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. |
Script Configuration Properties Exclusive to LWC Omniscripts
Beginning with Vlocity Insurance and Vlocity Health Summer '19, Omniscripts support Lightning web components.
Property |
Description |
Example |
|---|---|---|
commitOnChange Available beginning with Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20. |
In LWC Omniscripts, validation runs when a user clicks out of a field by using the onBlur function. In Angular Omniscripts, validation runs when a user types in a field by using the onChange function. |
n/a |
Deploy LWC |
Redeploy an active Omniscript if the previously generated LWC Omniscript fails to deploy by clicking Deploy LWC. |
Activate and Deploy Omniscripts |
Download LWC |
Review the auto-generated Omniscript LWC by clicking Download LWC. |
n/a |
Element Type To LWC Component Mapping |
Enables a custom Lightning web component to override all elements of a specific Element Type. |
Add Custom Lightning Web Components to an Omniscript |
Enable LWC |
Enables the Omniscript to use the Vlocity Lightning Web Component framework. |
Create an LWC Omniscript |
Pub/Sub |
Sends custom parameters as a key/value pair when an action fires a pub/sub event that enables communication between Lightning Web Components. |
n/a |
Step Chart Placement |
Exclusive to LWC Omniscripts using Lightning styling, set the Step Chart to display to the right, to the left, or on top of the Omniscript. |
Right:  Left:  Top:  |
Script Configuration Properties
Property Label |
Description |
LWC Enabled |
Example |
|---|---|---|---|
Cancel Options |
Enables customization of the cancel link's behavior. |
Yes |
Configuring the Cancel Link in an Omniscript |
Console Tab Label |
Applies text to the console tab where the Omniscript is embedded. The Console Tab Label and Console Tab Icon settings in Omniscript only applies if the Omniscript owns the entire tab or subtab. The Console Tab Label and Console Tab Icon settings aren't used if the Omniscript is embedded on a page with other components. |
Available starting with Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20. |
n/a |
Console Tab Icon |
Applies an icon to the console tab where the Omniscript is embedded. The Console Tab Label and Console Tab Icon settings in Omniscript only applies if the Omniscript owns the entire tab or subtab. The Console Tab Label and Console Tab Icon settings aren't used if the Omniscript is embedded on a page with other components. |
Available starting with Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20. |
n/a |
Currency Code |
By default, Omniscript uses an org's default currency in single-currency orgs and a user's currency in multi-currency orgs. Override the default currency by configuring the currency code field. Add the currency code as a static value or pass it in from a URL using the OmniScriptCurrencyCode parameter. For example, set the currency code JPY or pass it in as a URL parameter, c__OmniScriptCurrencyCode=JPY. |
Yes |
In a VisualForce page that displays an Omniscript, by setting the strOmniScriptCurrencyCode to a currency code. |
Custom HTML Templates |
Enter CSS to modify the Omniscript or enter HTML templates to override Omniscript's default templates. |
No |
Using Custom Templates |
Custom JavaScript |
Enter custom JavaScript that is run, or available, when an Omniscript initializes. |
No |
n/a |
Description |
Shown on the list view on the Omniscript Designer home page. |
Yes |
n/a |
Element Type To HTML Template Mapping |
Applies a template override to every element of a specific type. The element type is specified in the left field, and the template is specified in the field on the right. |
No |
n/a |
Enable Tracking |
Enables Omniscript to track how long steps and actions take. The times are stored in the Data JSON. |
Available starting with Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20. |
Omniscript Custom Event Tracking |
Enable Unload Warning |
Triggers a Leave Site? warning when reloading, navigating away, or closing the window. |
Yes |
n/a |
Error Messages |
Enables custom error messages that replace the default error messages. |
No |
Customize Omniscript Error Messages |
Fetch Picklist Values At Script Load |
Enables picklist values to be retrieved at script load when selected. If the setting is deselected, picklists are fetched at design time. |
Available starting with Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20. |
n/a |
Enable Logging Metrics |
Sends data to Salesforce about which Omniscript elements are used at runtime. Doesn't include hidden actions and steps. Doesn't collect user data. |
Yes |
n/a |
Enable Logging Metrics for Hidden Actions and Steps |
Sends data to Salesforce about which Omniscript hidden actions and steps are used at runtime. Doesn't collect user data. Not selected by default due to possible decreased performance. |
Yes |
n/a |
Hide Step Chart |
Removes the Step Chart from the UI when selected. |
Yes |
n/a |
Knowledge Options |
Enables Salesforce Knowledge to be integrated with Omniscript. |
Available starting with Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20. |
Integrate Salesforce Knowledge with Classic Omniscript |
Label Outside Of Field |
Displays the label outside of the field when selected. |
No |
|
Language |
Type, SubType, and Language define the unique identity of the Omniscript: there can be only one Omniscript with the same Type, SubType, and Language active at any time. |
Yes |
Create Multi-Language Omniscripts |
Merge Saved Data JSON |
Enables saved Omniscript instances to merge data from the saved instance into an updated and redeployed Omniscript. When the setting is deselected, users start a new instance of the updated Omniscript. |
Yes |
Configure Save Options |
Omniscript Name |
Shown on the list view on the Omniscript Designer home page. |
Yes |
n/a |
Persistent Component |
Enables the addition of persistent components, including Cart and Knowledge. |
No |
n/a |
Reusable |
Enables the Omniscript to be embedded into another Omniscript when selected. |
Yes |
Embedding a reusable Omniscript |
Save Options |
Enables Omniscript data to be written to the OmniScriptInstance__c object, including the Data JSON, full JSON, and attachments. |
Available starting with Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20. |
Save and Resume an Omniscript |
Seed Data JSON |
Seed Data JSON enables the Omniscript to be seeded with data on launch.
It doesn’t allow for referencing other data with the |
Yes |
Seed Data into an Omniscript |
SubType |
Type, SubType, and Language define the unique identity of the Omniscript: there can be only one Omniscript with the same Type, SubType, and Language active at any time. Special characters aren’t allowed. |
Yes |
n/a |
Session Storage |
Sends custom parameters as a key/value pair when an action fires a session storage event that enables temporary data storage. |
Yes |
n/a |
Tracking Custom Data |
Log custom data to the Vlocity Tracking Entry table by adding Key/Value pairs. Requires the Vlocity Tracking Service to be enabled in Custom Settings. |
Available starting with Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20. |
n/a |
Type |
Type, SubType, and Language define the unique identity of the Omniscript: there can be only one Omniscript with the same Type, SubType, and Language active at any time. Special characters aren’t allowed. |
Yes |
n/a |
Visualforce Pages Available In Preview |
To make a custom Visualforce available in the Omniscript preview player dropdown, enter a Key/Value pair. |
No |
n/a |
Window PostMessage |
Sends custom parameters as a key/value pair when an action fires a postMessage event that enables cross-window communication. |
Yes |
n/a |
