File XML Record Output Adapter Configuration

Logging

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

Parameter

Description

Log4jProperty

Type: string

(Optional) Specify the 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

Parameter	Description
Module	(Required) Section containing all information for this module. It contains a type attribute for specifying the module type. For example, espconnector.
InstanceName	Type: `string` (Required) Specify the instance name of the specific module you wish to use. For example, MyInputTransporter.
Name	Type: `string` (Required) The name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter.
Next	Type: `string` (Required) Specify the instance name of the module that follows this one.
Parameters	Section containing the EspSubscriberParameters parameter.
EspSubscriberParameters	(Required) Section containing parameters 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 parameter of the Event Stream Processor (EspProjects) parameters section. 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 property 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 property as the adapter automatically detects the stream name.

Formatter Module: ESP to XML String Formatter

Parameter	Description
Module	(Required) Section containing all information for this module. It contains a type attribute for specifying the module type. For example, formatter.
InstanceName	Type: `string` (Required) Specify the instance name of the specific module you wish to use. For example, MyInputTransporter.
Name	Type: `string` (Required) The name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter.
Next	Type: `string` (Required) Specify the instance name of the module that follows this one.
Parallel	Type: `boolean` (Optional) If set to true, the module runs as a separated thread. The default value is true.
Parameters	(Required) Section containing the EspToXmlStringFormatterParameters parameter.
EspToXmlStringFormatterParameters	(Required) Section containing the ESP to XML String formatter parameters.
DateFormat	Type: `string` (Optional) The 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: File Output Transporter

Parameter	Description
Module	(Required) Section containing all information for this module. It contains a type attribute for specifying the module type. For example, transporter.
InstanceName	Type: `string` (Required) Specify the instance name of the specific module you wish to use. For example, MyInputTransporter.
Name	Type: `string` (Required) The name of the module as defined in the modulesdefine.xml file. For example, <TransporterType>InputTransporter.
Parameters	(Required) Section containing the FileOutputTransporterParameters parameter.
FileOutputTransporterParameters	(Required) Section containing the File Output transporter parameters.
Dir	Type: `string` (Required) Specify the absolute path to the data files that you want the adapter to write to. For example, <username>/<foldername>. The default value is ".", meaning the current directory in which the adapter is running. Use a forward slash for both UNIX and Windows paths.
File	Type: `string` (Required) Specify the file to which you want the adapter to write.
AccessMode	Type: `string` (Required) Specify an access mode. The adapter supports two modes: rowBased – the adapter writes one text line at a time into the file Streaming – the adapter writes the raw data in ByteBuffer into the file No default value.
AppendMode	Type: `boolean` (Optional) If set to true, the adapter appends the data into the existing file. If set to false, the adapter overwrites existing content in the file. Default value is false.

Event Stream Processor Parameters

Event Stream Processor parameters configure communication between Event Stream Processor and the File XML Record Output adapter.

Parameter	Description
EspProjects	Section containing parameters for connecting to Event Stream Processor.
EspProject	Section containing the Name and Uri parameters. 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 Event Stream Processor cluster. For example, esp://localhost:19011/ws1/p1.
Security	Section containing all the authentication parameters 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. Default value is false. If set to true, the password value is decrypted using RSAKeyStore and RSAKeyStorePassword.
AuthType	Type: `string` (Required) Specifies 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.