How to create an RPA flow for Cosmos DB 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 Cosmos DB, users can embed Cosmos DB data in the workflow.

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

👁 Using the CData ODBC Data Sources in UiPath

Configure the Connection to Cosmos DB

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.

To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

• AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
• AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.

Connect UiPath Studio to Cosmos DB Data

Now you are ready to use Cosmos DB 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 CosmosDB 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 Cosmos DB 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 City, CompanyName FROM Customers
   • 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 Cosmos DB 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 Cosmos DB data and exporting it to CSV.

👁 Connect each Activity in the Flowchart

Click Run to extract Cosmos DB data and create a CSV file.

👁 Running the RPA Flowchart

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