Upgrading from Older Versions - Simple - Before Codebeamer 21.09 (EMMA)

This document describes how to upgrade to Codebeamer 9.x from older Codebeamer 8.x releases running with MySQL or Oracle.

For the supported upgrade paths, see page Codebeamer Upgrade - Tested Paths.

This method cannot be used for any older Codebeamer versions.

To control the whole upgrade process, use this upgrade guide: Upgrading from Older Versions - Advanced - Before 21.09 (EMMA)

Only MySQL 5.7 and Oracle 19 are supported. Upgrade your MySql/Oracle instance before upgrading your Codebeamer instance. To upgrade to newer version than 21.09 (Emma), first upgrading to Emma is required.

The old Codebeamer installation will be referred as OLD-CB, the new one as NEW-CB throughout this document.

Step 1. Install NEW-CB

Install NEW-CB into a new directory (the installation must not be executed into an existing directory) and do not start the CB server at the end of the installation.

Step 2. Start Upgrade Script

Windows

NEW-CB\upgrade\upgrade.bat

Unix

NEW-CB\upgrade\upgrade.sh

Go through upgrade steps.

In case of error, fix the problem and start the whole process again. Reinstall new Codebeamer.

Step 3. Get a New License

Check the appropriate Release-Notes whether a new license is required.

You need to have that license at hand before you continue with the next steps.

Also consider that you can only request licenses from the PTC Licensing Team from Monday through Friday, 8:00 - 17:00 GMT+2, and that processing a license request may take hours up to several days!

Do not shut down your live production system or schedule to upgrade overnight or during the weekend until you already have a license for the new system.

To install the new license:

1. Log in to Codebeamer with System Admin and open System Admin > License page.
2. Click Edit License and insert the new License.
3. Once done, click Save.

For further information on licensing, see pages Managing Licenses and Licensing with FlexLM.

Step 4. Runtime Parameters

If you had customized OLD-CB runtime variables, e.g. special JVM, HEAPSIZE, etc., then you should copy these settings from the OLD_CB start script to the NEW-CB start script.

For changes in ~/NEW-CB/tomcat/bin/cbservice.bat to take effect, you must run the following command manually afterwards

cbservice codebeamer codebeamer

Step 5. Start

Start the NEW-CB server. The first time the Codebeamer server is started, the database schema will be upgraded to version NEW-CB.
Depending on which version you're upgrading from, and the amount of data in your database, the first startup of the NEW-CB server might take up to 10-120 min, because the database scheme will be updated in the background (the database process might use a lot of CPU).

Do not shutdown or kill the NEW-CB server as long as the database upgrade is in progress, otherwise the database might be corrupted.

Step 6. Clearing Browser Caches

Since browsers cache javascript files, the cached javascript files must be re-loaded. We strongly recommend clearing the browsers' cache and then re-starting the browser.

Step 7. Starting Re-Indexing

1. After upgrading, the index database is empty, thus searching will not return any match.
2. Perform a re-indexing of artifacts by going to System Admin ► Indexing ► click on [YES, drop file cache and re-index!]

Note: during the re-indexing process, the search result may not contain all matches, so it is recommended to perform out of business hours.

Step 8. Validate Logs

Check that ~/NEW-CB/tomcat/logs/errors.txt does not contains any error. In case of errors, create a bug ticket on https://codebeamer.com with the attached log files (cb.txt / errors.txt)

Step 9. Git Http-Backend Verification ( Optional, for Windows-Based Installation )

Go to System Admin ► Application Configuration and verify and update the "http-backend" key in "git" section:

"git" : {
      "http-backend" : "C:\\NEW_CB_\\libexec\\git\\mingw64\\libexec\\git-core\\git-http-backend.exe",