---
schema_version: "1"
id: 6ac39363ddf00e9ed31a1b89987542285b8dced94bf49369d5dcbcb6770dfae2
title: Navigate Action Properties (Managed Package)
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/os_navigate_action_properties.md
canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.os_navigate_action_properties.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: 712ea3ae032bad51f8e7b56a81caca493703ca93f1c178c0560c27329c9d8bf6
description: For the managed package runtime, this page contains information about Navigate Action Properties.
products:
  - Omnistudio
release: "264"
---
# Navigate Action Properties (Managed Package)

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

![Managed Package app icon](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_for_managed_packages-264-0-0-production-enus/aa2554ec-624a-4ee6-8da4-6435670e6e62/resources-global/_corporate/images/managedpackageicon.png) This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see [Omnistudio Help](https://help.salesforce.com/s/articleView?id=xcloud.os_omnistudio_standard.htm&language=en_US).

![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_for_managed_packages-264-0-0-production-enus/aa2554ec-624a-4ee6-8da4-6435670e6e62/images/icon_note.png)

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

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
      <colgroup>
        <col>
        <col>
      </colgroup>
      <thead class="slds-text-title_caps ">
        <tr class="">
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d26151e82">
            <p style="margin-bottom:0;">Property</p>
          </th>
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d26151e88">
            <p style="margin-bottom:0;">Description</p>
          </th>
        </tr>
      </thead>
      <tbody>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Button Variant</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p>If the Navigate Action renders in a Step, determines the style of the button:</p>
            <ul>
              <li>
                <p>brand — Uses a brand-specific fill color to indicate a primary action.</p>
              </li>

              <li>
                <p>outline-brand — Uses a brand-specific outline color to indicate a primary action.</p>
              </li>

              <li>
                <p>neutral — Generic button.</p>
              </li>

              <li>
                <p>success — Uses a green fill to indicate success.</p>
              </li>

              <li>
                <p>destructive — Uses a red fill to indicate a destructive action to the user, like permanently erasing data.</p>
              </li>

              <li>
                <p>text-destructive — Uses red text to indicate a destructive action to the user, like permanently erasing data.</p>
              </li>

              <li>
                <p>inverse — Uses a white outline and text to be visible on a dark background.</p>
              </li>

              <li>
                <p>link — Highlighted and underlined to indicate navigation to a page.</p>
              </li>

            </ul>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Icon Name</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">Name of the icon for the button.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Page Reference Type</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p>Select the PageReference sObject type:</p>
            <ul>
              <li>
                <p>App — Navigates to an App page.</p>
              </li>

              <li>
                <p>Component — Navigates to a Lightning Web Component.</p>
              </li>

              <li>
                <p>Community Named Page — Navigates to a Community Named Page.</p>
              </li>

              <li>
                <p>Current Page — Performs an action on the current page.</p>
              </li>

              <li>
                <p>Knowledge Article — Navigates to a knowledge article.</p>
              </li>

              <li>
                <p>Login — Navigates to a Login or Logout.</p>
              </li>

              <li>
                <p>Named Page — Navigates to the page with the specified name.</p>
              </li>

              <li>
                <p>Navigation Item — Navigates to a Custom Tab. Visualforce tabs, web tabs, Lightning Pages, and Lightning Component tabs are supported.</p>
              </li>

              <li>
                <p>Object — Navigates to an sObject page.</p>
              </li>

              <li>
                <p>Record — Navigates to an sObject record page.</p>
              </li>

              <li>
                <p>Record Relationship — Navigates to a list of records related to the specified record.</p>
              </li>

              <li>
                <p>Web Page — Navigates to an external web page.</p>
              </li>

              <li>
                <p>Vlocity Omniscript — Navigates to a Vlocity Omniscript.</p>
              </li>

            </ul>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Replace Existing Page in Browser History</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">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.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">App Name</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">The <strong class="uicontrol">appId</strong>, or the
              <strong class="uicontrol">appDeveloperName</strong> with the appropriate namespace.
              See <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_navigate_to_an_app.htm&amp;release=264.0.0&amp;type=5" title="For the managed package runtime, beginning with Vlocity Insurance and Health Spring '20, Direct users from an Omniscript to a standard App, custom App, or a page within an App using Navigate Action's App PageReference Type.">Navigate to an App (Managed Package)</a>.
            </p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Component Name</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">Name of the Lightning Web Component in the format
              <kbd><var>namespace</var>__<var>componentName</var></kbd>,
              where <strong class="uicontrol">namespace</strong> is the <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_viewing_the_namespace_and_version_of_the_omnistudio_vlocity_package.htm&amp;release=264.0.0&amp;type=5" title="For the managed package runtime, to check the namespace and version of your Omnistudio for Managed Packages installation.">namespace</a> of your package. This field supports Merge fields.
            </p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Target Parameters</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">Additional parameters for the page.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Article URL</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">URL of the Knowledge Article.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Article Type</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">Type of the Knowledge Article.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Page Name</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">Name of the Named Page.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Tab Name</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">Name of the Custom Tab.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Object API Name</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">Name of the sObject. For custom objects, include the namespace, for example vlocity_ins__PartyRelationship__c.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Object Action</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p>Page for the action to perform on the sObject:</p>
            <ul>
              <li>
                <p>Home — Displays sObject information.</p>
              </li>

              <li>
                <p>List — Lists sObject records.</p>
              </li>

              <li>
                <p>New — Opens the window for creating a new sObject.</p>
              </li>

            </ul>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Filter Name</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">Text to filter the List of sObject records.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Record Action</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p>Page for the action to perform on the sObject record:</p>
            <ul>
              <li>
                <p>Clone — Opens the window for cloning the record.</p>
              </li>

              <li>
                <p>Edit — Opens the window for editing the record.</p>
              </li>

              <li>
                <p>View — Displays sObject record information.</p>
              </li>

            </ul>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Relationship API Name</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">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.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Replace</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">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.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Record ID</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">Id of the sObject record.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Web URL</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">URL of the external Web Page.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">LWC Omniscript</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">Name of the Omniscript using the syntax typeSubTypeLanguage.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Omniscript Layout</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">Layout for Omniscript rendering, either Newport for non-LWC or Lightning for LWC.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Omniscript Prefill</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">Parameters to prefill the Omniscript in URL query string format. Parameters must have a&nbsp;<code>c__</code>&nbsp;prefix. This field supports Merge fields. For example: <code>c__firstName=%firstName%</code>.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Property" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e82 ">
            <p style="margin-bottom:0;">
              <strong class="uicontrol">Pub/Sub</strong>
            </p>
          </td>

          <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d26151e88 ">
            <p style="margin-bottom:0;">Enables the Omniscript to send messages to separate Lightning web components. After checking this property, specify a Message key-value pair.</p>
          </td>

        </tr>
      </tbody>
    </table>