Use Clean Metadata Deployment to manage and deploy Omnistudio components with the same tools and processes you already use for standard Salesforce metadata. Deploy them by using Salesforce CLI, change sets, and first-generation (1GP) and second-generation (2GP) packages in the same pipeline as your Lightning web components, flows, Apex classes, and similar metadata. Each component exposes a single version, dependencies are detected automatically, and source files use clean, version-agnostic names. Previously, deploying Omnistudio components required extra steps to work around the limitations of the old metadata.
Where: This change applies to Omnistudio 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 Clean Metadata Deployment.
Why: With Clean Metadata Deployment turned on, you get these improvements.
-
Atomic deployment: Deploy Omnistudio changes together with other Salesforce metadata types in one deployment.
-
Automatic dependency detection: Automatically include a component's dependencies when you retrieve or deploy it. This detection applies to first-generation packages.
-
Single-version management: Work with only each component's active version instead of scanning a long list to find the right one, and create a version in the target org each time you deploy.
-
Readable diffs: Give reviewers consistent, readable diffs of your deployed Omnistudio changes.
-
Packaging support: Package the metadata in 1GP and 2GP packages.
-
Sandbox copy support: Copy your Omnistudio components automatically when you create a full or partial copy sandbox.
-
Source tracking: Track changes between your local project and a scratch org or sandbox as you create, update, or delete Omnistudio components.
How: From Setup, in the Quick Find box, enter Omnistudio Settings, select Omnistudio Settings, and turn on Clean Metadata Deployment in both the source org and the target org.