FTP Event XML Output Adapter Configuration
Configure the FTP Event XML Output adapter by specifying values for the ESP connector, formatter, and transporter modules in the adapter configuration file. The FTP Event XML Output adapter uses SimpleDateFormat formatting codes.
| 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 STREAMING_HOME/adapters/framework/config/log4j.properties. |
| XML Element | Description |
|---|---|
| Cipher |
Type: string (Optional) Specify a full path to the adapter.key encryption file you wish to use. The default value is $STREAMING_HOME/adapters/framework/adapter.key. |
The ESP Subscriber module obtains data from the SAP Event Stream Processor project and passes it along to a transporter or formatter module.
| Parameter | 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 | (Required) 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, StreamingProject2. 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 te 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. |
| 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. |
| 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. |
The ESP to XML String formatter translates AepRecord objects to SAP Event Stream Processor 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 elements for the ESP to XML String formatter elements. |
| SecondDateFormat |
Type: string (Optional) Format string for parsing SecondDate values. For example, yyyy-MM-dd'T'HH:mm:ss is the default value. |
| MsDateFormat |
Type: string (Optional) Format string for parsing MsDate values. For example, yyyy-MM-dd'T'HH:mm:ss.SSS is the default value. |
The String to Stream formatter writes Java strings to output streams.
| 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. |
| Parameters |
(Required) Element containing the StringToStreamFormatterParameters element. |
| StringToStreamFormatterParameters |
(Required) Element containing elements for the String to Stream formatter elements. |
| Delimiter |
Type: string (Required) Specify the symbol that separates columns. The default value is "\n". |
| IncludeDelimiter |
Type: boolean (Required) If set to true, the delimiter is part of current row. If set to false, the delimiter is not part of the current row. The default value is false. |
| AppendString |
Type: string (Required if IncludeDelimiter is set to true) If set to true, specify the string to append to the end of each result row. No default value. |
| AppendPosition |
Type: string (Required if IncludeDelimiter is set to true) Specify the position to which the AppendString element takes effect. There are two valid values: front and end. The default value is front. |
| IgnoreSpace |
Type: boolean (Required) Specify whether to ignore the space char. The default value is false. |
| CharsetName |
Type: string (Advanced) Specify the name of a supported charset. The default value is US-ASCII. |
The FTP Output transporter obtains data from the previous module configured in the adapter configuration file, and saves it to files on the FTP 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 FTPOutputTraansporterParameters element. |
| FTPOutputTraansporterParameters |
(Required) Element containing the elements for the FTP Output transporter. |
| Host |
Type: string (Required) Specify the server name or IP address of the FTP server to which you are connecting. |
| Port |
Type: integer (Required) Specify the port address for the FTP server to which you are connecting. The default value is 21. |
| LoginType |
Type: enum (Required) Specify the login type for the FTP server. There are two valid types: normal and anonymous. |
| User |
Type: string (Required if LoginType is set to normal) Specify the login account for the FTP server. |
| Password |
Type: string (Required if LoginType is set to normal) Specify the login password for the FTP server. |
| FtpFilePath |
Type: string (Required) Specify the absolute path to the data files in the FTP server. |
| FtpFileName |
Type: string (Required) Specify the data files in the FTP server. |
| MaxBlockSize |
Type: int (Required) Specify the max data block size to transfer to the FTP server. The default value is 2048. |
| Overwrite |
Type: boolean (Required) If set to true, the transporter overwrites the file on the FTP server, if it exists. If this element is set to false, the transporter appends the output to the end of the existing file. The default value is false. |
| TransferMode |
Type: string (Required) Specify the transfer mode for the FTP connection. There are two valid values: active or passive. The default value is active. |
| RetryPeriod |
Type: second (Required) Specify the period of time, in seconds, during which to try and reconnect to the FTP server if you disconnect unexpectedly. The default value is 30. |
| RetryCount |
Type: integer (Required) Specify the number of times to attempt to reconnect to the FTP server if you disconnect unexpectedly. The default value is 0. |
SAP Event Stream Processor elements configure communication between Event Stream Processor and the FTP Event 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, if you have SSL enabled, use esps://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 AuthType). 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 Event Stream Processor. Valid
values are:
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 the 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. |