You are here:
Omnistudio Settings
Enable settings applicable to the entire Omnistudio product suite from the Omnistudio Settings page in your org's Setup. For example, enable Omnistudio metadata API support from the Omnistudio Metadata setting.
Required Versions |
|---|
Available beginning Spring '22 and later releases for customers on the standard object model. |
- Enable Omnistudio Metadata API Support
To deploy and retrieve Omnistudio standard objects with Salesforce Metadata API, enable the Omnistudio Metadata setting. Until you enable this setting, you can't use Metadata API to deploy Omnistudio components. Future enhancements will depend on this setting and completion of the migration. After this setting is enabled, Omnistudio checks for valid unique names and creates entries for existing components from the standard objects in the Omnistudio configuration tables. Also, for each new component, Omnistudio creates an entry in the Omnistudio configuration tables. Omnistudio Metadata supports OmniProcess (Omniscript and Integration Procedure), OmniDataTransform (Omnistudio Data Mapper), and OmniUiCard (Flexcard) standard objects. This setting doesn't apply to Omnistudio custom objects. - Troubleshooting Errors After Enabling Omnistudio Metadata
If you see an error after enabling the Omnistudio Metadata setting, check for invalid names for components, Omnistudio Data Mapper version numbers, and populated configuration tables. - Disable the Managed Package Runtime and Deploy Custom Lightning Web Components
If you migrate from Omnistudio for Managed Packages to Omnistudio, disable the Managed Package Runtime setting. Before you disable this setting, ensure that all Flexcards and Omniscripts in use that are key to your business processes are supported in standard objects. If you add or edit an Omniscript or Flexcard after disabling this setting and use custom components to load these Omniscripts or Flexcards in Lightning App Builders and communities, the changes won’t be reflected unless you replace them with standard components. To update your existing Flexcards and Omniscripts in Lightning App Builders and communities without using the standard components, enable the Deploy Custom Lightning Web Components setting. - Disable the Managed Package Designer
To use the Omnistudio standard designer in your org, disable the Managed Package Designer setting. - Omnistudio SLDS 2 Theme
Salesforce provides the Salesforce Lightning Design System (SLDS) as a theme that offers resources for building applications consistent with the Salesforce Lightning principles, design language, and best practices. Starting in Spring ‘25, Salesforce provides the SLDS 2 theme, which is the enhanced version of SLDS with updates to the CSS. With the introduction of the Omnistudio SLDS 2 theme, you can use the advantages of SLDS, SLDS 2, and its enhanced user experience (UI) to improve the UI of your Omnistudio applications at runtime. The Omnistudio SLDS 2 theme fully aligns with the standard SLDS and SLDS 2 theme in your Salesforce org. - Enable Omnistudio Data Mapper Versioning
Manage different versions of your Data Mappers by enabling the Data Mapper Versioning setting. Enabling this feature activates existing standard Data Mappers as version 1 and prevents the editing of active components to ensure consistency. Your implementation automatically uses the active version of a referenced Data Mapper. By default, the Data Mapper Versioning setting is disabled. - Enable Autogenerated Numbers
To set up a numbering system and autogenerate numbers for various use cases, enable the Omni Global Auto Number setting on the Omnistudio Settings page. - Enable Enhanced Runtime Performance of Components
Improve component runtime performance by turning on Enhanced Runtime Performance on the Omnistudio Settings page. This setting ensures that Omnistudio communicates with the Salesforce Platform with in-platform capabilities instead of through Apex calls. It also allows Omnistudio components to be executed in user mode. User mode respects the access levels of the person performing an operation.

