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.
Assumptions
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
LabKey configuration file. Before adding this section, check to see if it is already present but commented out, and if so simply uncomment it:
<Resource name="jms/ConnectionFactory" auth="Container"
type="org.apache.activemq.ActiveMQConnectionFactory"
factory="org.apache.activemq.jndi.JNDIReferenceFactory"
description="JMS Connection Factory"
brokerURL="tcp://@@JMSQUEUE@@:61616"
brokerName="LocalActiveMQBroker"/>
You will need to change the setting for
brokerURL to point to the location of your ActiveMQ installation (i.e. replace
@@JMSQUEUE@@ with the hostname of the server running the ActiveMQ software).
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, add (or uncomment) the following parameter to the
LabKey configuration file:
<Parameter name="org.labkey.api.pipeline.config" value="C:/path-to-config"/>
Set this to the location of your Enterprise Pipeline configuration directory.
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.
Test the Configuration
There are a few simple tests that can be performed at this stage to verify that the configuration is correct. These tests are focused on ensure that a remote server can perform an MS2 search
Related Topics