Installing BMC AMI DevX Workbench Explorer

The following steps help you to install BMC AMI DevX Workbench Explorer.

  1. Open Visual Studio Code.
  2. In the left side activity bar, click the Extensions icon (image2022-8-25_19-30-45.png)
  3. In the Search Extensions in Marketplace field, enter BMC AMI DevX Workbench Explorer. The BMC AMI DevX Workbench Explorer extension is displayed in the search list.
  4. Click Install on the extension. Once the extension is installed successfully, it will be listed under installed extensions.
     

Important

When the extension is installed, the <USER_HOME>/.devx-workbench  folder is created for the cache and temp files. If you are facing read/write permission issues, you must perform the following actions:

  1. Create a folder in your local drive where you have read/write access.
  2. Configure the environment variable as DEVX_PATH (The value of the environment variable should be the path of the newly created folder). All our caches and temp files will be written to the newly configured path of .devx_workbench.

To use this feature, your system JRE must have JAVA version 11 and above. After you have configured DEVX_PATH, you must restart all the instances of VS Code.

Important

You can now set the environment variable DEVX_JRE_PATH with the JDK 11 bin folder location available in the system. This will help you to start the workbench service with the provided JRE (JRE must be version 11 or above).

If DEVX_JRE_PATH is not set, Workbench service will use system JRE (JDK 11 installed on the system) to start the service. 

If there is an issue in starting with system JRE and DEVX_JRE_PATH is not set then the extension will use embedded JRE to start the Workbench service.

When you install the extension, Workbench Services is started as a Java Process on port 8089. If it is occupied you can change the port. You can change the port by clicking the  Manage (image2022-8-23_21-35-26.png) > Settings > User > Extensions > DevX Explorer > General > Workbench Services: Port. The valid range of the port is 1024 to 65535.

To explicitly start or stop the service, you can use the following commands:

  • Workbench Explorer: Start Workbench Services
  • Workbench Explorer: Stop Workbench Services

When you close the VS Code application, the Workbench Services automatically shut down in 5-10 mins. This time lag has been added to solve the problem when VS Code reloads or restarts and then activates all extensions after upgrading, downgrading, or installing. If you have installed multiple extensions, then  VS Code takes a longer time to activate all the extensions. This process was creating issues with the Workbench Service start and stop process. You do not have to manually kill the Java process when multiple VS Code instances are spinned up.

Important

If you are updating BMC AMI DevX Explorer, you can see the Update option. Click Update and reload, and then restart VS Code to update BMC AMI DevX Workbench Explorer.
Make sure you stop the Workbench Service (if already running) before you make a change to environment variables and restart VS Code.
You can use the command palette command  Stop Workbench Service to stop the Workbench Service.

Important

When you are upgrading or downgrading the extension, ensure the Workbench Service is stopped (if it's running), then restart VS Code.

Related topics

Prerequisites

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*