--- schema_version: "1" id: 13a20311dd1020b8f99e730dc66eec3bebefd79608bcedf360820b6a81ce96f2 title: Enable Omnistudio Metadata API Support collection: admin version: current locale: en-us portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/os_enable_omnistudio_metadata_api_support.md canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.os_enable_omnistudio_metadata_api_support.htm&release=264.0.0&type=5 source_site: help.salesforce.com content_type: documentation content_hash: c40c597178dda97c7c814a4fee37b099be39d57a424a3a722ed12b1115fc47de description: 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. products: - Omnistudio release: "264" --- # 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. Before You Begin - Make sure that your org uses the standard object model. See [Does Your Org Use Custom or Standard Objects?](https://help.salesforce.com/s/articleView?id=xcloud.os_does_your_org_use_custom_or_standard_objects.htm&type=5&language=en_US) . - Make sure that your components have valid unique names. - When you select the Omnistudio Metadata setting, a process runs that validates your components' names. If one name is invalid, the setting isn’t enabled, and you receive an email. - The fields used to create uniques must include only alphanumeric characters and can’t include spaces or special characters such as underscores. After changing the names, update the references. The fields used to create the unique names vary by component. For more details, see [Omnistudio Naming Conventions](https://help.salesforce.com/s/articleView?id=xcloud.os_omnistudio_naming_conventions.htm&type=5&language=en_US). | Component | Object | Fields That Create Unique Name | | --- | --- | --- | | Integration Procedures | OmniProcess | Type + Subtype | | Omnistudio Data Mappers | OmniDataTransform | Name | | Omniscripts | OmniProcess | Type + Subtype + Language | | Flexcards | OmniUiCard | Name | - Make sure that the Omnistudio configuration tables don’t contain any records in these objects: - OmniUiCardConfig - OmniScriptConfig - OmniIntegrationProcConfig - OmniDataTransformConfig Any existing records in these objects can prevent the setting from being enabled. Log in to the Developer Console and run a Select query to find any records on the objects. If there are records in these objects: 1. Back up all Omnistudio components (OmniProcess, OmniDataTransform, OmniUiCard) by exporting all the records. For example, in the Omniscripts tab, select **Type** and click **Export**. 2. After the backup is complete, manually delete all records returned by the SOQL queries for the respective configuration objects. You can use the backups later to restore standard Omnistudio components if they were removed during the configuration table cleanup process. This scenario is rare. - If you're migrating from the custom data model to the standard data model, run the Omnistudio Migration Tool and update references. See [Migration Process from Omnistudio for Managed Packages to Omnistudio](https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_omnistudio_custom_objects_to_standard_objects.htm&type=5&language=en_US). ![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_installation-264-0-0-production-enus/16286473-ea8d-4159-8e40-85f7fcf16314/images/icon_note.png) Note The pre-validation run ensures that all data is validated before enabling Metadata API. This process prevents the partial creation of metadata. ![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_installation-264-0-0-production-enus/16286473-ea8d-4159-8e40-85f7fcf16314/images/icon_note.png) Note If you use the Salesforce Industries Communications, Media, and Energy (CME), Insurance, or Public Sector package: Before turning off the Managed Package Runtime setting, verify that the standard runtime supports each component you use. Check each component’s Omnistudio Standard Runtime certification status in [Communications, Media, and Energy (CME) Support for Omnistudio Standard Runtime](https://help.salesforce.com/s/articleView?id=ind.cme_support_for_omnistudio_standard_runtime.htm&language=en_US). ![Warning](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_installation-264-0-0-production-enus/16286473-ea8d-4159-8e40-85f7fcf16314/images/icon_warning.png) Warning After you enable this setting, you can’t disable it.

Required Versions

Available beginning Spring '22 and later releases for customers on the standard object model.
1. In Setup, in the Quick Find box, enter Omnistudio Settings and select **Omnistudio Settings**. 2. Enable **Omnistudio Metadata**. 3. Check your email for confirmation that Omnistudio Metadata is enabled or for notification of errors. If there are errors, the Omnistudio Metadata setting initially appears enabled but is then disabled. See [Troubleshooting Errors After Enabling Omnistudio Metadata](https://help.salesforce.com/s/articleView?id=xcloud.os_metadata_setting_troubleshooting.htm&release=264.0.0&type=5 "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."). 4. To allow users other than admins to create, update, or delete Omnistudio components, enable object permissions in user profiles or permission sets for the Omnistudio configuration BPOs. - OmniUiCardConfig - OmniScriptConfig - OmniIntegrationProcConfig - OmniDataTransformConfig By default, the standard profile has read-only access.