Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ opencode.json
# Any local run configuration file
.run

# local Pi agent settings
.pi

# Local git worktrees
.worktrees/

Expand Down
111 changes: 111 additions & 0 deletions 2026-06-19_FEATURE_Connect_associated_datasets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
Connect datasets with research projects

Versions
2026-06-19 First draft: Outlining the background and idea as well as the first user stories for connecting open and restricted published datasets on an InventioRDM instance
Background
To get a scientific finding ready for publication, good scientific practice requests scientists to share associated data. While the German science council has made this part of their GWP (Gute Wissenschaftliche Praxis), also funding bodies and journals include the publication of associated data increasingly as hard requirement.
The University of Tübingen’s life science data management platform Data Manager shall assist scientists in managing high throughput data and connecting further datasets associated with the research project to have a single access point for their data and metadata.
A popular publication platform for all sorts of datasets and widely accepted by both, science community as well as funding bodies and journals, are public InvenioRDM installations such as Zenodo. These platforms are used for smaller datasets, such as figures, results or additional protocols to create a persistent and sharable public reference via a digital object identifier (DOI). Due to its flexibility and ease of use, they are an important way to get various types of supportive data ready for publication.
The idea
As a new feature, Data Manager shall enable users to connect associated datasets managed on a public InvenioRDM instance from within the main project managed in the application.
The vision is to simplify data management for the various assets that are usually part of a scientific project and provide a central access point to retain the overview. At the same time, users shall not be burdened with yet another platform they need to transfer their data from to make them ready for publication.
If the integration turns out to be successful, additional features like the direct creation of datasets on these InvenioRDM instances from within Data Manager can be put into focus and evaluation.
Data Manager becomes the hub. InvenioRDM remains the publishing platform.
The integration is based on FAIR Signposting, providing machine-actionable, machine-readable relationships between the project in Data Manager and the associated datasets on InvenioRDM. This demonstrates true FAIR integration — the connections are not manual bookmarks, but discoverable by other tools and services.
Initial scope
• Target platforms: Zenodo and FDAT (University of Tübingen public InvenioRDM instance)

If the integration turns out to be successful, additional features like the direct creation of datasets on these InvenioRDM instances from within Data Manager can be put into focus and evaluation.

InvenioRDM OpenAPI Specification
See https://inveniosoftware.github.io/invenio-openapi/

User Stories
Personas:
- QBiC project manager
- Researcher
- Data Steward

User Stories of a researcher
Story 01 – Connecting open, published datasets
As a researcher, I want to connect an open, published dataset on InvenioRDM with my project, so I can retain an overview of associated data for myself and collaborators on the project.
Acceptance Criteria:
- Only users with write access can connect datasets in a project
- Users can access a Search Public Dataset section for available InvenioRDM instances
- Users can select the InvenioRDM instance they want to search in (e.g. Zenodo, FDAT)
- If no search term is provided, a paginated result of the search is shown to the user
- Users can enter a search term, and the system will present them with the matching search result
- Clicking Connect successfully adds the selected datasets to the project in the system
- If the connection fails, the system shall inform users about the failure
- If the connection is successful, the system shall inform users about success

References:
None.

Story 02 – Viewing connected open, published datasets
As a researcher, I want to see connected datasets with the current project, so I get an overview of associated datasets.
Acceptance Criteria:
- Users can access a Public Datasets section for connected datasets with the project
- The system provides dataset information for every connected dataset
- The system provides information about the user that connected the dataset
- The system provides an Access Link, that enables all project members to access the dataset without an account on the target InvenioRDM instance
References:
- Dataset Information stakeholder document (tbd)

Story 03 – Remove a connected open, published dataset
As a researcher, I want to remove an existing dataset connection, so I can restore the integrity of associated data with the project.
Acceptance Criteria:
- Users with write access can click a Remove button for connected datasets to remove the connection with the current project
- If the removal was successful, users get a confirmation notification and the view refreshes
- If the removal fails, users get an error notification with further instructions

Story 04 – Sync a connected open, published dataset
As a researcher, I want to sync a connected dataset with its hosted platform, so I have the latest information about the dataset associated with the project.
Acceptance Criteria:
- Users with write access can click a Sync button for a connected dataset to trigger a synchronization with the host system of the dataset
- Users with write access can click a Sync All button to trigger a synchronization for all datasets connected in the project
- If a dataset has a new version, the system updates the local entry with the latest version and notifies users about the update
- If the synchronization is successful, the system informs users about the number of updated datasets
- If the synchronization fails, the system informs users about the failure and next steps.

