[BPMN Modeler] Features for Confluence Admins

[BPMN Modeler] Features for Confluence Admins

Features described on this page

Feature

Hosting Type

Release Version

Blogpost

App Configurations

SERVER | DATA CENTER CLOUD

initial

 

Diagram Settings

SERVER | DATA CENTER CLOUD

3.15.0-ENTERPRISE

Space Permissions

SERVER | DATA CENTER CLOUD

initial

Usage Analysis and Upgrade of Existing Diagrams

SERVER | DATA CENTER CLOUD

initial

 

Process Net: Diagram Link Synchronization

SERVER | DATA CENTER CLOUD

3.21.0-ENTERPRISE

 

GitLab Connection

SERVER | DATA CENTER CLOUD

3.10.0-ENTERPRISE

Gitlab Synchronisation mit BPMN und DMN Modeler Enterprise

GitHub Connection

SERVER | DATA CENTER CLOUD

3.41.0-ENTERPRISE

 

App Configurations SERVER | DATA CENTER CLOUD

If you are a Confluence administrator, you may use additional functions of the BPMN Modeler Enterprise App. To access, go to Confluence administration → Manage Apps , find the BPMN Modeler Enterprise app and select Configure.


Diagram Settings SERVER | DATA CENTER CLOUD

|Since 3.15.0-ENTERPRISE.|

On the first pages you can set the default settings for all newly created BPMN diagrams. Still, you are able to change these setting for each diagram via the diagram configuration afterwards without affecting other macros.

For more information about diagram Settings, see in this manual in Configuration.

 

image-20260309-161121.png

 


Space Permissions SERVER | DATA CENTER CLOUD

Under the Space Permissions Tab, you have the option to restrict the use of BPMN Modeler Enterprise to certain spaces. This way, the creation and editing of BPMN diagrams is only permitted in the whitelisted Confluence spaces.

image-20240419-132357.png

 

 


Usage Analysis and Upgrade of Existing Diagrams
SERVER | DATA CENTER CLOUD

In the Upgrade Tab you can upgrade all macros created with our BPMN Modeler Free to BPMN Modeler Enterprise macros. With one click, a bulk upgrade is started. Please note, that this upgrade might take a while depending on the number of diagrams.

The usage analysis searches your Confluence instance for instances of BPMN Modeler Free and Enterprise macros and displays the results in a table. This can be used to get an overview, for example before or after starting the upgrade.

Important (if on Data Center): After completing the Upgrade procedure, it is necessary to perform a Content Re-Indexing.

image-20240419-131824.png

 

Note on permissions:
The Usage Analysis and Upgrade features rely on Confluence’s internal CQL search, which always applies permission checks. This means that only pages visible to the user executing the process will be included in the results. Even Confluence administrators might not have access to all restricted pages.
Consequently, diagrams located on pages without view permission for the executing user will not appear in the usage analysis and cannot be upgraded automatically. To ensure a complete system‑wide upgrade, run the process using an account with access to all relevant spaces and pages.

 


Process Net: Diagram Links Synchronization SERVER | DATA CENTER CLOUD

|Since 3.21.0-ENTERPRISE.|

The Process Net macro uses a central database to manage all diagram links. In case of any incorrect behavior, or if you simply want to refresh and reimport all you diagram links, this can be done in the admin app configuration of the BPMN Modeler Enterprise.

Reset

The reflection of all links in the database will be deleted. This leaves a clean and empty database to be filled again.

This does not affect the links in the diagrams! All models will remain untouched.

Synchronize

All currently present diagram links in all models in your entire Confluence instance will be saved to the database.

Depending on the number of diagrams, this can take some time.

This does not affect the links in the diagrams! All models will remain untouched.

 

 

 

 

 

image-20240419-132433.png

 


GitLab Connection SERVER | DATA CENTER CLOUD

|Since 3.10.0-ENTERPRISE.|

To enable users of the BPMN Modeler Enterprise to import diagrams from GitLab and push diagrams to GitLab, you need to establish a connection between the Add-On and GitLab. This involves setting up an OAuth2 connection between the two systems. To do so, follow these steps:

  1. Create an OAuth2 App in GitLab:

    • Log in to GitLab as an administrator.

    • Go to Settings > Access > Applications

    • Select “Add new Application”, give it a name, and use the redirect URI provided in the BPMN Modeler Enterprise Add-Ons's App Configuration. Add the scope api to leverage the GitLab connection fully.

    • Store the OAuth app's secret securely

    For more detailed guidance, refer to the GitLab OAuth App Documentation.

  2. Configure the Connection in Confluence:

    • If you are using a Confluence SERVER | DATA CENTER instance, you must provide the following environment variables containing Base64-encoded 32-byte encryption keys to store your configuration securely:

      • GITLAB_OAUTH_CID_KEY

      • GITLAB_OAUTH_CSC_KEY

      • GITLAB_OAUTH_AT_KEY

    • You can find instructions on generating your encryption keys here.

    • Enter your GitLab Base URL, application ID, and secret into the corresponding fields in Confluence and save them.

    • Click on Test Connection. This will open GitLab in a new browser tab, prompting you to sign in. Then, the OAuth app will ask you to authorize access to repositories.

    • After granting authorization, you should see a success message. If there is an issue, you will receive feedback on what went wrong.

 

image-20240801-112141.png
Note the redirect URL to use in your Gitlab application

 

image-20240730-132846.png
Use as redirect URL the one provided in BPMN Modeler Configuration

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


GitHub Connection SERVER | DATA CENTER CLOUD

|Since 3.41.0-ENTERPRISE.|

To enable users of the BPMN Modeler Enterprise to import diagrams from GitHub and push diagrams to GitHub, you need to establish a connection between the Add-On and GitHub. This involves setting up an OAuth2 connection between the two systems. To do so, follow these steps:

  1. Create an OAuth2 App in GitHub:

    • Log in to GitHub as an administrator.

    • Go to your Organization > Settings > Developer Settings > OAuth Apps

    • Select “New Org Oauth Application”, give it a name, and use the redirect URI provided in the BPMN Modeler Enterprise Add-Ons's App Configuration.

      • The Homepage URL is of no relevance.

    • Generate a new client secret and store it securely.

    For more detailed guidance, refer to the GitHub OAuth App Documentation

  2. Configure the Connection in Confluence:

    • If you are using a Confluence SERVER | DATA CENTER instance, you must provide the following environment variables containing Base64-encoded 32-byte encryption keys to store your configuration securely:

      • GITHUB_OAUTH_CID_KEY

      • GITHUB_OAUTH_CSC_KEY

      • GITHUB_OAUTH_AT_KEY

    • You can find instructions on generating your encryption keys here.

    • Enter your application ID and secret into the corresponding fields in Confluence and save them.

    • Click on Test Connection. This will open GitHub in a new browser tab, prompting you to sign in. Then, the OAuth app will ask you to authorize access to repositories.

    • After granting authorization, you should see a success message. If there is an issue, you will receive feedback on what went wrong.

 

image-20240801-112308.png
image-20240730-132609.png

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


Tips & Tricks: Encryption Key Generation

To generate encryption keys, there are several methods available, with OpenSSL being one of the simplest options. If you have OpenSSL installed, you can do this directly from your command line. Simply enter the following command, which will generate a random 32-byte key encoded in Base64.

  • openssl rand -base64 32

Alternatively, you can also write your own script in programming languages such as Node.js, Java, or Python to achieve similar results. The generated keys can then be used to store your credentials securely in your database.

grafik-20250114-160520.png