How to Launch Omniscripts

Make an active Omniscript available for launch in one of three ways: as a standalone Lightning Web Component in a Lightning Web Page or as a URL.

Note On the How to Launch page in the Omniscript designer, the Newport URL and the code samples beginning with this[NavigationMixin.Navigate] don't apply to Omnistudio Omniscripts.

Note It is recommended that you use a standard Omnistudio component on a Lightning or Experience Cloud page. If you migrate from the Omnistudio managed package runtime to the standard runtime, you can create new versions of existing Omniscripts for standard runtime. Then, you can add those Omniscripts via the Process Automation section on the Lightning App Builder or Aura-based Experience Builder page. In cases where you're unable to create standard versions of your Omniscripts, you may use a standalone or embedded Omniscript as described here.

Standalone

Open a Lightning Web Page in the Lightning App Builder, find the LWC for the Omniscript in the Custom Components section, and drag it onto the page.

Note This feature applies only to the designer on a managed package in standard runtime.

Embedded

If you’re referencing an Omniscript on a Lightning Web Runtime (LWR) Experience Cloud site, you must use a wrapper component that takes in the name of the Omniscript you want to load at runtime, as shown. The type, subtype, and language attributes are mandatory. The Lightning theme is added by default. However, if you'd like to use the Newport theme instead, add the theme attribute as well.

Example

<namespace-omnistudio-standard-runtime-wrapper type={type}
                                           subtype={subtype}
                                           language={language}
                                           theme={theme} 
                                           inline={inline}
                                           inlinevariant={inlinevariant}
                                           inlinelabel={inlinelabel}
                                           direction={direction}
                                           record-id={recordId} 
                                           prefill={prefill} >
</namespace-omnistudio-standard-runtime-wrapper>

For embedding an Omniscript in an LWC on an Aura page, use this format.

Example

<namespace:omnistudioStandardRuntimeWrapper 
    type="type"
    subtype="subtype"  
    language="language">
</omnistudio:omnistudioStandardRuntimeWrapper>

URL

Newport URL Example

https://myorg.lightning.force.com/lightning/page/omnistudio/omniscript?omniscript__type=Type&omniscript__subType=SubType&omniscript__language=English&omniscript__theme=newport&omniscript__tabIcon=custom:custom_tab_icon&omniscript__tabLabel=custom_tab_label

Lightning URL Example

https://myorg.lightning.force.com/lightning/page/omnistudio/omniscript?omniscript__type=Type&omniscript__subType=SubType&omniscript__language=English&omniscript__theme=lightning&omniscript__tabIcon=custom:custom_tab_icon&omniscript__tabLabel=custom_tab_label