Enable Omnistudio Metadata API Support

Before You Begin

• Make sure that your org uses the standard object model. See Does Your Org Use Custom or Standard Objects? .
• 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.

    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.

Note

The pre-validation run ensures that all data is validated before enabling Metadata API. This process prevents the partial creation of metadata.

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.

Warning

After you enable this setting, you can’t disable it.