Activation and setup

ADONIS Process Mining Essentials (PME) is disabled by default and must be manually enabled by an ADONIS administrator. This chapter explains how to activate and configure PME.

• First, make sure all prerequisites are met.

• If you're working with a fresh installation of ADONIS 17.0 or higher, enabling PME for specific repositories is straightforward — and likely the only step needed.

• Organisations that restrict outbound connections must allow the PME URLs through their firewall.

• If you're migrating from an earlier ADONIS version, follow the extra configuration steps to enable PME.

• You can also configure additional settings. For example, you can manage which users can access PME or remove all repository-specific PME data.

Prerequisites

Before you can run process mining with ADONIS PME, the following prerequisites must be met:

• Access to the ADONIS Enterprise BPM Suite: PME is an add-on for the ADONIS Enterprise Edition, so you need to have access to this edition.

• Supported ADONIS versions: PME is available for ADONIS 17.0 or higher. If you are using an older version of ADONIS, the add-on cannot be installed or used.

• Library requirement: PME requires the ADONIS BPMS Library 17.0 or higher, or another library updated to the same standard. Otherwise, the add-on cannot be installed or used.

Library requirements for ADONIS upgrades

Customers who have upgraded from an earlier ADONIS version but kept their old database must ensure that a library upgrade was performed.

• Event log data: PME analyses event log data, but does not provide the data itself.

Remarque

For testing purposes, you can use the following sample event logs to explore the capabilities of ADONIS PME:

• Purchase-To-Pay (CSV file)
• Defect Reparation (XES file)

Enable PME

To activate PME in your ADONIS environment:

1. Open the ADONIS Administration with your administrator account:

   • Enter the HTTPS URL where ADONIS is available, click Administration, enter your credentials and log in.

   • If you’re already logged in to ADONIS and want to switch to the ADONIS Administration, click the user symbol in the upper-right corner, and then click Administration.

2. Access the PME settings:

   • Go to Settings > Process Mining Essentials > General.

3. Check the configuration (ADONIS 17.2 or higher):

   • At the top of the page, ADONIS displays whether the required configuration for activating PME is valid or invalid.

   • If settings are missing, expand the hierarchy to view details and resolve issues.

     • You can click Configure automatically to apply missing settings automatically or perform a manual configuration.

4. Add the registration key:

   On-premise customers who purchase ADONIS PME must request a registration key from the BOC Group Hotline before enabling PME.

   • Click Request registration key. Your email client will open with a pre-filled message.

     • Replace [Enter company name] with your actual company name.

     • The Database ID and Base URL boxes are filled in automatically and should not be changed.

   • Send the email to the BOC Group Hotline.

   • You will receive a link to a secure file transfer portal where you can download the registration key.

   • Paste the key into the Registration key box.

   SaaS customers can skip this step, as the registration key will be handled by our Cloud Operations team.

5. Enable PME per repository:

   The Registration key can be used to activate PME for up to 10 repositories.

   • Under Repository name, select the repositories for which PME should be enabled.

   • Click Save to apply the changes.

PME will now be available to users logging into the selected repositories in ADONIS (see Open ADONIS PME).

Allow the PME URLs on Your Firewall

Customers who want to use PME must ensure that specific URLs are allowed through their firewall. You'll need to identify the configured URLs for PME in the ADONIS Administration and add them to your allowlist.

Remarque

PME is embedded into ADONIS via an iframe, which causes the user's browser to establish direct connections to external services such as AWS Cognito and the PME API.

While the required public service URLs are often allowed by default in many network environments, you may need to manually allow these URLs if your organisation enforces outbound restrictions, particularly from user devices or browsers.

This applies to both SaaS and on-premise deployments and ensures that PME functions correctly within the ADONIS interface.

Look up URLs

To find the configured URLs for PME:

1. In the ADONIS Administration, go to Settings > More options > Connect Center.

2. In the left pane, under Connectors, select the AWS Cognito configuration, and then click Open configuration dialog.

3. Open the Technical Settings tab, copy the URL from the URL box and save it for later use. Then, close the configuration.

