Manage applications

You can manage applications. You can add and delete applications from the system.

Use application management for certain functions or systems in the ARIS environment. The application management registers and manages the systems you require. This way you make ARIS Process Mining or SAP applications known as trustworthy at ARIS.

The Applications page shows the applications available. The installed applications are marked as Internal. Internal applications cannot be deleted. Applications that you have added are marked as External.

Create application

You can create and register a customer-specific application. Internal applications are automatically installed when you install the system.

Prerequisite

You have the User administrator function privilege.

Procedure

  1. Open the Application management page.

    1. Click Application launcher Application launcher > Administration Administration. The Configuration Configuration view is shown.

    2. Click Applications Applications. The Application management page opens.

  2. Click Add Add application. The application details page opens.

  3. Enter the name, the description, and the scope of the application. The scope is required input.

  4. Click Save. The application is created. The Client ID and the Client secret are displayed.

    You can copy them to register ARIS in this application as trustworthy.

  5. Click Reset Back. The Configuration and modification sets page is displayed.

You can transfer the client ID and client secret to the third-party application.

Edit application

You can edit a customer-specific application. Internal applications cannot be changed.

Prerequisite

You have the User administrator function privilege.

Procedure

  1. Open the Application management page.

    1. Click Application launcher Application launcher > Administration Administration. The Configuration Configuration view is shown.

    2. Click Applications Applications. The Application management page opens.

  2. In the row of the relevant application, click Show application Show application. Click the relevant application.

  3. Click Edit Edit.

  4. Edit the name, description, and scope for the application.

  5. Click Save.

  6. The client ID and the client secret are displayed. You can copy them to use register ARIS in the application.

  7. Click Reset Back. The Configuration and modification sets page is displayed.

You have edited the application.

You can also generate a new client ID and client secret to register ARIS in this application as trustworthy.

Create or edit ARIS Process Mining application

If you use ARIS Process Mining in a combined deployment with ARIS Enterprise and you have the ARIS Process Mining license, you do not have to configure the integration of ARIS and ARIS Process Mining.

You can create the connection to an ARIS Process Mining system. There are two possible scenarios. The first scenario is that you create the application in ARIS. Then ARIS serves as the authorization server and ARIS Process Mining is the authorization client. You can then log in to ARIS Process Mining with your ARIS credentials.

The second scenario is that ARIS is created as an application in ARIS Process Mining. ARIS Process Mining serves as the authorization server and ARIS as the authorization client. Then you can log in to ARIS with your ARIS Process Mining credentials. If the corresponding user does not exist in ARIS and the Create user option is enabled in ARIS, then the user will be automatically created in ARIS.

This scenario is described in this procedure.

Prerequisite

  • You have the User administrator function privilege.

  • You have enabled ARIS Process Mining.

Procedure

  1. Open the Application management page.

    1. Click Application launcher Application launcher > Administration Administration. The Configuration Configuration view is shown.

    2. Click Applications Applications. The Application management page opens.

  2. Click the Process mining ARIS Process Mining button. The Details page of the miningserver application opens.

  3. Click the Edit Edit button.

  4. Specify the application settings.

    1. You can enter an optional description, for example, Process conformance check.

    2. Enter the client-credentials key in the corresponding input field.

      Copy the client ID and secret from the ARIS system integration, as shown in step 4. Connect the client ID and secret to the client-credentials key as follows:

      <client ID>/<secret key>

      Example

      ef1bf998-9658-4433-94d6-1fe8209ab36b/81cbce47-1e67-43c3-a26c-764d85a47126

    3. Specify the API scope in the Scopes input field. If you register ARIS Process Mining to perform a conformance check, add the ConformanceCheck API scope.

    4. Click Save.

  5. Click Reset Back. The Configuration and modification sets page is displayed.

You have all data that you need to enter in the ARIS Process Mining system. As soon as the data is entered in ARIS Process Mining, you can log in to ARIS with your ARIS Process Mining credentials.

Display application details

You can display the details of an application.

Prerequisite

You have the User administrator function privilege.

Procedure

  1. Open the Application management page.

    1. Click Application launcher Application launcher > Administration Administration. The Configuration Configuration view is shown.

    2. Click Applications Applications. The Application management page opens.

  2. Click the relevant application. The application details page opens.

The application details are displayed.

You can generate a new Client ID and Client secret.

Generate client ID and client secret

You can generate a new client ID and a new client secret for an application.

Prerequisite

You have the User administrator function privilege.

Procedure

  1. Open the Application management page.

    1. Click Application launcher Application launcher > Administration Administration. The Configuration Configuration view is shown.

    2. Click Applications Applications. The Application management page opens.

  2. Click the relevant application. The application details page opens.

  3. Click Generate client ID and client secret Generate client ID and client secret. You have generated a client ID and a client secret for the application.

    You can copy and use them with the application.

  4. Click Reset Back. The Configuration and modification sets page is displayed.

You can transfer the client ID and client secret to the third-party application.

Refresh application list

You can refresh the list of registered applications.

Prerequisite

You have the User administrator function privilege.

Procedure

  1. Open the Application management page.

    1. Click Application launcher Application launcher > Administration Administration. The Configuration Configuration view is shown.

    2. Click Applications Applications. The Application management page opens.

  2. Click Refresh Refresh.

The list of registered applications is refreshed.

Display active sessions

You can display the active sessions for an application.

Prerequisite

You have the User administrator function privilege.

Procedure

  1. Open the Application management page.

    1. Click Application launcher Application launcher > Administration Administration. The Configuration Configuration view is shown.

    2. Click Applications Applications. The Application management page opens.

  2. Click the relevant application. The application details page opens.

  3. Click Active sessions.

