FTPGet - FTP(Get)

The FTP(Get) component gets files from the specified FTP server.

Stream Information

Input	Format	All
	Number of Inputs	1
	Description	The input stream is not used. Stream formats are not selectable.
Output	Format	XML,CSV,FixedLength,Text,HTML,Binary,MIME
	Description	Set the output stream according to the type of file to be retrieved.

Output Stream Variables

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

Component Properties

Name	Data Type	Mapping	Description
UseConnection	boolean	-	Specifies if the Connection property is used to specify the FTP server information. true [true] - Uses Connection specified connnection. false [false] - Uses the information under ConnectionInfo.
Connection	connection	-	If UseConnection=true, specifies the FTP connection to use. The connections are defined in the Connection Pane of Flow Designer or the Flow Service Management Console.
ConnectionInfo	group	-	The FTP server connection property settings' place holder displayed when UseConnection is set to false.
Protocol	choice	In & Out	Specifies if the FTP server is SFTP server or not. If UseConnection=false, this is used. ftp - FTP sftp - SFTP
Servername	string	In & Out	Specifies the hostname of the FTP server. If UseConnection=false, this is used.
Port	int	In & Out	Specifies the listening port of the FTP server. If UseConnection=false, this is used.
PassiveMode	boolean	In & Out	Specifies whether or not to use passive mode. This is not used if the protocol is SFTP. If UseConnection=false, this is used. true [true] - Passive mode false [false] - Active mode
FilenameEncoding	choice	In & Out	Specifies the encoding of file name of transferred files. If the file name doesn't include multibyte characters, any encoding can be used. This is not used if the protocol is SFTP. If UseConnection=false, this is used.
Timeout	int	In & Out	Specifies the timeout value, in seconds. This component times out after specified time passed since the communication was done at the end. If UseConnection=false, this is used.
Username	string	In & Out	Specifies the username. If UseConnection=false, this is used.
Password	password	In & Out	Specifies the password. If UseConnection=false, this is used.
FilePath	string	In & Out	The relative directory path of the file(s) to retrieve. Absoute path cannot be used. This path can contain the '*' and '?' wildcards. '*' matches zero or more characters, '?' matches one character.
FileDateGet	boolean	-	Specifies if the last modified date is set to the stream variable FileDate. If the last modified date is not required, please set false so that it could be faster. true [true] - Sets the last modified time of the file. false [false] - Sets the current local time of GMT.
TransferMode	choice	In & Out	The FTP transfer mode to use when retrieving the file(s). Ascii - ASCII mode. Converts the line feed code. Binary - BINARY mode.
FileEncoding	choice	In & Out	Specifies the encoding of transferred files. If OutputStream=CSV/Text/HTML, specifies the character encoding used to encode the file content. If the files don't include multibyte characters, any encoding can be used.
LoopProcess	loopProcess	-	Specifies if it outputs files as an individual stream or as a single stream when if the FilePath includes wildcards and the multiple files matches. true [true] - Each matching file is returned in its own output stream. false [false] - All matching files are returned in a single output stream.
Processing when commit	choice	-	Specifies if files are deleted on the server when the transaction is committed. Delete File(s) [true] - Deletes it Do Nothing [false] - Don't delete it

Loop

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

Transaction

Commit	If Processing when commit=Delete File(s), files are deleted on the server.
Rollback	Do nothing.

Exceptions

Type	Parameter	Stream for error handling flow	Error Code	Description
FileNotFoundException	None	This component's input stream	-	Cannot find the FilePath defined file.
Exception	None	This component's input stream	-	The specified Connection could not be found.
			-	The FTP server could not be contacted.
			-	The FTP server returned an error.

Cancel of the flow

When flow is canceled, the flow usually aborts after the execution of that component is ends. However, the execution of this component is forced to be ended, then it aborts.

Limitation

LIST command result's is supported Windows and Unix file list style. the other format may error.