Description - Emits a message to an ActiveMQ queue or topic

Runtime Class - com.ibi.agents.XDActiveMQEmitAgent

Configuration

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

Parameter Groups

• Message
• JMS Headers
• JMS Settings
• Post Action

	Parameter	Type	Description
	Correlation ID:	string	Value of the JMSCorrelationID header field
	Priority:	integer	Outgoing message priority. Value must be between 0 and 9, with 9 most expedited. If omitted uses incoming priority.
	Type:	string	Class of message sent. Dynamic will select BytesMessage, TextMessage or MapMessage depending on the document contents. Select from one of the following options: BytesMessage {bytes} Dynamic {dynamic} MapMessage {map} TextMessage {text}

* - denotes required

	Parameter	Type	Description
	ReplyTo:	string	Value of the JMSReplyTo header field
	Type:	string	Value of the JMSType header field
	Protocol:	string	Special register namespace from which protocol headers for the outbound request will be taken. Select from one of the following options: Default Namespace {default} None {none}

* - denotes required

	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} - 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} - the client acknowledges a message by calling a message's acknowledge method. Dups OK Acknowledge {dupsok} - Instructs the session to lazily acknowledge the delivery of messages. Session Transacted {trans} - Specifies that the session should use a local transaction
	Delivery Mode:	string	Non-Persistent mode has low overhead but may lose messages. Persistent mode takes extra care to ensure the message is not lost in transit but makes no absolute guarantee. Select from one of the following options: Non-Persistent {1} Persistent {2}
	Time to Live:	integer	The message's lifetime (in milliseconds), default will live forever
	Delivery Delay:	integer	Minimum length of time in milliseconds that must elapse after a message is sent before the JMS provider may deliver the message to a consumer. JMS 2 only.

* - denotes required

	Parameter	Type	Description
	Return Document:	string	Type of output from this service. Select from one of the following options: Status document {status} - Returns a status document. Input document {input} - Returns the document passed into the object.

* - denotes required

Output Events

Name	Description
onFailConnect	Could not connect to the external system.

Description - Emits input document to a JMS (Java Messaging Service) Queue or Topic; returns a status document or the original input document as the output document

Runtime Class - com.ibi.agents.XDJMSQEmitAgent

Configuration

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

Parameter Groups

• Message
• JMS Settings
• JMS Headers
• Post Action

	Parameter	Type	Description
	Correlation ID:	string	Value of the JMSCorrelationID header field
	Correlation ID Tag:	string	Name of the element in the input document that holds the Correlation ID to use. Takes precedence over Correlation ID when both are specified.
	Priority:	integer	Outgoing message priority. Value must be between 0 and 9, with 9 most expedited. If omitted uses incoming priority.
	Type:	string	Class of message sent. Dynamic will select BytesMessage, TextMessage or MapMessage depending on the document contents. Select from one of the following options: BytesMessage {bytes} Dynamic {dynamic} MapMessage {map} TextMessage {text}

* - denotes required

	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} - 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} - the client acknowledges a message by calling a message's acknowledge method. Dups OK Acknowledge {dupsok} - Instructs the session to lazily acknowledge the delivery of messages. Session Transacted {trans} - Specifies that the session should use a local transaction
	Delivery Mode:	string	Non-Persistent mode has low overhead but may lose messages. Persistent mode takes extra care to ensure the message is not lost in transit but makes no absolute guarantee. Select from one of the following options: Non-Persistent {1} Persistent {2}
	Time to Live:	integer	The message's lifetime (in milliseconds), default will live forever
	Delivery Delay:	integer	Minimum length of time in milliseconds that must elapse after a message is sent before the JMS provider may deliver the message to a consumer. JMS 2 only.

* - denotes required

	Parameter	Type	Description
	ReplyTo:	string	Value of the JMSReplyTo header field
	Type:	string	Value of the JMSType header field
	Protocol:	string	Special register namespace from which protocol headers for the outbound request will be taken. Select from one of the following options: Default Namespace {default} None {none}

* - denotes required

	Parameter	Type	Description
*	Output Document:	string	Document returned by object Select from one of the following options: Status Document {status} - Returns a status document Input Document {original} - Returns the input document of the object.

* - denotes required

Output Events

Name	Description
OnFailConnection	Could not connect to the external system.
OnParseError	Could not parse a document.

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

• Correlation ID
• Message
• Headers
• Confirmation
• Post Action

	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

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.

Description - Emits input document to IBM MQ using the JMS API.

Runtime Class - com.ibi.agents.XDMQJMSEmitAgent

Configuration

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

Parameter Groups

• Message
• JMS Settings
• JMS Headers
• Post Action

	Parameter	Type	Description
	Correlation ID:	string	Value of the JMSCorrelationID header field
	Priority:	integer	Outgoing message priority. Value must be between 0 and 9, with 9 most expedited. If omitted uses incoming priority.
	Type:	string	Class of message sent. Dynamic will select BytesMessage, TextMessage or MapMessage depending on the document contents. Select from one of the following options: BytesMessage {bytes} Dynamic {dynamic} MapMessage {map} TextMessage {text}

