IDX Workbench: Frequently Asked Questions (FAQ) & Known Issues

1. What are the migration types supported by IDX Workbench?

Migrations types supported by IDX Workbench are:

• From one Vlocity org to another
• From a Vlocity org to a Git repository
• From a Git repository to a Vlocity org
• From a DataPack (JSON) to a Git repository or a Vlocity org

Since IDX is a UI-based tool built on top of VBT, it can't be used with CI/CD pipeline. VBT/OmniStudio Build Tool is recommended for CI/CD Pipeline. 
Ref: IDX Workbench Desktop Application

2. What kind of datapacks can users import using the IDX Workbench?

The users can import datapacks from OmniStudio for Vlocity to an OmniStudio for Vlocity or OmniStudio org. The components will be automatically converted to OmniStudio object, but importing datapacks from OmniStudio org to Omnistudio for Vlocity is not supported.
Ref: IDX Workbench Desktop Application

3. How to install IDX Workbench?

Navigate to the download site and click the link for the desired platform.
Ref: Install IDX Workbench

4. How to set a Git Repository in the IDX?

Following are the steps to follow to set a Git Repository in the IDX:

• Pull the git repository to the local system.
• Set the local repository by setting the repository in IDX.
• Set the target folder to the local Vlocity folder of the git repository.
• Once the components are pushed to the local, the user will need to commit the changes and raise pull requests to push the changes to the git.

5. What should a user do in case the components are missing for migration from the Trial Orgs in ASM and ESM related scenarios?

The user needs to request another TSO (Trial Source Org) with the upgraded version which will contain all the latest components and these can be migrated successfully to the target org.

6. How can a user migrate FlexCards using IDX?

The user needs to select ‘Vlocity Cards’ from the ‘Vlocity Types’ drop-down while creating the project to migrate FlexCards through IDX.
 

7. How to install Process Libraries from IDX?

This operation isn't allowed. VPLs aren't available for download from Success Community, if the user has any already downloaded datapacks, they'll have to manually install them by importing them into the source org. Using IDX, they can create a project to migrate and then keep the source as the folder which contains datapacks.
 

8. What should a user do when IDX Certificate expires on Windows?

This will be handled by the backend team and they'll update the certification before it expires, so the customer doesn't have to take any action from their end.
 

9. What's the alpha version of IDX Workbench?

• Alpha version of the IDX is used to migrate/deploy OmniStudio Components (components which have Omnistudio.ComponentName as the namespace) to another OmniStudio enabled org.
• This version can also migrate Vlocity namespace components.
• This link can help the users install the alpha version of IDX in their local systems.

Note: The traditional version of IDX can't migrate components from Omnistudio enabled org to non-Omnistudio enabled org. Also, IDX Workbench has always been in Alpha stage and never been GA'ed. There are no plans to GA this tool as well, and hence it is recommended to use VBT.
 

10. How is the number of retries calculated in the IDX?

The IDX tool generates LWCs for OS and Cards using Puppeteer and hence the retries numbers can be seen, but if there's no activity for a long time, users can check from the debug logs for any errors, or in the target org they can try to activate and deactivate the components manually.

Known Issues in IDX:

1. Error: Post Process Failed - Message: Attempt to de-reference a null object 
2. Not Able to View Project and its Component
3. Error message: INVALID_TYPE: omnistudio__GeneralSettings__c is not supported with deploying OmniStudio Components using IDX Workbench
4. IDX vs VBT