SolaceMQ Module
- 06 Jun 2022
- 3 Minutes to read
-
Print
-
DarkLight
SolaceMQ Module
- Updated on 06 Jun 2022
- 3 Minutes to read
-
Print
-
DarkLight
Overview
Module Details | |
| Core | SolaceMQ |
| Restart Required? | No |
| Step Location | Integration > SOLACEMQ |
| Settings Location | System > Settings > Solace MQSettings |
| Prerequisites |
|
The SolaceMQ module provides flow steps that can be used to integrate with Solace PubSub+ message brokers. Message handler Flows can be created to push and pull messages from Solace message queues.
SolaceMQ Settings
SolaceMQ settings can be found under System > Settings Solace MQSettings. These settings are used to configure the default connection to the message queue host.
| Configuration Options | Description | |
|---|---|---|
| Default Host IP or Name | The IP Address or name of the SolaceMQ host machine. | |
| Default Virtual Router Name | Optional setting used to test sending/receiving messages to SolaceMQ. | |
| Default User Name | The username used to connect to SolaceMQ. | |
| Default Password | The password used to connect to SolaceMQ. | |
| Use Client Certificate for Authentication | Enables SSL connections to SolaceMQ. If enabled, the following fields will require inputs: Filename of Client Certificate, Filename of PFX/P12/PKCS12 File To Sign with, Password for PFX/P12/PKCS12 File, SSL Trust Store Directory | |
| Filename of Client Certificate | The filename holding the SSL certificate. | |
| Filename of PFX/P12/PKCS12 File To Sign with | The filename holding the signatures for the SSL certificate. | |
| Password for PFX/P12/PKCS12 File | The password to access the SSL certificate. | |
| SSL Trust Store Directory | The path to the SSL Directory. | |
Adding a Solace Message Queue
Once the settings have been configured to connect to a Solace MQ host machine:
- Navigate to System > Integration > Jobs and Events > Message Queues.
- Select Add Solace Queue from the action bar and define the values for the message queue. Save.
Add Solace Message Queue Properties
| Properties | Description |
|---|---|
| Display Name | The name of the message queue as it will appear in Decisions. |
| Queue Name | The name of the message queue. |
| Override Host Info | If enabled, provides a textbox used to override Host IP or Name field defined in SolaceMQ Settings. |
| Override Virtual Router Name | Optional input used to override the Virtual Router Name field defined in SolaceMQ Settings. |
| Override Client Certificate in Settings | If enabled, provides textbox controls used to override Filename of Client Certificate, Filename of PFX/P12/PKCS12 File To Sign with, Password for PFX/P12/PKCS12 File, and SSL Trust Store Directory fields defined in SolaceMQ Settings. |
| Override Client Credentials | If enabled, provides textbox controls used to override the User Name and Password fields defined in SolaceMQ Settings |
| Always Try to Reconnect | If enabled, attempts to reconnect to the queue after a set period of time. |
| Time Between Reconnect Attempts (ms) | Defines the time between reconnects to the message queue. By default, this setting is set to 3000 |
Available Steps
SolaceMQ steps are available under Integration > SolaceMQ
Disable Solace Queue
Disables the selected Solace message queue. The message queue can be selected from a dropdown found under Properties > Settings > QueueName field on the step.
Enable Solace Queue
Enables the selected Solace message queue. The message queue can be selected from a dropdown found under Properties > Settings > QueueName field on the step.
Get String Message From Solace Queue
Retrieves a list of messages from a Solace Message Queue. The Message Count defines the number of messages being retrieved from the queue.
| Inputs | Description |
|---|---|
| Message Count | Defines the number of messages retrieved from the queue. |
Publish Message to Solace Topic
Sends a message to a Solace Topic. An additional setting to select the Topic used for the step can be defined under the Properties > Settings > TopicName .
| Inputs | Description |
|---|---|
| Headers | Header data that is sent with the message. |
| Message Data | Byte string containing the message data. |
| Message Type | The type of message sent by the user. |
| Persistent? | Boolean value to determine if the message is persistent |
Put Binary Message in Solace Queue
Sends a binary string message to the selected message queue.
| Inputs | Description |
|---|---|
| Headers | Header data that is sent with the message. |
| Message Data | Byte string containing the message data. |
| Message Type | The type of message sent by the user. |
| Persistent? | Boolean value to determine if the message is persistent |
Put String Message in Solace Queues
Sends a string message to the selected message queue.
| Inputs | Description |
|---|---|
| Headers | Header data that is sent with the message. |
| Message Type | The type of message sent by the user. |
| Message(s) Text | A list of strings representing the message. |
| Persistent? | Boolean value to determine if the message is persistent |
Was this article helpful?
