Download
Retrieves a file from the FTP server to the local system as a backup, or transfers a file from the FTP server for remote data ingestion.
Input
| Name | Type | Required | Description |
| RemoteFile | String | False | The name and path of the file to be downloaded from the remote FTP server. |
| RemotePath | String | False | The path to the remote folder for downloading files. If no RemoteFile is specified, all files in this folder will be downloaded. |
| LocalPath | String | False | The destination folder on the local system where the downloaded files will be stored. |
| LocalFile | String | False | The local filename to use for the downloaded file. (Applies only if one particular file is downloaded. Not needed if all the files in a folder will be downloaded.) |
| Overwrite | String | False | Specifies whether existing local files should be overwritten (true) or preserved (false).
The allowed values are true, false. The default value is true. |
| TransferMode | String | False | The transfer method to use, which is typically ASCII or Binary, depending on the file type.
The allowed values are DEFAULT, ASCII, BINARY. The default value is DEFAULT. |
| IncludeSubFolders | String | False | Indicates whether to include subfolders within the remote path in the download (true) or to ignore them (false).
The allowed values are true, false. The default value is false. |
Result Set Columns
| Name | Type | Description |
| Success | String | Indicates whether the download operation was successful (true) or unsuccessful (false). |
| FileData | String | The Base64-encoded content of the downloaded file. Returned only if neither LocalPath nor FileStream is specified. |