FileList - File List

The FileList component outputs the specified directory's file list.

The list is output as a stream of records.

Stream Information

Input	Format	All
	Number of Inputs	Unlimited
	Description	The input stream is not used. Stream formats are not selectable.
Output	Format	Record
	Description	The output stream is always of type Record. The Record field names and the order that they are output is listed below. The Record fields and their order are fixed. The field names or field order should not be changed. If the field names are changed or the fields deleted the data will not be retrieved correctly. Field Name Data Type Description FileName String file name FilePath String file path FileDate DateTime file timestamp FileSize Integer file size FileType String "file" or "directory"

Component Properties

Name	Data Type	Mapping	Description
FileMask	string	In & Out	The file search mask. File data for the files that match the search pattern specified here will be output. There are three wildcard characters: "*", "**", and "?". "**" is an optional multi-directory wildcard operator. The "*" character is an optional multi-character wildcard operator. The "?" character is an optional single-character wildcard operator. If this property is empty, file data for all the files in the Directory will be output. This is the same as setting this property to "*". Some examples follow: ** - all files in all the directories beneath, and including, the Directory * - all files in the Directory **/*.txt - all "*.txt" files in all the directories beneath, and including, the Directory *.txt - all "*.txt" files in the Directory **/src/**/*.java - all "*.java" files beneath the Directory that have at least one "src" directory in their path.
Directory	remoteFile	In & Out	The directory path. No distinction is made between the "/" and "\" characters. Either is acceptable. If this field is empty, the HomeDirectory file list will be output. Some example file paths follow: directory C:\directory \\server\share\
FilePathDetail	group	-	Properties for specifying details of file path.
HomeDirectory	pathResolver	-	Specifies the base folder when the path is written by a relative path. Project folder [Relative] Start point is the same folder as the project file. Home folder [ProjectOwner] Start point is the projedct owner's home folder. Executing user home folder [ExecuteUser] Start point is the execute user's home folder.
AllowAbsolute	boolean	-	Specifies whether to allow an absolute path.
AllowUpDir	boolean	-	Specifies whether to allow the ".." in order to move to parent folder.
FileType	choice	In & Out	The type of file to list. All - Files and folders File - Only files Directory - Only folders
Target Updated Date	group	-	The property settings' place holder when the files are filtered by modified time.
Before	datetime	In & Out	If non-empty, only files whose modified date is before this value are selected. For details of the format, please refer to following topic "About the Before and After properties' format".
After	datetime	In & Out	If non-empty, only files whose modified date is after this value are selected. For details of the format, please refer to following topic "About the Before and After properties' format".
Sort	choice	In & Out	Specifies how the file results are to be sorted for output. FilePath - Sort by FilePath (ascending order) FilePath(Desc) - Sort by FilePath (descending order) FileDate - Sort by FileDate (ascending order) FileDate(Desc) - Sort by FileDate (descending order) FileSize - Sort by FileSize (ascending order) FileSize(Desc) - Sort by FileSize (ascending order)
LoopProcess	loopProcess	-	Specifies if it outputs file list as an individual stream or as a single stream. true [true] - Each matching file is returned in its own output stream. false [false] - All matching files are returned in a single output stream.

Loop

If LoopProcess=true, an output stream is created for each matching file, otherwise, a single output stream is created.

Transaction

Commit	Do nothing
Rollback	Do nothing

Exceptions

Type	Parameter	Stream for error handling flow	Error Code	Description
Exception	None	This component's input stream	-	Invalid FileMask.
DirectoryNotFoundException	None	This component's input stream	1	Invalid Directory.
FileNotFoundException	None	This component's input stream	2	File not found in the specified Directory.

Operations

• When double-clicking the component icon, the dialog box is displayed and the path of Directory property can be selected. It is possible to do similarly by "Selection of folders" of the menu that right-clicks in the icon.
• By dragging the folder from tree pane and dropping on the component icon, the folder path is set automatically to Directory.

About the Before and After properties' format

The Before and After properties' value, if set, must take the form "yyyy-MM-dd'T'HH:mm:ss". The time - hours, minutes, and seconds - cannot me omitted. Also, if a file's timestamp equals the specified Before and After period, the file's information will not be output.