1. Mirth Connect
2. Home
3. Upgrade Guides (Official)

Created by Jacob Brauer, last modified on Apr 27, 2011

This guide is for upgrading your Mirth Connect 2.0.0 or 2.0.1 installation to Mirth Connect 2.1. If you are upgrading from Mirth Connect 1.8, please follow the Mirth Connect 1.8 to 2.0 Upgrade Guide. There are a few steps that must be performed before upgrading to backup your database and configuration properties.

Please read this!

Icon

It is important to follow all of the steps below, to ensure that you do not lose any data. We recommend printing this guide as a reference before starting the upgrade process.

Icon

From here on, $MIRTH_HOME refers to the Mirth Connect installation directory.

Congratulations! The upgrade process is done automatically when the appliance is upgraded.

1. Before you upgrade =====================

Certain libraries, properties, and configuration files will need to be manually copied over. Copy them to a location outside of your existing 2.0 $MIRTH_HOME directory before running the Mirth Connect 2.1 installer. Once Mirth Connect 2.1 is installed, follow the directions in step 3, "After the upgrade".

1. Backup server configuration: Before proceeding, it's important that you backup your existing server configuration. This can be done through the Mirth Connect Administrator under Settings. The server configuration includes channels, code templates, alerts, and global scripts. User accounts will not be backed up.

2. Application Data: Create a backup of $MIRTH_HOME/appdata

3. mirth.properties: Create a backup of $MIRTH_HOME/conf/mirth.properties

4. Custom Java libraries (JAR files): If you added custom libraries, back them up from $MIRTH_HOME/custom-lib

5. Custom database drivers: If you have added custom database drivers, make sure to back them up in the above step. You will also need to back up your additions to $MIRTH_HOME/conf/dbdrivers.xml

6. Custom extensions: Custom extensions will not be migrated during the upgrade. Before upgrading, you should remove any extensions that did not come with the general Mirth Connect release. If they are not removed, the extension folders may need to be manually removed in order to start the Mirth Connect 2.1 server. After upgrading, you will need to install an updated extension that is compatible with Mirth Connect 2.1.

7. Java JVM parameters: If you have added any Java JVM parameters or changed any of the default heap size settings, create a backup of any $MIRTH_HOME/*.vmoptions files

8. Logger settings: If you have made any changes to your logger settings, create a backup of $MIRTH_HOME/conf/log4j.properties

9. CLI configuration: If you have made any changes to the CLI configuration file, create a backup of $MIRTH_HOME/conf/mirth-cli-config.properties

10. Upgrading ============

Make sure that you have exited and stopped the Mirth Connect Administrator, Server Manager, and Server/Service before proceeding.

1. Create a backup of the $MIRTH_HOME/mirthdb
2. Run and complete the Mirth Connect 2.1 installer, choosing the update option using the same installation directory.
3. If you have chosen to install the Mirth Connect Service, stop it now using the Mirth Connect Server Manager.
4. Rename the mirthdb directory in your installation directory to mirthdb_old.
5. Restore the backup of your previous mirthdb directory into the new Mirth Connect 2.1 installation directory.

1. Create a backup of your database using your preferred database administration tool (ex. pgAdmin, MySQL Administrator).

2. Create a copy of $MIRTH_HOME/conf/database-SqlMapConfig.properties (ex. postgres-SqlMapConfig.properties, mysql-SqlMapConfig.properties), where database is the value of the property in $MIRTH_HOME/conf/mirth.properties

3. Run and complete the Mirth Connect 2.1 installer, choosing the update option using the same installation directory.

4. If you have chosen to install the Mirth Connect Service, stop it now from the Mirth Connect Server Manager.

5. The properties in your previous properties file have been renamed and relocated to mirth.properties. Using your old property values, edit $MIRTH_HOME/conf/mirth.properties and set the database, database.url, database.username, and database.password properties.

6. After the upgrade ====================

1. Application Data: Restore the directory to $MIRTH_HOME
2. Custom Java libraries (JAR files): Restore your custom libraries to $MIRTH_HOME/custom-lib

1. mirth.properties: Some of the property names have changed in 2.1. Set any properties you changed in $MIRTH_HOME/conf/mirth.properties manually. Database Connection Settings

   Icon As of 2.1, all database connection settings (URL, username, password) are set in the mirth.properties file. You will no longer need to edit the settings file for each database.

2. Custom database drivers: Make sure you restored your custom database drivers in the above step, and restore your changes to $MIRTH_HOME/conf/dbdrivers.xml

3. Java JVM parameters: Restore the changes in your backed up *.vmoptions files to the corresponding *.vmoptions files $MIRTH_HOME. Note that the file names have changed.

4. Logger settings: Some of the log settings have changed in 2.1. Set any properties you changed in $MIRTH_HOME/conf/log4j.properties manually.

5. CLI configuration: Restore mirth-cli-config.properties to $MIRTH_HOME/conf/

6. Start the server

7. Custom extensions: Install new versions of any custom extensions

Channel Statistics

Icon

If after upgrading the channel statistics for all channels are reset, you probably didn't copy over your application data directory. Don't worry, your message data has been preserved and is accessible through the message browser. To restore your previous statistics, restore the application data directory.

Document generated by Confluence on Nov 11, 2019 08:40

Atlassian