Loading
Salesforce Enforces New Security Requirements in Summer 2026Read More
Done Action (Managed Package)

Done Action (Managed Package)

For the managed package runtime, the Done Action ends the Omniscript and returns the user either to where the script was launched or a custom URL. This page explains the settings to configure for the Done Action.

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

Note
Note

LWC Omniscripts do not support the Done Action. For information on how to navigate from an LWC Omniscript, see Navigate Action (Managed Package).

  • Option Source:

    • To redirect to a Salesforce object, select SObject.

    • To redirect to a URL, select URL.

    • To redirect to an HTML template, select Redirect.

  • Source:

    • If redirecting to an SObject, enter %ContextId% to redirect to the record from which the script launched.

    • If redirecting to a URL, enter the page and parameters. For example, MyTestPage?Id=%ContextId% would redirect to an internal page and http://www.vlocity.com will redirect to an external page.

      Note
      Note

      Beginning with Vlocity Summer '19, you can pass percentage signs in the URL by replacing the percentage sign in the URL with the variable $Vlocity.Percent.

    • Beginning with Vlocity Insurance and Vlocity Health Summer 2018, when redirecting to a Visualforce page URL from a Lightning container, use the ltng: prefix. For example, ltng:/apex/CustomVFPage will redirect to a Visualforce page.

    • Beginning with Vlocity Insurance and Vlocity Health Summer 2018, when redirecting to a Lightning or Lightning Community page URL, apply the ltngpage: prefix. For example, ltngpage:/Home will redirect to the community home page.

  • Redirect Page Name and Redirect Template URL:

    • If you selected Redirect, enter the page name and template URL that the Omniscript will redirect to when the action runs into the Redirect Page Name and Redirect Template URL fields.

  • Outcome:

  • Console Tab Label:

    • Modifies the text that displays in the label of the console tab. By default, this is set to New.

  • openInPrimaryTab: Omniscript's open in SubTabs by default. Make the Done Action open a Primary tab by taking these steps:

    1. In the Done Action, click Edit JSON.

    2. Set the openInPrimaryTab property to true.

      "openInPrimaryTab": true

Navigate Action Functionality Map

Done Action

Navigate Action

Configuration Notes

Option Source: Redirect

Target a component.

Example Configuration:

PageReference Type: Current Page

Target Params: c__target=myCancelComponent

n/a

Option Source: SObject

PageReference Type: Record

Use a merge field in the Navigate Action’s Record Id configuration to target a specific record, otherwise navigate to an Object Level page using the Object PageReference Type

Option Source: URL

PageReference Type: Web Page

use a URL to navigate when referencing resources outside of salesforce. Otherwise use one of the more specific PageReference types.

Source

Use Merge fields in the Navigate Action’s configuration.

n/a

Redirect Page Name

n/a

n/a

Redirect Template URL

n/a

n/a

Console Tab Label

Use the c__tabLabel and c__tabIcon parameters in the Navigate Action’s Target Params field.

Currently, it is not possible to control where the tab is opened.

Outcome

n/a

n/a

Window Post Message? / Session Storage Message?

LWC PubSub Message?

Communicate with other components using the LWC PubSub Message configuration on the Navigate Action.

 
Loading
Salesforce Help | Article