--- schema_version: "1" id: 38164255c21bd1b8e214b9f96c05ace7becb938ecba7b0b6ec6c1df46f671471 title: Clean Metadata Deployment for Omnistudio collection: admin version: current locale: en-us portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/os_clean_metadata_deployment.md canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.os_clean_metadata_deployment.htm&release=264.0.0&type=5 source_site: help.salesforce.com content_type: documentation content_hash: 2fdf5b826487ca07c9db7149f8c73097a9c0d6bc729de66b7e8dde25c6857a2a description: Clean Metadata Deployment modernizes how you deploy Omnistudio components. When you turn it on, Omnistudio components behave like standard Salesforce metadata, so you deploy them with Salesforce CLI, DevOps Center, change sets, and packaging, alongside Lightning web components, flows, and Apex classes in a single pipeline. products: - Omnistudio release: "264" --- # Clean Metadata Deployment for Omnistudio Clean Metadata Deployment modernizes how you deploy Omnistudio components. When you turn it on, Omnistudio components behave like standard Salesforce metadata, so you deploy them with Salesforce CLI, DevOps Center, change sets, and packaging, alongside Lightning web components, flows, and Apex classes in a single pipeline. Omnistudio components become standard setup entities, represented by new metadata types. Each component exposes only a single version, dependencies are detected automatically, and source files use clean, version-agnostic names. You deploy Omnistudio components with the same tools and workflows that you already use for the rest of the Salesforce platform. ![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio-264-0-0-production-enus/f526eaa8-ae05-487a-8944-4bb99b0b78ac/images/icon_note.png) Note Clean Metadata Deployment is available only on the standard runtime and standard designer. If you're on the managed package runtime and designer, migrate to the standard runtime and designer to use this feature. See [Migrate Your Components to Omnistudio Standard Runtime Using the Omnistudio Migration Assistant](https://help.salesforce.com/s/articleView?id=xcloud.os_migrate_omnistudio.htm&type=5&language=en_US). ## Key Benefits Clean Metadata Deployment brings these improvements to Omnistudio deployment. - Atomic deployment: Deploy Omnistudio changes together with other Salesforce metadata types in one cohesive deployment. - Automatic dependency detection in first-generation (1GP) packages: When you retrieve or deploy an Omnistudio component, the framework identifies the components it depends on and includes them. - Streamlined version management: Each component exposes only its single version for deployment. Each deployment creates a version in the target org, so you no longer scan a long list of versions to find the right one. - Readable diffs: The new metadata produces consistent, readable diffs of your deployed Omnistudio changes for reviewers. - Packaging support: The new metadata is packageable in first-generation (1GP) and second-generation (2GP) packages. - Sandbox copy support: When you create a full copy or partial copy sandbox, your Omnistudio components are copied to the sandbox. See [Sandbox Types and Templates](https://help.salesforce.com/s/articleView?id=platform.create_test_instance.htm&type=5&language=en_US). - Source tracking: Track the changes between your local project and a scratch org or sandbox when you create, update, or delete Omnistudio components. See [Track Changes Between Your Project and Org](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_source_tracking.htm). ## Key Differences This table compares Omnistudio deployment before and after you turn on Clean Metadata Deployment. | Capability | Legacy Deployment | Clean Metadata Deployment | | --- | --- | --- | | Deploy alongside other metadata types | No | Yes | | Versions exposed for deployment | All versions | Single version only | | Automatic dependency detection | Not supported | Supported (1GP only) | | Source files in version control | Hard to compare | Readable, consistent diffs | | File naming | Includes version number | Version-agnostic | | Source tracking | Not supported | Supported | | Full sandbox copy | Omnistudio components not copied | Omnistudio components copied | | 1GP packaging | Limited | Supported | | 2GP packaging | Limited | Supported | | Change sets | Not supported | Supported | ## Supported Deployment Methods and Tools After you turn on the feature, you can use Omnistudio components with these options: - Salesforce CLI: Retrieve, deploy, and package Omnistudio components with `sf project` commands. See [project Commands](https://developer.salesforce.com/docs/platform/salesforce-cli-reference/guide/cli_reference_project.html). - Change sets: Include Omnistudio components in change sets, with dependencies identified automatically. See [Deploy Using Change Sets](https://help.salesforce.com/s/articleView?id=platform.code_tools_changesets.htm&type=5&language=en_US). - Metadata API: Work with the new metadata types programmatically. See [Understanding Metadata API](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_intro.htm). - 1GP and 2GP packaging: Package Omnistudio components in first-generation and second-generation packages. See [First-Generation Managed Packages](https://developer.salesforce.com/docs/atlas.en-us.pkg1_dev.meta/pkg1_dev/sharing_apps.htm) and [Second-Generation Managed Packages](https://developer.salesforce.com/docs/atlas.en-us.pkg2_dev.meta/pkg2_dev/sfdx_dev_dev2gp.htm). - Sandbox copy: When you create or refresh a Developer, Developer Pro, Partial Copy, or Full sandbox, Omnistudio components copy automatically. See [Sandboxes](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandboxes.htm). ## New Metadata Types When Clean Metadata Deployment is turned on, use these metadata types for retrieve and deploy operations. These metadata types require API version 67.0 or later. | Component | New Metadata Type | Legacy Type (no longer supported) | | --- | --- | --- | | Omniscript | [OmniscriptDefinition](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/meta_omniscriptdefinition.htm) | OmniScriptConfig | | Integration Procedure | [IntegrationProcdDefinition](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/meta.integrationprocddefinition.htm) | OmniIntegrationProcConfig | | Data Mapper | [DataMapperDefinition](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/meta.datamapperdefinition.htm) | OmniDataTransformConfig | | Flexcard | [FlexcardDefinition](https://developer.salesforce.com/docs/atlas.en-us.industries_reference.meta/industries_reference/meta.flexcarddefinition.htm) | OmniUiCardConfig | ## Limitations Consider these limitations when you plan your deployment. - The Tooling API isn't supported. - Omnistudio components that reference Data Mappers in the non-Industries managed package aren't supported. - Packaging doesn't allow version overrides. If a component name conflicts with an existing component during installation, the installation creates a version. - **[Set Up Clean Metadata Deployment](https://help.salesforce.com/s/articleView?id=xcloud.os_set_up_clean_metadata_deployment.htm&release=264.0.0&type=5)** Turn on Clean Metadata Deployment from Omnistudio Settings in Setup. Turn it on in both the source org and the target org. - **[Omnistudio Clean Metadata Frequently Asked Questions (FAQs)](https://help.salesforce.com/s/articleView?id=xcloud.os_clean_metadata_deployment_faqs.htm&release=264.0.0&type=5)** Get answers to common questions about using Clean Metadata Deployment for Omnistudio.