| Redirect | ||||||
|---|---|---|---|---|---|---|
|
What is
...
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)ZBots help you automate your test cases: when ZBot is running, you can execute Zephyr Vortex jobs that will add automated test cases to the specified folder and create test cycles on the Test Planning page. When a user runs an automated test case on the Test Execution page, the Zephyr Server connects with to the target ZBot and , sends over execution information to execute an individual test script to it to run one or multiple test scripts., and then retrieves test results to parse and send them to Zephyr:
Download
...
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.
...
You can download ZBot directly from Zephyr:
1. Click your username in the top-right corner of the main Zephyr screen and select Download ZBot from the menu:
2. In the subsequent dialog, specify a name for your ZBot so that you can easily identify it in Zephyr and click Download:
3. Unzip the downloaded archive to some folder on your hard drive:
Run ZBot
You can start ZBot right after downloading, there is no need to configure it in any way. It is preconfigured to use your Zephyr URL, username and password,
...
however, you can
...
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.
change these values in the conf\zbot.properties file, if needed.
You start ZBot in different ways, depending on the operating system you use:
Windows:
- Run the zbot_start.bat batch file to start ZBot. To shut it down, just close the terminal.
- To start ZBot automatically, you can schedule to run the batch file automatically by using Windows Task Scheduler.
To start ZBot as a service when your computer starts, just run the zbot_install_service_64.bat file.
Linux:
- Run zbot_start.sh to start ZBot.
- Run zbot_stop.sh to stop it.
You can also schedule to start ZBot automatically.
Create a Vortex job
A job is a task with a number of parameters. You use it to automate your test cases. You can create two types of jobs: Automation and Folder Watcher.
- An Automation job allows you to trigger an execution directly from Zephyr, and once the automation is done, it posts the results to Zephyr.
- A Folder Watcher job waits for results to appear in the specified results folder, and if any report file is generated, it posts the results to Zephyr.
To create a job,
- Switch to Vortex in the pane on the left, click the Automation or Folder Watcher tab if you want to create an Automation or Folder Watcher job respectively, and then click the plus sign:
2. In the subsequent window, specify the needed parameters and click Add at the bottom of the page:
3. Now when you have a job, you can run it by clicking E in the Execute Job column, or Execute in the top-right corner of the screen.
For more information on Vortex, see Zephyr Vortex.
| Note |
|---|
Before running a job, you need to start ZBot. You can execute your jobs only when ZBot is running. |
API tokens
Downloading ZBot also creates a Zephyr API token (a token is generated automatically based on the ZBot name) and adds it to the ZBot properties file. You can then use this token to control your ZBot via API. To view the API tokens you have created or to create a new one, click your username in the top-right corner and select API Token from the menu:
See Also
Executing Automated Test Cases
Create and Manage API Tokens in Zephyr