Read FTP File

Read FTP File returns the contents of a remote file through an FTP Connection resource.

The file is located by Directory, File Path and File Name, each of which can also be supplied at runtime through the Input mapping.

The activity has four tabs: Configuration, Advanced, Input, and Output.

Configuration

Field	Required	Description
Name	Required	Name of the step, unique within this workflow.
Description	Optional	Describe the purpose of this step.
FTP Connection	Optional	Resource to connect to the FTP or FTPS server.
FTP Auth Context	Optional	Authorization context used for the FTP connection.
Directory	Optional	Remote directory the file is in.
File Path	Optional	Path to the file within the working directory.
File Name	Optional	Name of the file to read.

Advanced

Field	Required	Description
Encoding	Optional	Text encoding for the returned content. Defaults to UTF-8.
Retry	Optional	Retry the operation on failure.
Retry Policy	Optional	The retry policy resource to apply.

Input

Field	Data Type	Description
filePath	String	Full path to the file in the storage location to be read.
fileName	String	File name. Used with the working directory when filePath is not provided.
streaming	Boolean	Whether the file should be read in streaming mode.

Output

The activity returns a readFileOutput object.

Field	Data Type	Description
content	String	The file's contents, decoded using Encoding.
contentLength	Integer	Length of the content returned.
fileName	String	Name of the file read.
filePath	String	Path of the file read.
createdTime	String	When the file was created.
lastModified	String	When the file was last modified.