Download
Transfers files from a remote SFTP server to the local system, allowing both individual file retrieval and larger workflows for synchronizing remote data locally.
Input
| Name | Type | Required | Accepts Output Streams | Description |
| RemoteFile | String | False | False | The full path and name of the file on the FTP/SFTP server to be downloaded. This property takes precedence over the RemotePath parameter if both are provided. |
| RemotePath | String | False | False | The remote folder path to download from. If the IncludeSubFolders parameter is true, all files and folders within this path will be downloaded. |
| LocalPath | String | False | False | The destination folder on the local system where downloaded files will be stored. |
| LocalFile | String | False | False | The local filename to assign to the downloaded file, which is not applicable when downloading all files from a folder. |
| Overwrite | Boolean | False | False | Specifies whether existing local files should be overwritten (true) or preserved (false).
The default value is true. |
| TransferMode | String | False | False | The file transfer mode to use, typically ASCII or Binary, depending on the file type.
The allowed values are DEFAULT, ASCII, BINARY. The default value is DEFAULT. |
| IncludeSubFolders | Boolean | False | False | Specifies whether files in subfolders of the remote path should also be downloaded (true) or ignored (false).
The default value is false. |
| DownloadDepth | Integer | False | False | The depth level for downloading subfolders from the remote path, which only applies when IncludeSubFolders is true.
The default value is 0. |
| ContinueOnError | Boolean | False | False | Specifies whether the operation should continue (true) or stop (false) if an error occurs with any file.
The default value is false. |
| FileStream | String | False | True | An output stream to which the downloaded file is written. This is used only when LocalPath is not set. |
| MaxDownloadBytes | Long | False | False | Limits the maximum number of bytes to download if greater than 0. This is useful for partial or controlled transfers.
The default value is 0. |
| StartByte | Long | False | False | The byte offset from the beginning of the file at which to start reading, which allows partial downloads.
The default value is 0. |
Result Set Columns
| Name | Type | Description |
| FileName | String | The name of the file that was downloaded. |
| Success | String | Indicates whether the download operation for the file completed successfully (true) or unsuccessfully (false). |
| FileData | String | The Base64-encoded content of the downloadeded file is returned only if the LocalPath and FileStream parameters are not specified. |