IBM MQ - send a message
Search form
Description - Emits input document to Message Queuing queue; returns a status document or the original input document as the output document
Runtime Class - com.ibi.agents.XDMQEmitAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description Outgoing ID: string If set to a value, this is used as the correlation id of the outgoing message
ID Tag: string Name of the element in the input document that holds the Correlation ID to use. Ignored when Correlation ID is specified.
* - denotes required
Parameter Type Description Priority: string Outgoing message priority (if omitted uses incoming priority)
CharacterSet: string IBM MQ Read and Write methods perform data conversion; they convert between the internal formats, and the IBM MQ message formats as defined by the Encoding and CharacterSet properties from the message. When writing a message you should, if possible, set values into Encoding and CharacterSet that match the characteristics of the recipient of the message. MQCCSI_INHERIT - Character data in the data following this structure is in the same character set as this structure. The queue manager changes this value in the structure sent in the message to the actual character-set identifier of the structure. MQCCSI_Q_MGR - Character data in the message is in the queue manager's character set. The default value for this field is MQCCSI_Q_MGR.
Select from one of the following options:
- MQCCSI_INHERIT {-2}
- MQCCSI_Q_MGR {0}
Format: string Name of MQ message format. Default STRING
Select from one of the following options:
- NONE (no translation) {NONE}
- STRING (auto translation) {STRING}
Type: string Type of the MQ message to be written
Select from one of the following options:
- Datagram {datagram} - An unsolicited message
- Request {request} - A message for which a response is expected
- Response {response} - A reply to a request message
Persistence: string Message persistence. Default is as defined for the queue.
Select from one of the following options:
- Queue {queue} - Persist as defined by queue
- Persistent {persistent} - Message should be persistent
- Non-Persistent {non-persistent} - Message should be non-persistent
Expiry: integer An expiry time expressed in tenths of a second. Enter 0 or leave blank for unlimited.
* - denotes required
Parameter Type Description Register: string Special register namespace from which the outgoing message's RFH2 header properties will be created. Choose "None" when not creating any RFH2 header properties, choose Default when the register's namespace dictates the folder where the header property will be created (except the default namespace creates properties in the usr folder), or enter a register namespace name such that a matching special register name patterned like nsname.foldername.propname creates the header property propname in the folder foldername.
Select from one of the following options:
- None {none}
- Default Namespace {default}
Include User Registers boolean When a register namespace for headers is set to create RFH2 header properties, this determines whether user-level registers also create header properties.
* - denotes required
Parameter Type Description Delivery: string Request Confirmation Of Delivery report message; requires Report Queue
Select from one of the following options:
- None {none} - Do not request report
- No Data {nodata} - Request report with no data
- Partial {partial} - Request report with a fixed amount of data
- Full Data {full data} - Request report with full data
Arrival: string Request Confirmation Of Arrival report message; requires Report Queue
Select from one of the following options:
- None {none} - Do not request report
- No Data {nodata} - Request report with no data
- Partial {partial} - Request report with a fixed amount of data
- Full Data {full data} - Request report with full data
Report Queue: string The name of the report queue. Required if COA or COD is requested or the MQ message type (Type) is request
* - denotes required
Parameter Type Description Output Document Type string Whether output document emitted should be the original input document (original) or a status document (status)
Select from one of the following options:
- Status Document {status} - An exit-appropriate status document
- Input Document {input} - The original input document
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDMQEmitAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description Outgoing ID: string If set to a value, this is used as the correlation id of the outgoing message
ID Tag: string Name of the element in the input document that holds the Correlation ID to use. Ignored when Correlation ID is specified.
* - denotes required
Parameter Type Description Priority: string Outgoing message priority (if omitted uses incoming priority)
CharacterSet: string IBM MQ Read and Write methods perform data conversion; they convert between the internal formats, and the IBM MQ message formats as defined by the Encoding and CharacterSet properties from the message. When writing a message you should, if possible, set values into Encoding and CharacterSet that match the characteristics of the recipient of the message. MQCCSI_INHERIT - Character data in the data following this structure is in the same character set as this structure. The queue manager changes this value in the structure sent in the message to the actual character-set identifier of the structure. MQCCSI_Q_MGR - Character data in the message is in the queue manager's character set. The default value for this field is MQCCSI_Q_MGR.
Select from one of the following options:
- MQCCSI_INHERIT {-2}
- MQCCSI_Q_MGR {0}
Format: string Name of MQ message format. Default STRING
Select from one of the following options:
- NONE (no translation) {NONE}
- STRING (auto translation) {STRING}
Type: string Type of the MQ message to be written
Select from one of the following options:
- Datagram {datagram} - An unsolicited message
- Request {request} - A message for which a response is expected
- Response {response} - A reply to a request message
Persistence: string Message persistence. Default is as defined for the queue.
Select from one of the following options:
- Queue {queue} - Persist as defined by queue
- Persistent {persistent} - Message should be persistent
- Non-Persistent {non-persistent} - Message should be non-persistent
Expiry: integer An expiry time expressed in tenths of a second. Enter 0 or leave blank for unlimited.
* - denotes required
Parameter Type Description Register: string Special register namespace from which the outgoing message's RFH2 header properties will be created. Choose "None" when not creating any RFH2 header properties, choose Default when the register's namespace dictates the folder where the header property will be created (except the default namespace creates properties in the usr folder), or enter a register namespace name such that a matching special register name patterned like nsname.foldername.propname creates the header property propname in the folder foldername.
Select from one of the following options:
- None {none}
- Default Namespace {default}
Include User Registers boolean When a register namespace for headers is set to create RFH2 header properties, this determines whether user-level registers also create header properties.
* - denotes required
Parameter Type Description Delivery: string Request Confirmation Of Delivery report message; requires Report Queue
Select from one of the following options:
- None {none} - Do not request report
- No Data {nodata} - Request report with no data
- Partial {partial} - Request report with a fixed amount of data
- Full Data {full data} - Request report with full data
Arrival: string Request Confirmation Of Arrival report message; requires Report Queue
Select from one of the following options:
- None {none} - Do not request report
- No Data {nodata} - Request report with no data
- Partial {partial} - Request report with a fixed amount of data
- Full Data {full data} - Request report with full data
Report Queue: string The name of the report queue. Required if COA or COD is requested or the MQ message type (Type) is request
* - denotes required
Parameter Type Description Output Document Type string Whether output document emitted should be the original input document (original) or a status document (status)
Select from one of the following options:
- Status Document {status} - An exit-appropriate status document
- Input Document {input} - The original input document
* - denotes required
Output Events
Configuration
This action requires a Generics Configuration as well as the following required parameters.Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| Outgoing ID: | string | If set to a value, this is used as the correlation id of the outgoing message | ID Tag: | string | Name of the element in the input document that holds the Correlation ID to use. Ignored when Correlation ID is specified. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Priority: | string | Outgoing message priority (if omitted uses incoming priority) | CharacterSet: | string | IBM MQ Read and Write methods perform data conversion; they convert between the internal formats, and the IBM MQ message formats as defined by the Encoding and CharacterSet properties from the message. When writing a message you should, if possible, set values into Encoding and CharacterSet that match the characteristics of the recipient of the message. MQCCSI_INHERIT - Character data in the data following this structure is in the same character set as this structure. The queue manager changes this value in the structure sent in the message to the actual character-set identifier of the structure. MQCCSI_Q_MGR - Character data in the message is in the queue manager's character set. The default value for this field is MQCCSI_Q_MGR.
Select from one of the following options:
|
Format: | string | Name of MQ message format. Default STRING
Select from one of the following options:
|
Type: | string | Type of the MQ message to be written
Select from one of the following options:
|
Persistence: | string | Message persistence. Default is as defined for the queue.
Select from one of the following options:
|
Expiry: | integer | An expiry time expressed in tenths of a second. Enter 0 or leave blank for unlimited. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Register: | string | Special register namespace from which the outgoing message's RFH2 header properties will be created. Choose "None" when not creating any RFH2 header properties, choose Default when the register's namespace dictates the folder where the header property will be created (except the default namespace creates properties in the usr folder), or enter a register namespace name such that a matching special register name patterned like nsname.foldername.propname creates the header property propname in the folder foldername.
Select from one of the following options:
|
Include User Registers | boolean | When a register namespace for headers is set to create RFH2 header properties, this determines whether user-level registers also create header properties. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Delivery: | string | Request Confirmation Of Delivery report message; requires Report Queue
Select from one of the following options:
|
Arrival: | string | Request Confirmation Of Arrival report message; requires Report Queue
Select from one of the following options:
|
Report Queue: | string | The name of the report queue. Required if COA or COD is requested or the MQ message type (Type) is request |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Output Document Type | string | Whether output document emitted should be the original input document (original) or a status document (status)
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. |
| OnFailSecurity | Could not operate due to a security violation. |