---
schema_version: "1"
id: 8a37dc32fd3d6283bd3c15132b36f2ea6f1754bd698f5f5b8478a823b0edfe71
title: Omnistudio Naming Conventions
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/os_omnistudio_naming_conventions.md
canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.os_omnistudio_naming_conventions.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: a76d0ce94bf3ce5c1e994f288d6bafee8a16f661c90d4869f60dfb52d1856f20
description: When creating an Omnistudio component, such as an Omnistudio Data Mapper, Flexcard, Integration Procedure, or an Omniscript, follow the naming conventions on this page.
products:
  - Omnistudio
release: "264"
---
# Omnistudio Naming Conventions

When creating an Omnistudio component, such as an Omnistudio Data Mapper, Flexcard, Integration Procedure, or an Omniscript, follow the naming conventions on this page.

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
      <colgroup>
        <col>
        <col>
        <col>
      </colgroup>
      <thead class="slds-text-title_caps ">
        <tr class="">
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d96916e35">
            <p style="margin-bottom:0;">Product</p>
          </th>
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d96916e41">
            <p style="margin-bottom:0;">sObject</p>
          </th>
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d96916e47">
            <p style="margin-bottom:0;">Unique Name</p>
          </th>
        </tr>
      </thead>
      <tbody>
        <tr class="">
          <td data-label="Product" class="slds-cell-wrap" style="vertical-align:top;" headers="d96916e35 ">
            <p style="margin-bottom:0;">Integration Procedures</p>
          </td>

          <td data-label="sObject" class="slds-cell-wrap" style="vertical-align:top;" headers="d96916e41 ">
            <p style="margin-bottom:0;">Omni Process</p>
          </td>

          <td data-label="Unique Name" class="slds-cell-wrap" style="vertical-align:top;" headers="d96916e47 ">
            <p>Type_SubType: The Type and SubType are joined by an underscore to create a unique
              identifier used to call the Integration Procedure. The Name Type and SubType can
              contain letters, numbers, and special characters, but no spaces.</p>
            <p style="margin-bottom:0;">For example, <kbd>Type=Auto</kbd> and
              <kbd>SubType=CreateUpdateQuote</kbd> create a unique identifier
              <kbd>Auto_CreateUpdateQuote</kbd>.
            </p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Product" class="slds-cell-wrap" style="vertical-align:top;" headers="d96916e35 ">
            <p style="margin-bottom:0;">Data Mappers</p>
          </td>

          <td data-label="sObject" class="slds-cell-wrap" style="vertical-align:top;" headers="d96916e41 ">
            <p style="margin-bottom:0;">Omni Data Transformation</p>
          </td>

          <td data-label="Unique Name" class="slds-cell-wrap" style="vertical-align:top;" headers="d96916e47 ">
            <p style="margin-bottom:0;">Interface Name: The Data Mapper Interface Name must be unique. The Interface Name
              can contain letters, numbers, and dashes, but no spaces.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Product" class="slds-cell-wrap" style="vertical-align:top;" headers="d96916e35 ">
            <p style="margin-bottom:0;">Omniscripts</p>
          </td>

          <td data-label="sObject" class="slds-cell-wrap" style="vertical-align:top;" headers="d96916e41 ">
            <p style="margin-bottom:0;">Omni Process</p>
          </td>

          <td data-label="Unique Name" class="slds-cell-wrap" style="vertical-align:top;" headers="d96916e47 ">
            <p>TypeSubtypeLanguage: Type, SubType, and Language combine to create a unique
              identifier that becomes the name of a compiled Omniscript's Lightning web component.
              The Type and SubType can contain letters and numbers, but no spaces or underscores
              and cannot exceed 104 characters.</p>
            <p style="margin-bottom:0;">For example, an Omniscript
              where&nbsp;<kbd>Type=account</kbd>,&nbsp;<kbd>SubType=Create</kbd>,
              and&nbsp;<kbd>Language=English</kbd>&nbsp;generates an LWC
              named&nbsp;<kbd>accountCreateEnglish</kbd>.</p>
          </td>

        </tr>
        <tr class="">
          <td data-label="Product" class="slds-cell-wrap" style="vertical-align:top;" headers="d96916e35 ">
            <p style="margin-bottom:0;">Flexcards</p>
          </td>

          <td data-label="sObject" class="slds-cell-wrap" style="vertical-align:top;" headers="d96916e41 ">
            <p style="margin-bottom:0;">Omni Ui Card</p>
          </td>

          <td data-label="Unique Name" class="slds-cell-wrap" style="vertical-align:top;" headers="d96916e47 ">
            <p style="margin-bottom:0;">Name + Author: The combination of the card&nbsp;Name&nbsp;and&nbsp;Author&nbsp;must be unique in your
              Org. Name and Author can only contain letters, numbers, and underscores, begin with
              a letter, not include spaces, not end with an underscore, and not contain two
              consecutive underscores. </p>
          </td>

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

## Reserved Words

These reserved words shouldn't be used in Flexcard names or element names:

- Action
- Data-element-label
- Data-action-key
- Data-element-label
- Data-action-element-class
- Flyout
- FlyoutType
- Tracking-obj
- Parent-Mergefields

## Omnistudio Metadata API Support

If you enable Omnistudio Metadata API support through Setup under Omnistudio Settings, Omnistudio component names can only include letters and numbers and cannot contain spaces or special characters such as underscores. With Omniscripts, the name may contain special characters. However, the unique combination of the Type, Subtype, and Language can't contain special characters.

After you enable Metadata API support, you won't be able to create a component whose unique name contains special characters.

#### See Also

- [Enable Omnistudio Metadata API Support](https://help.salesforce.com/s/articleView?id=xcloud.os_enable_omnistudio_metadata_api_support.htm&type=5&language=en_US)