How to create an RPA flow for SQL Server Data in UiPath Studio

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 SQL Server, users can embed SQL Server data in the workflow.

This article explains how to use the SQL Server ODBC Driver in UiPath Studio to create an RPA program that accesses SQL Server data.

👁 Using the CData ODBC Data Sources in UiPath

Configure the Connection to SQL Server

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.

Connecting to Microsoft SQL Server

Connect to Microsoft SQL Server using the following properties:

• Server: The name of the server running SQL Server.
• User: The username provided for authentication with SQL Server.
• Password: The password associated with the authenticating user.
• Database: The name of the SQL Server database.

Connecting to Azure SQL Server and Azure Data Warehouse

You can authenticate to Azure SQL Server or Azure Data Warehouse by setting the following connection properties:

• Server: The server running Azure. You can find this by logging into the Azure portal and navigating to "SQL databases" (or "SQL data warehouses") -> "Select your database" -> "Overview" -> "Server name."
• User: The name of the user authenticating to Azure.
• Password: The password associated with the authenticating user.
• Database: The name of the database, as seen in the Azure portal on the SQL databases (or SQL warehouses) page.

SSH Connectivity for SQL Server

You can use SSH (Secure Shell) to authenticate with SQL Server, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).

SSH Connections to SQL Server in Password Auth Mode

To connect to SQL Server via SSH in Password Auth mode, set the following connection properties:

• User: SQL Server User name
• Password: SQL Server Password
• Database: SQL Server database name
• Server: SQL Server Server name
• Port: SQL Server port number like 3306
• UserSSH: "true"
• SSHAuthMode: "Password"
• SSHPort: SSH Port number
• SSHServer: SSH Server name
• SSHUser: SSH User name
• SSHPassword: SSH Password

SSH Connections to SQL Server in Public Key Auth Mode

To connect to SQL Server via SSH in Password Auth mode, set the following connection properties:

• User: SQL Server User name
• Password: SQL Server Password
• Database: SQL Server database name
• Server: SQL Server Server name
• Port: SQL Server port number like 3306
• UserSSH: "true"
• SSHAuthMode: "Public_Key"
• SSHPort: SSH Port number
• SSHServer: SSH Server name
• SSHUser: SSH User name
• SSHClientCret: the path for the public key certificate file

Connect UiPath Studio to SQL Server Data

Now you are ready to use SQL Server 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. 👁 Configure the Connect Activity
   
   1. Click the Connection Wizard
   2. Select "Microsoft ODBC Data Source"
   3. In Connection Properties, select your DSN (CData SQL Source) and click OK
6. To store Connection info, create a variable and bind to Output in the Properties section. Choose DatabaseConnection in Output.
   👁 Bind the Connection to the Output property.
   

Create an Execute Query Activity

With the connection configured, we are ready to query SQL Server 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 ShipName, Freight FROM Orders
   • DataTable: Create and use a variable with the Type System.Data.DataTable
   👁 Set the Query for the ODBC Driver.
   

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 SQL Server 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 SQL Server data and exporting it to CSV.

👁 Connect each Activity in the Flowchart

Click Run to extract SQL Server data and create a CSV file.

👁 Running the RPA Flowchart

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