Features described on this page
Feature | Hosting Type | Release Version | Blogpost |
|---|---|---|---|
SERVER | DATA CENTER CLOUD | initial | ||
SERVER | DATA CENTER CLOUD | 3.15.0-ENTERPRISE | ||
SERVER | DATA CENTER CLOUD | initial | ||
SERVER | DATA CENTER CLOUD | initial | ||
SERVER | DATA CENTER CLOUD | 3.21.0-ENTERPRISE | ||
SERVER | DATA CENTER CLOUD | 3.10.0-ENTERPRISE | https://blog.viadee.de/en/bpmn-modeler-enterprise-3.15 https://blog.viadee.de/en/gitlab-synchronization-with-bpmn-and-dmn-modeler-enterprise | |
SERVER | DATA CENTER | 3.12.0-ENTERPRISE | ||
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.
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.
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.
Diagram Link Synchronization SERVER | DATA CENTER CLOUD
|Since 3.21.0-ENTERPRISE.|
The process net 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.
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:
Create an OAuth2 App in GitLab:
Log in to GitLab as an administrator.
Go to Admin Area > Applications > New Application.
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.
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_KEYGITLAB_OAUTH_CSC_KEYGITLAB_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.
If GitLab is not self-hosted, the base URL will be https://gitlab.com
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.
Bitbucket Connection SERVER | DATA CENTER
|Since 3.12.0-ENTERPRISE.|
To enable users of the BPMN Modeler Enterprise to import diagram from Atlassian Bitbucket, you need to set up an Application Link between your Confluence and Bitbucket.
To do this, sign into your Confluence as administrator, go to General Configuration> Application links > New Link and enter your Bitbucket base URL. Follow the setup wizard.
It is important for the BPMN Modeler, that you choose the Oauth (impersonation) option. Otherwise it will not be able to pull files from Bitbucket.
For more information on this refer to the official Atlassian documentation.
Once you established the Application link, open the configuration of the BPMN Modeler Enterprise. Under Bitbucket Connection, you can click the Refresh Button to see all your available applications. Choose the desired one for Bitbucket. You must provide the following environment variable containing a Base64-encoded 32-byte encryption key to store your configuration securely:
BITBUCKET_OAUTH_CID_KEY
You can find instructions on generating your encryption keys here.
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:
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
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_KEYGITHUB_OAUTH_CSC_KEYGITHUB_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.
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.
