Skip to main content

Get help for ARIS Process Mining functions and services

Create a system integration for the data ingestion API

To use the data ingestion API, you must create a corresponding system integration.

ARIS Process Mining supports the OAuth2 Flows with Client credentials and Authorization code grant types as authentication methods.

The authentication methods with client credentials is outside of a context of a user and is recommended for machine-to-machine communication.

Prerequisite

You have installed the ARIS Process Mining Enterprise license.

Procedure. Procedure

  1. Click the Navigation menu Navigation menu icon > administration Administration in the program header.

  2. Click system integration System integration in the Administration panel.

  3. Click system integration Add system integration > Data ingestion (API). The corresponding dialog opens.

  4. Enter a name, for example, Data ingestion, and an optional description.

  5. Select an authentication method in the Grant type (OAuth) drop-down menu.

    Client credentials as authentication method is recommended. It is intended for machine-to-machine communication and is outside of the context of an actual log-in user.

    If you select the Authorization code grant type, specify the Authorization callback URL that is used for authentication.

    https://<region.ariscloud>/umc/rest/oauth/callback?tenant=<project_room>&provider=umc

    Replace hostname <region.ariscloud> with the hostname of the ARIS Process Mining installation and the <project_room> with the ARIS Process Mining project room you want to login to.

    You can read the hostname of the URL (for example, processmining.ariscloud.com) in the browser address bar if you are logged in.

    Examples

    Authorization callback URL for the ARIS cloud

    https://processmining.ariscloud.com/umc/rest/oauth/callback?tenant=myprojectroom&provider=umc

    Authorization callback URL for the ARIS Enterprise cloud

    https://<my_company_name>.ariscloud.com/umc/rest/oauth/callback?tenant=<project_room>&provider=umc

  6. Click Add. The Data ingestion access data dialog opens. The dialog provides the client ID, secret key, and project room name.

    If you have selected the Authorization code grant type the well-known URL is additionally shown.

  7. You can save the provided authentication data, for example, using a text editor.

    Click Copy to clipboard and save the data.

  8. Click Done.

The system integration is created and listed with the name you specified.

Note that the system integration of the data ingestion API remains in the Pending state by default. However, you can use the system integration properly.

Tip

The access data (except for the endpoints) is saved in the system integration you created. You can display the source system access data to access the client credentials key.