Setup an existing MySQL database for codebeamer X

Pre-actions

• Have an existing MySQL5.7* installation.
• Go through the Installation steps of Installing codebeamer X on a Linux distribution or Installing codebeamer X on Windows.

Configure your MySQL database

1. Open the MySQL configuration file and insert the following line under the [mysqld] tag:
   

   character_set_server=utf8mb4
   character_set_filesystem=utf8mb4
   collation-server=utf8mb4_general_ci
   skip-character-set-client-handshake
   max_allowed_packet=128M
   sql_mode = 'STRICT_TRANS_TABLES,NO_ENGINE_SUBSTITUTION'

2. The configuration file is:
   • Windows:
     • my.ini (directory e.g., C:\ProgramData\MySQL\MySQL Server 5.7)
   • Linux:
     • my.cnf (directory: /etc/mysql/)
3. In order for codebeamer X to access a MySQL database, an appropriate database schema and user have to be prepared. Any username and password can be used instead of the cbroot and cbpassword used below:
   
   
   1. Open a terminal and navigate to the $MYSQL_HOME$/bin directory (on windows e.g., C:\Program Files\MySQL\MySQL Server 5.7\bin).
   2. Execute the command: mysql -u root -p. When asked, provide the password which was configured during the installation.
   3. Execute commands:
      

      CREATE DATABASE codebeamer default character set 'utf8mb4' default collate 'utf8mb4_general_ci';
      CREATE USER 'cbroot'@'localhost' IDENTIFIED BY 'CbPassword01!';
      GRANT ALL PRIVILEGES ON codebeamer.* TO 'cbroot'@'localhost';
      FLUSH PRIVILEGES;

Setup during post-install

1. Follow the Post-installation steps from How to install on Linux or How to install on Windows.
2. Set the database's access in step 6.
3. Continue the post-install process.

Setup the configuration file

• Edit/create the configuration file: <cbX-installation-dir>/config/configuration.properties:
  

  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=pass
  database.passwordStorageType=ENCRYPTED