Änderungen von Dokument Digitale Mitgliederverwaltung

Zuletzt geändert von Daniel Herrmann am 2026/02/22 21:17

Von Version Icon 29.1 Icon
bearbeitet von Daniel Herrmann
am 2025/08/22 17:39
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version Icon 44.1 Icon
bearbeitet von Daniel Herrmann
am 2025/08/27 19:09
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Icon Seiteneigenschaften
Inhalt
... ... @@ -7,6 +7,10 @@
7 7  
8 8  zu diesem Zweck schaffen wir eine Platform basierend auf mehreren Open Source Software Produkten sowie einigen Hardware Produkten (NAS Speicher, Dokumentenscanner, PC Arbeitsplatz für die Mitgliederverwaltung).
9 9  
10 += {{id name="DigitaleMitgliederverwaltung-Inhaltsverzeichnis"/}}Inhaltsverzeichnis =
11 +
12 +{{toc/}}
13 +
10 10  = {{id name="DigitaleMitgliederverwaltung-Hintergrundinformationen"/}}Hintergrundinformationen =
11 11  
12 12  Viele der Dokumente müssen von einer oder mehreren Partien unterschrieben werden. Wir unterscheiden dabei Dokumente mit geringem und hohem "Streitwert". Unsere Definition zielt hierbei auf eine Einschätzung ab, welcher Schaden dem Verein potentiell entstehen könnte und ob wir im Zweifel eine ordnungsgemäße Unterschrift vor Gericht beweisen können müssen. Beispielsweise hat der Lagervertrag (mögliche Schäden im 2-3 stelligen Eurobereich) einen anderen Stellenwert als beispielsweise ein Einweisungszettel (potentiell Personenschäden, dies kann in Millionen gehen).
... ... @@ -19,7 +19,7 @@
19 19  
20 20  Kurz gesagt: Die EES ist schnell und unkompliziert, aber unsicher und nur für risikofreie Vorgänge geeignet. Die FES ist technisch sicherer, rechtlich belastbarer und für wichtige, aber formfreie Vereinbarungen ideal. Die QES ist rechtlich vollwertig wie eine handschriftliche Unterschrift und für alle Schriftformerfordernisse zwingend notwendig. Zusammenfassung:
21 21  
22 -(% style="text-decoration: none;" %)
26 +(% class="wrapped" style="text-decoration: none;" %)
23 23  |=(((
24 24  Signaturtyp
25 25  )))|=(((
... ... @@ -69,6 +69,7 @@
69 69  
70 70  Am Dienstag, den 12.08.2025 fand hierzu ein Workshop statt, bei dem Vertreter des IT Teams, der Mitgliederverwaltung sowie des Vorstands teilgenommen haben. Dabei wurden die Ziele erläutert und definiert, ebenfalls haben eine Übersicht der bestehenden Dokumenten-Typen erstellt, mit denen wir im Verein heute hantieren. Für jedes Dokument wurde dann evaluiert, ob es in Zukunft komplett digitalisiert werden kann oder ob beispielsweise aus Haftungsgründen die Schriftform und damit eine handschriftliche Unterschrift weiterhin notwendig ist. Die folgende Tabelle gibt einen Überblick:
71 71  
76 +(% class="wrapped" %)
72 72  |=(% scope="col" %)(((
73 73  Dokumenten-Typ
74 74  )))|=(% scope="col" %)(((
... ... @@ -77,7 +77,7 @@
77 77  )))|=(% scope="col" %)(((
78 78  Prozess heute
79 79  )))|=(% scope="col" %)(((
80 -Prozess Zukunft
85 +Notwendige Änderungen
81 81  )))
82 82  |(((
83 83  Mitgliedsantrag
... ... @@ -91,7 +91,7 @@
91 91  * Nach Eingang: Mitgliederverwaltung prüft den Antrag und genehmigt ihn
92 92  * Mitgliederakte wird angelegt, der Antrag wird in der Akte abgeheftet
93 93  )))|(((
94 -Der Antrag kann komplett **digital unterschrieben** werden. Vorgehen:
99 +Der Antrag soll komplett **digital unterschrieben** werden. Vorgehen:
95 95  
96 96  * Interessent:in füllt den Online-Antrag auf der Homepage aus
97 97  * Nach Bestätigung der E-Mail Adresse wird ein Vorgang zur digitalen Unterschrift ausgelöst
... ... @@ -162,11 +162,7 @@
162 162  Ist ein Blanko-Formular, welches ausgefüllt, eingeworfen und abgeheftet wird.
163 163  Danach wird ein Flag für das jeweilige Mitglied gesetzt, dass die Erklärung abgegeben wurde.
164 164  )))|(((
165 -**Vollständig digital**.
166 -
167 -* Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage)
168 -* Mitglied erhält die Aufforderung per Mail das Dokument zu unterschreiben
169 -* Nach Unterschrift wird das Flag automatisch gesetzt und das Dokument wird zu Paperless NGX hochgeladen.
170 +**Vollständig digital**. Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage), danach digital weiter.
170 170  )))
171 171  |(((
172 172  Übungsleitervertrag
... ... @@ -180,12 +180,9 @@
180 180  * Bestätigung dass der Vertrag vorliegt
181 181  * Ein Flag ob das Mitglied die Übungsleiterpauschale an den Verein spendet oder nicht
182 182  )))|(((
183 -**Vollständig digital**.
184 +**Vollständig digital**. Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage), danach digital weiter.
184 184  
185 -* Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage)
186 -* Mitglied erhält die Aufforderung per Mail das Dokument zu unterschreiben
187 -* Nach Unterschrift wird das erste automatisch gesetzt und das Dokument wird zu Paperless NGX hochgeladen.
188 -* Ein Todo für die Mitgliederverwaltung wird erstellt um zu prüfen, ob das Mitglied die Pauschale spenden möchte oder nicht.
186 +Ein Todo für die Mitgliederverwaltung wird erstellt um zu prüfen, ob das Mitglied die Pauschale spenden möchte oder nicht.
189 189  )))
190 190  |(((
191 191  Nutzungsvereinbarung Schulungsinhalte
... ... @@ -196,7 +196,7 @@
196 196  
197 197  Urheberrecht, Übertragung von Nutzungsrechten sollte in Schriftform erfolgen
198 198  )))|(((
199 -Unverändert, bleibt handschriftlich. Manuell über Dokumentenscanner Einscannen und in Paperless dem Mitglied zuweisen.
197 +Unverändert, bleibt handschriftlich. Manuell über Dokumentenscanner einscannen und in Paperless dem Mitglied zuweisen.
200 200  )))
201 201  |(((
202 202  Bestellung eines Einweisers
... ... @@ -257,7 +257,7 @@
257 257  ** Muss für den Einweisenden eine Auszahlung veranlasst werden?
258 258  * Danach wird der Zettel in die jeweiligen Akten einsortiert.
259 259  )))|(((
260 -\\
258 +Der Einweisungszettel ist das bei weitem komplizierteste Dokument, hierfür wird ein separater Workshop stattfinden. Siehe weiter unten für Details.
261 261  )))
262 262  |(((
263 263  Lagervertrag Kistenlager
... ... @@ -271,7 +271,7 @@
271 271  
272 272  Nach Erfassen kann die Person eine Kiste beantragen, die dann monatliche Kosten auslöst
273 273  )))|(((
274 -\\
272 +**Vollständig digital**, die Papierform entfällt. Self-Service durch Nutzer:in.
275 275  )))
276 276  |(((
277 277  Lagervertrag Projektlager
... ... @@ -285,7 +285,7 @@
285 285  
286 286  Nach Erfassen kann die Person das Projektlager automatisch nutzen.
287 287  )))|(((
288 -\\
286 +**Vollständig digital**, die Papierform entfällt. Self-Service durch Nutzer:in.
289 289  )))
290 290  
291 291  == {{id name="DigitaleMitgliederverwaltung-WorkflowBeschreibung"/}}Workflow Beschreibung ==
... ... @@ -318,6 +318,7 @@
318 318  
319 319  Im zweiten Schritt wird nun ein oder mehrere personalisierte Dokumente erstellt. Hier gibt es eine Entscheidungsmatrix:
320 320  
319 +(% class="wrapped" %)
321 321  |=(% scope="col" %)(((
322 322  Remote / Lokal
323 323  )))|=(% scope="col" %)(((
... ... @@ -373,6 +373,7 @@
373 373  
374 374  Im dritten Schritt müssen eine oder mehrere Parteien das Dokument unterschreiben. Wie viele Parteien ist abhängig vom Dokument. So muss beispielsweise der Mitgliedsantrag nur vom werdenden Mitglied unterschrieben werden, während das Schlüsselausgabeformular vom ausgebenen Funktionär und dem Mitglied unterschrieben werden muss. Analog zur Erstellung des Dokuments wird hier unterschieden, ob das Dokument zuhause unterschrieben werden kann oder ob es vor Ort im Makerspace passiert.
375 375  
375 +(% class="wrapped" %)
376 376  |=(((
377 377  Remote / Lokal
378 378  )))|=(((
... ... @@ -427,6 +427,7 @@
427 427  
428 428  Egal welcher Prozess angewandt wird, das Dokument muss am Ende in Paperless eingelesen und mit den Meta-Daten (siehe unten) versehen werden. Hier gibt es drei verschiedene Varianten:
429 429  
430 +(% class="wrapped" %)
430 430  |=(% scope="col" %)(((
431 431  Signatur über
432 432  )))|=(% scope="col" %)(((
... ... @@ -533,6 +533,7 @@
533 533  
534 534  Daraus ergeben sich vier verschiedene Kombinationen (Workflows), die nachstehend genauer beschrieben sind.
535 535  
537 +(% class="wrapped" %)
536 536  |=(% scope="row" %)(((
537 537  Workflow
538 538  )))|=(% scope="col" %)(((
... ... @@ -656,10 +656,50 @@
656 656  
657 657  **Beispiele**: Einweisungszettel für reine Online-Einweisungen
658 658  
661 +{{confluence_drawio border="true" diagramName="Fall 3 Ablaufdiagramm_" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1159" height="467" revision="2"/}}
662 +
663 +Die einzelnen Schritte hierbei sind:
664 +
665 +1. User löst eine Aktion auf der Homepage aus, die ein Dokument erfordert. Beispielsweise hat der User eine Online-Einweisung beendet und muss dafür nun den Einweisungszettel unterschreiben.
666 +1. Die Anfrage wird vom Backend verarbeitet. Hierbei werden sowohl die Rechte geprüft (Lager kann nur von Mitgliedern verwendet werden, der ein neuer Übungsleitervertrag kann nur von Vorstand oder Mitgliederverwaltung angestoßen werden). Danach
667 +11. Speichert das Backend die Anfrage als Signature Request in der Datenbank
668 +11. Erstellt eine "Submission" in DocuSeal. Diese basiert auf einem Template und enthält so viele Daten wie möglich schon vorausgefüllt. Mindestens aber enthält die Submission den signierten QR Code (siehe unten).
669 +11. Das vorausgefüllte Dokument wird im PDF Format heruntergeladen und die Submission wird direkt wieder archived.
670 +1. Das vorausgefüllte PDF wird als Antwort auf die Anfrage an die Website zum Download angeboten. Der Benutzer druckt das PDF aus.
671 +1. (Optional): Ein regelmäßig laufender Cronjob prüft die laufenden Verfahren. Nach einer Woche Inaktivität wird der Unterschriftprozess abgebrochen, 48 Stunden vorher wird eine Erinnerung verschickt
672 +1. Das ausgedruckte Dokument wird vom Benutzer unterschrieben, wenn weitere Parteien notwendig sind, auch diesen zur Unterschrift vorgelegt.
673 +1. Ein Mitglied der Mitgliederverwaltung prüft das Dokument auf Korrektheit (dokumentenechte Unterschrift, vollständig ausgefüllt) und scannt es mit Hilfe des ScanSnap Scanners ein.
674 +1. Das Dokument landet automatisch auf einem Netzwerklaufwerk auf dem Makerspace NAS. Dort wird es von Paperless erkannt und automatisch verarbeitet. Das Post Consumption Script (siehe unten) scannt das Dokument auf einen MKSP QR Code
675 +1. Wird ein MKSP QR Code gefunden passieren zwei Dinge:
676 +11. Die Paperless Meta Daten werden automatisch zugewiesen.
677 +11. Es wird ein N8n Webhook ausgelöst
678 +1. Als Teil des N8n Workflows informiert N8n das Backend darüber, dass das Dokument eingescannt und verarbeitet wurde. Der Vorgang wird entsprechend in der Datenbank als erledigt markiert.
679 +1. (Optional): Wurde im vorherigen Schritt über den Webhook ein N8n Workflow ausgelöst, kann dieser nun weitere Schritte unternehmen (beispielsweise Vikunja Tasks erzeugen, Mails verschicken, oder ähnlich)
680 +
659 659  === {{id name="DigitaleMitgliederverwaltung-Fall4:Handschriftlich+Makerspace"/}}Fall 4: Handschriftlich + Makerspace ===
660 660  
661 -ToDo
683 +In diesem Fall wird der Prozess durch einen Benutzer **im Makerspace ausgelöst und benötigt Schriftform.** In diesem Fall wird das Dokument im Makerspace erzeugt (soweit wie möglich vorausgefüllt und mit QR Code versehen) und direkt vor Ort ausgedruckt. Dort wird es dann unterschrieben und eingeworfen.
662 662  
685 +**Beispiele**: Einweisungszettel für Vor-Ort Online-Einweisungen
686 +
687 +{{confluence_drawio border="true" diagramName="Fall 4 Ablaufdiagramm" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1208" height="523" revision="3"/}}
688 +
689 +Die einzelnen Schritte hierbei sind:
690 +
691 +1. Ein autorisierter User meldet sich am Tablet an einer App an, entweder per Makerspace Login (Keycloak) oder per Keyfob. Dort hat der Benutzer dann mehrere Optionen, beispielsweise die Erfassung von Einweisungs-Teilnehmer:innen.
692 +1. Tablet sendet im Namen des angemeldeten Benutzers eine Anfrage ans Backend. Die Anfrage wird vom Backend verarbeitet. Danach...
693 +11. Speichert das Backend die Anfrage als Signature Request in der Datenbank
694 +11. Erstellt mit Hilfe einer Docuseal Submission ein PDF Dokument. Dieses basiert auf einem Template und enthält so viele Daten wie möglich schon vorausgefüllt. Mindestens aber den signierten QR Code (siehe unten).
695 +1. Das Tablet druckt das oder die heruntergeladenen PDF Datei(en) aus.
696 +1. Die Parteien unterschreiben das Dokument handschriftlich und werfen es in den Briefkasten.
697 +1. Ein Mitglied der Mitgliederverwaltung prüft das Dokument auf Korrektheit (dokumentenechte Unterschrift, vollständig ausgefüllt) und scannt es mit Hilfe des ScanSnap Scanners ein.
698 +1. Das Dokument landet automatisch auf einem Netzwerklaufwerk auf dem Makerspace NAS. Dort wird es von Paperless erkannt und automatisch verarbeitet. Das Post Consumption Script (siehe unten) scannt das Dokument auf einen MKSP QR Code
699 +1. Wird ein MKSP QR Code gefunden passieren zwei Dinge:
700 +11. Die Paperless Meta Daten werden automatisch zugewiesen.
701 +11. Es wird ein N8n Webhook ausgelöst
702 +1. Als Teil des N8n Workflows informiert N8n das Backend darüber, dass das Dokument eingescannt und verarbeitet wurde. Der Vorgang wird entsprechend in der Datenbank als erledigt markiert.
703 +1. (Optional): Wurde im vorherigen Schritt über den Webhook ein N8n Workflow ausgelöst, kann dieser nun weitere Schritte unternehmen (beispielsweise Vikunja Tasks erzeugen, Mails verschicken, oder ähnlich)
704 +
663 663  = {{id name="DigitaleMitgliederverwaltung-PaperlessNGX"/}}Paperless NGX =
664 664  
665 665  Das Herzstück der digitalen Mitgliederakte bildet Paperless NGX. Es wird im Makerspace lokal betrieben und ist daher nur aus dem Netzwerk des Makerspaces oder [[per VPN>>confluencePage:page:IN.[HOWTO] Makerspace VPN]] erreichbar. Der Zugang zu Paperless ist über OpenID Connect an [[confluencePage:page:IN.Keycloak]] gekoppelt, Zugang besteht nur für Mitglieder der Gruppen **Vorstand** und **Mitgliederverwaltung**.
... ... @@ -685,184 +685,763 @@
685 685  * **Tags**: Einem Dokument können beliebig viele Tags zugewiesen werden. **Tags** dienen der einfacheren **Zuordnung** und dem **Wiederfinden** von Dokumenten. Es gibt allerdings auch spezielle Tags für Dokumente die eingelesen aber noch nicht bearbeitet wurden, so genannte "Inbox Tags":
686 686  ** (% style="color:var(--ds-icon-success,#22a06b);" %)**Inbox Mitgliederverwaltung**(%%) - Alle **Dokumente** die **per Mail oder per Ordner** für die **Gruppe Mitgliederverwaltung** aufgenommen wurden und **nicht automatisch zugeordnet** werden konnten.
687 687  ** (% style="color:var(--ds-icon-accent-blue,#1d7afc);" %)**Inbox Vorstand**(%%) - Alle **Dokumente** die **per Mail oder per Ordner** für die **Gruppe Vorstand** aufgenommen wurden und **nicht automatisch zugeordnet** werden konnten.
730 +* **Dokumenten-Typen**: Einem Dokument wird exakt ein Typ zugewiesen. Dokumenten Typen sind im Prinzip einfache Gruppen. Für die Mitgliederverwaltung sind die Gruppen gemäß der folgenden Liste festgelegt, können aber natürlich bei Bedarf erweitert werden.
731 +** Mitgliedsantrag
732 +** SEPA Lastschriftmandat
733 +** Studienbescheinigung
734 +** Bestätigung Schlüsselausgabe
735 +** Verpflichtungserklärung Datenschutz
736 +** Übungsleitervertrag
737 +** Nutzungsvereinbarung Schulungsinhalte
738 +** Bestellung als Einweiser:in
739 +** Haftungsausschluss
740 +** Einweisungszettel
741 +** Lagervertrag Kistenlager
742 +** Lagervertrag Projektlager
688 688  * (((
689 -**Dokumenten-Typen**: Einem Dokument wird exakt ein Typ zugewiesen. Dokumenten Typen sind im Prinzip einfache Gruppen. Für die Mitgliederverwaltung sind die Gruppen gemäß der folgenden Tabelle festgelegt, können aber natürlich bei Bedarf erweitert werden. Neben einem Namen haben die Dokumente einen Match String. Kommt dieser eindeutig (exakter Match) irgendwo im Dokument vor, wird der Typ automatisch zugewiesen.
744 +**Storage Path**: Speicherpfade sind ein fortgeschrittenes Feature, welches kontrolliert, wie die Dateien im unterliegenden Dateisystem gespeichert werden. In der Regel arbeitet man nicht direkt mit den Dateien, aber wenn man aus lange Sicht mal aus Paperless NGX weg ziehen möchte kann es sinnvoll sein, die Dokumente in einer Struktur zu speichern, die man theoretisch auch manuell durchsuchen könnte. Details finden sich in der [[Dokumentation von Paperless zu File Name Handling>>url:https://docs.paperless-ngx.com/advanced_usage/#file-name-handling||shape="rect"]].
745 +\\{{info title="Verhalten von Paperless"}}(% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %)Paperless checks the filename of a document whenever it is saved. Changing (or deleting) a (%%)[[storage path>>url:https://docs.paperless-ngx.com/advanced_usage/#storage-paths||style="text-decoration: none;" shape="rect"]](% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %) will automatically be reflected in the file system. However, when changing (% style="text-decoration: none;" %){{code language="none"}}PAPERLESS_FILENAME_FORMAT{{/code}}(% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %) you will need to manually run the (%%)[[
746 +
747 +{{code language="none"}}
748 +document renamer
749 +{{/code}}>>url:https://docs.paperless-ngx.com/administration/#renamer||style="text-decoration: none;" shape="rect"]](% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %) to move any existing documents.{{/info}}
750 +In unserem Fall kommen die folgenden Speicherpfade zum Einsatz:
690 690  \\
691 691  
692 692  |=(% scope="col" %)(((
693 693  Name
694 694  )))|=(% scope="col" %)(((
695 -Exact Match String
756 +Definition
757 +)))|=(% scope="col" %)(((
758 +Sichtbar für
759 +)))|=(% scope="col" %)(((
760 +Anwendung
696 696  )))
697 697  |(((
698 -Mitgliedsantrag
763 +Mitglieder Einweisungszettel
699 699  )))|(((
700 -mksp-doc-mitgliedsantrag
765 +(% class="code" %)
766 +(((
767 +~{~{ correspondent }}/Einweisungen/~{~{ document_type }}-~{~{ tag_list }}-~{~{ created }}-~{~{ doc_pk }}
701 701  )))
769 +)))|(((
770 +Mitgliederverwaltung
771 +)))|(((
772 +Einweisungszettel
773 +)))
702 702  |(((
703 -SEPA Lastschriftmandat
775 +Mitglieder Unterlagen
704 704  )))|(((
705 -mksp-doc-sepamandat
777 +(% class="code" %)
778 +(((
779 +~{~{ correspondent }}/~{~{ document_type }}-~{~{ created }}-~{~{ doc_pk }}
706 706  )))
781 +)))|(((
782 +Mitgliederverwaltung
783 +)))|(((
784 +Alle anderen Mitgliederdokumente
785 +)))
707 707  |(((
708 -Studienbescheinigung
787 +Vorstand Dokumente
709 709  )))|(((
710 -mksp-doc-studienbescheinigung
789 +(% class="code" %)
790 +(((
791 +~{~{ created_year }}/~{~{ correspondent }}/~{~{ title }}
711 711  )))
793 +)))|(((
794 +Vorstand
795 +)))|(((
796 +Alle Vorstandsdokumente
797 +)))
798 +)))
799 +
800 +== {{id name="DigitaleMitgliederverwaltung-AutomatischeZuordnungvonMetadaten"/}}Automatische Zuordnung von Metadaten ==
801 +
802 +Paperless unterstützt die automatische Zuordnung von Metadaten basierend auf festen Strings. So kann man beispielsweise angeben, dass ein Dokumententyp "Haftungsausschluss" zugewiesen werden soll, wenn der String "Haftungsausschluss" irgendwo im Dokument vorkommt. Dies ist allerdings auf eine korrekte Funktion der Texterkennung angewiesen und funktioniert erfahrungsgemäß nur in manchen Fällen, sodass mindestens eine manuelle Überprüfung trotzdem notwendig kommt. Wenn beispielsweise ein Brief mit dem Satz "ich dachte, ich hätte den Haftungsausschluss bereits abgegeben, könntet ihr dies bitte prüfen" erfasst wird, würde der basierend auf der Regel ebenfalls kategorisiert werden.
803 +
804 +**Aus diesem Grund wird auf jedes Dokument einen spezieller QR Code aufgedruckt**. Der QR code wird vom Post-Consume Script verwendet um die Metadaten in Paperless zuzuordnen. Weiterhin können Daten übermittelt werden, die dann mittels Webhook an N8n übermittelt werden und dort im Workflow verwendet werden können. Der Aufbau orientiert sich an dem Aufbau eines **JSON Web Tokens (JWT).**
805 +
806 +=== {{id name="DigitaleMitgliederverwaltung-Barcodeerzeugen"/}}(% style="color:var(--ds-text-accent-purple-bolder,#352c63);" %)Barcode erzeugen(%%) ===
807 +
808 +(% style="color:var(--ds-text-accent-purple-bolder,#352c63);" %)Der Prozess zur Erzeugung eines QR Codes ist wie folgt:
809 +
810 +* **Payload (Daten) festlegen**. Einige Werte sind verpflichtend, andere können nach Bedarf optional hinzugefügt werden.
811 +* JWT erzeugen und signieren. der JWT besteht aus drei Teilen:
812 +** **Header**: **alg** (Algorithmus) und **typ** (JWT) sind verpflichtend. Zusätzlich fügen wir einen Timestamp, eine eindeutige ID und eine Gültigkeitsdauer hinzu.
813 +** **Body**: beinhaltet die eigentlichen Daten.
814 +** **Signature**: Mit Hilfe eines Secrets und wird die Signatur erzeugt und automatisch angehängt.
815 +* PDF417 code erzeugen: ein JWT ist per Definition URL safe und kann daher einfach in ein QR code umgewandelt werden.
816 +
817 +=== {{id name="DigitaleMitgliederverwaltung-Header"/}}Header ===
818 +
819 +Der Header enthält wichtige Meta-Daten, diese werden von der JWT Library automatisch erzeugt und beschreiben in der Regel den verwendeten Key-Typ.
820 +
821 +=== {{id name="DigitaleMitgliederverwaltung-Body"/}}Body ===
822 +
823 +Die folgenden Claims sind im Body verfügbar:
824 +
825 +|=(((
826 +Claim
827 +)))|=(((
828 +Type
829 +)))|=(((
830 +Pflicht
831 +)))|=(((
832 +Beschreibung
833 +)))
712 712  |(((
713 -Formular Schlüsselausgabe
835 +id
714 714  )))|(((
715 -mksp-doc-schluesselausgabe
837 +UUID4
838 +)))|(((
839 +✅️
840 +)))|(((
841 +Eindeutige ID dieses Dokuments
716 716  )))
717 717  |(((
718 -Verpflichtungserklärung Datenschutz
844 +time
719 719  )))|(((
720 -\\
846 +Zahl
847 +)))|(((
848 +✅️
849 +)))|(((
850 +UTC Linux-Timestamp an dem das Dokument und der QR Code erzeugt wurden
721 721  )))
722 722  |(((
723 -Übungsleitervertrag
853 +exp
724 724  )))|(((
725 -\\
855 +Zahl
856 +)))|(((
857 +✅️
858 +)))|(((
859 +UTC Linux-Timestamp der angibt, bis wann das Dokument gültig ist.
726 726  )))
727 727  |(((
728 -Nutzungsvereinbarung Schulungsinhalte
862 +(% class="code" %)
863 +(((
864 +typ
865 +)))
729 729  )))|(((
730 -\\
867 +String
868 +)))|(((
869 +✅️
870 +)))|(((
871 +Typ des Dokuments basierend auf der unten definierten Liste.
731 731  )))
732 732  |(((
733 -Bestellung eines Einweisers
874 +(% class="code" %)
875 +(((
876 +cor
877 +)))
734 734  )))|(((
735 -\\
879 +String
880 +)))|(((
881 +❌️
882 +)))|(((
883 +Optional: Name des Korrespondenten, dem das Dokument zugeordnet werden soll
736 736  )))
737 737  |(((
738 -Haftungsausschluss
886 +tags
739 739  )))|(((
740 -\\
888 +List[String]
889 +)))|(((
890 +❌️
891 +)))|(((
892 +Liste an Tags, die dem Dokument zugeordnet werden soll
741 741  )))
742 742  |(((
743 -Einweisungszettel
895 +spth
744 744  )))|(((
745 -\\
897 +String
898 +)))|(((
899 +❌️
900 +)))|(((
901 +Storage Path, das dem Dokument zugeordnet werden soll
746 746  )))
747 747  |(((
748 -Lagervertrag Kistenlager
904 +opt
749 749  )))|(((
750 -\\
906 +dict
907 +)))|(((
908 +❌️
909 +)))|(((
910 +Optionale Attribute, die mit eincodiert werden und dem N8n Workflow übergeben werden.
751 751  )))
912 +
913 +=== {{id name="DigitaleMitgliederverwaltung-Footer"/}}Footer ===
914 +
915 +Der Footer wird automatisch erzeugt und erhält eine Signatur über den Header und den Body, basierend auf einem Algorithmus und einer Signatur.
916 +
917 +{{confluence_tip title="Algorithmus"}}
918 +Von den meisten Libraries werden symmetrische und asymmetrische Signaturen unterstützt. Die Verwendung eines symmetrischen Algorithmus ist für uns einfacher.
919 +
920 +Für diesen Anwendungsfall nutzen wir (% style="text-decoration: none;color:var(--ds-text,#333333);" %)**HS256** (HMAC mit SHA-256 Algorithmus).
921 +{{/confluence_tip}}
922 +
923 +=== {{id name="DigitaleMitgliederverwaltung-AuswahlderLibrary"/}}Auswahl der Library ===
924 +
925 +Die Implementierung für die Erzeugung und das Validieren erfolgt in Python. Dies hat den Hintergrund, dass sowohl unser Backend als auch Paperless NGX (und damit das Post-Consumption Script) in Python implementiert ist. Es gibt verschiedene Libraries, die betrachtet wurden:
926 +
927 +|=(% scope="col" %)(((
928 +Name
929 +)))|=(% scope="col" %)(((
930 +CVE
931 +)))|=(% scope="col" %)(((
932 +Github
933 +)))|=(% scope="col" %)(((
934 +GH⭐
935 +)))|=(% scope="col" %)(((
936 +Letztes Release
937 +)))|=(% scope="col" %)(((
938 +Offene Issues
939 +)))|=(% scope="col" %)(((
940 +Dokumentation
941 +)))|=(% scope="col" %)(((
942 +Qualität Dokumentation
943 +)))|=(% scope="col" %)(((
944 +In Backend vorhanden?
945 +)))|=(% scope="col" %)(((
946 +In Paperless vorhanden?
947 +)))
752 752  |(((
753 -Lagervertrag Projektlager
949 +python-jose
754 754  )))|(((
755 -\\
951 +3/0
952 +)))|(((
953 +[[https:~~/~~/github.com/mpdavis/python-jose>>url:https://github.com/mpdavis/python-jose||shape="rect"]]
954 +)))|(((
955 +1.7k
956 +)))|(((
957 +28.05.2025
958 +)))|(((
959 +83
960 +)))|(((
961 +[[https:~~/~~/python-jose.readthedocs.io/en/latest/>>url:https://python-jose.readthedocs.io/en/latest/||shape="rect"]]
962 +)))|(((
963 +⛔ Wenige Bespiele, API Dokumentation fehlt komplett
964 +)))|(((
965 +❌️
966 +)))|(((
967 +❌️
756 756  )))
969 +|(((
970 +pyJWT
971 +)))|(((
972 +4/0
973 +)))|(((
974 +[[https:~~/~~/github.com/jpadilla/pyjwt>>url:https://github.com/jpadilla/pyjwt||shape="rect"]]
975 +)))|(((
976 +5.4k
977 +)))|(((
978 +28.11.2024
979 +)))|(((
980 +30
981 +)))|(((
982 +[[https:~~/~~/pyjwt.readthedocs.io>>url:https://pyjwt.readthedocs.io||shape="rect"]]
983 +)))|(((
984 +➕️ Gute Dokumentation, API, Beispiele, Changelog
985 +)))|(((
986 +✅️ 2.10.1
987 +Dep von firebase
988 +)))|(((
989 +✅️ 2.10.1
757 757  )))
758 -* **Storage Path**: Speicherpfade sind ein etwas fortgeschrittenes Feature, welches kontrolliert, wie die Dateien im unterliegenden Dateisystem gespeichert werden. In der Regel arbeitet man nicht direkt mit den Dateien, aber wenn man aus lange Sicht mal aus Paperless NGX weg ziehen möchte kann es sinnvoll sein, die Dokumente in einer Struktur zu speichern, die man theoretisch auch manuell durchsuchen könnte. Details finden sich in der [[Dokumentation von Paperless zu File Name Handling>>url:https://docs.paperless-ngx.com/advanced_usage/#file-name-handling||shape="rect"]].
759 -\\{{info title="Verhalten von Paperless"}}(% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %)Paperless checks the filename of a document whenever it is saved. Changing (or deleting) a (%%)[[storage path>>url:https://docs.paperless-ngx.com/advanced_usage/#storage-paths||style="text-decoration: none;" shape="rect"]](% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %) will automatically be reflected in the file system. However, when changing (% style="text-decoration: none;" %){{code language="none"}}PAPERLESS_FILENAME_FORMAT{{/code}}(% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %) you will need to manually run the (%%)[[
991 +|(((
992 +JWCrypto
993 +)))|(((
994 +5/0
995 +)))|(((
996 +[[https:~~/~~/github.com/latchset/jwcrypto>>url:https://github.com/latchset/jwcrypto||shape="rect"]]
997 +)))|(((
998 +465
999 +)))|(((
1000 +06.03.2024
1001 +)))|(((
1002 +8
1003 +)))|(((
1004 +[[https:~~/~~/jwcrypto.readthedocs.io>>url:https://jwcrypto.readthedocs.io||shape="rect"]]
1005 +)))|(((
1006 +➕️ API Doc, einige Beispiele
1007 +)))|(((
1008 +✅️ 1.5.6
1009 +Dep von python-keycloak
1010 +)))|(((
1011 +❌️
1012 +)))
760 760  
761 -{{code language="none"}}
762 -document renamer
763 -{{/code}}>>url:https://docs.paperless-ngx.com/administration/#renamer||style="text-decoration: none;" shape="rect"]](% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %) to move any existing documents.{{/info}}
764 -TODO: Define Storage Path
1014 +Unsere bevorzugte Library ist **pyjwt**. Diese ist auch in **paperless nativ vorhanden**, sodass wir uns für die Implementierung mittels **pyjwt** entschieden haben.
765 765  
766 -== {{id name="DigitaleMitgliederverwaltung-AutomatischeZuordnungvonMetadaten"/}}Automatische Zuordnung von Metadaten ==
1016 +=== {{id name="DigitaleMitgliederverwaltung-PDF417Code"/}}PDF417 Code ===
767 767  
768 -Paperless unterstützt die automatische Zuordnung von Metadaten basierend auf festen Strings. So kann man beispielsweise angeben, dass ein Dokumententyp "Haftungsausschluss" zugewiesen werden soll, wenn der String "Haftungsausschluss" irgendwo im Dokument vorkommt. Dies ist allerdings auf eine korrekte Funktion der Texterkennung angewiesen und funktioniert erfahrungsgemäß nur in manchen Fällen, sodass mindestens eine manuelle Überprüfung trotzdem notwendig kommt. Wenn beispielsweise ein Brief mit dem Satz "ich dachte, ich hätte den Haftungsausschluss bereits abgegeben, könntet ihr dies bitte prüfen" erfasst wird, würde der basierend auf der Regel ebenfalls kategorisiert werden.
1018 +Als Format r den Code wurde PDF417 ausgewählt, da dieser mehr Platz und Fehlerkorrektur bietet. Weiterhin gibt es eine einfach zu nutzende Library für Python (Erzeugung) und PDF417 wird von (% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %)ZXING unterstützt, welches in Paperless eingebettet ist. Ein solcher Barcode sieht beispielsweise so aus:
769 769  
770 -Aus diesem Grund nutzen wir einen speziellen QR Code in einem für den Makerspace spezifischen Format, welches nachstehend detailliert beschrieben wird.
1020 +(% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %)[[image:attach:barcode.jpg||height="250"]]
771 771  
772 -{{code language="json"}}
773 -{
774 - "payload": {
775 -        "timestamp": "YYYY-MM-DDTHH:mm:ss",
776 - "correspondent": "Daniel Herrmann (#250)",
777 - "type": "mksp-doc-sepamandat",
778 - "tags": [
779 - "tag1",
780 - "tag2"
781 - ],
782 -"storage_path": "Mitgliederverwaltung"
783 - },
784 - "sig": "signature over the entire payload block"
785 -}
786 -{{/code}}
1022 +(% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %)Daraus kann dann eine Base64 basierte Repräsentation berechnet werden, die einfach in Docuseal hochgeladen werden kann.
787 787  
788 -Die beiden Einträge **payload** und **sig** sind **Pflichtfelder**. Innerhalb der Payload muss der **timestamp** **vorhanden** sein, alle anderen Felder sind optional, jedoch muss mindestens eins angegeben werden. Der QR Code kann dann - insbesondere bei der Digitalen Unterschrift oder bei Workflows, wo die Formulare ohnehin on demand erzeugt werden bereits mit allen Daten bestückt werden. In Paperless gibt es dann ein Postconsume Script, welches den QR Code ausliest, die Signatur prüft und - falls die Signatur korrekt ist - automatisch die Meta-Daten übernimmt.
1024 +=== {{id name="DigitaleMitgliederverwaltung-Referenz-Implementierung"/}}Referenz-Implementierung ===
789 789  
790 -=== {{id name="DigitaleMitgliederverwaltung-Signatur"/}}Signatur ===
1026 +Eine Referenz-Implementierung befindet sich im Makerspace Gitlab: [[https:~~/~~/git.makerspace-darmstadt.de/makerspace-it-infrastructure/mitgliederverwaltung/paperless-pdf417-reference>>url:https://git.makerspace-darmstadt.de/makerspace-it-infrastructure/mitgliederverwaltung/paperless-pdf417-reference||shape="rect"]]
791 791  
792 -Die Signatur wird kryptographisch mit Hilfe asymmetrischen Verschlüsselung erzeugt. Wir erzeugen ein RSA 2048 Key Pair. Der öffentliche Schlüssel steht Paperless zur Verfügung, sodass Paperless die Signaturen verifizieren kann. Der private Teil des Schlüssels wird von den Makerspace-Systemem verwendet, welche die Formulare erzeugen. Im Detail:
1028 +=== {{id name="DigitaleMitgliederverwaltung-PostConsumptionScript"/}}Post Consumption Script ===
793 793  
794 -* **Key-Pair**: 2048 bit Schlüssellänge, RSA, 65537 Exponent
795 -* **Signatur**: SHA256 Signatur, PKCS1v15 Padding
796 -* (((
797 -**Payload**: Als Payload wird nur der Inhalt der Payload verwendet, als **JSON String ohne Whitespaces, byte encoded in UTF-8.** Das oben genannte Beispiel würde die Signatur über den folgenden String erstellen:
798 -\\
1030 +Die eigentliche Zuordnung der Meta-Daten erfolgt über ein so genanntes Post Consumption Script. Dieses befindet sich ebenfalls im Makerspace Gitlab: [[https:~~/~~/git.makerspace-darmstadt.de/makerspace-it-infrastructure/mitgliederverwaltung/paperless-post-consumption-script#>>url:https://git.makerspace-darmstadt.de/makerspace-it-infrastructure/mitgliederverwaltung/paperless-post-consumption-script||shape="rect"]]
799 799  
800 -{{code language="json"}}
801 -{"payload":{"correspondent":"Daniel Herrmann (#250)","type":"SEPA Mandat","tags":["tag1","tag2"]},"timestamp":"YYYY-MM-DDTHH:mm:ss","sig":"this-would-be-the-signature-appended-to-the-data"}
802 -{{/code}}
1032 +== {{id name="DigitaleMitgliederverwaltung-PaperlessBerechtigungen"/}}Paperless Berechtigungen ==
803 803  
1034 +Paperless NGX hat ein Berechtigungssystem, welches sich über fast alle Ressourcen erstreckt. Grundsätzlich gibt es **Benutzer** und **Gruppen**. Berechtigungen können dann global vergeben werden (Sichtbarkeit von Features) und zusätzlich auf Objektebene vergeben werden.
804 804  
805 -Als Referenz, die in Python wäre der Input der Signatur:
1036 +=== {{id name="DigitaleMitgliederverwaltung-BenutzerundGruppen"/}}Benutzer und Gruppen ===
1037 +
1038 +Paperless NGX ist so konfiguriert, dass sich Benutzer mit ihrem zentralen Makerspace Login anmelden können (OIDC über Keycloak). Eine Anmeldung mit lokalen Zugangsdaten ist nicht möglich. Bei der Anmeldung werden ebenfalls die Gruppen aus Keycloak übernommen, aber nur die folgenden:
1039 +
1040 +* **Vorstand**: Für die Mitglieder des Vorstands
1041 +* **Mitgliederverwaltung**: Alle Personen, die mit der Verwaltung der Mitglieder betraut sind
1042 +* **IT Admin**: IT Administratoren im Makerspace
1043 +
1044 +Nutzer, die keine dieser Gruppen angehören haben keine Rechte in Paperless. Sie können sich zwar anmelden, aber selbst die Willkommens-Seite erzeugt eine "Permission Denied" Fehlermeldung.
1045 +
1046 +=== {{id name="DigitaleMitgliederverwaltung-GlobaleBerechtigungen"/}}Globale Berechtigungen ===
1047 +
1048 +Berechtigungen werden grundsätzlich nicht auf Benutzerebene konfiguriert, sondern ausschließlich auf Gruppenebene. So wird sichergestellt, dass bei der Änderung einer Gruppenzugehörigkeit auch die damit verbundenen Rechte entzogen oder gewährt werden, ohne dass eine manuelle Änderung notwendig ist. Die folgende Tabelle gibt eine Übersicht der konfigurierten globalen Berechtigungen pro Gruppe:
1049 +
1050 +|=(% scope="row" %)(((
1051 +Berechtigung
1052 +)))|=(% scope="col" %)(((
1053 +Beschreibung
1054 +)))|=(% scope="col" %)(((
1055 +Mitgliederverwaltung
1056 +)))|=(% scope="col" %)(((
1057 +Vorstand
1058 +)))|=(% scope="col" %)(((
1059 +IT Admin
1060 +)))|=(% scope="col" %)(((
1061 +Notiz
1062 +)))
1063 +|=(% scope="row" %)(((
1064 +Document
1065 +)))|(((
1066 +Sehen und bearbeiten von Dokumenten.
1067 +)))|(((
1068 +ALLE
1069 +)))|(((
1070 +ALLE
1071 +)))|(((
1072 +KEINE
1073 +)))|(((
1074 +Wird zusätzlich durch Berechtigungen auf Objekt-Level eingeschränkt
1075 +)))
1076 +|=(% scope="row" %)(((
1077 +Tag
1078 +)))|(((
1079 +Sehen und bearbeiten von Tags.
1080 +)))|(((
1081 +Anzeigen
1082 +)))|(((
1083 +ALLE
1084 +)))|(((
1085 +ALLE
1086 +)))|(((
1087 +Wird zusätzlich durch Berechtigungen auf Objekt-Level eingeschränkt
1088 +)))
1089 +|=(% scope="row" %)(((
1090 +Correspondent
1091 +)))|(((
1092 +Sehen und bearbeiten von Korrespondenten
1093 +)))|(((
1094 +Anzeigen
1095 +)))|(((
1096 +ALLE
1097 +)))|(((
1098 +ALLE
1099 +)))|(((
1100 +Wird zusätzlich durch Berechtigungen auf Objekt-Level eingeschränkt
1101 +)))
1102 +|=(% scope="row" %)(((
1103 +DocumentType
1104 +)))|(((
1105 +Sehen und bearbeiten von Dokument-Typen
1106 +)))|(((
1107 +Anzeigen
1108 +)))|(((
1109 +ALLE
1110 +)))|(((
1111 +ALLE
1112 +)))|(((
1113 +Wird zusätzlich durch Berechtigungen auf Objekt-Level eingeschränkt
1114 +)))
1115 +|=(% scope="row" %)(((
1116 +StoragePath
1117 +)))|(((
1118 +Sehen und bearbeiten von Speicherpfaden
1119 +)))|(((
1120 +Anzeigen
1121 +)))|(((
1122 +Anzeigen
1123 +)))|(((
1124 +ALLE
1125 +)))|(((
1126 +Wird zusätzlich durch Berechtigungen auf Objekt-Level eingeschränkt
1127 +)))
1128 +|=(% scope="row" %)(((
1129 +SavedView
1130 +)))|(((
1131 +Ansichten erzeugen und speichern
1132 +)))|(((
1133 +ALLE
1134 +)))|(((
1135 +ALLE
1136 +)))|(((
1137 +KEINE
1138 +)))|(((
806 806  \\
1140 +)))
1141 +|=(% scope="row" %)(((
1142 +PaperlessTask
1143 +)))|(((
1144 +Dateiaufgaben einsehen und löschen
1145 +)))|(((
1146 +KEINE
1147 +)))|(((
1148 +KEINE
1149 +)))|(((
1150 +ALLE
1151 +)))|(((
1152 +\\
1153 +)))
1154 +|=(% scope="row" %)(((
1155 +AppConfig
1156 +)))|(((
1157 +Konfiguration von Paperless NGX selbst
1158 +)))|(((
1159 +KEINE
1160 +)))|(((
1161 +KEINE
1162 +)))|(((
1163 +ALLE
1164 +)))|(((
1165 +\\
1166 +)))
1167 +|=(% scope="row" %)(((
1168 +UISettings
1169 +)))|(((
1170 +Persönliche Anzeigeeinstellungen ändern
1171 +)))|(((
1172 +ALLE
1173 +)))|(((
1174 +ALLE
1175 +)))|(((
1176 +ALLE
1177 +)))|(((
1178 +\\
1179 +)))
1180 +|=(% scope="row" %)(((
1181 +History
1182 +)))|(((
1183 +Dokumenten-Audit Log anzeigen oder ändern
1184 +)))|(((
1185 +Anzeigen
1186 +)))|(((
1187 +Anzeigen
1188 +)))|(((
1189 +KEINE
1190 +)))|(((
1191 +Nur für Dokumente, auf die Zugriff gewährt wurde.
1192 +)))
1193 +|=(% scope="row" %)(((
1194 +Note
1195 +)))|(((
1196 +Notizen zu Dokumenten einsehen oder ändern
1197 +)))|(((
1198 +ALLE
1199 +)))|(((
1200 +ALLE
1201 +)))|(((
1202 +KEINE
1203 +)))|(((
1204 +Nur für Dokumente, auf die Zugriff gewährt wurde.
1205 +)))
1206 +|=(% scope="row" %)(((
1207 +MailAccount
1208 +)))|(((
1209 +Mail-Accounts verwalten
1210 +)))|(((
1211 +KEINE
1212 +)))|(((
1213 +Anzeigen
1214 +)))|(((
1215 +ALLE
1216 +)))|(((
1217 +\\
1218 +)))
1219 +|=(% scope="row" %)(((
1220 +MailRule
1221 +)))|(((
1222 +Verarbeitungsregeln für eingehende Mails bearbeiten
1223 +)))|(((
1224 +KEINE
1225 +)))|(((
1226 +ALLE
1227 +)))|(((
1228 +ALLE
1229 +)))|(((
1230 +\\
1231 +)))
1232 +|=(% scope="row" %)(((
1233 +User
1234 +)))|(((
1235 +Benutzer einsehen oder verwalten
1236 +)))|(((
1237 +KEINE
1238 +)))|(((
1239 +Anzeigen
1240 +)))|(((
1241 +ALLE
1242 +)))|(((
1243 +\\
1244 +)))
1245 +|=(% scope="row" %)(((
1246 +Group
1247 +)))|(((
1248 +Gruppen einsehen oder verwalten
1249 +)))|(((
1250 +KEINE
1251 +)))|(((
1252 +Anzeigen
1253 +)))|(((
1254 +ALLE
1255 +)))|(((
1256 +\\
1257 +)))
1258 +|=(% scope="row" %)(((
1259 +ShareLink
1260 +)))|(((
1261 +Öffentliche Share-Links erstellen oder verwalten
1262 +)))|(((
1263 +KEINE
1264 +)))|(((
1265 +KEINE
1266 +)))|(((
1267 +KEINE
1268 +)))|(((
1269 +\\
1270 +)))
1271 +|=(% scope="row" %)(((
1272 +CustomField
1273 +)))|(((
1274 +Custom Fields einsehen oder verwalten
1275 +)))|(((
1276 +Anzeigen
1277 +)))|(((
1278 +Anzeigen
1279 +)))|(((
1280 +ALLE
1281 +)))|(((
1282 +\\
1283 +)))
1284 +|=(% scope="row" %)(((
1285 +Workflow
1286 +)))|(((
1287 +Workflows für neue Dokumente einsehen oder verwalten
1288 +)))|(((
1289 +KEINE
1290 +)))|(((
1291 +KEINE
1292 +)))|(((
1293 +ALLE
1294 +)))|(((
1295 +\\
1296 +)))
807 807  
808 -{{code language="python"}}
809 -import json
1298 +=== {{id name="DigitaleMitgliederverwaltung-Objekt-Berechtigungen"/}}Objekt-Berechtigungen ===
810 810  
811 -input_data = {'payload': {'correspondent': 'Daniel Herrmann (#250)', 'type': 'SEPA Mandat', 'tags': ['tag1', 'tag2']}, 'timestamp': 'YYYY-MM-DDTHH:mm:ss', 'sig': 'this-would-be-the-signature-appended-to-the-data'}
812 -signature_data = json.dumps(input_data, separators=(',', ':')).encode('utf-8')
813 -{{/code}}
1300 +Zusätzlich zu den globalen Berechtigungen können für alle Objekte noch Berechtigungen auf Objekt-Level konfiguriert werden. Dabei werden globale Regeln zuerst geprüft, danach zusätzlich die Objekt-Berechtigungen. Jedes Objekt (egal ob Dokument, Korrespondent, Tag, Dokumenten-Typ) hat zwei wichtige Einstellungen:
1301 +
1302 +* Owner / Eigentümer: Das Objekt gehört diesem Benutzer. Der Owner hat immer alle Berechtigungen für das Objekt
1303 +* Zusätzliche Berechtigungen:
1304 +** Es können getrennt voneinander Berechtigungen zum Anzeigen und Bearbeiten vergeben werden
1305 +** Diese Berechtigungen können jeweils für einzelne Benutzer oder für Gruppen gewährt werden
1306 +
1307 +Das sieht im Frontend beispielsweise so aus:
1308 +
1309 +[[image:attach:image-2025-8-25_10-19-25.png||thumbnail="true" height="250"]]
1310 +
1311 +{{info title="Berechtigungen"}}
1312 +Es sind grundsätzlich sowohl globale als auch objekt-spezifische Berechtigungen notwendig. Wenn ein Benutzer ein Objekt bearbeiten ansehen oder bearbeiten möchte ergibt sich daher die folgende Matrix:
1313 +
1314 +|=(% scope="col" %)(((
1315 +Globale Berechtigung
1316 +)))|=(% scope="col" %)(((
1317 +Owner
1318 +)))|=(% scope="col" %)(((
1319 +Objekt-Berechtigung
1320 +)))|=(% scope="col" %)(((
1321 +Ergebnis
814 814  )))
1323 +|(((
1324 +❌️
1325 +)))|(((
1326 +Egal
1327 +)))|(((
1328 +Egal
1329 +)))|(((
1330 +❌️
1331 +)))
1332 +|(((
1333 +✅️
1334 +)))|(((
1335 +✅️
1336 +)))|(((
1337 +Egal
1338 +)))|(((
1339 +✅️
1340 +)))
1341 +|(((
1342 +✅️
1343 +)))|(((
1344 +❌️
1345 +)))|(((
1346 +❌️
1347 +)))|(((
1348 +❌️
1349 +)))
1350 +|(((
1351 +✅️
1352 +)))|(((
1353 +❌️
1354 +)))|(((
1355 +✅️
1356 +)))|(((
1357 +✅️
1358 +)))
815 815  
816 -\\
1360 +Mit anderen Worten, um eine Aktion auszuführen, muss ein Benutzer (a) die globale Berechtigung haben **UND** (b) Owner sein **ODER** Objekt-Berechtigungen haben.
1361 +{{/info}}
817 817  
818 -== {{id name="DigitaleMitgliederverwaltung-TechnischesSetup"/}}Technisches Setup ==
1363 +=== {{id name="DigitaleMitgliederverwaltung-LokaleOwner"/}}Lokale Owner ===
819 819  
820 -Owner: zwei Owner
821 -Docs: Owner = grp owner, View + Edit jeweilige Gruppen
822 -Correspondent: owner = grp owner, view = jeweilige Gruppe, edit = it admin
823 -Tag: owner = grp owner, view = jeweilige Gruppe, edit = it admin
824 -Doc Type: owner = grp owner, view = jeweilige Gruppe, edit = it admin
1365 +Jedes Objekt in Paperless muss einen Owner haben. Damit der Owner nicht ein realer Benutzer ist, der gegebenenfalls den Vorstand / Mitgliederverwaltung oder Verein verlassen könnte, werden lokale Benutzer angelegt. Diese halten lediglich die Owner Rolle für die Ressourcen, können aber nicht für den Login verwendet werden.
825 825  
826 -TODO
1367 +|=(% scope="row" %)(((
1368 +Benutzer
1369 +)))|=(% scope="col" %)(((
1370 +Verwendet für
1371 +)))
1372 +|=(% scope="row" %)(((
1373 +mksp-mv-owner
1374 +)))|(((
1375 +Alle Objekte (Dokumente, Dokumenttypen, Tags, Korrespondenten und Speicherpfade), die dem Use-Case **Mitgliederverwaltung** zugewiesen sind
1376 +)))
1377 +|=(% scope="row" %)(((
1378 +mksp-vs-owner
1379 +)))|(((
1380 +Alle Objekte (Dokumente, Dokumenttypen, Tags, Korrespondenten und Speicherpfade), die dem Use-Case **Vorstandspost** zugewiesen sind
1381 +)))
827 827  
828 -\\
1383 +=== {{id name="DigitaleMitgliederverwaltung-Standard-Objekt-Berechtigungen"/}}Standard-Objekt-Berechtigungen ===
829 829  
830 -=== {{id name="DigitaleMitgliederverwaltung-AusFace2Faceam20.8(DH,YS)"/}}Aus Face 2 Face am 20.8  (DH,YS) ===
1385 +Basierend auf den hier beschrieben Regeln werden für Objekte die folgenden Berechtigungen gesetzt:
831 831  
832 -* Schritt 1: Einweisungszettel erzeugen 
833 -** Checkliste in Directus hinterlegen, eine pro Einweisung
834 -** N8n Workflow, welches die Liste aus Directus herunterlädt und Template mit Puppetteer Script Node erzeugen
835 -** Aus diesem Template dann ein DocuSeal Template erstellen
836 -* Schritt 2: Zettel für Einweisungen generieren
837 -** Tablet für Einweiser im makerspace
838 -** Authentifizierung über Token an der Freigabebox
839 -*** Neue Maschine, User schaltet die Maschine "Tablet" frei
840 -*** Datenbank erzeugt JWT und signiert es mit einem RSA Priv Key
841 -*** Wird als Payload in der MQTT unlock message mitgeschickt
842 -** Tablet nutzt dieses Token für API Requests gegen Homepage Backend
843 -** Backend wird um weitere Middleware angepasst, die dieses Token für manche Endpoints akzeptiert
844 -** Einweiser:in bekommt aktive Einweisung angezeigt und kann Teilnehmer Entfernern (no-show) oder hinzufügen (spontan)
845 -*** Option eine Einweisung ohne Rechnungsstellung vorzunehmen
846 -** PDFs werden automatisch ausgedruckt
847 -*** Tablet triggert einen Backend endpoint
848 -**** übergibt teilnehmer als parameter (auth über token) und
849 -**** erzeugt die entsprechenden PDFs in DocuSeal
850 -**** Gibt PDF als Return
851 -*** Tablet kann PDF über Netzwerk print drucken
852 -* Schritt 3: Einweisungen erfassen
853 -** QR code wird in Schritt 2 aufgedruckt und enthält:
854 -*** Einweisung
855 -*** Datum
856 -*** Einweiser
857 -*** Teilnehmer
858 -*** Flag Rechnung
859 -** Dokument wird über ScanSnap eingescannt und automatisch an paperless übergeben
860 -** Paperless Post Consume erkennt den QR Code, validiert ihn und löst über einen Webook einen Flow in N8n aus
861 -** N8n erstellt dann einen temporären Eintrag im Backend, ähnlich dem der heute bei "Einweisung erfassen" sichtbar ist
862 -** Die Mitgliederverwaltung hat dann x Tage Zeit, die Einträge zu korrigieren und zu prüfen (beispielsweise ob Voraussetzungen erfüllt sind)
863 -** Danach werden alle Schritte wie bisher ausgelöst (Berechtigung, Rechnung, Auszahlung an Einweiser, E-Mail Bestätigung, ...)
1387 +|=(% rowspan="2" scope="rowgroup" %)(((
1388 +Objekt
1389 +\\
1390 +)))|=(% colspan="3" scope="colgroup" %)(((
1391 +Mitgliederverwaltung
1392 +)))|=(% rowspan="7" scope="rowgroup" %)(((
1393 +\\
1394 +)))|=(% colspan="3" scope="colgroup" %)(((
1395 +Vorstandspost
1396 +)))
1397 +|=(% scope="col" %)(((
1398 +Owner
1399 +)))|=(% scope="col" %)(((
1400 +Anzeigen
1401 +)))|=(% scope="col" %)(((
1402 +Bearbeiten
1403 +)))|=(((
1404 +Owner
1405 +)))|=(((
1406 +Anzeigen
1407 +)))|=(((
1408 +Bearbeiten
1409 +)))
1410 +|=(% scope="row" %)(((
1411 +Dokument
1412 +)))|(((
1413 +mksp-mv-owner
1414 +)))|(((
1415 +Mitgliederverwaltung
1416 +)))|(((
1417 +Mitgliederverwaltung
1418 +)))|(((
1419 +mksp-vs-owner
1420 +)))|(((
1421 +Vorstand
1422 +)))|(((
1423 +Vorstand
1424 +)))
1425 +|=(% scope="row" %)(((
1426 +Dokumenttyp
1427 +)))|(((
1428 +mksp-mv-owner
1429 +)))|(((
1430 +Mitgliederverwaltung, IT Admin
1431 +)))|(((
1432 +IT Admin
1433 +)))|(((
1434 +mksp-vs-owner
1435 +)))|(((
1436 +Vorstand
1437 +)))|(((
1438 +Vorstand
1439 +)))
1440 +|=(% scope="row" %)(((
1441 +Tag
1442 +)))|(((
1443 +mksp-mv-owner
1444 +)))|(((
1445 +Mitgliederverwaltung, IT Admin
1446 +)))|(((
1447 +IT Admin
1448 +)))|(((
1449 +mksp-vs-owner
1450 +)))|(((
1451 +Vorstand
1452 +)))|(((
1453 +Vorstand
1454 +)))
1455 +|=(% scope="row" %)(((
1456 +Korrespondent
1457 +)))|(((
1458 +mksp-mv-owner
1459 +)))|(((
1460 +Mitgliederverwaltung, IT Admin
1461 +)))|(((
1462 +IT Admin
1463 +)))|(((
1464 +mksp-vs-owner
1465 +)))|(((
1466 +Vorstand
1467 +)))|(((
1468 +Vorstand
1469 +)))
1470 +|=(% scope="row" %)(((
1471 +Speicherpfad
1472 +)))|(((
1473 +mksp-mv-owner
1474 +)))|(((
1475 +Mitgliederverwaltung, IT Admin
1476 +)))|(((
1477 +IT Admin
1478 +)))|(((
1479 +mksp-vs-owner
1480 +)))|(((
1481 +Vorstand
1482 +)))|(((
1483 +IT Admin
1484 +)))
864 864  
865 -TODO:
1486 += {{id name="DigitaleMitgliederverwaltung-OffenePunkte"/}}Offene Punkte =
866 866  
867 867  * Docuseal Logging + Monitoring
868 868  * N8n Error Handling
Icon Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -202867224
1 +205586482
URL
... ... @@ -1,1 +1,1 @@
1 -https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/202867224/Digitale Mitgliederverwaltung
1 +https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/205586482/Digitale Mitgliederverwaltung