Subscribe

UiPath Process Mining

The UiPath Process Mining Guide

Deliverables

This page describes the required content for a released connector.

Introduction

A UiPath Process Mining Connector consists of the following deliverables. Each deliverable is described in more detail on the corresponding pages.

  • Extractors to extract data from a source system, see Extractors.
  • Transformations to transform the source data into a given data model, see Transformations.
  • Datasets to make it easy to use and validate the connector, see Datasets.
  • Documentation to explain how to use and customize the connector, see Documentation.
  • Scripts to automate the extraction, transformation, and loading of data into an app, see Scripts .
  • Tests to validate whether transformations are applied correctly, see Tests.

Repository

A Process Mining Connector is stored in a repository with a standardized directory structure. The UiPath/ProcessMining-devkit-connector repository should be used as a template and already contains the correct structure and files. Below is an overview of the structure of the UiPath/ProcessMining-devkit-connector repository.

File/folderDescriptionMore information
.vscode\Contains Visual Studio Code setting files.The Visual Studio Code documentation
documentation\Connector & App Framework 0.8.1
Contains:
system_specific.md which describes how to connect to the source system, to extract, and transform the data to a process data model.
process_specific.md which describes the overall process that is outputted by this connector.

Connector & App Framework 0.8.
Contains:
connector_documentation.md which describes how to use the connector.
Documentation
extractors\Contains folders with descriptions of extraction methods for this connector.Extractors
sample_data\Contains a sample dataset.Datasets
scripts\Contains the scripts necessary to automate running the connector.Scripts
transformations\Contains a the dbt project that defines the transformations.Transformations
.gitignoreThe .gitignore file.The official Git documentation
README.mdContains an introduction to the connector.
license.txtContains the license information for the connector.
settings.jsonContains settings for this connector.
third-party_licenses.txt*Contains licenses for all third party tools used as part of the connector, directly or indirectly.

* third-party_licenses.txt is available from version 0.8.1.

Settings.json (Connector & App Framework 0.8.1)

The settings.json file contains the following fields:

  • framework-version: the version of the Connector & App Framework that was used to create this connector.
    Below is an example settings.json.
{
   "framework-version": "1.0"
}

Settings.json (Connector & App Framework 0.8)

The settings.json file contains the following fields:

  • name: the display name of the connector.
  • app: a reference to the repository of the implemented app.
  • framework-version: the version of the Connector & App Framework that was used to create this connector.

Below is an example settings.json.

{
  "name": "SAP connector for Purchase-to-Pay Discovery Accelerator",
  "app": "P2P-app",
  "framework-version": "1.0"
}

Updated 5 months ago

Deliverables


This page describes the required content for a released connector.

Suggested Edits are limited on API Reference Pages

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