Client Connection: JMS - NEW! 🚀
Use this tab to define the client connection to a JMS provider for sending a file as a single JMS message or as a collection of multiple JMS messages (file-to-message) and for receiving a file, which can be a single JMS message or the collection of multiple JMS messages (message-to-file).
Some of the parameters to configure strictly depend on the provider used. In this documentation, an ActiveMQ JMS provider is detailed.
Fields with the asterisk * are mandatory.
| Properties | Description |
|---|---|
| NAME * | Name of the JMS connection you are creating. The maximum number of characters is 128. Blanks and ' " | special characters are not supported. |
| DESCRIPTION | Description of the JMS connection you are creating. The maximum number of characters is 2048. |
| STATUS | Enable or disable the client connection. Possible values: - Enabled (default value) - Disabled |
| USERNAME * | Username to connect to the JMS server. |
| PASSWORD * | Password to connect to the JMS server. |
| INITIAL CONTEXT FACTORY CLASS NAME * | For ActiveMQ, enter org.apache.activemq.jndi.ActiveMQInitialContextFactory. |
| INITIAL CONTEXT FACTORY URL * | Server endpoint to which Data One wants to connect. For ActiveMQ, it starts with tcp, followed by the JMSServerIP and by the JMServerPort. E.g., tcp://10.20.1.17:61616 |
| CONNECTION FACTORY JNDI NAME * | For ActiveMQ, enter activeMQ:ConnectionFactory. |
| LIBRARY DIRECTORY RELATIVE PATH * | Directory where JMS client libs are located in the STENG installation directory. E.g., activemq. You must create a subdirectory and call it libexternal. In there, create another subdirectory with a name of your choice. E.g., /opt/dataone/wlp/usr/servers/steng00/libexternal/activemq. Copy in this subdirectory the client components of the JMS type you want to use. |
| CLIENTID | Name that can be given to the client connection to identify it on the server side. |
| INITIAL CONTEXT ENVIRONMENT | Map containing the properties that depend on the JMS server, used for configuration connection of the client. |
| MAX RETRIES | Maximum number of retries. If this field is empty or set to 0, no retries will be executed and the job will be set to Failed if the first attempt is not successful. A high value corresponds to a high number of retrying attempts. |
| CONFIGURATION TEST | Use this section to test that the Cluster and the STENG are connected correctly. Select a Cluster and a STENG you want to test and click the TEST button. Data One automatically selects a Cluster and a STENG to test the connection. Note that a Cluster will be selected only if it is the only one available. A message with a green check will confirm a successful connection. A message with a red exclamation mark will warn about an unsuccessful connection. The message also details the reason why the connection fails. The connection might not be successful for different reasons, each of them depending on the transport type and the configuration. The first time you try to test the connection, if trusting certificates are missing, an error message detailing the unsuccessful connection will appear. In this case, go to Setup → Untrusted Cache → Certificates tab and trust the relevant certificates. Note that trusting certificates in the Untrusted Cache page may not be sufficient to establish a successful connection. Refer to the Untrusted Cache section of this guide for all the details. |
For the AMQ Server, refer to the jndi-support documentation page.
Updated 6 days ago