Installing codebeamer Service Packs

Service pack files should not be installed in docker environment. If available, the corresponding docker tag has to be pulled.

Starting from version 10.0.1, codeBeamer patches are provided in service packs. A service pack contains multiple fixes. Individual fixes for specific bugs will not be available.

Service packs are identified by an SP-number, and that appears also in the product version. For example, after applying Service Pack 1 in a 10.0.1-final installation, the version number becomes 10.0.1-SP1.

Service packs are cumulative (e.g. SP2 contains all the changes included in SP1).

All items of final Service Packs (without any further prefix like "beta") are functionally tested and the whole package goes through a smoke tests, but not tested for regression.

Before applying a Service Pack, create a backup of codebeamer web application's directory! This is needed for reverting from a service pack if necessary. Also, if customizations are made to codebeamer by editing files, then the altered files need to be copied back after applying a service pack.

Service pack files can be downloaded from this folder: Service Packs

In general, codeBeamer web application directory is located at <codeBeamer install directory>/tomcat/webapps/<context>. These are the two most common scenarios for <context> in practice:

• If you have "/cb" in the URL for accessing your codeBeamer (e.g. the link to login page is like https://your.codebeamer.server/cb/login.spr ) then web application folder is <codeBeamer install directory>/tomcat/webapps/cb
• If there is no "/cb" in the URL (e.g. the link to login page is like https://your.codebeamer.server/login.spr ) then the folder is <codeBeamer install directory>/tomcat/webapps/ROOT

Full patch

Full patch contains the new version of a tomcat, and all codebeamer related changes. Patch .zip file contains a tomcat directory.

Follow these steps to apply a full patch:

1. Stop codebeamer server.
2. Locate codebeamer tomcat directory.
3. Make a backup copy of the tomcat directory.
4. Remove <codebeamer install directory>/tomcat directory.
5. Extract the content of Service Pack file into a <codebeamer install directory>.
6. If MySQL database is used, make sure that the MySQL driver (mysql-connector-java.jar) is copied under the<codebeamer install directory>/tomcat/webapps/<context>/WEB-INF/lib directory.
7. Copy back my-applicationContext.xml file under the <codebeamer install directory>/tomcat/webapps/WEB-INF/classes/ directory.
8. Copy back smmapping.xml file under <codebeamer install directory>/tomcat/webapps/config/ directory.
9. Copy back mergefields.vm file under <codebeamer install directory>/tomcat/webapps/config/templates/export/ directory.
10. Copy back /tomcat/logs/ directory into <codebeamer install directory>/tomcat/.
11. Apply all customization such as email templates, tomcat configuration changes, etc.
12. If a different context path is used, rename the <codebeamer install directory>/tomcat/webapps/cb directory.
13. Start codebeamer server.
14. Verify if version number is updated (it is shown at the bottom of each codebeamer page in fine print).

Web app patch

Web app patch only contains the content of the web directory of tomcat.

Follow these steps to apply a service pack:

1. Stop codebeamer server.
2. Locate your codebeamer web application directory.
3. Make a backup copy of the web application directory.
4. Remove <codebeamer install directory>/tomcat/webapps/.
5. Extract the content of service pack file in web application folder.
6. If MySQL database is used, make sure that the MySQL driver (mysql-connector-java.jar) is copied under the<codebeamer install directory>/tomcat/webapps/<context>/WEB-INF/lib directory.
7. Copy back my-applicationContext.xml file under the <codebeamer install directory>/tomcat/webapps/WEB-INF/classes/ directory.
8. Copy back smmapping.xml file under <codebeamer install directory>/tomcat/webapps/config/ directory.
9. Copy back mergefields.vm file under <codebeamer install directory>/tomcat/webapps/config/templates/export/ directory.
10. Copy back /tomcat/logs/ directory into <codebeamer install directory>/tomcat/.
11. Apply all customization such as email templates, tomcat configuration changes, etc.
12. If a different context path is used, rename the <codebeamer install directory>/tomcat/webapps/cb directory.
13. Start codebeamer server.
14. Verify if version number is updated (it is shown at the bottom of each codebeamer page in fine print).