SonicMQ - get a message
Search form
Description - Sonic Read Agent
Runtime Class - com.ibi.agents.XDSonicReadAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description Acknowledgement: string Makes the JMS Session transactional or else specifies how received messages are acknowledged
Select from one of the following options:
- Auto Acknowledge {Auto_Acknowledge} - The session automatically acknowledges the client receipt of a message by successfully returning from a call to receive (synchronous mode) or when the session message listener successfully returns (asynchronous mode).
- Client Acknowledge {Client_Acknowledge} - An explicit acknowledge on a message acknowledges the receipt of all messages that were produced and consumed by the session that gives the acknowledgement. When a session is forced to recover, it restarts with its first unacknowledged message.
- Dups OK Acknowledge {Duplicates_OK} - The session slowly acknowledges the delivery of messages to consumers, possibly allowing some duplicate messages after a system outage.
- Session Transacted {trans} - Specifies that the session should use a local transaction
Timeout integer The timeout period in seconds that the read will await availability of a message on the input queue.
Get Correlation ID as Bytes boolean Bytes allows for binary in correlation IDs
* - denotes required
Parameter Type Description Parse: string Should the message be parsed as a specific format
Select from one of the following options:
- As Is {flat} - Do not parse the input
- XML {xml} - Parse as XML
- JSON {json} - Parse as JSON
Selector: string If used, input is filtered by this selector
* - denotes required
Parameter Type Description Embed boolean Whether to embed the data from the read operation into the input document
Tag string Name of the XML tag to wrap the data read in. Required if data is flat
Parent Tag string Where in the input document the input data should be embedded
Base64 Encode boolean Base64 encode the read in document when embedding
* - denotes required
Parameter Type Description Namespace: string Special register namespace into which protocol headers from the incoming request will be saved.
Select from one of the following options:
- Default Namespace {default}
* - denotes required
Parameter Type Description Return Document: string Determines the output document, select status for a status document, or select results for the message read.
Select from one of the following options:
- Status Document {status} - status document will be the out document.
- Result Document {result} - message read will become the out document.
Action on Failure: string Whether input document or status document returned on failure.
Select from one of the following options:
- Status Document {status} - status document will be the out document.
- Input Document {input} - in document will become the out document.
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDSonicReadAgent
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description Acknowledgement: string Makes the JMS Session transactional or else specifies how received messages are acknowledged
Select from one of the following options:
- Auto Acknowledge {Auto_Acknowledge} - The session automatically acknowledges the client receipt of a message by successfully returning from a call to receive (synchronous mode) or when the session message listener successfully returns (asynchronous mode).
- Client Acknowledge {Client_Acknowledge} - An explicit acknowledge on a message acknowledges the receipt of all messages that were produced and consumed by the session that gives the acknowledgement. When a session is forced to recover, it restarts with its first unacknowledged message.
- Dups OK Acknowledge {Duplicates_OK} - The session slowly acknowledges the delivery of messages to consumers, possibly allowing some duplicate messages after a system outage.
- Session Transacted {trans} - Specifies that the session should use a local transaction
Timeout integer The timeout period in seconds that the read will await availability of a message on the input queue.
Get Correlation ID as Bytes boolean Bytes allows for binary in correlation IDs
* - denotes required
Parameter Type Description Parse: string Should the message be parsed as a specific format
Select from one of the following options:
- As Is {flat} - Do not parse the input
- XML {xml} - Parse as XML
- JSON {json} - Parse as JSON
Selector: string If used, input is filtered by this selector
* - denotes required
Parameter Type Description Embed boolean Whether to embed the data from the read operation into the input document
Tag string Name of the XML tag to wrap the data read in. Required if data is flat
Parent Tag string Where in the input document the input data should be embedded
Base64 Encode boolean Base64 encode the read in document when embedding
* - denotes required
Parameter Type Description Namespace: string Special register namespace into which protocol headers from the incoming request will be saved.
Select from one of the following options:
- Default Namespace {default}
* - denotes required
Parameter Type Description Return Document: string Determines the output document, select status for a status document, or select results for the message read.
Select from one of the following options:
- Status Document {status} - status document will be the out document.
- Result Document {result} - message read will become the out document.
Action on Failure: string Whether input document or status document returned on failure.
Select from one of the following options:
- Status Document {status} - status document will be the out document.
- Input Document {input} - in document will become the out document.
* - denotes required
Output Events
Configuration
This action requires a Generics Configuration as well as the following required parameters.Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| Acknowledgement: | string | Makes the JMS Session transactional or else specifies how received messages are acknowledged
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. | Get Correlation ID as Bytes | boolean | Bytes allows for binary in correlation IDs |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Parse: | string | Should the message be parsed as a specific format
Select from one of the following options:
|
Selector: | string | If used, input is filtered by this selector |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Embed | boolean | Whether to embed the data from the read operation into the input document | Tag | string | Name of the XML tag to wrap the data read in. Required if data is flat | Parent Tag | string | Where in the input document the input data should be embedded | Base64 Encode | boolean | Base64 encode the read in document when embedding |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Namespace: | string | Special register namespace into which protocol headers from the incoming request will be saved.
Select from one of the following options:
|
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Return Document: | string | Determines the output document, select status for a status document, or select results for the message read.
Select from one of the following options:
|
Action on Failure: | string | Whether input document or status document returned on failure.
Select from one of the following options:
|
* - denotes required
Output Events
| Name | Description |
|---|---|
| onFailParse | Could not parse a document. |
| onFailConnect | Could not connect to the external system. |
| onFailPartner | Generic or unknown SERVER error. Something occurred between the adapter and the adaptee communication. |
| onFailOperation | Could not perform the operation requested. |
| onNoMessage | No messages matched the criteria. |
| onUnknownMesageType | Unsupported message type. |