FTP Event XML Input Adapter Configuration
Configure the FTP Event XML Input adapter by specifying values for the ESP connector, formatter, and transporter modules in the adapter configuration file. The FTP Event XML Input adapter uses SimpleDateFormat formatter 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 FTP Input transporter reads binary data from files on an FTP server, wraps it up with ByteBuffer, and sends it to the next module that is configured in the adapter configuration file.
| 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. |
| 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 FTPInputTransporterParameters element. |
| FTPInputTransporterParameters |
(Required) Element containing elements for the FTP Input 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: normal or 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 maximum size of any data blocks transferred from the FTP server. The default value is 2048. |
| TransferMode |
Type: string (Required) Specify the transfer mode for the FTP connection: 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. |
The Stream to String formatter reads streaming data from an input stream, and splits it into Java strings.
| 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 StreamToStringFormatterParameters element. |
| StreamToStringFormatterParameters |
(Required) Element containing the Stream to String 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 at which the AppendString element takes effect. Valid values: front and end. The default value is front. |
| IgnoreSpace |
Type: boolean (Required) Specify whether to trim the space char. The default value is true. |
The XML String to ESP formatter translates SAP Event Stream Processor XML strings to AepRecord objects.
| 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 XmlStringToEspFormatterParameters element. |
| XmlStringToEspFormatterParameters |
(Required) Element containing the XML String to ESP 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 ESP Publisher module obtains data from a transporter or formatter module and publishes it to the SAP Event Stream Processor project.
| 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. |
| 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 EspPublisherParameters element. |
| EspPublisherParameters |
(Required) Element containing elements for the ESP publisher. |
| ProjectName |
Type: string (Required if adapter is running in standalone mode; optional if it is running in managed mode) Name 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 (that is, running the adapter in managed mode), you need not set this element as the adapter automatically detects the project name. |
| StreamName |
Type: string (Required if adapter is running in standalone mode; optional if it is running in managed mode) Name of the stream to which the adapter publishes data. If you are starting the adapter with the ESP project to which it is attached (that is, running the adapter in managed mode), you need not set this element as the adapter automatically detects the stream name. |
| MaxPubPoolSize |
Type: positive integer (Optional) Maximum size of the record pool. Record pooling, also referred to as block or batch publishing, allows for faster publication since there is less overall resource cost in publishing multiple records together, compared to publishing records individually. Record pooling is disabled if this value is 1. The default value is 256. |
| MaxPubPoolTime |
Type: positive integer (Optional) Maximum period of time, in milliseconds, for which records are pooled before being published. If not set, pooling time is unlimited and the pooling strategy is governed by maxPubPoolSize. No default value. |
| UseTransactions |
Type: boolean (Optional) If set to true, pooled messages are published to Event Stream Processor in transactions. If set to false, they are published in envelopes. The default value is false. |
| SafeOps |
Type: boolean (Advanced) Converts the opcodes INSERT and UPDATE to UPSERT, and converts DELETE to SAFEDELETE. The default value is false. |
| SkipDels |
Type: boolean (Advanced) Skips the rows with opcodes DELETE or SAFEDELETE. The default value is false. |
SAP Event Stream Processor elements configure communication between Event Stream Processor and the FTP Event XML Input 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. |