QMetry and Reports Installation on Windows - 2 Tier (with Docker)

You will be asked for credentials. Enter docker credentials shared as a part of the installation package.

1. Copy the QMetryApp.zip installation file received from QMetry Support to your server. Navigate to the directory where this file is saved. Open a command prompt on that path with administrator privileges. Administrator rights are required to install the application.

2. Execute the following command including the dot (‘.’) at the end of the command.

   powershell Expand-Archive 'QMetryApp.zip' -DestinationPath 

3. Execute the following command to start the installation of the QMetry Web Server.

   cd QMetryApp 
   qmetry.bat

   The next question during the installation process will be as follows.

   Options	Allowed Values	Default Value	Recommended Value
   Do you want to make an online installation (Y/N)?	Y, y, N, n	Y	Y

4. Next, the installation process will prompt for the directory path on the host machine to store the QMetry application’s file-related data like attachments, license, import, export files etc. You can enter any path of the host machine to store QMetry application’s file related data. If the mentioned directory does not exist on the given path, it will get created automatically during the installation process.

   Options	Comments/Example
   Please enter QMetry application directory	C:\qmetryapp

5. Once the script finishes executing, it will prompt to enter the following parameters:

   Options	Details	Default Value	Example
   Enter QMetry database schema	QMetry Application Database schema name.	qmetry	qmetry
   Enter QMetry database user (root)	Enter QMetry Application Database user name.	root	root
   Enter QMetry database password for the user mentioned above	Enter QMetry Application Database Password for the mentioned above user.	-	QMetry@123
   Enter Email for QMetry admin user	Enter QMetry user email address for Admin.	-	admin@qmetry.com
   Enter password for QMetry admin user	Enter QMetry user password for Admin.	-	Admin@123
   Enter Min. Heap Memory for web server in GB	Enter Heap Memory in GB(s)	2	2
   Enter Max. Heap Memory for web server in GB	Enter Heap Memory in GB(s)	4	4
   Enter QMetry Database Connection Pool Size	Enter Pool Size in number format	100	100

6. The installation may take a while. The script will check for the availability of .NET Framework 3.5. In the absence of which it will prompt you to download the same.

   

   It will ask for confirmation to install the qmetry-app.exe. Click Yes to proceed.

   Once the installation is complete, execute the following command.

   docker ps

   The docker containers installed will be shown along with their container IDs and names.

7. Getting your QMetry License and Installing it.

   • For users evaluating QMetry

     • You should have received an evaluation license valid for 30 days along with the installation.

   • For users requiring a commercial license

     • Server's domain name and mac address are required to generate your QMetry License. Follow the below steps to get your server mac address and send this information along with the domain name to QMetry Support to get your QMetry License generated. Send an email to qtmprofessional@qmetrysupport.atlassian.net to reach QMetry Support.

       • Execute the below command to get your server's mac address. Then send the MAC address to QMetry Support to receive the license file.

         getmac

         You may get more than one mac address. Share any one of them with QMetry Support.

     • Once you receive license.key from QMetry Support, you can follow the Steps to Apply License file.

8. Access QMetry application using the following address.

   http://<your IP Address OR Domain Name>

   Default QMetry login credentials.

   • Username: admin

   • Password: <user specified password in Step#5>;

   Note

   With installation, MySQL 8.0.40 will be installed on port 3306. Below are the details

   • Username : root

   • Password : <user specified password in Step#5>

   • Schema : <user specified Schema in Step#5>

   This installation installs QMetry over Apache Tomcat 11.0.5, MySQL 8.0.40 and Open JDK 17.0.2 in a docker container.

9. After the above steps are completed, log into the QMetry application.

   • Go to "Admin" Profile and Edit the Profile.

   • Update Email of Admin in the Email field.

   • Enter the Base URL as your QMetry URL.

10. Additional Tomcat Configuration: QMetry is installed with a default configuration of minimum and maximum heap memory utilization. You can modify these settings depending on your hardware configuration. Refer Additional Configuration for more details.

You will be asked for credentials. Enter docker credentials shared as a part of the installation package.

Once the script finishes executing, it will prompt you to enter the following parameters.

In cases when you need to force sync to re-sync any missing data, just repeat step 3, and skip qll parameter details (by hitting enter) and just enter y when prompted for a force sync.

Wait for the script to finish executing.

Wait for about 2 minutes - docker ps command should give output as follows:

1. Go to the directory where the QMetryReport.zip file is saved and go to a command prompt on that path.

2. Execute the following command including the dot (‘.’) at the end of the command.

   powershell Expand-Archive 'QMetryReport.zip' -DestinationPath . 
   cd QMetryReport 

3. Execute the following command to start the installation of the QMetry Report Server.

   qmetry.bat

   The next question during the installation process will be as follows.

   Options	Allowed Values	Default Value	Recommended Value
   Do you want to make an online installation (Y/N)?	Y, y, N, n	Y	Y

4. Once the script finishes, it will prompt to enter the following parameters:

   Options	Details	Default Value	Example
   Enter Report Database Password (root user)	Enter password for QMetry Reports Database.	-	QMetryreports@!Nf0#
   Enter Report Database Schema	Enter Database schema name for QMetryReports Database.	qtmanalytics	qtmanalytics
   Enter Number of CPU's to allocate	Allocate 3/4th of the available CPUs. For example, if CPU has 8 cores, enter 6 the number of CPUs can be checked from Task Manager > Performance tab > Number of cores. This would be the number of CPUs.	4	6
   Enter Memory to allocate in GB(s)	Entered memory would be used by the sync job while running full sync of data. Enter 3/4th of total memory available on the server. For example, if the memory on the server is 24 GB, enter 18	4	18

5. Login to QMetry with 'admin' user login, and configure the reports server URL in the configuration menu.

   Go to QMetry and click Customizations. Go to Insight Configuration.

   • Under Database Configuration tab

     • Enter Host: Reports Server Host Public IP/DNS

     • Enter Port: 33061

     • Enter Username: root

     • Enter Password: <user specified password in Step#4>

     • Enter Database Name : <user specified password in Step#4>

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

   • 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" is required the first time after reports installation. 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 during sync and It is recommended to be run only during off-peak hours.

   Users can start using QMetry Reports when the sync is completed. QMetry remains available during this time.