[Files] Copy/Move from FTP
This module allows you to copy or move one or more files from an FTP server to a different location, e.g., on a local or network drive. Typically, you would first set up a job step that uses the [Files] Find on FTP module, then use its output as the input to this module. You can also forgo this and supply a file or folder name in FileSource.
The basic operation of the module is to connect to an FTP server, copy each specified file to the desired destination, and then optionally delete it from the FTP server once it has been successfully copied. The parameters are a combination of the FTP parameters you will find in [Files] Find on FTP, plus some of the [Files] Copy/Move parameters:
| Parameter | I/O | Description |
|---|---|---|
| FileSource | In | This parameter takes a list of files (a FileList) that we want to copy or move from the FTP server. It is usually linked to the output of a job step that uses the [Files] Find on FTP module. If it is not linked and entered manually, it must either be a file or a folder that exists on the FTP server. If it is a file, that file will be copied/moved. If it is a folder, every file in the folder will be copied/moved, but not sub-folders. If a recursive copy/move is needed, then the output from the [Files] Find on FTP module must be used |
| Action | In | Copy: Copies the source files to the destination. Move: Copies the source files to the destination and then deletes from the source folder the files that were copied. |
| FtpServer | In | The FTP server you wish to connect to. Example: ftp.abcxyz.com - there is no need to include ftp:// |
| FtpUsername | In | The username used to login to the FTP server. |
| FtpPassword | In | The password used to login to the FTP server. |
| FtpProtocol | In | The protocol to use to connect with the FTP server. Options: Auto, FTP, FTPS, SFTP. If you are not sure which protocol is appropriate, try Auto. |
| FtpFolder | In | The folder you wish to search. If you are using a FileList from the [Files] Find on FTP module, this parameter is ignored. If you are not using a FileList, then this needs to be specified to determine where to look for the files to be copied. |
| DestinationFolder | In | The folder you want to copy or move the files to. |
| ReplicateSubfolders | In | True: Replicates all sub-folders during the copy process. False: Copies all files to the same folder level regardless of their location in sub-folders at the source, which can lead to name collisions. |
| IgnoreIfSameSize | In | True: Before each file is copied, if the destination file already exists, the sizes are compared, and if they are the same, no copy/move is performed. False: No size check is done before overwriting the destination file. |
| LogOutputLevel | In | Minimal: Normal output to the log. Verbose: More detailed output is written to the log, suitable for debugging purposes. |
| FileList | Out | This parameter lists all the files from the FileSource that were able to be successfully processed (deleted). |
((TODO: Files CopyMove to FTP))