Process Mining

DELIVERY:

Last updated Sep 18, 2025

Installing the UiPath data extractor

The UiPath on-premises data extractor must be installed within the same network environment as the data source (e.g., the SAP system). For example, if SAP is hosted in a private cloud or data center, the UiPath data extractor should be deployed within that same environment or network segment to ensure reliable and secure connectivity.

Note:

If installing the UiPath data extractor within the same network as the SAP system is not feasible, it is possible to install it outside the private network. In that case, you must open the required ports (e.g., 33<xx>) on the SAP system, where <xx> corresponds to the SAP system number, to allow inbound and outbound communication between the UiPath data extractor and the SAP server.

If a proxy is used, it must forward the same 33<xx> port from the proxy to the corresponding 33<xx> port on the SAP system. This is because the Theobald RFC does not support connecting to custom or remapped ports—it expects to connect using the default port format based on the SAP system number.

Refer to the official Theobald documentation on port requirements for more information.

Installing the Uipath on-premises data extractor involves the following steps.

Set up your UiPath Automation Cloud organization.
Install the UiPath data extractor in your on-premises environment.
Install the the Theobald RFC on your SAP server.
Note: This step is required only when installing the UiPath data extractor for SAP data extraction.

1. Setting up the UiPath Cloud organization

Follow these steps to set up the UiPath Cloud organization for the Uipath data extractor.

In Automation Cloud, go to Admin.
Select the External applications tile, to add an external application.
On the OAuth apps tab, select +Add application.
Enter a descriptive name for the new application in the Application name field. For example, "Process Mining on-prem extractor".
Select +Add scopes.
1. Select Process Mining API access from the list of Resources.
2. Select Application scope(s) and select the ProcessMining.DataExtractor option to enable access to Process Mining.
3. Select Save.
In the Add application page, select Add. A confirmation message is displayed
Copy and paste the App ID and App secret, for example in Notepad.
Note: You will need the App ID and App secret during the installation of the on-premise data extractor in the on-premises environment.
Select Close.

2. Installing the UiPath data extractor in the on-premises environment

Prerequisites

The UiPath on-premises data extractor requires the .NET 8 ASP.NET Core Runtime to be installed. You can download the latest version from the official Microsoft .NET website.

Downloading the UiPath on-premises data extractor

Use the following link to download the UiPath on-premises data extractor:

https://uipath.blob.core.windows.net/download/UiPathDataExtractor.zip

Installation steps

Extract the installation package.
Open PowerShell as administrator in the extracted folder.
Configure DataExtractor/appsettings.json with your settings.
Note: You will need the App ID and App secret saved when setting up the UiPath Cloud organization.

Important: Make sure that the user credentials defined in the ConnectionString have access to the tables you want to extract.
```
{
"UiPathURL": "https://cloud.uipath.com/<OrgName>/<TenantName>",
"S2S": {
    "ClientId": "<Application id from UiPath admin portal>",
    "ClientSecret": "<Application secret from UiPath admin portal>"
},
"LogFilePath": "<OPTIONAL: Path to log file, otherwise will be in /Logs>",
"Connections":[
   {
     "Type": "sapOnPrem",
     "Name": "<Connection Name>",
     "ConnectionString": "USER=<User>;PASSWORD=<Password>;LANG=<Language>;CLIENT=<ClientNumber>;HOST=<Host IP address>;SYSNR=<System number>;FUNCTIONMODULE=<Function module name>;"
   },
    {
      "Type": "sqlServer",
      "Name": "<Connection Name>",
      "ConnectionString": "Server=<ServerAddr>;Initial Catalog=<DatabaseName>;User Id=<User>;Password=<Password>;"
    }
 ]
}{
"UiPathURL": "https://cloud.uipath.com/<OrgName>/<TenantName>",
"S2S": {
    "ClientId": "<Application id from UiPath admin portal>",
    "ClientSecret": "<Application secret from UiPath admin portal>"
},
"LogFilePath": "<OPTIONAL: Path to log file, otherwise will be in /Logs>",
"Connections":[
   {
     "Type": "sapOnPrem",
     "Name": "<Connection Name>",
     "ConnectionString": "USER=<User>;PASSWORD=<Password>;LANG=<Language>;CLIENT=<ClientNumber>;HOST=<Host IP address>;SYSNR=<System number>;FUNCTIONMODULE=<Function module name>;"
   },
    {
      "Type": "sqlServer",
      "Name": "<Connection Name>",
      "ConnectionString": "Server=<ServerAddr>;Initial Catalog=<DatabaseName>;User Id=<User>;Password=<Password>;"
    }
 ]
}
```
Run the installation script using the following Powershell command: ./Setup.ps1 -Install.

Tip: For additional script options, you can use the following Powershell command: ./Setup.ps1 -Help

3. Installing the Theobald RFC on your SAP server

Theobald Xtract Universal is the SAP certified extraction tool used for data extraction from SAP source systems, integrating with SAP through Remote Function Calls (RFC). Theobald Xtract Universal contains the read-only custom function module Z_THEO_READ_TABLE-transport1 that is to be installed in SAP.

The XtractCore/Transports folder of the UiPath data extractor contains multiple versions of Remote Function Calls (RFCs) used to read tables, along with a README file that provides details about each version.

Refer to Setting up Theobald Xtract Universal (Steps 2 - 4) for more information on configuring the SAP environment to run with the UiPath data extractor.

On this page