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, Inactivity, Throttling, Post-Process, Scheduling, Criteria, and Sorting.
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 data stream 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:
Initialize on trigger only: If enabled, the Listener doesn’t start up until a trigger initializes it.
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.
Stop If Directory: Listener will stop and report an error when polling directory, or postprocess target directory do not exist.
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 Transaction 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.
Full Folder Path Restriction: A regex expression which must be contained by the full folder path of the file to be picked up (typically will only be used if you are using the ‘Include sub-folders’ option).
Include hidden files: This specifies whether or not hidden files should be 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.
Synchronous: Listener waits for a synchronous response before continuing to process the next file. Max Transactions Per Run setting must be set to 1 to enable synchronous mode.
Synchronous Timeout: Time in seconds to wait for a synchronous response before timing out.
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 Data: if enabled, logs transaction data body.
Log Transaction Data Base64: if enabled, logs transaction data body as Base64.
Log Transaction Attribute: if enabled, logs transaction attributes.
Log All Attributes: If enabled, no attributes will be filtered.
Allowed Attributes: Attributes which are allowed to be logged.
4. Inactivity: This tab allows you to specify:
Enable Inactivity Monitor: Check this box to enable inactivity monitoring. This will throw a non-transaction exception if the specified number of transactions haven’t been processed in the specified time interval.
Min. Transactions to Expect: The number of transactions to expect to be completed per monitoring interval.
Monitoring Interval: How often to check the specified number of transactions have been processed.
Times to Monitor: If set, monitoring will be done during the defined times of day. To ignore, set start and end time equal.
Days to Exclude from Monitoring: Inactivity monitoring will not occur on the days specified.
Include Errors in Transaction Count: If checked, transactions that attempted to start but failed at the Listener stage will also be counted.
5. Throttling: this tab allows you to specify:
Throttling Mode: The throttling mode to use for limiting the number of transactions or messages emitted by this Listener. “Timed” will limit transactions based on time intervals, while “Concurrent” will limit based on a concurrent number of transactions. “Concurrent” mode requires a Throttling Response Processor step later in your Interface workflow to acknowledge completion.
Throttling Mechanism: The mechanism to use for throttling message. “Blocking” prevents the Listener from continuing to process and emit messages altogether, while “Queued” pushes received messages into the Interface queue (or a default, in-memory queue).
Max Concurrent Messages: How many messages can be concurrently processed, either by time-based limits (“Allow X per Second”) or synchronous (“Allow X at any Time”)
Timed Emission Interval: The interval for time-based limits (“Allow X per X Timed Emission Interval”)
Synchronous Timeout Interval: The interval to wait for a synchronous response before failing.
6. 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.
7. 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 you 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.
8. 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
9. Sorting: this tab allows you to specify:
File Sorting Method: Sorting method for the order in which files are read.
Sorting Direction: Direction of the selected sorting method.