FTP/SFTP Reader Component

This component connects to a File Transfer Server and downloads the file or files specified in its configuration.  The component can be used to download either a single file or an entire directory of files depending on how it is configured.  The file download is initiated by passing a SignalData object to the execute input channel.

Data Governance

The FTP/SFTP Reader Component will register all the File Data objects it returns with the Data Governance System. If the retrieval was triggered by a SignalData object, the File Data objects are registered as being derived from that object.

Input Channels

execute — Receives a SignalData object that instructs the component to re-execute its query.  If the query is already executing, the message is ignored and logged.

Output Channels

default — Outputs FileData objects for each file that is downloaded from the File Transfer Server.

noResults — Outputs a SignalData object if there are no files to download from the target location on the File Transfer Server.

error — Outputs ErrorOutput objects if there is an error communicating with the File Transfer Server.

Parameters

resource — (FTP Resource) The resource defining the service to which this component should connect

downloadRecursive — (boolean, default: false) Instructs the component to recursively download files found in any directories of the download path.

downloadPath — (String) The path on the file transfer server from which to download files.  If the download path points to a file, that single file is downloaded, and the component stops.  If the download path points to a directory, all files in that directory are downloaded.