User Guide > Process Steps and Components > Queue Step > IBM MQ Queue
Was this helpful?
IBM MQ Queue
Note:  For general information about Queue Steps, see Queue Step.
IBM MQ Queue allows a message to be put into the queue or retrieve from a queue to a message object. Use the PutMessage action to write to the queue. Use the GetMessage action in a Queue step to retrieve messages. Session properties control which message objects are read and the names of the messages that are written. Also, if the message properties must be to preserved.
Note:  IBM MQ Component supports IBM MQ Version 9.2.0.
IBM MQ Queue Properties
Property
Default Value
Description
Host
 
Host name where IBM MQ server is installed.
Port
1414
Port number to connect to.
Channel
 
Channel name through which the communication occurs.
Queue Manager
 
Name of the Queue Manager to connect to.
User ID
 
User ID that has access to the specified Host.
Password
 
Password of the above specified User ID.
Supported Actions
Action
Description
Connect
Establishes a connection to the IBM MQ server.
Disconnect
Disconnects from the IBM MQ server.
GetMessage
Retrieves message into a message object.
PutMessage
Writes a message object into the queue.
Begin Transaction
Starts a IBM MQ transaction.
Commit Transaction
Commits a IBM MQ transaction.
Rollback Transaction
Rolls back a IBM MQ transaction.
 
Supported Action Properties
Action
Property
Description
PutMessage
Include JMS Headers
Set the property to FALSE if you want MQ-style message body, without a JMS MQRFH2 header.
PutMessage
GetMessage
CCSID
Coded Character Set Identifier of character data within the message body.
PutMessage
 
Encoding
Encoding for numeric data. The representation used for binary integers, packed-decimal integers, and floating-point numbers.
PutMessage
GetMessage
MsgId
Message ID of a specific message put in or retrieved from a queue.
PutMessage
GetMessage
CorrelationId
Correlation ID of messages to put in or retrieve from a queue.
PutMessage
GetMessage
GroupId
Group ID of message to put in or retrieve from a queue.
GetMessage
SequenceNumber
Sequence number of a specific message to retrieve from a queue.
GetMessage
Timeout
Maximum number of seconds to wait for a message to arrive on a queue when retrieving messages.
GetMessage
Browse
Retrieve messages from a queue without removing them.
PutMessage
Offset
Segment offset.
PutMessage
ReplyToQ
Reply to queue (this field must not be blank if the MsgType field has the value MQMT_REQUEST).
PutMessage
ReplyToQMgr
Set the name of the queue manager to which reply message must be sent.
PutMessage
UserID
UserIdentifier specifies the user identifier of the application that originated the message.
PutMessage
AccountingToken
Accounting token of the message to be sent.
PutMessage
ApplIdData
Set ApplIdentityData to provide additional information about the message or its originator.
PutMessage
PutAppIName
Application that put the message.
PutMessage
PutDate
Date the message was put.
PutMessage
PutTime
Time the message was put.
PutMessage
ApplOriginData
Set ApplOriginData to provide additional information about the origin of the message.
PutMessage
MsgType
Message type.
PutMessage
Expiry
Message lifetime expressed in tenths of a second.
PutMessage
Feedback
Set Feedback to indicate the nature of the report (used with a message of type MQMT_REPORT).
PutMessage
Priority
Message priority.
PutMessage
Persistence
Persistence indicates whether the message survives system failures and restarts of the queue manager.
IBM MQ Environment Variables
You can use IBM MQ environment variable MQServer, to connect to the server. If the Host is not defined in Queue properties, then Actian DataConnect attempts to read the MQServer environment variable to connect. Use the following format to define MQServer environment variable:
MQServer=ChannelName/TransportType/IPAddress(Port)
Example
MQServer=mymq1/TCP/123.123.123.123(1415)
Or
MQServer=mymq1/TCP/123.123.123.123
 
If you do not provide (Port), then the default port number 1414 will be used to connect.
Note:  Press Test Connection button after defining Queue (Component) Properties, if the Test Connection fails, then make sure that you can successfully ping the server/host where IBM MQ is deployed from the machine where Actian DataConnect is installed. You will need to set appropriate authentication rules (CHLAUTH) at the IBM MQ Server which allows the access to the Server/Queue Manager/Queue you are trying to connect to. For more information, see IBM MQ documentation — https://www.ibm.com/support/knowledgecenter/SSFKSJ_9.2.0/com.ibm.mq.sec.doc/q132560_.htm
Last modified date: 02/09/2024