Background

From codeBeamer 9.4.0, codeBeamer is shipped with a 3-rd party jdbc driver. It is strongly recommended replacing this driver with the official MySQL driver as soon as possible to ensure best performance and stability.

During installation the system administrator will be asked if he agrees to download the official driver as part of the process and the driver can be used further without any restrictions.

However there are cases when it's not possible to download the driver right away (servers without internet connection, network errors, etc.). For these cases we have created a step-by-step guide, how to replace the driver manually.

Please note: the shipped MariaDB driver is not supported to use, so please do replace as soon as you can.

Replacement steps

1. Stop codeBeamer
2. Replace the database driver binaries:
   1. Download the MySQL provided driver.
      1. Before codeBeamer 20.11-final, use this link.
      2. Starting from codeBeamer 20.11-final, but before Emma, use this link.
      3. Starting from Emma, use this link.
   2. Copy the downloaded mysql-connector-java-x.y.z.jar into {codeBeamer installation directory}/tomcat/webapps/cb/WEB-INF/lib directory and rename to mysql-connector-java.jar
   3. Before 20.11-final, delete the MariaDB driver (mariadb-java-client.jar) from {codeBeamer installation directory}/tomcat/webapps/cb/WEB-INF/lib
3. Modify the database connection configuration:
   1. Open {codeBeamer installation directory}/config/configuration.properties
   2. Modify the database.driver and database.connectionURLproperties as highlihgted:
      1. database.driver=com.mysql.jdbc.Driver
      2. database.connection.URL=jdbc:mysql://{databaseHost}:{databasePort}/{schema}?autoReconnect=true&zeroDateTimeBehavior=convertToNull&emulateLocators=ture&characterEncoding=UTF-8
4. Start codeBeamer

Example configurations

Content of {codeBeamer installation directory}/config/configuration.properties

MariaDB driver

database.driver=org.mariadb.jdbc.Driver
database.connectionURL=jdbc:mariadb://localhost:3306/codebeamer?autoReconnect=true&zeroDateTimeBehavior=convertToNull&emulateLocators=true&characterEncoding=UTF-8&useSSL=false
database.username={user}
database.password={password}
database.passwordStorageType=PLAIN
location.scheme=http
location.hostName=192.168.0.122
location.port=8080

MySQL driver

database.driver=com.mysql.jdbc.Driver
database.connectionURL=jdbc:mysql://localhost:3306/codebeamer?autoReconnect=true&zeroDateTimeBehavior=convertToNull&emulateLocators=true&characterEncoding=UTF-8&useSSL=false
database.username={user}
database.password={password}
database.passwordStorageType=PLAIN
location.scheme=http
location.hostName=192.168.0.122
location.port=8080