MQ Put Message activity

Use the MQ Put Message activity sends a message to the specified queue during run time.

Note: You must have created an endpoint for the MQ activity before configuring the activity.
The Configure task has three sections:
  • Queue and Message details - where you specify properties for queue and message details.
  • Delivery rules - where you specify how you want messages delivered.
  • Retry options - where you specify how long to wait between retries and the number of time to retry before failing.

After completing the Configure tasks, and Mapping inputs for the activity.

Note: The maximum message size is 100 MBytes.

Queue and Message details

Specify the Queue and Message details using the fields in the following table. Required fields are marked with an asterisk.
Field Description
Queue Name * Specifies the name of the queue where the messages are put.
Payload Data Type Specifies the datatype of the message payload, either binary or string.
Message Type Datagram - Select if the message should be sent and no reply is needed.

Request - Select if the message should have a reply. Be sure to set the Reply to Queue property for request messages.

Response - Select if the message is a reply to a previous request.

Reply to Queue Specifies the queue the reply should be sent to for request messages.
Reply to Queue Manager Specifies the name of the Queue Manager that the queue (specified in the Reply to Queue field) belongs to.
Persistent
  • True - Messages are restored to queues if the Queue Manager crashes.
  • False - Messages may be lost from the queue if the Queue Manager crashes.
  • Default - Messages use the persistence setting for the queue (this is the default).
Priority Specifies the priority of the message.  By default, the message priority defaults to the default priority for the queue. If the queue uses priorities to order messages and this message should have a specific priority set, select Specify and enter the priority. Priorities can range from 1 (lowest) up to 9 (highest).
Note: The priority should not exceed the maximum priority number set for the MQ queue. Check with your MQ system administrator for this information.
Message Expiration The number of seconds that messages are kept in the queue before expiring. Defaults to Never, which ensures that the message is delivered and waits on the queue until it is retrieved, no matter how long that may take.

If messages for this queue should expire and be discarded after some period of time, select Specify and enter the maximum number of Seconds that the message should be kept in the queue.

Schema Fragment for MQRFH2 Header Specifies if an MQRFH2 header is included in the message. If the message is an XML message and includes a MQRFH2 header, select this check box and click [...]. In the Browse For Schema Type Element dialog box find the XML Schema that defines the header, select the NameValueData element in that XML Schema, and click OK. The schema fragment is the NameValueData element and all its child elements.  
Note: The XML Schema that defines the header must first be created and loaded into the project before you can select it. For more information see Defining and loading an XML schema for a MQRFH2 header.

Delivery rules

Field Description
Deliver Messages The options available here are:
  • At least once - Specifies that the message is delivered at least once but can be delivered more than once. Connection or Integration Appliance failures can result in messages being retrieved and processed more than once. This delivery option is typically used when the receiving system can detect or tolerate duplicate messages.
  • At most once - Specifies the message is delivered only once or not at all. Connection or Integration Appliance failures can result in messages being missed. This delivery option is typically used when the receiving system cannot tolerate duplicate messages but can tolerate lost messages.

Retry options

Configure the retry options for connecting to a MQ Server. The following table describes the retry options for connecting to a MQ Server:

Retry Options Description
1) Wait ___ second(s) between each retry. The number of seconds that the Integration Appliance waits before attempting to contact the Queue manager to send a message to MQ Server, again.
2) Try to connect ___ times before failing. Specifies the maximum number of times the Integration Appliance attempts to contact the Queue manager to send a message to the MQ Server before issuing an error and stopping the processing of the current orchestration job.

If you deploy an orchestration that contains an MQ Put Message activity and the Integration Appliance cannot connect to the Queue manager of the specified MQ Server, the Integration Appliance logs the errors as warnings in the system and orchestration logs until the retry count value is reached. When the retry count is reached, the Integration Appliance logs an error in the system and orchestration logs and the stops processing the current orchestration job.

For example, you set the retry count to 3. The first, second, and third connection errors appear in the system log as warnings. The Integration Appliance logs the fourth error as an error and stops processing the current orchestration job.

Mapping inputs

You are required to map input parameters for this activity. The following parameter is required and must be mapped in order for the configuration to be complete. All other parameters are optional. See Creating a Map for more information.
Required Input Parameters:
payload

To view the optional input parameters in the To Activity panel of the Map Inputs panel, select Map > Show Optional Parameters from the toolbar menu or right-click in the To Activity panel and select the Show Optional Parameters option. If the Map > Show Optional Parameters option is not selectable in the toolbar menu, click on a node in the Map Inputs panel to activate this option.




Feedback | Notices


Timestamp icon Last updated: Wednesday, 15 June 2016


http://pic.dhe.ibm.com/infocenter/wci/v7r0m0/topic/com.ibm.wci.doc/MQ_Put_Message_Activity.html