sftpGetFile Step

Use this step to download a file from the SFTP server.

Last published at: August 1st, 2023


This step gets / downloads a file from the SFTP server. 


  • sftpConnection – Select the SFTP connection from dropdown
  • sourceFilePath – The relative path of the file in SFTP server. Ex: - /folder1/test.txt
  • destinationFilePath – The physical path to be downloaded to in local. Ex: - C:\Download



  • True – step executed successfully
  • False – step failed to execute 




To use this step, configure SFTP in FlowWright SFTP Connections.



Let’s build and execute the “sftpGetFileDef” example.          

  • Create a new definition called “sftpGetFileDef” 
  • Select the definition and click the “design” button
  • Drag a “sftpGetFile” step from the toolbox
  • Connect the dots between the start and “sftpGetFile” step
  • Click on the “sftpGetFile” step to configure its “Settings” properties. Provide a name to the step. Select “SFTP” connection string from the dropdown list. Provide a relative file path of the source file to be downloaded. Provide a local file path to store the file on the local machine.  
  • The “Logging” setting configuration is necessary for documentation and also measure the workflow progress and the percent complete. This is acheived by configuring the step state and percent fields individually as shown in the images below. Configure the “Logging” using the following properties.
  • Save the process definition, create a new process instance and execute. Render the process instance. Click on the process step to view the properties. The step should get or download file from the SFTP server.