Deploying Vlocity components

Overview

Vlocity integration with ARM allows you to retrieve and deploy Vlocity metadata in the same way as the Salesforce metadata and deploy the Vlocity components to the destination Salesforce org directly from ARM. Using the Deployment feature in ARM, you can quickly deploy components to your destination environment in no time.

Before you begin

Before you proceed with the deployment, it is mandatory to configure your Vlocity data pack type from the My Account > Vlocity Configuration Settings section.

Deploying Vlocity Components

1. Login to your AutoRABIT account.

2. Click on Create New > New Deployment from the top navigation bar.

   
3. Give a label name for the deployment.

4. Choose Deployment From as Vlocity Components.

   
5. Select the Source Pack from where the vlocity components data packs will be fetched. There are five options to choose from:

   Source Pack	Description
   Pack from Salesforce Org	The vlocity components will be fetched from the source Salesforce org. You need to specify the destination org where the vlocity components will be deployed. Note: Only those Salesforce orgs must be chosen under the source and the destination org fields in which the vlocity managed package is installed.
   Pack from AutoRABIT Build	The vlocity components will be fetched from the build number of the specified project, as shown below—only those built to be selected constructed on vlocity components.
   Pack from Version Control	Select this option if you want to fetch the vlocity components from your source version control's data pack folder path. For the same, you need to fill in the details such as version control type (GIT, SVN, TFS), repository and its mapped branch, the data pack folder path, and the destination org where the vlocity components will be deployed.
   Pack from Commit Label	This will allow you to fetch the vlocity components from the data pack folder path of the commit label and deploy them to the destination org. For the same, you need to fill in the details such as version control type (GIT, SVN, TFS), repository and its mapped branch, commit label, data pack folder path, and the destination org where the Vlocity components will be deployed.
   Pack from Release Label	Pack from Release Label will allow you to fetch the vlocity components from the data pack folder path of the release label and deploy them to your destination org.

6. Choose the metadata types. The metadata types field allows you to deploy the entire Salesforce org, Full Profiles, or Permission Sets. Full Profiles will fetch all the profiles available in the selected Salesforce Org, and the Full Permission Sets will allow you to grant additional access to one or more users without changing or reassigning their profiles.

7. Enter your target org.

8. Based on the source pack selection, you will have different fields to fill in to proceed with the vlocity deployments.

9. Click on Retrieve Metadata.

10. Based on the above selection, the metadata components will be fetched and will get displayed on the next screen. Select the metadata and their corresponding members that will be deployed. Click Deploy.

11. On the Deployment Settings page, you will be presented with the below filters to use in the deployment:

    1. Pack Update: This option will refresh the datapacks settings to the version included in the project in the destination org. However, this is recommended only if you are on the latest major version of the vlocity managed package. For example, if some of the records that exist as part of the datapack data were not upserted into Salesforce, then it means that there is a mismatch between the configuration data in the target org compared to the source org, so by enabling Pack Update checkbox and perform deployment then this will update the datapack settings in the target org and will resolve the issue.

    2. Pack Retry: Continues a Job retrying all errors to redeploy once again. For example, if the job contains 10 data packs and where seven were successfully deployed since we enabled the Pack Retry option, then the three errors will be set back to redeploy again.

       
12. Static Code Analysis (SCA): Choose the SCA tool to detect bugs, code smells, and security vulnerabilities before the deployment begins.SCA-Supported Metadata Types:

    • For ApexPMD, Checkmarx, Salesforce Scanner, and SonarQube: Apex Classes, Apex Triggers, Apex Pages, AuraDefinitionBundle, LightningComponentBundle.

    • For Codescan: ApexClasses, ApexPages, ApexTriggers, AuraDefinitionBundle, CustomObjects, Flow, LightningComponentBundle, PermissionSets, Profiles, Settings, SharingRules, Workflows.

13. You can stop the deployment if the SCA doesn't meet the global criteria. Go to My Account > Validation Criteria- Static Code Analysis to set the global configuration for your SCA tool.

14. Also, you can select the recipients for the alert under the "SCA Mail Notifications" field. Multiple recipients can be added here.

15. Under Deployment Notes, specify the reason for the deployment and what has changed across your Salesforce org. This is optional too.

16. Click OK. The Deployment Summary page will be displayed, where you can view the components one final time before deploying them.

17. Finally, click on Deploy. You will now be redirected to the Deployment History screen, which will show you the progress of the deployment. We just included new functionality to the ARM 22.3 version that allows users to terminate an ongoing vlocity deployment process or abort it if it becomes stuck. The Deployment History screen contains the Abort option, which allows you to terminate the deployment process.

The detailed report can be viewed on this page, such as total vlocity components successfully deployed, failed components (if any), code coverage details, etc. In addition to viewing the report, you can also download the vlocity components packs for the selected deployment.

Important Note: Redeploy, and RollBack is currently not supported for the vlocity deployment.

Using Continuous Integration (CI) Job

1. Go to the New CI Job screen.

   
2. Select the Deploy from the Version Control tile.

   
3. Give the job a descriptive name in the CI Job Name field.

4. In the Build section, select your version control repository and branch.

5. Select the Vlocity Build checkbox.

6. Enter the data packs folder path from where the components will get retrieved for the deployment.

   1. Pack Update: This option will refresh the data Packs settings to the version included in the project in the destination org. However, this is recommended only if you are on the latest major version of the vlocity managed package.

   2. Pack Retry: Continues a Job retrying all errors to redeploy once again.

      
7. Fill in the remaining fields as per your requirements and click on Save.