Story 05 – Connecting an access restricted, published dataset
As a researcher, I want to connect an access restricted dataset with a project so I can collaborate and share with collaborators before opening publication.
Acceptance Criteria:
- Users with write access can enter a Search Restricted Datasets section and search for published restricted datasets on the target InvenioRDM instance
- Users can select the InvenioRDM instance they want to search in (e.g. Zenodo, FDAT)
- If no search term is provided, a paginated result of the search is shown to the user
- Users can enter a search term, and the system will present them with the matching search result
- Clicking Connect successfully adds the selected datasets to the project in the system
- If the connection fails, the system shall inform users about the failure
- If the connection is successful, the system shall inform users about success
- If users have not configured an InvenioRDM instance in their account with an authorization token, notify users and navigate them to the user account section

Story 06 – Viewing connected access-restricted, published datasets
As a researcher, I want to see connected restricted datasets with the current project, so I get an overview of associated restricted datasets.
Acceptance Criteria:
- Users can access a Private Datasets section for connected datasets with the project
- The system provides dataset information for every connected dataset
- The system provides information about the user that connected the dataset
- The system provides an Access Link, that enables all project members to access the dataset without an account on the target InvenioRDM instance
Story 07 – Remove a connected restricted, published dataset
As a researcher, I want to remove an existing dataset connection, so I can restore the integrity of associated data with the project.
Acceptance Criteria:
- Users with write access can click a Remove button for connected restricted datasets to remove the connection with the current project
- If the removal was successful, users get a confirmation notification and the view refreshes
- If the removal fails, users get an error notification with further instructions

Story 08 – Sync a connected restricted, published dataset
As a researcher, I want to sync a connected dataset with its hosted platform, so I have the latest information about the dataset associated with the project.
Acceptance Criteria:
- Users with write access can click a Sync button for a connected dataset to trigger a synchronization with the host system of the dataset
- Users with write access can click a Sync All button to trigger a synchronization for all datasets connected in the project
- If a dataset has a new version, the system updates the local entry with the latest version and notifies users about the update
- If the synchronization is successful, the system informs users about the number of updated datasets
- If the synchronization fails, the system informs users about the failure and next steps.

Missing topics
- tbd




6 changes: 6 additions & 0 deletions Prototype_connect_datasets_prompt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
2026-06-19_FEATURE_Connect_associated_datasets.md contains a vision and a set of user stories for
a new Data Manager feature.

Create a pure UI prototype for the user stories. src/main/java/life/qbic/datamanager/views/demo/ComponentDemo.java can serve
as a blueprint, how the project came up with a demo preview of UI components such that is
not shown in the production environment, but can be run with a development profile.
Binary file modified datamanager-app/src/main/bundles/dev.bundle
Binary file not shown.
32 changes: 32 additions & 0 deletions datamanager-app/src/main/dev-bundle/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
This directory is automatically generated by Vaadin and contains the pre-compiled
frontend files/resources for your project (frontend development bundle).

It should be added to Version Control System and committed, so that other developers
do not have to compile it again.

Frontend development bundle is automatically updated when needed:
- an npm/pnpm package is added with @NpmPackage or directly into package.json
- CSS, JavaScript or TypeScript files are added with @CssImport, @JsModule or @JavaScript
- Vaadin add-on with front-end customizations is added
- Custom theme imports/assets added into 'theme.json' file
- Exported web component is added.

If your project development needs a hot deployment of the frontend changes,
you can switch Flow to use Vite development server (default in Vaadin 23.3 and earlier versions):
- set `vaadin.frontend.hotdeploy=true` in `application.properties`
- configure `vaadin-maven-plugin`:
```
<configuration>
<frontendHotdeploy>true</frontendHotdeploy>
</configuration>
```
- configure `jetty-maven-plugin`:
```
<configuration>
<systemProperties>
<vaadin.frontend.hotdeploy>true</vaadin.frontend.hotdeploy>
</systemProperties>
</configuration>
```

Read more [about Vaadin development mode](https://vaadin.com/docs/next/configuration/development-mode/#pre-compiled-front-end-bundle-for-faster-start-up).
Loading
Loading