Activation and setup

The Process Drafter is disabled by default and must be manually enabled by an ADONIS administrator. This chapter explains how to activate and configure it.

• First, make sure all prerequisites are met.

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

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

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

• You can also configure additional settings. For example, you can manage which users can access the Process Drafter or define additional relations for process steps.

Prerequisites

Before you can run the Process Drafter, there are a few prerequisites:

• Access to ADONIS Enterprise BPM Suite: The Process Drafter is included for all ADONIS Enterprise Edition customers at no extra cost.

• Supported ADONIS versions: The Process Drafter is available for ADONIS 17.0 or higher. If you are using an older version of ADONIS, the Process Drafter cannot be installed or used.

• Library requirement: The Process Drafter requires the ADONIS BPMS Library 17.0 or higher, or another library updated to the same standard. Otherwise, the Process Drafter 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.

• ADONIS installed with SSL: On-premise customers need to make sure to configure SSL/TLS support on Tomcat. SaaS customers don't have to worry about this, as all SaaS deployments are already set up to use SSL/TLS for encrypting data transmitted between the client and the server.

Enable Process Drafter

To activate the Process Drafter 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. Configure the Base URL:

   On-premise customers must configure the Base URL.

   • Go to Settings > System settings > System.

   • In the Base URL box, enter the HTTPS URL where ADONIS can be reached from other machines.

   • Click Save.

   SaaS customers can skip this step, as the Base URL is set automatically during deployment.

3. Access the Process Drafter settings:

   • Go to Settings > Process Drafter > General.

4. Check the configuration (ADONIS 17.1 or higher):

   • At the top of the page, ADONIS displays whether the required configuration for activating the Process Drafter 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.

     • The Base URL in on-premise deployments must be set manually in any case (see step 2. above).

5. Add the registration key:

   On-premise customers must request a registration key from the BOC Group Hotline before enabling the Process Drafter.

   • 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.

6. Enable the Process Drafter per repository:

   The Registration key can be used to activate the Process Drafter for up to 10 repositories.

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

   • Click Save to apply the changes.

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

Allow the Process Drafter URLs on Your Firewall

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

note

The Process Drafter 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 Process Drafter 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 the Process Drafter functions correctly within the ADONIS interface.

Look up URLs

To find the configured URLs for the Process Drafter:

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 Drafter configuration.

Add URLs to Firewall Allowlist

Add the following URLs to your firewall's allowlist:

• The AWS Cognito URL (as identified above)

• The Process Drafter 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 the Process Drafter. 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.1 or higher)

• Manual Configuration (for ADONIS 17.0 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.1 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 Drafter > General.

2. At the top of the page, ADONIS displays whether the required configuration for activating the Process Drafter 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 OAuth 2.0 client & Enable CORS

     • Enable RESTful services

     • Configure AWS Cognito connector

   • The Base URL in on-premise deployments must be set manually in any case (see Enable Process Drafter).

Manual Configuration

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

• Enable RESTful services

• Enable CORS

• Configure OAuth 2.0 client

• Import AWS Cognito configuration

Enable RESTful services

1. In the ADONIS Administration, go to Settings > Standard RESTful services > General.

2. Select the Enable Standard RESTful Services globally check box.

3. Switch to the OAuth 2.0 tab and configure the following settings:

   • Select the Enable OAuth 2.0 check box.

   • Under Repository scenarios, enable all available APIs.

   • Under Metamodel scenarios, enable Metamodel read APIs.

4. Click Save.

Enable CORS

1. In the ADONIS Administration, go to Authentication > More options > Security Settings.

2. On the General tab, select the Allow CORS check box.

3. On the REST tab, select the Allow CORS check box.

4. Click Save.

Configure OAuth 2.0 client

Look up the Redirect URI

Before you can add the OAuth 2.0 client in the next step, you need to look up the Redirect URI for the Process Drafter.

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

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

3. Open the Constants tab, copy the URL from the pw_tool_url parameter and save it for later use as the Redirect URI. Then, close the configuration.

Add the OAuth 2.0 client

1. In the ADONIS Administration, go to Authentication > OAuth 2.0

2. Select the Enabled check box.

3. Click Create to add a new client and configure the following settings:

   • Type: Select public.

   • ID: ProcessDrafterAppID

   • Name: Process Drafter

   • Redirect URI: Paste the Redirect URI you looked up earlier.

   • Logo: Optionally upload a logo representing the Process Drafter.

   • Secret: Click Generate to create a new secret.

4. Click OK to confirm. Back on the OAuth 2.0 page, click Save.

Import AWS Cognito configuration

On-premise customers must import the new AWS Cognito configuration.

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 AWS Cognito configuration.

   • 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 configuration.

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 application server and the web application, the Process Drafter can be used.

Additional settings

The following additional settings are available:

Grant or deny access to the Process Drafter

Access to the Process Drafter is managed via system roles. By default, it’s 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 Drafter

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

Configure available relations for process steps

When creating a process draft, users can enrich individual steps (= the Tasks required to complete the process) by adding related information. By default, the following relations are available:

• Responsible for execution to assign responsible roles

• Referenced applications/IT system elements to link applications

As an administrator, you can configure which relations are available for users to add to steps:

1. In the ADONIS Administration, go to Settings > Process Drafter > Configuration.

2. On the Process Drafter - Configuration page, select the relations you want users to be able to add to each step.

   • Use the search box to quickly find a specific relation.

   • Expand a relation to restrict which object types are allowed as targets:

     • If you select specific object types, only these can be added by users.

     • If no object types are selected, all are allowed.

3. Click Save to apply your changes.

Delete Process Drafter data for a repository

To permanently remove all repository-specific Process Drafter data:

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

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

3. When prompted to continue, click Clear repository data.