Migrating myARCH from version 1.x to 2.x

Owned by Stanley Boykin
Last updated: Jul 26, 2019 by Marc Natter
2 min read

If migrating to the Dockerized myARCH platform (version 2.0 and up) from a previous version, please follow the steps below.

Prepare the host system

  1. Install the current version of the myARCH cluster on a recommended VM, following the steps of the installation guide.
  2. Backup all database and configuration files from the legacy myARCH system.

Move the database files

The myARCH cluster will have installed fresh databases for the Contact Info and Survey Manager applications.  To replace these files, do the following (you will need to be logged in as myARCH on the cluster host machine):

  1. Stop the myARCH cluster if it is running.
  2. Zip up the MySQL data directory (/var/lib/mysql) from the legacy host machine.
  3. Unzip the above directory onto the mySCILHS cluster host machine in the data directory, e.g.:

tar zxvf <data-directory-tarball-file> -C $MYSCILHS_HOME/data-volumes/myscilhs/db

Edit the mySCILHS cluster application property files

The Survey Manager, Contact Info App, and i2b2 loader property files have been pre-configured to point to their counterparts within the cluster.  The recommended method is to customize these files based on your site's values (which are all found in $MYSCILHS_HOME/tomcat/conf/myscilhs/):

Backup the default properties files

It is recommended that you backup the existing properties files before altering them - particularly if you want to revert back to testing on the local REDCap and i2b2 instances.

Limit property file access

CAUTION: Due to the sensitivity of the files, it is strongly recommended that you restrict permissions to the application property files to the myARCH OS user only.

Contact Info App (myscilhs_csv.properties)

  1. Edit the db.user and db.pass values (if necessary).
  2. Edit the app.user and app.pass properties to the desired values.

i2b2 Loader (i2b2_loader.properties)

  1. Edit the i2b2 values to reflect the production i2b2 system values.  (This can be done by replacing the myscilhs.i2b2 values with the values that were in the legacy properties file.)
  2. If the Contact Info App credentials were changed above, change the myscilhs.publicid.user and myscilhs.publicid.pass values to reflect those changes.

Survey Manager (surveymanager.properties)

  1. Edit the spring.datasource.user and spring.datasource.password values (if necessary).
  2. Change the administrator credentials to desired values (security.user.name and security.user.password).

For the myARCH project(s) on production REDCap systems, the Data Entry Trigger link will need to be updated to point to the myARCH cluster host.  See the REDCap configuration guide for details on how to do this from the project setup page.

Update REDCap Survey Dictionaries

There was a bug in the 1.x version of myARCH that affected the survey dictionaries - please click here for instructions on how to update and fix in myARCH 2.x.