4. Repeat steps 2 - 3 for the Process Mining Essentials configuration.

Add URLs to Firewall Allowlist

Add the following URLs to your firewall's allowlist:

• The AWS Cognito URL (as identified above)

• The Process Mining Essentials URL (as identified above)

Additional setup for migrated ADONIS installations

If you are upgrading from an earlier ADONIS version, additional configuration steps are required to enable PME. These settings are already preconfigured in fresh installations of ADONIS 17.0 or higher and can be skipped in that case.

Depending on your ADONIS version and setup preferences, there are two ways to complete the extra configuration steps required for migrated ADONIS installations:

• Automatic Configuration (recommended for ADONIS 17.2 or higher)

• Manual Configuration (for ADONIS 17.0/17.1 or advanced control)

No matter which option you choose, you will need to perform some finishing touches afterwards:

• Final Steps

Choose either the automatic or manual configuration, complete the final steps, and you’re good to go!

Automatic Configuration

If you are using ADONIS 17.2 or higher, the recommended way to complete the extra configuration steps for migrated ADONIS installations is to let ADONIS handle everything automatically:

1. In the ADONIS Administration, go to Settings > Process Mining Essentials > General.

2. At the top of the page, ADONIS displays whether the required configuration for activating PME is valid or invalid.

   • The overall status should be invalid.

   • Expand the hierarchy to view the individual status of the required settings.

3. Click Configure automatically.

   • A background script will run and perform the following tasks:

     • Configure AWS Cognito connector

     • Configure Process Mining Essentials connector

Manual Configuration

If you are using ADONIS 17.0/17.1 or prefer to perform the configuration manually, follow these steps to complete the extra configuration steps for migrated ADONIS installations:

• Import connector configurations

Import connector configurations

On-premise customers must import new connector configurations.

1. In the ADONIS Administration, go to Settings > More options, and then click Import settings.

2. Click Browse and select the file ADONIS <version> - BPMS AL Standard Component Setting.axs, which contains the connector configurations.

   • You can find this file in the <04 Sample Data/Component Settings> folder of the ADONIS installation package.

   • Alternatively, drag the file from your computer to the Drag and drop files here to upload area.

3. Leave Import all settings unchecked. Scroll down, expand the entry Integration - Data Connectors, and select only the AWS Cognito and Process Mining Essentials configurations.

4. Click Import. When prompted to continue, click Yes. The data is imported.

SaaS customers can skip this step, as the necessary configuration is handled by our Cloud Operations team.

Final Steps

Regardless of whether you used the automatic or manual configuration for migrated ADONIS installations, perform the following final steps:

• Verify web application configuration

• Restart environment

Verify web application configuration

On-premise customers must verify important parameters in a web server configuration file.

1. Navigate to the directory <Tomcat>/webapps.

2. Open the file ADONIS*_*.war with a file archiver.

3. Inside the top-level directory of the archive, open the configuration file adoxx_web.properties in a text editor with administrative privileges.

4. Ensure the following properties exist and include valid, preconfigured values:

   • security.src.frame-src

   • security.src.connect-src

   • security.src.frame-ancestors

If any of these properties are missing or empty, copy the relevant lines (with preconfigured values) from the reference configuration file in the 03 Web Application folder of the ADONIS installation package.

SaaS customers can skip this step, as the parameters will be automatically set during the deployment.

Restart environment

After restarting the web application, PME can be used.

Additional settings

The following additional settings are available:

Grant or deny access to PME

Access to PME is managed via system roles. By default, the add-on is available to users with the "Design & Document" role.

To change who has access:

• In the ADONIS Administration, go to Settings > System settings > Modules.

• Assign the following module to system roles you want to allow access to:

  • Process Mining Essentials

That’s it! All users assigned to those system roles will now be able to access PME in ADONIS.

Delete PME data for a repository

To permanently remove all repository-specific PME data:

1. In the ADONIS Administration, go to Settings > Process Mining Essentials > General.

2. Click the More button to the right of the repository, and then select Clear repository data.

3. When prompted to continue, click Delete.