QMetry Agent Configuration

Compatibility: QMetry Agent is a Java executable file that needs Open JDK 17.

Automation Agent Key

Use this key to configure the QMetry Automation Agent.

To generate an Automation Key, go to Integration, select Automation Agent, and then click Generate new Key.

Screenshot showing the Automation Agent API Key field in QMetry with options to regenerate or copy the key.

Steps to Configure QMetry Automation Agent

Configure QMetry Automation Agent using UI

  1. Go to Integration, and then select Automation Agent.

  2. Expand the Download & Run Agent section, if not expanded already.

    Screenshot of the “Download & Run Agent” section in QMetry, showing expandable instructions for launching the Automation Agent tool and command line.

  3. Download QMetryAgent.zip by clicking the Automation Agent.

    QTM_Screenshot_Download_QMetry_Agent.png

  4. Extract QMetryAgent.zip to your computer drive.

  5. Open the QMetryAgent folder.

  6. Run <Qmetry Agent Directory>/QmetryAutomationAgent.jar by clicking on it.

    The QMetry Automation Agent wizard opens.

    Screenshot of the QMetry Automation Agent configuration window with fields for URL, API Key, Agent Name, Proxy option, and Running on VM checkbox, along with Clear and Start Agent buttons.

The QMetry Automation Agent has the following fields:

Table 39. Field Description

Field

Description

URL

The URL of your QMetry Test Management application instance.

API Key

Enter Automation Agent Key. To generate the Automation Key, go to Integration > Automation Agent and click the Generate Key.

Agent Name

Enter the name of your preference as Agent Alias to identify the specific agent.

Running on VM

Users who want to run the agent on a virtual machine can do so by setting this configuration. The manual settings are not required.



Interval Time: By default, the interval time between two scheduled jobs will be 180 seconds. You can change the time by modifying the Interval parameter in the QMetryAgent.properties. The minimum value should be 60 seconds.

Click the Start Agent button.

Users can also view logs by clicking on the View Logs button.

QTM_Screenshot_Qmetry_Automation_Agent_View_Logs.png

Once the Agent is configured, it will be added to the list of Registered Agents with the Status Active.

Screenshot of the Registered Agents table in QMetry showing agent alias, operating system, MAC address, status, schedules, and available actions.

Configure QMetry Automation Agent using Command Line

Follow the steps mentioned below to configure QMetry Automation Agent for Windows and Linux/MacOS.

Configure QMetry Automation Agent using Command Line on Windows

  1. Go to Integration > Automation Agent.

  2. Expand the Download & Run Agent section, if not expanded already.

    Screenshot of the “Download & Run Agent” section in QMetry showing expandable instructions to launch the Automation Agent via the Windows command line.

  3. You will find Agent download and installation instructions on the screen. Download QMetryAgent.zip by clicking on the Automation Agent download link.

    Screenshot of the “Download & Run Agent” section in QMetry showing detailed steps to download, extract, and run the Automation Agent via the Windows command line, including start and stop commands for both Windows and Linux/Mac.

    Note

    The downloaded zip file will be in the format QMetryAgent_A.B.C.zip, where A.B.C will be the version of QMetry Agent.

  4. Copy the QMetryAgent_A.B.C.zip file to your server. Then, navigate to the directory where this file is kept and extract the zip file to the computer drive.

    Screenshot of the extracted QMetry Automation Agent folder (QMetryAgent_8.15.0) in Windows File Explorer showing configuration files, JAR files, batch files, shell scripts, and VBScript launcher.

  5. Execute the following command to run the agent.

    startAgent.bat

The QMetry Automation Agent command line wizard will open. Users need to fill required information.

Fields

Description

URL

The URL of your QMetry Test Management application instance.

Key

Enter Automation Agent Key. To generate an Automation Key, go to Integration > Automation Agent and click Generate Key as described under Automation Agent Key above.

Alias

Enter the name of your preference as Agent Alias to identify the specific agent.

Enable Proxy

Users who want to run the agent on a proxy can do so by setting this configuration.

Enable VM

Users who want to run agent on virtual machine, can do so by setting this configuration. The manual settings are not required.

Screenshot of Windows Command Prompt showing QMetry Automation Agent setup steps, including prompts for URL, API Key, Agent Name, Proxy Server, and VM option.

This will enable the agent to start automatically when the system reboots.

To stop the running agent: Run stopAgent.bat by clicking on it.

