Enumerates all files matching the specified criteria in the specified location. Includes support for local files, UNC paths. FTP, SFTP anf FTPS.

Revision History

1.0.0.35 - Added support for explicit passive & active FTP, added support for custom timeout, some bug fixes

Properties

Connection

Type: Connection Input

Username
Type: String
The username used to authenticate access to the FTP or SFTP server

Password
Type: String
The password used to authenticate access to the FTP or SFTP server

TargetUsername
Type: String
Not used on this Connector.

TargetPassword
Type: String
Not used on this Connector.

CreateTargetDirectory
Type: Boolean
When True, indicates that the target path should be created if it does not already exist.

Provides a Connection and optionally a DropPoint to service the request.

DirectoryPath

Type: String Input
The path to the directory from which files should be listed.

Filter

Type: String Input
The search string to match against the names of files in the path.
Filter can be a combination of literal and wildcard characters, but doesn't support regular expressions. The following wildcard specifiers are permitted in Filter. * (asterisk) Zero or more characters in that position. ? (question mark) Zero or one character in that position. Characters other than the wildcard are literal characters. Filter cannot end in two periods ("..") or contain two periods ("..") followed by Directory Separator Character, nor can it contain any invalid characters.

IncludeSubDirectories

Type: Boolean Input
When true, all files in directories under the primary directory will also be enumerated. When false only files directly under the primary directory will be listed.

ReturnFullPath

Type: Boolean Input
When true, the full path to the file will be provided on the FileName output. When false, only the file name will be provided.

FileName

Type: String Output
Returns the name of each file found in turn.

CurrentRow

Type: Int32 Output
An incrementing counter, returning the index of the current file in the returned list.

TotalRows

Type: Int32 Output
Returns the total number of files which match the supplied criteria.

Video

Remarks

The File Enumerator enumerates files based on the specified criteria. 

The prefix provided as part of DirectoryPath determines the file type as follows:

  • [Drive]:\ local drive
  • \\ UNC path for network share
  • ftp:// FTP
  • sftp://  SFTP
  • ftps:// FTPS

When accessing a local filesystem, a DropPoint must be used, not using a DropPoint will result in the error "An operation requiring File access permission was denied." Direct connections may only be used for FTP/SFTP servers.

Authentication

The Username and Password provided in the Connection Property will be used to authorize FTP or SFTP sessions only. If you require specific credentials to gain access to a local file or UNC path, change the Windows Service account used by the DropPoint.

See Also

File
File Watcher
FileManage
Flat File

Did this answer your question?