Zum Inhalt springen

Änderungen von Dokument Digitale Mitgliederverwaltung

Zuletzt geändert von Daniel Herrmann am 2026/02/22 21:17
Von Version Icon 12.1 Icon
bearbeitet von Daniel Herrmann
am 2025/08/15 17:23
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version Icon 16.1 Icon
bearbeitet von Daniel Herrmann
am 2025/08/17 12:32
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Icon Seiteneigenschaften
Inhalt
... ... @@ -65,6 +65,8 @@
65 65  
66 66  = {{id name="DigitaleMitgliederverwaltung-Anforderungen/Workshop"/}}Anforderungen / Workshop =
67 67  
68 +== {{id name="DigitaleMitgliederverwaltung-WelcheDokumentehabenwir?"/}}Welche Dokumente haben wir? ==
69 +
68 68  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:
69 69  
70 70  |=(% scope="col" %)(((
... ... @@ -286,6 +286,14 @@
286 286  \\
287 287  )))
288 288  
291 +== {{id name="DigitaleMitgliederverwaltung-WorkflowBeschreibung"/}}Workflow Beschreibung ==
292 +
293 +Basierend auf diesen Dokumententypen ergeben sich einige verschiedene Workflows, die im Folgenden genauer beschrieben werden:
294 +
295 +1. **Personalisierbar**, **ohne Schriftformerfordernis** - Das Formular wird on demand über Docuseal zur Unterschrift bereit gestellt und automatisch in Paperless hinzugefügt. Optional kann eine Aktion im Backend (bestimmte Flags, ...) und/oder andere Aktionen in über N8n (Vikunja, Listmonk, ...) ausgeführt werden.
296 +1. **Personalisierbar, mit Schriftformerfordernis** - Das Formular wird on demand erzeugt und ausgedruckt und handschriftlich unterschrieben. Dann wird es eingescannt und zu Paperless hinzugefügt. Optional kann eine Aktion im Backend (bestimmte Flags, ...) und/oder andere Aktionen in über N8n (Vikunja, Listmonk, ...) ausgeführt werden.
297 +1. **Nicht Personalisierbar, mit Schriftformerfordernis** - Wir können das Formular stand heute nicht personalisieren (kein QR Code). In diesem Fall wird es eingescannt und muss manuell bearbeitet werden.
298 +
289 289  = {{id name="DigitaleMitgliederverwaltung-TechnischeÜbersicht"/}}Technische Übersicht =
290 290  
291 291  == {{id name="DigitaleMitgliederverwaltung-VorhandeneKomponenten"/}}Vorhandene Komponenten ==
... ... @@ -331,3 +331,172 @@
331 331  Das folgende Kapitel gibt eine Übersicht über die vorgeschlagene Systemarchitektur basierend auf den oben vorgestellten Komponenten. Zusätzlich werden einige Beispiel-Worksflows vorgestellt, eine detailliertere Übersicht der oben vorgestellten Use-Cases für die Dokumente folgt weiter unten.
332 332  
333 333  {{confluence_drawio border="true" diagramName="System Architecture" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1034" height="578" revision="5"/}}
344 +
345 +TODO: Genauere Beschreibung der Komponenten
346 +
347 += {{id name="DigitaleMitgliederverwaltung-PaperlessNGX"/}}Paperless NGX =
348 +
349 +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**.
350 +
351 +== {{id name="DigitaleMitgliederverwaltung-PaperlessÜbersicht"/}}Paperless Übersicht ==
352 +
353 +**Dokumente** sind die primären Ressourcen in Paperless. Ein Dokument kann über mehrere Wege in Paperless aufgenommen werden (der Prozess wird **Ingestion** genannt):
354 +
355 +* **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.
356 +** Die Mitgliederverwaltung: [[mitglieder-dokumente@makerspace-darmstadt.de>>mailto:mitglieder-dokumente@makerspace-darmstadt.de||shape="rect"]]
357 +** Den Vorstand: [[vorstand-dokumente@makerspace-darmstadt.de>>mailto:vorstand-dokumente@makerspace-darmstadt.de||shape="rect"]]
358 +* **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
359 +* **Per Weboberfläche**: Es ist ebenfalls möglich, Dokumente manuell über die Weboberfläche hinzuzufügen.
360 +
361 +== {{id name="DigitaleMitgliederverwaltung-Meta-Daten"/}}Meta-Daten ==
362 +
363 +Dokumente werden dann Meta-Daten zugeordnet, die eine spätere Suche und Zuordnung erleichtern. Diese Meta-Daten sind:
364 +
365 +* **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:
366 +** Für **Mitglieder**: //Vorname Nachname (#Mitgliedsnummer)//, also beispielsweise "//Daniel Herrmann (#250)//"
367 +** Für **Gäste**: //Vorname Nachname (GEindeutigeNummer)//, also beispielsweise "//Max Mustermann (G1244)//"
368 +** Bei **Vereinseintritt** und **Vereinsaustritt** werden die Korrespondenten automatisch umbenannt, auch Namensänderungen werden automatisch verarbeitet.
369 +* **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":
370 +** (% 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.
371 +** (% 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.
372 +* (((
373 +**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.
374 +\\
375 +
376 +|=(% scope="col" %)(((
377 +Name
378 +)))|=(% scope="col" %)(((
379 +Exact Match String
380 +)))
381 +|(((
382 +Mitgliedsantrag
383 +)))|(((
384 +mksp-doc-mitgliedsantrag
385 +)))
386 +|(((
387 +SEPA Lastschriftmandat
388 +)))|(((
389 +mksp-doc-sepamandat
390 +)))
391 +|(((
392 +Studienbescheinigung
393 +)))|(((
394 +mksp-doc-studienbescheinigung
395 +)))
396 +|(((
397 +Formular Schlüsselausgabe
398 +)))|(((
399 +mksp-doc-schluesselausgabe
400 +)))
401 +|(((
402 +Verpflichtungserklärung Datenschutz
403 +)))|(((
404 +\\
405 +)))
406 +|(((
407 +Übungsleitervertrag
408 +)))|(((
409 +\\
410 +)))
411 +|(((
412 +Nutzungsvereinbarung Schulungsinhalte
413 +)))|(((
414 +\\
415 +)))
416 +|(((
417 +Bestellung eines Einweisers
418 +)))|(((
419 +\\
420 +)))
421 +|(((
422 +Haftungsausschluss
423 +)))|(((
424 +\\
425 +)))
426 +|(((
427 +Einweisungszettel
428 +)))|(((
429 +\\
430 +)))
431 +|(((
432 +Lagervertrag Kistenlager
433 +)))|(((
434 +\\
435 +)))
436 +|(((
437 +Lagervertrag Projektlager
438 +)))|(((
439 +\\
440 +)))
441 +)))
442 +* **Storage Path**: Speicherpfade sind ein etwas fortgeschrittenes Feature, welches kontrolliert, wie die Dateien im unterliegenden Dateisystem gespeichert werden. In der Regel arbeitet man nicht direkt mit den Dateien, aber wenn man aus lange Sicht mal aus Paperless NGX weg ziehen möchte kann es sinnvoll sein, die Dokumente in einer Struktur zu speichern, die man theoretisch auch manuell durchsuchen könnte. Details finden sich in der [[Dokumentation von Paperless zu File Name Handling>>url:https://docs.paperless-ngx.com/advanced_usage/#file-name-handling||shape="rect"]].
443 +\\{{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 (%%)[[
444 +
445 +{{code language="none"}}
446 +document renamer
447 +{{/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}}
448 +TODO: Define Storage Path
449 +
450 +== {{id name="DigitaleMitgliederverwaltung-AutomatischeZuordnungvonMetadaten"/}}Automatische Zuordnung von Metadaten ==
451 +
452 +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.
453 +
454 +Aus diesem Grund nutzen wir einen speziellen QR Code in einem für den Makerspace spezifischen Format, welches nachstehend detailliert beschrieben wird.
455 +
456 +{{code language="json"}}
457 +{
458 + "payload": {
459 +        "timestamp": "YYYY-MM-DDTHH:mm:ss",
460 + "correspondent": "Daniel Herrmann (#250)",
461 + "type": "mksp-doc-sepamandat",
462 + "tags": [
463 + "tag1",
464 + "tag2"
465 + ],
466 +"storage_path": "Mitgliederverwaltung"
467 + },
468 + "sig": "signature over the entire payload block"
469 +}
470 +{{/code}}
471 +
472 +Die beiden Einträge **payload** und **sig** sind **Pflichtfelder**. Innerhalb der Payload muss der **timestamp** **vorhanden** sein, alle anderen Felder sind optional, jedoch muss mindestens eins angegeben werden. Der QR Code kann dann - insbesondere bei der Digitalen Unterschrift oder bei Workflows, wo die Formulare ohnehin on demand erzeugt werden bereits mit allen Daten bestückt werden. In Paperless gibt es dann ein Postconsume Script, welches den QR Code ausliest, die Signatur prüft und - falls die Signatur korrekt ist - automatisch die Meta-Daten übernimmt.
473 +
474 +=== {{id name="DigitaleMitgliederverwaltung-Signatur"/}}Signatur ===
475 +
476 +Die Signatur wird kryptographisch mit Hilfe asymmetrischen Verschlüsselung erzeugt. Wir erzeugen ein RSA 2048 Key Pair. Der öffentliche Schlüssel steht Paperless zur Verfügung, sodass Paperless die Signaturen verifizieren kann. Der private Teil des Schlüssels wird von den Makerspace-Systemem verwendet, welche die Formulare erzeugen. Im Detail:
477 +
478 +* **Key-Pair**: 2048 bit Schlüssellänge, RSA, 65537 Exponent
479 +* **Signatur**: SHA256 Signatur, PKCS1v15 Padding
480 +* (((
481 +**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:
482 +\\
483 +
484 +{{code language="json"}}
485 +{"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"}
486 +{{/code}}
487 +
488 +
489 +Als Referenz, die in Python wäre der Input der Signatur:
490 +\\
491 +
492 +{{code language="python"}}
493 +import json
494 +
495 +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'}
496 +signature_data = json.dumps(input_data, separators=(',', ':')).encode('utf-8')
497 +{{/code}}
498 +)))
499 +
500 +\\
501 +
502 +== {{id name="DigitaleMitgliederverwaltung-TechnischesSetup"/}}Technisches Setup ==
503 +
504 +Owner: zwei Owner
505 +Docs: Owner = grp owner, View + Edit jeweilige Gruppen
506 +Correspondent: owner = grp owner, view = jeweilige Gruppe, edit = it admin
507 +Tag: owner = grp owner, view = jeweilige Gruppe, edit = it admin
508 +Doc Type: owner = grp owner, view = jeweilige Gruppe, edit = it admin
509 +
510 +TODO
511 +
512 +\\
Icon Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -202866863
1 +202866879
URL
... ... @@ -1,1 +1,1 @@
1 -https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/202866863/Digitale Mitgliederverwaltung
1 +https://wiki.makerspace-darmstadt.de/spaces/PROJ/pages/202866879/Digitale Mitgliederverwaltung