Änderungen von Dokument Digitale Mitgliederverwaltung
Zuletzt geändert von Daniel Herrmann am 2026/02/22 21:17
Von Version
32.1
bearbeitet von Daniel Herrmann
am 2025/08/22 18:02
am 2025/08/22 18:02
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Auf Version
45.1
bearbeitet von Daniel Herrmann
am 2025/08/27 19:13
am 2025/08/27 19:13
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Zusammenfassung
Details
- 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 - ProzessZukunft85 +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 kannkomplett **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="1 138" 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,7 +703,7 @@ 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 +== {{id name="DigitaleMitgliederverwaltung-ÜbersichtderMetadaten"/}}Übersicht der Metadaten == 707 707 708 708 Dokumente werden dann Meta-Daten zugeordnet, die eine spätere Suche und Zuordnung erleichtern. Diese Meta-Daten sind: 709 709 ... ... @@ -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. 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 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. 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: 719 719 \\ 720 720 721 -(% class="wrapped" %) 722 722 |=(% scope="col" %)((( 723 723 Name 724 724 )))|=(% scope="col" %)((( 725 -Exact Match String 756 +Definition 757 +)))|=(% scope="col" %)((( 758 +Sichtbar für 759 +)))|=(% scope="col" %)((( 760 +Anwendung 726 726 ))) 727 727 |((( 728 -Mitglieds antrag763 +Mitglieder Einweisungszettel 729 729 )))|((( 730 -mksp-doc-mitgliedsantrag 765 +(% class="code" %) 766 +((( 767 +~{~{ correspondent }}/Einweisungen/~{~{ document_type }}-~{~{ tag_list }}-~{~{ created }}-~{~{ doc_pk }} 731 731 ))) 769 +)))|((( 770 +Mitgliederverwaltung 771 +)))|((( 772 +Einweisungszettel 773 +))) 732 732 |((( 733 - SEPA Lastschriftmandat775 +Mitglieder Unterlagen 734 734 )))|((( 735 -mksp-doc-sepamandat 777 +(% class="code" %) 778 +((( 779 +~{~{ correspondent }}/~{~{ document_type }}-~{~{ created }}-~{~{ doc_pk }} 736 736 ))) 781 +)))|((( 782 +Mitgliederverwaltung 783 +)))|((( 784 +Alle anderen Mitgliederdokumente 785 +))) 737 737 |((( 738 - Studienbescheinigung787 +Vorstand Dokumente 739 739 )))|((( 740 -mksp-doc-studienbescheinigung 789 +(% class="code" %) 790 +((( 791 +~{~{ created_year }}/~{~{ correspondent }}/~{~{ title }} 741 741 ))) 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 +))) 742 742 |((( 743 - Formular Schlüsselausgabe835 +id 744 744 )))|((( 745 -mksp-doc-schluesselausgabe 837 +UUID4 838 +)))|((( 839 +✅️ 840 +)))|((( 841 +Eindeutige ID dieses Dokuments 746 746 ))) 747 747 |((( 748 - Verpflichtungserklärung Datenschutz844 +time 749 749 )))|((( 750 -\\ 846 +Zahl 847 +)))|((( 848 +✅️ 849 +)))|((( 850 +UTC Linux-Timestamp an dem das Dokument und der QR Code erzeugt wurden 751 751 ))) 752 752 |((( 753 - Übungsleitervertrag853 +exp 754 754 )))|((( 755 -\\ 855 +Zahl 856 +)))|((( 857 +✅️ 858 +)))|((( 859 +UTC Linux-Timestamp der angibt, bis wann das Dokument gültig ist. 756 756 ))) 757 757 |((( 758 -Nutzungsvereinbarung Schulungsinhalte 862 +(% class="code" %) 863 +((( 864 +typ 865 +))) 759 759 )))|((( 760 -\\ 867 +String 868 +)))|((( 869 +✅️ 870 +)))|((( 871 +Typ des Dokuments basierend auf der unten definierten Liste. 761 761 ))) 762 762 |((( 763 -Bestellung eines Einweisers 874 +(% class="code" %) 875 +((( 876 +cor 877 +))) 764 764 )))|((( 765 -\\ 879 +String 880 +)))|((( 881 +❌️ 882 +)))|((( 883 +Optional: Name des Korrespondenten, dem das Dokument zugeordnet werden soll 766 766 ))) 767 767 |((( 768 - Haftungsausschluss886 +tags 769 769 )))|((( 770 -\\ 888 +List[String] 889 +)))|((( 890 +❌️ 891 +)))|((( 892 +Liste an Tags, die dem Dokument zugeordnet werden soll 771 771 ))) 772 772 |((( 773 - Einweisungszettel895 +spth 774 774 )))|((( 775 -\\ 897 +String 898 +)))|((( 899 +❌️ 900 +)))|((( 901 +Storage Path, das dem Dokument zugeordnet werden soll 776 776 ))) 777 777 |((( 778 - Lagervertrag Kistenlager904 +opt 779 779 )))|((( 780 -\\ 906 +dict 907 +)))|((( 908 +❌️ 909 +)))|((( 910 +Optionale Attribute, die mit eincodiert werden und dem N8n Workflow übergeben werden. 781 781 ))) 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 +))) 782 782 |((( 783 - Lagervertrag Projektlager949 +python-jose 784 784 )))|((( 785 -\\ 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 +❌️ 786 786 ))) 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 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 (%%)[[ 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 +))) 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 1014 +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"/}}AutomatischeZuordnung von Metadaten==1016 +=== {{id name="DigitaleMitgliederverwaltung-PDF417Code"/}}PDF417 Code === 797 797 798 - Paperlessunterstützt die automatischeZuordnungvon Metadatenbasierend auf festen Strings.So kannman beispielsweiseangeben,dasseinDokumententyp"Haftungsausschluss"zugewiesenwerdensoll,wenn derString "Haftungsausschluss"irgendwo im Dokument vorkommt. Diesistallerdingsaufeine korrekteFunktionderTexterkennungangewiesenundfunktionierterfahrungsgemäß nurinmanchenFällen, sodass mindestenseine manuelleÜberprüfung trotzdemnotwendig kommt. Wenn beispielsweise ein Brief mitdem Satz"ich dachte,ichhättedenHaftungsausschlussbereits abgegeben, könntet ihr diesbitteprüfen"erfasstwird, würdeder basierendauf der Regel ebenfalls kategorisiertwerden.1018 +Als Format fü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 - Ausdiesem Grund nutzen wireinenspeziellenQR Code ineinem fürden Makerspace spezifischenFormat, welches nachstehenddetailliertbeschrieben wird.1020 +(% 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}} 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. 818 818 819 - DiebeidenEinträge **payload** und **sig** sind **Pflichtfelder**. Innerhalb der Payload müssen der **timestamp** **und dieUUID** **vorhanden** sein, alle anderen Feldersind optional, jedoch muss mindestens eins angegeben werden. Der QR Code kann dann-insbesondere bei der Digitalen Unterschrift oder bei Workflows, wo die Formulareohnehin on demand erzeugt werden bereits mit allenDaten bestückt werden.In Paperless gibt es dann ein PostconsumeScript, welches denQR Code ausliest, dieSignaturprüftund - falls die Signaturkorrekt ist - automatisch die Meta-Daten übernimmt.1024 +=== {{id name="DigitaleMitgliederverwaltung-Referenz-Implementierung"/}}Referenz-Implementierung === 820 820 821 - === {{idname="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"]] 822 822 823 - DieSignatur wirdkryptographischmit 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 verifizierenkann. Derprivate Teil desSchlüssels wird vonden Makerspace-Systemem verwendet, welche die Formulare erzeugen.Im Detail:1028 +=== {{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 -\\ 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"]] 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}} 1032 +== {{id name="DigitaleMitgliederverwaltung-PaperlessBerechtigungen"/}}Paperless Berechtigungen == 834 834 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. 835 835 836 -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 +)))|((( 837 837 \\ 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 +))) 838 838 839 -{{code language="python"}} 840 -import json 1298 +=== {{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}} 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 845 845 ))) 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 +))) 846 846 847 -\\ 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}} 848 848 849 -== {{id name="DigitaleMitgliederverwaltung- TechnischesSetup"/}}TechnischesSetup==1363 +=== {{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 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. 856 856 857 -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 +))) 858 858 1383 +=== {{id name="DigitaleMitgliederverwaltung-Standard-Objekt-Berechtigungen"/}}Standard-Objekt-Berechtigungen === 1384 + 1385 +Basierend auf den hier beschrieben Regeln werden für Objekte die folgenden Berechtigungen gesetzt: 1386 + 1387 +|=(% rowspan="2" scope="rowgroup" %)((( 1388 +Objekt 859 859 \\ 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 +))) 860 860 861 -== ={{id name="DigitaleMitgliederverwaltung-AusFace2Faceam20.8(DH,YS)"/}}AusFace 2 Face am 20.8 (DH,YS)===1486 +== {{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, ...) 1488 +Paperless Workflows können zur Automatisierung verschiedener Tasks eingesetzt werden. In diesem Fall werden zwei Fälle damit abgedeckt: 895 895 896 -TODO: 1490 +* 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. 1491 +* 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 1493 += {{id name="DigitaleMitgliederverwaltung-OffenePunkte"/}}Offene Punkte = 1494 + 898 898 * Docuseal Logging + Monitoring 899 899 * N8n Error Handling
- Confluence.Code.ConfluencePageClass[0]
-
- Id
-
... ... @@ -1,1 +1,1 @@ 1 -20 28672761 +205586515 - URL
-
... ... @@ -1,1 +1,1 @@ 1 -https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/20 2867276/Digitale Mitgliederverwaltung1 +https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/205586515/Digitale Mitgliederverwaltung