Input Signature Properties for the Put Service
When you configure the Put service, the following overrideConnection properties automatically appear in the input signature of the Put service on the Input/Output tab:
Note:
An asterisk * indicates that if you set the dynamicQueuePrefix at run time, then you also need to set the queueName.
Note:
A plus + indicates that there is a description for this property below this table.
Property | Data Type |
queueManagerName | String |
hostName | String |
port | String |
channel | String |
CCSID | String |
queueName* | String |
dynamicQueuePrefix* | String |
useLocalQueueManager+ | String |
encoding | String |
For a description of each data type, see the list of parameters in
Configuring
WebSphere MQ Adapter Connections.
When you configure a Put service, useLocalQueueManager is in the input signature under override connection parameter. You can set the value for useLocalQueueManager in the Pipeline Editor. If you add a value other than Yes or No in this field, then WebSphere MQ Adapter sets the value to No.
Yes The Put service uses the existing connection (configured for this service) to send messages to the specified queue on the remote queue manager.
No The Put service creates a new connection to the remote queue manager and sends the message to the specified queue on the remote queue manager.
For proper operation, the local queue manager needs to know the route to the remote location (that is, the transmission queue). When an application puts messages that are destined for a remote queue manager, the local queue manager adds a transmission header to the message before putting the message on the transmission queue with the same name as the remote queue manager. The transmission header contains the name of the destination queue and queue manager, that is, the addressing information. The receiving channel removes the transmission header and uses the information in it to locate the destination queue. To configure your local queue and remote queue managers:
1. Define a Transmission queue on the local queue manager. The transmission queue name must be same as the remote queue manager name.
2. Define a Sender channel at the local queue manager and specify the transmission queue to be used. Use the transmission queue defined in the previous step.
3. Define a Receiver channel at the remote queue manager. The receiver channel name must be same as the sender channel name.
Tip:
For more information on configuring your local queue and remote queue managers, see WebSphere MQ Intercommunication.pdf (SC34-6587). Refer to "Chapter 1: Concepts of Intercommunication" and "Chapter 2: Making Your Applications Communicate" for instructions on enabling communication between two Queue Managers.
The following properties, except for msgBody and msgBodyByteArray properties, are passed from the Put Service tab in Designer to the input signature of the Put service:
Property | Description |
deadLetterQueueName | A String that contains the name of the queue that will contain any messages that could not reach their destination. You set the value of this property in the Pipeline Editor, which overwrites any value set on the Put Service tab. |
deadLetterQueueManagerName | A String that contains the name of the queue manager for the dead letter queue. You set the value of this property in the Pipeline Editor, which overwrites any value set on the Put Service tab. |
deadLetterMessageHeaders | A String that contains the headers to include in the message sent to the dead letter queue. You set the value of this property in the Pipeline Editor, which overwrites any value set on the Put Service tab. None Includes any headers along with the original payload in the message sent to the dead letter queue. DLH Includes only the DLH header along with the original payload in the message sent to the dead letter queue. MQMD Includes only the MQMD header along with the original payload in the message sent to the dead letter queue. DLH_&_MQMD Includes both DLH and MQMD headers along with the original payload in the message sent to the dead letter queue. Default: DLH_&_MQMD |
msgBody | The contents of the payload. Note: The msgBody is only available via the input signature for the Put service, located on the Input/Output tab. |
msgBodyByteArray | The contents of the payload in a byte array. Note: The msgBodyByteArray is only available via the input signature for the Put service, located on the Input/Output tab. |
WebSphere MQ Adapter passes the following optional input fields from the JMS Properties tab in Designer to the input signature of the Put service. The data types for the JMS Properties are documented as they appear in Designer.
Note:
All the User-Defined Properties specified will also be passed to the input signature.
For a complete description of the JMS Property properties and their uses, refer to your JMS provider's user documentation.
JMS Property | Data Type |
JMSDestination | String |
JMSExpiration | String |
JMSPriority | String |
JMSDeliveryMode | String |
JMSCorrelationID | String |
JMSCorrelationIDByteArray | String |
JMSReplyTo | String |
JMSType | String |
JMSMessageID | String |
JMSTimestamp | String |
JMSRedelivered | String |
JMSXGroupID | String |
JMSXGroupIdByteArray | String |
JMSXGroupSeq | String |
JMSXUserID | String |
JMSXAppID | String |
JMSXDeliveryCount | String |
MCDMessageDomain | String |
MCDMessageSet | String |
MCDMessageFormat | String |
Note:
An "X" in the JMS property name indicates that the property is provider specific. The remaining JMS properties are generic, delivered by any JMS provider.
WebSphere MQ Adapter passes the following optional input fields from the MQMD Header tab in Designer to the input signature of the Put service. The data types for the msgHeader properties are documented as they appear in Designer.
For a complete description of the msgHeader properties and their uses, refer to IBM's WebSphere MQ user documentation.
msgHeader Property | Data Type |
AccountingToken* | String |
AccountingTokenByteArray* | Object |
ApplIdentityData | String |
ApplOriginData | String |
BackoutCount | String |
CodedCharSetId | String |
CorrelId | String |
CorrelationIdByteArray | Object |
Encoding | String |
Expiry | String |
Feedback | String |
Format | String |
GroupId* | String |
GroupIdByteArray* | Object |
MsgFlags | String |
MsgId | String |
MsgIdByteArray | Object |
MsgType | String |
MsgSeqNumber | String |
Offset | String |
OriginalLength | String |
Persistence | String |
Priority | String |
PutApplName | String |
PutApplType | String |
PutDate | String |
PutTime | String |
ReplytoQueueMgr | String |
ReplyToQ | String |
Report | String |
UserIdentifier | String |
Note:
An asterisk * indicates that you can enter these properties either as a string or as a byte array. For example, AccountingToken and AccountingTokenByteArray refer to the same msgHeader property. If you specify values for both properties, then the byte array value will be used.