Create an RPA Flow that Connects to SFTP Data in UiPath Studio

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SFTP ODBC Driver

The SFTP ODBC Driver is a powerful tool that allows you to connect with live data from remote files and directories, directly from any applications that support ODBC connectivity.

Access remote data like you would a database through a standard ODBC Driver interface.



Use the SFTP ODBC Driver to create workflows that access real-time SFTP data without any coding.

UiPath is a Robotic Process Automation (RPA) platform with rich features and an easy-to-use UI that enables non-developers to create process automation. By using UiPath Studio, you can build an RPA program just like drawing a diagram. With the CData ODBC Driver for SFTP, users can embed SFTP data in the workflow.

This article walks through using the SFTP ODBC Driver in UiPath Studio to create an RPA program that accesses SFTP data.

Configure the Connection to SFTP

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

SFTP can be used to transfer files to and from SFTP servers using the SFTP Protocol. To connect, specify the RemoteHost;. service uses the User and Password and public key authentication (SSHClientCert). Choose an SSHAuthMode and specify connection values based on your selection.

Set the following connection properties to control the relational view of the file system:

  • RemotePath: Set this to the current working directory.
  • TableDepth: Set this to control the depth of subfolders to report as views.
  • FileRetrievalDepth: Set this to retrieve files recursively and list them in the Root table.
Stored Procedures are available to download files, upload files, and send protocol commands. See gdatamodel for more on using SQL to interact with the server.

Connect UiPath Studio to SFTP Data

Now you are ready to use SFTP data ODBC DSN in UiPath Studio with the following steps.

  1. From the Start page, click Blank to create a New Project.
  2. Click Manage Packages then search for and install UiPath.Database.Activities.
  3. Navigate to the Activities and drop a Flowchart (Workflow -> Flowchart -> Flowchart) onto the process.
  4. Drop a database Connect activity (App Integration -> Datbase -> Connect) after the Start activity.
  5. Double-click the Connect activity and configure the Connection.
    1. Click the Connection Wizard
    2. Select "Microsoft ODBC Data Source"
    3. In Connection Properties, select your DSN (CData SFTP Source) and click OK
  6. To store Connection info, create a variable and bind to Output in the Properties section. Choose DatabaseConnection in Output.

Create an Execute Query Activity

With the connection configured, we are ready to query SFTP data in our RPA.

  1. From the Activities navigation, select Execute Query and drop it on the Flowchart.
  2. Double-click the Execute Query activity and set the properties as follows:
    • ExistingDbConnection: Your Connection variable
    • Sql: SELECT statement like SELECT Filesize, Filename FROM MyDirectory WHERE FilePath = /documents/doc.txt
    • DataTable: Create and use a variable with the Type System.Data.DataTable

Create Write CSV Activity

With the Connection and Execute Query activities configured, we are ready to add a Write CSV activity to the Flowchart to replicate the SFTP data.

  1. From the Activities navigation, select Write CSV and drop it after the Execute Query activity.
  2. Double-click the Write CSV activity and set the properties as follows:
    • FilePath: Set to a file (new or existing) on disk (i.e.: C:\UiPath[id]-data.csv
    • DataTable: Set to the DataTable variable you created earlier

Connect the Activities and Run the Flowchart

If they are not already connected, connect each Activity that you created to complete the RPA project for extracting SFTP data and exporting it to CSV.

Click Run to extract SFTP data and create a CSV file.

In this article, we used the CData ODBC Driver for SFTP to create an automation flow that accesses SFTP data in UiPath Studio. Download a free, 30-day trial of the ODBC Driver and start working with live SFTP data in UiPath Studio today!