Änderungen von Dokument Digitale Mitgliederverwaltung
Zuletzt geändert von Daniel Herrmann am 2026/02/22 21:17
Von Version
65.1
bearbeitet von Daniel Herrmann
am 2026/01/30 10:41
am 2026/01/30 10:41
Änderungskommentar:
Löschung des Anhangs Fall 3 Ablaufdiagramm_
Auf Version
51.1
bearbeitet von Daniel Herrmann
am 2025/10/19 18:49
am 2025/10/19 18:49
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Zusammenfassung
Details
- Seiteneigenschaften
-
- Inhalt
-
... ... @@ -23,7 +23,7 @@ 23 23 24 24 Kurz gesagt: Die EES ist schnell und unkompliziert, aber unsicher und nur für risikofreie Vorgänge geeignet. Die FES ist technisch sicherer, rechtlich belastbarer und für wichtige, aber formfreie Vereinbarungen ideal. Die QES ist rechtlich vollwertig wie eine handschriftliche Unterschrift und für alle Schriftformerfordernisse zwingend notwendig. Zusammenfassung: 25 25 26 -(% class="wrapped" style="text-decoration:none" %) 26 +(% class="wrapped" style="text-decoration: none;" %) 27 27 |=((( 28 28 Signaturtyp 29 29 )))|=((( ... ... @@ -61,8 +61,8 @@ 61 61 Mehrfaktor, über einen zugelassenen Vertrauensdienstleister 62 62 ))) 63 63 64 +\\ 64 64 65 - 66 66 {{confluence_tip title="Zusammenfassung"}} 67 67 Für uns im Makerspace bedeutet das, dass wir die EES und FES (über DocuSeal) einsetzen können. Wir haben keine Partnerschaft mit einem Anbieter, der die QES und damit die Schriftformerfordernis abdecken würde, sodass wir alle Dokumente, für die die Schriftform erforderlich ist, weiterhin handschriftlich unterschreiben lassen. 68 68 {{/confluence_tip}} ... ... @@ -74,14 +74,14 @@ 74 74 Am Dienstag, den 12.08.2025 fand hierzu ein Workshop statt, bei dem Vertreter des IT Teams, der Mitgliederverwaltung sowie des Vorstands teilgenommen haben. Dabei wurden die Ziele erläutert und definiert, ebenfalls haben eine Übersicht der bestehenden Dokumenten-Typen erstellt, mit denen wir im Verein heute hantieren. Für jedes Dokument wurde dann evaluiert, ob es in Zukunft komplett digitalisiert werden kann oder ob beispielsweise aus Haftungsgründen die Schriftform und damit eine handschriftliche Unterschrift weiterhin notwendig ist. Die folgende Tabelle gibt einen Überblick: 75 75 76 76 (% class="wrapped" %) 77 -|=((( 77 +|=(% scope="col" %)((( 78 78 Dokumenten-Typ 79 -)))|=((( 79 +)))|=(% scope="col" %)((( 80 80 Vollständig 81 81 digitalisieren 82 -)))|=((( 82 +)))|=(% scope="col" %)((( 83 83 Prozess heute 84 -)))|=((( 84 +)))|=(% scope="col" %)((( 85 85 Notwendige Änderungen 86 86 ))) 87 87 |((( ... ... @@ -164,7 +164,7 @@ 164 164 )))|((( 165 165 Notwendig für Funktionäre, Einweisende, und so weiter. 166 166 167 -Ist ein Blanko-Formular, welches ausgefüllt, eingeworfen und abgeheftet wird. 167 +Ist ein Blanko-Formular, welches ausgefüllt, eingeworfen und abgeheftet wird. 168 168 Danach wird ein Flag für das jeweilige Mitglied gesetzt, dass die Erklärung abgegeben wurde. 169 169 )))|((( 170 170 **Vollständig digital**. Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage), danach digital weiter. ... ... @@ -317,13 +317,13 @@ 317 317 Im zweiten Schritt wird nun ein oder mehrere personalisierte Dokumente erstellt. Hier gibt es eine Entscheidungsmatrix: 318 318 319 319 (% class="wrapped" %) 320 -|=((( 320 +|=(% scope="col" %)((( 321 321 Remote / Lokal 322 -)))|=((( 322 +)))|=(% scope="col" %)((( 323 323 Schriftformerfordernis 324 -)))|=((( 324 +)))|=(% scope="col" %)((( 325 325 Beispiel 326 -)))|=((( 326 +)))|=(% scope="col" %)((( 327 327 Beschreibung 328 328 ))) 329 329 |((( ... ... @@ -361,7 +361,7 @@ 361 361 )))|((( 362 362 Einweisungszettel Vor-Ort Einweisung 363 363 )))|((( 364 -Dokument wird über eine Docuseal One-Off Submission erzeugt und als PDF auf das Tablet heruntergeladen. 364 +Dokument wird über eine Docuseal One-Off Submission erzeugt und als PDF auf das Tablet heruntergeladen.\\ 365 365 ))) 366 366 367 367 {{error title="Docuseal Lizenz"}} ... ... @@ -420,7 +420,7 @@ 420 420 Einweisungszettel Vor-Ort Einweisung 421 421 )))|((( 422 422 Auf dem Makerspace Tablet wird das Dokument vor Ort ausgedruckt (AirPrint oder CUPS) und **handschriftlich** unterschrieben. 423 - 423 +\\ 424 424 ))) 425 425 426 426 === Ablegen und Verarbeiten === ... ... @@ -428,11 +428,11 @@ 428 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: 429 429 430 430 (% class="wrapped" %) 431 -|=((( 431 +|=(% scope="col" %)((( 432 432 Signatur über 433 -)))|=((( 433 +)))|=(% scope="col" %)((( 434 434 Paperless Ingest 435 -)))|=((( 435 +)))|=(% scope="col" %)((( 436 436 Ablauf 437 437 ))) 438 438 |((( ... ... @@ -537,12 +537,12 @@ 537 537 (% class="wrapped" %) 538 538 |=(% scope="row" %)((( 539 539 Workflow 540 -)))|=((( 540 +)))|=(% scope="col" %)((( 541 541 Schriftform erforderlich 542 -)))|=((( 542 +)))|=(% scope="col" %)((( 543 543 Lokal / Remote 544 544 ))) 545 -|=((( 545 +|=(% scope="row" %)((( 546 546 Fall 1: Digital Remote 547 547 )))|((( 548 548 Nein ... ... @@ -549,7 +549,7 @@ 549 549 )))|((( 550 550 Remote 551 551 ))) 552 -|=((( 552 +|=(% scope="row" %)((( 553 553 Fall 2: Digital Makerspace 554 554 )))|((( 555 555 Nein ... ... @@ -556,7 +556,7 @@ 556 556 )))|((( 557 557 Lokal 558 558 ))) 559 -|=((( 559 +|=(% scope="row" %)((( 560 560 Fall 3: Handschriftlich Remote 561 561 )))|((( 562 562 Ja ... ... @@ -563,7 +563,7 @@ 563 563 )))|((( 564 564 Remote 565 565 ))) 566 -|=((( 566 +|=(% scope="row" %)((( 567 567 Fall 4: Handschriftlich Makerspace 568 568 )))|((( 569 569 Ja ... ... @@ -617,7 +617,7 @@ 617 617 11. Speichert das Backend die Anfrage als Signature Request in der Datenbank 618 618 11. Erstellt eine "Submission" in DocuSeal. Diese basiert auf einem Template und enthält so viele Daten wie möglich schon vorausgefüllt. Mindestens aber enthält die Submission den signierten QR Code (siehe unten). 619 619 11. ((( 620 -Die URL für das Dokument werden als Antwort des API Requests an das Tablet zurück geschickt. Dies enthält die Embed-URL, die direkt auf dem Tablet angezeigt werden kann. Beispiel: 620 +Die URL für das Dokument werden als Antwort des API Requests an das Tablet zurück geschickt. Dies enthält die Embed-URL, die direkt auf dem Tablet angezeigt werden kann. Beispiel:\\ 621 621 622 622 {{expand}} 623 623 {{code language="json"}} ... ... @@ -702,6 +702,803 @@ 702 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 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 704 705 += Paperless NGX = 706 + 707 +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>>doc:xwiki:IN.IT Infrastruktur.IT im Makerspace.[HOWTO] Makerspace VPN.WebHome]] erreichbar. Der Zugang zu Paperless ist über OpenID Connect an [[doc:xwiki:IN.IT Infrastruktur.Services.Keycloak.WebHome]] gekoppelt, Zugang besteht nur für Mitglieder der Gruppen **Vorstand** und **Mitgliederverwaltung**. 708 + 709 +== Paperless Übersicht == 710 + 711 +**Dokumente** sind die primären Ressourcen in Paperless. Ein Dokument kann über mehrere Wege in Paperless aufgenommen werden (der Prozess wird **Ingestion** genannt): 712 + 713 +* **Per E-Mail**: es sind zwei Mail-Adressen eingerichtet, eingehende Anhänge werden automatisch von Paperless verarbeitet. Die QR Code Verarbeitung (siehe unten) findet hier ebenfalls Anwendung. 714 +** Die Mitgliederverwaltung: [[mitglieder-dokumente@makerspace-darmstadt.de>>mailto:mitglieder-dokumente@makerspace-darmstadt.de||shape="rect"]] 715 +** Den Vorstand: [[vorstand-dokumente@makerspace-darmstadt.de>>mailto:vorstand-dokumente@makerspace-darmstadt.de||shape="rect"]] 716 +* **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 717 +* **Per Weboberfläche**: Es ist ebenfalls möglich, Dokumente manuell über die Weboberfläche hinzuzufügen. 718 + 719 +Die folgenden Grafik gibt eine Übersicht: 720 + 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 +== Übersicht der Metadaten == 729 + 730 +Dokumente werden dann Meta-Daten zugeordnet, die eine spätere Suche und Zuordnung erleichtern. Diese Meta-Daten sind: 731 + 732 +* **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: 733 +** Für **Mitglieder**: //Vorname Nachname (#Mitgliedsnummer)//, also beispielsweise "//Daniel Herrmann (#250)//" 734 +** Für **Gäste**: //Vorname Nachname (GEindeutigeNummer)//, also beispielsweise "//Max Mustermann (G1244)//" 735 +** Bei **Vereinseintritt** und **Vereinsaustritt** werden die Korrespondenten automatisch umbenannt, auch Namensänderungen werden automatisch verarbeitet. 736 +* **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": 737 +** (% 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. 738 +** (% 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 752 +* ((( 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: 760 +\\ 761 + 762 +|=(% scope="col" %)((( 763 +Name 764 +)))|=(% scope="col" %)((( 765 +Definition 766 +)))|=(% scope="col" %)((( 767 +Sichtbar für 768 +)))|=(% scope="col" %)((( 769 +Anwendung 770 +))) 771 +|((( 772 +Mitglieder Einweisungszettel 773 +)))|((( 774 +(% class="code" %) 775 +((( 776 +~{~{ correspondent }}/Einweisungen/~{~{ document_type }}-~{~{ tag_list }}-~{~{ created }}-~{~{ doc_pk }} 777 +))) 778 +)))|((( 779 +Mitgliederverwaltung 780 +)))|((( 781 +Einweisungszettel 782 +))) 783 +|((( 784 +Mitglieder Unterlagen 785 +)))|((( 786 +(% class="code" %) 787 +((( 788 +~{~{ correspondent }}/~{~{ document_type }}-~{~{ created }}-~{~{ doc_pk }} 789 +))) 790 +)))|((( 791 +Mitgliederverwaltung 792 +)))|((( 793 +Alle anderen Mitgliederdokumente 794 +))) 795 +|((( 796 +Vorstand Dokumente 797 +)))|((( 798 +(% class="code" %) 799 +((( 800 +~{~{ created_year }}/~{~{ correspondent }}/~{~{ title }} 801 +))) 802 +)))|((( 803 +Vorstand 804 +)))|((( 805 +Alle Vorstandsdokumente 806 +))) 807 +))) 808 + 809 +== 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 +=== (% 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 +=== 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 +=== 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 +))) 843 +|((( 844 +id 845 +)))|((( 846 +UUID4 847 +)))|((( 848 +✅️ 849 +)))|((( 850 +Eindeutige ID dieses Dokuments 851 +))) 852 +|((( 853 +time 854 +)))|((( 855 +Zahl 856 +)))|((( 857 +✅️ 858 +)))|((( 859 +UTC Linux-Timestamp an dem das Dokument und der QR Code erzeugt wurden 860 +))) 861 +|((( 862 +exp 863 +)))|((( 864 +Zahl 865 +)))|((( 866 +✅️ 867 +)))|((( 868 +UTC Linux-Timestamp der angibt, bis wann das Dokument gültig ist. 869 +))) 870 +|((( 871 +(% class="code" %) 872 +((( 873 +typ 874 +))) 875 +)))|((( 876 +String 877 +)))|((( 878 +✅️ 879 +)))|((( 880 +Typ des Dokuments basierend auf der unten definierten Liste. 881 +))) 882 +|((( 883 +(% class="code" %) 884 +((( 885 +cor 886 +))) 887 +)))|((( 888 +String 889 +)))|((( 890 +❌️ 891 +)))|((( 892 +Optional: Name des Korrespondenten, dem das Dokument zugeordnet werden soll 893 +))) 894 +|((( 895 +tags 896 +)))|((( 897 +List[String] 898 +)))|((( 899 +❌️ 900 +)))|((( 901 +Liste an Tags, die dem Dokument zugeordnet werden soll 902 +))) 903 +|((( 904 +spth 905 +)))|((( 906 +String 907 +)))|((( 908 +❌️ 909 +)))|((( 910 +Storage Path, das dem Dokument zugeordnet werden soll 911 +))) 912 +|((( 913 +opt 914 +)))|((( 915 +dict 916 +)))|((( 917 +❌️ 918 +)))|((( 919 +Optionale Attribute, die mit eincodiert werden und dem N8n Workflow übergeben werden. 920 +))) 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 +=== 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 +|=((( 937 +Name 938 +)))|=((( 939 +CVE 940 +)))|=((( 941 +Github 942 +)))|=((( 943 +GH⭐ 944 +)))|=((( 945 +Letztes Release 946 +)))|=((( 947 +Offene Issues 948 +)))|=((( 949 +Dokumentation 950 +)))|=((( 951 +Qualität Dokumentation 952 +)))|=((( 953 +In Backend vorhanden? 954 +)))|=((( 955 +In Paperless vorhanden? 956 +))) 957 +|((( 958 +python-jose 959 +)))|((( 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 +❌️ 977 +))) 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 999 +))) 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 +))) 1022 + 1023 +Unsere bevorzugte Library ist **pyjwt**. Diese ist auch in **paperless nativ vorhanden**, sodass wir uns für die Implementierung mittels **pyjwt** entschieden haben. 1024 + 1025 +=== PDF417 Code === 1026 + 1027 +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="color:var(--ds-text-accent-purple-bolder,#352c63); text-decoration:none" %)ZXING unterstützt, welches in Paperless eingebettet ist. Ein solcher Barcode sieht beispielsweise so aus: 1028 + 1029 +(% style="color:var(--ds-text-accent-purple-bolder,#352c63); text-decoration:none" %)[[image:attach:barcode.jpg||height="250"]] 1030 + 1031 +(% style="color:var(--ds-text-accent-purple-bolder,#352c63); text-decoration:none" %)Daraus kann dann eine Base64 basierte Repräsentation berechnet werden, die einfach in Docuseal hochgeladen werden kann. 1032 + 1033 +=== Referenz-Implementierung === 1034 + 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"]] 1036 + 1037 +=== Post Consumption Script === 1038 + 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"]] 1040 + 1041 +== Paperless Berechtigungen == 1042 + 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. 1044 + 1045 +=== 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 +=== 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 +)))|((( 1148 +\\ 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 +))) 1306 + 1307 +=== Objekt-Berechtigungen === 1308 + 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 1331 +))) 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 +))) 1368 + 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}} 1371 + 1372 +=== Lokale Owner === 1373 + 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. 1375 + 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 +))) 1391 + 1392 +=== 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 1398 +\\ 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 +))) 1494 + 1495 +== Workflows == 1496 + 1497 +Paperless Workflows können zur Automatisierung verschiedener Tasks eingesetzt werden. In diesem Fall werden zwei Fälle damit abgedeckt: 1498 + 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. 1501 + 705 705 = Offene Punkte = 706 706 707 707 * Docuseal Logging + Monitoring