queue in connector

Description - Reads one message from an ActiveMQ queue or topic

Runtime Class - com.ibi.agents.XDActiveMQReadAgent


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
AcknowledgementstringMakes 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 a client's receipt of a message when it has either successfully returned from a call to receive or the message listener it has called to process the message successfully returns.
  • Client Acknowledge {Client_Acknowledge} - the client acknowledges a message by calling a message's acknowledge method.
  • Dups OK Acknowledge {Duplicates_OK} - Instructs the session to lazily acknowledge the delivery of messages.
  • Session Transacted {trans} - Specifies that the session should use a local transaction
Get Correlation ID as BytesbooleanBytes allows for binary in correlation IDs
TimeoutintegerThe timeout period in seconds that the read will await availability of a message on the input queue.
* - denotes required
 ParameterTypeDescription
Parse:stringShould the agent attempt to parse the input in 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:stringIf used, input is filtered by this selector
* - denotes required
 ParameterTypeDescription
Embed:booleanWhether to embed the data from the read operation into the input document
Tag:stringName of the XML tag to wrap the data read in. Required if data is flat
Parent Tag:stringWhere in the input document the input data should be embedded
Base64 Encode:booleanBase64 encode the read in document when embedding
* - denotes required
 ParameterTypeDescription
Namespace:stringSpecial 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
 ParameterTypeDescription
Return Document:stringDetermines 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:stringWhether 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

NameDescription
onFailParseCould not parse a document.
onFailConnectCould not connect to the external system.
onFailPartnerGeneric or unknown SERVER error. Something occurred between the adapter and the adaptee communication.
onFailOperationCould not perform the operation requested.
onNoMessageNo messages matched the criteria.
onUnknownMesageTypeUnsupported message type.
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

 ParameterTypeDescription
Acknowledgement:stringMakes 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
TimeoutintegerThe timeout period in seconds that the read will await availability of a message on the input queue.
Get Correlation ID as BytesbooleanBytes allows for binary in correlation IDs
* - denotes required
 ParameterTypeDescription
Parse:stringShould 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:stringIf used, input is filtered by this selector
* - denotes required
 ParameterTypeDescription
EmbedbooleanWhether to embed the data from the read operation into the input document
TagstringName of the XML tag to wrap the data read in. Required if data is flat
Parent TagstringWhere in the input document the input data should be embedded
Base64 EncodebooleanBase64 encode the read in document when embedding
* - denotes required
 ParameterTypeDescription
Namespace:stringSpecial 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
 ParameterTypeDescription
Return Document:stringDetermines 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:stringWhether 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

NameDescription
onFailParseCould not parse a document.
onFailConnectCould not connect to the external system.
onFailPartnerGeneric or unknown SERVER error. Something occurred between the adapter and the adaptee communication.
onFailOperationCould not perform the operation requested.
onNoMessageNo messages matched the criteria.
onUnknownMesageTypeUnsupported message type.
Description - Read a message from RabbitMQ using AMQP

Runtime Class - com.ibi.agents.XDRabbitMQReadAgent


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
*Name:stringMessages will be consumed from this queue
* - denotes required
 ParameterTypeDescription
Timeout:integerPeriod to wait in milliseconds for the message to become available. 0 means return immediately.
* - denotes required
 ParameterTypeDescription
Headers:stringA register which protocol headers will be saved from the incoming document.
* - denotes required

Output Events

NameDescription
OnParseErrorCould not parse a document.
OnFailConnectionCould not connect to the external system.
OnFailedOperationCould not perform the operation requested.
OnFailPartnerGeneric or unknown SERVER error. Something occurred between the adapter and the adaptee communication.
noMessageNo messages matched the criteria.
Description - Reads and parses MQ queue records using the JMS API

Runtime Class - com.ibi.agents.XDMQJMSReadAgent


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Acknowledgement:stringMakes 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 a client's receipt of a message when it has either successfully returned from a call to receive or the message listener it has called to process the message successfully returns.
  • Client Acknowledge {Client_Acknowledge} - the client acknowledges a message by calling a message's acknowledge method.
  • Dups OK Acknowledge {Duplicates_OK} - Instructs the session to lazily acknowledge the delivery of messages.
  • Session Transacted {trans} - Specifies that the session should use a local transaction
Timeout:integerThe timeout period in seconds that the read will await availability of a message on the input queue.
Get Correlation ID as Bytes:booleanBytes allows for binary in correlation IDs
* - denotes required
 ParameterTypeDescription
