Subscribe

UiPath Process Mining

The UiPath Process Mining Guide

Connector Development Kit

Introduction

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

Prerequisites

It is assumed you are familiar with UiPath Process Mining and the Basic Connector.
Please refer to the UiPath Academy or the Basic Connector documentation.

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 steps performed in the process;
  • a timestamp to show when each step happened,
  • a case ID to tie all events to the right cases.

📘

Note

Without one of these three mandatory elements, a Process Mining analysis is not possible. Therefore, it is important to know the tables, including keys and foreign keys, 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. In order for these dashboards to be available, the Process Mining developer has to execute several steps (see From Data to Dashboard).

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. However, most source systems do not provide data in this format.

Connectors

To help with the data transformation, Process Mining has Connectors which can be used as a template for loading, cleaning, and transforming data. The goal of a connector is to produce a dataset that fits the format required by AppOne or a Discovery Accelerator.

📘

Note

This guide focuses on building a connector for AppOne.

Process Mining provides several pre-built Connectors which are specific for a certain system and process, for example, the SAP Purchase-to-Pay Connector for AppOne. Additionally, Process Mining also supplies the generic Basic Connector which expects input data in the case and event format.

When starting with a new project, it is recommended to check whether you can make use of the pre-built Connectors or whether your input data fits the structure of the Basic Connector. 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 is applicable, you need to build one yourself.

Building a Connector

When developing your own connector, it is recommended to not completely start from scratch but to use the Basic Connector as a template. Following the structure of the Basic Connector ensures that the created event log fits the format required by AppOne.

You can extend the Basic Connector to match your source data by adding additional table groups to the Basic Connector. See the illustration below for a recommended structure of your Connector.

Connector framework

Hover over the image and click to go to the related page in the documentation.

1. Input 2. Entities 3. Event creation 4. Business data input 5. Preprocessing 6. Output

Below is a description of the different table groups of the Connector.

Table group

Description

1. Input

Load your input data into the Connector.

2. Entities

Calculate the entities of your process.

3. Event creation

Calculate the events relevant for your process.

4. Business data input

Load the input data for tags, due dates, and reference models.

5. Preprocessing

Enhance the data and add business value.

6. Output

The final data that will be exported and loaded into AppOne.

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. Practical examples and different scenarios throughout the guide aim to visualize the different concepts. To successfully follow this guide, make sure you are familiar with your input data and its underlying model.

Updated 15 days ago


Connector Development Kit


Suggested Edits are limited on API Reference Pages

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