Vlocity Integration

Updated 3 weeks ago by Copado Solutions

Copado's Vlocity integration allows you to include Vlocity metadata in the same release management process as the one for standard Salesforce metadata with a complete Git version control.

While working with Copado and Vlocity, you can promote and deploy Vlocity configurations in the same way as for Salesforce metadata, taking advantage of Copado's flexibility and quality gates. 

Vlocity configurations/metadata are available to be retrieved and committed to the repository, or promoted and deployed without version control (org to org).

You can find Vlocity metadata in the same places as Salesforce metadata, for instance in the Org Credential record, the Git Snapshot page or the User Story Commit page.


  • A fully enabled Coapdo user.
  • Vlocity feature activated in your Copado instance.
    • If the feature is not enabled, your system admin user will be able to activate it by following these steps:
      1. Go to the Account Summary tab.
      2. Switch the Toggle Vlocity button.
      3. Click on Refresh features.
    Please note this option is only available if you are in Winter '20. For all other versions, contact your sales representative in order to get Vlocity enabled.

  • Vlocity  metadata visibility.
    • Records (configurations) permission.

Vlocity Components

Once your organization has the Vlocity feature activated, simply refresh the metadata index of your org credential(s) and you will see the Vlocity metadata listed alongside the Salesforce metadata:

Vlocity Commit Process

On the User Story Commit page you will also find the Vlocity metadata listed in the metadata index grid. Once you select the Vlocity metadata and click on Commit Changes, the Copado backend runs the Vlocity build tool and executes the packExport command to retrieve the selected Vlocity files from the source organization. Copado then commits the retrieved files in the corresponding branch:

Vlocity Dependencies

If you would like to resolve Vlocity dependencies before a commit, you can select the components you want to commit and then click on Get Vlocity Dependencies on the User Story Commit page. After completion of the job, you will see in the Selected Metadata tab your original selections plus the dependencies needed, so that you can commit and deploy them together:

Max Depth

Add the parameter @maxDepth=X (1 min, 10 max, -1 all) in the commit message to retrieve Vlocity components that are not selectable in the grid and cannot be retrieved using the Get Vlocity Dependencies link. Max depth is the maximum distance of parent or children relationships from the initial data being exported: 





Vlocity Deployment Process

When executing a deployment with Vlocity metadata, the Copado backend runs the Vlocity build tool and executes the packDeploy command to deploy the Vlocity files from the source organization (MetaData step) or Git branch (Git Promotion or Git MetaData steps) into the destination organization: 

Onboarding Vlocity Integration Strategies

If you are currently working with Copado and did not do the initial setup (production snapshot) including Vlocity metadata, you can follow this strategy:

  1. Commit  to a user story all Vlocity metadata with production as source environment
    1. Copado will now include the Vlocity metadata in your Git repository.
      You can use an org credential with visibility to Vlocity metadata only to reduce chances of committing other metadata. 
  2. Back-promote the user story to all the lower environments to synchronize Vlocity metadata with all the environments and branches.
This strategy will back-promote the current status of your Vlocity configuration in production. Work in progress in Vlocity configurations will be overwritten in lower environments.

If you are currently working with Copado and did not do the initial setup, but your lower environments are aware of Vlocity configurations and have work in progress, you can follow this strategy:

  1. Create an independent auxiliary Git branch in your Git repository. 
  2. Create a Git Snapshot record:
    1. Select the production org credential.
    2. Write the name of the auxiliary branch name.
    3. From the advanced metadata, select only Vlocity Metadata.
    4. Save and click on Take Snapshot Now.
After completion, from your Git repository, manually merge the new Vlocity folder into your master branch. In order to achieve this, you can create a pull request from the auxiliary branch to master and merge.   

Each time a new user story gets created and changes are committed, changes are merged into the source environment until everything is in sync.

How did we do?