FME Transformers: 2025.0
Connects to an IBM MQ 9.x Queue Manager over TCP/IP, in Client mode. Supports sending/receiving messages from queues and publishing/subscribing to topics.
Usage Notes
- The IBMMQConnector supports Windows only.
- The IBMMQConnector connects to Queue Managers using the Client mode, so users must have an IBM MQ client installed locally. Bindings mode is not supported. For more details on installing a client, see Where to find downloadable installation images.
- The IBMMQConnector requires that the environment variable MQ_FILE_PATH be set. This should be done automatically during client installation.
- The IBM MQ user used with the IBMMQConnector must have the following permissions. For more details on permissions, see SET AUTHREC (set authority records) on Multiplatforms.
- QMGR: CONNECT, DSP, SETID
- QUEUE: DSP, GET, INQ, PUT, SETID
- TOPIC: PUB, SUB
- There are possible restrictions on the default IBM MQ user named “app”. If running into authorization errors despite having the permissions above granted, try creating a different user.
Configuration
Input Ports
Input
This transformer accepts any feature.
Output Ports
Output
The output of this transformer will vary depending on the action performed. Message data and metadata are presented as feature attributes.
- After a Send action, output features represent messages sent to a queue/topic.
- After a Receive action, output features represent messages received from a queue/topic.
- After a Count action, output features contain metadata for the number of messages in a queue.
Initiator
The incoming feature is output through this port.
<Rejected>
Features that cause the operation to fail are output through this port. An fme_rejection_code attribute, having the value ERROR_DURING_PROCESSING, will be added, along with a more descriptive fme_rejection_message attribute which contains more specific details as to the reason for the failure.
Note If a feature comes in to the IBMMQConnector already having a value for fme_rejection_code, this value will be removed.
Rejected Feature Handling: can be set to either terminate the translation or continue running when it encounters a rejected feature. This setting is available both as a default FME option and as a workspace parameter.
Parameters
Authentication
|
Web Connection |
To create an IBM MQ web connection, click the Account drop-down box and select Add Web Connection.... The connection can then be managed via Tools > FME Options > Web Connections. |
Connection
|
Queue Manager |
The Queue Manager to connect to. |
|
Channel |
The MQ Channel to use. |
|
Use SSL |
Whether to use SSL or not. If checked, ensure that the Queue Manager is also configured to use SSL. |
|
Key Repository |
If Use SSL is checked, specify the key database file (.kdb). |
|
CipherSpec |
If Use SSL is checked, select a CipherSpec that is supported by the Queue Manager. |
Action
|
Action |
The type of operation to perform. Choices are:
Defaults to Receive. |
The remaining parameters available depend on the value of the Request > Action parameter. Parameters for each Action are detailed below.
Parameters - Count Messages Action
Count Messages Options
|
Queue |
Select a Queue to count the number of pending messages. If Queue does not exist, the transformer will return a rejected feature. |
Output Attributes
The following attributes can be selected for inclusion on the output features.
|
_message_count |
Number of messages in Queue. |
Parameters - Send Action
Send Options
|
Payload |
Message to send. |
|
Destination |
Send message to a:
Defaults to Queue. |
|
Queue |
If Destination is Queue, select a Queue to send message(s) to. |
|
Queue Message Descriptor |
Properties to apply to message(s) when Destination is Queue:
For more details on message descriptor properties, see: MQMD - Message descriptor. |
|
Topic String |
If Destination is Topic, specify the topic string that identifies the Topic to send message(s) for. This is a character string that must be broken up into ‘/’ delimited parts. See Topic strings for details. |
|
Topic Message Descriptor |
Properties to apply to message(s) when Destination is Topic:
For more details on message descriptor properties, see: MQMD - Message descriptor |
Output Attributes
The following attributes can be selected for inclusion on the output features.
|
_payload |
The message sent. |
Parameters - Receive Action
Receive Options
|
Source |
Get message from a:
Defaults to Queue. |
|
Queue |
If Source is Queue, select a Queue to receive message(s) from. |
|
Topic String |
If Source is Topic, specify the topic string that is being subscribed to. This is a character string that must be broken up into ‘/’ delimited parts. See Topic strings for details. |
|
Subscription Name |
If Source is Topic, specify the name of the Subscription to receive message(s) from. If the specified Subscription does not exist, a new Subscription will be created for Topic String. |
|
Durable Subscription |
If Source is Topic, determine whether a Subscription is durable or not. Defaults to Yes. |
|
Receive Mode |
Two message receiving options are available:
|
|
Batch Size |
In Batch mode, specifies the number of messages to read per batch. |
|
Get JMS Headers |
If Source is Queue, determine whether JMS (Java Message Service) headers are kept or discarded. Default to Yes. |
Output Attributes
The following attributes can be selected for inclusion on the output features.
|
_payload |
The message payload. UTF-8 string if possible to decode, otherwise binary or numeric. |
|
_accounting_token |
Part of the identity context of the message. |
|
_application_identity_data |
Provides additional information about the message or originator. Part of the identity context of the message. |
|
_message_id |
Message identifier. |
|
_persistence |
Indicates whether the message survives system failures and restarts of the queue manager. |
|
_priority |
Priority of the message. |
|
_reply_to_queue |
Name of the Queue that the application receiving the message sends reply or report messages to. |
|
_reply_to_queue_manager |
Name of the Queue Manager that the application receiving the message sends reply or report messages to. |
|
_user_identifier |
The user identifier of the application that originated the message. Part of the identity context of the message. |
Editing Transformer Parameters
Transformer parameters can be set by directly entering values, using expressions, or referencing other elements in the workspace such as attribute values or user parameters. Various editors and context menus are available to assist. To see what is available, click 
beside the applicable parameter.
How to Set Parameter Values
Defining Values
There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters.
Using the Text Editor
The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.
Using the Arithmetic Editor
The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.
Conditional Values
Set values depending on one or more test conditions that either pass or fail.
Parameter Condition Definition Dialog
Content
Expressions and strings can include a number of functions, characters, parameters, and more.
When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.
Content Types
| These functions manipulate and format strings. | |
|
Special Characters |
A set of control characters is available in the Text Editor. |
| Math functions are available in both editors. | |
| Date/Time Functions | Date and time functions are available in the Text Editor. |
| These operators are available in the Arithmetic Editor. | |
| These return primarily feature-specific values. | |
| FME and workspace-specific parameters may be used. | |
| Creating and Modifying User Parameters | Create your own editable parameters. |
Dialog Options - Tables
Table Tools
Transformers with table-style parameters have additional tools for populating and manipulating values.
|
Row Reordering
|
Enabled once you have clicked on a row item. Choices include:
|
|
Cut, Copy, and Paste
|
Enabled once you have clicked on a row item. Choices include:
Cut, copy, and paste may be used within a transformer, or between transformers. |
|
Filter
|
Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output. |
|
Import
|
Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers. |
|
Reset/Refresh
|
Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers. |
Note: Not all tools are available in all transformers.
For more information, see Transformer Parameter Menu Options.
Reference
|
Processing Behavior |
|
|
Feature Holding |
No |
| Dependencies | |
| Aliases | |
| History |
FME Community
The FME Community has a wealth of FME knowledge with over 20,000 active members worldwide. Get help with FME, share knowledge, and connect with users globally.
Search for all results about the IBMMQConnector on the FME Community.
Examples may contain information licensed under the Open Government Licence – Vancouver, Open Government Licence - British Columbia, and/or Open Government Licence – Canada.