JMS XML Output Adapter

Adapter type: jms_xml_out. The JMS XML Output adapter publishes stream data as XML-formatted text messages to a JMS queue or topic.

Ensure that each message consists of an XML element with the same name as the stream name.

The first attribute is the Event Stream Processor opcode. The rest of the attributes have the same names as the corresponding stream columns. Ensure that any columns with null values are omitted.

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

Property Label Property ID Type Description
Connection Factory connectionFactory string (Required) Connection factory class name. No default value.
JNDI Context Factory jndiContextFactory string (Required) Context factory for JNDI context initialization. No default value.
JNDI URL jndiURL string (Required) JNDI URL. No default value.
Destination Type destinationType choice (Required) Destination type.
Valid values are:
  • QUEUE
  • TOPIC
Default value is QUEUE.
Destination Name destinationName string (Required) Destination name. No default value.
Delivery Mode deliveryMode choice (Optional) Type of delivery mode.
Valid values are:
  • PERSISTENT
  • NON_PERSISTENT
Default value is PERSISTENT.

PropertySet

propertyset string

(Advanced) Specifies the name of the property set from the project configuration 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.

Column To Message Property Map columnPropertyMap string (Advanced) A comma-delimited list of ColumnName=PropertyName mappings that enables message filtering on the message broker side using the JMS selector mechanism.

Ensure that there are no spaces present in the value of this property. For each mapped column name, the outbound message is paired with a corresponding JMS property that has a value equal to the column value. ColumnName1=PropertyName1,ColumnName2=PropertyName2...

No default value.
Date Format dateFormat string (Advanced) Date format. Default value is YYYY-MM-DDTHH:MM:SS.SSS.
Timestamp Format timestampFormat string (Advanced) Timestamp format. Default value is YYYY-MM-DDTHH:MM:SS.SSS.

Runs Adapter in GD Mode

enableGDMode boolean

(Advanced) If set to true, the adapter runs in guaranteed delivery (GD) mode and all GD-related parameters become required. Default value is false.

Name of Column Holding GD Key

gdKeyColumn string

(Advanced) Specifies column name in the Flex operator holding the GD key. The GD key is a constantly increasing value that uniquely identifies every event regardless of the opcode in the stream of interest. No default value.

Name of Column Holding opcode

gdOpcodeColumn string

(Advanced) Specifies name of column in Flex operator holding opcode. The opcode is the operation code (for example, inserts, update, or delete) of the event occurring in the stream of interest. No default value.

Name of Truncate Stream

gdControlStream string

(Advanced) Specifies name of the control window in the GD setup. The control window is a source stream that informs the Flex operator of which data has been processed by the adapter and can be safely deleted. No default value.

Purge After Number of Records

gdPurgeInternal int

(Advanced) Specifies number of records after which to purge the Flex operator. Default value is 1000.

Batch Size to Update Truncate Stream

gdBatchSize int

(Advanced) Specifies number of records after which the control window must be updated with the latest GD key. Default value is 1000.

Known limitations:

Related concepts
Guaranteed Delivery