You are here:
Enable and Configure Cancel Functionality in an LWC Omniscript (Managed Package)
For the managed package runtime, navigate users to different Salesforce experiences after canceling an Omniscript by configuring cancel options.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
Omniscript's cancel functionality enables users to cancel out of an Omniscript from a Step by clicking a cancel link. The cancel link directs the user to a Salesforce experience set in the cancel options or a Navigate Action.
-
From Omniscript's Setup, expand Cancel Options and click
Enable Cancel.
Enabling users to cancel an embedded Omniscript also enables them to cancel the parent Omniscript and any other Omniscripts embedded in the parent. Similarly, enabling users to cancel the parent Omniscript enables them to cancel all embedded Omniscripts. In both cases, a cancel link is included in all parent and child Omniscripts.
- In Field Label, enter the cancel option's display text. The text displays as a clickable link in every Step.
-
To display a prompt message when a users cancels the Omniscript, check Show
prompt before cancel? and enter text into Cancel Message.
Users can return to the Omniscript or confirm the cancellation.
-
To replace the existing entry in the browser history when a user cancels, set the
Replace? property to Yes.
Enabling the property prevents users from navigating back to the Omniscript.
-
Determine the Salesforce experience to which the cancel link directs by clicking
and selecting a Page Reference Type.
Page Reference Type
Description
App
Launch a standard or custom app that is available from the app launcher. Connected apps are not supported.
Community Named Page
Direct users to a named page in a community.
Component
Navigate to an Aura or Lightning web component.
Current Page
Trigger a page update on the current page once a user completes the Omniscript.
Knowledge Article
Display knowledge articles in the Omniscript.
Login
Open a community login page.
LWC Omniscript
Launch another LWC Omniscript.
Named Page Open a standard named page.
Navigation Item
Open a page that displays mapped content on a CustomTab.
Object
Direct users to a standard or custom object page.
Record
Open a page that interacts with a Salesforce record.
Record Relationship
Open a record relationship page.
Web Page
Open an external URL.
- For the selected Page Reference Type, enter additional Target Parameters to pass to the experience. For information about Page Reference Types, see PageReference Types.
- Add Cancel Options to a Navigate Action (Managed Package)
For the managed package runtime, prior to Vlocity Insurance and Health Summer ’20, add cancel functionality to an LWC Omniscript by using the Navigate Action.
