Salesforce Docs Portal

LWC Omniscript Changes and Enhancements (Managed Package)

For the managed package runtime, beginning with the Vlocity Insurance and Health Summer '19 and Vlocity Communications, Media, and Energy Fall '19 releases, Vlocity supports the Salesforce Lightning Web Component programming model.

Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

Changes in functionality affect configuration and performance of your LWC Omniscripts.

Beginning with the Vlocity Insurance and Health Summer '19 and Vlocity Communications, Media, and Energy Fall '19 releases, Vlocity supports the Salesforce Lightning Web Component programming model.

Changes and Enhancements for Vlocity Insurance and Health and Vlocity CME Summer '20

All of the LWC Omniscript changes and enhancements apply to both the LWC Omniscript Designer and the Classic Omniscript Designer.

Download the LWC HTML, CSS, and ReadMe files for this release by clicking here.

LWC OmniOut

Run an Omniscript on an external site by using the LWC OmniOut in your external application. OmniOut enables apps to run an Omniscript that connects to Salesforce and external APIs to send and receive data.

Added Omniscript Element Support

LWC Omniscript supports these elements:

Element

LWC Behavior

Angular Behavior

PDF Action

No change

No change

New Properties

New LWC Omniscript properties appear in the LWC Omniscript Designer only.

Added Property Support

LWC Omniscript supports these Omniscript properties:

Property

LWC Behavior

Angular Behavior

Enable Unload Warning

No change

No change

New Functionalities

These new functionalities are exclusive to LWC Omniscripts:

Functionality

Description

Browser Navigation

A browser's forward and back buttons navigate an LWC Omniscript to the next or previous Step.

Custom Styling Support for RTL Language

Add custom styling for right-to-left languages using static resources.

Download Off-Platform LWC

Download the Omniscript LWC to add it to OmniOut.

Expanded Google Maps Response Node

Type Ahead's Google Maps functionality returns an expanded response containing more JSON nodes.

Improved Readability

Readability has been improved for screenreaders.

Messaging Framework

Pass a value in the c__messagingKey URL parameter to change the node that stores the messaging payload for window.postMessage and session storage message.

Place Custom LWC Elements in Blocks

Custom LWC Elements are usable in a non-repeatable Block element. The Block cannot be nested.

Run Omniscripts with OmniOut

Add OmniOut to an application to run Omniscripts on a third-party website.

Translate Tooltip Help Text in Multi-Language Omniscripts

Provide translations for tooltip help text in multi-language Omniscripts by defining and adding custom labels.

Added Functionality Support

LWC Omniscript supports these Omniscript functionalities:

Functionality

LWC Behavior

Angular Behavior

Beta support for right-to-left languages

Multi-language and single language Omniscripts provide beta support for right-to-left languages.

No change

Mobile View in App Builder

Preview how your Omniscript displays on a mobile device by Lightning App Builder's device view to Phone.

No change

Changes and Enhancements for Vlocity Insurance and Health Spring '20 and Vlocity CME Summer '20

Download the HTML, CSS, and ReadMe files for this release by clicking here.

New Elements

These new elements are available in LWC Omniscripts.

Element

Description

Action Block

Groups Action elements together to enable backend calls to fire asynchronously using the same configuration.

Data Mapper Turbo Extract Action

Invokes an Omnistudio Data Mapper Turbo Extract.

Added Omniscript Element Support

LWC Omniscript supports these elements:

Element

LWC Behavior

Angular Behavior

Calculation Action

Calculation Action's Pre-Transform Data Mapper Interface and Post-Transform Data Mapper Interface properties are now in the remote properties section. This enables both Data Mappers to run in a single Apex call.

Calculation Action's Pre-Transform Data Mapper Interface and Post-Transform Data Mapper Interface properties are now in the remote properties section. This enables both Data Mappers to run in a single Apex call.

Delete Action

No change

No change

Disclosure

No change

No change

Matrix Action

No change

No change

Set Errors Action

No change

No change

New Properties

These new properties are exclusive to LWC Omniscripts:

Property

Description

Send only Extra Payload

Pass an Extra Payload's Key/Value pairs without sending an Omniscript's data JSON by using the Send Only Extra Payload property available in these actions: Calculation Action, HTTP Action, Integration Procedure Action, and Remote Action.

Step: Messaging Framework

Steps support the pubsub, window post message, and session storage message properties.

Added Property Support

LWC Omniscript supports these Omniscript properties:

Property

LWC Behavior

Angular Behavior

Conditional View: Set element to readonly if false

The conditional view property takes precedence over an element's Read Only property.

The element's Read Only property takes precedence.

Conditional View: Set required element to optional if false

The conditional view property takes precedence over an element's Required property.

The element's Required property takes precedence.

Repeat

No change

No change

New Functionalities

These new functionalities are exclusive to LWC Omniscripts:

Functionality

Description

Custom Stylesheet Static Resource

Add custom styling to an Omniscript using a custom style sheet static resource.

Enable LWC Omniscripts with UpperCase Type

Create LWC Omniscripts or convert Angular Omniscripts with a Type that begins with an uppercase letter with no additional configuration.

