FileGet - File Get

The FileSystem(Get) component reads the specified file and outputs the data.

Stream Information

Input	Format	All
	Number of Inputs	Unlimited
	Description	The input stream is not used. Stream formats are not selectable.
Output	Format	XML,CSV,FixedLength,Text,HTML,Binary,MIME
	Description	Specifies the format the file's data is to be output as.

Output Stream Variables

Name	Data Type	Description
FilePath	String	The file's path.
FileDate	DateTime	The file's last modified date.
FileSize	Integer	The file's size.

Component Properties

Name	Data Type	Mapping	Description
FilePath	remoteFile	In & Out	The file's path to be read. No distinction is made between the "/" and "\" characters. Either is acceptable. If the file path is not absolute, the path is relative to the HomeDirectory. 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. Some example file paths follow: directory/file.txt C:\directory\file.txt \\server\share\file.txt **/*.txt - all "*.txt" files in all the directories beneath, and including, the HomeDirectory C:\directory\*.txt - all "*.txt" files in all the directories beneath, and including, the directory C:\directory
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.
FileEncoding	choice	In & Out	Defines the encoding used to read the file if the file's stream format is Text, HTML or CSV. The file's stream format is defined by the OutputStreamFormat property. Auto Detect will attempt to determine the file's encoding type automatically. The selected Stream Properties Encoding type can be different than the selected FileEncoding type. Auto Detect [(AutoDetect)] - Attempts to automatically detect and select the character code. utf-8 [utf-8] - Unicode utf-8 shift_jis [shift_jis] - Shift JIS euc-jp [euc-jp] - EUC-JP iso-2022-jp [iso-2022-jp] - ISO-2022-JP utf-16 [utf-16] - unicode utf-16 Windows-31J [Windows-31J] - Windows Japanese utf-16 [utf-16] - Unicode utf-16
LoopProcess	loopProcess	-	When using the "*" wild card in the FilePath property, it is possible to match multiple files. true [true] - Send out each file's output stream individually, thus creating a loop. false [false] - Send out all of the file's output data as a single output stream.
Processing when commit	choice	-	Selects whether to delete the file after flow is committed. Delete File(s) [true] - Deletes the file. Do Nothing [false] - Does not delete the file.

Loop

If the defined FilePath matches multiple files and LoopProcess=true, looping will be initiated.

Transaction

Commit	If Processing when commit=Delete File(s), the file will be deleted.
Rollback	Do nothing

Exceptions

Type	Parameter	Stream for error handling flow	Error Code	Description
FileNotFoundException	No. Name Description 1 FilePath The FilePath at the time the Exception occurs.	This component's input stream	-	Cannot find the FilePath defined file.
Exception	No. Name Description 1 FilePath The FilePath at the time the Exception occurs.	This component's input stream	-	The HomeDirectory is set to Executing user home folder, but the execute user does not exist and the relative path cannot be determined.

Operations

• When double-clicking the component icon, the file specified by FilePath property is opened by the application associated with the suffix. It is possible to do similarly by "Editing file" of the menu that right-clicks in the icon.
• By dragging the file from tree pane and dropping on the component icon, the file path is set automatically to FilePath.

Output file order when using a wild card

When using a wild card, which results in the output of multiple files, the order in which the files are output is dependent on the results of sorting the file paths into lexical order.
Furthermore, the sorting results may differ depending on the underlying system. A UNIX system will distinguish between upper and lower case characters. A Win32 system will not distinguish between upper and lower case characters.