Upgrading from 4.1.x to 4.2.0

The following instructions explain how to upgrade an instance of OpenEMPI from a 4.1.x release to the major release 4.2.y.

1. Shutdown your Tomcat server instance. Make sure the server has shutdown before moving on to the next step.

2. Backup your Postgres and OrientDB databases. You can find instructions on how to do that here.

3. Install the 4.2.y instance in its new OPENEMPI_HOME directory. Follow the installation instructions for installing a new instance of OpenEMPI from a distribution that can be found here. The recommended approach is to install new releases under the same parent directory so that openempi-4.1.x and openempi-4.2.y are in the same directory. On our installations, we follow the convention of installing new releases in the /sysnet/openempi directory so that the 4.1.x release would be installed in the /sysnet/openempi/openempi-4.1.x directory and the 4.2.y release would be installed in the /sysnet/openempi/openempi-4.2.y directory.

For the purpose of these instructions, we assume that OPENEMPI_OLD_HOME points to the installation directory of the 4.1.x release

4. First, compare the contents of the following configuration files between the 4.1.x and 4.2.y directories and if they include changes that you have made, then merge those changes into the new version of the file. If you have questions about specific differences between the two versions and are unsure how to proceed, don't hesitate to reach out to us through the customer support portal. We can perform the merge between the configuration files for you. For example, the openempi-extension-contexts.properties may have been changed to activate or deactivate specific modules in your instance of OpenEMPI and jdbc.properties may have changed to reflect a change in the database password for the relational or graph databases.

5. Copy the following configuration files from the 4.1.x to the 4.2.y directory.

NOTES:

• We use the convention of naming file loader mapping files file-loader-map-{VARIABLE].xml where VARIABLE is a unique name that identifies the specific mapping file. You only need to copy mapping files that are unique to your installation.

• Starting with the 4.1.0 release of OpenEMPI the configuration settings from the mpi-config.xml and {entity}-FellegiSunterConfiguration.ser files are maintained in the graph database so it is not necessary that you move those files under the new installation directory. The settings are preserved in the configuration database instance (openempiConfig-db).

6. You will need to modify the setenv.sh file in /sysnet/openempi/openempi-4.2.y/bin to set the location of the data directory for your site and should point to the data directory that includes the openempiConfig-db directory as one of its subdirectories.

Here is a sample configuration of the setenv.sh file.

7. Copy the license.txt from the ${OPENEMPI_OLD_HOME}/conf directory that contains the product key to the ${OPENEMPI_HOME}/conf directory.

8. Run any database upgrade scripts that are specific to the new version you are upgrading to. Not every release includes a database upgrade script but if there is one, it would be in the conf directory under OPENEMPI_HOME. Upgrading to the 4.2.0 release from 4.1.x requires that you run the script update_database_schema-4.2.0.sql but depending on the current minor version of 4.1 that you are upgrading from, there may also be some upgrade scripts to bring your 4.1.x version up to the latest version in the 4.1 stream. For example, if you are currently at 4.1.3, you must also run the upgrade script for the 4.1.4 release.

9. Start your instance of OpenEMPI using the startup script from the new release directory. If you are using a service startup script to automatically start your instance of OpenEMPI, make sure you update the script to reflect its new directory location (this is usually installed in /etc/systemd/system/openempi.service).

You can check on the startup progress of the application by looking at the openempi.log file using the following command. Note that the path may vary for your site and specific version you are using.