→ Interval Time: By default, the interval time between two scheduled jobs will be 180 seconds. You can change the time by modifying the "Interval" parameter in the QMetryAgent.properties. The minimum value should be 60 seconds.

Configure QMetry Automation Agent using Command Line on Linux / MacOS

  1. Go to Integration > Automation Agent.

  2. Expand the Download & Run Agent section, if not expanded already.

    Screenshot of the “Download & Run Agent” section in QMetry showing expandable instructions to launch the Automation Agent via the Linux or MacOS command line.

  3. You will find Agent download and installation instructions on the screen. Download QMetryAgent.zip by clicking on the Automation Agent download link.

    Screenshot of the “Download & Run Agent” section in QMetry showing detailed steps to download, extract, and run the Automation Agent via Linux or MacOS command line, including start and stop commands with prerequisite shell permission settings.

    Note

    The downloaded zip file will be in the format QMetryAgent_A.B.C.zip where A.B.C will be the version of QMetryAgent.

  4. QMetryAgent_A.B.C.zip

    unzip QMetryAgent_A.B.C.zip

    Note

    Replace A.B.C with the actual version of QMetryAgent.

    Screenshot of a MacOS terminal showing the user inside the extracted QMetryAgent_8.15.0 directory after running the unzip command.

  5. Execute the following commands.

    chmod +x startAgent.sh
chmod +x stopAgent.sh

    Note

    Replace A.B.C with the actual version of QMetry Agent.

    QTM_Screenshot_Agent_Directory_Execute_Commands_Linux_MacOS.png

  6. Run the agent by executing the following command.

    sh startAgent.sh

The QMetry Automation Agent command line wizard will open. Users need to fill required information.

Field

Description

URL

The URL of your QMetry Test Management application instance.

Key

Enter Automation Agent Key. To generate Automation Key, go to Integration > Automation Agent and click on the Generate Key as described under Automation Agent Key above.

Alias

Enter the name of your preference as Agent Alias to identify the specific agent.

Enable Proxy

Users who want to run the agent on a proxy can do so by setting this configuration.

Enable VM

Users, who want to run the agent on the virtual machine, can do so by setting this configuration. The manual settings are not required.

Screenshot of a MacOS terminal inside the QMetryAgent_8.15.0 directory showing the commands chmod +x startAgent.sh and chmod +x stopAgent.sh being executed to grant script permissions.

Note

This will enable the agent to start automatically when the system reboots.

To stop the running agent:

sh stopAgent.sh

→ Interval Time: By default, the interval time between two scheduled jobs will be 180 seconds. You can change the time by modifying the Interval parameter in the QMetryAgent.properties. The minimum value should be 60 seconds.

Once the Agent is configured, it will be added to the list of Registered Agents with the Status Active.

Screenshot of the Registered Agents list in QMetry showing multiple agents with details such as alias, operating system (Windows, Mac OS X), MAC address, status (Active, Not Registered, Inactive), schedules, and actions.

The screen lists all agents added in QMetry with the details of OS, Machine Address, Status (Not Registered, Active, Inactive, Not Applicable), ScheduledIn Progress

Filter Options

You can filter the Registered Agents on the following criteria:

  • Alias

  • OS

  • Status

After configuring the Agent in Integration > Automation Agent, download and run the Agent. Schedule tasks for the Agent to perform automation testing.

The columns on the screen are described below:

  • Alias: This is Agent Alias mentioned by the user while adding Agent.

  • OS: Operating System on the hosting machine on which the command will be executed.

  • MAC Address: The machine address of the hosting machine on which the command will be executed.

  • Status: The Agent status could be Active, Inactive.

    • Active: QMetry Agent is executed to request a schedule from the QMetry application. When you start the agent, it attains Active status and remains Active till it keeps requesting for schedule from QMetry application at the frequency defined.

    • Inactive: As stated above, QMetry Agent and its connection with QMetry application are checked at a defined interval. If QMetry Agent is not communicating with QMetry application for more than the defined time and it stops requesting for schedule, then the QMetry Agent status is updated as Inactive.

  • Schedules: The column shows the number of pending schedules and in-progress schedules. For example, 4 Scheduled / 2 In-progress.

  • In Progress: This column shows when a scheduled run is currently in execution.

  • Updated At: This is the system date and time when the Agent is added to QMetry.

The Actions column includes the Schedule, History, Manage Schedule, and Delete buttons.

  • Schedule Agent: Click on the Schedule button to schedule QMetry Agent run.

In this section:
© 2026
Publication date: