Navigate Action Properties (Managed Package)

For the managed package runtime, this page contains information about Navigate Action Properties.

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

Note

In 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

Property	Description
Button Variant	If the Navigate Action renders in a Step, determines the style of the button: brand — Uses a brand-specific fill color to indicate a primary action. outline-brand — Uses a brand-specific outline color to indicate a primary action. neutral — Generic button. success — Uses a green fill to indicate success. destructive — Uses a red fill to indicate a destructive action to the user, like permanently erasing data. text-destructive — Uses red text to indicate a destructive action to the user, like permanently erasing data. inverse — Uses a white outline and text to be visible on a dark background. link — Highlighted and underlined to indicate navigation to a page.
Icon Name	Name of the icon for the button.
Page Reference Type	Select the PageReference sObject type: App — Navigates to an App page. Component — Navigates to a Lightning Web Component. Community Named Page — Navigates to a Community Named Page. Current Page — Performs an action on the current page. Knowledge Article — Navigates to a knowledge article. Login — Navigates to a Login or Logout. Named Page — Navigates to the page with the specified name. Navigation Item — Navigates to a Custom Tab. Visualforce tabs, web tabs, Lightning Pages, and Lightning Component tabs are supported. Object — Navigates to an sObject page. Record — Navigates to an sObject record page. Record Relationship — Navigates to a list of records related to the specified record. Web Page — Navigates to an external web page. Vlocity Omniscript — Navigates to a Vlocity Omniscript.
Replace Existing Page in Browser History	Specifies that the page to which this action navigates replaces the current page in the browser history. If this property is checked, users can't navigate back to the Omniscript.
App Name	The appId, or the appDeveloperName with the appropriate namespace. See Navigate to an App (Managed Package).
Component Name	Name of the Lightning Web Component in the format `namespace__componentName`, where namespace is the namespace of your package. This field supports Merge fields.
Target Parameters	Additional parameters for the page.
Article URL	URL of the Knowledge Article.
Article Type	Type of the Knowledge Article.
Page Name	Name of the Named Page.
Tab Name	Name of the Custom Tab.
Object API Name	Name of the sObject. For custom objects, include the namespace, for example vlocity_ins__PartyRelationship__c.
Object Action	Page for the action to perform on the sObject: Home — Displays sObject information. List — Lists sObject records. New — Opens the window for creating a new sObject.
Filter Name	Text to filter the List of sObject records.
Record Action	Page for the action to perform on the sObject record: Clone — Opens the window for cloning the record. Edit — Opens the window for editing the record. View — Displays sObject record information.
Relationship API Name	Name of the relationship. For standard objects, the relationship is usually an Id reference such as AccountId. For custom objects, the relationship is usually the name of the related object with the __c suffix changed to __r.
Replace	If checked, the pageReference replaces the existing entry in the browser history, and disables the user from navigating back to the Omniscript. In a console context, the target replaces the current tab instead of opening a new tab.
Record ID	Id of the sObject record.
Web URL	URL of the external Web Page.
LWC Omniscript	Name of the Omniscript using the syntax typeSubTypeLanguage.
Omniscript Layout	Layout for Omniscript rendering, either Newport for non-LWC or Lightning for LWC.
Omniscript Prefill	Parameters to prefill the Omniscript in URL query string format. Parameters must have a `c__` prefix. This field supports Merge fields. For example: `c__firstName=%firstName%`.
Pub/Sub	Enables the Omniscript to send messages to separate Lightning web components. After checking this property, specify a Message key-value pair.