Inline Omniscripts

Display Omniscripts inline in Community and Lightning pages.

Navigate to Additional PageReference Types

Direct users to an App, Community Named Page, Logout, or Login page using the Navigate Action.

Override the Edit Block LWC

Override an Edit Block LWC, Edit Block New LWC, and Edit Block Label LWC, to add custom functionality and styling to an Edit Block.

Override the Model LWC

Extend and override the Omniscript Modal LWC.

Override the Save For Later Acknowledgement LWC

Override the Save For Later Acknowledgment LWC to add customizations.

Override the Type Ahead LWC

The LWC Type Ahead element's LWC Component Override field overrides the Type Ahead component instead of overriding the Type Ahead Block component.

SEO Omniscripts

Enable Omniscripts to appear in online searches and direct users to specific Steps in the Omniscript by configuring Omniscript's SEO options.

SLDS Token Override

Add customizations to SLDS Design Tokens in the Omniscript.

Stateful Omniscripts

Store the state of an Omniscript's progression in the URL to direct users to specific Steps in an Omniscript and temporarily store data.

Time Tracking in Navigate Action

The Navigate Action supports time tracking. The action is tracked in the StepActionTime time tracking entry.

Added Functionality Support

LWC Omniscript supports these Omniscript functionalities:

Functionality

LWC Behavior

Angular Behavior

Cancel

Add a cancel option to an LWC Omniscript by configuring the Navigate Action.

The Cancel button options appear in the Script Configuration's Cancel Options section.

Edit Block Cards

Override the Card with an LWC to add customizations.

Use templates to add customizations to the Card.

Multi-Language Omniscripts

  • Add and access custom labels in custom LWCs.

  • Provides Beta support for right-to-left languages.

  • Requires different custom label translations

  • Angular Multi-Language Omniscripts cannot use LWCs.

  • Supports right-to-left languages

  • Requires different custom label translations

Changes and Enhancements for Vlocity Insurance and Health Winter '20 and Vlocity CME Winter '20

New Properties

These new properties are exclusive to LWC Omniscripts:

Property

Description

Action Message

Enables custom action messages to render under an action's loading spinner when an Action runs.

Display Outside Omniscript

Enables Knowledge base articles to display in a separate Lightning web component in a Lightning page.

Merge Saved Data JSON into updated Omniscript

Enables a saved Omniscript to merge data into an updated version of the Omniscript.

Added Property Support

LWC Omniscript supports these Omniscript properties:

  • Console Tab Title and Console Tab Icon

  • Custom Tracking Data

  • Enable Tracking

  • Fetch Picklist Values At Script Load

  • Hide

  • Knowledge

  • Repeat - Only Block elements are supported

New Functionalities

These new functionalities are exclusive to LWC Omniscripts:

  • Make remote calls from any custom LWC using the Common Action Utility. .

  • View Knowledge Base articles outside of the Omniscript using the Vlocity Omniscript Knowledge Base Component.

  • Pass parameters into LWC Omniscripts in a Community.

  • Launch an Omniscript from a Card in a Community.

  • Override the default save for later error message with a custom message.

  • Pass events to an LWC Omniscript in the c_vlocEvents parameter, and fire the event by configuring the Navigate Action.

  • Hide the Next and Previous button on a Step by setting the width for each button to 0.

  • Override the Step Chart Lightning web component.

  • The Omniscript Base Mixin component includes methods to enable these functionalities:

    • Navigating to a Step

    • Saving a state in a disconnected callback

    • Clearing a saved state when a user navigates to a previous Step

    • Making remote calls

    • Applying response data to an Omniscript's data JSON

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

    To enable the LWC Omniscript to run validation when a user types:

    • In the Setup properties, click Edit as JSON.

    • Add the property "commitOnChange": true.

    • Preview the behavior.

      Note
      Note

      In LWC Omniscripts, the onChange behavior runs after a half-second delay.

Added Functionality Support

LWC Omniscript supports these Omniscript functionalities:

  • Displaying Knowledgebase articles in Omniscript.

  • Saving and resuming Omniscripts. Saving and resuming LWC Omniscripts requires additional configuration due to new behavior.

  • Group elements support the validation framework. For example, when a Group element, such as a Block, is hidden, validation does not apply to any element inside of the hidden group element.

  • Prefilling repeatable blocks.

Added Omniscript Element Support

LWC Omniscript supports these elements:

Element

LWC Behavior

Angular Behavior

Block

No change

No change

Edit Block

The Edit Block replaces HTML templates with the Select Modes property.

Edit Block uses HTML templates to display different Edit Block styles.

Email Action

No change

No change

DocuSign Envelope

No change

No change

DocuSign Signature

LWC Omniscripts use a new Visuaforce page to render the DocuSign Signature modal. To use the DocuSign Signature Action in Communities, add user profile permission for the Visualforce page.

The Visualforce page does not exist.

File

Supports uploads up to 2GB.

Note
Note

The Image and File elements do not work in the LWC preview due to a Salesforce limitation. When Image and File elements are required in a Step, the LWC Preview cannot advance past the Step. Vlocity recommends marking File and Image elements as Required only before activating the Omniscript.

