JMS Read Agent (com.ibi.agents.XDJMSReadAgent)

Syntax:

com.ibi.agents.XDJMSReadAgent

Description:

This service reads a message from a JMS (Java Messaging Server) queue or topic. For more information on JMS, see the Queuing Adapters chapter in the iWay Service Manager Protocol Guide.

Parameters:

Parameter

Description

Name

The name of the queue or topic to be read.

JMS Message Model

Type of JMS Message Model to use. Select one of the following values from the drop-down list:

  • queue
  • topic

Durable Subscriber

A durable subscriber is a virtual message consumer for the specified topic, identified by the unique combination of a client identifier and subscriber name. When a message arrives for the topic and no message consumer is currently active for it, the message will be retained for later delivery.

Message Type

The type of JMS Message the system is to expect. Select one of the following values from the dropdown list:

  • text
  • bytes
  • map
  • dynamic

Timeout

The timeout period in seconds.

Tag

Name of the XML tag to wrap the data read in. Required if data is flat.

Embed

Whether to embed the data from the read operation into the input document. Select one of the following values from the dropdown list:

  • true
  • false

Parent Tag

Where in the input document should the input data be embedded,

Base64 Encode

Base64 encode the read in document when embedding. Select one of the following values from the drop-down list:

  • true
  • false

Parse to XML

Should the agent attempt to parse the input into XML:

  • true
  • false

Out Document

Select one of the following values from the drop-down list:

  • status. A status document will become the output document.
  • input. Input document will become the output document.
  • result. Message read will become the out document.

Action on Failure

Whether input document or status document returned on failure. Select one of the following values from the drop-down list:

  • input
  • status

Connection Factory

The object store name.

Local Context

True if connecting to an internal jndi store. Select one of the following values from the drop-down list:

  • true
  • false

JNDI Factory

Factory class name.

JNDI URL

The JNDI URL.

User ID

User ID for challenges.

Password

Password for challenges.

Acknowledgement

Acknowledgement or transactional. Select one of the following values from the drop-down list:

  • Auto Acknowledge
  • Client Acknowledge
  • Dups OK Acknowledge

Edges:

The following table lists the available line edges for the JMS Read Agent (com.ibi.agents.XDJMSReadAgent).

Line Edge

Description

OnError

Error

OnSuccess

Success

OnFailure

Failure

OnCustom

  • OnError
  • OnSuccess
  • OnFailure
  • fail_connect
  • fail_partner
  • fail_parse
  • fail_operation
  • noMessage
  • unknownMessageType