Definition

Specify a label for this action.

Specify the path and file name of a single file to download. A file name is required, it may not be a directory name only.

Specify the name of a variable of type Remote File List which contains the files to retrieve from the remote server. For example, ${variableName}.

Specify the destination file when downloading a single file. This value is only used when downloading only a single file. Specifying this attribute when downloading multiple files will result in a compilation error.

Specify where on the local system the files should be downloaded. If the specified directory does not exist, it will be created.

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.

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.

Specify a string to attach to the beginning of the destination file names.

Specify a string to attach to the end of the destination file names.

SSpecify 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.

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.

If desired, specify the name of a variable which will contain the succesfully 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.

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.

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.