Requirements for Custom Lightning Web Components for Omniscripts

Review the requirements for making a custom Lightning web component compatible with Omnistudio Lightning web components.

• Custom Lightning web components extending the OmniscriptBaseMixin component cannot extend or override an Omniscript element Lightning web component.
• Custom Lightning web components extending the OmniscriptBaseMixin must use the Custom LWC input element in Omniscript. For more information about using the Custom LWC element, see Custom LWC Element.
• Custom Lightning Web Components don’t throw errors unless Debug Mode is enabled. For more information, see Debug Lightning Web Components.
• A standalone component cannot extend an Omniscript element's Lightning web component.
• A standalone component cannot extend the OmniscriptBaseMixin component.
• A standalone component can only interact with Omniscript through the omniscriptaggregate event.
• To make the custom Lightning web component compatible with Omnistudio Lightning web components, set the isExposed metadata tag to true in your XML configuration file:

  <isExposed>True</isExposed>

• To prevent JSON validation errors when passing data from Custom Lightning web components to Omnistudio Lightning web components, precede double quotes in the data with the backslash (\) escape character. Single quotes don't need to be escaped.
• Install the package with the custom components. See Set Up Your Environment to Customize Omniscript Elements.
• View all of the component's properties, attributes, and methods in the Omniscript ReadMe Reference.