You are here:
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.
Product |
sObject |
Unique Name |
|---|---|---|
Integration Procedures |
Omni Process |
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. For example, Type=Auto and SubType=CreateUpdateQuote create a unique identifier Auto_CreateUpdateQuote. |
Data Mappers |
Omni Data Transformation |
Interface Name: The Data Mapper Interface Name must be unique. The Interface Name can contain letters, numbers, and dashes, but no spaces. |
Omniscripts |
Omni Process |
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. For example, an Omniscript where Type=account, SubType=Create, and Language=English generates an LWC named accountCreateEnglish. |
Flexcards |
Omni Ui Card |
Name + Author: The combination of the card Name and Author 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. |
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.
