Subscribe

UiPath Process Mining

The UiPath Process Mining Guide

Connector Development Guide

Introduction

This document aims to guide you through the different steps of developing a Connector for UiPath Process Mining.

Prerequisites

Before getting started with this guide, make sure your chosen process and data source are suitable for a Process Mining implementation. Process Mining requires:

  • an activity to define the performed process events;
  • a timestamp to show when each step happened,
  • an identifier to tie all events in one process execution.

📘

Note

Without one of these three mandatory elements, a Process Mining analysis is not possible. Therefore, it is important to know the tables and fields of your data before getting started.

Data transformation

Process Mining is a solution that transforms data from your IT systems into visual interactive dashboards, allowing you to see existing value decreases, bottlenecks, and discrepancies, as well as understanding the root causes and possible risks. For these dashboards to be available, the Process Mining developer has to execute several steps. See App and Discovery Accelerator development.

Data model

Many of these steps are part of the data transformation process. This transformation is necessary since Process Mining requires the data in the form of an event log to be able to visualize it. This format is called the data model. The data model describes the tables and attributes that need to be part of the output dataset generated by the connector. However, most source systems do not provide data in this format. Therefore, it is necessary to transform the data.

Connectors

To help with the data transformation, Process Mining has created several connectors which can be used as a template for loading, cleaning, and transforming data. These pre-built connectors are specific for a certain system and process such as the SAP Purchase-to-Pay Connector for AppOne. See Introduction to SAP Connector for Purchase-to-Pay Discovery Accelerator.

When starting with a new project, it is recommended to check whether you can make use of UiPath pre-built connectors. In the simplest cases, the input data fits directly with one of the connectors, and there is no need for a custom connector. If neither of these options are applicable, you will need to build a connector yourself.

Building a connector

The goal of a connector is to produce a dataset that fits the data model. The most standard Process Mining data model consists of a Cases and an Event log table. Alternative data models consist of several Entity and Events tables. Independent of the data model, we recommend structuring the first transformation steps of the connector as listed below.

Step

Description

1. Input

Define the raw data from the source system in the connector.

2. Entities

Define the entities relevant to the process.

3. Events

Define the events that happen for the entities.

If Event log, Tags, or Due dates are part of the data model, the following two transformation steps must be performed.

Step

Description

4. Event log

Combine events for different entities in one event log.

5. Business data

Define tags and due dates.

The last transformation step in any connector is defining the output that corresponds to the data model.

Step

Description

6. Output

Transformed data that fits the data model.

About this guide

This guide leads you through the steps to create these different sections and provides you with conceptual explanations as well as tips and tricks for the actual implementation. The guide is written in a generic way so that you can apply it to any kind of process and system. To successfully follow this guide, make sure you are familiar with your input data and its underlying model.

Updated about a month ago

Connector Development Guide


Suggested Edits are limited on API Reference Pages

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