---
schema_version: "1"
id: 151e9827190c78dc023cdc501197b8dbb0bd4d5c7cda24321423598d7ade6e45
title: LWC Omniscript ReadMe Reference (Managed Package)
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/os_lwc_omniscript_readme_reference.md
canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.os_lwc_omniscript_readme_reference.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: 44cff57bafff5dc31dc4cbeeeacbc2022b0980063e6ff550341f62f6ec7d6703
description: For the managed package runtime, this page lists the Lightning web components ReadMes available for LWC Omniscripts. Extend Lightning web components to add custom behavior and styling.
products:
  - Omnistudio
release: "264"
---
# LWC Omniscript ReadMe Reference (Managed Package)

For the managed package runtime, this page lists the Lightning web components ReadMes available for LWC Omniscripts. Extend Lightning web components to add custom behavior and styling.

![Managed Package app icon](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_for_managed_packages-264-0-0-production-enus/aa2554ec-624a-4ee6-8da4-6435670e6e62/resources-global/_corporate/images/managedpackageicon.png) This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see [Omnistudio Help](https://help.salesforce.com/s/articleView?id=xcloud.os_omnistudio_standard.htm&language=en_US).

For information on customizing Omniscript LWCs see [Create a Custom Lightning Web Component for Omniscript (Managed Package)](https://help.salesforce.com/s/articleView?id=xcloud.os_create_a_custom_lightning_web_component_for_omniscript.htm&release=264.0.0&type=5 "For the managed package runtime, add custom HTML, JavaScript, and CSS to an Omniscript by creating a custom Lightning web component."). For information on configuring Omniscript elements, see [Omniscript Element Reference (Managed Package)](https://help.salesforce.com/s/articleView?id=xcloud.os_omniscript_element_reference.htm&release=264.0.0&type=5 "For the managed package runtime, this guide contains explanations of the different elements that can be added to an Omniscript, such as Omnistudio Data Mapper actions. Each element uses an extendable Lightning web component or customizable HTML template. There are separate templates used for Lightning Player and Classic Player. Classic Player is no longer supported, however, Classic templates for Summer 17 and v15 are still available."). To view ReadMes for elements, see [Set Up Your Environment to Customize Omniscript Elements](https://help.salesforce.com/s/articleView?id=xcloud.os_standard_set_up_your_environment_for_customizing_omniscript_elements.htm&type=5&language=en_US). Though this documentation points to Omnistudio Help, the steps involved are the same for the managed package.

## Action Element ReadMes

These are the LWC ReadMes for Omniscript Action elements:

- Omnistudio Data Mapper Extract Action
- Data Mapper Turbo Extract Action
- Data Mapper Post Action
- Data Mapper Transform Action
- DocuSign Envelope Action
- DocuSign Signature Action
- Email Action
- HTTP Action
- Integration Procedure Action
- Navigate Action
- Remote Action
- Set Values Action

## Base Component ReadMes

LWC Omniscript elements extend the base components in this table.

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d299652e166">
              <p style="margin-bottom:0;">LWC</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d299652e172">
              <p style="margin-bottom:0;">Description</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="LWC" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e166 ">
              <p style="margin-bottom:0;"> Omniscript
                Atomic Element </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e172 ">
              <p style="margin-bottom:0;">The base component for Omniscript Input elements.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="LWC" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e166 ">
              <p style="margin-bottom:0;"> Omniscript
                Base Action </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e172 ">
              <p style="margin-bottom:0;">The base component for Omniscript Action elements.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="LWC" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e166 ">
              <p style="margin-bottom:0;"> Omniscript
                Base Element </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e172 ">
              <p style="margin-bottom:0;">The base component for LWC Omniscript.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="LWC" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e166 ">
              <p style="margin-bottom:0;"> Omniscript
                Group Element </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e172 ">
              <p style="margin-bottom:0;">The base component for Omniscript Group elements.</p>
            </td>

          </tr>
        </tbody>
      </table>

## Display Element ReadMes

These are the LWC ReadMes for Omniscript Display elements:

- Line Break
- Text Block

## Function Element ReadMes

These are the LWC ReadMes for Omniscript Function elements:

- Formula
- Messaging

## General ReadMes

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d299652e310">
              <p style="margin-bottom:0;">LWC</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d299652e316">
              <p style="margin-bottom:0;">Description</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="LWC" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e310 ">
              <p style="margin-bottom:0;"> Omniscript Knowledge Base ReadMe </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e316 ">
              <p style="margin-bottom:0;">LWC for the Omniscript Knowledge component. The knowledge component enables users to search for Lightning Knowledge articles.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="LWC" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e310 ">
              <p style="margin-bottom:0;"> Omniscript Modal </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e316 ">
              <p style="margin-bottom:0;">LWC for the modal that displays in Omniscript.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="LWC" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e310 ">
              <p style="margin-bottom:0;"> Omniscript Step Chart </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e316 ">
              <p style="margin-bottom:0;">LWC for the Omniscript Step Chart. See
                .</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="LWC" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e310 ">
              <p style="margin-bottom:0;"> Omniscript Step Chart Items </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e316 ">
              <p style="margin-bottom:0;">LWC for the Omniscript Step Chart Items. The Step Chart Items component controls the functionality of the Omniscript Step Chart.</p>
            </td>

          </tr>
        </tbody>
      </table>

## Group Element Readmes

These are the LWC ReadMes for Omniscript Group elements:

- Block
- Edit Block
- Radio Group
- Step
- Type Ahead Block
    
    - Places Type Ahead
    - Type Ahead Action
    - Type Ahead Block

## Input Element ReadMes

These are the LWC ReadMes for Omniscript Input Elements:

- Checkbox
- Currency
- Custom LWC
- Date
- Date/Time
- Email
- File
- Image
- Lookup
- Multi-select
- Number
- Password
- Radio
- Range
- Select
- Telephone
- Text
- Text Area
- Time
- URL

## Mixin ReadMes

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d299652e603">
              <p style="margin-bottom:0;">LWC</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d299652e609">
              <p style="margin-bottom:0;">Description</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="LWC" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e603 ">
              <p style="margin-bottom:0;"> Omniscript
                Base Mixin </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e609 ">
              <p style="margin-bottom:0;">Enables custom LWCs that do not override an Omniscript element's LWC to interact with Omniscript through the Custom LWC element. See <a href="https://help.salesforce.com/s/articleView?id=xcloud.os_extend_the_omniscriptbasemixin_component.htm&amp;release=264.0.0&amp;type=5" title="For the managed package runtime, enable a custom Lightning web component to interact with an Omniscript by extending the OmniScriptBaseMixin component. The OmniScriptBaseMixin includes methods to update an Omniscript's data JSON, pass parameters, and more.">Extend the OmniScriptBaseMixin Component (Managed Package)</a>.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="LWC" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e603 ">
              <p style="margin-bottom:0;"> Omniscript
                Options Mixin </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e609 ">
              <p style="margin-bottom:0;">Provides options logic for any LWC in Omniscript.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="LWC" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e603 ">
              <p style="margin-bottom:0;"> Omniscript
                Validation </p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d299652e609 ">
              <p style="margin-bottom:0;">Provides validation options to any LWC in Omniscript.</p>
            </td>

          </tr>
        </tbody>
      </table>