Show TOC

JMS Event XML Output Adapter Studio PropertiesLocate this document in the navigation structure

Adapter type: toolkit_jms_xmllist_output. Configure the adapter properties using the SAP Event Stream Processor Studio. The JMS XML Output adapter uses SimpleDateFormat formatting codes.

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

Property Label Description
SecondDate Format

Property ID: xmllistSecondDateFormat

Type: string

(Advanced) Specify the format for parsing SecondDate values.

For example, yyyy-MM-dd'T'HH:mm:ss is the default value.

MsDate Format

Property ID: xmllistMsDateFormat

Type: string

(Advanced) Specify the format for parsing MsDate values.

For example, yyyy-MM-dd'T'HH:mm:ss.SSS is the default value.

Time Format

Property ID: xmllistTimeFormat

Type: string

(Advanced) Specify the format for parsing time values.

For example, HH:mm:ss is the default value.

Connection Factory

Property ID: connectionFactory

Type: string

(Required) Connection factory name.

JNDI Context Factory

Property ID: jndiContextFactory

Type: string

(Required) Context factory for JDNI context initialization.

JNDI URL

Property ID: jdniURL

Type: string

(Required) JDNI URL.

JMS Destination Type

Property ID: destinationType

Type: string

(Required) Specify the destination type. Valid values: QUEUE, TOPIC.

Destination Name

Property ID: destinationName

Type: string

(Required) Specify the destination name.

Delivery Mode

Property ID: deliveryMode

Type: string

(Optional) Specify the delivery mode. Valid values: PERSISTENT, NON_PERSISTENT.

Batch Size

Property ID: BatchSize

Type: int

(Advanced) If the adapter is running in GD (guaranteed delivery) mode, specify the number of message rows after which the adapter issues a commit command to the external data source and a GD commit to the stream to which the adapter is attached.

If the adapter is runing without GD mode, specify the number of message rows after which the adapter issues a commit command to the external data source to which it is attached. The default value is 1.

Increasing this value improves performance at the expense of latency. It also increases memory consumption in the ESP Server because the uncommitted rows need to be preserved for redelivery in case of failure.

If running this adapter in GD mode, set either this or the BatchPeriod property to greater than 0. If neither property is set to greater than 0, a warning is sent and this property is set to 1.

Batch Period

Property ID: BatchPeriod

Type: int

(Advanced) Specify the number of seconds after which the adapter issues a commit command to the external data source and a GD commit to the stream to which the adapter is attached.

If the adapter is running without GD mode, specify the number of seconds after which the adapter issues a commit command to the external data source. The default value is 0.

JNDI Security Principal

Property ID: jndiSecurityPrincipal

Type: string

(Advanced) Specify the JNDI security principal that you use for the JMS server. This property corresponds to the JNDI property javax.naming.Context.SECURITY_PRINCIPAL. See your JMS server provider documentation for more information.

Specify this property only if your JMS server requires JNDI credentials.

JNDI Security Credentials

Property ID: jndiSecurityCredentials

(Advanced) Specify the JNDI security credentials that you use for the JMS server. This property corresponds to the JNDI property javax.naming.Context.SECURITY_CREDENTIALS. See your JMS server provider documentation for more information.

Specify this property only if your JMS server requires JNDI credentials.

JNDI Security Credentials Encrypted

Property ID: jndiCreEncrypted

Type: boolean

(Advanced) Specify whether the jndiSecurityCredentials value is encrypted. No default value.

Specify this property only if your JMS server requires JNDI credentials.

User Name

Property ID: Username

Type: string

(Advanced) Specify a valid username for connecting to a specific JMS server.

Password

Property ID: Password

Type: string

(Advanced) Specify a valid password for connecting to a specific JMS server.

Password Encrypted

Property ID: encrypted

Type: boolean

(Advanced) Specify whether the Password value is encrypted.

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.

Include Base Content

Property ID:outputBase

Type: boolean

(Optional) If set to true, the adapter outputs the initial stream contents in addition to stream updates.

If this option is enabled and the adapter is running in GD mode, once the adapter has done a GD commit on the entire base data, the ESP Server does not redeliver the base data on adapter restart and only sends deltas that are saved for delivery. The default value is false.

Only Base Content

Property ID: onlyBase

Type: boolean

(Advanced) Sends a one-time snapshot of initial contents in a stream. Default value is false. If set to true, outputBase automatically becomes true.

Enable GD Mode

Property ID: EnableGdMode

Type: boolean

(Advanced) Specifies whether the adapter runs in guaranteed delivery (GD) mode. GD ensures that data continues to be processed in the case that the ESP Server fails, or the destination (third-party server) fails or does not respond for a long time. See Guaranteed Delivery in the SAP Event Stream Processor: Developer Guide for details on enabling GD for your project.

The default value is false.

Enable GD Cache

Property ID: EnableGdCache

Type: boolean

(Advanced)If set to true, only rows that can be recovered (that is, checkpointed) by the ESP Server on restart are sent to the end source. Other rows are cached internally by the adapter.

The default value is false.

GD Subscriber Name

Property ID: GdSubscriberName

Type: string

(Advanced) If the adapter is running in GD mode (the EnableGDMode property is set to true), specify a unique name to identify the GD subscription client. If this value is empty when running in GD mode, the adapter logs an error and shuts down.