The active sessions for an application are displayed.

You can terminate applications.

Refresh active sessions

You can refresh the list of the active sessions for an application.

Prerequisite

You have the User administrator function privilege.

Procedure

  1. Open the Application management page.

    1. Click Application launcher Application launcher > Administration Administration. The Configuration Configuration view is shown.

    2. Click Applications Applications. The Application management page opens.

  2. Click the relevant application. The application details page opens.

  3. Click Active sessions.

  4. Click Refresh Refresh.

The list of the active sessions for an application is refreshed.

Terminate all active sessions

You can terminate all active sessions of an application.

Prerequisite

You have the User administrator function privilege.

Warning

Note that if you terminate an internal application, your system could no longer work as expected.

Procedure

  1. Open the Application management page.

    1. Click Application launcher Application launcher > Administration Administration. The Configuration Configuration view is shown.

    2. Click Applications Applications. The Application management page opens.

  2. Click the relevant application. The application details page opens.

  3. Click Active sessions.

  4. Click Log out application Close application.

All sessions of the application are terminated.

Display history

You can display the history of an application.

Prerequisite

  • You have the User administrator function privilege.

  • You have the Log application changes option enabled.

Procedure

  1. Open the Application management page.

    1. Click Application launcher Application launcher > Administration Administration. The Configuration Configuration view is shown.

    2. Click Applications Applications. The Application management page opens.

  2. Click the relevant application. The application details page opens.

  3. Click History.

The application history is displayed. All changes to the application are listed, for example, creating or updating the application.

Refresh application history

You can refresh the history of an application.

Prerequisite

You have the User administrator function privilege.

Procedure

  1. Open the Application management page.

    1. Click Application launcher Application launcher > Administration Administration. The Configuration Configuration view is shown.

    2. Click Applications Applications. The Application management page opens.

  2. Click the relevant application. The application details page opens.

  3. Click History.

  4. Click Refresh Refresh.

The history of an application is refreshed.

Delete application

You can delete a customer-specific application. Internal applications cannot be deleted.

Prerequisite

You have the User administrator function privilege.

Warning

The application is deleted. If any active sessions are generated or exist for the application, the sessions are also deleted. The sessions used become unusable.

Procedure

  1. Open the Application management page.

    1. Click Application launcher Application launcher > Administration Administration. The Configuration Configuration view is shown.

    2. Click Applications Applications. The Application management page opens.

  2. In the row of the relevant application, click delete Delete application.

The application is deleted.

Scopes

Scopes and APIs are created when you start the umcadmin_<size: s, m, or l> runnable. This server component manages users, permissions, licenses, LDAP connectivity and SSO.

Each scope has one or more APIs. You can display the details of a scope.

Available scopes

  • Conformance check

    The Conformance check scope is implemented to fit to the ARIS Process Mining conformance checks. A process conformance analysis analyzes whether an executed and measured process instance of a production system is conformant with a designed process model in ARIS.

  • Default

    The Default scope is used to authenticate and establish the communication between the components of the installed system. These applications are marked as internal.

  • Export

    The Export scope is designed for applications that intend to consume the export API of Tenant Management.

  • Extractor

    The Extractor scope is designed to import data from ARIS Process Mining and SAP if they are integrated into ARIS.

    The Extractor scope enables the import of ARIS Process Mining and SAP data if they are integrated into ARIS.

  • Import

    The Import scope is designed for applications that intend to consume the import API of Tenant Management to import data.

  • UserProfile

    The UserProfile scope is designed to share the user token with the client applications and allow them to invoke the APIs intended for them.

  • ConformanceCheck

    The ConformanceCheck scope is designed for the ARIS Process Mining conformance check process.

  • MiningPubApi

    The public API enables the upload of external data into ARIS Process Mining.

  • ARIS Connector for SAP Solutions

    If you are using ARIS in a cloud scenario, such as ARIS Enterprise edition, you must install ARIS Connector for SAP Solutions to exchange data between ARIS and SAP® Solution Manager 7.2 without a VPN connection.

Prerequisite

You have the User administrator function privilege.

Procedure

  1. Open the Application management page.

    1. Click Application launcher Application launcher > Administration Administration. The Configuration Configuration view is shown.

    2. Click Applications Applications. The Application management page opens.

  2. Click Scopes.

  3. Click the relevant scope.

The scope details are displayed.

To display the history of a scope, click History. If you want to ensure that you see all modifications that are made meanwhile, click Refresh Refresh.

APIs

You can display the details of an API.

Available APIs

  • Dataset

    The Dataset API enables the query of SAP data records.

  • Export

    The Export API enables the export of data from Tenant Management.

  • Extractor

    The Extractor API enables the integration of ARIS Process Mining and SAP.

  • Import

    The Import API enables the import of data into Tenant Management and thus into User Management.

  • Token

    The Token API enables access to User Management using OAuth authentication.

  • MiningPubApi

    The Public API enables the upload of external data into ARIS Process Mining.

  • ARIS Connector for SAP Solutions

    If you are using ARIS in a cloud scenario, such as ARIS Enterprise edition, you must install ARIS Connector for SAP Solutions to exchange data between ARIS and SAP® Solution Manager 7.2 without a VPN connection.

Prerequisite

You have the User administrator function privilege.

Procedure

  1. Open the Application management page.

    1. Click Application launcher Application launcher > Administration Administration. The Configuration Configuration view is shown.

    2. Click Applications Applications. The Application management page opens.

  2. Click APIs.

  3. Click the relevant API.

The API details are displayed.

To display the history of an API, click History. If you want to ensure that you see all modifications that are made meanwhile, click Refresh Refresh.