This article helps to install and setup HCL Compass in your machine which runs on rest server (without WAS)

  1. Installation and setup are done on Windows machine, hence, should have Windows OS installed in the machine.
  2. MS_Access database to store the data.
  3. Java installed in the machine.


  1. Navigate to https://www.hcltechsw.com/compass, click “GET A FREE TRIAL” button and submit the form with required details. Successful message shown as below.

2. Wait for few mins and will receive 2 mails. One with user has created and other provides link to download required software. Download Installation Manager and HCL Compass using links provided in the email.

3. Both software will be downloaded in zip format which need to be extracted and kept in a directory. Let’s install “Installation Manager (IM)” first followed by “HCL Compass”.

4. Select the version and Click “Next”.

5. Accept the terms and click “Next”.

6. Select the directory to install Installation manager and click ‘Next’.

7. Here final step to finish installing Installation Manager. Click ‘Install’.

8. Installation Manager is installed in machine and successful message will be shown. We need to restart IM by clicking on ‘Restart Installation Manager’.

  1. Launch IM. Click File -> Preference -> Add Repository -> Enter url (D:\HCL_Compass_Install\ and OK button. Again, click Ok button.

Note: Above url can be derived from where HCL Compass is downloaded and extracted.

2. Click “Next”.

3. Select I accept and click ‘Next’.

4. Click “Next”.

5. Select the path to install HCL Compass and click ‘Next’.

6. Check the components to install (excluding Web server and Report Launcher) as per below screenshot and click ‘Next’.

7. Click ‘Next’.

8. Add the URL and Server ID. Click ‘Next’.

Note: URL and Server ID are available in mail received by HCL.

9. Point to Java where it is installed in your machine and Click ‘Next’.

10. Click ‘Next’.

11. Click “Install” button.

12. Install will be success and message will be displayed. Click “Finish”.

  1. Open “HCL Compass Maintenance Tool” installed . Click “Create” on top left icon and provide Schema name. I gave “CompassTrail”.

2. Select Feature Level, Vendor and Database file path. Click “Next”.

3. Click “Next”.

4. Select schema to use “Defect Tracking”, add description (if needed). Click “Next”.

5. Create user database and click “Finish”.

Note: I am using MS_Access for database

6. Once successful, click “Done”. Now, Schema is created and ready to use.

  1. Navigate to directory where HCL Compass is installed and start the server.

For me: Path would be C:\Program Files\HCL\Compass\compass-rest-server-distribution\bin and run the command prompt.

Note: If you get any error related to java, you may need to edit start.bat file and set java path.

2. Once command runs successfully, open any browser and launch the application using https://localhost:8190/#/login. you will be able to see HCL Compass application up and running.

Login Credentials: Username: admin, Password: <empty> and Login.

Note: If you wish to experience production databases like Oracle, DB2 others, please refer to documents available in HCL Software portal.





Comment wrap
Further Reading
Secure DevOps | May 25, 2022
Ensure HCL Compass is installed in your machine and have valid credentials to login into repository.
Secure DevOps | February 25, 2022
HCL Compass Webhooks in Action
This article talks about Webhooks in HCL Compass. Webhooks are nothing but automated data sent from an app when something is triggered. In our case, HCL Compass is the app which sends the Webhook data, which is also called as Payload.
Secure DevOps | October 25, 2021
Tips To Configure your Compass REST Server for Production Use
This article assumes that you are not running IBM Http Server with legacy Compass web server, or any other software, using port 443. We are also assuming that a server Administrator is performing these tasks and that person has permission to edit files and create Windows services.
Filters result by