Änderungen von Dokument Digitale Mitgliederverwaltung
Zuletzt geändert von Daniel Herrmann am 2026/02/22 21:17
Von Version
22.1
bearbeitet von Daniel Herrmann
am 2025/08/21 21:25
am 2025/08/21 21:25
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Auf Version
36.1
bearbeitet von Daniel Herrmann
am 2025/08/23 12:04
am 2025/08/23 12:04
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Zusammenfassung
Details
- Seiteneigenschaften
-
- Inhalt
-
... ... @@ -19,7 +19,7 @@ 19 19 20 20 Kurz gesagt: Die EES ist schnell und unkompliziert, aber unsicher und nur für risikofreie Vorgänge geeignet. Die FES ist technisch sicherer, rechtlich belastbarer und für wichtige, aber formfreie Vereinbarungen ideal. Die QES ist rechtlich vollwertig wie eine handschriftliche Unterschrift und für alle Schriftformerfordernisse zwingend notwendig. Zusammenfassung: 21 21 22 -(% style="text-decoration: none;" %) 22 +(% class="wrapped" style="text-decoration: none;" %) 23 23 |=((( 24 24 Signaturtyp 25 25 )))|=((( ... ... @@ -69,6 +69,7 @@ 69 69 70 70 Am Dienstag, den 12.08.2025 fand hierzu ein Workshop statt, bei dem Vertreter des IT Teams, der Mitgliederverwaltung sowie des Vorstands teilgenommen haben. Dabei wurden die Ziele erläutert und definiert, ebenfalls haben eine Übersicht der bestehenden Dokumenten-Typen erstellt, mit denen wir im Verein heute hantieren. Für jedes Dokument wurde dann evaluiert, ob es in Zukunft komplett digitalisiert werden kann oder ob beispielsweise aus Haftungsgründen die Schriftform und damit eine handschriftliche Unterschrift weiterhin notwendig ist. Die folgende Tabelle gibt einen Überblick: 71 71 72 +(% class="wrapped" %) 72 72 |=(% scope="col" %)((( 73 73 Dokumenten-Typ 74 74 )))|=(% scope="col" %)((( ... ... @@ -77,7 +77,7 @@ 77 77 )))|=(% scope="col" %)((( 78 78 Prozess heute 79 79 )))|=(% scope="col" %)((( 80 - ProzessZukunft81 +Notwendige Änderungen 81 81 ))) 82 82 |((( 83 83 Mitgliedsantrag ... ... @@ -91,7 +91,7 @@ 91 91 * Nach Eingang: Mitgliederverwaltung prüft den Antrag und genehmigt ihn 92 92 * Mitgliederakte wird angelegt, der Antrag wird in der Akte abgeheftet 93 93 )))|((( 94 -Der Antrag kannkomplett **digital unterschrieben** werden. Vorgehen:95 +Der Antrag soll komplett **digital unterschrieben** werden. Vorgehen: 95 95 96 96 * Interessent:in füllt den Online-Antrag auf der Homepage aus 97 97 * Nach Bestätigung der E-Mail Adresse wird ein Vorgang zur digitalen Unterschrift ausgelöst ... ... @@ -162,11 +162,7 @@ 162 162 Ist ein Blanko-Formular, welches ausgefüllt, eingeworfen und abgeheftet wird. 163 163 Danach wird ein Flag für das jeweilige Mitglied gesetzt, dass die Erklärung abgegeben wurde. 164 164 )))|((( 165 -**Vollständig digital**. 166 - 167 -* Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage) 168 -* Mitglied erhält die Aufforderung per Mail das Dokument zu unterschreiben 169 -* Nach Unterschrift wird das Flag automatisch gesetzt und das Dokument wird zu Paperless NGX hochgeladen. 166 +**Vollständig digital**. Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage), danach digital weiter. 170 170 ))) 171 171 |((( 172 172 Übungsleitervertrag ... ... @@ -180,12 +180,9 @@ 180 180 * Bestätigung dass der Vertrag vorliegt 181 181 * Ein Flag ob das Mitglied die Übungsleiterpauschale an den Verein spendet oder nicht 182 182 )))|((( 183 -**Vollständig digital**. 180 +**Vollständig digital**. Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage), danach digital weiter. 184 184 185 -* Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage) 186 -* Mitglied erhält die Aufforderung per Mail das Dokument zu unterschreiben 187 -* Nach Unterschrift wird das erste automatisch gesetzt und das Dokument wird zu Paperless NGX hochgeladen. 188 -* Ein Todo für die Mitgliederverwaltung wird erstellt um zu prüfen, ob das Mitglied die Pauschale spenden möchte oder nicht. 182 +Ein Todo für die Mitgliederverwaltung wird erstellt um zu prüfen, ob das Mitglied die Pauschale spenden möchte oder nicht. 189 189 ))) 190 190 |((( 191 191 Nutzungsvereinbarung Schulungsinhalte ... ... @@ -196,7 +196,7 @@ 196 196 197 197 Urheberrecht, Übertragung von Nutzungsrechten sollte in Schriftform erfolgen 198 198 )))|((( 199 -Unverändert, bleibt handschriftlich. Manuell über Dokumentenscanner Einscannen und in Paperless dem Mitglied zuweisen.193 +Unverändert, bleibt handschriftlich. Manuell über Dokumentenscanner einscannen und in Paperless dem Mitglied zuweisen. 200 200 ))) 201 201 |((( 202 202 Bestellung eines Einweisers ... ... @@ -257,7 +257,7 @@ 257 257 ** Muss für den Einweisenden eine Auszahlung veranlasst werden? 258 258 * Danach wird der Zettel in die jeweiligen Akten einsortiert. 259 259 )))|((( 260 - \\254 +Der Einweisungszettel ist das bei weitem komplizierteste Dokument, hierfür wird ein separater Workshop stattfinden. Siehe weiter unten für Details. 261 261 ))) 262 262 |((( 263 263 Lagervertrag Kistenlager ... ... @@ -271,7 +271,7 @@ 271 271 272 272 Nach Erfassen kann die Person eine Kiste beantragen, die dann monatliche Kosten auslöst 273 273 )))|((( 274 - \\268 +**Vollständig digital**, die Papierform entfällt. Self-Service durch Nutzer:in. 275 275 ))) 276 276 |((( 277 277 Lagervertrag Projektlager ... ... @@ -285,7 +285,7 @@ 285 285 286 286 Nach Erfassen kann die Person das Projektlager automatisch nutzen. 287 287 )))|((( 288 - \\282 +**Vollständig digital**, die Papierform entfällt. Self-Service durch Nutzer:in. 289 289 ))) 290 290 291 291 == {{id name="DigitaleMitgliederverwaltung-WorkflowBeschreibung"/}}Workflow Beschreibung == ... ... @@ -318,6 +318,7 @@ 318 318 319 319 Im zweiten Schritt wird nun ein oder mehrere personalisierte Dokumente erstellt. Hier gibt es eine Entscheidungsmatrix: 320 320 315 +(% class="wrapped" %) 321 321 |=(% scope="col" %)((( 322 322 Remote / Lokal 323 323 )))|=(% scope="col" %)((( ... ... @@ -373,7 +373,8 @@ 373 373 374 374 Im dritten Schritt müssen eine oder mehrere Parteien das Dokument unterschreiben. Wie viele Parteien ist abhängig vom Dokument. So muss beispielsweise der Mitgliedsantrag nur vom werdenden Mitglied unterschrieben werden, während das Schlüsselausgabeformular vom ausgebenen Funktionär und dem Mitglied unterschrieben werden muss. Analog zur Erstellung des Dokuments wird hier unterschieden, ob das Dokument zuhause unterschrieben werden kann oder ob es vor Ort im Makerspace passiert. 375 375 376 -(% class="" %)|=((( 371 +(% class="wrapped" %) 372 +|=((( 377 377 Remote / Lokal 378 378 )))|=((( 379 379 Schriftformerfordernis ... ... @@ -382,7 +382,7 @@ 382 382 )))|=((( 383 383 Beschreibung 384 384 ))) 385 - (% class="" %)|(((381 +|((( 386 386 Remote 387 387 )))|((( 388 388 Nein ... ... @@ -391,7 +391,7 @@ 391 391 )))|((( 392 392 Unterschrift über DocuSeal. Parteien werden nacheinander per Mail zur Unterschrift aufgefordert 393 393 ))) 394 - (% class="" %)|(((390 +|((( 395 395 Remote 396 396 )))|((( 397 397 Ja ... ... @@ -400,7 +400,7 @@ 400 400 )))|((( 401 401 Das Mitglied muss das Dokument ausdrucken, **handschriftlich** unterschreiben und in den Makerspace mitbringen. 402 402 ))) 403 - (% class="" %)|(((399 +|((( 404 404 Lokal 405 405 )))|((( 406 406 Nein ... ... @@ -412,7 +412,7 @@ 412 412 * Direkt auf dem Tablet in Docuseal ([[Docuseal In-Person Signing>>url:https://www.docuseal.com/resources/sign-documents-in-person||shape="rect"]]) 413 413 * PDF erzeugen, in der App unterschreiben, PDF danach in Paperless hochladen 414 414 ))) 415 - (% class="" %)|(((411 +|((( 416 416 Lokal 417 417 )))|((( 418 418 Ja ... ... @@ -427,6 +427,7 @@ 427 427 428 428 Egal welcher Prozess angewandt wird, das Dokument muss am Ende in Paperless eingelesen und mit den Meta-Daten (siehe unten) versehen werden. Hier gibt es drei verschiedene Varianten: 429 429 426 +(% class="wrapped" %) 430 430 |=(% scope="col" %)((( 431 431 Signatur über 432 432 )))|=(% scope="col" %)((( ... ... @@ -465,7 +465,7 @@ 465 465 466 466 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 467 468 -= {{id name="DigitaleMitgliederverwaltung-Technische Übersicht"/}}TechnischeÜbersicht=465 += {{id name="DigitaleMitgliederverwaltung-TechnischesDesign"/}}Technisches Design = 469 469 470 470 == {{id name="DigitaleMitgliederverwaltung-VorhandeneKomponenten"/}}Vorhandene Komponenten == 471 471 ... ... @@ -507,12 +507,200 @@ 507 507 508 508 == {{id name="DigitaleMitgliederverwaltung-Systemübersicht"/}}Systemübersicht == 509 509 510 -Das folgende Kapitel gibt eine Übersicht über die vorgeschlagene Systemarchitektur basierend auf den oben vorgestellten Komponenten. Zusätzlich werden einigeBeispiel-Worksflowsvorgestellt, einedetailliertereÜbersichtderobenvorgestelltenUse-Casesfürdie Dokumentefolgt weiter unten.507 +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. 511 511 512 512 {{confluence_drawio border="true" diagramName="System Architecture" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1034" height="578" revision="5"/}} 513 513 514 - TODO:GenauereBeschreibungderKomponenten511 +Im Wesentlichen teilt sich die Architektur in zwei Zonen, die **öffentliche** und die **interne** Zone: 515 515 513 +* **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. 514 +* 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. 515 + 516 +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. 517 + 518 +**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. 519 + 520 +== {{id name="DigitaleMitgliederverwaltung-Dokument-Workflows"/}}Dokument-Workflows == 521 + 522 +Die beiden entscheidenden Faktoren für den Workflow: 523 + 524 +1. **Erfordernis der Schriftform** 525 +11. **Ja** - auf Grund der Haftungshöhe oder anderer gesetzlichen Anforderungen ist die **Schriftform** erforderlich. Da wir stand heute keine Qualifizierte elektronische Signatur (QeS) umsetzen können, ist dies eine **handschriftliche** Unterschrift 526 +11. **Nein** - eine Fortgeschrittene elektronische Signatur (FeS) ist ausreichend. 527 +1. Ort der Unterschrift 528 +11. **Remote** - Der Prozess wird typischerweise über die Homepage angestoßen und 529 +11. **Lokal (Makerspace)** - Der Prozess wird als Reaktion auf ein In-Person Event im Makerspace ausgelöst, beispielsweise einer Einweisung oder einer Schlüsselausgabe 530 + 531 +Daraus ergeben sich vier verschiedene Kombinationen (Workflows), die nachstehend genauer beschrieben sind. 532 + 533 +(% class="wrapped" %) 534 +|=(% scope="row" %)((( 535 +Workflow 536 +)))|=(% scope="col" %)((( 537 +Schriftform erforderlich 538 +)))|=(% scope="col" %)((( 539 +Lokal / Remote 540 +))) 541 +|=(% scope="row" %)((( 542 +Fall 1: Digital Remote 543 +)))|((( 544 +Nein 545 +)))|((( 546 +Remote 547 +))) 548 +|=(% scope="row" %)((( 549 +Fall 2: Digital Makerspace 550 +)))|((( 551 +Nein 552 +)))|((( 553 +Lokal 554 +))) 555 +|=(% scope="row" %)((( 556 +Fall 3: Handschriftlich Remote 557 +)))|((( 558 +Ja 559 +)))|((( 560 +Remote 561 +))) 562 +|=(% scope="row" %)((( 563 +Fall 4: Handschriftlich Makerspace 564 +)))|((( 565 +Ja 566 +)))|((( 567 +Lokal 568 +))) 569 + 570 +=== {{id name="DigitaleMitgliederverwaltung-Fall1:Digital+Remote"/}}Fall 1: Digital + Remote === 571 + 572 +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. 573 + 574 +**Beispiele**: Lagerverträge, Mitgliedsantrag, SEPA Lastschriftmandat, Übungsleitervertrag, ... 575 + 576 +Die folgende Grafik zeigt den Prozessablauf: 577 + 578 +{{confluence_drawio border="true" diagramName="Fall 1 Ablaufdiagramm" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1138" height="515" revision="4"/}} 579 + 580 +Die einzelnen Schritte hierbei sind: 581 + 582 +1. User löst eine Aktion auf der Homepage aus, die ein Dokument erfordert. Beispielsweise stellt die Person einen Mitgliedsantrag, beantragt die Nutzung des Lagers oder ähnliches 583 +1. Die Anfrage wird vom Backend verarbeitet. Hierbei werden sowohl die Rechte geprüft (Lager kann nur von Mitgliedern verwendet werden, der ein neuer Übungsleitervertrag kann nur von Vorstand oder Mitgliederverwaltung angestoßen werden). Danach 584 +11. Speichert das Backend die Anfrage als Signature Request in der Datenbank 585 +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). 586 +1. Docuseal informiert die beteiligten Parteien automatisch und bittet um eine Unterschrift. Die Parteien können über das Webinterface unterschreiben, entweder mit der Haus auf dem Computer oder mit Hilfe des Handys. 587 +1. (Optional): Ein regelmäßig laufender Cronjob prüft die laufenden Verfahren. Nach einer Woche Inaktivität wird der Unterschriftprozess abgebrochen, 48 Stunden vorher wird eine Erinnerung verschickt 588 +1. Nachdem alle Parteien unterschrieben haben informiert Docuseal das Backend über ein Webhook. Beide Systeme laufen auf dem gleichen Server, weiterhin können fehlgeschlagene Webhooks bei Bedarf wiederholt werden. Das Backend markiert den Prozess als abgeschlossen und führt gegebenenfalls interne Schritte aus (Berechtigungen für ein User anlegen oder ähnliches) 589 +1. Das Backend erstellt ein NATS Event mksp.backend.signature.completed, welches dann in N8n einen Workflow auslöst 590 +1. N8n lädt das von allen Parteien unterschriebene Dokument von Docuseal herunter 591 +1. N8n lädt das Dokument zu Paperless hoch. Dort wird es wie alle anderen Dokumente verarbeitet. Das Post Consumption Script (siehe unten) scannt das Dokument auf einen MKSP QR Code 592 +1. Wird ein MKSP QR Code gefunden passieren zwei Dinge: 593 +11. Die Paperless Meta Daten werden automatisch zugewiesen. 594 +11. Bei Bedarf (Konfiguration im QR Code) wird ein N8n Webhook ausgelöst 595 +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) 596 + 597 +=== {{id name="DigitaleMitgliederverwaltung-Fall2:Digital+Makerspace"/}}Fall 2: Digital + Makerspace === 598 + 599 +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. 600 + 601 +Wir können nicht davon ausgehen, dass alle Personen ein mobiles Endgerät dabei haben, mit dem sie E-Mails abrufen und Unterschriften leisten können. Außerdem ist die Unterschrift Voraussetzung dafür, dass der Schlüssel auch tatsächlich eingebunden wird, die Unterschrift ist also mittig in einem Prozess eingebunden und erfordert ein unmittelbares Feedback ähnlich einer handschriftlichen Unterschrift. 602 + 603 +**Beispiele**: Ausgabeformular Schlüsselkarte / RFID Token 604 + 605 +Die folgende Grafik zeigt den Prozessablauf: 606 + 607 +{{confluence_drawio border="true" diagramName="Fall 2 Ablaufdiagramm" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1138" height="499" revision="2"/}} 608 + 609 +Die einzelnen Schritte hierbei sind: 610 + 611 +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 Ausgabe eines Schlüssels. Dies erfordert irgendwo im Prozess, dass direkt vor Ort ein Dokument unterschrieben werden muss. 612 +1. Tablet sendet im Namen des angemeldeten Benutzers eine Anfrage ans Backend. Die Anfrage wird vom Backend verarbeitet. Danach... 613 +11. Speichert das Backend die Anfrage als Signature Request in der Datenbank 614 +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). 615 +11. ((( 616 +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:\\ 617 + 618 +{{expand}} 619 +{{code language="json"}} 620 +[ 621 + { 622 + "id": 430, 623 + "uuid": "3845d527-ea14-402a-bd05-e85cd4b28a68", 624 + "name": "Vorname Nachname", 625 + ... 626 + "role": "Mitglied", 627 + "embed_src": "https://sign.makerspace-darmstadt.de/s/mMUEBY6Knz1vap" 628 + }, 629 + { 630 + "id": 431, 631 + "uuid": "04cbbf45-e3eb-4956-b104-01c0315adc94", 632 + "name": null, 633 + ... 634 + "role": "Verein", 635 + "embed_src": "https://sign.makerspace-darmstadt.de/s/k5gvGuBjW5fkb1" 636 + } 637 +] 638 +{{/code}} 639 +{{/expand}} 640 +))) 641 +1. Die beteiligten Personen unterschreiben direkt auf dem Tablet. 642 +1. Nachdem alle Parteien unterschrieben haben informiert Docuseal das Backend über ein Webhook. Das Backend markiert den Prozess als abgeschlossen und führt gegebenenfalls interne Schritte aus (Berechtigungen für ein User anlegen oder ähnliches). Der Vorgang kann auf dem Tablet direkt weitergeführt werden. 643 +1. Das Backend erstellt ein NATS Event mksp.backend.signature.completed, welches dann in N8n einen Workflow auslöst 644 +1. N8n lädt das von allen Parteien unterschriebene Dokument von Docuseal herunter 645 +1. N8n lädt das Dokument zu Paperless hoch. Dort wird es wie alle anderen Dokumente verarbeitet. Das Post Consumption Script (siehe unten) scannt das Dokument auf einen MKSP QR Code 646 +1. Wird ein MKSP QR Code gefunden passieren zwei Dinge: 647 +11. Die Paperless Meta Daten werden automatisch zugewiesen. 648 +11. Bei Bedarf (Konfiguration im QR Code) wird ein N8n Webhook ausgelöst 649 +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) 650 + 651 +=== {{id name="DigitaleMitgliederverwaltung-Fall3:Handschriftlich+Remote"/}}Fall 3: Handschriftlich + Remote === 652 + 653 +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. 654 + 655 +**Beispiele**: Einweisungszettel für reine Online-Einweisungen 656 + 657 +{{confluence_drawio border="true" diagramName="Fall 3 Ablaufdiagramm_" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1159" height="467" revision="2"/}} 658 + 659 +Die einzelnen Schritte hierbei sind: 660 + 661 +1. User löst eine Aktion auf der Homepage aus, die ein Dokument erfordert. Beispielsweise hat der User eine Online-Einweisung beendet und muss dafür nun den Einweisungszettel unterschreiben. 662 +1. Die Anfrage wird vom Backend verarbeitet. Hierbei werden sowohl die Rechte geprüft (Lager kann nur von Mitgliedern verwendet werden, der ein neuer Übungsleitervertrag kann nur von Vorstand oder Mitgliederverwaltung angestoßen werden). Danach 663 +11. Speichert das Backend die Anfrage als Signature Request in der Datenbank 664 +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). 665 +11. Das vorausgefüllte Dokument wird im PDF Format heruntergeladen und die Submission wird direkt wieder archived. 666 +1. Das vorausgefüllte PDF wird als Antwort auf die Anfrage an die Website zum Download angeboten. Der Benutzer druckt das PDF aus. 667 +1. (Optional): Ein regelmäßig laufender Cronjob prüft die laufenden Verfahren. Nach einer Woche Inaktivität wird der Unterschriftprozess abgebrochen, 48 Stunden vorher wird eine Erinnerung verschickt 668 +1. Das ausgedruckte Dokument wird vom Benutzer unterschrieben, wenn weitere Parteien notwendig sind, auch diesen zur Unterschrift vorgelegt. 669 +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. 670 +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 671 +1. Wird ein MKSP QR Code gefunden passieren zwei Dinge: 672 +11. Die Paperless Meta Daten werden automatisch zugewiesen. 673 +11. Es wird ein N8n Webhook ausgelöst 674 +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. 675 +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) 676 + 677 +=== {{id name="DigitaleMitgliederverwaltung-Fall4:Handschriftlich+Makerspace"/}}Fall 4: Handschriftlich + Makerspace === 678 + 679 +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. 680 + 681 +**Beispiele**: Einweisungszettel für Vor-Ort Online-Einweisungen 682 + 683 +{{confluence_drawio border="true" diagramName="Fall 4 Ablaufdiagramm" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1208" height="523" revision="3"/}} 684 + 685 +Die einzelnen Schritte hierbei sind: 686 + 687 +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. 688 +1. Tablet sendet im Namen des angemeldeten Benutzers eine Anfrage ans Backend. Die Anfrage wird vom Backend verarbeitet. Danach... 689 +11. Speichert das Backend die Anfrage als Signature Request in der Datenbank 690 +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). 691 +1. Das Tablet druckt das oder die heruntergeladenen PDF Datei(en) aus. 692 +1. Die Parteien unterschreiben das Dokument handschriftlich und werfen es in den Briefkasten. 693 +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. 694 +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 695 +1. Wird ein MKSP QR Code gefunden passieren zwei Dinge: 696 +11. Die Paperless Meta Daten werden automatisch zugewiesen. 697 +11. Es wird ein N8n Webhook ausgelöst 698 +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. 699 +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) 700 + 516 516 = {{id name="DigitaleMitgliederverwaltung-PaperlessNGX"/}}Paperless NGX = 517 517 518 518 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**. ... ... @@ -542,6 +542,7 @@ 542 542 **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. 543 543 \\ 544 544 730 +(% class="wrapped" %) 545 545 |=(% scope="col" %)((( 546 546 Name 547 547 )))|=(% scope="col" %)((( ... ... @@ -620,53 +620,226 @@ 620 620 621 621 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. 622 622 623 -Aus diesem Grund nutzenwir einen speziellenQR Code ineinemfürdenMakerspacespezifischenFormat,welchesnachstehend detailliert beschriebenwird.809 +**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).** 624 624 625 -{{code language="json"}} 626 -{ 627 - "payload": { 628 - "timestamp": "YYYY-MM-DDTHH:mm:ss", 629 - "correspondent": "Daniel Herrmann (#250)", 630 - "type": "mksp-doc-sepamandat", 631 - "tags": [ 632 - "tag1", 633 - "tag2" 634 - ], 635 -"storage_path": "Mitgliederverwaltung" 636 - }, 637 - "sig": "signature over the entire payload block" 638 -} 639 -{{/code}} 811 +=== {{id name="DigitaleMitgliederverwaltung-QRcodeerzeugen"/}}(% style="color:var(--ds-text-accent-purple-bolder,#352c63);" %)**QR **(% style="color: rgb(53, 44, 99)" %)code erzeugen(%%) === 640 640 641 - Diebeiden Einträge **payload** und **sig** sind **Pflichtfelder**. Innerhalb der Payload muss der **timestamp** **vorhanden** sein, alle anderenFeldersind optional, jedoch muss mindestens eins angegebenwerden.DerQR Codekann dann - insbesonderebei der Digitalen Unterschrift oder bei Workflows, wo die Formulareohnehin on demand erzeugt werdenbereits mit allen Daten bestückt werden. In Paperlessgibtes dann einPostconsumeScript, welchesdenQR Codeausliest,dieSignatur prüft und - falls die Signatur korrekt ist - automatisch die Meta-Daten übernimmt.813 +(% style="color: rgb(53,44,99);" %)Der Prozess zur Erzeugung eines QR Codes ist wie folgt: 642 642 643 -=== {{id name="DigitaleMitgliederverwaltung-Signatur"/}}Signatur === 815 +* **Payload (Daten) festlegen**. Einige Werte sind verpflichtend, andere können nach Bedarf optional hinzugefügt werden. 816 +* JWT erzeugen und signieren. der JWT besteht aus drei Teilen: 817 +** **Header**: **alg** (Algorithmus) und **typ** (JWT) sind verpflichtend. Zusätzlich fügen wir einen Timestamp, eine eindeutige ID und eine Gültigkeitsdauer hinzu. 818 +** **Body**: beinhaltet die eigentlichen Daten. 819 +** **Signature**: Mit Hilfe eines Secrets und wird die Signatur erzeugt und automatisch angehängt. 820 +* QR code erzeugen: ein JWT ist per Definition URL safe und kann daher einfach in ein QR code umgewandelt werden. 644 644 645 - DieSignatur wirdkryptographischmit Hilfeasymmetrischen Verschlüsselungerzeugt. Wir erzeugen ein RSA 2048 Key Pair. Der öffentlicheSchlüssel steht Paperless zurVerfügung, sodass Paperless die Signaturenverifizieren kann. Der private Teildes Schlüssels wird von den Makerspace-Systemem verwendet, welche die Formulareerzeugen. Im Detail:822 +=== {{id name="DigitaleMitgliederverwaltung-Header"/}}Header === 646 646 647 -* **Key-Pair**: 2048 bit Schlüssellänge, RSA, 65537 Exponent 648 -* **Signatur**: SHA256 Signatur, PKCS1v15 Padding 649 -* ((( 650 -**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: 651 -\\ 824 +Der Header enthält wichtige Meta-Daten: 652 652 653 -{{code language="json"}} 654 -{"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"} 655 -{{/code}} 826 +|=(% scope="col" %)((( 827 +Claim 828 +)))|=(% scope="col" %)((( 829 +Type 830 +)))|=(% scope="col" %)((( 831 +Pflicht 832 +)))|=(% scope="col" %)((( 833 +Beschreibung 834 +))) 835 +|((( 836 +time 837 +)))|((( 838 +Timestamp 839 +Format: YYYY-MM-DDTHH:mm:ss 840 +)))|((( 841 +✅️ 842 +)))|((( 843 +Timestamp an dem das Dokument und der QR Code erzeugt wurden 844 +))) 845 +|((( 846 +id 847 +)))|((( 848 +UUID4 849 +)))|((( 850 +✅️ 851 +)))|((( 852 +Eindeutige ID dieses Dokuments 853 +))) 854 +|((( 855 +exp 856 +)))|((( 857 +Zahl 858 +)))|((( 859 +✅️ 860 +)))|((( 861 +Dauer der Gültigkeit gemessen in Sekunden, beispielsweise 1209600 für 2 Wochen. 862 +))) 656 656 864 +=== {{id name="DigitaleMitgliederverwaltung-Body"/}}Body === 657 657 658 -Als Referenz, die in Python wäre der Input der Signatur: 659 -\\ 866 +Die folgenden Claims sind im Body verfügbar: 660 660 661 -{{code language="python"}} 662 -import json 868 +(% class="" %)|=((( 869 +Claim 870 +)))|=((( 871 +Type 872 +)))|=((( 873 +Pflicht 874 +)))|=((( 875 +Beschreibung 876 +))) 877 +(% class="" %)|((( 878 +(% class="code" %) 879 +((( 880 +typ 881 +))) 882 +)))|((( 883 +String 884 +)))|((( 885 +✅️ 886 +)))|((( 887 +Typ des Dokuments basierend auf der unten definierten Liste. 888 +))) 889 +(% class="" %)|((( 890 +(% class="code" %) 891 +((( 892 +cor 893 +))) 894 +)))|((( 895 +String 896 +)))|((( 897 +❌️ 898 +)))|((( 899 +Optional: Name des Korrespondenten, dem das Dokument zugeordnet werden soll 900 +))) 901 +(% class="" %)|((( 902 +tags 903 +)))|((( 904 +List[String] 905 +)))|((( 906 +❌️ 907 +)))|((( 908 +Liste an Tags, die dem Dokument zugeordnet werden soll 909 +))) 910 +|((( 911 +spth 912 +)))|((( 913 +String 914 +)))|((( 915 +❌️ 916 +)))|((( 917 +Storage Path, das dem Dokument zugeordnet werden soll 918 +))) 919 +|((( 920 +opt 921 +)))|((( 922 +dict 923 +)))|((( 924 +❌️ 925 +)))|((( 926 +Optionale Attribute, die mit eincodiert werden und dem N8n Workflow übergeben werden. 927 +))) 663 663 664 -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'} 665 -signature_data = json.dumps(input_data, separators=(',', ':')).encode('utf-8') 666 -{{/code}} 929 +=== {{id name="DigitaleMitgliederverwaltung-Footer"/}}Footer === 930 + 931 +Der Footer wird automatisch erzeugt und erhält eine Signatur über den Header und den Body, basierend auf einem Algorithmus und einer Signatur. 932 + 933 +{{confluence_tip title="Algorithmus"}} 934 +Von den meisten Libraries werden symmetrische und asymmetrische Signaturen unterstützt. Die Verwendung eines symmetrischen Algorithmus ist für uns einfacher. 935 + 936 +Für diesen Anwendungsfall nutzen wir (% style="text-decoration: none;color:var(--ds-text,#333333);" %)**HS256** (HMAC mit SHA-256 Algorithmus). 937 +{{/confluence_tip}} 938 + 939 +=== {{id name="DigitaleMitgliederverwaltung-AuswahlderLibrary"/}}Auswahl der Library === 940 + 941 +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: 942 + 943 +|=(% scope="col" %)((( 944 +Name 945 +)))|=(% scope="col" %)((( 946 +CVE 947 +)))|=(% scope="col" %)((( 948 +Github 949 +)))|=(% scope="col" %)((( 950 +GH⭐ 951 +)))|=(% scope="col" %)((( 952 +Letztes Release 953 +)))|=(% scope="col" %)((( 954 +Offene Issues 955 +)))|=(% scope="col" %)((( 956 +Dokumentation 957 +)))|=(% scope="col" %)((( 958 +Qualität Dokumentation 959 +)))|=(% scope="col" %)((( 960 +In Backend vorhanden? 961 +)))|=(% scope="col" %)((( 962 +In Paperless vorhanden? 667 667 ))) 964 +|((( 965 +python-jose 966 +)))|((( 967 +3/0 968 +)))|((( 969 +[[https:~~/~~/github.com/mpdavis/python-jose>>url:https://github.com/mpdavis/python-jose||shape="rect"]] 970 +)))|((( 971 +1.7k 972 +)))|((( 973 +28.05.2025 974 +)))|((( 975 +83 976 +)))|((( 977 +[[https:~~/~~/python-jose.readthedocs.io/en/latest/>>url:https://python-jose.readthedocs.io/en/latest/||shape="rect"]] 978 +)))|((( 979 +⛔ Wenige Bespiele, API Dokumentation fehlt komplett 980 +)))|((( 981 +❌️ 982 +)))|((( 983 +❌️ 984 +))) 985 +|((( 986 +pyJWT 987 +)))|((( 988 +4/0 989 +)))|((( 990 +[[https:~~/~~/github.com/jpadilla/pyjwt>>url:https://github.com/jpadilla/pyjwt||shape="rect"]] 991 +)))|((( 992 +5.4k 993 +)))|((( 994 +28.11.2024 995 +)))|((( 996 +30 997 +)))|((( 998 +[[https:~~/~~/pyjwt.readthedocs.io>>url:https://pyjwt.readthedocs.io||shape="rect"]] 999 +)))|((( 1000 +➕️ Gute Dokumentation, API, Beispiele, Changelog 1001 +)))|((( 1002 +✅️ 2.10.1 1003 +)))|((( 1004 +✅️ 2.10.1 1005 +))) 1006 +|((( 1007 +JWCrypto 1008 +)))|((( 1009 +5/0 1010 +)))|((( 1011 +[[https:~~/~~/github.com/latchset/jwcrypto>>url:https://github.com/latchset/jwcrypto||shape="rect"]] 1012 +)))|((( 1013 +465 1014 +)))|((( 1015 +06.03.2024 1016 +)))|((( 1017 +8 1018 +)))|((( 1019 +[[https:~~/~~/jwcrypto.readthedocs.io>>url:https://jwcrypto.readthedocs.io||shape="rect"]] 1020 +)))|((( 1021 +➕️ API Doc, einige Beispiele 1022 +)))|((( 1023 +✅️ 1.5.6 1024 +)))|((( 1025 +❌️ 1026 +))) 668 668 669 - \\1028 +Unsere bevorzugte Library ist **pyjwt**. Diese ist auch in **paperless nativ vorhanden**, sodass wir uns für die Implementierung mittels **pyjwt** entschieden haben. 670 670 671 671 == {{id name="DigitaleMitgliederverwaltung-TechnischesSetup"/}}Technisches Setup == 672 672 ... ... @@ -676,43 +676,7 @@ 676 676 Tag: owner = grp owner, view = jeweilige Gruppe, edit = it admin 677 677 Doc Type: owner = grp owner, view = jeweilige Gruppe, edit = it admin 678 678 679 - TODO1038 += {{id name="DigitaleMitgliederverwaltung-OffenePunkte"/}}Offene Punkte = 680 680 681 -\\ 682 - 683 -=== {{id name="DigitaleMitgliederverwaltung-AusFace2Faceam20.8(DH,YS)"/}}Aus Face 2 Face am 20.8 (DH,YS) === 684 - 685 -* Schritt 1: Einweisungszettel erzeugen 686 -** Checkliste in Directus hinterlegen, eine pro Einweisung 687 -** N8n Workflow, welches die Liste aus Directus herunterlädt und Template mit Puppetteer Script Node erzeugen 688 -** Aus diesem Template dann ein DocuSeal Template erstellen 689 -* Schritt 2: Zettel für Einweisungen generieren 690 -** Tablet für Einweiser im makerspace 691 -** Authentifizierung über Token an der Freigabebox 692 -*** Neue Maschine, User schaltet die Maschine "Tablet" frei 693 -*** Datenbank erzeugt JWT und signiert es mit einem RSA Priv Key 694 -*** Wird als Payload in der MQTT unlock message mitgeschickt 695 -** Tablet nutzt dieses Token für API Requests gegen Homepage Backend 696 -** Backend wird um weitere Middleware angepasst, die dieses Token für manche Endpoints akzeptiert 697 -** Einweiser:in bekommt aktive Einweisung angezeigt und kann Teilnehmer Entfernern (no-show) oder hinzufügen (spontan) 698 -*** Option eine Einweisung ohne Rechnungsstellung vorzunehmen 699 -** PDFs werden automatisch ausgedruckt 700 -*** Tablet triggert einen Backend endpoint 701 -**** übergibt teilnehmer als parameter (auth über token) und 702 -**** erzeugt die entsprechenden PDFs in DocuSeal 703 -**** Gibt PDF als Return 704 -*** Tablet kann PDF über Netzwerk print drucken 705 -* Schritt 3: Einweisungen erfassen 706 -** QR code wird in Schritt 2 aufgedruckt und enthält: 707 -*** Einweisung 708 -*** Datum 709 -*** Einweiser 710 -*** Teilnehmer 711 -*** Flag Rechnung 712 -** Dokument wird über ScanSnap eingescannt und automatisch an paperless übergeben 713 -** Paperless Post Consume erkennt den QR Code, validiert ihn und löst über einen Webook einen Flow in N8n aus 714 -** N8n erstellt dann einen temporären Eintrag im Backend, ähnlich dem der heute bei "Einweisung erfassen" sichtbar ist 715 -** Die Mitgliederverwaltung hat dann x Tage Zeit, die Einträge zu korrigieren und zu prüfen (beispielsweise ob Voraussetzungen erfüllt sind) 716 -** Danach werden alle Schritte wie bisher ausgelöst (Berechtigung, Rechnung, Auszahlung an Einweiser, E-Mail Bestätigung, ...) 717 - 718 -\\ 1040 +* Docuseal Logging + Monitoring 1041 +* N8n Error Handling
- Confluence.Code.ConfluencePageClass[0]
-
- Id
-
... ... @@ -1,1 +1,1 @@ 1 -20286 69271 +202867288 - URL
-
... ... @@ -1,1 +1,1 @@ 1 -https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/20286 6927/Digitale Mitgliederverwaltung1 +https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/202867288/Digitale Mitgliederverwaltung