Survey Message Queue Configuration

Project:	myARCH	Date:	12-12-2014
Subject:	myARCH MQ Install/Config	Author:	Paul Blazejewski
Version:	2.0.0	Contributors:	Emily Conner Marc Natter Stanley Boykin
Copyright:	© 2015 - 2019, Boston Children's Hospital	License:	The myARCH documentation is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

This document describes configuration details for the Survey Message Queue, which is essentially an ActiveMQ server configured to broker survey response messages between the Survey Manager and the i2b2 Loader. This Queue can be deployed in a Docker container, either on a standalone host or as part of a multi-container myARCH cluster.

Out of Scope

SSL configuration between client and server is specified in the /wiki/spaces/MYSW/pages/1703939.

Overview

The messaging framework is designed to handle asynchronous survey responses coming from Voxeo and RedCap. The responses are held in a queue until they can be processed by a consumer, the i2b2 Loader.

Minimum Container Requirements

512MB Memory, 1G HD space, 1Gz

Recommended Container Requirements

4G Memory, 10G HD space, 2Gz Dual-Core

Configuration

All of the configuration parameters, including container environment variables that set the SSL configuration files, are automatically set in the Docker Compose configuration file for the Survey Message Queue. These parameters can be reviewed and changed for special/non-standard configurations.

The default password 'myscilhs' is used for the message queues 'myscilhsPublisher', 'myscilhsConsumer', and 'myscilhsAdmin'. Edit the '<simpleAuthenticationPlugin>' section of the configuration file activemq.xml if you wish to change the usernames or passwords for clients to connect.

The Survey Message Queue console can be accessed from a browser from the URL https://<hostname>:8161/admin. The user credentials may be found and edited at /opt/activemq/conf/jetty-real.properties'.

SSL Configuration

Follow the /wiki/spaces/MYSW/pages/1703939document to authorize the client to server connection. This requires your client server vm to have its own ssl certificate.

Startup

The Survey Message Queue can be started as part of the myARCH container cluster framework. Instructions for managing that framework may be found here.

You may verify the server is up by connecting to the console from a browser as described above.

Used Ports

61617 - SSL Protocol used to connect to MQ and send and receive messages
8161 - HTTP Protocol used by administrator console

Logging

The Queue logs may be accessed in the myARCH cluster framework via the myscilhs.sh log script command, located on the host machine.

Alternatively, the message queue logs can be found on the container directly at '/opt/activemq/data/activemq.log'