Skip to main content

Install Plugins

DSF-TeamAbout 2 min

Overview

  • You can find an overview of compatable process plugins below (last updated 2026-01-19).
Process Pluginreleased for testreleased for production
Ping-Pongv1.0.1.0 & v2.0.0.2v1.0.1.0 & v2.0.0.2
Allow-Listv1.0.0.1v1.0.0.1
MII Process Feasibilityv1.0.0.11v1.0.0.11
MII Process Reportv1.2.0.1v1.2.0.1
MII Process Data Transferv1.1.0.1v1.1.0.1
MII Process Data Sharingv1.1.0.0v1.1.0.0
NUM Dashboard Report Notev1.1.0.0v1.1.0.0
  • Deploying the process plugin to the DSF involves copy the process jar-file and configuring environment variable for the business process engine (BPE).

Prerequisites

  • A DSF installation of version 2.0.0 or higher. An installation guide can be found here.

Deployment

  • Add the process jar-file to the DSF BPE folder /opt/bpe/process:
wget (your jar-file download link)

For example:

 wget https://github.com/medizininformatik-initiative/mii-process-data-sharing/releases/download/v1.1.0.0/mii-process-data-sharing-1.1.0.0.jar
  • Make sure the process is readable by the bpe user or group, for example by executing:
sudo chmod 440 (your jar-file name.jar)
sudo chown root:bpe (your jar-file name.jar)

For example:

sudo chmod 440 mii-process-data-sharing-1.1.0.0.jar
sudo chown root:bpe mii-process-data-sharing-1.1.0.0.jar
  • Modify the process exclude config in /opt/bpe/docker-compose.yml
  • Reminder: Update/verify required configurations in docker-compose.yml

NUM Dashboard Report on DSF 2

The NUM Dashboard Report Plugin is not fully compatible with DSF 2.0.1 out of the box. DSF 2 introduced some new security features like class whitelisting of classes from the DSF and it's dependencies. The NUM Dashboard Report Plugin uses some of the not whitelisted classes. After review, it's fine to use the classes required by the plugin. Until new versions are released, you can allow the required classes with the following changes:

  1. Create a new file with the name api-v1-allowed-bpe-classes.list with the following content:
#
# Copyright 2018-2025 Heilbronn University of Applied Sciences
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

com.fasterxml.jackson.annotation
com.fasterxml.jackson.core
com.fasterxml.jackson.databind
com.google.common
dev.dsf.bpe.api
jakarta.ws.rs
org.apache.commons.codec
org.apache.commons.io
org.apache.commons.lang3
org.apache.commons.text
org.apache.http
org.bouncycastle
org.operaton.bpm.engine.delegate
org.operaton.bpm.engine.impl.el.FixedValue
org.operaton.bpm.engine.impl.util.ClassDelegateUtil
org.operaton.bpm.engine.impl.variable.serializer
org.operaton.bpm.engine.ProcessEngine
org.operaton.bpm.engine.RuntimeService
org.operaton.bpm.engine.variable
org.operaton.bpm.model.bpmn.instance
org.joda.time
org.glassfish.jersey
org.slf4j.Logger
org.slf4j.LoggerFactory
org.springframework.beans
org.springframework.cglib
org.springframework.context
org.springframework.core
org.springframework.lang
org.springframework.util
org.springframework.web.util.UriComponents
org.springframework.web.util.UriComponentsBuilder
org.w3c.dom
org.xml.sax
sun.misc.Unsafe
# packages required for num dashboard report plugin
org.springframework.web.client
org.springframework.http
  1. Edit the docker-compose.yml file and add the following:
...
  app:
    image: ghcr.io/datasharingframework/bpe:2.0.1
...
    volumes:
...
      - type: bind
        source: api-v1-allowed-bpe-classes.list
        target: /api-v1-allowed-bpe-classes.list
...
    environment:
      DEV_DSF_BPE_PROCESS_API_ALLOWED_BPE_CLASSES: "{v1: '/api-v1-allowed-bpe-classes.list'}"
...

  1. Restart the application container with docker compose up -d && docker compose logs -f.

  2. The process should work as intended.