Supports uploads up to 25 MB.

Image

Supports uploads up to 2 GB.

Note
Note

The Image and File elements do not work in the LWC preview because they use Salesforce components. When Image and File elements are required in a Step, the LWC Preview cannot advance past the Step. Vlocity recommends marking File and Image elements as Required only before activating the Omniscript.

Supports uploads up to 25 MB.

Messaging

Validation runs when a user clicks out of a field.

Validation runs when a user types.

Password

No change

No change

Type Ahead Block

The Type Ahead Block displays a progress bar instead of a spinner when retrieving data results.

There is no progress-bar component

Changes and Enhancements for Vlocity Insurance and Health Summer '19 and Vlocity Communications, Media, and Energy Fall '19

Changes in Functionality

Functionality

LWC Behavior

Angular Behavior

Conditional View

LWC supports Hide element if false.

Angular supports all Conditional View options.

Currency Element

Optionally display a Currency code in addition to the Currency symbol.

Displays the Currency symbol

Data Preview

In addition to the ContextId functionality, test data in the Omniscript's Data panel by adding Key/Value pairs.

Angular cannot test additional data.

HTTP Action for Integration Procedures

To use an HTTP Action that calls Apex, you must add the Salesforce org's domain into a Remote Site's Remote Site URL field.

HTTP Actions calling Apex do not require a Remote Site.

Input Fields

LWC supports placeholder text in Input fields.

Angular does not support placeholder text in Input fields.

Launching an Activated Script

The How to Launch Activated Script modal now displays an LWC tab that provides code to embed or launch a URL addressable LWC Omniscript.

Clicking the How to Launch an Activated Script opens a modal that contains information on embedding an Omniscript and launching an Omniscript from a URL.

Lightning

LWC Omniscripts use pure SLDS.

Angular Omniscripts do not use pure SLDS.

Previewing an Omniscript

Omniscripts using custom Lightning web components must be active before previewing.

Angular Omniscripts support previewing Inactive and Active Omniscripts with custom templates.

Single-step rendering

  • LWC Omniscripts load and render Steps individually, resulting in faster initial load times

  • Actions receive smaller data sets because the data JSON only contains prefilled data and data from Steps that have rendered

  • Data, including data from previous Steps, is accessible to a Step containing conditionals, formulas, and merge fields once the Step renders

  • Previously loaded Steps containing conditionals, formulas, and merge fields can evaluate data JSON when it becomes available

  • A future Step containing conditionals, formulas, and merge fields will not have access to the data JSON until the Step renders

  • Prefill data present in the data JSON loads into a Step once the Step renders

  • Loads all of the Omniscript's Steps when the Omniscript first loads

  • The Omniscript's data JSON is present for every Step after the initial load

  • Actions receive the entire set of data JSON that is present

  • Merge fields in future Steps can access the data JSON

  • Formulas in future Steps can access the data JSON

Step Chart Navigation

  • Navigating to a future step is not possible, even if there are no Actions between the Steps

  • Navigate back to any previously loaded Step by clicking the Step in the Step Chart.

  • Advance to a future Step by clicking the Step in the Step Chart if no Actions exist between the Steps.

  • Navigate back to a previously loaded step by clicking the Step in the Step Chart.

Step Instruction Field

Merge fields are usable in the Step Instruction field.

Merge fields are not usable in the Step Instruction field.

Type

An LWC Omniscript's Type must begin with a lowercase letter. You cannot use case-sensitivity to define a Type's unique name if another Omniscript with the same Type exists. For example, if you have an Angular Omniscript with an existing Type named Test, you cannot create an LWC Omniscript with a Type named test.

The Omniscript's Type must be a unique name that is not case-sensitive. For example, if a Type named Test exists, you cannot enter test as a Type.

UI Validation

  • Validation runs when a User clicks out of a field

  • Validation runs when a User submits a Step

    Note
    Note

    The Step always runs the validation and ignores the Step's Validation Required property.

  • When a User submits a Step, error messages appear inline with the Element

  • Validation runs for typed values and values set by an API

  • Validation methods are accessible in custom Lightning web components.

  • Validation runs when a User types

  • When a User submits a step, error messages appear in a modal

URL Element

Accepts a broader range of URL patterns, including:

  • http://www.xyz.com

  • https://www.xyz.com

  • www.xyz.com

  • test.xyz.com

Accepts a pattern of http://www.xyz.com

Script Configuration Properties Exclusive to LWC Omniscripts

Property

Purpose

Example

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

Step Chart Options

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:

image

Left:

image

Top:

image

Elements Exclusive to LWC Omniscripts

Element

Description

Custom LWC

The Custom LWC element enables custom components that do not extend an Omniscript element to exist in Omniscript.

Navigate Action

The Navigate Action enables the Omniscript to open different Salesforce experiences and external endpoints.

Element Changes

  • Elements that support Lightning web components display a Lightning icon in the available components section of an Omniscript.

  • The LWC Component Override property enables custom Lightning web components to override an individual element's component.