Key Capabilities
- Enterprise message queuing through IBM MQ REST API integration
- Queue manager connectivity with TLS encryption support
- Bidirectional message processing with configurable authentication
- Automatic retry logic with configurable intervals and maximum attempts
Overview
connectors are configured with a specific queue to which messages are pushed or from which messages are retrieved. Files that arrive in the Transactions tab of the connector are pushed as a message to the queue, and messages pulled from the queue are written as files to the Transactions tab. Each connector instance can only be configured with a single queue.Prerequisites
To establish a connection with , at a minimum users must have:- An server and a clear network path to that server from
- A queue manager with at least one active queue
does not provide setup assistance or support for the creation or configuration of the server. For questions about the setup of an server, consult the Introduction to documentation.
Connector Configuration
This section contains all of the configurable connector properties.Settings Tab
Configuration
Settings related to the core configuration of the connector.| Setting | Description |
|---|---|
| Connector Id | The static, unique identifier for the connector. |
| Connector Type | Displays the connector name and a description of what it does. |
| Connector Description | An optional field to provide a free-form description of the connector and its role in the flow. |
| Remote Host | The hostname or IP address of the system hosting the MQ service. |
| Remote Port | The port on the remote host where the MQ service is listening. |
| Queue Manager | The name of the local queue manager for the desired queue. |
| Queue | The name of the queue to push messages to or pull messages from. |
TLS Settings
Settings related to transport security.| Setting | Description |
|---|---|
| Use TLS when connecting with servers | Whether to use TLS encryption as transport security when connecting and communicating with servers. When disabled, all communication is in plain text. |
| Server Public Certificate | When TLS is enabled, set this field to the TLS/SSL certificate that the presents to verify its identity. Set this to Any Certificate to implicitly trust the server. |
Client Authentication
Settings related to authenticating against the remote service.| Setting | Description |
|---|---|
| Username | The username credential for authenticating against the remote server. |
| Password | The password for the specified username. |
Other Settings
Settings not included in the previous categories.| Setting | Description |
|---|---|
| Local File Scheme | A scheme for assigning filenames to messages that are output by the connector. You can use macros in your filenames dynamically to include information such as identifiers and timestamps. For more information, see Macros. |
Advanced Tab
Message
Logging
Other Settings
| Setting | Description |
|---|---|
| Processing Delay | The amount of time (in seconds) by which the processing of files placed in the Transactions tab is delayed. This is a legacy setting. Best practice is to use a File connector to manage local file systems instead of this setting. |
Miscellaneous
Automation Tab
Automation Settings
Settings related to the automatic processing of files by the connector.| Setting | Description |
|---|---|
| Send | Whether files arriving at the connector are automatically sent. |
| Retry Interval | The number of minutes before a failed send is retried. |
| Max Attempts | The maximum number of times the connector processes the file. Success is measured based on a successful server acknowledgement. If you set this to 0, the connector retries the file indefinitely. |
| Receive | Whether the connector should automatically query the data source. |
| Interval | The interval between automatic query attempts. |
| Minutes Past the Hour | The minutes offset for an hourly schedule. Only applicable when the interval setting above is set to Hourly. For example, if this value is set to 5, the automation service downloads at 1:05, 2:05, 3:05, etc. |
| Time | The time of day that the attempt should occur. Only applicable when the interval setting above is set to Daily, Weekly, or Monthly. |
| Day | The day on which the attempt should occur. Only applicable when the interval setting above is set to Weekly or Monthly. |
| Minutes | The number of minutes to wait before attempting the download. Only applicable when the interval setting above is set to Minute. |
| Cron Expression | A five-position string representing a cron expression that determines when the attempt should occur. Only applicable when the interval setting above is set to Advanced. |
Performance
Alerts Tab
SLAs Tab
Establishing a Connection
The following settings are required to establish a connection:- Remote Host
- Remote Port
- Queue Manager
- Queue
- Username
- Password