Skip to main content

Install Plugins

DSF-Team10/30/23About 1 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 now fully compabile with DSF 2.0.2 and above. If you implemented the workaround for DSF 2.0.1 and below, you can remove it:

  1. Remove the file with the name api-v1-allowed-bpe-classes.list

  2. Edit the docker-compose.yml file and remove the following volume and environment variable:

...
  app:
    image: ghcr.io/datasharingframework/bpe:2.0.2
...
    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.
Last Updated