Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

What is a ZBot?

Zephyr Bots or ZBots are software agents that reside on target automation systems and form the link between the Zephyr Server and the automation tool being used on the target automation system. Based on user action in Test Execution (where the "E" button is clicked and an automation script(s) is kicked off), the Zephyr Server connects with the target ZBot and sends over execution information to execute an individual test script or multiple test scripts.

Download and Install ZBot

To download and install your pre-configured zBot, please use the Download Pre-Configured zBot button provided in your Zephyr application.

Zephyr provides our users with an option to download a pre-configured zBot. The zBot can be downloaded directly within the Zephyr application for any individual user. 

  • When downloading the zBot from the application, users are able to rename their zBot.

    • When renaming your zBot and viewing it in Vortex, it will display the name of the zBot given and the IP address of the machine.

  • Downloading the zBot will also create a Zephyr API token (auto-generated token from the zBot name) and will automatically add the API token to the zBot properties file.

  • The new zBot download will automatically configure the Zephyr URL, username and password. Once the zBot is downloaded, it can be run right away.

    • If you want to manually configure the Zephyr URL, username and password, then you can edit the zBot properties file in the zBot folder to change anything that you want to. 

1. Navigate to the top-right of the interface (where your name is account name is) and click on the drop-down list to display the various options.

2. Click on the Download zBot button.

  • This will display a pop-up that requires you to name the zBot. Naming the zBot is beneficial as it provides you with an easy way to locate it when using the zBot with Vortex. 

3. Enter the name of your zBot and then click the Download button.

4. Once the ZIP file for the zBot is downloaded. Extract the folder and this folder will contain your pre-configured zBot.

  • From here, you can start and stop your zBot using the files included in the folder. 

The a Zephyr API token (auto-generated token from the zBot name) and will automatically add the API token to the zBot properties file.

Start the ZBot

1. Navigate to the folder where you downloaded your zBot.

2. Use and run the zbot_start.sh file to start the zBot.

Stop the ZBot

1. Navigate to the folder where you downloaded your zBot.

2. Use and run the zbot_stop.sh file to stop the zBot.




  • No labels