Parse:stringShould the agent attempt to parse the input in 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:stringIf used, input is filtered by this selector
* - denotes required
 ParameterTypeDescription
Embed:booleanWhether to embed the data from the read operation into the input document
Tag:stringName of the XML tag to wrap the data read in. Required if data is flat
Parent Tag:stringWhere in the input document the input data should be embedded
Base64 Encode:booleanBase64 encode the read in document when embedding
* - denotes required
 ParameterTypeDescription
Namespace:stringSpecial 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
 ParameterTypeDescription
Return Document:stringDetermines the output document, select status for a status document, or select results for the message read.

Select from one of the following options:
  • status - status document will be the out document.
  • results {result} - message read will become the out document.
Action on Failure:stringWhether input document or status document returned on failure.

Select from one of the following options:
  • status - status document will be the out document.
  • input - in document will become the out document.
* - denotes required

Output Events

NameDescription
OnParseErrorCould not parse a document.
OnFailConnectionCould not connect to the external system.
OnFailPartnerGeneric or unknown SERVER error. Something occurred between the adapter and the adaptee communication.
OnFailedOperationCould not perform the operation requested.
onNoMessageNo messages matched the criteria.
onUnknownMesageTypeUnsupported message type.
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

 ParameterTypeDescription
Format:stringFormat 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:integerThe timeout period in seconds that the read will await availability of a message on the input queue.
Browse:booleanIf set, operation is BROWSE only (non-transactional)
* - denotes required
 ParameterTypeDescription
By Msg Id:stringIf set to a value, incoming messages on the queue are filtered to reject those without this message id
By Correlation Id:stringIf set to a value, incoming messages on the queue are filtered to reject those without this correlation id
By Group Id:stringIf set to a value, incoming messages on the queue are filtered to reject those without this group id
* - denotes required
 ParameterTypeDescription
Namespace:stringSpecial 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

NameDescription
OnParseErrorCould not parse a document.
OnFailConnectionCould not connect to the external system.
OnNotFoundThe resource was not found and this is considered an error.
OnFailedOperationCould not perform the operation requested.
OnFailTimeoutThe operation timed out.
OnFailSecurityCould not operate due to a security violation.
Description - Reads and parses JMS records

Runtime Class - com.ibi.agents.XDJMSReadAgent


Configuration

This action requires a Generics Configuration as well as the following required parameters.

Parameter Groups

 ParameterTypeDescription
Acknowledgement:stringMakes 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 a client's receipt of a message when it has either successfully returned from a call to receive or the message listener it has called to process the message successfully returns.
  • Client Acknowledge {Client_Acknowledge} - the client acknowledges a message by calling a message's acknowledge method.
  • Dups OK Acknowledge {Duplicates_OK} - Instructs the session to lazily acknowledge the delivery of messages.
  • Session Transacted {trans} - Specifies that the session should use a local transaction
Timeout:integerThe timeout period in seconds that the read will await availability of a message on the input queue.
Get Correlation ID as Bytes:booleanBytes allows for binary in correlation IDs
* - denotes required
 ParameterTypeDescription
Parse:stringShould the agent attempt to parse the input in 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:stringIf used, input is filtered by this selector
* - denotes required
 ParameterTypeDescription
Embed:booleanWhether to embed the data from the read operation into the input document
Tag:stringName of the XML tag to wrap the data read in. Required if data is flat
Parent Tag:stringWhere in the input document the input data should be embedded
Base64 Encode:booleanBase64 encode the read in document when embedding
* - denotes required
 ParameterTypeDescription
Namespace:stringSpecial 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
 ParameterTypeDescription
Return Document:stringDetermines the output document, select status for a status document, or select results for the message read.

Select from one of the following options:
  • status - status document will be the out document.
  • results {result} - message read will become the out document.
Action on Failure:stringWhether input document or status document returned on failure.

Select from one of the following options:
  • status - status document will be the out document.
  • input - in document will become the out document.
* - denotes required

Output Events

NameDescription
OnParseErrorCould not parse a document.
OnFailConnectionCould not connect to the external system.
OnFailPartnerGeneric or unknown SERVER error. Something occurred between the adapter and the adaptee communication.
OnFailedOperationCould not perform the operation requested.
onNoMessageNo messages matched the criteria.
OnUnknownMesageTypeUnsupported message type.