Steps to change the JDBC Driver

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-installation---upgrade-guides/upgrade-zephyr-enterprise/zephyr-on-premise-upgrade-instructions/steps-to-change-the-jdbc-driver.html

This section explains the step-by-step process to update the JDBC driver for a Zephyr installation running on MySQL, MSSQL, or Oracle databases.

Before proceeding, we recommend taking a snapshot or backup of the Zephyr instance.

To update the JDBC driver for a Zephyr installation,

  1. Stop the Zephyr Server Service.

  2. Take a backup of the jdbc.properties file from the location <Zephyr installation directory>\tomcat\webapps\flex\WEB-INF\classes.

  3. Go to <Zephyr installation directory>\tomcat\webapps\flex\WEB-INF\lib folder and take a backup of the lib folder.

  4. Remove the existing jar file (depending on the database used, such as MySQL, MSSQL, or Oracle) under <Zephyr installation directory>\tomcat\webapps\flex\WEB-INF\lib folder.

  5. Download the recommended jar file for the specific database being used:

  6. Copy the downloaded jar file and paste it into <Zephyr installation directory>\tomcat\webapps\flex\WEB-INF\lib folder.

  7. Go to <Zephyr installation directory>\tomcat\webapps\flex\WEB-INF\classes folder.

  8. Open the jdbc.properties file and locate the jarFileName = parameter.

  9. Change the value of jarFileName to reflect the name of the new jar file.
    For example, for MSSQL,
    jarFileName = sqljdbc42.jar

  10. Start the Zephyr Server service.

Note: If the Zephyr instance is part of a cluster setup, these steps must be done on all nodes.