sftpGetFile Step

Last published at: May 14th, 2024


Get (Download file from 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 properties
  • Configure the following values for the properties as shown on the below graphic
  • Save the workflow definition, create a workflow instance and execute. Step should get or download file from SFTP server.