JMS XML Output Adapter Configuration

Logging

XML Element	Description
Log4jProperty	Type: `string` (Optional) Specify a full path to the log4j.properties logging file you wish to use. The default value is $ESP_HOME/adapters/framework/config/log4j.properties.

XML Element

Description

Log4jProperty

Type: string

(Optional) Specify a full path to the log4j.properties logging file you wish to use. The default value is $ESP_HOME/adapters/framework/config/log4j.properties.

ESPConnector Module: ESP Subscriber

The ESP Subscriber module obtains data from an ESP project and passes it along to a transporter or formatter module.

XML Element	Description
Module	(Required) Element containing all information for this module. It contains a type attribute for specifying the module type. For example, espconnector.
InstanceName	Type: `string` (Required) Instance name of the specific module you want to use. For example, MyInputTransporter.
Name	Type: `string` (Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter.
Next	Type: `string` (Required) Instance name of the module that follows this one.
BufferMaxSize	Type: `integer` (Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240.
Parameters	Element containing the EspSubscriberParameters element.
EspSubscriberParameters	(Required) Element containing elements for the ESP subscriber.
ProjectName	Type: `string` (Required if running adapter in standalone mode; optional if running in managed mode) Specifies the unique project tag of the ESP project to which the adapter is connected. For example, EspProject2. This is the same project tag that you specify later in the adapter configuration file in the Name element within the Event Stream Processor (EspProjects) element. If you are starting the adapter with the ESP project to which it is attached (running the adapter in managed mode), you do not need to set this element as the adapter automatically detects the project name.
StreamName	Type: `string` (Required if running adapter in standalone mode; optional if running in managed mode) Name of the ESP stream from which the adapter subscribes to data. If you are starting the adapter with the ESP project to which it is attached (running the adapter in managed mode), you do not need to set this element as the adapter automatically detects the stream name.

Formatter Module: ESP to XML String Formatter

The ESP to XML String formatter translates AepRecord objects to ESP XML string.

XML Element	Description
Module	(Required) Element containing all information for this module. It contains a type attribute for specifying the module type. For example, formatter.
InstanceName	Type: `string` (Required) Instance name of the specific module you want to use. For example, MyInputTransporter.
Name	Type: `string` (Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter.
Next	Type: `string` (Required) Instance name of the module that follows this one.
BufferMaxSize	Type: `integer` (Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240.
Parallel	Type: `boolean` (Optional) If set to true, the module runs as a separated thread. The default value is true.
Parameters	(Required) Element containing the EspToXmlStringFormatterParameters element.
EspToXmlStringFormatterParameters	(Required) Element containing the ESP to XML String formatter elements.
DateFormat	Type: `string` (Optional) Format string for date values from an ESP project. For example, `yyyy-MM-dd'T'HH:mm:ss.`
TimestampFormat	Type: `string` (Optional) Format string for timestamp values from an ESP project. For example, `yyyy-MM-dd'T'HH:mm:ss.SSS`.

Transporter Module: JMS Output Transporter

The JMS Output transport obtains data from the previous module that is configured in the adapter configuration file, wraps it up, and sends it to a JMS server.

XML Element	Description
Module	(Required) Element containing all information for this module. It contains a type attribute for specifying the module type. For example, transporter.
InstanceName	Type: `string` (Required) Instance name of the specific module you want to use. For example, MyInputTransporter.
Name	Type: `string` (Required) Name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter.
BufferMaxSize	Type: `integer` (Advanced) Capacity of the buffer queue between this module and the next. The default value is 10240.
Parameters	(Required) Element containing the JMSOutputTransporterParameters element.
JMSOutputTransporterParameters	(Required) Element containing the JMS Output transporter elements.
ConnectionFactory	Type: `string` (Required) Specify the connection factory class name. No default value.
JndiContextFactory	Type: `string` (Required) Specify the context factory for JNDI context initialization. No default value.
JndiUrl	Type: `string` (Required) Specify the JNDI URL. No default value.
Destination Type	Type: `string` (Required) Specify the destination type. Valid values are: QUEUE and TOPIC. The default value is QUEUE.
DestinationName	Type: `string` (Required) Specify the destination name. No default value.
MessageType	Type: `string` (Required) Specify the message type you want the JMS transporter to process: TEXT – for receiving and sending messages in text string. OBJARRAY – for receiving and sending messages in custom format. No default value.
DeliveryMode	Type: `string` (Optional) Specify the delivery mode type. Valid values are: PERSISTENT NON_PERSISTENT Default value is PERSISTENT.

Event Stream Processor Elements

Event Stream Processor elements configure communication between Event Stream Processor and the JMS XML Output adapter.

XML Element	Description
EspProjects	(Required) Element containing elements for connecting to Event Stream Processor.
EspProject	(Required) Element containing the Name and Uri elements. Specifies information for the ESP project to which the adapter is connected.
Name	Type: `string` (Required) Specifies the unique project tag of the ESP project which the EspConnector (publisher/subscriber) module references.
Uri	Type: `string` (Required) Specifies the total project URI to connect to the ESP project. For example, esp://localhost:19011/ws1/p1.
Security	(Required) Element containing all the authentication elements below. Specifies details for the authentication method used for Event Stream Processor.
User	Type: `string` (Required) Specifies the user name required to log in to Event Stream Processor (see AuthType). No default value.
Password	Type: `string` (Required) Specifies the password required to log in to Event Stream Processor (see espAuthType). Includes an "encrypted" attribute indicating whether the Password value is encrypted. The default value is false. If set to true, the password value is decrypted using RSAKeyStore and RSAKeyStorePassword.
AuthType	Type: `string` (Required) Method used to authenticate to the Event Stream Processor. Valid values are: server_rsa – RSA authentication using keystore kerberos – Kerberos authentication using ticket-based authentication user_password – LDAP, SAP BI, and Native OS (user name/password) authentication If the adapter is operated as a Studio plug-in, AuthType is overridden by the Authentication Mode Studio start-up parameter.
RSAKeyStore	Type: `string` (Dependent required) Specifies the location of the RSA keystore, and decrypts the password value. Required if AuthType is set to server_rsa, or the encrypted attribute for Password is set to true, or both.
RSAKeyStorePassword	Type:`string` (Dependent required) Specifies the keystore password, and decrypts the password value. Required if AuthType is set to server_rsa, or the encrypted attribute for Password is set to true, or both.
KerberosKDC	Type: `string` (Dependent required) Specifies host name of Kerberos key distribution center. Required if AuthType is set to kerberos.
KerberosRealm	Type: `string` (Dependent required) Specifies the Kerberos realm setting. Required if AuthType is set to kerberos.
KerberosService	Type: `string` (Dependent required) Specifies the Kerberos principal name that identifies an Event Stream Processor cluster. Required if AuthType is set to kerberos.
KerberosTicketCache	Type: `string` (Dependent required) Specifies the location of the Kerberos ticket cache file. Required if AuthType is set to kerberos.
EncryptionAlgorithm	Type: `string` (Optional) Used when the encrypted attribute for Password is set to true. If left blank, RSA is used as default.