What are the required steps to migrate/move QIE to new hardware?

Question

When migrating QIE to a new server there are two options. One is to migrate QIE without the existing database. The second option is to migrate QIE with the existing database. The steps for both scenarios are listed below.

 

Note: For detailed instructions on installing and setting up QIE please refer to the QIE Install Guide available from the Help menu in QIE or requesting a copy from support@qvera.com. A review of hardware and software requirements for the new QIE server is recommended and can be referenced in the first chapter of the Install Guide.

 

Recomendation: It is recomended to create a written plan documenting all of the details about the current QIE configuration and steps outlining the proposed process.

Answer 1

Option 2 - Migrating QIE with the existing QIE database:

 

Use this option if retaining message history, and error message retention is desired.

Note: Prior to migrating, ensure all messages have been processed through the interfaces.

 

Current Server

 

1. To allow all messages to process through a running channel you can right click on the Green Source Node and choose to disable the source. See KB article: Stopping Source and Destination Nodes

 

2.     Retrieve a current copy of the QIE configuration backup file. The file can be obtained from the nightly configuration backup or by exporting a current configuration file.

 

1.     Nightly Configuration Backup

 

a.     The nightly backup file will always exist in the QIE Home directory. To locate the QIE Home directory launch the QIE Service Manager and navigate to the Java Tab. The path to the home directory  is in  the Java Options field (-Dqie.home=C:\ProgramData\QIE). The default QIE Home Directory is  "C:\ProgramData\QIE".

 

b.     Optionally a copy of the nightly backup configuration file may be obtained from another directory on the network if an "Alternate Backup Path" was specified under System Administration -> System Configuration -> System Configuration Nightly Backup.

 

2.     Export the Configuration

 

a.     Login to QIE with the admin user/password.

 

b.     Export the configuration with license information (license information is only allowed if signed on with the admin user).

 

3.     External Libraries - On some intallations there may have been installed Java Lirbraries (jar files) used to extend the QIE interface. If External Libraries are being used there will be entries in the libs.txt file. See KB article What are External Libraries

 

            a. Copy the libs.txt file found under the QIE Home Directory. This file will be replaced after having started QIE at least once on the new server.

 

            b. Copy the lib folder found under the QIE Home Directory. This folder will also be replaced after having started QIE at least once on the new server.

 

4. Open the QIE Service Manager and copy the "Arguments" from the "Startup Tab" to a notepad. Alternatively, the Java arguments can be found in a file titled qieJavaArguments.txt in the QIE home directory. Note: On some older installs of QIE certificates may have been setup and referenced in the Arguments. If certificates are referenced the keystore (folder with certificates) will also need to be moved to the new server. If desired these certificates can be left as java arguments or can be moved inside of QIE under the Zone/Channel that is using them. See KB article: Installing certificates into QIE

 

5.   Stop all channels from the Global Status page. If this step is done before stopping the QIE service, this will prevent the channels from auto starting should the QIE server ever be re-enabled.  See KB article Stoping, Starting, Pausing channles

6.   Stop the QIE service and disable it from the Windows Service Manager.

 

New Server

 

1. Download/Install Java 8.  Ensure you are using the correct download for 32 or 64 bit machines.

 

2. Download/Install Chrome.

 

3. Download/Install QIE. If you need assistance with the install refer to the QIE install Guide.

 

4. Start QIE. 

 

5. Sign on with user "admin" and password "admin" and change the password to an interim password.

 

6. Stop QIE.

 

7. Replace the libs.txt and llib folders obtained in step 3 from the old server.

 

8. Open the QIE Service Manager and replace the default "Arguments" found on the "Startup Tab" with the arguments copied from the previous step.

 

9. Configuring old database:

NOTE: If QIE is on V3.0.44 or greater see https://www.qvera.com/kb/index.php/1536 in place of steps a or b below.

   a. If QIE was previously using the H2 database copy the existing H2 database from the old server (the H2 database will be found in the QIE home Directory under a folder called H2) to the new server replacing the new empty H2 database file. 

 

   b. If QIE was previously using MSSQL, MySQL, or MariaDB and if the database was not moved as part of the QIE move then QIE will already be pointing to the database with step 7 above by copying the startup arguments from the old server. If the database was also moved as part of the QIE move, then the database location will need to be updated in the "Arguments" found on the "Startup Tab". Please refer to the QIE Install Guide for more information about configuring QIE with an alternate database management system.

 

10. Restart QIE

 

   a. Check all database connections to ensure they still connect.

 

   b. Check all source and destination nodes that are configured to send or receive data from a directory to ensure QIE still has access to the directories by clicking on the Test Path button.

 

   c. Start the desired channels and verify that data is processing through.

Answer 2

Option 1 - Migrating QIE without the QIE database:

 

This option would be used if retaining message history and errors is not desired or if the existing database is not available to be moved.

Note: Prior to migrating, ensure all messages have been processed through the interface.  Any messages in process or in an error state will be lost along with all message history.

 

Current Server

 

1. To allow all messages to process through a running channel you can right click on the Green Source Node and choose to disable the source. See KB article: Stopping Source and Destination Nodes

 

2.     Retrieve a current copy of the QIE configuration backup file. The file can be obtained from the nightly configuration backup or by exporting a current configuration file.

 

