You are here:
IDX Workbench Desktop Application (Managed Package)
For the managed package runtime, IDX Workbench is a desktop application that you use to deploy Omnistudio data packs and Salesforce metadata. Its user interface is built on top of the Omnistudio Build Tool. The application is available for Mac and Linux.
This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.
Deployment is supported:
-
From one Vlocity org to another
-
From a Vlocity org to a Git repository
-
From a Git repository to a Vlocity org
-
From the Vlocity Process Library to a Vlocity org
-
From a JSON file to a Git repository or a Vlocity org
We recommend the Omnistudio Build Tool for deploying Omnistudio components between orgs. It ensures that the deployment includes dependencies, it validates deployment success, and you can use it with automated deployment, such as scripts or Jenkins.
Components are packaged as data packs, which are optimized for source control and deployment to other orgs. For example, you can develop apps on a dedicated development org. Then, use IDX Workbench to deploy them to a QA org until they’re ready for use in production, and then deploy from your QA org to production orgs.
You can import data packs of some older Omnistudio for Managed Packages objects into an Omnistudio Standard org. Omnistudio Data Mapper, Integration Procedure, and LWC-enabled Omniscript custom objects are automatically converted to standard objects.
Importing data packs of standard objects into an Omnistudio for Managed Packages org isn't supported. Importing Cards between Omnistudio and Omnistudio for Managed Packages orgs isn't supported.
See Differences Between Omnistudio and Omnistudio for Managed Packages (Managed Package).
When you choose a component for deployment, IDX Workbench ensures that its dependent components are included. For example, if you deploy an Omniscript that requires a Data Mapper, that Data Mapper is packaged for deployment with the Omniscript.
In IDX Workbench, you define the source org or repository, the target org or repository, and the components to be deployed. You must create this definition before you can deploy. Deployment is one way, from source to target. Source components overwrite target components of the same name and type.
If you need a command-line client for scripting deployment, download and use the Build Tool.
- Install IDX Workbench (Alpha) (Managed Package)
For the managed package runtime, to deploy changes to Omnistudio components, download and install the IDX Workbench application. - Configure LWC Omniscript and Flexcard Activation and Compilation (Managed Package)
For the managed package runtime, if Google Chrome is your default browser and IDX Workbench logs you into your source and target orgs through it, you can skip this task. When you deploy Omniscripts, Integration Procedures, and Flexcards, they’re automatically activated in the target org. However, if you use a different browser, you must configure this automatic activation feature manually. - IDX Workbench Configuration for Deployment (Managed Package)
For the managed package runtime, before you can deploy components, you must specify the source, the target, and the objects to be deployed. The source can be an org, a Project object in an org, a JSON file, the Vlocity Process Library, or a Git repository. The target can be an org or a Git repository. - Object Deployment and Comparison (Managed Package)
For the managed package runtime, after you have configured a project, you can deploy objects from the Source to the Target. After the initial deployment, you can compare objects in the Source and Target to see if any have been updated and need to be deployed again. You can also save objects in the Source to DataPacks. - Use the IDX Workbench Process Profiler (Managed Package)
For the managed package runtime, the Process Profiler lets you view the Tracking Service data for an object in a source or target org. - Compare Omniscript and Integration Procedure Versions (Managed Package)
For the managed package runtime, the Version Compare dashboard lets you compare two versions of an Omniscript or Integration Procedure in the same Source or Target org. - Run Test Procedures (Managed Package)
For the managed package runtime, the Test dashboard lets you run Test Procedures (Integration Procedures that perform unit tests) and analyze the results of the tests. - IDX Workbench Menu Commands (Managed Package)
For the managed package runtime, most of the commands in the IDX Workbench menus are like those of any application. For example, copies the selected text. Commands specific to IDX Workbench are listed here.