* - denotes required

	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} - 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} - the client acknowledges a message by calling a message's acknowledge method. Dups OK Acknowledge {dupsok} - Instructs the session to lazily acknowledge the delivery of messages. Session Transacted {trans} - Specifies that the session should use a local transaction
	Delivery Mode:	string	Non-Persistent mode has low overhead but may lose messages. Persistent mode takes extra care to ensure the message is not lost in transit but makes no absolute guarantee. Select from one of the following options: Non-Persistent {1} Persistent {2}
	Time to Live:	integer	The message's lifetime (in milliseconds), default will live forever
	Delivery Delay:	integer	Minimum length of time in milliseconds that must elapse after a message is sent before the JMS provider may deliver the message to a consumer. JMS 2 only.

* - denotes required

	Parameter	Type	Description
	ReplyTo:	string	Value of the JMSReplyTo header field
	Type:	string	Value of the JMSType header field
	Protocol:	string	Special register namespace from which protocol headers for the outbound request will be taken. Select from one of the following options: Default Namespace {default} None {none}

* - denotes required

	Parameter	Type	Description
*	Output Document:	string	Document returned by object Select from one of the following options: Status Document {status} - Returns a status document Input Document {original} - Returns the input document of the object.

* - denotes required

Output Events

Name	Description
OnFailConnection	Could not connect to the external system.

Description - Emits input document to Microsoft Message Queuing queue; returns a status document or the original input document as the output document

Runtime Class - com.ibi.agents.XDMSMQEmitAgent

Configuration

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

Parameter Groups

• Message
• Post Action

	Parameter	Type	Description
	Correlation ID:	string	If set to a value, this is used as the correlation id of the outgoing message
	Delivery Method:	string	Express does not guarantee arrival, but processes in a faster fashion Select from one of the following options: Express Delivery {Express} Recoverable Delivery {Recoverable}
	Priority:	integer	Outgoing message priority. Value must be between 0 and 7, with 7 most expedited. If omitted uses incoming priority.
	Label:	string	Label is roughly equivalent to email subject or JMS Topic

* - denotes required

	Parameter	Type	Description
	Return:	string	Document to return from the object. Select from one of the following options: Status Document {status} - Status document will be the out document. Input Document {input} - Input document will be the out document.

* - 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.

Description - Emits via Oracle AQ

Runtime Class - com.ibi.agents.XDAQEmitAgent

Configuration

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

Parameter Groups

• Message
• JMS Settings
• JMS Headers
• Post Action

	Parameter	Type	Description
	Correlation ID:	string	Value of the JMSCorrelationID header field
	Priority:	integer	Outgoing message priority. Value must be between 0 and 9, with 9 most expedited. If omitted uses incoming priority.
	JMS Type:	string	Select from one of the following options: BytesMessage {bytes} Dynamic {dynamic} MapMessage {map} TextMessage {text}
	AQ Type:	string	Selecting CLOB requires special configuration on server Select from one of the following options: CLOB {clob} RAW {raw}

* - denotes required

	Parameter	Type	Description
	Delivery Mode:	string	Non-Persistent mode has low overhead but may lose messages. Persistent mode takes extra care to ensure the message is not lost in transit but makes no absolute guarantee. Select from one of the following options: Non-Persistent {1} Persistent {2}
	Time to Live:	integer	The message's lifetime (in milliseconds), default will live forever
	Delivery Delay:	integer	Minimum length of time in milliseconds that must elapse after a message is sent before the JMS provider may deliver the message to a consumer. JMS 2 only.

* - denotes required

	Parameter	Type	Description
	ReplyTo:	string	Value of the JMSReplyTo header field
	Type:	string	Value of the JMSType header field
	Protocol:	string	Special register namespace from which protocol headers for the outbound request will be taken. Select from one of the following options: Default Namespace {default} None {none}

* - denotes required

	Parameter	Type	Description
*	Output Document:	string	Document returned by object Select from one of the following options: Status Document {status} - Returns a status document Response Document {response} - Returns the response of execution.

* - denotes required

Output Events

Name	Description
OnParseError	Could not parse a document.
OnFailConnection	Could not connect to the external system.

Description - Emit to RabbitMQ using AMQP

Runtime Class - com.ibi.agents.XDRabbitMQEmitAgent

Configuration

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

Parameter Groups

• Message Attributes
• Message Processing
• Policies
• Registers
• Post Action

	Parameter	Type	Description
	Application ID:	string	The ID of the publisher.Creating application ID
	Content Encoding:	string	MIME Content Encoding of the payload
	Content Type:	string	MIME Content Type of the payload Select from one of the following options: application/csv application/json application/pdf application/x-compressed application/xml application/zip binary/octet-stream image/gif image/jpg image/png multipart/x-zip text/css text/csv text/html text/javascript text/json text/plain text/xhtml text/xml
	Correlation ID:	string	Application correlation identifier
	Message ID:	string	Application message identifier
	Priority:	string	Message priority, 0 to 255
	Timestamp:	string	The value of the timestamp property in the outgoing message, in milliseconds since the epoch.
	Type:	string	Message type name
	User ID:	string	Creating user ID

