Field | Definition |
Basic Tab | |
Label | Specify a label for this action. |
Source Files | Specify the path and/or filter pattern. Leave blank to download all files in the current working directory. |
Destination Directory | Specify the directory to which the files should be downloaded. |
When File Exists | Specify the action to take when a destination file already exists. The default value is 'rename' which changes the destination file name to a new name so the existing file remains untouched. Default Value: rename |
Transfer Options Tab | |
Data Type | Specify the data type to use when transferring the files. The default value is 'auto' which uses the file extensions and/or the content type of the file to determine the correct download mode. Default Value: auto |
File Name Prefix | Specify a string to attach to the beginning of the destination file names. |
File Name Suffix | Specify a string to attach to the end of the destination file names. |
Verify Checksum | Specify whether or not to enable checksum verification. Checksum verification ensures that the source file is exactly the same as the destination file after a successful transfer. Please note that not all FTP servers support checksum verification, in which case you must turn off checksum verification to be able to transfer files. Also, transferring files in ASCII mode may result in checksum mismatch. Please make sure to explicitly set the Data Type to binary or image. Default Value: false |
Checksum Algorithm | Specify the algorithm to use for checksum verification. Some FTP servers implemented a proprietary command called XCRC for getting the checksum of the remote file. Most recent FTP standards recommend implementing a command called MD5, which uses the MD5 algorithm for calculating the checksums. Depending on the algorithm you choose, an appropriate command will be sent to the FTP server to request the checksum. The same algorithm will be used for calculating the checksum of local files. Default Value: MD5 |
Output Variables Tab | |
Destination Files Variable | If desired, specify the name of a variable which will contain the successfully downloaded files on the local system. This variable will be of type File List and may be used in subsequent tasks that accept a File List input variable. The variable will be created if it does not exist. |
Number of Files Downloaded Variable | If desired, specify the name of a variable which will contain the number of files downloaded. The variable may be used in subsequent tasks. The variable will be created if it does not exist. |
Processed Source Files Variable | If desired, specify the name of a variable which will contain the files on the remote system that were successfully downloaded. This variable will be of type Remote File List and may be used in subsequent tasks that accept a Remote File List input variable. The variable will be created if it does not exist. |