The Directory / File Listener allows the eiConsole and eiPlatform to periodically poll a Directory for a file or set of files that will be picked up and used to initiate a transaction. There are 5 tabs available for configuring the behavior: Basic, Advanced, Transaction Logging, Postprocess, Scheduling and Criteria.
1. Basic: This includes the required Polling interval for how often to scan the Directory. The Polling directory allows you to specify which directory you would like to poll. Click on the three dots to the right of the line.
You’ll see the window below.
The File/folder name restriction allows you to specify a set of characters required in the file name. The File extension restriction allows you to specify the file extensions that you will process. Tokenizers allow you to specify a character after which to split the file into multiple transactions. By default, the eiConsole will treat the entire file as the datastream to be handled as 1 message. However, if each line of the file represents a different record you would enter a value, such as the new line delimiter in this space.
2. Advanced: The Advanced tab allows you to specify whether or not you should only run the Listener when it is triggered externally, how many elements should be serialized and whether or not to also scan sub-folders.
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.
Include sub-folders: This specifies whether or not sub-folders should be searched for files as well.
Include hidden files: This specifies whether or not hidden files should retrieved by the listener.
Combine file 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.
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. Post-process: This tab allows you to specify the behavior of the system after a file has been picked up. You can Keep, Delete or Move the file.
If you choose to Move a file, the Target directory becomes required. This allows you to specify the directory to use for the processed files.
5. Scheduling: This tab allows you to specify the start times and end times for scheduled execution (choose the three dots to the right of the line in order to see this window). 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.
6. Criteria: This tab allows you to specify additional criteria, such as:
Minimum seconds since file modified: minimum number of seconds elapsed since file modified.
Minimum days since file modified: minimum number of days elapsed since file modified.
Maximum days since file modified: maximum number of days elapsed since file modified