[Files] Find on FTP
This module allows you to locate a selection of various files on an FTP server that you want to process further in a following step or module. Like [Files] Find, this module provides a variety of options to gather up a list of files—in this case from an FTP server—and allows a combination of options to allow for filtering of what files you want it to identify. Because of the limitations of the FTP protocol, it is not possible to reliably filter on file age, so those parameters do not appear here.
The parameters the module uses are listed in the table below. The filtering parameters marked with an asterisk (*) are the same as [Files] Find, so the same detailed discussions and examples apply.
| Parameter | I/O | Description |
|---|---|---|
| FtpServer | In | The FTP server you wish to connect to. Example: ftp.abcxyz.com - there is no need to include ftp:// |
| FtpUsername | In | The username used to login to the FTP server. |
| FtpPassword | In | The password used to login to the FTP server. |
| FtpProtocol | In | The protocol to use to connect with the FTP server. Options: Auto, FTP, FTPS, SFTP. If you are not sure which protocol is appropriate, try Auto. |
| FtpFolder | In | The folder you wish to search. |
| IncludeSubfolders* | In | True: The find operation will dig down into any sub-folders located in the source path and will include any files matched in the sub-folders. The sub-folders option is recursive and will keep looking for files any number of subfolders deep. False (default): The find operation is only going to look for files located directly within the source path. |
| FilenamePattern* | In | This is a simple filename pattern that can be used like in many legacy applications using the asterisk * and question mark ? characters as wildcards for simple pattern matching. These simple patterns can be combined by using the vertical bar separator | as many times as needed. Not specifying a patten at all is the equivalent to specifying the all files *.* pattern. More examples in the section below, but some basic examples are: *.jpg *.jpg|*.jpeg *.doc|*.docx|*.xls|*.xlsx |
| IncludeRegEx* | In | This allows specifying a regular expression to find files from the source path. The matching is done by file name only, not on the entire path. Using a regular expression allows for complex selection of filename rules. Since regular expressions can be involved, we will provide more details and examples in the section below. |
| ExcludeRegEx* | In | This allows specifying a regular expression to filter out any files from the source path that we do not want. The matching is done by file name only, not on the entire path. Since this uses a regular expression, it can be combined with both the filename pattern and include regex options to provide a rich set of rules for processing specifically named files in a source path. |
| LogOutputLevel | In | Minimal: Normal output to the log. Verbose: More detailed output is written to the log, suitable for debugging purposes. |
| FileList | Out | This parameter lists all the files from the Find operation that the module was able to identify. The files will use the forward slash as the path name separator as that is standard convention for FTP. |