You are here:
Navigate Action (Managed Package)
For the managed package runtime, navigate to various Salesforce experiences from Omniscript using the Navigate Action element.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
-
Drag the Navigate Action into the Omniscript's structure panel.
- If the Navigate Action renders in a Step, it becomes a clickable button.
- If the Navigate Action is between Steps, it fires automatically.
-
If the Navigate Action renders in a Step:
-
Determine the style of the button by selecting an SLDS Button variant.
In addition to SLDS Button variants, you can select Link to render the Navigate Action as an HTML anchor tag.
-
Display an SLDS Icon in the button by entering the Icon
name in the Icon Name field.
For example, to add the standard_account Icon, enter Standard:Account.
-
Determine the style of the button by selecting an SLDS Button variant.
-
If desired, replace the existing entry in the browser history by setting the
Replace checkbox to Yes.
If Replace is set to Yes, users can’t navigate back to the Omniscript.
NoteBy default, a Navigate Action in a Console App opens the PageReference type in a new subtab. If you use more than one Navigate Action, only the first Navigate Action redirects to a new tab. Even if the Replace checkbox is deselected, subsequent Navigate Actions replace the tab.
But if the Replace checkbox is deselected, the page reference doesn’t replace existing entries in the browser history. Users can navigate back and forth between Omniscripts in the tab.
After a Navigate Action completes, the Steps and other Omniscript elements that follow it run. However, if the user navigates away from the Omniscript, an asynchronously invoked Integration Procedure stops running.
-
To send messages from the Omniscript to separate Lightning web components, check
LWC PubSub Message? and add a message key-value pair.
Each Navigate Action must pass all required parameters to subsequent Lightning web components. For example, the first Navigate Action passes the
c__ContextIdparameter to a second Omniscript asc__ContextId=ContextId. A Navigate Action in the second Omniscript passes the parameter to a third Omniscript asc__ContextId=%ContextId%. All Navigate Actions must continue to pass the parameter to subsequent Omniscripts for as long as the parameter is needed. -
To fire events from the Navigate Action, pass an event to the Omniscript in the URL
parameter
c__vlocEvents. The Navigate Action element must have the checkbox property LWC PubSub Message? enabled to fire the event. -
Determine the Salesforce experience that the Navigate Action directs to by selecting
a PageReference type.
PageReference Type
Description
Task Documentation
App
Direct users from an Omniscript to a standard App, a custom App, or a page within an App. Connected apps aren’t supported.
Component
Navigate from an Omniscript to an Aura or Lightning web component.
Current Page
Trigger a page update on the Current Page after a user completes an Omniscript.
Knowledge Article
Display a Knowledge Article in an Omniscript.
Login or Logout
Direct users from an Omniscript to a Community Login or Logout page.
Named Page
Navigate from an Omniscript to a Named Page or a Community Named Page.
Navigation Item
Navigate from an Omniscript to a page that displays mapped content on a CustomTab.
Object
Navigate from an Omniscript to a standard or custom Object page.
Omniscript by pageReference Type
Navigate to an Omniscript by using a Vlocity Omniscript pageReference type.
Record
Navigate from an Omniscript to a Record page.
Record Relationship
Navigate from an Omniscript to a page that interacts with a Record Relationship.
Restart Omniscript
Navigate to a new instance of the same Omniscript that resets the Omniscript data.
Web Page
Open an external Web page from an Omniscript.
NoteIn the LWC Omniscript Designer, the Navigate Action's JSON prop set doesn't contain every property from the Properties section. To add a property, edit the JSON. If a corresponding property exists, it appears in the UI. Don’t edit these properties when using the Edit JSON feature:
- disOnTplt
- iconPositionOptions
- loginActionOptions
- objectActionOptions
- recordActionOptions
- replaceOptions
- targetLWCLayoutOptions
- targetTypeOptions
- variantOptions
