Änderungen von Dokument Digitale Mitgliederverwaltung
Zuletzt geändert von Daniel Herrmann am 2026/02/22 21:17
Von Version
55.1
bearbeitet von Daniel Herrmann
am 2025/10/24 14:49
am 2025/10/24 14:49
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Auf Version
47.1
bearbeitet von Daniel Herrmann
am 2025/08/31 18:23
am 2025/08/31 18:23
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Zusammenfassung
Details
- Seiteneigenschaften
-
- Inhalt
-
... ... @@ -7,11 +7,11 @@ 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 -= Inhaltsverzeichnis = 10 += {{id name="DigitaleMitgliederverwaltung-Inhaltsverzeichnis"/}}Inhaltsverzeichnis = 11 11 12 12 {{toc/}} 13 13 14 -= Hintergrundinformationen = 14 += {{id name="DigitaleMitgliederverwaltung-Hintergrundinformationen"/}}Hintergrundinformationen = 15 15 16 16 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). 17 17 ... ... @@ -23,47 +23,54 @@ 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 -~| 26 +(% class="wrapped" style="text-decoration: none;" %) 27 +|=((( 28 +Signaturtyp 29 +)))|=((( 30 +Sicherheitsniveau 31 +)))|=((( 32 +Rechtliche Wirkung 33 +)))|=((( 34 +Umsetzung 35 +))) 36 +|((( 37 +**EES** 38 +)))|((( 39 +niedrig 40 +)))|((( 41 +schwacher Beweiswert 42 +)))|((( 43 +Eingescannte Unterschrift, ein einfacher Button 44 +))) 45 +|((( 46 +**FES** 47 +)))|((( 48 +mittel 49 +)))|((( 50 +starker Beweiswert, aber kein Ersatz der Schriftform 51 +)))|((( 52 +Adobe Sign, DocuSign oder ähnliches 53 +))) 54 +|((( 55 +**QES** 56 +)))|((( 57 +hoch 58 +)))|((( 59 +gesetzlich Schriftformersatz 60 +)))|((( 61 +Mehrfaktor, über einen zugelassenen Vertrauensdienstleister 62 +))) 27 27 28 - Signaturtyp |64 +\\ 29 29 30 -Sicherheitsniveau | 66 +{{confluence_tip title="Zusammenfassung"}} 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 +{{/confluence_tip}} 31 31 32 - RechtlicheWirkung|70 += {{id name="DigitaleMitgliederverwaltung-DokumenteundWorkflow"/}}Dokumente und Workflow = 33 33 34 -|=Umsetzung 35 -| 72 +== {{id name="DigitaleMitgliederverwaltung-Dokumenten-Arten"/}}Dokumenten-Arten == 36 36 37 -**EES** | 38 - 39 -niedrig | 40 - 41 -schwacher Beweiswert | 42 - 43 -Eingescannte Unterschrift, ein einfacher Button | | 44 - 45 -**FES** | 46 - 47 -mittel | 48 - 49 -starker Beweiswert, aber kein Ersatz der Schriftform | 50 - 51 -Adobe Sign, DocuSign oder ähnliches | | 52 - 53 -**QES** | 54 - 55 -hoch | 56 - 57 -gesetzlich Schriftformersatz | 58 - 59 -Mehrfaktor, über einen zugelassenen Vertrauensdienstleister | 60 - 61 -~{~{confluence_tip title="Zusammenfassung"}} 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. ~{~{/confluence_tip}} 62 - 63 -= Dokumente und Workflow = 64 - 65 -== Dokumenten-Arten == 66 - 67 67 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: 68 68 69 69 (% class="wrapped" %) ... ... @@ -279,19 +279,19 @@ 279 279 **Vollständig digital**, die Papierform entfällt. Self-Service durch Nutzer:in. 280 280 ))) 281 281 282 -== Workflow Beschreibung == 289 +== {{id name="DigitaleMitgliederverwaltung-WorkflowBeschreibung"/}}Workflow Beschreibung == 283 283 284 284 Grundsätzlich teilt sich der Umgang mit Dokumenten in folgende Phasen auf: 285 285 286 286 {{confluence_drawio border="true" diagramName="Prozess Allgemein" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="991" height="221" revision="2"/}} 287 287 288 -=== Trigger / Starten des Workflows === 295 +=== {{id name="DigitaleMitgliederverwaltung-Trigger/StartendesWorkflows"/}}Trigger / Starten des Workflows === 289 289 290 290 Eine neues Dokument kann auf unterschiedliche Arten erstellt werden. Im Allgemeinen ist es unser Ziel, alle Dokumente vorausgefüllt zur Verfügung zu stellen. Vorausgefüllt bedeutet hierbei, dass mindestens ein QR Code vorhanden ist, der später eine automatische Verarbeitung in Paperless möglich macht. Dabei ist es unerheblich, ob das Dokument komplett digital verarbeitet wird oder zwischenzeitlich auf Grund der Schriftformerfordernis ausgedruckt werden muss. 291 291 292 292 In seltenen Fällen (Haftungsauschluss oder der Nutzungsvereinbarung für Schulungsinhalte) ist eine Personalisierung nicht möglich. In diesem Fall wird der Vorgang mit dem Einscannen des Dokuments begonnen und muss von der Mitgliederverwaltung manuell verarbeitet werden. 293 293 294 -==== Start über die Homepage ==== 301 +==== {{id name="DigitaleMitgliederverwaltung-StartüberdieHomepage"/}}Start über die Homepage ==== 295 295 296 296 Ein Prozess kann über die Homepage eingeleitet werden, entweder durch 297 297 ... ... @@ -299,13 +299,13 @@ 299 299 * **remote, explizit durch den Use**r für sich selbst (Self-Service, beispielsweise der Lager-Vertrag) 300 300 * **remote, explizit durch einen Funktionär** für einen andere User (Datenschutzvereinbarung, Übungsleitervertrag, ...) 301 301 302 -==== Lokal im Makerspace ==== 309 +==== {{id name="DigitaleMitgliederverwaltung-LokalimMakerspace"/}}Lokal im Makerspace ==== 303 303 304 304 Alternativ kann der Prozess lokal im Makerspace angestoßen werden, beispielsweise wenn die lokale Präsenz des Mitglieds notwendig ist (Schlüsselausgabe) oder nach einer Vor-Ort Einweisung. In diesem Fall wird der Prozess beispielsweise ein Tablet im Space verwendet. 305 305 306 306 * **lokal, explizit durch einen Funktionär** (Einweisungsleiter:in, Mitgliederverwaltung, Vorstand), beispielsweise Einweisungszettel oder Schlüsselausgabeformular 307 307 308 -=== Dokument erstellen === 315 +=== {{id name="DigitaleMitgliederverwaltung-Dokumenterstellen"/}}Dokument erstellen === 309 309 310 310 Im zweiten Schritt wird nun ein oder mehrere personalisierte Dokumente erstellt. Hier gibt es eine Entscheidungsmatrix: 311 311 ... ... @@ -361,7 +361,7 @@ 361 361 Das genannte Feature "One-Off" Submission ist ein DocuSeal Pro Feature, welches uns nicht zur Verfügung steht. Eventuell müssen wir 362 362 {{/error}} 363 363 364 -=== Unterschrift leisten === 371 +=== {{id name="DigitaleMitgliederverwaltung-Unterschriftleisten"/}}Unterschrift leisten === 365 365 366 366 Im dritten Schritt müssen eine oder mehrere Parteien das Dokument unterschreiben. Wie viele Parteien ist abhängig vom Dokument. So muss beispielsweise der Mitgliedsantrag nur vom werdenden Mitglied unterschrieben werden, während das Schlüsselausgabeformular vom ausgebenen Funktionär und dem Mitglied unterschrieben werden muss. Analog zur Erstellung des Dokuments wird hier unterschieden, ob das Dokument zuhause unterschrieben werden kann oder ob es vor Ort im Makerspace passiert. 367 367 ... ... @@ -416,7 +416,7 @@ 416 416 \\ 417 417 ))) 418 418 419 -=== Ablegen und Verarbeiten === 426 +=== {{id name="DigitaleMitgliederverwaltung-AblegenundVerarbeiten"/}}Ablegen und Verarbeiten === 420 420 421 421 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: 422 422 ... ... @@ -459,9 +459,9 @@ 459 459 460 460 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. 461 461 462 -= Technisches Design = 469 += {{id name="DigitaleMitgliederverwaltung-TechnischesDesign"/}}Technisches Design = 463 463 464 -== Vorhandene Komponenten == 471 +== {{id name="DigitaleMitgliederverwaltung-VorhandeneKomponenten"/}}Vorhandene Komponenten == 465 465 466 466 Der Verein hat in den letzten Jahren bereits einige Systeme aufgebaut, die uns den Alltag erleichtern und eine gewisse Automatisierung ermöglichen. Dazu gehören: 467 467 ... ... @@ -473,17 +473,17 @@ 473 473 * [[DocuSeal>>url:http://docuseal.com||shape="rect"]] - Eine Open Source Lösung für das Signieren von Dokumenten. Wir betreiben unsere eigene Instanz unter [[https:~~/~~/sign.makerspace-darmstadt.de>>url:https://sign.makerspace-darmstadt.de||shape="rect"]]. DocuSeal ist für die Lagerverträge in die Homepage integriert - ein Mitglied kann die Unterschrift dort anfragen und erhält dann per Mail (=Authentifizierung) eine Einladung, den Vertrag zu unterschreiben. Der Vertrag wird anschließend kryptographisch gegen Veränderungen geschützt und per Mail an das Mitglied und die Mitgliederverwaltung geschickt. 474 474 * [[Vikunja>>url:https://vikunja.io||shape="rect"]] - Ein Open Source System für die Todo-Verwaltung und einfaches Projekt-Tracking. Wir nutzen es stand heute ohne jegliche Integration für die Aufgabenverwaltung im Vorstand, in der Vereins-IT sowie in einigen Bereichen. 475 475 476 -== Neue Komponenten == 483 +== {{id name="DigitaleMitgliederverwaltung-NeueKomponenten"/}}Neue Komponenten == 477 477 478 -=== Paperless NGX === 485 +=== {{id name="DigitaleMitgliederverwaltung-PaperlessNGX"/}}Paperless NGX === 479 479 480 -Paperless-NGX ist ein freies, quelloffenes Dokumentenmanagementsystem (DMS), das als aktiv gepflegter Community-Fork des eingestellten „paperless-ng“ entstanden ist. Die Software läuft unter Linux, ist in Python und TypeScript geschrieben, unter der GPL-3.0 lizenziert und wird üblicherweise containerisiert mit Docker betrieben. In unserem Fall wird sie vor Ort im Makerspace auf dem vorhandenen Kubernetes-Cluster betrieben. 487 +(% style="text-decoration: none;color:var(--ds-text,#333333);" %)Paperless-NGX ist ein freies, quelloffenes Dokumentenmanagementsystem (DMS), das als aktiv gepflegter Community-Fork des eingestellten „paperless-ng“ entstanden ist. Die Software läuft unter Linux, ist in Python und TypeScript geschrieben, unter der GPL-3.0 lizenziert und wird üblicherweise containerisiert mit Docker betrieben. In unserem Fall wird sie vor Ort im Makerspace auf dem vorhandenen Kubernetes-Cluster betrieben. 481 481 482 -Sie dient dazu, Papierdokumente und digitale Dateien zentral zu erfassen, automatisch zu verarbeiten, strukturiert zu archivieren und komfortabel wiederzufinden. Die Dokumente können über verschiedene Wege ins System gelangen – etwa durch einen speziellen „consume“-Ordner, per E-Mail-Import oder via Drag-and-drop im Webinterface. Bei der Verarbeitung wird eine leistungsfähige Texterkennung (OCR) auf Basis von Tesseract eingesetzt, die über 100 Sprachen unterstützt und auch gescannte Dokumente durchsuchbar macht. Zusätzlich werden Metadaten wie Tags, Korrespondenten, Dokumenttypen oder benutzerdefinierte Felder erfasst; diese lassen sich automatisiert per Machine-Learning oder durch definierte Workflows zuweisen, die auch externe Aktionen wie E-Mails oder Webhooks auslösen können. 489 +(% style="text-decoration: none;color:var(--ds-text,#333333);" %) Sie dient dazu, Papierdokumente und digitale Dateien zentral zu erfassen, automatisch zu verarbeiten, strukturiert zu archivieren und komfortabel wiederzufinden. Die Dokumente können über verschiedene Wege ins System gelangen – etwa durch einen speziellen „consume“-Ordner, per E-Mail-Import oder via Drag-and-drop im Webinterface. Bei der Verarbeitung wird eine leistungsfähige Texterkennung (OCR) auf Basis von Tesseract eingesetzt, die über 100 Sprachen unterstützt und auch gescannte Dokumente durchsuchbar macht. Zusätzlich werden Metadaten wie Tags, Korrespondenten, Dokumenttypen oder benutzerdefinierte Felder erfasst; diese lassen sich automatisiert per Machine-Learning oder durch definierte Workflows zuweisen, die auch externe Aktionen wie E-Mails oder Webhooks auslösen können. 483 483 484 -Die Speicherung erfolgt in einem standardisierten PDF/A-Format für die Langzeitarchivierung, wobei stets auch die Originaldateien erhalten bleiben. Metadaten werden in einer Datenbank (PostgreSQL) verwaltet, während die eigentlichen Dateien im Dateisystem (über Kubernetes CSI direkt auf dem NAS) liegen. Über das Webinterface stehen Funktionen wie Volltextsuche mit Auto-Completion, Hervorhebung von Treffern, Filterung und „Ähnliche Dokumente“-Vorschläge zur Verfügung. Mehrbenutzerfähigkeit, fein abgestufte Rechtevergabe und ein anpassbares Dashboard erleichtern die Zusammenarbeit. 491 +(% style="text-decoration: none;color:var(--ds-text,#333333);" %)Die Speicherung erfolgt in einem standardisierten PDF/A-Format für die Langzeitarchivierung, wobei stets auch die Originaldateien erhalten bleiben. Metadaten werden in einer Datenbank (PostgreSQL) verwaltet, während die eigentlichen Dateien im Dateisystem (über Kubernetes CSI direkt auf dem NAS) liegen. Über das Webinterface stehen Funktionen wie Volltextsuche mit Auto-Completion, Hervorhebung von Treffern, Filterung und „Ähnliche Dokumente“-Vorschläge zur Verfügung. Mehrbenutzerfähigkeit, fein abgestufte Rechtevergabe und ein anpassbares Dashboard erleichtern die Zusammenarbeit. 485 485 486 -=== N8n === 493 +=== {{id name="DigitaleMitgliederverwaltung-N8n"/}}(% style="text-decoration: none;color:var(--ds-text,#333333);" %)N8n(%%) === 487 487 488 488 n8n ist ein **Open-Source-Tool zur Workflow-Automatisierung**, das man selbst hosten kann. Über eine **visuelle Oberfläche** baut man Workflows per Drag-and-drop aus sogenannten „Nodes“, die verschiedene Dienste und Aktionen miteinander verbinden. Es gibt Hunderte vorgefertigte Integrationen, z. B. für Slack, Mail oder MQTT. Ebenfalls gibt es eine große Auswahl an für uns relevante Community Nodes (Vikunja, Listmonk, und so weiter) sowie die Möglichkeit, eigene Nodes zu schreiben (beispielsweise Paperless oder NATS). 489 489 ... ... @@ -491,8 +491,10 @@ 491 491 492 492 In unserem Fall wird N8n auf der Infrastruktur im Makerspace betrieben damit, der Zugriff auch auf interne Systeme wie Paperless oder die MQTT Umgebung möglich ist. Das Setup und die Konfiguration von N8n ist auf einer eigenen Wiki-Seite beschrieben. 493 493 494 - === NATS ===501 +\\ 495 495 503 +=== {{id name="DigitaleMitgliederverwaltung-NATS"/}}NATS === 504 + 496 496 Für den Transport von Events zwischen der Homepage (insbesondere dem Backend) und N8n wird **NATS** vorgeschlagen. **NATS** ist ein leichtgewichtiges, schnelles **Messaging-System** für Event-Streaming und -Queues, das auf dem **Publish/Subscribe-Prinzip** basiert. Es eignet sich besonders für verteilte Systeme, bei denen verschiedene Dienste über Events miteinander kommunizieren. 497 497 498 498 Das Backend sendet Ereignisse (als JSON) an einen NATS-Subject (ähnlich einem MQTT Topic). NATS nimmt diese Events sofort entgegen und hält sie je nach Konfiguration im Speicher oder in einer persistierten Stream-Queue (JetStream). n8n kann dann über einen **NATS-Trigger**-Node diese Events abonnieren. Sobald ein Event eintrifft, startet n8n den zugehörigen Workflow automatisch und verarbeitet die enthaltenen Daten. ... ... @@ -499,7 +499,7 @@ 499 499 500 500 NATS entkoppelt Backend und Automatisierungslogik, sorgt für sehr geringe Latenz, zuverlässige Zustellung und ermöglicht horizontale Skalierung, ohne dass FastAPI oder n8n direkt voneinander abhängig sind. 501 501 502 -== Systemübersicht == 511 +== {{id name="DigitaleMitgliederverwaltung-Systemübersicht"/}}Systemübersicht == 503 503 504 504 Das folgende Kapitel gibt eine Übersicht über die vorgeschlagene Systemarchitektur basierend auf den oben vorgestellten Komponenten. Zusätzlich werden für die oben analysierten Dokumente und Workflows die technischen Ablaufdiagramme dargestellt. 505 505 ... ... @@ -508,13 +508,13 @@ 508 508 Im Wesentlichen teilt sich die Architektur in zwei Zonen, die **öffentliche** und die **interne** Zone: 509 509 510 510 * **Paperless** ist das maßgebliche System, welches ausschließlich **intern** erreichbar ist. Es enthält alle Dokumente und somit sehr viele Mitglieder-Daten. Weiterhin ist es auf ein Teil der Infrastruktur im Makerspace (NAS, Drucker, Scanner) angewiesen, sodass es im Netzwerk des Makerspaces laufen muss. Aus Sicherheitsgründen ist Paperless ausschließlich im lokalen Netzwerk des Makerspaces oder per VPN erreichbar. 511 -* Alle den **Mitgliedern gegenüber sichtbare Systeme (Homepage, Backend, ...) sind öffentlich **und auf einem gemieteten Server beim deutschen Anbieter Hetzner gehostet. [[Details dazu finden sich im Wiki>> doc:xwiki:IN.IT Infrastruktur.Public Server Infrastruktur.WebHome]]. Die meiste bestehende Automatisierung wird aktuell im Backend durchgeführt, ist dort allerdings in Python Logic fest einprogrammiert. Die meiste Logik soll in Zukunft über N8n realisiert werden.520 +* Alle den **Mitgliedern gegenüber sichtbare Systeme (Homepage, Backend, ...) sind öffentlich **und auf einem gemieteten Server beim deutschen Anbieter Hetzner gehostet. [[Details dazu finden sich im Wiki>>confluencePage:page:IN.Public Server Infrastruktur]]. Die meiste bestehende Automatisierung wird aktuell im Backend durchgeführt, ist dort allerdings in Python Logic fest einprogrammiert. Die meiste Logik soll in Zukunft über N8n realisiert werden. 512 512 513 513 Für die Kommunikation zwischen beiden Zonen kommt eine **Event Queue** zum Einsatz, wir nutzen hier NATS. NATS wird ebenfalls **auf dem öffentlichen Server installiert. **Der Makerspace selbst ist nur über eine reguläre DSL Leitung an das Internet angebunden, sodass wir hier keine hohe Verfügbarkeit voraussetzen können. Durch die Installation der NATS Services auf dem öffentlichen Server können die dort laufenden Services wie das Backend jederzeit (auch wenn die Internet-Verbindung im Makerspace nicht zur Verfügung steht) die Events veröffentlichen. Die Events werden dann bis zu 7 Tage in der NATS EventQueue persistent gespeichert, und nach Wiederherstellung der Verbindung abgearbeitet. 514 514 515 515 **In N8n** werden dann für die **verschiedenen Events Workflows** definiert. Jeder Workflow beginnt mit einem Trigger (genauer: ein NATS JetStream Trigger), der bei auf definierbare Events in der NATS Queue lauscht. Wird ein solches Event gefunden wird es konsumiert und die im Workflow definierten Aktionen werden abgearbeitet. Weiterhin kann auch **Paperless Events in N8n triggern**, dies passiert allerdings direkt über **Webhooks**. Hier nutzen wir NATS nicht, da der NATS Server in der öffentlichen Zone läuft und dann erneut eine Abhängigkeit zur Internet-Anbindung bestehen würde. 516 516 517 -== Dokument-Workflows == 526 +== {{id name="DigitaleMitgliederverwaltung-Dokument-Workflows"/}}Dokument-Workflows == 518 518 519 519 Die beiden entscheidenden Faktoren für den Workflow: 520 520 ... ... @@ -564,7 +564,7 @@ 564 564 Lokal 565 565 ))) 566 566 567 -=== Fall 1: Digital + Remote === 576 +=== {{id name="DigitaleMitgliederverwaltung-Fall1:Digital+Remote"/}}Fall 1: Digital + Remote === 568 568 569 569 Alle diese Fälle haben gemein, dass der Prozess **remote ausgelöst und abgeschlossen** wird. In diesem Fall wird nie ein ausgedrucktes Dokument erzeugt, das Dokument wird **ausschließlich digital** verwaltet. 570 570 ... ... @@ -591,7 +591,7 @@ 591 591 11. Bei Bedarf (Konfiguration im QR Code) wird ein N8n Webhook ausgelöst 592 592 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) 593 593 594 -=== Fall 2: Digital + Makerspace === 603 +=== {{id name="DigitaleMitgliederverwaltung-Fall2:Digital+Makerspace"/}}Fall 2: Digital + Makerspace === 595 595 596 596 In diesem Fall kann die Unterschrift digital erfolgen, allerdings findet die Unterschrift im Makerspace statt. Beispiel hier ist die Ausgabe eines Schlüssels und das Schlüsselausgabeformular. 597 597 ... ... @@ -645,7 +645,7 @@ 645 645 11. Bei Bedarf (Konfiguration im QR Code) wird ein N8n Webhook ausgelöst 646 646 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) 647 647 648 -=== Fall 3: Handschriftlich + Remote === 657 +=== {{id name="DigitaleMitgliederverwaltung-Fall3:Handschriftlich+Remote"/}}Fall 3: Handschriftlich + Remote === 649 649 650 650 In diesem Fall wird der Prozess durch einen Benutzer **remote ausgelöst, benötigt allerdings die Schriftform.** In diesem Fall wird dem Benutzer ein vorausgefülltes und mit QR Code versehenes Dokument zum Download angeboten, welches dann heruntergeladen, ausgedruckt, unterschrieben und eingereicht werden muss. 651 651 ... ... @@ -671,7 +671,7 @@ 671 671 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. 672 672 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) 673 673 674 -=== Fall 4: Handschriftlich + Makerspace === 683 +=== {{id name="DigitaleMitgliederverwaltung-Fall4:Handschriftlich+Makerspace"/}}Fall 4: Handschriftlich + Makerspace === 675 675 676 676 In diesem Fall wird der Prozess durch einen Benutzer **im Makerspace ausgelöst und benötigt Schriftform.** In diesem Fall wird das Dokument im Makerspace erzeugt (soweit wie möglich vorausgefüllt und mit QR Code versehen) und direkt vor Ort ausgedruckt. Dort wird es dann unterschrieben und eingeworfen. 677 677 ... ... @@ -695,11 +695,11 @@ 695 695 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. 696 696 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) 697 697 698 -= Paperless NGX = 707 += {{id name="DigitaleMitgliederverwaltung-PaperlessNGX"/}}Paperless NGX = 699 699 700 -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**.709 +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**. 701 701 702 -== Paperless Übersicht == 711 +== {{id name="DigitaleMitgliederverwaltung-PaperlessÜbersicht"/}}Paperless Übersicht == 703 703 704 704 **Dokumente** sind die primären Ressourcen in Paperless. Ein Dokument kann über mehrere Wege in Paperless aufgenommen werden (der Prozess wird **Ingestion** genannt): 705 705 ... ... @@ -718,7 +718,7 @@ 718 718 * **SCAN Vorstand** - Platziert das Dokument in dem Consumption Ordner für den Vorstand, Rechte und Tags werden dann automatisch gesetzt 719 719 * **SCAN MV** - Platziert das Dokument in dem Consumption Ordner für die Mitgliederverwaltung, Rechte und Tags werden dann automatisch gesetzt 720 720 721 -== Übersicht der Metadaten == 730 +== {{id name="DigitaleMitgliederverwaltung-ÜbersichtderMetadaten"/}}Übersicht der Metadaten == 722 722 723 723 Dokumente werden dann Meta-Daten zugeordnet, die eine spätere Suche und Zuordnung erleichtern. Diese Meta-Daten sind: 724 724 ... ... @@ -799,15 +799,15 @@ 799 799 ))) 800 800 ))) 801 801 802 -== Automatische Zuordnung von Metadaten == 811 +== {{id name="DigitaleMitgliederverwaltung-AutomatischeZuordnungvonMetadaten"/}}Automatische Zuordnung von Metadaten == 803 803 804 804 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. 805 805 806 806 **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).** 807 807 808 -=== (% style="color:var(--ds-text-accent-purple-bolder,#352c63)" %)Barcode erzeugen(%%) === 817 +=== {{id name="DigitaleMitgliederverwaltung-Barcodeerzeugen"/}}(% style="color:var(--ds-text-accent-purple-bolder,#352c63);" %)Barcode erzeugen(%%) === 809 809 810 -(% style="color:var(--ds-text-accent-purple-bolder,#352c63)" %)Der Prozess zur Erzeugung eines QR Codes ist wie folgt: 819 +(% style="color:var(--ds-text-accent-purple-bolder,#352c63);" %)Der Prozess zur Erzeugung eines QR Codes ist wie folgt: 811 811 812 812 * **Payload (Daten) festlegen**. Einige Werte sind verpflichtend, andere können nach Bedarf optional hinzugefügt werden. 813 813 * JWT erzeugen und signieren. der JWT besteht aus drei Teilen: ... ... @@ -816,13 +816,13 @@ 816 816 ** **Signature**: Mit Hilfe eines Secrets und wird die Signatur erzeugt und automatisch angehängt. 817 817 * PDF417 code erzeugen: ein JWT ist per Definition URL safe und kann daher einfach in ein QR code umgewandelt werden. 818 818 819 -=== Header === 828 +=== {{id name="DigitaleMitgliederverwaltung-Header"/}}Header === 820 820 821 821 Der Header enthält wichtige Meta-Daten, diese werden von der JWT Library automatisch erzeugt und beschreiben in der Regel den verwendeten Key-Typ. 822 822 823 -=== Body === 832 +=== {{id name="DigitaleMitgliederverwaltung-Body"/}}Body === 824 824 825 -Die folgenden Claims sind im Body verfügbar .834 +Die folgenden Claims sind im Body verfügbar: 826 826 827 827 |=((( 828 828 Claim ... ... @@ -872,7 +872,6 @@ 872 872 )))|((( 873 873 Typ des Dokuments basierend auf der unten definierten Liste. 874 874 ))) 875 -|mode|String|✅️ |Kann entweder "digital" oder "manual" sein und bestimmt, ob N8n den unterschriebenen Vertrag ans Backend meldet. 876 876 |((( 877 877 (% class="code" %) 878 878 ((( ... ... @@ -923,29 +923,29 @@ 923 923 Für diesen Anwendungsfall nutzen wir (% style="text-decoration: none;color:var(--ds-text,#333333);" %)**HS256** (HMAC mit SHA-256 Algorithmus). 924 924 {{/confluence_tip}} 925 925 926 -=== Auswahl der Library === 934 +=== {{id name="DigitaleMitgliederverwaltung-AuswahlderLibrary"/}}Auswahl der Library === 927 927 928 928 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: 929 929 930 -|=((( 938 +|=(% scope="col" %)((( 931 931 Name 932 -)))|=((( 940 +)))|=(% scope="col" %)((( 933 933 CVE 934 -)))|=((( 942 +)))|=(% scope="col" %)((( 935 935 Github 936 -)))|=((( 944 +)))|=(% scope="col" %)((( 937 937 GH⭐ 938 -)))|=((( 946 +)))|=(% scope="col" %)((( 939 939 Letztes Release 940 -)))|=((( 948 +)))|=(% scope="col" %)((( 941 941 Offene Issues 942 -)))|=((( 950 +)))|=(% scope="col" %)((( 943 943 Dokumentation 944 -)))|=((( 952 +)))|=(% scope="col" %)((( 945 945 Qualität Dokumentation 946 -)))|=((( 954 +)))|=(% scope="col" %)((( 947 947 In Backend vorhanden? 948 -)))|=((( 956 +)))|=(% scope="col" %)((( 949 949 In Paperless vorhanden? 950 950 ))) 951 951 |((( ... ... @@ -1016,27 +1016,27 @@ 1016 1016 1017 1017 Unsere bevorzugte Library ist **pyjwt**. Diese ist auch in **paperless nativ vorhanden**, sodass wir uns für die Implementierung mittels **pyjwt** entschieden haben. 1018 1018 1019 -=== PDF417 Code === 1027 +=== {{id name="DigitaleMitgliederverwaltung-PDF417Code"/}}PDF417 Code === 1020 1020 1021 -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:1029 +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: 1022 1022 1023 -(% style="color:var(--ds-text-accent-purple-bolder,#352c63); text-decoration:none" %)[[image:attach:barcode.jpg||height="250"]]1031 +(% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %)[[image:attach:barcode.jpg||height="250"]] 1024 1024 1025 -(% 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.1033 +(% 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. 1026 1026 1027 -=== Referenz-Implementierung === 1035 +=== {{id name="DigitaleMitgliederverwaltung-Referenz-Implementierung"/}}Referenz-Implementierung === 1028 1028 1029 1029 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"]] 1030 1030 1031 -=== Post Consumption Script === 1039 +=== {{id name="DigitaleMitgliederverwaltung-PostConsumptionScript"/}}Post Consumption Script === 1032 1032 1033 1033 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"]] 1034 1034 1035 -== Paperless Berechtigungen == 1043 +== {{id name="DigitaleMitgliederverwaltung-PaperlessBerechtigungen"/}}Paperless Berechtigungen == 1036 1036 1037 1037 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. 1038 1038 1039 -=== Benutzer und Gruppen === 1047 +=== {{id name="DigitaleMitgliederverwaltung-BenutzerundGruppen"/}}Benutzer und Gruppen === 1040 1040 1041 1041 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: 1042 1042 ... ... @@ -1046,7 +1046,7 @@ 1046 1046 1047 1047 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. 1048 1048 1049 -=== Globale Berechtigungen === 1057 +=== {{id name="DigitaleMitgliederverwaltung-GlobaleBerechtigungen"/}}Globale Berechtigungen === 1050 1050 1051 1051 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: 1052 1052 ... ... @@ -1298,7 +1298,7 @@ 1298 1298 \\ 1299 1299 ))) 1300 1300 1301 -=== Objekt-Berechtigungen === 1309 +=== {{id name="DigitaleMitgliederverwaltung-Objekt-Berechtigungen"/}}Objekt-Berechtigungen === 1302 1302 1303 1303 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: 1304 1304 ... ... @@ -1363,7 +1363,7 @@ 1363 1363 Mit anderen Worten, um eine Aktion auszuführen, muss ein Benutzer (a) die globale Berechtigung haben **UND** (b) Owner sein **ODER** Objekt-Berechtigungen haben. 1364 1364 {{/info}} 1365 1365 1366 -=== Lokale Owner === 1374 +=== {{id name="DigitaleMitgliederverwaltung-LokaleOwner"/}}Lokale Owner === 1367 1367 1368 1368 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. 1369 1369 ... ... @@ -1383,7 +1383,7 @@ 1383 1383 Alle Objekte (Dokumente, Dokumenttypen, Tags, Korrespondenten und Speicherpfade), die dem Use-Case **Vorstandspost** zugewiesen sind 1384 1384 ))) 1385 1385 1386 -=== Standard-Objekt-Berechtigungen === 1394 +=== {{id name="DigitaleMitgliederverwaltung-Standard-Objekt-Berechtigungen"/}}Standard-Objekt-Berechtigungen === 1387 1387 1388 1388 Basierend auf den hier beschrieben Regeln werden für Objekte die folgenden Berechtigungen gesetzt: 1389 1389 ... ... @@ -1486,7 +1486,7 @@ 1486 1486 IT Admin 1487 1487 ))) 1488 1488 1489 -== Workflows == 1497 +== {{id name="DigitaleMitgliederverwaltung-Workflows"/}}Workflows == 1490 1490 1491 1491 Paperless Workflows können zur Automatisierung verschiedener Tasks eingesetzt werden. In diesem Fall werden zwei Fälle damit abgedeckt: 1492 1492 ... ... @@ -1493,7 +1493,7 @@ 1493 1493 * 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. 1494 1494 * 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. 1495 1495 1496 -= Offene Punkte = 1504 += {{id name="DigitaleMitgliederverwaltung-OffenePunkte"/}}Offene Punkte = 1497 1497 1498 1498 * Docuseal Logging + Monitoring 1499 1499 * N8n Error Handling