Änderungen von Dokument Digitale Mitgliederverwaltung

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

Von Version Icon 32.1 Icon
bearbeitet von Daniel Herrmann
am 2025/08/22 18:02
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version Icon 46.1 Icon
bearbeitet von Daniel Herrmann
am 2025/08/27 20:14
Ä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).
... ... @@ -78,7 +78,7 @@
78 78  )))|=(% scope="col" %)(((
79 79  Prozess heute
80 80  )))|=(% scope="col" %)(((
81 -Prozess Zukunft
85 +Notwendige Änderungen
82 82  )))
83 83  |(((
84 84  Mitgliedsantrag
... ... @@ -92,7 +92,7 @@
92 92  * Nach Eingang: Mitgliederverwaltung prüft den Antrag und genehmigt ihn
93 93  * Mitgliederakte wird angelegt, der Antrag wird in der Akte abgeheftet
94 94  )))|(((
95 -Der Antrag kann komplett **digital unterschrieben** werden. Vorgehen:
99 +Der Antrag soll komplett **digital unterschrieben** werden. Vorgehen:
96 96  
97 97  * Interessent:in füllt den Online-Antrag auf der Homepage aus
98 98  * Nach Bestätigung der E-Mail Adresse wird ein Vorgang zur digitalen Unterschrift ausgelöst
... ... @@ -163,11 +163,7 @@
163 163  Ist ein Blanko-Formular, welches ausgefüllt, eingeworfen und abgeheftet wird.
164 164  Danach wird ein Flag für das jeweilige Mitglied gesetzt, dass die Erklärung abgegeben wurde.
165 165  )))|(((
166 -**Vollständig digital**.
167 -
168 -* Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage)
169 -* Mitglied erhält die Aufforderung per Mail das Dokument zu unterschreiben
170 -* 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.
171 171  )))
172 172  |(((
173 173  Übungsleitervertrag
... ... @@ -181,12 +181,9 @@
181 181  * Bestätigung dass der Vertrag vorliegt
182 182  * Ein Flag ob das Mitglied die Übungsleiterpauschale an den Verein spendet oder nicht
183 183  )))|(((
184 -**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.
185 185  
186 -* Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage)
187 -* Mitglied erhält die Aufforderung per Mail das Dokument zu unterschreiben
188 -* Nach Unterschrift wird das erste automatisch gesetzt und das Dokument wird zu Paperless NGX hochgeladen.
189 -* 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.
190 190  )))
191 191  |(((
192 192  Nutzungsvereinbarung Schulungsinhalte
... ... @@ -197,7 +197,7 @@
197 197  
198 198  Urheberrecht, Übertragung von Nutzungsrechten sollte in Schriftform erfolgen
199 199  )))|(((
200 -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.
201 201  )))
202 202  |(((
203 203  Bestellung eines Einweisers
... ... @@ -258,7 +258,7 @@
258 258  ** Muss für den Einweisenden eine Auszahlung veranlasst werden?
259 259  * Danach wird der Zettel in die jeweiligen Akten einsortiert.
260 260  )))|(((
261 -\\
258 +Der Einweisungszettel ist das bei weitem komplizierteste Dokument, hierfür wird ein separater Workshop stattfinden. Siehe weiter unten für Details.
262 262  )))
263 263  |(((
264 264  Lagervertrag Kistenlager
... ... @@ -272,7 +272,7 @@
272 272  
273 273  Nach Erfassen kann die Person eine Kiste beantragen, die dann monatliche Kosten auslöst
274 274  )))|(((
275 -\\
272 +**Vollständig digital**, die Papierform entfällt. Self-Service durch Nutzer:in.
276 276  )))
277 277  |(((
278 278  Lagervertrag Projektlager
... ... @@ -286,7 +286,7 @@
286 286  
287 287  Nach Erfassen kann die Person das Projektlager automatisch nutzen.
288 288  )))|(((
289 -\\
286 +**Vollständig digital**, die Papierform entfällt. Self-Service durch Nutzer:in.
290 290  )))
291 291  
292 292  == {{id name="DigitaleMitgliederverwaltung-WorkflowBeschreibung"/}}Workflow Beschreibung ==
... ... @@ -428,7 +428,7 @@
428 428  
429 429  === {{id name="DigitaleMitgliederverwaltung-AblegenundVerarbeiten"/}}Ablegen und Verarbeiten ===
430 430  
431 -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:
428 +Egal welcher Prozess angewandt wird, das Dokument muss am Ende in Paperless eingelesen und mit den Metadaten (siehe unten) versehen werden. Hier gibt es drei verschiedene Varianten:
432 432  
433 433  (% class="wrapped" %)
434 434  |=(% scope="col" %)(((
... ... @@ -467,7 +467,7 @@
467 467  Das Dokument wird von der Mitgliederverwaltung eingescannt und dann von Paperless verarbeitet
468 468  )))
469 469  
470 -In allen Fällen sollte das Dokument einen QR Code enthalten, der die automatische Zuordnung von Meta-Daten ermöglicht. Weiterhin wird vom Post-Consumption Script ein NATS Event für jedes erfolgreich erkannte Dokument erstellt, welches dann vom N8n verarbeitet werden kann. Darüber lassen sich beispielsweise Einweisungszettel im Backend erfassen.
467 +In allen Fällen sollte das Dokument einen QR Code enthalten, der die automatische Zuordnung von Metadaten ermöglicht. Weiterhin wird vom Post-Consumption Script ein NATS Event für jedes erfolgreich erkannte Dokument erstellt, welches dann vom N8n verarbeitet werden kann. Darüber lassen sich beispielsweise Einweisungszettel im Backend erfassen.
471 471  
472 472  = {{id name="DigitaleMitgliederverwaltung-TechnischesDesign"/}}Technisches Design =
473 473  
... ... @@ -687,8 +687,24 @@
687 687  
688 688  **Beispiele**: Einweisungszettel für Vor-Ort Online-Einweisungen
689 689  
690 -{{confluence_drawio border="true" diagramName="Fall 4 Ablaufdiagramm" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1138" height="499" revision="1"/}}
687 +{{confluence_drawio border="true" diagramName="Fall 4 Ablaufdiagramm" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1208" height="523" revision="3"/}}
691 691  
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 +
692 692  = {{id name="DigitaleMitgliederverwaltung-PaperlessNGX"/}}Paperless NGX =
693 693  
694 694  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**.
... ... @@ -703,8 +703,17 @@
703 703  * **Per Ordner**: Auf unserem NAS gibt es einen speziellen Ordner, der in Paperless eingebunden ist. Alle Dokumente, die in diesen Ordner gelegt werden, werden automatisch von Paperless verarbeitet. Dieser Ordner wird hauptsächlich vom Dokumentenscanner verwendet, der die gescannten Dokumente ablegt. Dies ermöglicht einen einfachen Scan mit einem einfachen Button, die Dokumente werden dann automatisch in Paperless erkannt
704 704  * **Per Weboberfläche**: Es ist ebenfalls möglich, Dokumente manuell über die Weboberfläche hinzuzufügen.
705 705  
706 -== {{id name="DigitaleMitgliederverwaltung-Meta-Daten"/}}Meta-Daten ==
719 +Die folgenden Grafik gibt eine Übersicht:
707 707  
721 +{{confluence_drawio border="true" diagramName="Ingest Diagram" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1016" height="451" revision="3"/}}
722 +
723 +Die Konfiguration des Scanners ist so eingerichtet, dass nur zwei Buttons auf dem Display sichtbar sind:
724 +
725 +* **SCAN Vorstand** - Platziert das Dokument in dem Consumption Ordner für den Vorstand, Rechte und Tags werden dann automatisch gesetzt
726 +* **SCAN MV** - Platziert das Dokument in dem Consumption Ordner für die Mitgliederverwaltung, Rechte und Tags werden dann automatisch gesetzt
727 +
728 +== {{id name="DigitaleMitgliederverwaltung-ÜbersichtderMetadaten"/}}Übersicht der Metadaten ==
729 +
708 708  Dokumente werden dann Meta-Daten zugeordnet, die eine spätere Suche und Zuordnung erleichtern. Diese Meta-Daten sind:
709 709  
710 710  * **Korrespondent**: Im Prinzip der "Gesprächspartner", beispielsweise der Absender eines Briefs. Im Falle der Mitgliederverwaltung wird für jedes Mitglied und jeden registrierten Gast automatisch im Hintergrund ein Korrespondent angelegt. Die Korrespondenten heißen:
... ... @@ -714,186 +714,770 @@
714 714  * **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":
715 715  ** (% 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.
716 716  ** (% 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.
739 +* **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.
740 +** Mitgliedsantrag
741 +** SEPA Lastschriftmandat
742 +** Studienbescheinigung
743 +** Bestätigung Schlüsselausgabe
744 +** Verpflichtungserklärung Datenschutz
745 +** Übungsleitervertrag
746 +** Nutzungsvereinbarung Schulungsinhalte
747 +** Bestellung als Einweiser:in
748 +** Haftungsausschluss
749 +** Einweisungszettel
750 +** Lagervertrag Kistenlager
751 +** Lagervertrag Projektlager
717 717  * (((
718 -**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.
753 +**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"]].
754 +\\{{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 (%%)[[
755 +
756 +{{code language="none"}}
757 +document renamer
758 +{{/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}}
759 +In unserem Fall kommen die folgenden Speicherpfade zum Einsatz:
719 719  \\
720 720  
721 -(% class="wrapped" %)
722 722  |=(% scope="col" %)(((
723 723  Name
724 724  )))|=(% scope="col" %)(((
725 -Exact Match String
765 +Definition
766 +)))|=(% scope="col" %)(((
767 +Sichtbar für
768 +)))|=(% scope="col" %)(((
769 +Anwendung
726 726  )))
727 727  |(((
728 -Mitgliedsantrag
772 +Mitglieder Einweisungszettel
729 729  )))|(((
730 -mksp-doc-mitgliedsantrag
774 +(% class="code" %)
775 +(((
776 +~{~{ correspondent }}/Einweisungen/~{~{ document_type }}-~{~{ tag_list }}-~{~{ created }}-~{~{ doc_pk }}
731 731  )))
778 +)))|(((
779 +Mitgliederverwaltung
780 +)))|(((
781 +Einweisungszettel
782 +)))
732 732  |(((
733 -SEPA Lastschriftmandat
784 +Mitglieder Unterlagen
734 734  )))|(((
735 -mksp-doc-sepamandat
786 +(% class="code" %)
787 +(((
788 +~{~{ correspondent }}/~{~{ document_type }}-~{~{ created }}-~{~{ doc_pk }}
736 736  )))
790 +)))|(((
791 +Mitgliederverwaltung
792 +)))|(((
793 +Alle anderen Mitgliederdokumente
794 +)))
737 737  |(((
738 -Studienbescheinigung
796 +Vorstand Dokumente
739 739  )))|(((
740 -mksp-doc-studienbescheinigung
798 +(% class="code" %)
799 +(((
800 +~{~{ created_year }}/~{~{ correspondent }}/~{~{ title }}
741 741  )))
802 +)))|(((
803 +Vorstand
804 +)))|(((
805 +Alle Vorstandsdokumente
806 +)))
807 +)))
808 +
809 +== {{id name="DigitaleMitgliederverwaltung-AutomatischeZuordnungvonMetadaten"/}}Automatische Zuordnung von Metadaten ==
810 +
811 +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.
812 +
813 +**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).**
814 +
815 +=== {{id name="DigitaleMitgliederverwaltung-Barcodeerzeugen"/}}(% style="color:var(--ds-text-accent-purple-bolder,#352c63);" %)Barcode erzeugen(%%) ===
816 +
817 +(% style="color:var(--ds-text-accent-purple-bolder,#352c63);" %)Der Prozess zur Erzeugung eines QR Codes ist wie folgt:
818 +
819 +* **Payload (Daten) festlegen**. Einige Werte sind verpflichtend, andere können nach Bedarf optional hinzugefügt werden.
820 +* JWT erzeugen und signieren. der JWT besteht aus drei Teilen:
821 +** **Header**: **alg** (Algorithmus) und **typ** (JWT) sind verpflichtend. Zusätzlich fügen wir einen Timestamp, eine eindeutige ID und eine Gültigkeitsdauer hinzu.
822 +** **Body**: beinhaltet die eigentlichen Daten.
823 +** **Signature**: Mit Hilfe eines Secrets und wird die Signatur erzeugt und automatisch angehängt.
824 +* PDF417 code erzeugen: ein JWT ist per Definition URL safe und kann daher einfach in ein QR code umgewandelt werden.
825 +
826 +=== {{id name="DigitaleMitgliederverwaltung-Header"/}}Header ===
827 +
828 +Der Header enthält wichtige Meta-Daten, diese werden von der JWT Library automatisch erzeugt und beschreiben in der Regel den verwendeten Key-Typ.
829 +
830 +=== {{id name="DigitaleMitgliederverwaltung-Body"/}}Body ===
831 +
832 +Die folgenden Claims sind im Body verfügbar:
833 +
834 +|=(((
835 +Claim
836 +)))|=(((
837 +Type
838 +)))|=(((
839 +Pflicht
840 +)))|=(((
841 +Beschreibung
842 +)))
742 742  |(((
743 -Formular Schlüsselausgabe
844 +id
744 744  )))|(((
745 -mksp-doc-schluesselausgabe
846 +UUID4
847 +)))|(((
848 +✅️
849 +)))|(((
850 +Eindeutige ID dieses Dokuments
746 746  )))
747 747  |(((
748 -Verpflichtungserklärung Datenschutz
853 +time
749 749  )))|(((
750 -\\
855 +Zahl
856 +)))|(((
857 +✅️
858 +)))|(((
859 +UTC Linux-Timestamp an dem das Dokument und der QR Code erzeugt wurden
751 751  )))
752 752  |(((
753 -Übungsleitervertrag
862 +exp
754 754  )))|(((
755 -\\
864 +Zahl
865 +)))|(((
866 +✅️
867 +)))|(((
868 +UTC Linux-Timestamp der angibt, bis wann das Dokument gültig ist.
756 756  )))
757 757  |(((
758 -Nutzungsvereinbarung Schulungsinhalte
871 +(% class="code" %)
872 +(((
873 +typ
874 +)))
759 759  )))|(((
760 -\\
876 +String
877 +)))|(((
878 +✅️
879 +)))|(((
880 +Typ des Dokuments basierend auf der unten definierten Liste.
761 761  )))
762 762  |(((
763 -Bestellung eines Einweisers
883 +(% class="code" %)
884 +(((
885 +cor
886 +)))
764 764  )))|(((
765 -\\
888 +String
889 +)))|(((
890 +❌️
891 +)))|(((
892 +Optional: Name des Korrespondenten, dem das Dokument zugeordnet werden soll
766 766  )))
767 767  |(((
768 -Haftungsausschluss
895 +tags
769 769  )))|(((
770 -\\
897 +List[String]
898 +)))|(((
899 +❌️
900 +)))|(((
901 +Liste an Tags, die dem Dokument zugeordnet werden soll
771 771  )))
772 772  |(((
773 -Einweisungszettel
904 +spth
774 774  )))|(((
775 -\\
906 +String
907 +)))|(((
908 +❌️
909 +)))|(((
910 +Storage Path, das dem Dokument zugeordnet werden soll
776 776  )))
777 777  |(((
778 -Lagervertrag Kistenlager
913 +opt
779 779  )))|(((
780 -\\
915 +dict
916 +)))|(((
917 +❌️
918 +)))|(((
919 +Optionale Attribute, die mit eincodiert werden und dem N8n Workflow übergeben werden.
781 781  )))
921 +
922 +=== {{id name="DigitaleMitgliederverwaltung-Footer"/}}Footer ===
923 +
924 +Der Footer wird automatisch erzeugt und erhält eine Signatur über den Header und den Body, basierend auf einem Algorithmus und einer Signatur.
925 +
926 +{{confluence_tip title="Algorithmus"}}
927 +Von den meisten Libraries werden symmetrische und asymmetrische Signaturen unterstützt. Die Verwendung eines symmetrischen Algorithmus ist für uns einfacher.
928 +
929 +Für diesen Anwendungsfall nutzen wir (% style="text-decoration: none;color:var(--ds-text,#333333);" %)**HS256** (HMAC mit SHA-256 Algorithmus).
930 +{{/confluence_tip}}
931 +
932 +=== {{id name="DigitaleMitgliederverwaltung-AuswahlderLibrary"/}}Auswahl der Library ===
933 +
934 +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:
935 +
936 +|=(% scope="col" %)(((
937 +Name
938 +)))|=(% scope="col" %)(((
939 +CVE
940 +)))|=(% scope="col" %)(((
941 +Github
942 +)))|=(% scope="col" %)(((
943 +GH⭐
944 +)))|=(% scope="col" %)(((
945 +Letztes Release
946 +)))|=(% scope="col" %)(((
947 +Offene Issues
948 +)))|=(% scope="col" %)(((
949 +Dokumentation
950 +)))|=(% scope="col" %)(((
951 +Qualität Dokumentation
952 +)))|=(% scope="col" %)(((
953 +In Backend vorhanden?
954 +)))|=(% scope="col" %)(((
955 +In Paperless vorhanden?
956 +)))
782 782  |(((
783 -Lagervertrag Projektlager
958 +python-jose
784 784  )))|(((
785 -\\
960 +3/0
961 +)))|(((
962 +[[https:~~/~~/github.com/mpdavis/python-jose>>url:https://github.com/mpdavis/python-jose||shape="rect"]]
963 +)))|(((
964 +1.7k
965 +)))|(((
966 +28.05.2025
967 +)))|(((
968 +83
969 +)))|(((
970 +[[https:~~/~~/python-jose.readthedocs.io/en/latest/>>url:https://python-jose.readthedocs.io/en/latest/||shape="rect"]]
971 +)))|(((
972 +⛔ Wenige Bespiele, API Dokumentation fehlt komplett
973 +)))|(((
974 +❌️
975 +)))|(((
976 +❌️
786 786  )))
978 +|(((
979 +pyJWT
980 +)))|(((
981 +4/0
982 +)))|(((
983 +[[https:~~/~~/github.com/jpadilla/pyjwt>>url:https://github.com/jpadilla/pyjwt||shape="rect"]]
984 +)))|(((
985 +5.4k
986 +)))|(((
987 +28.11.2024
988 +)))|(((
989 +30
990 +)))|(((
991 +[[https:~~/~~/pyjwt.readthedocs.io>>url:https://pyjwt.readthedocs.io||shape="rect"]]
992 +)))|(((
993 +➕️ Gute Dokumentation, API, Beispiele, Changelog
994 +)))|(((
995 +✅️ 2.10.1
996 +Dep von firebase
997 +)))|(((
998 +✅️ 2.10.1
787 787  )))
788 -* **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"]].
789 -\\{{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 (%%)[[
1000 +|(((
1001 +JWCrypto
1002 +)))|(((
1003 +5/0
1004 +)))|(((
1005 +[[https:~~/~~/github.com/latchset/jwcrypto>>url:https://github.com/latchset/jwcrypto||shape="rect"]]
1006 +)))|(((
1007 +465
1008 +)))|(((
1009 +06.03.2024
1010 +)))|(((
1011 +8
1012 +)))|(((
1013 +[[https:~~/~~/jwcrypto.readthedocs.io>>url:https://jwcrypto.readthedocs.io||shape="rect"]]
1014 +)))|(((
1015 +➕️ API Doc, einige Beispiele
1016 +)))|(((
1017 +✅️ 1.5.6
1018 +Dep von python-keycloak
1019 +)))|(((
1020 +❌️
1021 +)))
790 790  
791 -{{code language="none"}}
792 -document renamer
793 -{{/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}}
794 -TODO: Define Storage Path
1023 +Unsere bevorzugte Library ist **pyjwt**. Diese ist auch in **paperless nativ vorhanden**, sodass wir uns für die Implementierung mittels **pyjwt** entschieden haben.
795 795  
796 -== {{id name="DigitaleMitgliederverwaltung-AutomatischeZuordnungvonMetadaten"/}}Automatische Zuordnung von Metadaten ==
1025 +=== {{id name="DigitaleMitgliederverwaltung-PDF417Code"/}}PDF417 Code ===
797 797  
798 -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.
1027 +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:
799 799  
800 -Aus diesem Grund nutzen wir einen speziellen QR Code in einem für den Makerspace spezifischen Format, welches nachstehend detailliert beschrieben wird.
1029 +(% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %)[[image:attach:barcode.jpg||height="250"]]
801 801  
802 -{{code language="json"}}
803 -{
804 - "payload": {
805 -        "timestamp": "YYYY-MM-DDTHH:mm:ss",
806 - "uuid": "260171c3-c71c-4da2-b13e-bf1386fe9eac",
807 - "correspondent": "Daniel Herrmann (#250)",
808 - "type": "mksp-doc-sepamandat",
809 - "tags": [
810 - "tag1",
811 - "tag2"
812 - ],
813 -"storage_path": "Mitgliederverwaltung"
814 - },
815 - "sig": "signature over the entire payload block"
816 -}
817 -{{/code}}
1031 +(% 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.
818 818  
819 -Die beiden Einträge **payload** und **sig** sind **Pflichtfelder**. Innerhalb der Payload müssen der **timestamp** **und die UUID** **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.
1033 +=== {{id name="DigitaleMitgliederverwaltung-Referenz-Implementierung"/}}Referenz-Implementierung ===
820 820  
821 -=== {{id name="DigitaleMitgliederverwaltung-Signatur"/}}Signatur ===
1035 +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"]]
822 822  
823 -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:
1037 +=== {{id name="DigitaleMitgliederverwaltung-PostConsumptionScript"/}}Post Consumption Script ===
824 824  
825 -* **Key-Pair**: 2048 bit Schlüssellänge, RSA, 65537 Exponent
826 -* **Signatur**: SHA256 Signatur, PKCS1v15 Padding
827 -* (((
828 -**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:
829 -\\
1039 +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"]]
830 830  
831 -{{code language="json"}}
832 -{"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"}
833 -{{/code}}
1041 +== {{id name="DigitaleMitgliederverwaltung-PaperlessBerechtigungen"/}}Paperless Berechtigungen ==
834 834  
1043 +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.
835 835  
836 -Als Referenz, die in Python wäre der Input der Signatur:
1045 +=== {{id name="DigitaleMitgliederverwaltung-BenutzerundGruppen"/}}Benutzer und Gruppen ===
1046 +
1047 +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:
1048 +
1049 +* **Vorstand**: Für die Mitglieder des Vorstands
1050 +* **Mitgliederverwaltung**: Alle Personen, die mit der Verwaltung der Mitglieder betraut sind
1051 +* **IT Admin**: IT Administratoren im Makerspace
1052 +
1053 +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.
1054 +
1055 +=== {{id name="DigitaleMitgliederverwaltung-GlobaleBerechtigungen"/}}Globale Berechtigungen ===
1056 +
1057 +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:
1058 +
1059 +|=(% scope="row" %)(((
1060 +Berechtigung
1061 +)))|=(% scope="col" %)(((
1062 +Beschreibung
1063 +)))|=(% scope="col" %)(((
1064 +Mitgliederverwaltung
1065 +)))|=(% scope="col" %)(((
1066 +Vorstand
1067 +)))|=(% scope="col" %)(((
1068 +IT Admin
1069 +)))|=(% scope="col" %)(((
1070 +Notiz
1071 +)))
1072 +|=(% scope="row" %)(((
1073 +Document
1074 +)))|(((
1075 +Sehen und bearbeiten von Dokumenten.
1076 +)))|(((
1077 +ALLE
1078 +)))|(((
1079 +ALLE
1080 +)))|(((
1081 +KEINE
1082 +)))|(((
1083 +Wird zusätzlich durch Berechtigungen auf Objekt-Level eingeschränkt
1084 +)))
1085 +|=(% scope="row" %)(((
1086 +Tag
1087 +)))|(((
1088 +Sehen und bearbeiten von Tags.
1089 +)))|(((
1090 +Anzeigen
1091 +)))|(((
1092 +ALLE
1093 +)))|(((
1094 +ALLE
1095 +)))|(((
1096 +Wird zusätzlich durch Berechtigungen auf Objekt-Level eingeschränkt
1097 +)))
1098 +|=(% scope="row" %)(((
1099 +Correspondent
1100 +)))|(((
1101 +Sehen und bearbeiten von Korrespondenten
1102 +)))|(((
1103 +Anzeigen
1104 +)))|(((
1105 +ALLE
1106 +)))|(((
1107 +ALLE
1108 +)))|(((
1109 +Wird zusätzlich durch Berechtigungen auf Objekt-Level eingeschränkt
1110 +)))
1111 +|=(% scope="row" %)(((
1112 +DocumentType
1113 +)))|(((
1114 +Sehen und bearbeiten von Dokument-Typen
1115 +)))|(((
1116 +Anzeigen
1117 +)))|(((
1118 +ALLE
1119 +)))|(((
1120 +ALLE
1121 +)))|(((
1122 +Wird zusätzlich durch Berechtigungen auf Objekt-Level eingeschränkt
1123 +)))
1124 +|=(% scope="row" %)(((
1125 +StoragePath
1126 +)))|(((
1127 +Sehen und bearbeiten von Speicherpfaden
1128 +)))|(((
1129 +Anzeigen
1130 +)))|(((
1131 +Anzeigen
1132 +)))|(((
1133 +ALLE
1134 +)))|(((
1135 +Wird zusätzlich durch Berechtigungen auf Objekt-Level eingeschränkt
1136 +)))
1137 +|=(% scope="row" %)(((
1138 +SavedView
1139 +)))|(((
1140 +Ansichten erzeugen und speichern
1141 +)))|(((
1142 +ALLE
1143 +)))|(((
1144 +ALLE
1145 +)))|(((
1146 +KEINE
1147 +)))|(((
837 837  \\
1149 +)))
1150 +|=(% scope="row" %)(((
1151 +PaperlessTask
1152 +)))|(((
1153 +Dateiaufgaben einsehen und löschen
1154 +)))|(((
1155 +KEINE
1156 +)))|(((
1157 +KEINE
1158 +)))|(((
1159 +ALLE
1160 +)))|(((
1161 +\\
1162 +)))
1163 +|=(% scope="row" %)(((
1164 +AppConfig
1165 +)))|(((
1166 +Konfiguration von Paperless NGX selbst
1167 +)))|(((
1168 +KEINE
1169 +)))|(((
1170 +KEINE
1171 +)))|(((
1172 +ALLE
1173 +)))|(((
1174 +\\
1175 +)))
1176 +|=(% scope="row" %)(((
1177 +UISettings
1178 +)))|(((
1179 +Persönliche Anzeigeeinstellungen ändern
1180 +)))|(((
1181 +ALLE
1182 +)))|(((
1183 +ALLE
1184 +)))|(((
1185 +ALLE
1186 +)))|(((
1187 +\\
1188 +)))
1189 +|=(% scope="row" %)(((
1190 +History
1191 +)))|(((
1192 +Dokumenten-Audit Log anzeigen oder ändern
1193 +)))|(((
1194 +Anzeigen
1195 +)))|(((
1196 +Anzeigen
1197 +)))|(((
1198 +KEINE
1199 +)))|(((
1200 +Nur für Dokumente, auf die Zugriff gewährt wurde.
1201 +)))
1202 +|=(% scope="row" %)(((
1203 +Note
1204 +)))|(((
1205 +Notizen zu Dokumenten einsehen oder ändern
1206 +)))|(((
1207 +ALLE
1208 +)))|(((
1209 +ALLE
1210 +)))|(((
1211 +KEINE
1212 +)))|(((
1213 +Nur für Dokumente, auf die Zugriff gewährt wurde.
1214 +)))
1215 +|=(% scope="row" %)(((
1216 +MailAccount
1217 +)))|(((
1218 +Mail-Accounts verwalten
1219 +)))|(((
1220 +KEINE
1221 +)))|(((
1222 +Anzeigen
1223 +)))|(((
1224 +ALLE
1225 +)))|(((
1226 +\\
1227 +)))
1228 +|=(% scope="row" %)(((
1229 +MailRule
1230 +)))|(((
1231 +Verarbeitungsregeln für eingehende Mails bearbeiten
1232 +)))|(((
1233 +KEINE
1234 +)))|(((
1235 +ALLE
1236 +)))|(((
1237 +ALLE
1238 +)))|(((
1239 +\\
1240 +)))
1241 +|=(% scope="row" %)(((
1242 +User
1243 +)))|(((
1244 +Benutzer einsehen oder verwalten
1245 +)))|(((
1246 +KEINE
1247 +)))|(((
1248 +Anzeigen
1249 +)))|(((
1250 +ALLE
1251 +)))|(((
1252 +\\
1253 +)))
1254 +|=(% scope="row" %)(((
1255 +Group
1256 +)))|(((
1257 +Gruppen einsehen oder verwalten
1258 +)))|(((
1259 +KEINE
1260 +)))|(((
1261 +Anzeigen
1262 +)))|(((
1263 +ALLE
1264 +)))|(((
1265 +\\
1266 +)))
1267 +|=(% scope="row" %)(((
1268 +ShareLink
1269 +)))|(((
1270 +Öffentliche Share-Links erstellen oder verwalten
1271 +)))|(((
1272 +KEINE
1273 +)))|(((
1274 +KEINE
1275 +)))|(((
1276 +KEINE
1277 +)))|(((
1278 +\\
1279 +)))
1280 +|=(% scope="row" %)(((
1281 +CustomField
1282 +)))|(((
1283 +Custom Fields einsehen oder verwalten
1284 +)))|(((
1285 +Anzeigen
1286 +)))|(((
1287 +Anzeigen
1288 +)))|(((
1289 +ALLE
1290 +)))|(((
1291 +\\
1292 +)))
1293 +|=(% scope="row" %)(((
1294 +Workflow
1295 +)))|(((
1296 +Workflows für neue Dokumente einsehen oder verwalten
1297 +)))|(((
1298 +KEINE
1299 +)))|(((
1300 +KEINE
1301 +)))|(((
1302 +ALLE
1303 +)))|(((
1304 +\\
1305 +)))
838 838  
839 -{{code language="python"}}
840 -import json
1307 +=== {{id name="DigitaleMitgliederverwaltung-Objekt-Berechtigungen"/}}Objekt-Berechtigungen ===
841 841  
842 -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'}
843 -signature_data = json.dumps(input_data, separators=(',', ':')).encode('utf-8')
844 -{{/code}}
1309 +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:
1310 +
1311 +* Owner / Eigentümer: Das Objekt gehört diesem Benutzer. Der Owner hat immer alle Berechtigungen für das Objekt
1312 +* Zusätzliche Berechtigungen:
1313 +** Es können getrennt voneinander Berechtigungen zum Anzeigen und Bearbeiten vergeben werden
1314 +** Diese Berechtigungen können jeweils für einzelne Benutzer oder für Gruppen gewährt werden
1315 +
1316 +Das sieht im Frontend beispielsweise so aus:
1317 +
1318 +[[image:attach:image-2025-8-25_10-19-25.png||thumbnail="true" height="250"]]
1319 +
1320 +{{info title="Berechtigungen"}}
1321 +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:
1322 +
1323 +|=(% scope="col" %)(((
1324 +Globale Berechtigung
1325 +)))|=(% scope="col" %)(((
1326 +Owner
1327 +)))|=(% scope="col" %)(((
1328 +Objekt-Berechtigung
1329 +)))|=(% scope="col" %)(((
1330 +Ergebnis
845 845  )))
1332 +|(((
1333 +❌️
1334 +)))|(((
1335 +Egal
1336 +)))|(((
1337 +Egal
1338 +)))|(((
1339 +❌️
1340 +)))
1341 +|(((
1342 +✅️
1343 +)))|(((
1344 +✅️
1345 +)))|(((
1346 +Egal
1347 +)))|(((
1348 +✅️
1349 +)))
1350 +|(((
1351 +✅️
1352 +)))|(((
1353 +❌️
1354 +)))|(((
1355 +❌️
1356 +)))|(((
1357 +❌️
1358 +)))
1359 +|(((
1360 +✅️
1361 +)))|(((
1362 +❌️
1363 +)))|(((
1364 +✅️
1365 +)))|(((
1366 +✅️
1367 +)))
846 846  
847 -\\
1369 +Mit anderen Worten, um eine Aktion auszuführen, muss ein Benutzer (a) die globale Berechtigung haben **UND** (b) Owner sein **ODER** Objekt-Berechtigungen haben.
1370 +{{/info}}
848 848  
849 -== {{id name="DigitaleMitgliederverwaltung-TechnischesSetup"/}}Technisches Setup ==
1372 +=== {{id name="DigitaleMitgliederverwaltung-LokaleOwner"/}}Lokale Owner ===
850 850  
851 -Owner: zwei Owner
852 -Docs: Owner = grp owner, View + Edit jeweilige Gruppen
853 -Correspondent: owner = grp owner, view = jeweilige Gruppe, edit = it admin
854 -Tag: owner = grp owner, view = jeweilige Gruppe, edit = it admin
855 -Doc Type: owner = grp owner, view = jeweilige Gruppe, edit = it admin
1374 +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.
856 856  
857 -TODO
1376 +|=(% scope="row" %)(((
1377 +Benutzer
1378 +)))|=(% scope="col" %)(((
1379 +Verwendet für
1380 +)))
1381 +|=(% scope="row" %)(((
1382 +mksp-mv-owner
1383 +)))|(((
1384 +Alle Objekte (Dokumente, Dokumenttypen, Tags, Korrespondenten und Speicherpfade), die dem Use-Case **Mitgliederverwaltung** zugewiesen sind
1385 +)))
1386 +|=(% scope="row" %)(((
1387 +mksp-vs-owner
1388 +)))|(((
1389 +Alle Objekte (Dokumente, Dokumenttypen, Tags, Korrespondenten und Speicherpfade), die dem Use-Case **Vorstandspost** zugewiesen sind
1390 +)))
858 858  
1392 +=== {{id name="DigitaleMitgliederverwaltung-Standard-Objekt-Berechtigungen"/}}Standard-Objekt-Berechtigungen ===
1393 +
1394 +Basierend auf den hier beschrieben Regeln werden für Objekte die folgenden Berechtigungen gesetzt:
1395 +
1396 +|=(% rowspan="2" scope="rowgroup" %)(((
1397 +Objekt
859 859  \\
1399 +)))|=(% colspan="3" scope="colgroup" %)(((
1400 +Mitgliederverwaltung
1401 +)))|=(% rowspan="7" scope="rowgroup" %)(((
1402 +\\
1403 +)))|=(% colspan="3" scope="colgroup" %)(((
1404 +Vorstandspost
1405 +)))
1406 +|=(% scope="col" %)(((
1407 +Owner
1408 +)))|=(% scope="col" %)(((
1409 +Anzeigen
1410 +)))|=(% scope="col" %)(((
1411 +Bearbeiten
1412 +)))|=(((
1413 +Owner
1414 +)))|=(((
1415 +Anzeigen
1416 +)))|=(((
1417 +Bearbeiten
1418 +)))
1419 +|=(% scope="row" %)(((
1420 +Dokument
1421 +)))|(((
1422 +mksp-mv-owner
1423 +)))|(((
1424 +Mitgliederverwaltung
1425 +)))|(((
1426 +Mitgliederverwaltung
1427 +)))|(((
1428 +mksp-vs-owner
1429 +)))|(((
1430 +Vorstand
1431 +)))|(((
1432 +Vorstand
1433 +)))
1434 +|=(% scope="row" %)(((
1435 +Dokumenttyp
1436 +)))|(((
1437 +mksp-mv-owner
1438 +)))|(((
1439 +Mitgliederverwaltung, IT Admin
1440 +)))|(((
1441 +IT Admin
1442 +)))|(((
1443 +mksp-vs-owner
1444 +)))|(((
1445 +Vorstand
1446 +)))|(((
1447 +Vorstand
1448 +)))
1449 +|=(% scope="row" %)(((
1450 +Tag
1451 +)))|(((
1452 +mksp-mv-owner
1453 +)))|(((
1454 +Mitgliederverwaltung, IT Admin
1455 +)))|(((
1456 +IT Admin
1457 +)))|(((
1458 +mksp-vs-owner
1459 +)))|(((
1460 +Vorstand
1461 +)))|(((
1462 +Vorstand
1463 +)))
1464 +|=(% scope="row" %)(((
1465 +Korrespondent
1466 +)))|(((
1467 +mksp-mv-owner
1468 +)))|(((
1469 +Mitgliederverwaltung, IT Admin
1470 +)))|(((
1471 +IT Admin
1472 +)))|(((
1473 +mksp-vs-owner
1474 +)))|(((
1475 +Vorstand
1476 +)))|(((
1477 +Vorstand
1478 +)))
1479 +|=(% scope="row" %)(((
1480 +Speicherpfad
1481 +)))|(((
1482 +mksp-mv-owner
1483 +)))|(((
1484 +Mitgliederverwaltung, IT Admin
1485 +)))|(((
1486 +IT Admin
1487 +)))|(((
1488 +mksp-vs-owner
1489 +)))|(((
1490 +Vorstand
1491 +)))|(((
1492 +IT Admin
1493 +)))
860 860  
861 -=== {{id name="DigitaleMitgliederverwaltung-AusFace2Faceam20.8(DH,YS)"/}}Aus Face 2 Face am 20.8  (DH,YS) ===
1495 +== {{id name="DigitaleMitgliederverwaltung-Workflows"/}}Workflows ==
862 862  
863 -* Schritt 1: Einweisungszettel erzeugen 
864 -** Checkliste in Directus hinterlegen, eine pro Einweisung
865 -** N8n Workflow, welches die Liste aus Directus herunterlädt und Template mit Puppetteer Script Node erzeugen
866 -** Aus diesem Template dann ein DocuSeal Template erstellen
867 -* Schritt 2: Zettel für Einweisungen generieren
868 -** Tablet für Einweiser im makerspace
869 -** Authentifizierung über Token an der Freigabebox
870 -*** Neue Maschine, User schaltet die Maschine "Tablet" frei
871 -*** Datenbank erzeugt JWT und signiert es mit einem RSA Priv Key
872 -*** Wird als Payload in der MQTT unlock message mitgeschickt
873 -** Tablet nutzt dieses Token für API Requests gegen Homepage Backend
874 -** Backend wird um weitere Middleware angepasst, die dieses Token für manche Endpoints akzeptiert
875 -** Einweiser:in bekommt aktive Einweisung angezeigt und kann Teilnehmer Entfernern (no-show) oder hinzufügen (spontan)
876 -*** Option eine Einweisung ohne Rechnungsstellung vorzunehmen
877 -** PDFs werden automatisch ausgedruckt
878 -*** Tablet triggert einen Backend endpoint
879 -**** übergibt teilnehmer als parameter (auth über token) und
880 -**** erzeugt die entsprechenden PDFs in DocuSeal
881 -**** Gibt PDF als Return
882 -*** Tablet kann PDF über Netzwerk print drucken
883 -* Schritt 3: Einweisungen erfassen
884 -** QR code wird in Schritt 2 aufgedruckt und enthält:
885 -*** Einweisung
886 -*** Datum
887 -*** Einweiser
888 -*** Teilnehmer
889 -*** Flag Rechnung
890 -** Dokument wird über ScanSnap eingescannt und automatisch an paperless übergeben
891 -** Paperless Post Consume erkennt den QR Code, validiert ihn und löst über einen Webook einen Flow in N8n aus
892 -** N8n erstellt dann einen temporären Eintrag im Backend, ähnlich dem der heute bei "Einweisung erfassen" sichtbar ist
893 -** Die Mitgliederverwaltung hat dann x Tage Zeit, die Einträge zu korrigieren und zu prüfen (beispielsweise ob Voraussetzungen erfüllt sind)
894 -** Danach werden alle Schritte wie bisher ausgelöst (Berechtigung, Rechnung, Auszahlung an Einweiser, E-Mail Bestätigung, ...)
1497 +Paperless Workflows können zur Automatisierung verschiedener Tasks eingesetzt werden. In diesem Fall werden zwei Fälle damit abgedeckt:
895 895  
896 -TODO:
1499 +* Beim Hinzufügen der Dokumente via Webinterface **wird standardmäßig der angemeldete Nutzer als Owner des Dokuments festgelegt**. Damit haben andere Mitglieder der gleichen Gruppe (Beispielsweise Vorstand oder Mitgliederverwaltung) kein Zugriff auf die so hinzugefügten Dokumente. Aus diesem Grund setzt einer der Workflow die entsprechend notwendigen Berechtigungen.
1500 +* Einscannen von Dokumenten soll sowohl für die Mitgliederverwaltung als auch für den Vorstand möglich sein und der richtigen Gruppe zugeordnet werden. Wir haben dafür zwei unterschiedliche Ordner aus dem NAS angelegt. Der Dokumentenscanner kann Dokumente in einen der beiden Ordner legen, wir nutzen Workflows um auch hier die richtigen Berechtigungen zu setzen.
897 897  
1502 += {{id name="DigitaleMitgliederverwaltung-OffenePunkte"/}}Offene Punkte =
1503 +
898 898  * Docuseal Logging + Monitoring
899 899  * N8n Error Handling
Icon Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -202867276
1 +205586522
URL
... ... @@ -1,1 +1,1 @@
1 -https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/202867276/Digitale Mitgliederverwaltung
1 +https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/205586522/Digitale Mitgliederverwaltung