Open Other Pages from Omniscripts with the Navigate Action

To open various Salesforce pages, apps, and resources from Omniscript, use the Navigate element.

1. From the elements panel, drag the Navigate action element to the canvas.
   • If the Navigate Action renders in a Step, it becomes a clickable button.
   • If the Navigate Action is between Steps, it fires automatically.
2. If the Navigate Action renders in a Step, select the button style.
   1. 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.
   2. Display an SLDS Icon in the button.
      For example, to add the standard_account Icon, enter Standard:Account.
3. If desired, replace the existing entry in the browser history by enabling the Replace property.
   If the Replace property is enabled, users can’t navigate back to the Omniscript.

   

   Note

   By default, a Navigate Action in a Console App opens the page reference type in a new subtab. If you use more than one Navigate Action, only the first navigation action redirects to a new tab. Even if the Replace property is disabled, subsequent Navigate Actions replace the tab.

   But if the Replace property is disabled, the page reference doesn’t replace existing entries in the browser history. Users can navigate back and forth between Omniscripts in the same 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.

4. To send messages from the Omniscript to separate Lightning web components, use Pub/Sub messages 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__ContextId parameter to a second Omniscript as c__ContextId=ContextId. A Navigate Action in the second Omniscript passes the parameter to a third Omniscript as c__ContextId=%ContextId%. All Navigate Actions must continue to pass the parameter to subsequent Omniscripts for as long as the parameter is needed.
5. Determine the Salesforce experience that the Navigate Action directs to by selecting a page reference 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.	Navigate to an App
   Component	Navigate from an Omniscript to a Lightning web component.	Navigate to a Component
   Current Page	Trigger a page update on the Current Page after a user completes an Omniscript.	Navigate to the Current Page
   Knowledge Article	Display a Knowledge Article in an Omniscript.	Navigate to a Knowledge Article
   Login or Logout	Direct users from an Omniscript to a Community Login or Logout page.	Navigate to an Experience Cloud Login or Logout
   Named Page	Navigate from an Omniscript to a Named Page or a Community Named Page.	Navigate to a Named Page or Community Named Page
   Navigation Item	Navigate from an Omniscript to a page that displays mapped content on a CustomTab.	Navigate to a Navigation Item
   Object	Navigate from an Omniscript to a standard or custom Object page.	Navigate to an Object Page
   Omniscript by pageReference Type	Navigate to an Omniscript by using a page reference type.	Navigate to an Omniscript by Using a Page Reference Type
   Omniscript by custom Lightning web component	Navigate to an Omniscript by using a custom Lightning web component.	Navigate to an Omniscript by Using a Custom Lightning Web Component
   Record	Navigate from an Omniscript to a Record page.	Navigate to a Record Page
   Record Relationship	Navigate from an Omniscript to a page that interacts with a Record Relationship.	Navigate to a Record Relationship Page
   Restart Omniscript	Navigate to a new instance of the same Omniscript that resets the Omniscript data.	Restart an Omniscript
   Web Page	Open an external Web page from an Omniscript.	Navigate to a Web Page

{"type": "standard__navItemPage","attributes": {"apiName": "standard__Account"}}