QMetry Reports Upgrade from v8.11.2 and above

Note

This document is applicable ONLY if your QMetry Reports version is 8.11.2 and above, and you want to upgrade to QMetry Reports version 8.24.1.1

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

Pre-requisites

  • 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.

  • Proceed with this upgrade ONLY IF your current QMetry Reports version is v8.11.2 or above.

Upgrade Steps

Step 1: Download Required Files

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

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

Step 2. Check the running containers

sudo su -
docker ps
image-20230829-121708.png

If they are not seen running, start them using the command:

docker start qmetryreport_db qmetry-reports

Step 3: Copy the QMetryReports82411.zip 

Copy the QMetryReports82411.zip into the docker container from the server's /opt directory using the following commands, and get into the container.

cd /opt
docker cp QMetryReports82002.zip qmetry-reports:/opt
docker exec -it qmetry-reports bash

Section 4: Unzip the new reports

Unzip the new reports upgrade zip QMetryReports82411.zip copied under Docker’s/opt directory, and go to the unzipped folder.

cd /opt
unzip QMetryReports82411.zip
cd QMetryReports82002

Step 5. Execute the Report Upgrade .jar file

java -jar LiveReportUpgrade.jar

Step 6. Enter the responses

Upon executing the LiveReportUpgrade.jar with the above commands, you will be asked the following 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.

Exit the docker.

exit

Step 7 Restart Report Services

docker restart qmetryreport_db qmetry-reports

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

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

    • Under the Sync Data tab, set up 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 Test to ensure a successful connection and then hit Test and Save.

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

Note

Sync Data should be run after the upgrade. The time taken to sync depends on the amount of data in QMetry. Sync Progress and Status can be monitored as shown in the screenshot below. QMetry custom reports remain inaccessible when syncing is 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.

image-20230522-061010.png

Note

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

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

In this section:
© 2026
Publication date: