Upgrading from a Previous Release

This page walks you through the process of upgrading to BRS 2.2.0 from a previous BRS version. Go to the required tab for step by step instructions based on the upgrade you need to perform. For more information on release versions, see the Release Matrix.

Preparing to upgrade

The following prerequisites need to be completed before upgrading.

• Make a backup of the BRS 2.1.0 database and copy the <BRS_HOME_2.1.0> directory in order to backup the product configurations.
• Download BRS 2.2.0 from http://wso2.com/products/business-rules-server/.

Upgrading the database

The instructions in this section describe how you can perform a data migration to upgrade the 2.1.0 database for use in BRS 2.2.0.

1. Before you upgrade to BRS 2.2.0, create a new database and restore the backup of the BRS 2.1.0 database in this new database.

   Note

   You should NOT connect a new version of WSO2 BRS to an older database that has not been upgraded.

2. Select the mysql.sql script for the upgrade from here and run it on the new database. Running this script will ensure that the new database is upgraded to have the additional tables and schemas that are required for BRS 2.2.0.

Once you run the migration scripts on the new database, it becomes the upgraded database for BRS 2.2.0.

Migrating the configurations

Follow the procedure below to migrate configurations from BRS 2.1.0 to BRS 2.2.0.

1. Check the configurations in the following files in BRS 2.1.0, and apply same configurations in BRS 2.2.0 manually. 

   Configurations should not be copied directly from BRS 2.1.0 to BRS 2.2.0 because the configuration files have new properties added to them as well as obsolete properties removed from them between the two releases.

   Configuration File	Location
   axis2.xml	<BRS_HOME>/repository/conf/axis2
   axis2_client.xml	<BRS_HOME>/repository/conf/axis2
   carbon.xml	<BRS_HOME>/repository/conf
   master-datasources.xml	<BRS_HOME>/repository/conf/datasources
   identity.xml	<BRS_HOME>/repository/conf
   log4j.properties	<BRS_HOME>/repository/conf
   registry.xml	<BRS_HOME>/repository/conf
   catalina-server.xml	<BRS_HOME>/repository/conf/tomcat
   web.xml	<BRS_HOME>/repository/conf/tomcat

2. If the Cipher tool was configured for BRS 2.1.0, check the configurations in the following files and apply the same changes in BRS 2.2.0 manually.

   Configuration File	Location
   cipher-text.properties	<BRS_HOME>/repository/conf/security
   cipher-tool.properties	<BRS_HOME>/repository/conf/security

3. Check the configurations in the other files located in the <BRS 2.1.0_HOME>/repository/conf directory and apply the same changes to BRS 2.2.0 manually.
4. If there are any third party libraries used with BRS 2.1.0 that you want to migrate, copy the following directories as applicable from BRS 2.1.0 to BRS 2.2.0: 
   
   • If you have used JMS libraries, JDBC libraries etc, copy <BRS_HOME>/repository/components/lib.
   • If you have used OSGi bundles such as SVN kit etc, copy <BRS_HOME>/repository/components/dropins.
5. Start the BRS 2.2.0 server. For more information, see Running the Product.

Migrating artifacts

You should manually deploy Composite Application Archive (CAR) files that you have in BRS 2.1.0 to BRS 2.2.0. For more information, see Creating and Deploying Carbon Applications.

Testing the upgrade

1. When the database upgrade scripts are executed, the following are some of the new tables that will be created in the database:
   • UM_DOMAIN
   • UM_SYSTEM_USER
   • UM_SYSTEM_ROLE
   • UM_SYSTEM_USER_ROLE
2. Verify that all the required scenarios are working as expected. This confirms that the upgrade is successful.