Download Files
AutomatR.SFTP.DownloadFiles
The "Download Files" activity in AutomatR is part of the SFTP activities package, allowing users to download specified files from an SFTP server to a local destination folder. This activity facilitates efficient file transfer from the SFTP server to the local environment.
Properties
| Name | Description |
|---|---|
| Input | |
| Client | Specifies the SFTP client object to connect to the SFTP server. |
| Server Path | Specifies the path of the files to be downloaded from the SFTP server. |
| Destination Path | Specifies the local location where the files will be downloaded. |
| Overwrite | If checked, the files will be overwritten locally if they already exist. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the activity. Useful for handling synchronization issues. |
How to use:
- Drag and drop the "Download Files" activity onto the workflow.
- Configure the properties by specifying the SFTP client, server path, local destination path, and optionally set a delay and overwrite preference.
- Execute the workflow to download the specified files from the SFTP server to the local destination folder.
- Optionally, handle any errors or utilize the downloaded files in subsequent activities.
Example:
Consider an example where the "Download Files" activity is used to download files from the "/Documents/" directory on the SFTP server to the local folder "C:/DownloadedFiles/":
Download Files:
Display Name: "Download SFTP Documents"
Client: sftpClientObject
Server Path: "/Documents/"
Destination Path: "C:/DownloadedFiles/"
Overwrite: true
In this example, the activity downloads files from the "/Documents/" directory on the SFTP server to the "C:/DownloadedFiles/" local folder. The overwrite option is set to true, allowing the activity to replace existing files if they already exist.