UiPath Process Mining

The UiPath Process Mining Guide

Setting up a development environment


If you want to develop or customize a SQL connector, you need a set of development tools. This page describes the installation instructions for these tools on a (local) development environment to be able to start developing.

For more information on setting up separate development and production environments, see Separate development and production environments.

Microsoft SQL Server

The main component, that is used in all parts of the SQL connector is the database. Microsoft SQL Server is the required database. You can download Microsoft SQL Server from the official Microsoft SQL Server downloads webpage.
The license for Microsoft SQL Server is not included in the UiPath Process Mining license, and needs to be acquired separately.
For help on installing SQL Server, refer to the official Microsoft SQL Server documentation.

SQL Server Management Studio (SSMS)

To view the database tables and to manage the SQL Server infrastructure, you can download SQL Server Management Studio (SSMS), which can be installed on any computer.

After installation, make sure to:

  • Create a user account for each developer that needs to have access to a database.
  • Set up different schemas per user per connector. This will make sure developers do not interfere with each other's work while running transformations during development.

Visual Studio Code

Visual Studio Code is the recommended code editor. You can download Visual Studio Code from Download Visual Studio Code webpage. Visual Studio Code supports extensions to increase productivity and cater to your workflow. SQL connectors will give you recommendations for extensions if edited using Visual Studio Code.

CData Sync

Most SQL connectors use CData Sync to extract data from the source system and to store it in the SQL Server database.

See Installing CData Sync.

It is also possible for the SQL connector scripts to make use of CData Sync. See Running CData Sync with scripts.


Dbt is used to run the transformations in a SQL connector to transform the input data into data that can be loaded into the Process Mining.
See Installing dbt for information on how to install dbt.
After installation, dbt needs to be configured. See Running a dbt project.

It is also possible to use dbt in the scripts. See Running dbt with scripts.


See the illustration below for an overview of the development setup.



Git is recommended as a version control system. A version control system gives you the possibility to make changes to a SQL connector and develop it in collaboration. You can download Git from the official Git download webpage and install it on a local server. You can also use a hosted Git service, like GitHub.

Process Mining

For dashboard development and creating app releases, you also need to have a Process Mining installation with access to the Git repository.

This Process Mining installation is also required for running cache generation with the SQL connector scripts. See also Generating a cache with scripts.

Updated 6 months ago

Setting up a development environment

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.