Upgrading

This chapter describes the various steps of the upgrade process.

Stop All Application Instances and Connections

Before upgrading, you must stop all applications and user connections to Convergence for MDM. During the upgrade:

You should contact your database administrator and middleware administrator to make sure that the unavailability of Semarchy Convergence for MDM during the upgrade process is correctly managed.

Stop all Semarchy Convergence for MDM Applications. This is done either by:

Backup Your Installation

Before upgrading, you should make sure that:

Important: Before going further, make sure that all the required backup are done, and that the entire Semarchy Convergence for MDM environment is stopped and not accessed by any user or application.

Duplicate Repositories and Data Locations (Out of Place Upgrade)

If you have decided to perform an out-of-place upgrade, you must replicate (Copy) the schemas containing the repositories and the data locations using the Oracle Database utilities.
The new product version, considered as a separate installation, will point to this copy of the schemas.

Tip: Use a clear naming convention for these new schemas to be able to identify them easily. For example, if the original schemas are called SEM_REPOSITORY, SEM_DLOC1, etc., the new one may be called SEM_2_2_REPOSITORY, SEM_2_2_DLOC1, etc.

Install the New Application Version

Perform the following operation for every application server into which the Semarchy Convergence for MDM application was deployed.

Installing for In-Place Upgrade

To install the new application version for in-place upgrade:

  1. Deploy the new version Semarchy Convergence for MDM Web Application Archive file on top of the previous version.

Note: Refer to your application server documentation for more information about re-deploying applications on top of previous installations. The simple instructions for Apache Tomcat are provided below.

To perform an in-place upgrade for Apache Tomcat.

  1. Backup the <tomcat>/conf/Catalina/localhost/semarchy.xml file.
  2. Connect to the Apache Tomcat Manager ( http://<tomcat_host>:<tomcat_port>/manager/).
  3. In the Deploy War File section, click the Select File button and then select the new semarchy.war file.
  4. Click the Deploy button.
  5. On the Tomcat server machine, restore the backup of the semarchy.xml file in the <tomcat>/conf/Catalina/localhost/ folder.

Installing for Out-of-Place Upgrade

To install the new application version for out-of-place upgrade:

  1. Deploy the new version Semarchy Convergence for MDM Web Application Archive file as a new application, separated from the previous version.

Warning: When performing an out-of-place update, make sure to deploy the new version as a new application. If this new deployment takes place in the application server that already contains the previous version, make sure to change the application name during the deployment.

Note: Refer to your application server documentation for more information about deploying new applications.

Configure the New Application

Perform the following operation for each deployment of the new Semarchy Convergence for MDM application version.

Configuration for In-Place Upgrade

For in-place upgrade, the updated deployment reuses the configuration already in place. Check this configuration in the application server console or configuration files. The following points should be checked:

Configuration for Out-of-Place Upgrade

To configure the new application version in an out-of-place upgrade:

  1. Configure new JDBC datasources for the new application deployment only. The datasources include repository and data location datasources. They should:
  2. Make sure that the existing JavaMail Session resource is configured or available for the new application.
  3. Make sure that the same security environment is configured for the new application.

Note: Datasources for repositories and data locations should be configured locally for the application. Indeed, the repository datasource must be called SEMARCHY_REPOSITORY. Declaring this datasource at application-level avoids having multiple Semarchy applications (possibly in different versions) try to connect the same repository schema at the same time.

Important: By using datasources local to the new application, you make sure that the new application connects exclusively to the copy of the repository and data locations schemas. Similarly, the old version should use local datasources to connect only the original repository and data location schemas.

Start One New Application Instance

Perform this operation for a single new application version instance. If you have multiple repositories, you should repeat this operation for each repository.
Start your application server or connect to your application server and start the deployed application.

Upgrade the Repository

Note: Repository upgrade is required only for major and minor versions. For patches, repository upgrade is not needed and the Repository Upgrade dialog does not appear when you connect.

Important: The repository upgrade is an operation that cannot be undone. Make sure that you have made a backup of the repository schema before proceeding.

To upgrade the repository:

  1. Connect to the new application instance that you have started, using a user account with the semarchyAdmin role. At the first connection, the Repository Upgrade dialog appears.
  2. Review the dialog.
  3. Click the checkbox and then click the Upgrade button.

The repository upgrade starts. When it completes, the Overview window appears.

Warning: The repository upgrade process can only be triggered by a user with the semarchyAdmin role.

Upgrade the Data Locations

Note: Data locations upgrade is required only for major and minor versions. For patches, data location upgrade is not needed, and the Overview page will not show any data location requiring an update.

Important: The data location upgrade is an operation that cannot be undone. Make sure that you have made a backup of the data location schemas before proceeding.

Warning: Development data locations upgrade is possible only if the current model edition deployed is valid. Before upgrade a development data location make sure that the deployed model does not raise any design-time validation errors.

To upgrade the data locations:

  1. Connect to the new application instance that you have started, using a user account with the semarchyAdmin role.
  2. In Overview page, a warning indicates the list of data locations attached to this repository that require an update.
  3. Click the link under this list to perform the upgrade. The Data Location Upgrade dialog appears.
  4. Review the dialog.
  5. Click the checkbox and then click the Upgrade button.

The repository upgrade starts. When it completes, the Overview window appears.

Warning: The data location upgrade process can only be triggered by a user with the semarchyAdmin role.

Restart All Application Instances

The upgrade is now finished.
You can restart all the Semarchy instances in the new version, and open the access through the user interface, web services and database tables.