Skip to main content
All CollectionsHelp ArticlesBest Practices
Deploying Salesforce Industries metadata
Deploying Salesforce Industries metadata

This Help article addresses how Copado Essentials supports Salesforce Industries (Vlocity) OmniStudio metadata deployment.

David Belove avatar
Written by David Belove
Updated over a month ago

OmniStudio is the foundation for applications Salesforce acquired from Vlocity, several years ago and renamed Salesforce Industries. The configuration of Vlocity applications was done with data records, similar to CPQ, using a home-grown tool called the VBT (Vlocity Build Tool). Copado CI/CD includes the VBT to provide a complete solution for deploying Vlocity/Salesforce Industries configuration data and metadata.

Since its acquisition of Vlocity, Salesforce has converted much of the OmniStudio to standard metadata that is accessible to Essentials through the Salesforce Metadata API. There may be some legacy aspects of Vlocity applications that still require the VBT. To have complete confidence in the ability to deploy Vlocity configuration data, Copado CI/CD is still the best option. But it appears that most Vlocity and Salesforce Industries metadata can be supported by Essentials. Before using Essentials for Salesforce Industries projects, be sure to check the Salesforce Metadata API library here to confirm that the components you need are supported.

Copado Essentials does support OmniStudio deployments, but with some limitations compared to the full Copado CI/CD solution. Here's what you need to know:

1. Metadata API Support:
Copado Essentials can deploy OmniStudio components that have been converted to Salesforce metadata. As mentioned in the [Copado Knowledge Base](http://docs.essentials.copado.com/en/articles/5741253-does-a-user-have-to-configure-the-salesforce-metadata-api-in-essentials):"Copado supports any metadata type that falls under the most recent version of the Salesforce Metadata API."This includes OmniStudio components that have been converted to metadata format.

2. OmniStudio Metadata API Support:
To deploy OmniStudio components using Copado Essentials, you need to ensure that OmniStudio Metadata API Support is enabled in your Salesforce orgs. This converts the OmniStudio components to a format that can be handled by the Salesforce Metadata API.

3. Component Selection:
When selecting components for deployment in Copado Essentials, you'll be able to see OmniStudio components in the metadata selection grid. As stated in the Copado Knowledge Base:"Once that task is done, Essentials handles the heavy lifting when comes to displaying the available metadata types in the Essentials metadata selection grid within a deployment or work item."

4. Limitations:
It's important to note that Copado Essentials may have some limitations compared to the full Copado CI/CD solution when it comes to advanced OmniStudio deployment features. For example, some of the auto-compilation features or advanced Vlocity Build Tool integrations might not be available in Essentials.

5. Deployment Process:
In Copado Essentials, you can deploy OmniStudio components as part of your regular metadata deployments. You would select the OmniStudio components in the metadata selection grid when creating a deployment.

6. Version Considerations:
Keep in mind that the Metadata API version can affect which components are available for deployment. As noted in the Copado Knowledge Base:"Note that the Metadata API version associated with a particular org may differ prior to a Salesforce major release."In conclusion, while Copado Essentials does support OmniStudio deployments through the Salesforce Metadata API, it may not offer all the advanced features and integrations available in the full Copado CI/CD solution. If you find that you need more advanced OmniStudio deployment capabilities, you might consider upgrading to the full Copado CI/CD platform.

About OmniStudio

OmniStudio is a suite of tools and components within the Salesforce platform that enables the creation of guided, interactive experiences and processes. It was originally part of Vlocity, which was acquired by Salesforce. OmniStudio is designed to help build complex, industry-specific applications and processes more efficiently.

OmniStudio is particularly useful for industries with complex processes or regulations, as it allows for the rapid development of sophisticated, industry-specific applications within the Salesforce ecosystem.

Key components of OmniStudio include:

1. OmniScripts: These are guided, interactive processes and forms that can be used to create step-by-step workflows for users.

2. FlexCards: Reusable UI components that can display data and actions in a card format.

3. DataRaptors: Tools for data transformation and integration, allowing for complex data operations.

4. Integration Procedures: Backend processes for data manipulation and integration with external systems.

When working with OmniStudio in Copado Essentials, there are some important considerations:

1. OmniStudio Metadata API Support: This needs to be enabled on all orgs in your Copado pipeline for consistent handling of components. As mentioned in the Resolving Commit Errors with OmniStudio Components in Source Format Pipelines documentation:

"Ensure that OmniStudio Metadata API Support is enabled on all Orgs within your Copado [or Copado Essentials] Pipeline. This setting must be consistent across all Orgs; you cannot have a mix of legacy Datapacks and Metadata API-supported components."

2. Component Types: When committing OmniStudio components in Copado, it's crucial to pay attention to the component type in the User Story Commit Grid. For example, DataRaptor should be listed as a Datapack component, while OmniDataTransform would appear as an OmniStudio Metadata component.

3. Deployment: OmniStudio components can be deployed using standard Copado Essentials deployment methods (e.g., Work Items or Deployments) once the Metadata API Support is enabled. This allows for these components to be treated similarly to other Salesforce metadata in the deployment process.

4. Auto Compilation: Copado supports auto compilation of Lightning Web Components (LWC) OmniScripts and FlexCards during deployment, which can streamline the deployment process.

Did this answer your question?