---
jupytext:
  formats: md:myst
  text_representation:
    extension: .md
    format_name: myst
    format_version: 0.13
    jupytext_version: 1.11.5
kernelspec:
  display_name: Python 3
  language: python
  name: python3
---

(openbis:concept)=
# Struktur von openBIS

(openbis:concept:s_c_o)=
## Space, Project, Collection, Object, Dataset
```{figure} ../img/spcod-structure.png
  :name: spod_structure
  :figclass: margin
  :width: 100%

  Baumstruktur Instanz
```
In einer openBIS Instanz sind alle möglichen Einträge in fünf Typen unterteilbar und in einer Baumstruktur angeordnet.

`````{tab-set}
````{tab-item} Space
  Ein Space ist das höchste, anpassbare Ordnungselement mit allen anderen Typen diesem untergeordnet. Ein Space kann entweder im Bereich {term}`ELN` / Laborbuch oder {term}`LIMS` / Inventar eingeteilt sein. Ein Space soll eine grobthematische Unterscheidung zulassen, bspw. persönlicher Space für private Laborbücher, ein Space pro Laborgruppe, ein Space pro Semester, ein Space pro Inventarverwaltungsgebiet. Direkt unter dem Space ist nur das Project.
````
````{tab-item} Project
  Ein Project bietete eine weitere Ordnungsebene an. Dem Space untergeordnet, werden Projects zur Aufteilung nach Themengebieten oder Gruppen genutzt. Rechte können bis zu dieser Ebene zugeteilt werden. Beispiele für Projects wären GP-Gruppen, persönliche Unterscheidung Bachelor und Master, Laborgruppe 1 und 2, usw. 
````
````{tab-item} Collection
  ```{image} ../img/collection-structure.png
    :name: collection-structure
    :align: right
    :width: 20%
  ```
  Eine weitere Ordnungsebene ist die Collection als Ansammlung von Objects. Hier können über mehrere Experimente oder Probenanalysen gleichbleibende Eigenschaften angegeben werden.
````
````{tab-item} Object
  ```{image} ../img/object-structure.png
    :name: object-structure
    :align: right
    :width: 35%
  ```
  Das Object ist eine frei anpassbare Vorlage mit verschiedenen Feldern und Eigenschaften.
````
````{tab-item} Dataset
  ```{image} ../img/dataset-structure.png
    :name: dataset-structure
    :align: right
    :width: 35%
  ```
  Ein Dataset fasst verschiedene Datensätze zusammen und bietet somit die Möglichkeit, z. B. Messdaten hochzuladen.
````
`````

(openbis:concept:roles)=
## Zugriffsrechte
Offizielle Dokumentation: [readthedocs User Registration](https://openbis.readthedocs.io/en/latest/user-documentation/general-admin-users/admins-documentation/user-registration.html#openbis-roles) / [wiki openBIS Roles](https://unlimited.ethz.ch/display/openBISDoc2010/openBIS+Roles)

Die Zugriffsrechte in openbis (*roles*) sind in fünf Klassen gruppiert: 
````{tab-set}
```{tab-item} Observer
können die zugeordneten Ebenen nur lesen, also anzeigen ohne Änderungsbefugnis. Dies umfasst auch die Typen von Objekten, Vokabular, Datasets und NutzerInnen. Außerdem können Datasets heruntergeladen und umfassend in openBIS gesucht werden (in freigebenden Ebenen).
```
```{tab-item} User
können zusätzlich Collections und Objekte erstellen und verändern. Projekte können nur verändert werden (auch wenn User auf Space Ebene).
```
```{tab-item} Power User
können zusätzlich Projekte erstellen und Projekte, Collections, Objekte, Datasets löschen. Es können Vokabular-Einträge verändert, gelöscht und hinzugefügt werden (über Admin-UI).
```
```{tab-item} Space / Project Admin
können Nutzerrollen vergeben und verändern, sowie Datasets verändern.
```
```{tab-item} Admin
kann alles, insbesondere Space, NutzerInnen, Objekte-Typen, Dataset-Typen, Property-Values erstellen, verändern und löschen. Zudem Rollen vergeben und verändern, inklusive Admin Rolle. 
```
````

Die Rechte werden in entgegengesetzter Reihenfolge vererbt, also User hat alle Observer Rechte. Die Rollen haben unterschiedlich weitreichende Rechte, welche auf drei Ebenen (Project, Space, Instance) vergeben werden können. Dabei werden Rollen nach unten vererbt (Instance -> Space -> Project), also hat ein Space Power User automatisch Power User Rechte für untergeordnete Projects. Dies gilt auch für manuell vergebenen Zugriff durch die NutzerInnen an Andere. 

Rollen können entweder einer Person individuell zugeteilt oder in Gruppen zusammengefasst werden. Dadurch erhält jede Person in der Gruppe jede der Gruppe zugehörigen Rechte.


(openbis:concept:groups)=
## Gruppen und Rollenvergabe

Neben der Zuweisung individueller Rollen können auch Gruppen verwendet werden, um mehreren Nutzer*innen gleichzeitig bestimmte Rechte zuzuweisen. Dies vereinfacht insbesondere die Verwaltung in größeren Projekten, Praktika oder Forschungsgruppen.

### Vorteile von Gruppen
- Rollenvergabe an mehrere Personen gleichzeitig
- Zentrale Steuerung von Zugriffsrechten
- Bessere Übersicht und geringerer Pflegeaufwand

### Gruppenstruktur
Eine Gruppe besteht aus:
- **Gruppencode**: Eindeutiger Name der Gruppe (z. B. `praktikum-a`, `admin-team`)
- **Mitglieder**: Eine oder mehrere Nutzer*innen, die Teil der Gruppe sind
- **Rollen**: Eine oder mehrere Rollen, die der Gruppe zugewiesen sind

### Beispielrollenvergabe
Wenn der Gruppe `praktikum-a` die Rolle `USER` auf dem Space `SS24` zugewiesen wird, dann haben automatisch alle Mitglieder dieser Gruppe Zugriff, um in diesem Space Inhalte zu erstellen und zu bearbeiten.

### Vererbung von Gruppenrechten
Analog zu Einzelpersonen werden auch Gruppenrechte von übergeordneten Ebenen (Instance > Space > Project) an untergeordnete Strukturen vererbt. Eine Gruppe mit `Power User`-Rolle auf Space-Ebene hat somit auch Schreib- und Löschrechte auf allen untergeordneten Projekten.

### Kombination von Rollen
Einzelpersonen können zusätzlich zu Gruppenmitgliedschaften eigene Rollen erhalten. Die umfassendste Rolle zählt: Wenn eine Person sowohl `Observer` über eine Gruppe als auch `Power User` individuell ist, gelten die `Power User`-Rechte.

```{note}
Gruppen bieten eine skalierbare Lösung zur Rechteverwaltung. Für Praktika mit mehreren Gruppen oder für Projektteams ist der Einsatz von Gruppen dringend empfohlen.
```
