Configure the FTP XML Input adapter by specifying values for the ESP connector, formatter, and transporter modules in the adapter configuration file.
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 |
---|---|
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. |
Next |
Type: string (Required) Specify the instance name of the module that follows this one. |
Parameters |
(Required) Section containing the FTPInputTransporterParameters element. |
FTPInputTransporterParameters |
(Required) Section containing parameters 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. 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 filename of the data files in the FTP server. |
MaxBlockSize |
Type: int (Required) Specify the max data block size to transfer from the FTP server. The default value is 2048. |
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, to try and reconnect to the FTP server if you disconnect unexpectedly. The default value is 30. |
RetryCount |
Type: integer (Required) Specify the retry counts to try to reconnect to the FTP server if you disconnect unexpectedly. The default value is 0. |
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. |
Parameters |
(Required) Section containing the StreamToStringFormatterParameters parameter. |
StreamToStringFormatterParameters |
(Required) Section containing the Stream to String formatter parameters. |
Delimiter |
Type: string (Required) Specify the symbol used to separate 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 parameter takes effect. There are two 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. |
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 XmlStringToEspFormatterParameters parameter. |
XmlStringToEspFormatterParameters |
(Required) Section containing the XML String to ESP formatter parameters. |
DateFormat |
Type: string (Optional) The format string for parsing date values. For example, yyyy-MM-dd'T'HH:mm:ss. |
TimestampFormat |
Type: string (Optional) Format string for parsing timestamp values. For example, yyyy-MM-dd'T'HH:mm:ss.SSS. |
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. |
Parameters |
(Required) Section containing the EspPublisherParameters parameter. |
EspPublisherParameters |
(Required) Section containing parameters for the ESP publisher. |
ProjectName |
Type: string (Required if running adapter in standalone mode; optional if running in managed mode) Name 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 to which the adapter publishes 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. |
MaxPubPoolSize |
Type: positive integer (Optional) Specifies the 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. Block publishing (record pooling or batch publishing) is disabled if this value is set to 1. The default value is 256. |
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. 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. |
Event Stream Processor parameters configure communication between Event Stream Processor and the FTP XML Input 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:
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. |