Get File Activity
The Get File activity downloads a specified file from a remote server. It requires an active session and defines both the source and destination paths for the file transfer.
| Field | Description | Requirement |
|---|---|---|
| Session name | The reference name of the session established by the Connect activity. | Required |
| Remote file name | The full path of the file on the remote server to be downloaded. | Required |
| Local file name | The full path, including the desired file name, for the downloaded file on the local machine. | Optional |
| Overwrite | Specifies whether to overwrite an existing file or folder with the same name at the local destination. | Optional |
Action Types & Examples
Session Name
- Format: String
- Example Result: "testSession"
Remote File Name
- Format: String (file path)
- Example Result: "/home/username/TestFolder/Get_File_Test.txt"
Local File Name
- Format: String (file path)
- Example Result: "C:\Temp"
Implementation Examples
Field Setup - Session name: testSession - Remote file name: /home/username/TestFolder/Get_File_Test.txt - Local file name: C:\Temp
Execution Parameters - sessionName: "testSession" - remoteFileName: "/home/username/TestFolder/Get_File_Test.txt" - localFileName: "C:\Temp"
Technical Notes
Ensure the specified session is active and possesses the necessary permissions to access the remote file and write to the local destination. File paths should adhere to the conventions of the respective operating systems (e.g., Unix-like for remote paths, Windows for local paths).