IBM MQ Connector

The IBM MQ connector provides access to IBM MQ queues through the REST API.

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

IBM MQ 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 IBM MQ, at a minimum users must have:

An IBM MQ server and a clear network path to that server from Arc
A queue manager with at least one active queue

CData does not provide setup assistance or support for the creation or configuration of the IBM MQ server. For questions about the setup of an IBM MQ server, consult the Introduction to IBM MQ 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 IBM MQ servers	Whether to use TLS encryption as transport security when connecting and communicating with IBM MQ 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 IBM MQ presents to verify its identity. Set this to Any Certificate to implicitly trust the IBM MQ 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

Logging

ログの作成と保存を制御する設定です。

設定	説明
Log Level	コネクタが生成するログの詳細度です。サポートを依頼する際は、これをDebug に設定してください。
Log Subfolder Scheme	選択した間隔に従って、コネクタがLogs フォルダ内のファイルをグループ化するよう指示します。Weekly オプション（デフォルト）は、コネクタが毎週新しいサブフォルダを作成し、その週のすべてのログをそのフォルダに保存するよう指示します。この設定を空白のままにすると、コネクタはすべてのログをLogs フォルダに直接保存します。多数のトランザクションを処理するコネクタでは、サブフォルダを使用することでログを整理しやすくなり、パフォーマンスが向上します。
Log Messages	処理したファイルのログエントリにファイル自体のコピーを含めるには、これをオンにします。これを無効にすると、Transactions タブからファイルのコピーをダウンロードできなくなる場合があります。

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

Miscellaneous 設定は、特定のユースケース向けの設定です。

設定	説明
Other Settings	非表示のコネクタ設定をセミコロン区切りのリストで設定できます（例：`setting1=value1;setting2=value2`）。通常のコネクタのユースケースや機能では、これらの設定の使用は必要ありません。

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.
Start Date and Time	The date and time at which the automation first runs. Every run after that follows the interval setting above. The last and next run times appear in the Automation Status section.

Automation Status

Performance

コネクタへのリソースの割り当てに関する設定です。

設定	説明
Max Workers	このコネクタでファイルを処理するためにスレッドプールから消費されるワーカースレッドの最大数です。設定すると、Advanced Settings ページのPerformance Settings 部分にあるデフォルト設定が上書きされます。
Max Files	コネクタに割り当てられた各スレッドが送信するファイルの最大数です。設定すると、Advanced Settings ページのPerformance Settings 部分にあるデフォルト設定が上書きされます。

Alerts Tab

SLAs Tab

Establishing a Connection

The following settings are required to establish a connection:

Remote Host
Remote Port
Queue Manager
Queue

If client authentication is required, you must also set the following:

Username
Password

Use the Test Connection button to verify the connection to the server.

Sending Messages

Files that arrive in the Transactions tab for the connector are pushed to the configured queue as a message. Files can arrive in this folder either by being placed there directly, or from another connector earlier in the flow. You need to set up multiple IBM MQ connectors to push messages to multiple queues. You can use a connector like the Branch connector to route files to the appropriate IBM MQ connector.

Receiving Messages

You can configure the IBM MQ connector to automatically poll the remote queue for messages to download. Use the Receive Automation and Receive settings on the Automation tab. When enabled, the connector waits for the specified interval before attempting to retrieve messages from the queue and pushing them to the Output folder. If the IBM MQ connector is connected to other connectors in a flow, downloaded messages are automatically passed to the next connector. Otherwise, the messages remain in the Output folder.

はじめに

フロー

EDI トレーディングパートナー管理コンソール

コネクタ

マッピング

API と自動化

ハウツーガイド

スクリプティング

ソフトウェアライセンスとサードパーティ著作権

Key Capabilities

Overview

Prerequisites

Connector Configuration

Settings Tab

Configuration

TLS Settings

Client Authentication

Other Settings

Advanced Tab

Logging

Other Settings

Miscellaneous

Automation Tab

Automation Settings

Automation Status

Performance

Alerts Tab

SLAs Tab

Establishing a Connection

Sending Messages

Receiving Messages

Macros

Examples

​Key Capabilities

​Overview

​Prerequisites

​Connector Configuration

​Settings Tab

​Configuration

​TLS Settings

​Client Authentication

​Other Settings

​Advanced Tab

​Logging

​Other Settings

​Miscellaneous

​Automation Tab

​Automation Settings

​Automation Status

​Performance

​Alerts Tab

​SLAs Tab

​Establishing a Connection

​Sending Messages

​Receiving Messages

​Macros

​Examples

Key Capabilities

Overview

Prerequisites

Connector Configuration

Settings Tab

Configuration

TLS Settings

Client Authentication

Other Settings

Advanced Tab

Logging

Other Settings

Miscellaneous

Automation Tab

Automation Settings

Automation Status

Performance

Alerts Tab

SLAs Tab

Establishing a Connection

Sending Messages

Receiving Messages

Macros

Examples