file poller
Icon |
|
|---|---|
Use When |
A file based resource needs to be checked for the existence of a file or set of files |
Samples |
|
Description |
The File Poller is used to look at a file based directory structure and send a message to downstream components if a file or files match a given file pattern exists. The file poller sends a payload of an array list of strings with the file names of each file found that matches the File Poller’s File Pattern parameter. The File pattern parameter can be a single pattern or a list of patterns separated by commas. Wildcards can be used in any pattern. |
Inbound Message Type |
None |
Output Message Type |
Text Based Message |
Control Message Handling |
Input: When a control message is received and 'Run When' is 'PER UNIT OF WORK' start the processing of this component or when any message other than a control is received and 'Run When' is not 'PER UNIT OF WORK'. Output: A single control message will be forwarded to downstream components once all files have been processed through this step. |
| Name | Description |
|---|---|
Resource |
The File based resource on which the File Poller should operate |
Whether to forward failed messages and continue processing. This is the name of a linked component to forward the failed messages to. |
|
Get File Pattern From Message |
Get the file pattern from an inbound text message versus the File Pattern parameter below. |
File Pattern |
The File Pattern specifies the pattern(s) of files to look for. Multiple patterns can be specified in a comma delimited list. Wildcards (*) can be used. See examples below. |
File Sort Order |
Indicates the order files will be reported. |
Sort Descending |
Order the sort in descending order. |
Files/Msg |
The number of file paths that should be published per message. The default value is 1. |
Min Files to Poll |
Files will not be reported unless at least this number of files are found |
Max Files to Poll |
No more than this number of files will be reported during on execution |
Use Trigger File |
Many systems post a single trigger file to designate that other data files are ready to process. The existence of the trigger file indicates the other files are ready to process. If "Use Trigger File" is true, the File Poller will first check for the existence of a file named the same as the Relative Trigger File Path parameter. If that file exists, the File Poller will then check for files matching the File Pattern parameter. If the trigger file does not exist, the File Poller will send a shutdown message to any downstream linked components. If the Use Trigger File is set to false, no file triggering mechanism will be used |
Relative Trigger File Path |
The relative path and file name of a trigger file that will be used to indicate the files that match the File Pattern parameter are ready for processing. |