Chapter 1 Vlocity DX Desktop Application

Vlocity DX is a desktop application that enables you to migrate Vlocity components from one org to
another. Components are packaged as Vlocity DataPacks, which are optimal for source control and
deployment to other orgs. For example, you can develop apps on a dedicated development org,
then use Vlocity DX to deploy them to a QA org until they are ready for use in production, and
then deploy from your QA org to production orgs.

When you choose a Vlocity component for export, Vlocity DX ensures that its dependent com-
ponents are included. For example, if you export an OmniScript that requires a DataRaptor, that
DataRaptor is packaged for export with the OmniScript.

If you need a command-line client for scripting deployment, use the Vlocity Build Tool.

Installing Vlocity DX
To launch the OS X installer for Vlocity DX, locate the .dmg file that you downloaded and double-
click it. The installation dialog is displayed. Drag the app to the Applications folder.

Setting Up Your Project

To define a group of Vlocity components to be exported as a group, you create a project. If you
intend to manage deployment using source control, commit the project as a whole when checking
it in. Do not manually change the files that a Vlocity DX project contains.

To create a project, launch Vlocity DX and perform the following steps:

1. From the Project drop-down list, choose New Project. The New Project dialog is displayed.

2. Specify the name of the project and create a new folder to contain it.

3. To configure the source org (the org from which you export component), click Source + New
Environment and specify the URL for the org. When prompted, log into the org.

4. To specify the target org (the org to which you deploy the packaged Vlocity components), click
Target + New Environment and specify the URL for the org. Note: The target org must have
the Vlocity package installed.

1
5. To configure the Vlocity components and Salesforce metadata to be exported, choose Vlocity
DX > Open Settings. The Settings dialog is displayed.

6. Check all the types of components that you want to export as a group and click Save. The right
pane displays Comparison and Migration tabs.

7. To view the differences between components in the source and target orgs, click the Refresh but-
ton at the top right corner of the right pane. Components in ther source and target orgs are lis-
ted in the left pane, indicating which items differ in source and target. Unchanged items are
indicated by a plain circle to the left. Items that differ are indicated by an orange circle, as fol-
lows:

Note: By default, all the components that you selected in Settings are compared. To compare a
subset, click the dropdown list at the top of the left pane, choose New Working Set and con-
figure the desired subset. To execute the working set comparison, click Refresh.

8. To view the detailed differences between a component in the source and target org, select its
entry in the left pane. Details are displayed as diffs in the right pane. Diffing large orgs can take
a long time, 10 minutes or more. By default, only changed items are shown. To list all com-
ponents, click the filter icon and uncheck New Items and Changed Items.

9. To migrate a single changed item to the target org, select its entry in the left pane and click
Migrate. To migrate all changed items, click All Changed Items at the top of the left pane, then
click Migrate.

Editing OmniScripts for Export

When you diff OmniScripts, differences are displayed per OmniScript component, to enable you
to, for example, delete elements that you added for debugging but want to remove for production.
Note that your edits are not propagated back to the source org. To delete an element from an
OmniScript that you are exporting, locate the element in the per-element diffs and click Discard
All.