IBM MQ - get a message
Search form
Description - Reads a single record from an MQ Series queue
Runtime Class - com.ibi.agents.XDMQReadAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
  Parameter Type Description Format: string Format of the input data message, default is auto detection
Select from one of the following options:
- Automatic {auto} - Input is inspected for type
- XML - Input must be an XML document
- JSON {json} - Input must be a JSON document
- Bytes {byte} - Input to be carried as bytes
- String {string} - Input to be carried as a string
 
Timeout: integer The timeout period in seconds that the read will await availability of a message on the input queue.
 
Browse: boolean If set, operation is BROWSE only (non-transactional)
 
* - denotes required
  Parameter Type Description By Msg Id: string If set to a value, incoming messages on the queue are filtered to reject those without this message id
 
By Correlation Id: string If set to a value, incoming messages on the queue are filtered to reject those without this correlation id
 
By Group Id: string If set to a value, incoming messages on the queue are filtered to reject those without this group id
 
* - denotes required
  Parameter Type Description Namespace: string Special register namespace to store incoming message's RFH2 header properties.
Select from one of the following options:
- None {none}
- Default Namespace {default}
 
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDMQReadAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
  Parameter Type Description Format: string Format of the input data message, default is auto detection
Select from one of the following options:
- Automatic {auto} - Input is inspected for type
- XML - Input must be an XML document
- JSON {json} - Input must be a JSON document
- Bytes {byte} - Input to be carried as bytes
- String {string} - Input to be carried as a string
 
Timeout: integer The timeout period in seconds that the read will await availability of a message on the input queue.
 
Browse: boolean If set, operation is BROWSE only (non-transactional)
 
* - denotes required
  Parameter Type Description By Msg Id: string If set to a value, incoming messages on the queue are filtered to reject those without this message id
 
By Correlation Id: string If set to a value, incoming messages on the queue are filtered to reject those without this correlation id
 
By Group Id: string If set to a value, incoming messages on the queue are filtered to reject those without this group id
 
* - denotes required
  Parameter Type Description Namespace: string Special register namespace to store incoming message's RFH2 header properties.
Select from one of the following options:
- None {none}
- Default Namespace {default}
 
* - denotes required
Output Events
Configuration
This action requires a Generics Configuration as well as the following required parameters.Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| Format: | string | Format of the input data message, default is auto detection Select from one of the following options: 
 | Timeout: | integer | The timeout period in seconds that the read will await availability of a message on the input queue. | Browse: | boolean | If set, operation is BROWSE only (non-transactional) | 
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| By Msg Id: | string | If set to a value, incoming messages on the queue are filtered to reject those without this message id | By Correlation Id: | string | If set to a value, incoming messages on the queue are filtered to reject those without this correlation id | By Group Id: | string | If set to a value, incoming messages on the queue are filtered to reject those without this group id | 
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Namespace: | string | Special register namespace to store incoming message's RFH2 header properties. Select from one of the following options: 
 | 
* - denotes required
Output Events
| Name | Description | 
|---|---|
| OnParseError | Could not parse a document. | 
| OnFailConnection | Could not connect to the external system. | 
| OnNotFound | The resource was not found and this is considered an error. | 
| OnFailedOperation | Could not perform the operation requested. | 
| OnFailTimeout | The operation timed out. | 
| OnFailSecurity | Could not operate due to a security violation. | 
