Zephyr On-Premise Upgrade Instructions for Windows
Download Zephy
Download Zephyr on the following page: Zephyr Download.
Zephyr Enterprise currently supports only upgrades to the supported versions. See Zephyr End-of-Life Policy.If you need to upgrade from an older version, contact support.
Zephyr Enterprise Release 8.1 and later supports the latest Java 17 or OpenJDK 17.0.13 versions. You can download Java 17 and OpenJDK 17.0.13 from the respective download page.
Important
As you transition to Zephyr Enterprise version 8.5.0, please be aware that the upgrade process may take more time, especially with substantial data. Prepare for possible downtime. If you encounter any upgrade issues, like the "lock table size" error, review and adjust the MySQL settings. If you require further assistance or encounter additional issues, we encourage you to contact our support team for resolution.
Caution
Run the following query to check for data corruption before upgrading your MySQL database to version 8.4.5 or later. See, Validating Data Corruption in MySQL Database for more information.
Remember to take a full database backup before upgrading.
You need to restart the MySQL database before upgrading Zephyr Enterprise, as MySQL 8.4.5 and later versions have an issue .
Step 1: Zephyr Enterprise supports MySQL v8.4.5 effective from v8.5.0. Therefore, if you use MySQL, upgrade your MySQL DB to v8.4.5 before upgrading your Zephyr Enterprise to v8.5.0.
Step 2: Follow this step if you want to use ES 8.6.2.
Important
To use ES 8.6.2, uninstall the previous Elasticsearch version before installing ES 8.6.2. Please see the Windows instructions below:
Uninstall the previous Elasticsearch version.
If you installed it as a service, go to Control Panel > Uninstall a program and uninstall Elasticsearch.
If you just unpacked the ZIP file, stop Elasticsearch and delete the elasticsearch-<version> folder from the computer:
Download and configure Elasticsearch 8.6.2 . Refer to Elasticsearch Single Node - On Windows for installation and configuration details.
Start Elasticsearch by double-clicking the elasticsearch.bat file:
To verify the version of ES in the browser, type the host name with port 9200.
In the response - it should be 8.6.2
Step 3: Take a backup of the entire database: Steps to take adatabase backup.
Step 4: Restart MySQL DB before doing the upgrade.
Step 5: Back up the attachments located in the file system (separate from the database).
Step 6: Check the Server.xml file.
Stop the Zephyr Server.
Open the file zephyr/tomcat/conf/server.xml and comment out the line below:
<!-- <Connector port="8009" protocol="AJP/1.3" redirectPort="8443" /> -->
The connector location will look like the following once the above lines are added and additional other highlighted changes are made:
<Connector port="443" protocol="org.apache.coyote.http11.Http11NioProtocol" SSLEnabled="true" acceptCount="100" maxThreads="150" scheme="https" secure="true" clientAuth="false" sslEnabledProtocols="TLSv1.2" sslProtocol="TLS" keystoreFile="C:/Program Files/Zephyr/tomcat/ssl/mysslkey.jks" keystorePass="changeit"> <!-- SSLHostConfig added to ensure proper initialization --> <SSLHostConfig hostName="_default_"> <!-- Using JKS keystore directly, no need for separate certificate/key files if using JKS --> <Certificate certificateKeystoreFile="C:/Program Files/Zephyr/tomcat/ssl/mysslkey.jks" certificateKeystorePassword="changeit" certificateKeystoreType="JKS"/> </SSLHostConfig> </Connector>
Save the file, exit and then you can start the upgrade process.
Important
If SSL is previously set up in Zephyr, take a copy of your Java keystore file, which is present under the Zephyr/tomcat/conf path file. For special SSL consideration, see here.
Step 7: Replace the recommended connector jar file.
Refer to the steps below to replace the recommended connector jar file for MySQL or MSSQL. The instructions are provided separately for each connector:
Stop the Zephyr Server Service.
Take a backup of jdbc.properties file from location <Zephyr installation directory>\tomcat\webapps\flex\WEB-INF\classes
Go to <Zephyr installation directory>\tomcat\webapps\flex\WEB-INF\lib folder and take a backup of the old jar file, which is mysql-connector-java-5.1.49-bin.jar, mysql-connector-j-8.0.32.jar from the folder.
For example, jarFileName = mysql-connector-j-9.2.0.jar.
Remove the existing jar file (mysql-connector-java-5.1.49-bin.jar, mysql-connector-j-8.0.32.jar) from <Zephyr installationdirectory>\tomcat\webapps\flex\WEB-INF\lib folder.
Download the recommended jar file.
MySQL: mysql-connector-j-9.2.0.jar (Path: https://downloads.mysql.com/archives/get/p/3/file/mysql-connector-j-9.2.0.zip)
For example, jarFileName = mysql-connector-j-9.2.0.jar
Copy the downloaded jar and paste it to <Zephyr installation directory>\tomcat\webapps\flex\WEB-INF\lib folder.
Go to <Zephyr installation directory>\tomcat\webapps\flex\WEB-INF\classes folder. Open the jdbc.properties file and change the value in “jarFileName =” parameter to the used jar file name.
For example, jarFileName = mysql-connector-j-8.4.5.jar
Upgrade to 8.x.
During extracting files, we get a popup. Clicking Yes/No or Yes to All/ No to All does not affect upgrade process and the process completes.
Note
If it is a cluster setup, you must perform the above steps on all nodes.
Stop Zephyr Server Service.
Take a backup of jdbc.properties file from location <Zephyr installation directory>\tomcat\webapps\flex\WEB-INF\classes
Go to <Zephyr installation directory>\tomcat\webapps\flex\WEB-INF\lib folder and take a backup of old jar file i.e., sqljdbc42.jar from lib folder.
Remove the existing jar file (sqljdbc42.jar) from <Zephyr installation directory>\tomcat\webapps\flex\WEB-INF\lib folder.
Download the recommended jar file.
MSSQL: mssql-jdbc-11.2.3.jre8.jar (Path: https://go.microsoft.com/fwlink/?linkid=2221563)
File will be downloaded as zip with name sqljdbc_11.2.3.0_enu.zip. Please extract this zip file.
MSSQL: mssql-jdbc-11.2.3.jre8.jar file can be found inside the downloaded zip path sqljdbc_11.2.3.0_enu\sqljdbc_11.2\enu folder.
Copy mssql-jdbc-11.2.3.jre8.jar and paste it to <Zephyr installation directory>\tomcat\webapps\flex\WEB-INF\lib folder.
Go to <Zephyr installation directory>\tomcat\webapps\flex\WEB-INF\classes folder. Open the jdbc.properties file and append the parameters in the DB URL for ITCC and Dversion.
Example as below:
db.url = jdbc:sqlserver://localhost:1433;encrypt=true;trustServerCertificate=true;databaseName=itcc db.dversion.url = jdbc:sqlserver://localhost:1433;encrypt=true;trustServerCertificate=true;databaseName=dversion
Go to <Zephyr installation directory>\tomcat\webapps\flex\WEB-INF\classes folder. Open the jdbc.properties file and change the value in “jarFileName =” parameter to the used jar file name.
For example, jarFileName = mssql-jdbc-11.2.3.jre8.jar
Now upgrade to 8.x
Note
If it is a cluster setup, you must perform the above steps on all nodes.
Step 8: Take a backup of the node data located in the file system.
We suggest you take a backup of the entire folder which can be found in Windows under the Zephyr Directory (ZephyrDir) or in Linux within /nodedata.
Note
Please take care of it if you have two or more nodes while upgrading the cluster environment:
The process of installing, updating, and executing the node occurs in a single step, starting from copying the update files.
Do not run the Upgrader simultaneously on all nodes, as it may lead to issues with database consistency.
First, execute the Upgrader on a single node until it completes, and then proceed with upgrading the rest of the nodes.
Step 9: Stop the Atemis Services, if you are upgrading from 8.3 and later version.
Step 10: Install RabbitMQ 4.1 (Optional):
RabbitMQ 4.1 is a robust messaging and streaming broker that's easily deployable across cloud environments and on-premises setups. Currently, installing RabbitMQ is optional for the users. You can download RabbitMQ 4.1 here.
Step 11: Install ZE-Services (Optional):
Note
This is optional for the current release.
Java 17 is required for the service.
ZE-Webhook Service is the component responsible for accepting the incoming events from Jira and enqueues them to the message broker for further processing. You can download ZE-Webhook Service - here and find the installation instructions - here.
ZE-Consumer Service is the component that picks the enqueued events from the message broker and updates ZE with the incoming data. You can download ZE-Consumer Service - here and find the installation instructions - here.
ZE-AuditService is the component that acts as the incoming endpoint for the Audit Logs generated during the incoming webhook event processing and enqueues them to the message broker. You can download ZE-AuditService - here and find the installation instructions - here.
ZE-AuditProcessor is the component responsible for reading the enqueued audit logs from the message broker and inserting them into ZE. You can download ZE-AuditProcessor - here and find the installation instructions - here.
Tip
RabbitMQ and ZE Services should be installed in a separate server as we require Java 17.
Upgrade on Windows
Perform the following steps to upgrade on Windows:
The upgrade procedure
1. Stop the Zephyr server.
 |
2. Start the Zephyr installer as an administrator on the first node and upgrade the product as shown below:
3. After you install Zephyr, make sure it is up and running.
When Zephyr starts, you will see the following line in the zephyrlocation/tomcat/logs/thedinc.log log file:
***************** Zephyr Started ****************
4. Stop the Zephyr service:
 |
Post-upgrade steps
Step 1: After upgrading, we recommend users clear their browser cache when accessing their Zephyr application if you are experiencing issues regarding cached pages.
Step 2: After upgrading, , If the Index is not 100%, then it is recommended for users to perform a re-index of your Zephyr instance to ensure the integrity of your data and information within the Zephyr instance. For more details on reindexing refer Full Reindex.
Step 3: Update the Tomcat configuration
Stop the Zephyr application server.
Locate the server.xml file under the Zephyr installation directory. (Zephyr Directory}\tomcat\conf)
Open the server.xml file and locate the <Host> tag.
Add the following value below the <Host> tag:
<Valve className="org.apache.catalina.valves.ErrorReportValve" showReport="false" showServerInfo="false" />
Save the server.xml file.
Start the Zephyr application server.
Step 4: Update Artemis ( If you are upgrading from Zephyr 8.3 and above)
After taking a data backup, you can update the Artemis Service. Refer to Upgrading Zephyr Version from 8.3 or later with Artemis Service for more information on updating Artemis Service for Windows and Linux.
Step 5: Update ZBot. You can download the ZBot installation file either from Zephyr by clicking the username in the top-right corner and selecting Download ZBot from the dropdown, or by going directly to http://<your_zephyr_server>/zephyr/zbot .
Step 6 (optional): This Step is only applicable If ZE-Service is Enabled. Once the upgrade is successful:
On logging into Zephyr, user will get the below popup (if Jira is integrated before the upgrade)
Once the user navigates to the Jira Integration page → the Jira connections will be highlighted in RED as shown in the below screenshot:
Once all services are up and running → For Automatic webhook management → click on the Update Webhook button from the Jira Integration page.
In Jira, the webhook URL will be updated as per the new webhook URL:
The new webhook URL would be something like: https://webhook.yourzephyr.com/v1/jira/webhooks/callback
Step 7 (optional): This Step is only applicable If ZE-Service is Enabled.
For Manual webhook management, copy the URL from the popup as shown in the below screenshot and go to Jira, to create a webhook with the new URL. The below popup will appear when integrating a Zephyr project with a Jira project or In Jira Integration → click on the Edit icon under the Action column and save the Jira Integration again.
Post-upgrade recommendations for special considerations and scenarios
These scenarios are based on whether or not users may have certain features enabled (SSO/etc.) These are not applicable to all customers.
Note
Users must disable binary logging in MySQL 8.4.5, which is enabled in default. For more information, see Step 5: Install Zephyr and Connect to the Database.
SSO Consideration: If you have SSO set up, your users may run into the following scenario.
The Zephyr login page will now auto-redirect to the SSO page if zephyr is integrated with SSO.
For the Internal-login page, there will be no redirection. On that page, the login will contain the same behavior in the scenario that the admin wants to change the integration.
https://<Zephyr domain>/flex/html5/internal-login
When a user logs out of the system, they will be able to view the 2 following options:
A normal login (Internal login for users)
A Single Sign-On login (SSO)
The advantage of this is that if an SSO user is logged into their SSO already and that user hits the Zephyr URL, the user does not need to type their username and password. When navigating to the Zephyr URL, the SSO user will automatically be logged into Zephyr.
Important
Linked test case statuses in Jira
From Zephyr Enterprise 7.21 and later, we've removed the support of the remote link created in Jira. However, any old or existing links in Jira that have remote links pointing to test cases in Zephyr will still display in Jira.
The reason for this is that Zephyr cannot update/remove those existing remote links during the upgrade process.
However, we recommend using the ZE Plugin to view the traceability report in Jira Zephyr Enterprise Jira Plugin.
Rollback process
Rollback may be required in the following cases:
When the Zephyr server is not stopped prior to the user starting the upgrade process.
When Zephyr is configured with Tomcat VisualVM memory configuration and then the Zephyr server stops, and the user performs an upgrade process.
If a rollback is required, follow the instructions in Zephyr On-Premise Rollback Process.