Upgrading from Older Versions - Advanced - Since Codebeamer 21.09 (EMMA)

This document describes how to upgrade from earlier versions running with MySQL/Oracle.
For applications developed by the API, see REST API (v1).
For the supported upgrade paths, see page Codebeamer Upgrade - Tested Paths.

Before Emma version, refer to Upgrading from Older Versions - Advanced

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. Copy Repository Data

Copy the following directories and files from OLD-CB/repository to NEW-CB/repository: (git, hg, src, svn, and acl.svn might not exist, depending on your RDBMS and SCM):

• docs
• git
• hg
• src
• svn
• acl.svn

If you have customized documents directory with "storage-path" application key, copy docs with docs/1 subfolder to NEW-CB/repository in order to pass the initial startup check of the document folder.

Windows:

cd OLD-CB\repository
xcopy docs NEW-CB\repository\docs\ /EH
xcopy git NEW-CB\repository\git\ /EH
xcopy hg NEW-CB\repository\hg\ /EH
xcopy src NEW-CB\repository\src\ /EH
xcopy svn NEW-CB\repository\svn\ /EH
xcopy access NEW-CB\repository\access\ /EH

Unix:

$ cd OLD-CB/repository
$ find acl.svn docs git hg src svn | cpio -updv NEW-CB/repository

If you have customized your OLD-CB/repository structure, e.g. mounted external volumes as docs and/or git, hg or svn, then the above procedure might not be appropriate, and, for the given example, you would better unmount the external volumes from OLD-CB/repository and mount to NEW-CB/repository.

Step 3. Database Configuration

When you upgrade from CB 9.3 or newer, copy configuration.properties file from from OLD-CB/config to NEW-CB/config.

In case you upgrade from CB 9.2 or older copy general.xml instead from OLD-CB/tomcat/webapps/cb/WEB-INF/classes/general.xml to NEW-CB/tomcat/webapps/cb/WEB-INF/classes/general.xml,

If you configure Codebeamer to re-use an existing database and have installed a new license, Codebeamer will convert the existing database schema automatically into the new schema upon first startup, and consequently this database cannot be used by OLD-CB anymore.

MySQL Upgrade

Migrate MySQL 5.7 CB database to 8.0

Oracle Upgrade

Refer to Preparing Oracle Database for Installation and section Database Connectivity in Post-installation Configuration, how to configure an Oracle database for CB-7.x.

Codebeamer database schema requires the CREATE VIEW privilege.
Because this privilege was not required in older releases, it is typically missing, and your database administrator has to grant it manually.

GRANT CREATE VIEW to <codebeamer schema user>

1. Create a dump of the OLD_CB Codebeamer Oracle schema with appropriate commands.
2. Shutdown OLD_CB instance forever.
3. Setup a new Oracle schema as described under Preparing Oracle Database for Installation.
4. Import the dump into the Oracle schema.
5. Adjust Oracle database access data in Codebeamer according to your NEW_CB configuration.

Derby

No upgrade is supported for Apache Derby databases!

Contact the PTC Support Team if you need to upgrade a Codebeamer instance with a Derby database, or want to migrate the Derby database to MySQL or Oracle.

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. Get and Install a New License

Check whether your available license is compatible with target Codebeamer release.

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

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. Copy the new license in XML format from the email you received to the clipboard.
2. Login into Codebeamer with System Administrator and click System Admin > License to paste the license.

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

Step 7. Logo Configuration

To restore your custom logo and welcome text manually, you need to Login as system administrator and re-upload your logo file.

You can find the logo file used by OLD-CB at OLD-CB/tomcat/webapps/cb/images/IL_Logo_120x40.gif.

Step 8. Clearing Browser Caches

Because 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 9. Starting Re-Indexing

After upgrading, the index database is empty thus searching will not provide any matching.

Perform a re-indexing of artifacts by go to System Admin > Indexing > click on 'YES, drop file cache and re-index!

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

Step 10. Apache SVN Configuration (Optional)

acl.svn and .htaccess files have been moved under the <CB install directory>/repository/access/ directory, check the configuration guide for more details Configuring Apache for Subversion.

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

In System Admin > Application Configuration, 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",