IBM MQ Get Activity
Use this activity to retrieve a message from a queue.
Configuration
The Configuration tab has the following fields:
| Field | Description |
|---|---|
| Connection | Select the connection. |
| GMO Convert | Enable to set the Get Message Option Convert for the get operation. This instructs the queue manager to perform conversions as a part of the GET operation. |
| Max Message Size |
Set this field to the number of bytes required for the largest expected message. The messages that are larger than the buffer size are consumed without truncation.
In case of |
| Value Deserializer | Select one of the options:
String or
JSON.
If JSON is selected an entry area for the JSON schema is provided. |
Input Settings
The Input Settings tab contains fields that might be specified either in hard coded format or mapped to the Input tab. Each field on this tab has an equivalent field on the Input tab.
| Field | Description |
|---|---|
| Destination | The queue on which you want to perform the Get operation. |
| CorrelId | Enter correlation ID in the form of a string to filter the Get. If the string is base64 encoded, it is decoded first and then used to filter the Get, otherwise, the string is used directly. |
| MsgId | Enter Message ID in the form of a string to filter the Get. If the string is base64 encoded, it is decoded first and then used to filter the Get, otherwise the string is used directly. |
| Wait Interval | The time taken in milliseconds by the Get operation before getting a timeout error. |
Input
The Input tab contains the same fields as mentioned in the Input Settings tab. They are mappable here and the values override the Input Settings tab.
Output Settings
The Output Settings tab displays the output schema of the activity as a tree structure. The output is read-only. The information in the schema varies based on the fields selected on the Configuration tab. The properties that are displayed in the schema correspond to the output of this activity and can be used as input by subsequent activities in the flow.
| Field | Description |
|---|---|
| Schema for JSON Value | If the Value Deserializer is set to JSON, this field accepts a JSON value. The string in the message must deserialize to correctly match this schema. |
| Properties | Click the Add Row button to add each string property. Properties are displayed on the output schema under the
MessageProperties
node.
Note: The messages that are expected to contain properties can be mapped here. It is necessary to map properties that areused in the flow.
|
Output
The Output tab has the following fields:
| Field | Description |
|---|---|
| Message | The output of the message is encoded as a JSON object if one was configured. |
| MessageProperties | The properties attached to the message. |
| MsgType | The type of message displayed: Request, Reply, Report, Datagram |
| MsgId | The binary fields mapped to the output as base64 strings. They are unique when generated by the queue manager but can also be specified by the sender. |
| CorrelId | The binary fields are mapped to the output as base64 strings. They are unique when generated by the queue manager but can also be specified by the sender. |
| Encoding | Specifies the encoding of floating point data in the message. |
| CodedCharSetId | Specifies the encoding for string data in the message and its properties. |
| Format | A free form of a string variable that describes the format of the message. The default value is MQSTR. |
| Priority | An integer field describing the queue manager's delivery priority. The default value is 4 but it can be overridden by the sending application. |
| BackoutCount | The number of times the message withdrew. The backout count is incremented every time a subscriber withdraws a message when the confirmed activity is not encountered in the flow. |
| ReplyToQ | The name of the queue to which a reply can be sent. |
| ReplyToQmgr | The name of the queue manager hosting the reply to the queue. This is only applicable to clustered queue managers. |
| UserIdentifier | The identity of the user. Normally, it is set to the user ID of the sending application, but can be overridden by the sending application if it has access to change the identity context fields. |
| AccountingToken | It contains accounting information relevant to the processing of the message unless overridden by the sending application. |
| ApplIdentityData | It is set to any string value by the sending application. The maximum length is 32 bytes. |
| PutApplType | It is set to a value describing the sending application. For more information about this field on various platforms, see IBM MQMD documentation. |
| PutApp|Name | Name of the application as determined by the client library. |
| PutDate | The date on which the message was sent. |
| PutTime | The time at which the message was sent. |
| ApplOriginData | Set by the sending application to provide additional information about the nature of the sending application. |
Iterator
Use the Iterator tab to iterate a certain piece of logic multiple times. If you leave this tab blank, the activity is executed only once. For more information about Iterator, see "Using the Iterator in an Activity" in the TIBCO Flogo® apps documentation.