Salesforce OmniStudio and Vlocity come in a few different configurations. Which setup you have determines how you should deploy OmniScripts, Data Raptors, Integration Procedures, and Flex Cards with Gearset.
The main distinction is whether these components are deployed as metadata (through Salesforce’s Metadata API) or as data packs (using Vlocity’s packaging format).
OmniStudio with metadata disabled (Vlocity)
What you’ll see in Salesforce settings:
OmniStudio MetadataDisabled
How to deploy in Gearset:
Use the Vlocity filter (data packs) to deploy:
OmniScriptDataRaptorIntegrationProcedureFlexCard
Licensing: Requires the Gearset Salesforce Industries add-on.
Activation: Gearset will attempt to activate OmniScripts and Flex Cards, but Salesforce activation is unreliable and may fail.
If your org is in this configuration, you must use the add-on.
OmniStudio with metadata enabled (Managed package run-time)
What you’ll see in Salesforce settings:
OmniStudio MetadataEnabled
Managed Package RuntimeEnabled
How to deploy in Gearset:
Deploy as standard metadata types:
OmniScriptOmniDataTransform(Data Raptors)OmniIntegrationProcedure(Integration Procedures)OmniUiCard(Flex Cards)
Licensing: Available to all Gearset deployment tiers.
Activation: Gearset does not auto-activate OmniScripts or Flex Cards, you will need to activate them manually after deployment.
This is the recommended and most common setup for new Salesforce orgs.
OmniStudio with metadata enabled (Standard runtime)
What you’ll see in Salesforce settings:
OmniStudio MetadataEnabled
Managed Package RuntimeDisabled
How to deploy in Gearset:
Deploy as standard metadata types:
OmniScriptOmniDataTransform(Data Raptors)OmniIntegrationProcedure(Integration Procedures)OmniUiCard(Flex Cards)
Licensing: Available to all Gearset deployment tiers.
Activation: No activation step needed, scripts and cards are automatically available after deployment.
If you are migrating from Managed Package runtime, you may also see a one-time step for “Deploy Custom Lightning Web Components in Standard Runtime.” This doesn’t affect Gearset deployments.
Vlocity CPQ
Gearset is currently expanding our support for Salesforce Industries (Vlocity) CPQ and EPC, if you're deploying Vlocity EPC please reach out to our product team via the in-app chat to find out more about our current support and to share your feedback.