QMetry Upgrade Document for Windows

Steps to upgrade existing QMetry to the latest version

Pre-requisites

  1. NEW! - For users upgrading to v8.7 or above
    • Before proceeding with this upgrade, please share the information listed on the page Pre-requisites to 8.7 Upgrade with QMetry Support. Based on this information, support will provide you scripts to correct the database anomalies which are required for the v8.7 upgrade to be successful.
    • DO NOT proceed further without sharing this information with QMetry Support before receiving, and applying the correction scripts as instructed. Ignoring this step will cause your upgrade to fail.
  2. Proceed with this upgrade ONLY IF your current QMetry version is v8.6.0 Build 2 or above. To check: Go to QMetry > About section.


Below are the steps to be followed to upgrade your existing QMetry installation :

Step 1 : Download Required Files

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

  • Download the QMetry8701.zip to your QMetry Application Server once you receive it. Unzip it under a directory as C:\, but separate from your current installation e.g C:\QMetry-Windows-Install\QMetry

Step 2 : IMPORTANT : Backup your existing QMetry Database

Take the backup of your existing “qmetry” database. You can replace the username, password, location of the backup file (currently default /opt).

  • Open a windows command prompt with Admin Privileges.
  • Backup in MySQL Community: 
    C:\Program Files\mysql-5.7.29-winx64\bin\mysqldump -uroot -pqmetry --triggers --routines --hex-blob --single-transaction --lock-tables --no-create-db qmetry > C:\qmetry_backup_<date>.sql
  • Backup in MySQL Enterprise: C:\mysql\meb-3.12\bin\mysqlbackup --port=3306 --protocol=tcp --user=root --password=qmetry --incremental-base=history:last_backup --with-timestamp --backup-dir=[BACKUP_DIR] backup-and-apply-log > C:\mysqlerror.txt          (NOTE : Set [BACKUP_DIR] as per the appropriate path)

Verify that your database has been backed up properly and is available for later use in case of any emergency.


Step 3 : Run the QMetry Upgrade

  1. Extract the ZIP file in the directory along-side ../QMetry install folder but in a separate directory from your existing QMetry installation. unzipped e.g C:\QMetry8701\ 

    • Post upgrade, your current existing tomcat installed path (e.g C:\QMetry-Windows-Install\QMetry) remains unchanged.
  2. Go to the new QMetry upgrader directory: C:\QMetry8701\

    • Locate the qmetry.bat and run it as administrator.
    • The utility will confirm if you want to upgrade, type Yes, and then specify the path of the existing QMetry installation.

      OptionsTypeDefault ValueComments/ Example
      Do you want to upgrade an existing version of QMetry?MandatoryNotype - yes

      Specify the path of the existing version of QMetry

      Mandatory-

      C:\QMetry-Windows-Install\QMetry

      Wait for the process to complete. Stop all open command windows.

Step 4 :Additional Tomcat and MySQL Configuration (Mandatory)

QMetry is installed with a default configuration of minimum and maximum heap memory utilization. You should modify these settings depending on your hardware configuration. Refer Additional Configuration for more details. Skip this step if this configuration is already done during any earlier upgrade.

Step 5 : Restart QMetry and MySQL Services.

  • Go to Run > Type services.msc. Restart the services in the following order.
    1. Restart : MySQL service
    2. Restart : "qmetry" service listed as Apache Tomcat 9.0 qmetry

Step 6 : Installing / Upgrading Jira add-on for the Integration of QMetry and Jira.

Note: It is important to have the correct version of the Jira add-on installed in Jira based on your upgraded and current QMetry version. Refer to the below table for the right version of "Jira Integration - QMetry Enterprise".

QMetry VersionJira-addon version required
8.7 and above2.1.0
8.6.42.0.9
8.6.2.22.0.7


Upgrade your Jira add-on as per the above compatibility matrix. In case you have not installed the Jira Integration - QMetry Enterprise add-on for integration, follow the Steps to Install and Configure the Jira Integration - QMetry Enterprise add-on, if it is not installed.

Important Note

If you are having any issues during the upgrade process, write to us at qtmprofessional@qmetrysupport.atlassian.net. This will automatically open a ticket with our support team and help you follow the progress.