| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Starting October 11, 2024 (Zephyr Enterprise 8.2), the Zephyr Enterprise documentation moved from its current location on Atlassian to a dedicated, standalone Zephyr Enterprise documentation page. Please see: https://support.smartbear.com/zephyr-enterprise/docs/en/zephyr-enterprise/zephyr-user-guide/zephyr-test-automation/zbot-overview/installing-and-getting-started-with-zbots.html |
| Table of Contents |
|---|
Prerequisites
...
Before installing ZBot, ensure make sure you must have JDK 8 17.0.10 for ZBot to run.
Java - one of the following:
Update the PATH and JAVA_HOME environment variables
...
for OpenJDK: C:\SomeFolder\java-se-8u41-rijdk-17\bin
for Oracle JDK: C:\Program Files\Java\JDK_117.80.0_<version>\bin
Setting up JAVA_HOME in Windows (steps might vary with Windows version):
...
for OpenJDK: C:\SomeFolder\java-se-8u41-rijdk-17\bin
for Oracle JDK: C:\Program Files\Java\JDK_117.80.0_<version>\bin
Setting up PATH in Linux (steps might vary with Linux version):
Set JAVA_HOME using the syntax
export JAVA_HOME=path to JDK. For example, export JAVA_HOME= /usr/java/jdk1jdk17.80.010_xx/.Set PATH using the syntax
export PATH=${PATH}:path to the JDK bin. For example, export PATH=${PATH}:/usr/java/jdk1jdk17.80.010_xx/binVerify the settings using the following commands:
| Code Block |
|---|
echo $JAVA_HOME |
...
echo $PATH |
The output must display the JAVA_HOME and PATH that you set.
Important: make Make sure you have specified the correct path!.
Download ZBot
...
You may download the ZBot directly from Zephyr:
Click your username in the top-right corner of the main Zephyr screen and select Download ZBot from the menu:
In the subsequent dialog, specify a name for your ZBot so that you can easily identify it in Zephyr and click Download:
Unzip the downloaded archive to some folder on your hard drive:
For windows-
For Linux-
Contents of ZIP file
Zip Package - Once unzipped, the following is present in the unzipped folder:
zbot_install_service_64.bat (To start ZBot and create automatic Services when your computer starts, just run the zbot_install_service_64.bat file in windows)
zbot_start.bat (Run the zbot_start.bat batch file to start ZBot. To shut it down, just close the terminal)
zbot_start / stop shell scripts for Linux & Unix
conf/zbot.properties
zbotsocket/zephyr-socket-@version.jar
Run ZBot
...
For Windows:
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 change these values in the conf\zbot.properties file, if needed.
...
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.
| Info |
|---|
Zbot ZBot must be run as administrator. |
For Linux and MacOS:
...
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 change these values in the conf\zbot.properties file, if needed.
...
| Info |
|---|
Zbot must be run as root. Run the sudo commands for root permission. |
...
To learn how to create and execute a Vortex job, see the corresponding topic:
Script Automation
Suite Automation
Folder Watcher
For more information on Vortex, see Zephyr Vortex.
...