To configure an FTP/SFTP Listener, choose this option from the Listener Type drop-down.
1. Basic tab – Here you can set the FTP Type: Regular FTP, FTP over SSL (Explicit and Implicit), Encrypted FTP (SSH/SFTP) or Encrypted FTP (JSCH SSH/SFTP).
Also this tab lets you configure how often to poll the FTP Server, File name restrictions, File extension restrictions, Tokenizers (split an inbound file into pieces based on a delimiter, when left blank the entire file is treated as a message), Polling directory and Host (FTP server).
2. Advanced – Choose to initialize this Listener when triggered externally, maximum number of transactions to process at a given time, determine whether to traverse sub-folders when scanning for files, change the default FTP port and determine whether to maintain the connection when not actively querying the server. Also you can set Allow command-line invocation: If enabled, the listener can be invoked using the CLI client application.
Restart on listening error: If enabled, the listener will be restarted after an error occurs.
FIFO Queue Name: The FIFO stuff enables a “First In, First Out” queuing mechanism between Listeners and Transports. If a “FIFO Queue Name” is provided, that name will be used as a key for a queue Transactions & will be pushed into before reaching a transport. They’ll be ordered in this queue according to when the Listener created them.
FIFO Queue Delay: It is the interval between updates/checks against that queue. Providing a queue name guarantees that a given Transport sends transactions in the same order the Listener created them in.
Max Transactions per Run: Specifies the maximum number of transactions to process at a time.
Include sub-folders: This specifies whether or not sub-folders should be searched for files as well.
Include hidden files: Specifies whether or not hidden files should retrieved by the listener.
Combine files into one stream: This reads in all matching files as a single stream.
Number of header lines: This is the number of lines to treat as header lines. The header of the first file is included and skipped in all other files.
Port: The FTP port; 21 by default.
Keep connection: This specifies whether connections are to be dropped once operations are completed, or maintained – creating connections is extremely expensive, so this can be utilized on a heavy server to reduce resource consumption.
Use ChangeDirectory Command: If enabled, ChangedDirectory is explicitly called.
Connection timeout: Specifies how long the Listener should wait for messages which are interrupted before timing out the connection.
Passive Mode: Specifies if local passive (or active) mode should be used.
Reconnect After Bytes: Reconnect SFTP connection after this number of bytes have been received.
File Type: Type of transfer to use (ASCII Text vs Binary).
3. Transaction Logging – This tab allows us to enable transaction events logging. That data can be logged by a TransactionEventListener.
The Transaction Logging Enable checkbox allows transaction events originating from this listener to be logged by a TransactionEventListener.
Log Transaction Attribute – if enabled, logs transaction attributes.
Log Transaction Data – if enabled, logs transaction data body.
Log Transaction Data Base64 – if enabled, logs transaction data body as Base64.
4. Postprocess – This tab lets you determine what to do with the file after it has been processed. You can choose to Keep, Delete or Move the file. If you choose Move, the target directory configuration item becomes required. Choose the directory for where you would like to move the file. You can also enter this information as text. Note that network paths are not evaluated in the eiConsole.
5. Credentials – This tab allows you to enter in the User name and Password for the server. Also you can set Key file to authenticate with.
6. The Certificate tab allows the user to configure the:
Key File – the file path for the certificate file
Key Type – the Format of the certificate file
Key Password – the certificate password
TrustStore – the file path for a certificate store
TrueStore Password – the password for the certificate store
7. Accept Tests – This tab allows you to specify the following settings:
Check FTP permission: If enabled, only accept files with explicit WRITE permissions (DISABLE for Windows FTP).
Check Previously Processed: If enabled, ignore files already processed by this listener since startup.
Check Write in Process: If enabled, ignore files with very recent modification dates.
8. Scheduling – This tab allows you to specify a start time and end time for polling the FTP server (to see the window below click on the three buttons to the right of the line). Also you can specify days of the week or particular dates to exclude from scheduling. The Time Zone drop-down menu allows to specify the Time Zone that should be used for scheduling; by default, it is set to the Time Zone of the console during initial configuration.