DEV Community

Sib sankar Bag
Sib sankar Bag

Posted on

Deploying Vlocity Code

Deploying Vlocity Code Using Omnistudio Build Tool (VBT)
This document guides you through deploying Vlocity code from a repository to an Org using the Omnistudio Build Tool (VBT). The instructions are designed for Omnistudio Managed Packages. Please ensure you are using Node.js version 10 or later for the Build Tool.

Prerequisites
Node.js Installation:
Ensure Node.js is installed on your system. It is required to install and run the Vlocity Build Tool. If Node.js is not installed, download and install from the official website.

Verify Node.js Version:
node -v
Ensure that the version is 10 or higher.
Vlocity Build Tool Installation: Install or update the Vlocity Build Tool using the Node Package Manager (NPM).

Installation Command:

npm install --global vlocity
Once installed, you can verify the installation and explore available commands:

vlocity help
Deployment Steps
Clone the Repository:

Use Git to clone the repository containing the Vlocity code to your local machine. Open the terminal in VS Code and execute:

git clone
Navigate to the cloned repository in your local environment.

Prepare for Deployment:

Open Visual Studio Code with the cloned project.
Ensure you have the components.yaml file configured with the deployment details and references necessary components.
Deploy Using VBT:

Use the following command in VS Code's terminal to start the deployment process:

vlocity -sfdx.username -job vlocityBuild/components.yaml packGetDiffsAndDeploy

packGetDiffsAndDeploy
packGetDiffsAndDeploy will first find all files that are different locally than in the target Org, and then will deploy only the DataPacks that have changed or are new.

vlocity -propertyfile -job packGetDiffsAndDeploy
Replace with the username of the Salesforce org you are deploying to.

This command will perform a differential deployment, comparing the local repository with what is already in the org, and deploy any changes.

By following the steps outlined above, you should be able to deploy Vlocity code effectively using the Omnistudio Build Tool.

references:

https://github.com/vlocityinc/vlocity_build?tab=readme-ov-file#vlocity-build

https://github.com/vlocityinc/vlocity_build?tab=readme-ov-file#packgetdiffsanddeploy

Through Visual Studio Code with Vlocity extension
Clone the Repository:
Clone the Master Branch:
git clone
cd
If direct cloning is not possible, download the Master branch as a zip, extract it, and set it up locally.
Visual Studio Code Setup:

Open the cloned repository folder in VS Code to ensure all contents are visible in the Explorer.
Ensure your Salesforce Org (sandbox) is authenticated within VS Code for deploying data packs.
Install vocity extension in your VS code -
Load Vlocity Records:

In the VS Code Explorer, locate the data packs to deploy.
Deployment Steps:
For each item, right-click and select: Vlocity: Deploy Datapack To Org
Deploy the following components:
Data Raptors
Integration Procedures
Omniscripts
Vlocity Cards (Flexcards)

Top comments (0)