QMetry Reports Upgrade from v8.10.0 and above

In this guide, we will run you through upgrading QMetry Test Management Reports in your environment. These steps are to be followed on your QMetry Reports server hosted on the Linux machine.


  • As a part of this upgrade - which introduces reports sync via QMetry UI, it is required to open port 8080 on the reports server to accommodate the changes as per upgrade steps 8, 9, and 10.

Upgrade Steps

Step 1: Download Required Files

  • You can generate a request on QMetry Support Portal,  to get the latest version of QMetry Reports.

  • Download the QMetryReports81031.zip file on your report server's /opt directory once you receive the report upgrade package.

Step 2. Check the running containers using the following command

  • sudo su -

  • docker ps

If they are not seen running start them using the command: docker start qmetry-reports-db qmetry-reports

Step 3. Remove the older QMetry Reports zip and unzipped folders from the docker's /opt directory.

  • docker exec -it qmetry-reports bash

  • cd /opt

  • rm -rf QMetryReports81031.zip QMetryReports81031

  • exit

Step 4. Copy the QMetryReports81031.zip into the docker container from server's /opt directory using the following commands and get into the container.

  • cd /opt

  • docker cp QMetryReports81031.zip qmetry-reports:/opt

  • docker exec -it qmetry-reports bash

Step 5. Unzip the new reports upgrade zip QMetryReports81031.zip copied under docker's /opt directory and go to the unzipped folder.

  • cd /opt

  • unzip QMetryReports81031.zip

  • cd QMetryReports81031

Step 6. Execute the Report Upgrade .jar file

  • java -jar LiveReportUpgrade.jar

Step 7. Upon executing the LiveReportUpgrade.jar with the above commands, you will be asked the below questions:

Do you want to upgrade QMetry Reports (Y/N) 

type - Y

Enter QMetry Reports Installation Path

type - /opt

  • Wait for the .jar to finish executing.

  • Type exit to exit the docker.

Step 8. Restart Reports Services

  • docker restart qmetry-reports-db qmetry-reports

Step 9. Configure Force Sync of Reports and Trigger a Sync (Post Upgrade Step)

  • Under Sync Data tab, setup the Report Data Sync from your reports server to QMetry Reporting. 

    • Report Server URL : This should be set to your report server domain URL followed by port 8080 as shown below. Ensure port 8080 is open on the reports server.

    • Click on Test to ensure successful connection and then hit "Test & Save".

    • Hit "Sync Data" to start Reports Data Sync.

Note : "Sync Data" should be run after the upgrade. Time taken to sync depends on the amount of data in QMetry. Sync Progress and Status can be monitored as shown in the below screenshot. QMetry custom reports remain inaccessible when syncing in progress. The sync process is recommended to be run only during off-peak hours.

Users can start using QMetry Reports when the sync is completed.

Note: Depending on your data this process can take time as it will be performing full QMetry Data Sync. Users can continue to use QMetry Application during this time. But QMetry custom reports remain inaccessible when the syncing is in progress.

If you are facing any issues during the upgrade process, kindly generate a support ticket on Support Portal for assistance.