Skip to content

Commit a7183e9

Browse files
committed
added instructions for num dashboard report on dsf 2
1 parent a0cb164 commit a7183e9

1 file changed

Lines changed: 87 additions & 7 deletions

File tree

docs/src/operations/v2.0.1/install-plugins.md

Lines changed: 87 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,9 @@ title: Install Plugins
33
icon: plugin
44
---
55

6-
::: tip Marketplace for process plugins
7-
To install and learn more about each Process Plugin, you can visit the Marketplace [here](https://hub.dsf.dev).
8-
:::
9-
106

117
## **Overview**
12-
- You can find an overview of compatable process plugins below (last updated 2025-11-25).
8+
- You can find an overview of compatable process plugins below (last updated 2026-01-19).
139

1410

1511
| Process Plugin | released for test | released for production |
@@ -20,9 +16,8 @@ To install and learn more about each Process Plugin, you can visit the Marketpla
2016
| [MII Process Report](https://github.com/medizininformatik-initiative/mii-process-report/releases) | [v1.2.0.1](https://github.com/medizininformatik-initiative/mii-process-report/releases/tag/v1.2.0.1) | [v1.2.0.1](https://github.com/medizininformatik-initiative/mii-process-report/releases/tag/v1.2.0.1) |
2117
| [MII Process Data Transfer](https://github.com/medizininformatik-initiative/mii-process-data-transfer/releases) | [v1.1.0.1](https://github.com/medizininformatik-initiative/mii-process-data-transfer/releases/tag/v1.1.0.1) | [v1.1.0.1](https://github.com/medizininformatik-initiative/mii-process-data-transfer/releases/tag/v1.1.0.1) |
2218
| [MII Process Data Sharing](https://github.com/medizininformatik-initiative/mii-process-data-sharing/releases) | [v1.1.0.0](https://github.com/medizininformatik-initiative/mii-process-data-sharing/releases/tag/v1.1.0.0) | [v1.1.0.0](https://github.com/medizininformatik-initiative/mii-process-data-sharing/releases/tag/v1.1.0.0) |
19+
| [NUM Dashboard Report](https://github.com/medizininformatik-initiative/dsf-plugin-numdashboard/releases) [Note](#num-dashboard-report-on-dsf-2) | [v1.1.0.0](https://github.com/medizininformatik-initiative/dsf-plugin-numdashboard/releases/tag/v1.1.0.0) | [v1.1.0.0](https://github.com/medizininformatik-initiative/dsf-plugin-numdashboard/releases/tag/v1.1.0.0) |
2320

24-
25-
- Explore and install Process Plugins in the Marketplace. Details on each plugin are available [here](https://hub.dsf.dev/).
2621
- Deploying the process plugin to the DSF involves copy the process jar-file and configuring environment variable for the business process engine (BPE).
2722

2823

@@ -53,3 +48,88 @@ sudo chown root:bpe mii-process-data-sharing-1.1.0.0.jar
5348

5449
- Modify the process exclude config in `/opt/bpe/docker-compose.yml`
5550
- **Reminder:** Update/verify required configurations in `docker-compose.yml`
51+
52+
53+
### NUM Dashboard Report on DSF 2
54+
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:
55+
56+
1. Create a new file with the name `api-v1-allowed-bpe-classes.list` with the following content:
57+
58+
```text
59+
#
60+
# Copyright 2018-2025 Heilbronn University of Applied Sciences
61+
#
62+
# Licensed under the Apache License, Version 2.0 (the "License");
63+
# you may not use this file except in compliance with the License.
64+
# You may obtain a copy of the License at
65+
#
66+
# http://www.apache.org/licenses/LICENSE-2.0
67+
#
68+
# Unless required by applicable law or agreed to in writing, software
69+
# distributed under the License is distributed on an "AS IS" BASIS,
70+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
71+
# See the License for the specific language governing permissions and
72+
# limitations under the License.
73+
#
74+
75+
com.fasterxml.jackson.annotation
76+
com.fasterxml.jackson.core
77+
com.fasterxml.jackson.databind
78+
com.google.common
79+
dev.dsf.bpe.api
80+
jakarta.ws.rs
81+
org.apache.commons.codec
82+
org.apache.commons.io
83+
org.apache.commons.lang3
84+
org.apache.commons.text
85+
org.apache.http
86+
org.bouncycastle
87+
org.operaton.bpm.engine.delegate
88+
org.operaton.bpm.engine.impl.el.FixedValue
89+
org.operaton.bpm.engine.impl.util.ClassDelegateUtil
90+
org.operaton.bpm.engine.impl.variable.serializer
91+
org.operaton.bpm.engine.ProcessEngine
92+
org.operaton.bpm.engine.RuntimeService
93+
org.operaton.bpm.engine.variable
94+
org.operaton.bpm.model.bpmn.instance
95+
org.joda.time
96+
org.glassfish.jersey
97+
org.slf4j.Logger
98+
org.slf4j.LoggerFactory
99+
org.springframework.beans
100+
org.springframework.cglib
101+
org.springframework.context
102+
org.springframework.core
103+
org.springframework.lang
104+
org.springframework.util
105+
org.springframework.web.util.UriComponents
106+
org.springframework.web.util.UriComponentsBuilder
107+
org.w3c.dom
108+
org.xml.sax
109+
sun.misc.Unsafe
110+
# packages required for num dashboard report plugin
111+
org.springframework.web.client
112+
org.springframework.http
113+
```
114+
115+
2. Edit the `docker-compose.yml` file and add the following:
116+
117+
```yaml
118+
...
119+
app:
120+
image: ghcr.io/datasharingframework/bpe:2.0.1
121+
...
122+
volumes:
123+
...
124+
- type: bind
125+
source: api-v1-allowed-bpe-classes.list
126+
target: /api-v1-allowed-bpe-classes.list
127+
...
128+
environment:
129+
DEV_DSF_BPE_PROCESS_API_ALLOWED_BPE_CLASSES: "{v1: '/api-v1-allowed-bpe-classes.list'}"
130+
...
131+
```
132+
133+
3. Restart the application container with `docker compose up -d && docker compose logs -f`.
134+
135+
4. The process should work as intended.

0 commit comments

Comments
 (0)