* - denotes required

	Parameter	Type	Description
	Outgoing Exchange Name:	string	The exchange where the outgoing message will be published.
	Routing Key:	string	The routing key of the outgoing message

* - denotes required

	Parameter	Type	Description
	Mandatory:	boolean	Determines what happens when a message is routed to zero queues. When set, an error is returned. When unset, the message is discarded.
	Delivery Mode:	string	Whether the message is persistent or not Select from one of the following options: Non-Persistent {1} Persistent {2}
	Expiration:	string	The message time to live in the queue, non-negative integral number of milliseconds
	Response Reply To:	string	Destination to reply to this response

* - denotes required

	Parameter	Type	Description
	Headers:	string	A register whose value will contain additional protocol headers to be added to the outbound document.

* - denotes required

	Parameter	Type	Description
	Output Document:	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} - Return a status document. Input document {input} - Return the input document.

* - denotes required

Output Events

Name	Description
OnParseError	Could not parse a document.
OnFailConnection	Could not connect to the external system.
OnFailedOperation	Could not perform the operation requested.

Description - Emits data using the Sonic version of JMS to a queue or topic

Runtime Class - com.ibi.agents.XDSonicEmitAgent

Configuration

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

Parameter Groups

• Message
• JMS Headers
• Post Action

	Parameter	Type	Description
	Type:	string	Class of message sent. Dynamic will select BytesMessage, TextMessage or MapMessage depending on the document contents. Select from one of the following options: BytesMessage {bytes} Dynamic {dynamic} MapMessage {map} TextMessage {text}
	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} - 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} - the client acknowledges a message by calling a message's acknowledge method. Dups OK Acknowledge {dupsok} - Instructs the session to lazily acknowledge the delivery of messages. Session Transacted {trans} - Specifies that the session should use a local transaction
	Priority:	integer	Outgoing message priority. Value must be between 0 and 9, with 9 most expedited. If omitted uses incoming priority.

* - denotes required

	Parameter	Type	Description
	CorrelationID:	string	Value of the JMSCorrelationID header field
	ReplyTo:	string	Value of the JMSReplyTo header field
	Type:	string	Value of the JMSType header field
	Protocol:	string	Special register namespace from which protocol headers for the outbound request will be taken. Select from one of the following options: Default Namespace {default} None {none}

* - denotes required

	Parameter	Type	Description
	Output Document:	string	Select from one of the following options: Status Document {status} - Document that reflects the agent status Input Document {input} - Original document that was supplied to the object

* - denotes required

Output Events

Name	Description
OnFailConnection	Could not connect to the external system.

Description - Emits to the ordered transfer queue

Runtime Class - com.ibi.agents.XDOrderedEmitAgent

Configuration

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

Parameter Groups

• Message
• Queue Settings
• Post Action

	Parameter	Type	Description
	Type:	string	Determines the content of the message. Select from one of the following options: Delete {del} - Sends a message to delete the message group Document {doc} - Sends a document payload Last Document {docend} - Sends a document payload with the end of group signal End Signal {end} - Sends just the end of group signal Keep Alive {keepalive} - Sends a signal to reset the timer for the unended group timeout
*	Group Key:	string	Identifies the group for this message. Messages belonging to a group will execute strictly in order one after the other but concurrently with messages belonging to other groups.
	Sort Key:	string	Determines the sort key of this message when the ordered queue sorting mode is not chronological.

* - denotes required

	Parameter	Type	Description
	Respect Transactionality:	boolean	If set, the emit respects the transactionality of the channel. If not set, the emit is always done.

* - denotes required

	Parameter	Type	Description
*	Return:	string	Return from this object. Select from one of the following options: Response Document {response} - Returns the results of the operation. Status Document {status} - Returns a status document Input Document {input} - Return the document passed in

* - denotes required

Output Events

Name	Description
OnParseError	Could not parse a document.
OnNotFound	The resource was not found. This may or may not be a failure.
OnTimeOut	The operation timed out.
OnCancelled	The service has responded to a cancellation request.
OnNotFound	The resource was not found and this is considered an error.
OnFailedOperation	Could not perform the operation requested.

Description - Sends a message on iSM ESB.

Runtime Class - com.ibi.agents.XDInternalEmitAgent

Configuration

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

Parameter Groups

• Queue Settings
• Post Action

	Parameter	Type	Description
	Respect Transactionality	boolean	If set, the emit respects the transactionality of the channel. If not set, the emit is always done.
	Timeout	integer	How many seconds to wait for synchronous response. Set to 0 or leave blank to wait indefinitely.

* - denotes required

	Parameter	Type	Description
*	Return:	string	Return from this object. Select from one of the following options: Response Document {response} - Returns the results of the operation. Status Document {status} - Returns a status document Input Document {input} - Return the document passed in

* - denotes required

Output Events

Name	Description
OnParseError	Could not parse a document.
OnNotFound	The resource was not found. This may or may not be a failure.
OnTimeOut	The operation timed out.
OnCancelled	The service has responded to a cancellation request.
OnNotFound	The resource was not found and this is considered an error.
OnFailedOperation	Could not perform the operation requested.

Subscribe to queue out connector