Configure the Pipeline with ActiveMQ

2024-03-28

This topic is under construction for the 24.3 (March 2024) release of LabKey Server with embedded Tomcat 10. For the previous documentation, click here.

Using the data pipeline with ActiveMQ is not a typical configuration and may require significant customization. If you are interested in using this feature, please contact LabKey to inquire about support options.

This topic covers configuring LabKey Server to use the Enterprise Pipeline with ActiveMQ. This configuration allows work to be distributed to remote servers, separate from the LabKey Server web server.

Prerequisites

In order to install the LabKey Enterprise Pipeline, you will first need to install and configure the following prerequisite software:

Enable Communication with the ActiveMQ JMS Queue

You will need to add the following settings to the application.properties file. Before adding this section, check to see if it is already present but commented out, and if so simply uncomment it by removing the leading #s:

context.resources.jms.ConnectionFactory.type=org.apache.activemq.ActiveMQConnectionFactory
context.resources.jms.ConnectionFactory.factory=org.apache.activemq.jndi.JNDIReferenceFactory
context.resources.jms.ConnectionFactory.description=JMS Connection Factory
# Update to the appropriate hostname and port
context.resources.jms.ConnectionFactory.brokerURL=tcp://localhost:61616
context.resources.jms.ConnectionFactory.brokerName=LocalActiveMQBroker

You will need to change all of these 'default' settings to the values appropriate for your installation.

Set the Enterprise Pipeline Configuration Directory

By default, the system looks for the pipeline configuration files in the following directory: <LABKEY_HOME>/config.

To specify a different location, set it in the application.properties file.

Provide Configuration Files

The config location set above must contain the configuration XML files your pipeline requires. This will depend on your use case. Contact us for assistance and more information about support options.

As one example, you might need both:

  • pipelineConfig.xml and
  • another tool-based file, such as ms2Config.xml in a previous example.

Restart LabKey Server

In order for the LabKey Server to use the new Enterprise Pipeline configuration settings provided in the specified config location, the server will need to be restarted. Confirm that the server started up with no errors:

  • Log on to your LabKey Server using a Site Admin account.
  • Select (Admin) > Site > Admin Console.
  • Under Diagnostics, click View all site errors.
  • Check to see that no errors have occurred after the restart.

Related Topics