Download Activity
The Download activity enables users to retrieve a specified file from an FTP server. It facilitates transferring files from a remote location to a designated local path, offering an option to manage existing files with the same name.
| Field | Description | Requirement |
|---|---|---|
| Connection Name | The reference name of the established FTP connection. | Required |
| Remote File Name | The full path to the file on the remote FTP server that will be downloaded. | Required |
| Local File Name | The full path, including the desired file name, for the downloaded file on the local system. | Required |
| Overwrite | Specifies whether to overwrite an existing local file or folder with the same name. | Optional |
Action Types & Examples
Connection Name
- Format: String
- Example Result:
${ftpConnection}
Remote File Name
- Format: String (file path)
- Example Result:
/home/Temp/ftpTest.xlsx
Local File Name
- Format: String (file path)
- Example Result:
C:TempTestftpTest.xlsx
Overwrite
- Format: Boolean
- Example Result:
true
Implementation Examples
Field Setup - Connection Name: Provide the name of the established FTP connection. - Remote File Name: Specify the full path to the file on the remote FTP server. - Local File Name: Define the full path, including the desired file name, for the downloaded file on the local system. - Overwrite: Set to 'true' to replace an existing local file with the same name, or 'false' to prevent overwriting.
Execution Parameters - Connection Name: ${ftpConnection} - Remote File Name: /home/Temp/ftpTest.xlsx - Local File Name: C:TempTestftpTest.xlsx - Overwrite: true
Technical Notes
Ensure the specified FTP connection has appropriate read permissions on the remote server for the
Remote File Nameand write permissions for theLocal File Nameon the local system. The local directory for theLocal File Namemust exist or be creatable by the executing process.