Upgrading to Codebeamer 3.1.0.0 Manually
• This document describes how to upgrade from earlier versions running with Oracle.
• For applications developed by the API, see REST API (v1).
• For the list of the tested upgrade paths, see Codebeamer upgrade tested paths.
 |
Upgrade your Oracle instance before upgrading your Codebeamer instance. To know the Oracle version that your Codebeamer supports, refer to the PTC Release Advisor.
|
|
|
Before you start upgrading, carefully check the Codebeamer release specific requirements, especially the supported Java and Oracle versions.
|
The old Codebeamer installation will be referred as OLD-CB, the new one as NEW-CB throughout this document.
|
|
1. It is imperative that you make a backup of your Codebeamer database before you upgrade.
2. During the installation, Codebeamer and the database must be stopped. Ensure that the database and all java/javaw processes are stopped, otherwise data loss is possible.
The upgrade procedure transfers your installation instance data from the old version to the new version. Migration from the new version back to the old version is not supported.
|
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 the documents directory with the "storage-path" property of the "document" application configuration, copy the 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 them to NEW-CB/repository.
|
Step 3. Database Configuration
Copy the configuration.properties file from from OLD-CB/config to NEW-CB/config.
|
|
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.
|
Oracle Upgrade
To know how to configure an Oracle database for Codebeamer, refer to Preparing Oracle Database for Installation and the section Database Connectivity (Database Host, Username, Password) in Post-installation Configuration.
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.
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.
|
Operating System
|
Path
|
Script
|
|---|---|---|
|
Unix/Linux/Mac OS X
|
~/NEW-CB/bin
|
cb
|
|
Windows (No Service)
|
~/NEW-CB/bin
|
cb.bat
|
|
Windows (Service)
|
~/NEW-CB/tomcat/bin
|
cbservice.bat
|
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.
Step 6. 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 7. 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 8. 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 > and then 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 9. Apache SVN Configuration (Optional)
The 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 10. Git Http-Backend Verification
After upgrading Codebeamer, it is recommended that System Administrators verify that the http-backend key is pointing to the correct directory, that is, the server with the latest git version. If the http-backend key is not pointing to the correct directory, it must be updated manually.
To update the http-backend key:
1. Navigate to > .
2. Find the http-backend key in the git section:
"git" : {
"http-backend" : "C:\\NEW_CB_\\libexec\\git\\mingw64\\libexec\\git-core\\git-http-backend.exe",[supported upgrade paths|https://intland.com/technical-support/#!/supported-version-software]
3. If it points to the incorrect directory, change it to the correct directory.
Step 11. SQL Execution Plan Verification
After upgrading to version 3.1, an issue can sometimes cause Oracle to select the wrong SQL execution plan. To resolve this issue:
1. Run the following script:
EXEC DBMS_STATS.GATHER_SCHEMA_STATS(ownname=> 'CBTEST', cascade=> TRUE, estimate_percent=> DBMS_STATS.AUTO_SAMPLE_SIZE, degree=>DBMS_STATS.AUTO_DEGREE, granularity=>'AUTO', method_opt=> 'FOR ALL COLUMNS SIZE AUTO');
2. Restart Codebeamer.