Show TOC

JMS XML Input AdapterLocate this document in the navigation structure

Adapter type: jms_xml_in. The JMS XML Input adapter subscribes to XML-formatted text messages from a JMS queue or topic, and writes the messages as stream records.

Ensure that each message consists of an XML element. If opted, the element name corresponds to the stream name.

If you use the CCL ATTACH ADAPTER statement to attach an adapter, you must supply the adapter type.

The ESP-OPS attribute is optional. If omitted, the message is interpreted as an upsert. Ensure that the rest of the attributes have the same names as the corresponding stream columns, and that the columns with null values are omitted. This adapter supports schema discovery.

Property Label Description
Connection Factory

Property ID: connectionFactory

Type: string

(Required for adapter operation and schema discovery) Specifies the JNDI name for the JMS server connection factory. Consult your third-party vendor documentation for specific formats. Here are some examples:
  • ActiveMQ™ ConnectionFactory
  • TIBCO QueueConnectionFactory
  • WebSphere MQ MyMQConnFactory
The default value is ConnectionFactory.
JNDI Context Factory

Property ID: jndiContextFactory

Type: string

(Required for adapter operation and schema discovery) Context factory for JNDI context initialization. Consult your third-party vendor documentation for specific formats. Here are some examples:
  • ActiveMQ org.apache.activemq.jndi.ActiveMQInitialContextFactory
  • TIBCO com.tibco.tibjms.naming.TibjmsInitialContextFactory
  • WebSphere MQ com.sun.jndi.fscontext.RefFSContextFactory
The default value is org.apache.activemq.jndi.ActiveMQInitialContextFactory.
JNDI URL

Property ID: jndiURL

Type: string

(Required for adapter operation and schema discovery) JNDI URL. Consult your third-party vendor documentation for specific formats. Here are some examples:
  • ActiveMQ tcp://server:61616
  • TIBCO tibjmsnaming://server:7222
  • WebSphere MQ file:/var/mqm/jndi/
WebSphere MQ is different as it requires a separate naming server to be configured with it. By default, WebSphere MQ only provides a file-based naming server. The default value is tcp://localhost:61616.
Destination Type

Property ID: destinationType

Type: choice

(Required for adapter operation and schema discovery) Destination type.

Valid values are:
  • QUEUE
  • TOPIC
Default value is QUEUE.
Destination Name

Property ID: destinationName

Type: string

(Required for adapter operation and schema discovery) Destination name. The default value is xmlout.queue.

Subscription Mode

Property ID: subscriptionMode

Type: choice

(Optional) Specifies the subscription mode for TOPIC. Default value is NONDURABLE. Valid values are DURABLE and NONDURABLE.

Client ID

Property ID: clientID

Type: string

(Required if subscription mode is set to DURABLE) Specifies the client identifier for a JMS client. Required for creating a durable subscription in JMS. Can be any string, but must be unique for each topic. No default value.

Subscription Name

Property ID: subscriptionName

Type: string

(Required if subscription mode is set to DURABLE) Specifies a unique name identifying a durable subscription. Required for creating a durable subscription in JMS. Can be any string, but must be unique within a given client ID. No default value.

Batch Size

Property ID: batchsize

Type: uint

(Optional) Specifies number of records in a batch to commit in durable subscription mode. Default value is 1.

PropertySet

Property ID: propertyset

Type: string

(Advanced) Specifies the name of the property set. Property sets are reusable sets of properties that are stored in the project configuration file. Using these sets allows you to move adapter configuration properties out of the CCL file and into the CCR file. If you specify the same properties in the project configuration file and the ATTACH ADAPTER statement, the values in the property set override the values defined in the ATTACH ADAPTER statement. No default value.

Match Stream Name

Property ID: matchStreamName

Type: boolean

(Advanced) Ignore message if the XML element name does not match the source stream name. Default value is false.

SecondDate Format

Property ID: seconddateFormat

Type: string

(Advanced) SecondDate format. Default value is YYYY-MM-DDTHH:MM:SS.SSS.

MsDate Formsat

Property ID: msdateFormat

Type: string

(Advanced) MsDate format. Default value is YYYY-MM-DDTHH:MM:SS.SSS.

Known limitations:

  • If the connection to the message broker is lost, the adapter does not attempt to reconnect.