FTP/SFTP Writer Component

Writes FileData passed into the component to the target directory on the File Transfer Server.

Data Governance

The FTP/SFTP Writer component will record the storage of each file it writes in the Data Governance System.

Input Channels

default — Uploads the FileData objects received on this input channel to the target directory on the File Transfer Server.

Output Channels

success — Returns a SimpleMappedData object indicating that a FileData object was successfully uploaded to the File Transfer Server.  The object contains the full path where the file was written on the File Transfer Server.

failure — Returns a SignalData object indicating that a FileData objects was not successfully uploaded to the File Transfer Server.

error — Returns an ErrorOutput object when 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

outputDirectory — (String) The directory on the File Transfer Server to which all of the input Files will be written.

createOutputDir— (Boolean, default: false) Specifies whether the output directory should be created if it doesn't exist.  The directory will be created at component initialization, and will cause a startup failure if it cannot be created.

ignoreFilePath — (boolean, default: false) Specifies whether the path included in the incoming files should be ignored or not.  If this is false, the files will be uploaded into a subdirectory on the server matching the file’s path, relative to the components outputDirectory.  If this is true, the path is ignored, and the file will be uploaded directly into the outputDirectory.