You are here:
Data Deployment with the Omnistudio Build Tool (Managed Package)
For the managed package runtime, the Omnistudio Build Tool (formerly Vlocity Build Tool or VBT) is a Node.js command-line automation tool that packages and deploys Salesforce data packs in a source-control-friendly format. The tool creates a YAML (YAML Ain’t Markup Language) manifest that describes a deployment project. The Build Tool enables continuous integration of Omnistudio metadata to source control.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
The Build Tool packages related objects together as data packs. The data packs preserve dependencies. For example, the Build Tool requires records to have unique IDs to ensure that data isn’t duplicated. The tool provides facilities that validate data and verify the success of data deployment. The GitHub project provides detailed instructions for deployment. For large or complex deployments, use either the Build Tool or IDX Workbench.
The Build Tool is available from GitHub. To check for updates and enhancements to the Build Tool, see the version history.
- Install and Update the Omnistudio Build Tool (Managed Package)
For the managed package runtime, install or update the Build Tool by installing Node.js or through the Node Package Manager (NPM). Downloads are available for each release. - Before You Start Using the Omnistudio Build Tool (Managed Package)
For the managed package runtime, before you start, understand the available and recommended authentication methods, the command syntax, and how the job file works. - Set Up a Project to Export and Deploy (Managed Package)
For the managed package runtime, start by identifying the data source and the target org. Examples show the simplest job file that can be used to set up a project and the commands for exporting and deploying. - Export and Deploy Data from Source Org to Target Org (Managed Package)
For the managed package runtime, to export and deploy data between a source or and a target org, follow this process. If you recently installed the managed package or created a sandbox org, follow the instructions for loading metadata. - Automation Quick Guide for the Omnistudio Build Tool (Managed Package)
For the managed package runtime, understand how the Build Tool works with Salesforce DX, Jenkins, and compiling Lightning Web Components, Omniscripts, and Flexcards. - Export and Deploy by Using the Omnistudio Build Tool Job File (Managed Package)
For the managed package runtime, use the job file to specify settings, the project path, what to export, and where to deploy. ThepackExportcommand takes parameters based on what’s in the job file. The simplest way to export is to include a manifest in your job file that exports all data packs by their data pack key. Or you can narrow the export using SOQL queries. - Omnistudio Build Tool Commands (Managed Package)
For the managed package runtime, review Build Tool commands organized and described by export and deploy, troubleshooting, and additional tasks (such as rebuilding data packs, comparing local files with an org, and listing data packs that can be exported). - Best Practice Developer Workflow (Managed Package)
For the managed package runtime, when developing on a large project, exporting data packs through queries isn't an ideal process. We recommend that you use a manifest-driven workflow to track the major items that you’re working on. Then, extract those items to commit to version control. The manifest section of the job file can be used to create a collection of data packs to be exported or deployed. Manifests are based on the data pack key of each data pack. - Considerations and Guidelines for Complex Deployments (Managed Package)
For the managed package runtime, review considerations and guidelines for using the Omnistudio Build Tool in complex deployments, including anonymous Apex and JavaScript, and with matching keys. - Tools and Processes for Troubleshooting (Managed Package)
For the managed package runtime, the Omnistudio Build Tool includes various tools and processes for troubleshooting, including log files, errors, and a script for cleaning data.
