Custom LWC Element

Add a custom Lightning web component that does not extend an Omniscript element component to an Omniscript using the Custom LWC element.

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

Note
Note

Use Custom LWC Elements in a Step and a non-repeatable Block element that is not nested.

  1. From the elements panel, drag a Custom LWC element to the canvas.
  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. Select Standalone LWC if your custom component does not extend the OmniscriptBaseMixin component.
  5. 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%.

  • Embed Flexcards in an Omniscript
    Embed a Flexcard Lightning Web Component in an Omniscript by using the Custom LWC element. Flexcards can receive data from the Omniscript and perform any action available in the Flexcard.