How to Launch (Managed Package)

For the managed package runtime, make an active Omniscript available for launch in one of four ways: as a standalone Lightning web component in a Lightning page, as an embedded link in another LWC, as a URL, or using an Aura wrapper.

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

Standalone

The Omniscript is compiled and deployed as a standalone Lightning web component. Open a Lightning page in the Lightning App Builder, find the LWC for the Omniscript in the Custom Components section, and drag it onto the page.

Embedded

You can embed the component into any Aura or LWC component using the component tag. The component attribute prefill accepts a String or JavaScript object. Use prefill to specify input for the Omniscript, such as context ID or an Omnistudio Data Mapper that populates the Omniscript.

Examples

<c-type--sub-type-english prefill={prefill} layout="lightning"></c-type--sub-type-english>

<c-type--sub-type-english prefill='\{"ContextId":"abc","otherParam":"FAQ"}' layout="newport"></c-type--sub-type-english>

URL

Lightning URL Example

https://my_org.force.com/lightning/cmp/my_org__vlocityLWCOmniWrapper?c__target=my_org:typeSubTypeEnglish&c__layout=lightning&c__tabIcon=custom:custom18

Newport URL Example

https://my_org.force.com/lightning/cmp/my_org__vlocityLWCOmniWrapper?c__target=my_org:typeSubTypeEnglish&c__layout=newport&c__tabIcon=custom:custom18

Aura Wrapper

The Omniscript can be launched using a prebuilt Aura component. You can pass additional parameters into the Omniscript.

Example

this[NavigationMixin.Navigate]({
    type: 'standard__component',
    attributes: {
        componentName: 'my_org__vlocityLWCOmniWrapper'
    },
    state: {
        c__target: 'c:testSubTypeEnglish',
        c__layout: 'lightning', // or 'newport'
        c__tabIcon: 'custom:custom18'
    }
})