Custom LWC Element (Managed Package)

For the managed package runtime, add a custom Lightning web component that does not extend an Omniscript element component to an Omniscript using the Custom LWC element.

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

Note

Use Custom LWC Elements in a Step, and, beginning with Vlocity Insurance and Health and Vlocity CME Summer '20, a non-repeatable Block element that is not nested.

Before You Begin

Create a custom LWC. The Custom LWC element supports these two types of custom Lightning web components:

• Components that extend the OmniScriptBaseMixin component. For more information, see Extend the OmniScriptBaseMixin Component (Managed Package).

• Standalone components that run independently from Omniscript. For more information, see Create a Standalone Custom Lightning Web Component (Managed Package).

1. In an Omniscript, add the Custom LWC element.
2. In Name and Field Label, enter a name and display name for the Custom LWC element.
3. In the Lightning Web Component Name field, enter the name of your custom Lightning web component.
4. (Optional) Check Standalone LWC if your custom component does not extend the OmniScriptBaseMixin component.
5. (Optional) Pass property values into the Omniscript by entering values in these property fields:

   Property	Description
   Property Name	Enter a property name using the HTML attribute format to pass it into the custom component. For example, the property recordId converts to the HTML attribute record-id.
   Property Source	Enter a value to pass in the property. Values may use merge field syntax to pass a JSON node. For example, to pass the JSON node ContextId, enter %ContextId%. To avoid Flexcard loading issues, don’t use the merge field syntax to reference a custom LWC. For example, if the name of the LWC is customlwc1, don’t use %customlwc1%.

6. (Optional) Activate and preview the Omniscript to view your custom Lightning web component.