Installing Agent

Installing Agent

1. Download and Install Agent Application

The agent allows you to access your machines or devices remotely, making it easier to debug. Learn more about Agents
To run test cases on local machines, the first step is to download and install the agent.
Notes
Note: The agent is supported for Mac, Windows, and Linux operating systems.

1.1 System Requirements 

Hardware

Minimum

RAM

4 GB

Processor

2 CPU cores

1.2 Installation of Agent

To setup the agent for your machine, follow these steps:
  1.  Navigate to Setup > Test Execution > Agents to download the installable for your machine.



  2. or

    From Projects, navigate to Settings > Agents for the same.



  3. Select and download the file for the required OS.

1.2.1  Install Agent for macOS:  

  1. After download, double-click the file to start the installation process.
  2. In the popup that appears, drag and drop the agent application to the Applications folder.
  3. Run the agent by clicking on the installed application. If the agent is successfully running, you should see the Zoho QEngine () icon in the system tray.
  4. Click OK. Navigate to System Settings > Privacy & Security and scroll down to the Security section. Select the App Store and identified developers option. Give permission to your system to make the changes.
  5. Upon clicking the icon (), the dropdown allows you to perform various actions.

    Restart: To terminate its current state and then initiate it again from the beginning
    Stop: To put a halt on its current state and disconnect from Zoho QEngine
    Register Agent: To register the agent with your desired Zoho QEngine project. <Learn more>.
    About Agent: To display the configuration details of your agent page
    Quit: To exit and close the agent application

1.2.2 Install Agent for Windows: 

  1. To start the installation, double-click the downloaded installable.
  2. Click Next in the InstallShield Wizard for Zoho QEngine.
  3. Read the License Agreement, then accept the terms and conditions.
  4. Set the Destination Folder, then click Next.
  5. Once the installation is complete, click Finish.
  6. If the agent is successfully running, you should see the Zoho QEngine () icon in the system tray.

1.2.3  Install Agent for Linux:

  1. Download the Linux Installation file (.bin) file

  2. Open terminal and navigate to the file downloaded path

  3. Change the bin file to executable mode, using the following command:
    chmod +x ZohoQEngine-Agent-64bit-<version>.bin

  4. To make the file executable, run it as follows:
    ./ZohoQEngine-Agent-64bit-<version>.bin

  5. After executing the bin file, the installer will be open. Follow the steps in the InstallationShield Wizard and complete the installation.
Upon successful installation, the agent will be started automatically.

Steps for Uninstalling Linux Agent:
  1. Navigate to the folder where the Zoho QEngine Agent is installed using the terminal.

  2. Execute the command below:
    ./Uninstall\ ZohoQEngine

  3. Follow the steps in the installer and complete the uninstallation.
Steps to update to the Latest Version:
  1. Download the .bin file from qengine.zoho.com

  2. Open the terminal and navigate to the path where the file is downloaded.

  3. Change the bin file to executable mode using the following command:
    chmod +x ZohoQEngine-Agent-64bit-<version>.bin

  4. To start the installation, run the following command:
    ./ZohoQEngine-Agent-64bit-<version>.bin

  5. After executing the bin file, InstallationShield will open.
    1. If the user tries to update the agent while the older instance is already running, the Prerequisite Window will pop up. Clicking on Yes will remove the older version of agent and the new version will be installed.
    2. If the user tries to update the agent on the existing agent's path, the confirmation window pops up. Clicking on Yes will remove the older version of the agent and new version will be installed.
Upon successful installation, the agent will be started automatically.

Notes
Note: 
  1. Agent will be only be started automatically at the time of installation. For manual start, navigate to the /home/<user-name>/Desktop/ZohoQEngine folder in the terminal and run the command below:
    ./StartServer

  2. For stopping the agent, navigate to the /home/<user-name>/Desktop/ZohoQEngine folder using the terminal and run the command below:
    ./StopServer

 2. Related Links 

  1. Agents