Naming Conventions in OmniStudio

Streamline App Development with Salesforce Omnistudio

OmniStudio Naming Conventions refer to the guidelines and best practices for naming various elements in OmniStudio, such as DataRaptors, Integration Procedures, Flows, and other components. Here are some general guidelines for naming these elements in OmniStudio:

Use descriptive and meaningful names: Choose names that accurately describe the purpose or function of the element. Avoid generic or vague names that may not convey the intended meaning.

Follow a consistent naming convention: Consistency in naming conventions, including Salesforce Omnistudio, makes it easier to locate and manage elements across different projects. You can follow a specific naming convention, such as using a prefix or suffix to identify the type of element.

Use camel case or underscores: Use camel case or underscores to separate words in names. For example, “customerAddress” or “customer_address“.

Avoid using special characters or spaces: Using special characters or spaces in names may cause issues with certain systems or platforms. Stick to alphanumeric characters, underscores, and hyphens.

Keep names concise and readable: Avoid using overly long names that are difficult to read or understand. Aim for names that are concise and easily readable.

OmniScripts

TypeSubtypeLanguage is a naming convention used in OmniScript, where the Type, SubType, and Language are combined to create a unique identifier that becomes the name of a compiled Lightning web component. The Type and SubType can only contain letters and numbers, without any spaces or underscores, and cannot exceed 104 characters in length.

For instance, if an OmniScript has a Type of “application”, a SubType of “Create”, and a Language of “English”, it will generate an LWC with the name “applicationCreateEnglish“. This naming convention allows for easy identification and management of compiled components in OmniScript.

DataRaptors

When it comes to naming the DataRaptor Interface, it is essential to keep it unique. The Interface Name can comprise letters and numbers, dashes, and underscores, but should not include spaces. This ensures that the Interface Name is easily recognizable and can be managed effectively.

Integration Procedure

Type_SubType is a naming convention used to create a unique identifier for an Integration Procedure. The convention involves joining the Type and SubType using an underscore, without any spaces. The Type and SubType can contain letters, numbers, and special characters, enabling you to create a unique identifier that is easy to remember and manage.

For example, suppose your Integration Procedure has a Type of “Application” and a SubType of “Recalculation”. In that case, the naming convention will create a unique identifier of “Application_Recalculation”. This convention allows for easy identification and calling of Integration Procedures.

FlexCards

In OmniCards, the combination of Name and Author must be unique within your Org. The Name and Author can consist of letters, numbers, and underscores, must begin with a letter, cannot include spaces or end with an underscore, and must not have two consecutive underscores. This naming convention ensures that the Name and Author are easily identifiable and managed within your Org, without any naming conflicts.

I hope this information is helpful for you.