1.     Nightly Configuration Backup

 

a.     The nightly backup file will always exist in the QIE Home directory. To locate the QIE Home directory launch the QIE Service Manager and navigate to the Java Tab. The path to the home directory  is in  the Java Options field (-Dqie.home=C:\ProgramData\QIE). The default QIE Home Directory is  "C:\ProgramData\QIE".

 

b.     Optionally a copy of the nightly backup configuration file may be obtained from another directory on the network if an "Alternate Backup Path" was specified under System Administration -> System Configuration -> System Configuration Nightly Backup.

 

2.     Export the Configuration

 

a.     Login to QIE with the admin user/password.

 

b.     Export the configuration with license information (license information is only allowed if signed on with the admin user).

 

3.     External Libraries - On some intallations there may have been installed Java Lirbraries (jar files) used to extend the QIE interface. If External Libraries are being used there will be entries in the libs.txt file. See KB article What are External Libraries

 

            a. Copy the libs.txt file found under the QIE Home Directory. This file will be replaced after having started QIE at least once on the new server.

 

            b. Copy the lib folder found under the QIE Home Directory. This folder will also be replaced after having started QIE at least once on the new server.

 

4.     Open the QIE Service Manager and copy the "Arguments" from the "Startup Tab" to a notepad. Alternatively, the Java arguments can be found in a file titled qieJavaArguments.txt in the QIE home directory. Note: On some older installs of QIE certificates may have been setup and referenced in the Arguments. If certificates are referenced the keystore (folder with certificates) will also need to be moved to the new server. If desired these certificates can be left as java arguments or can be moved inside of QIE under the Zone/Channel that is using them. See KB article: Installing certificates into QIE

 

5.   Stop all channels from the Global Status page. If this step is done before stopping the QIE service, this will prevent the channels from auto starting should the QIE server ever be re-enabled. See KB article Stoping, Starting, Pausing channels

6.   Stop the QIE service and disable it from the Windows Service Manager.

New Server

 

1.     Download/Install Java 8.  Ensure you are using the correct download for 32 or 64 bit machines.

 

2.     Download/Install Chrome.

 

3.     Download/Install QIE. If you need assistance with the install refer to the QIE install Guide.

 

4.     Start QIE.

 

5.     Sign on with user "admin" and password "admin" and change the password to an interim password. 

 

6.     Stop QIE.

 

7.     Replace the lib folder and libs.txt file obtained in steps 3 from the old server.

 

8.     Open the QIE Service Manager and replace the default "Arguments" found on the "Startup Tab" with the arguments copied from the previous step.

 

9.     Restart QIE.

 

10.     Import the configuration exported or obtained from the previous steps.  This will require the entry of the original admin password used to export the configuration above or that was used on the old system. Note: After importing the new configuration file all of the previous user names and passwords will be updated including the admin password. See KB article Importing QIE channels and Configurations

 

11.   After Import

 

a.     Check all database connections to ensure they still connect.

 

b.     Check all source and destination nodes that are configured to send or receive data from a directory to ensure QIE still has access to the directories by clicking on the Test Path button.

 

c.     Start the desired channels and verify that data is processing through.

 

Answer 3

Other Considerations:

1. Server IP Address and Hostname - Consideration should be given when setting up QIE on a new server to the server IP address. Depending on the channels running if the inbound channel is configured as a Socket Connection or an HTTP listener the sending system may need to update their configuration to reference the new IP address or the new server will need to be configured with the same IP address as the old server.

    a. Inbound Socket Connections - In this scenario, if the inbound channel is configured to listen on a specified port number the sending system may be referencing the server by either a Hostname or IP Address. If the new server is configured with a new Hostname or IP Address then the sender will need to be notified to update their configuration.

    b. Inbound HTTP Listener - In this scenario if the inbound channel is configured to listen as an HTTP listener then the sending system may need to update their URL to the new server's Hostname or IP Address.

    c. QIE Forms - If the customer is using forms in the EMR such as Immunization or CDA Reconciliation it may be necessary to update the clinical kit "EFM" file with the correct Hostname or IP address for the new Qvera Server and reimported.

    d. Web Service Connections - If QIE is calling an internal web service such as JBOSS then theses web service connections may need to be updated with the correct URL depending on if the JBOSS web server has also changed with your move.

2. QIE Service Log on as Account - On some systems, the QIE service may have been changed from running under the "Local System Account" to a "Named Account". It is important to configure the QIE Windows Service account to use the same account as the old server so that resources on the network can still be accessed. Note: If this account needs to be changed it is necessary that it be changed from the Windows Services directly rather than from the QIE Service Manager window. See KB article Setting QIE Log On Account

3. Firewall Rules - With some interfaces (e.g. Transition of Care - TOC) Port Forwarding and Firewall rules may have been put in place in order to allow outside message traffic to flow into the internal network and to QIE or to allow QIE to send messages to an external network location. If this type of interface is in place then the firewall & port forwarding rules may need to be updated to allow the traffic to flow over. A network admin from the organization would need to validate if firewall rules changes are necessary.

4. Certificates - If certificates are used on one or more of the channels then exporting and importing them on the new server will be required. See KB article How to export and import certificates