Install and Upgrade Automation API Feature for Online Installations
In this guide, we'll run you through the installation steps of Automation API. Installing the Automation API with your on-premise QMetry installations will enable several automation API related features including faster automation result file imports into QMetry.
Refer to Automation API Changes with QMetry v8.13.0 for latest changes.
Before you Start
Choose a Deployment Option
Option 1: Shared server: install the Automation API on the same server that runs the QMetry Application.
Option 2 (recommended): Dedicated server: for heavy Automation API usage, install ActiveMQ, the Automation API, and Redis caching on a separate server.
If you are opting for Option 2, the following are hardware requirements for Active MQ and Automation API Server.
Automation API Server Hardware Requirements
Small Teams < 50 Users | Medium Teams < 500 Users | Large Teams 500+ Users | ||||
Min | Recommended | Min | Recommended | Min | Recommended | |
Memory | 4 Gb | 8 Gb | 8 Gb | 16 Gb | 16 Gb | 32 Gb |
CPUs | 2 Core | 4 Core | 4 Core | 12 Core | 12 Core | 24 Core |
Pre-requisites for the Installation
QMetry Application is installed and running. Complete steps 1-7 of the QMetry and Reports Installation on Linux - 2 Tier (through entering the Base URL); Step 7 is mandatory.
Redis and ActiveMQ are configured with the QMetry Application. This guide installs both if you have not already.
Every server supports the commands: unzip, curl, and vim.
Internet access is enabled on every server for docker-based installation.
No Proxy blocks internet downloads.
Docker installation requires root user access.
Get the QMetryAutomationAPI.zip, QMetryActiveMQ.zip, and QMetryRedis.zip and Docker credentials from QMetry Support.
Required Ports
Installation | Ports that need to be enabled and should be available for use |
|---|---|
Redis Caching Server | 6379 |
Active MQ Server | 8181 & 61616 |
Automation API Server | 8081 |
Note
Run the three steps in order: Redis, then ActiveMQ, then the Automation API, so each dependency is available before the service that needs it.
During an upgrade, the installer detects the existing component and skips the configuration prompts, reusing stored values.
Install/Upgrade Redis Caching Server
Note
QMetry supports Redis 7.0.10 and later. The Docker image currently installs Redis 7.4.1.
Step 1: Extract the installer
Copy QMetryRedis.zip to the server, then extract it and enter the directory:
unzip QMetry_Linux_Installer.zip cd QMetry_Linux_Installer
Step 2: Run the Installer
sudo su chmod +x install.sh ./install.sh
Step 3: Online Installation Prompt
Options | Allowed Values | Default Value | Recommended Value |
|---|---|---|---|
Do you want to make an online installation (Y/N)? | Y, y, N, n | Y | Y |
Step 4: Docker Verification
The script runs docker.sh to verify Docker installation and prerequisites are met. Enter the docker credentials.
Step 5: Main Installation Menu
Enter 4 in the QMetry Installation Menu.
The installation may take a while. Once the installation is complete, execute the following command.
Step 6: Verify the Container
docker ps
Confirm the Redis container appears in the list.
Step 7: Configure Redis in QMetry
Log into the QMetry application:
Go to "Admin" Profile and Edit the Profile.
Update QMetry Redis URL (host/dns:port).
 |
For more on Redis, see https://redis.io/.
Note
Configure the Redis with QMetry Application as mentioned in 7. If you are facing any issues from the QMetry Application side after 7, then you may be required to restart the QMetry Application docker container after Step 7.
Install/Upgrade Active MQ
Get the QMetry_Linux_Installer.zip file from QMetry Support and copy it to the server for Automation API installation.
Step 1: Extract the installer
Copy the QMetryActiveMQ.zip to the server, then extract it and enter the directory.
unzip QMetry_Linux_Installer.zip cd QMetry_Linux_Installer
Step 2: Run the installer
Execute the following commands.
sudo su chmod +x install.sh ./install.sh
Step 3: Online Install Prompt
Options | Allowed Values | Default Value | Recommended Value |
|---|---|---|---|
Do you want to make an online installation (Y/N)? | Y, y, N, n | Y | Y |
Step 4: Docker Verification
The script runs docker.sh to verify Docker installation and prerequisites are met. Enter container repository credentials shared as a part of the installation package.
Step 5: Main Installation Menu
Type 5 to install Automation API.
The installation may take a while.
Step 6: Enter ActiveMQ credentials
Provide these when prompted (skipped during an upgrade):
Parameters | Example |
|---|---|
ActiveMQ username | admin |
ActiveMQ password | admin |
Step 7: Verify the container
docker ps
Step 8: Configure ActiveMQ in QMetry
Login to QMetry and perform the following steps:
Go to "Admin" Profile and Edit the Profile.
Update MQ URL, MQ Username, and MQ Password.
The ActiveMQ URL should be in the format of protocol://<host>:port.
For example, "tcp://<activeMQ-Host>:61616"
 |
Step 9: Restart the QMetry Application
Restart the QMetry Application docker container.
Install Automation API Server
Step 1: Extract the Installer
Copy QMetry_Linux_Installer.zip to the server and extract it:
unzip QMetry_Linux_Installer.zip
Step 2: Run the installer
sudo su chmod +x install.sh ./install.sh
Note
For upgrade, use upgrade.sh
Step 3: Online Install Prompt
Options | Allowed Values | Default Value | Recommended Value |
|---|---|---|---|
Do you want to make an online installation (Y/N)? | Y, y, N, n | Y | Y |
Step 4: Docker Verification
The script runs docker.sh to verify Docker installation and prerequisites are met. Enter container repository credentials shared as a part of the installation package.
Step 5: Main Installation Menu
Type 7 to install QMetry Automation API.
Step 6: Enter configuration parameters
Provide these values when prompted (skipped during an upgrade):
Options | Details | Default Value | Example |
Enter QMetry (QTM) database host (localhost) | For AWS, use the private IP of the instance hosting the QTM database. | localhost | QTM Application's database host |
Enter QMetry (QTM) database port (3306) | 3306 | 3306 | 3306 |
Enter QMetry (QTM) database schema (qmetry) | qmetry | qmetry | qmetry |
Enter QMetry (QTM) database user (root) | root | root | root |
Enter QMetry (QTM) database password | - | qmetry | qmetry |
Enter QMetry (QTM) database min connection (32) | 32 | 32 | 32 |
Enter QMetry (QTM) database max connection (50) | 50 | 50 | 50 |
Enter min threads (2) | 2 | 2 | 2 |
Enter max threads (2) | 2 | 2 | 2 |
Enter Redis host (localhost) | In case of AWS installation enter the private IP of the AWS instance where lis installed. | localhost | redis host |
Enter Redis port (6379) | 6379 | 6379 | 6379 |
Enter MQ URL (tcp://localhost:61616): | In case of AWS installation enter the private IP of the AWS instance where ActiveMQ is installed. EG: tcp://10.0.0.16:61616 | tcp://localhost:61616 | tcp://<activeMQ-Host>:61616 |
Enter MQ user (admin) | admin | admin | admin |
Enter MQ password | Match your ActiveMQ password | - | - |
The installation may take a while.
Step 7: Verify the docker
docker ps
Confirm the automation container appears in the list. Installation is complete once it is running.
 |
Type 0 to exit the installer.
Get support
For any installation issue, raise a ticket on the Support Portal.