LWC Omniscript Designer Changes and Enhancements (Managed Package)

For the managed package runtime, beginning with the Vlocity Insurance and Health Spring '20, the Vlocity LWC Omniscript Designer includes new features and changes to existing features.

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

Changes in functionality affect how you must configure an LWC Omniscript and how an LWC Omniscript performs.

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

This section lists changes and enhancements specific to the LWC Omniscript Designer.

New Setup Properties

Section: Property

Description

Enable Unload Warning

The Enable Unload Warning property is available in LWC Omniscripts.

Styling Options: Custom Lightning Stylesheet File Name

Reference a static resource that contain a custom Lightning stylesheet.

Styling Options: Custom Newport Stylesheet File Name

Reference a static resource that contain a custom Newport stylesheet.

Styling Options: Scroll Animation

Turn scroll animation on to add a smooth scroll animation to your Omniscript.

Cancel Options: Tracking Business Category

Define a business category for a tracking entry.

Cancel Options: Tracking Business Event

Define a business tracking event for a tracking entry.

New Element Properties

These properties are now available in LWC Omniscript Designer

Property

Description

Tracking Business Category

Define a business category for a tracking entry.

Tracking Business Event

Define a business tracking event for a tracking entry.

Added Element Property Support

The LWC Omniscript Designer now supports these properties.

Property

Description

Edit Block Label LWC Component Override

Edit Block's Cards and Long Cards modes support the Edit Block Label LWC Component Override.

Edit Block New LWC Component Override

Edit Block's Cards mode supports the Edit Block New LWC Component Override.

Use Continuation

The Remote Action's Use Continuation property, which enables you to invoke apex classes that return continuation objects, appears in the UI.

Added Element Support

The LWC Omniscript Designer now supports these elements.

Element

Description

Matrix Action

Call a Calculation Procedure with specific inputs and retrieve a value.

PDF Action

Fill and display PDFs using Omniscript data.

Set Errors Action

Render validation messaging on one or more elements in a Step.

New Functionalities

The LWC Omniscript Designer now includes these functionalities.

Functionality

Description

Cancel Options

Configure Cancel Options to direct users to different Salesforce experiences.

Download Off-Platform LWC

Download the Omniscript LWC to add it to OmniOut.

Hide Conditional Elements

Hide conditional elements in the designer by checking the hide conditional elements checkbox in the canvas.

Added Functionality Support

The LWC Omniscript Designer now supports these functionalities.

Functionality

Description

Edit Block SObject Mapping

The SObject mapping section appears in the UI of the Edit Block properties.

Full-width Preview

Collapse the Debug Panel to hide the Data JSON and Action debugger and preview the Omniscript in a full-width page.

Multi-Language: Custom Label Translations

Configure custom label translations from the LWC Omniscript Designer when designing a multi-language Omniscript.

Changes in Functionality

The File and Image elements no longer contain the Upload to Content Document checkbox property. LWC Omniscripts always upload files and images to the content document.

Changes and Enhancements for Vlocity Insurance and Health Spring '20

Changes to UI Section Names

UI Section Name LWC OS Designer

UI Section Name Classic OS Designer

Description

Build

Available Components

Lists available elements.

Canvas (not labeled)

Structure

Drag and drop elements here to build the script.

Navigation Panel (not labeled)

n/a

See higher-level and detailed views of the script structure.

Setup

Script Configuration

Configure script-wide settings.

Changes in Functionality

Functionality

LWC OS Designer

Classic OS Designer

Activating Inactive Elements

Inactive elements disappear from the canvas. To activate inactive elements, from Tree View or Slide View of the Navigation Panel, select the element, then activate it in the Properties panel.

Activate inactive elements by clicking the element on the Structure Panel and activating it on the Properties panel.

Cancel

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

The Cancel link appears on every Step in an Omniscript. Configure Cancel Options in the Script Configuration tab.

Conditional View

In the Properties panel, from the Conditional Type dropdown, select Show Element If True, Set Element To Required If True, or Disable Read Only If True.

In the Properties panel, from the Conditional View dropdown, select Hide element if false, Set element to readonly if false, or Set required element to optional if false.

Data JSON

In Preview, view Data JSON. Click clipboard icon to copy full data JSON.

In Preview, click Data to view full data JSON. Copy all or parts of the data JSON.

Editing Properties as JSON for a Navigation Action

Property options are not visible when Editing Properties as JSON. To view the options in the JSON, first set the property in the property UI.

Edit as JSON to edit all properties available in the Properties UI.

Step Elements Widths

Control the width and placement of elements in a step on the canvas with the adjustable 12-column horizontal grid and drag-and-drop features.

Drag-and-drop elements onto Structure Panel. Control element widths with the Control Width property in the Properties panel.

Theme

View Omniscript in Newport or Lightning themes in Design and Preview modes.

View Omniscript in Newport or Lightning themes in Preview.

Update Preview

Click the reload icon in Preview to update preview and reset data fields.

In Preview, click Data, click Update to update preview and reset data fields.

Added Functionality Support

Functionality

Description

Edit Block: SObject Mapping

In the LWC Omniscript Designer, the SObject Mapping section does not work. To edit the SObject mapping, use the classic designer. Once the edits are complete, switch back to the LWC Omniscript Designer to test the mapping.

Functionality Unique to LWC OS Designer

Functionality

Description

Canvas

Build and manage your script on an adjustable canvas.

In-Product Help

Access In-Product Help to view contextual information and instruction about elements and properties without leaving your script.

Preview Device

Preview how your LWC Omniscript appears on mobile, desktop, and tablet with the Preview Device feature.

Slide View

In the Slide View of the Navigation Panel, see a high-level overview of our Omniscript and navigate between active and inactive elements.

Tree View

In the Tree View of the Navigation Panel, see a detailed view of your Omniscript and navigate between active and inactive elements.

Setup Properties Unique to LWC OS Designer

Property

Description

Example

Default Error Message

Sets a script wide default error message that displays if an error message for a specific action does not exist.

Customize Omniscript Error Messages

Lightning Design System Design Token Overrides

Override Salesforce's Lightning Design System design tokens.

Customize SLDS Design Tokens in Omniscript

Element Changes

  • View elements in Build panel to drag onto the canvas to build your scripts.

  • Search for elements in the Build panel.