Activate and Deploy an LWC Omniscript (Managed Package)

For the managed package runtime, activate and deploy Omniscripts to make them available to Experience sites, Lightning pages, custom LWCs, and Lightning tabs.

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

  1. In an Omniscript, click Activate to activate and deploy the Omniscript automatically.
  2. (Optional) Click Deactivate and then Activate to redeploy the Omniscript and apply updates or resolve a deployment issue.
  3. (Optional) In the Classic Designer only, if there is an issue with the deployment, redeploy the Omniscript by clicking Deploy LWC in the Script Configuration properties.

    Ensure that the Omniscript is active, and then click Deploy LWC to redeploy the Omniscript.

  4. After deploying your Omniscript, launch it from one of these experiences:

    Experience

    Description

    Lightning pages

    Launch an Omniscript from a Lightning page the using Omniscript's generated LWC, or the Vlocity LWC Omniscript Wrapper component.

    Experience pages

    Launch an Omniscript from an Experience page using Omniscript's generated LWC, or the Vlocity LWC Omniscript Wrapper component.

    Embedded inside of a custom component

    Launch an Omniscript from a custom Lightning web component by embedding the Omniscript's LWC.

    Off-Platform

    Run Omniscripts off-platform using OmniOut. Available beginning with Vlocity Insurance and Health and Vlocity CME Summer ’20.

  5. (Optional) If an error occurs when an Omniscript initially loads, in the Omniscript, click Deactivate and then Activate to redeploy the Omniscript.
  6. (Optional) Map deployment errors using the Error Handling Framework. Available beginning with Vlocity Insurance and Health Winter ’20 and Vlocity CME Fall ’20 .

    Error Mapping Example:

    Original error

    image

    Error Message Mapping a Path and Value to a new message

    image

    New error message

    image
  7. (Optional) Click the dropdown arrow, and then click Download LWC to view the metadata for the Omniscript.