Der VereinWiki-Quellcode von Digitale Mitgliederverwaltung
Version 62.1 von Daniel Herrmann am 2025/10/24 18:48
Zeige letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
| 1 | Im Rahmen der Initiative Ehrenamt Digitalisiert hat uns das Land Hessen Fördermittel für die Digitalisierung unserer Mitgliederverwaltung zur Verfügung gestellt. Ziel ist es: | ||
| 2 | |||
| 3 | * möglichst viele der im Verein notwendigen Dokumente in Zukunft gar nicht mehr in Papierform zu benötigen | ||
| 4 | * die Mitgliederverwaltung zu entlasten, in dem möglichst viele Prozesse digitalisiert und automatisiert werden | ||
| 5 | * der Aufbau einer digitalen Dokumentenplatform, die sowohl neue Dokumente als auch alte Dokumente erfassen und Mitgliedern zuordnen kann | ||
| 6 | * die Digitalisierung der bestehenden Papierdokumente | ||
| 7 | |||
| 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 | |||
| 10 | = Inhaltsverzeichnis = | ||
| 11 | |||
| 12 | {{toc/}} | ||
| 13 | |||
| 14 | = Hintergrundinformationen = | ||
| 15 | |||
| 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 | |||
| 18 | In Deutschland – und in der gesamten EU nach der eIDAS-Verordnung – gibt es **drei Stufen elektronischer Signaturen**: die **einfache elektronische Signatur (EES**), die **fortgeschrittene elektronische Signatur (FES)** und die **qualifizierte elektronische Signatur (QES)**. | ||
| 19 | |||
| 20 | * Die **einfache elektronische Signatur (EES)** ist jede elektronische Form, mit der man einer Erklärung zustimmt, ohne besondere Sicherheitsmaßnahmen. Das kann zum Beispiel ein eingetippter Name in einer E-Mail, ein eingescanntes Bild einer Unterschrift in einem PDF oder das Anklicken eines „Ich stimme zu“-Buttons sein. Sie ist leicht zu erstellen, hat aber nur einen geringen Beweiswert, da weder die Identität des Unterzeichners sicher geprüft noch Manipulationen zuverlässig erkannt werden. Die EES eignet sich vor allem für alltägliche Geschäftsvorgänge mit geringem Risiko, wie interne Freigaben, einfache Auftragsbestätigungen oder unverbindliche Absprachen. | ||
| 21 | * Die **fortgeschrittene elektronische Signatur (FES)** muss eindeutig einer bestimmten Person zugeordnet sein, die Identifizierung des Unterzeichners ermöglichen und die Integrität des unterschriebenen Dokuments sicherstellen. Das geschieht meist über kryptografische Verfahren und persönliche Signaturschlüssel, die nur der Unterzeichner kontrolliert. Bekannte Beispiele sind Signaturen mit DocuSign, Adobe Sign oder FP Sign, bei denen eine Zwei-Faktor-Authentifizierung (etwa per SMS-TAN oder App) erfolgt, oder Signaturen mit einem persönlichen Zertifikat aus einer Public-Key-Infrastruktur. Die FES bietet einen hohen Beweiswert vor Gericht, ersetzt aber nicht die gesetzlich vorgeschriebene Schriftform. Sie wird häufig für B2B-Verträge, Geheimhaltungsvereinbarungen oder wichtige, aber formfrei mögliche Vereinbarungen eingesetzt. | ||
| 22 | * Die **qualifizierte elektronische Signatur (QES)** ist die sicherste Form und in der EU der handschriftlichen Unterschrift gleichgestellt. Sie darf nur mit einem qualifizierten Zertifikat erstellt werden, das von einem staatlich zugelassenen qualifizierten Vertrauensdiensteanbieter ausgestellt wird (z. B. D-Trust, Swisscom oder A-Trust). Die Erstellung erfolgt über eine sichere Signaturerstellungseinheit, wie eine Signaturkarte mit Kartenleser oder einen Fernsignaturdienst mit starker Identifizierung (z. B. VideoIdent). Die QES ist rechtlich zwingend erforderlich, wenn für ein Dokument die Schriftform nach § 126a BGB vorgeschrieben ist, etwa bei bestimmten Arbeitsverträgen, Verbraucherdarlehensverträgen oder in behördlichen und gerichtlichen Verfahren. | ||
| 23 | |||
| 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 | |||
| 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 | ))) | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 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}} | ||
| 69 | |||
| 70 | = Dokumente und Workflow = | ||
| 71 | |||
| 72 | == Dokumenten-Arten == | ||
| 73 | |||
| 74 | Am Dienstag, den 12.08.2025 fand hierzu ein Workshop statt, bei dem Vertreter des IT Teams, der Mitgliederverwaltung sowie des Vorstands teilgenommen haben. Dabei wurden die Ziele erläutert und definiert, ebenfalls haben eine Übersicht der bestehenden Dokumenten-Typen erstellt, mit denen wir im Verein heute hantieren. Für jedes Dokument wurde dann evaluiert, ob es in Zukunft komplett digitalisiert werden kann oder ob beispielsweise aus Haftungsgründen die Schriftform und damit eine handschriftliche Unterschrift weiterhin notwendig ist. Die folgende Tabelle gibt einen Überblick: | ||
| 75 | |||
| 76 | (% class="wrapped" %) | ||
| 77 | |=((( | ||
| 78 | Dokumenten-Typ | ||
| 79 | )))|=((( | ||
| 80 | Vollständig | ||
| 81 | digitalisieren | ||
| 82 | )))|=((( | ||
| 83 | Prozess heute | ||
| 84 | )))|=((( | ||
| 85 | Notwendige Änderungen | ||
| 86 | ))) | ||
| 87 | |((( | ||
| 88 | Mitgliedsantrag | ||
| 89 | )))|((( | ||
| 90 | ✅️ | ||
| 91 | )))|((( | ||
| 92 | * Interessent:in füllt den Online-Antrag auf der Homepage aus | ||
| 93 | * Nach Bestätigung der E-Mail Adresse wird der Antrag vorausgefüllt per Mail verschickt | ||
| 94 | * Antrag wird in der Vereinsverwaltung EasyVerein erfasst | ||
| 95 | * Interessent:in druckt den Antrag aus, unterschreibt ihn und bringt ihn im Makerspace vorbei | ||
| 96 | * Nach Eingang: Mitgliederverwaltung prüft den Antrag und genehmigt ihn | ||
| 97 | * Mitgliederakte wird angelegt, der Antrag wird in der Akte abgeheftet | ||
| 98 | )))|((( | ||
| 99 | Der Antrag soll komplett **digital unterschrieben** werden. Vorgehen: | ||
| 100 | |||
| 101 | * Interessent:in füllt den Online-Antrag auf der Homepage aus | ||
| 102 | * Nach Bestätigung der E-Mail Adresse wird ein Vorgang zur digitalen Unterschrift ausgelöst | ||
| 103 | ** Wenn nach 4 Wochen die Unterschrift nicht erfolgt ist, wird der Antrag abgelehnt und gespeicherte Daten vernichtet | ||
| 104 | ** Nach 2 Wochen und 1 Woche vor Ablauf wird eine Erinnerung verschickt | ||
| 105 | * Nach Eingang: Mitgliederverwaltung prüft den Antrag und genehmigt ihn | ||
| 106 | * Digitale Akte wird angelegt, Antrag wird automatisch hinzugefügt. | ||
| 107 | ))) | ||
| 108 | |((( | ||
| 109 | SEPA Lastschriftmandat | ||
| 110 | )))|((( | ||
| 111 | ✅️ | ||
| 112 | )))|((( | ||
| 113 | Wird zeitgleich mit dem Mitgliedsantrag verschickt und folgt exakt dem gleichen Prozess | ||
| 114 | )))|((( | ||
| 115 | **Gleicher Prozess **wie Mitgliedsantrag | ||
| 116 | ))) | ||
| 117 | |((( | ||
| 118 | Studienbescheinigung | ||
| 119 | )))|((( | ||
| 120 | ✅️ | ||
| 121 | )))|((( | ||
| 122 | Bescheinigung wird von Mitglied eingescannt und per Mail an die Mitgliederverwaltung geschickt | ||
| 123 | |||
| 124 | Diese prüft die Bescheinigung und verlängert die reduzierte Mitgliedschaft gemäß den Angaben auf dem Nachweis. | ||
| 125 | )))|((( | ||
| 126 | **Neue Lösung** basierend auf der Homepage, N8n, Paperless und Vikunja, weitere Details unten | ||
| 127 | ))) | ||
| 128 | |((( | ||
| 129 | Ausweiskopie | ||
| 130 | )))|((( | ||
| 131 | ❌️ | ||
| 132 | )))|((( | ||
| 133 | Bei der Ausgabe eines Schlüssels wird stand heute eine Ausweiskopie angefertigt und in der Akte abgelegt. | ||
| 134 | |||
| 135 | Vermutlich dürfen wir das ohnehin nicht. | ||
| 136 | )))|((( | ||
| 137 | **Entfällt**. Siehe **Formular Schlüsselausgabe** für Details | ||
| 138 | ))) | ||
| 139 | |((( | ||
| 140 | Formular Schlüsselausgabe | ||
| 141 | )))|((( | ||
| 142 | ⚠️ | ||
| 143 | )))|((( | ||
| 144 | Bei Ausgabe eines Schlüssels über die Schlüsselausgabebox wird das Formular vorausgefüllt und automatisch ausgedruckt | ||
| 145 | |||
| 146 | Unterschrieben wird es dann an zwei Stellen vom Mitglied, einmal für die Abbuchung, einmal für die Regeln. | ||
| 147 | |||
| 148 | Danach wird das Dokument zusammen mit der Ausweiskopie in der Akte abgelegt. | ||
| 149 | )))|((( | ||
| 150 | ⚠️ Der Prozess findet immer persönlich und vor Ort im Makerspace statt. | ||
| 151 | Es kann nicht vorausgesetzt werden, dass das Mitglied in allen Fällen ein Handy dabei hat um eine digitale Unterschrift in Docuseal zu leisten. | ||
| 152 | |||
| 153 | Das Formular für die Schlüsselausgabe wird um zwei Felder erweitert: | ||
| 154 | |||
| 155 | * Ausweisnummer (oder Nummer des Aufenthaltstitels, Reisepass, ...) | ||
| 156 | * Unterschriftsfeld für Vereinsfunktionär:in, dass der Ausweis eingesehen wurde und gültig ist | ||
| 157 | |||
| 158 | Bleibt ansonsten in Phase 1 erst einmal handschriftlich, kann dann in Phase 2 eventuell über das Tablet digital unterschrieben werden. | ||
| 159 | ))) | ||
| 160 | |((( | ||
| 161 | Verpflichtungserklärung Datenschutz | ||
| 162 | )))|((( | ||
| 163 | ✅️ | ||
| 164 | )))|((( | ||
| 165 | Notwendig für Funktionäre, Einweisende, und so weiter. | ||
| 166 | |||
| 167 | Ist ein Blanko-Formular, welches ausgefüllt, eingeworfen und abgeheftet wird. | ||
| 168 | Danach wird ein Flag für das jeweilige Mitglied gesetzt, dass die Erklärung abgegeben wurde. | ||
| 169 | )))|((( | ||
| 170 | **Vollständig digital**. Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage), danach digital weiter. | ||
| 171 | ))) | ||
| 172 | |((( | ||
| 173 | Übungsleitervertrag | ||
| 174 | )))|((( | ||
| 175 | ✅️ | ||
| 176 | )))|((( | ||
| 177 | Notwendig für alle, die Einweisungen oder Workshops halten möchten. | ||
| 178 | |||
| 179 | Ist ein Blanko-Formular, welches ausgefüllt, eingeworfen und abgeheftet wird. Danach werden zwei Flags gesetzt: | ||
| 180 | |||
| 181 | * Bestätigung dass der Vertrag vorliegt | ||
| 182 | * Ein Flag ob das Mitglied die Übungsleiterpauschale an den Verein spendet oder nicht | ||
| 183 | )))|((( | ||
| 184 | **Vollständig digital**. Vorstand oder Mitgliederverwaltung löst den Prozess über das Profil des Mitglieds aus (Button auf Homepage), danach digital weiter. | ||
| 185 | |||
| 186 | Ein Todo für die Mitgliederverwaltung wird erstellt um zu prüfen, ob das Mitglied die Pauschale spenden möchte oder nicht. | ||
| 187 | ))) | ||
| 188 | |((( | ||
| 189 | Nutzungsvereinbarung Schulungsinhalte | ||
| 190 | )))|((( | ||
| 191 | ❌️ | ||
| 192 | )))|((( | ||
| 193 | Handschriftliches Formular, kommt eher selten vor (< 10x pro Jahr) | ||
| 194 | |||
| 195 | Urheberrecht, Übertragung von Nutzungsrechten sollte in Schriftform erfolgen | ||
| 196 | )))|((( | ||
| 197 | Unverändert, bleibt handschriftlich. Manuell über Dokumentenscanner einscannen und in Paperless dem Mitglied zuweisen. | ||
| 198 | ))) | ||
| 199 | |((( | ||
| 200 | Bestellung eines Einweisers | ||
| 201 | )))|((( | ||
| 202 | ✅️ | ||
| 203 | )))|((( | ||
| 204 | **Formular existiert nicht**. Stand heute wird ein Einweisungszettel mit manuellen Notizen zweckentfremdet. | ||
| 205 | )))|((( | ||
| 206 | Im Prinzip sind vier Parteien involviert: | ||
| 207 | |||
| 208 | 1. Einweiser:in - die Person hat eine besondere Unterweisung für die/den neue(n) Einweiser:in durchgeführt - muss angegeben sein, muss aber nicht unterschreiben | ||
| 209 | 1. Bereichsleitung - schlägt vor und muss die Person zum Einweiser berufen | ||
| 210 | 1. Vorstand - bestätigt die Berufung | ||
| 211 | 1. Neue(r) Einweiser:in - unterschreibt, dass die Regelungen verstanden wurden. | ||
| 212 | |||
| 213 | Wenn das Formular von allen Parteien unterschrieben wurde: | ||
| 214 | |||
| 215 | * Automatisch In Paperless NGX der Akte hinzufügen | ||
| 216 | * Flag auf der Homepage setzen | ||
| 217 | * Es sind manuelle Aufgaben seitens der MV notwendig (Slack Channel hinzufügen) → Vikunja Task | ||
| 218 | * Bei Bedarf kann der Prozess für den Übungsleitervertrag automatisch gestartet werden | ||
| 219 | ))) | ||
| 220 | |((( | ||
| 221 | Haftungsausschluss | ||
| 222 | )))|((( | ||
| 223 | ❌️ | ||
| 224 | )))|((( | ||
| 225 | Wird sehr früh (schon beim ersten Besuch der offenen Werkstatt) unterschrieben und abgeheftet. | ||
| 226 | |||
| 227 | Zu dem Zeitpunkt existiert weder eine Akte für das Mitglied noch eine Notwendigkeit für eine eigene Gäste-Akte | ||
| 228 | |||
| 229 | Bisher: | ||
| 230 | |||
| 231 | * Bei Beginn der Mitgliedschaft wird der Haftungsausschluss aus dem großen Stapel heraussortiert | ||
| 232 | )))|((( | ||
| 233 | Zwei Vorschläge: | ||
| 234 | |||
| 235 | * Wie bisher Haftungsausschluss raussuchen, Einscannen und manuell in Paperless NGX zuweisen | ||
| 236 | * Alternativ zusammen mit dem Mitgliederantrag noch einmal versenden | ||
| 237 | |||
| 238 | Wird aber handschriftlich benötigt, muss also so oder so eingescannt werden | ||
| 239 | ))) | ||
| 240 | |((( | ||
| 241 | Einweisungszettel | ||
| 242 | )))|((( | ||
| 243 | ❌️ | ||
| 244 | )))|((( | ||
| 245 | Müssen aus Haftungsgründen handschriftlich unterschrieben werden. | ||
| 246 | Mit Abstand die meisten Zettel | ||
| 247 | |||
| 248 | * Blanko-Zettel liegen im Aktenschrank am Eingang. | ||
| 249 | * Nach einer Einweisung lässt der Einweisende die Teilnehmenden den Zettel ausfüllen und unterschreiben | ||
| 250 | * Danach werden sie in den Briefkasten geworfen | ||
| 251 | * Die Mitgliederverwaltung erfasst die Zettel. Dabei werden ebenfalls einige Dinge geprüft | ||
| 252 | ** Hat die Person notwendige Vorbedingungen erfüllt (beispielsweise einen LMS Kurs)? | ||
| 253 | ** Ist die einweisende Person überhaupt Berechtigt, diese Einweisung durchzuführen? | ||
| 254 | ** Muss für die Teilnehmenden eine Abbuchung veranlasst werden? | ||
| 255 | ** Muss für den Einweisenden eine Auszahlung veranlasst werden? | ||
| 256 | * Danach wird der Zettel in die jeweiligen Akten einsortiert. | ||
| 257 | )))|((( | ||
| 258 | Der Einweisungszettel ist das bei weitem komplizierteste Dokument, hierfür wird ein separater Workshop stattfinden. Siehe weiter unten für Details. | ||
| 259 | ))) | ||
| 260 | |((( | ||
| 261 | Lagervertrag Kistenlager | ||
| 262 | )))|((( | ||
| 263 | ✅️ | ||
| 264 | )))|((( | ||
| 265 | Kann digital über DocuSeal oder in Papierform unterschrieben werden. | ||
| 266 | |||
| 267 | Wenn DocuSeal → geht in Kopie an die Mitgliederverwaltung | ||
| 268 | Wenn Papierform → wird eingeworfen | ||
| 269 | |||
| 270 | Nach Erfassen kann die Person eine Kiste beantragen, die dann monatliche Kosten auslöst | ||
| 271 | )))|((( | ||
| 272 | **Vollständig digital**, die Papierform entfällt. Self-Service durch Nutzer:in. | ||
| 273 | ))) | ||
| 274 | |((( | ||
| 275 | Lagervertrag Projektlager | ||
| 276 | )))|((( | ||
| 277 | ✅️ | ||
| 278 | )))|((( | ||
| 279 | Kann digital über DocuSeal oder in Papierform unterschrieben werden. | ||
| 280 | |||
| 281 | Wenn DocuSeal → geht in Kopie an die Mitgliederverwaltung | ||
| 282 | Wenn Papierform → wird eingeworfen | ||
| 283 | |||
| 284 | Nach Erfassen kann die Person das Projektlager automatisch nutzen. | ||
| 285 | )))|((( | ||
| 286 | **Vollständig digital**, die Papierform entfällt. Self-Service durch Nutzer:in. | ||
| 287 | ))) | ||
| 288 | |||
| 289 | == Workflow Beschreibung == | ||
| 290 | |||
| 291 | Grundsätzlich teilt sich der Umgang mit Dokumenten in folgende Phasen auf: | ||
| 292 | |||
| 293 | {{confluence_drawio border="true" diagramName="Prozess Allgemein" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="991" height="221" revision="2"/}} | ||
| 294 | |||
| 295 | === Trigger / Starten des Workflows === | ||
| 296 | |||
| 297 | 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. | ||
| 298 | |||
| 299 | 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. | ||
| 300 | |||
| 301 | ==== Start über die Homepage ==== | ||
| 302 | |||
| 303 | Ein Prozess kann über die Homepage eingeleitet werden, entweder durch | ||
| 304 | |||
| 305 | * **remote, implizit** durch einen bestehenden Vorgang (Mitgliedsantrag) | ||
| 306 | * **remote, explizit durch den Use**r für sich selbst (Self-Service, beispielsweise der Lager-Vertrag) | ||
| 307 | * **remote, explizit durch einen Funktionär** für einen andere User (Datenschutzvereinbarung, Übungsleitervertrag, ...) | ||
| 308 | |||
| 309 | ==== Lokal im Makerspace ==== | ||
| 310 | |||
| 311 | 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. | ||
| 312 | |||
| 313 | * **lokal, explizit durch einen Funktionär** (Einweisungsleiter:in, Mitgliederverwaltung, Vorstand), beispielsweise Einweisungszettel oder Schlüsselausgabeformular | ||
| 314 | |||
| 315 | === Dokument erstellen === | ||
| 316 | |||
| 317 | Im zweiten Schritt wird nun ein oder mehrere personalisierte Dokumente erstellt. Hier gibt es eine Entscheidungsmatrix: | ||
| 318 | |||
| 319 | (% class="wrapped" %) | ||
| 320 | |=((( | ||
| 321 | Remote / Lokal | ||
| 322 | )))|=((( | ||
| 323 | Schriftformerfordernis | ||
| 324 | )))|=((( | ||
| 325 | Beispiel | ||
| 326 | )))|=((( | ||
| 327 | Beschreibung | ||
| 328 | ))) | ||
| 329 | |((( | ||
| 330 | Remote | ||
| 331 | )))|((( | ||
| 332 | Nein | ||
| 333 | )))|((( | ||
| 334 | Lagervertrag, Übungsleitervertrag | ||
| 335 | )))|((( | ||
| 336 | Dokument wird direkt in Docuseal über ein Template erzeugt. | ||
| 337 | Alle Parteien erhalten (in Reihenfolge), eine Mail, dass eine Unterschrift ansteht. | ||
| 338 | ))) | ||
| 339 | |((( | ||
| 340 | Remote | ||
| 341 | )))|((( | ||
| 342 | Ja | ||
| 343 | )))|((( | ||
| 344 | Einweisungszettel Online-Einweisung | ||
| 345 | )))|((( | ||
| 346 | Dokument wird über eine Docuseal One-Off Submission erzeugt und als PDF zum Download angeboten. | ||
| 347 | ))) | ||
| 348 | |((( | ||
| 349 | Lokal | ||
| 350 | )))|((( | ||
| 351 | Nein | ||
| 352 | )))|((( | ||
| 353 | Schlüsselausgabe | ||
| 354 | )))|((( | ||
| 355 | Dokument wird über eine Docuseal One-Off Submission oder ein Template erzeugt und auf das Tablet im Makerspace heruntergeladen. | ||
| 356 | ))) | ||
| 357 | |((( | ||
| 358 | Lokal | ||
| 359 | )))|((( | ||
| 360 | Ja | ||
| 361 | )))|((( | ||
| 362 | Einweisungszettel Vor-Ort Einweisung | ||
| 363 | )))|((( | ||
| 364 | Dokument wird über eine Docuseal One-Off Submission erzeugt und als PDF auf das Tablet heruntergeladen. | ||
| 365 | ))) | ||
| 366 | |||
| 367 | {{error title="Docuseal Lizenz"}} | ||
| 368 | Das genannte Feature "One-Off" Submission ist ein DocuSeal Pro Feature, welches uns nicht zur Verfügung steht. Eventuell müssen wir | ||
| 369 | {{/error}} | ||
| 370 | |||
| 371 | === Unterschrift leisten === | ||
| 372 | |||
| 373 | 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. | ||
| 374 | |||
| 375 | (% class="wrapped" %) | ||
| 376 | |=((( | ||
| 377 | Remote / Lokal | ||
| 378 | )))|=((( | ||
| 379 | Schriftformerfordernis | ||
| 380 | )))|=((( | ||
| 381 | Beispiel | ||
| 382 | )))|=((( | ||
| 383 | Beschreibung | ||
| 384 | ))) | ||
| 385 | |((( | ||
| 386 | Remote | ||
| 387 | )))|((( | ||
| 388 | Nein | ||
| 389 | )))|((( | ||
| 390 | Lagervertrag, Übungsleitervertrag | ||
| 391 | )))|((( | ||
| 392 | Unterschrift über DocuSeal. Parteien werden nacheinander per Mail zur Unterschrift aufgefordert | ||
| 393 | ))) | ||
| 394 | |((( | ||
| 395 | Remote | ||
| 396 | )))|((( | ||
| 397 | Ja | ||
| 398 | )))|((( | ||
| 399 | Einweisungszettel Online-Einweisung | ||
| 400 | )))|((( | ||
| 401 | Das Mitglied muss das Dokument ausdrucken, **handschriftlich** unterschreiben und in den Makerspace mitbringen. | ||
| 402 | ))) | ||
| 403 | |((( | ||
| 404 | Lokal | ||
| 405 | )))|((( | ||
| 406 | Nein | ||
| 407 | )))|((( | ||
| 408 | Schlüsselausgabe | ||
| 409 | )))|((( | ||
| 410 | Unterschrift entweder: | ||
| 411 | |||
| 412 | * Direkt auf dem Tablet in Docuseal ([[Docuseal In-Person Signing>>url:https://www.docuseal.com/resources/sign-documents-in-person||shape="rect"]]) | ||
| 413 | * PDF erzeugen, in der App unterschreiben, PDF danach in Paperless hochladen | ||
| 414 | ))) | ||
| 415 | |((( | ||
| 416 | Lokal | ||
| 417 | )))|((( | ||
| 418 | Ja | ||
| 419 | )))|((( | ||
| 420 | Einweisungszettel Vor-Ort Einweisung | ||
| 421 | )))|((( | ||
| 422 | Auf dem Makerspace Tablet wird das Dokument vor Ort ausgedruckt (AirPrint oder CUPS) und **handschriftlich** unterschrieben. | ||
| 423 | |||
| 424 | ))) | ||
| 425 | |||
| 426 | === Ablegen und Verarbeiten === | ||
| 427 | |||
| 428 | Egal welcher Prozess angewandt wird, das Dokument muss am Ende in Paperless eingelesen und mit den Metadaten (siehe unten) versehen werden. Hier gibt es drei verschiedene Varianten: | ||
| 429 | |||
| 430 | (% class="wrapped" %) | ||
| 431 | |=((( | ||
| 432 | Signatur über | ||
| 433 | )))|=((( | ||
| 434 | Paperless Ingest | ||
| 435 | )))|=((( | ||
| 436 | Ablauf | ||
| 437 | ))) | ||
| 438 | |((( | ||
| 439 | Docuseal | ||
| 440 | )))|((( | ||
| 441 | N8n | ||
| 442 | )))|((( | ||
| 443 | Docuseal sendet ein Webhook ans Backend | ||
| 444 | |||
| 445 | * Backend setzt den Prozess auf abgeschlossen | ||
| 446 | * Backend publisht ein Event auf N8n | ||
| 447 | * N8n lädt das Dokument von Docuseal herunter und lädt es zu Paperless hoch | ||
| 448 | ))) | ||
| 449 | |((( | ||
| 450 | Tablet | ||
| 451 | )))|((( | ||
| 452 | N8n oder API | ||
| 453 | )))|((( | ||
| 454 | Je nach gewählter Implementierung auf dem Tablet. | ||
| 455 | |||
| 456 | * Wenn Docuseal In Person Signing: Webhook + N8n wie oben | ||
| 457 | * Wenn Unterschrift in Tablet App: Tablet lädt das über die API hoch | ||
| 458 | ))) | ||
| 459 | |((( | ||
| 460 | Handschriftliche Unterschrift | ||
| 461 | )))|((( | ||
| 462 | ScanSnap Scanner | ||
| 463 | )))|((( | ||
| 464 | Das Dokument wird von der Mitgliederverwaltung eingescannt und dann von Paperless verarbeitet | ||
| 465 | ))) | ||
| 466 | |||
| 467 | In allen Fällen sollte das Dokument einen QR Code enthalten, der die automatische Zuordnung von Metadaten ermöglicht. Weiterhin wird vom Post-Consumption Script ein NATS Event für jedes erfolgreich erkannte Dokument erstellt, welches dann vom N8n verarbeitet werden kann. Darüber lassen sich beispielsweise Einweisungszettel im Backend erfassen. | ||
| 468 | |||
| 469 | = Technisches Design = | ||
| 470 | |||
| 471 | == Vorhandene Komponenten == | ||
| 472 | |||
| 473 | 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: | ||
| 474 | |||
| 475 | * [[EasyVerein>>url:https://easyverein.com||shape="rect"]] - Die Digitale Vereinsverwaltung in der Cloud. Hier verwalten wir alle Mitglieder (pro Benutzer muss eine Lizenz entrichtet werden). Wir nutzen EasyVerein hauptsächlich für die Abrechnung, da EasyVerein die automatische Abrechnung der Mitgliedschaftsgebühren anbietet. Die gesamte Buchhaltung und Zuordnung zu Mitgliedern erfolgt ebenfalls hier. Weiterhin befinden sich hier die Stammdaten aller Mitglieder. | ||
| 476 | * Homepage / Backend: Dies ist unsere Homepage, die unter [[https:~~/~~/makerspace-darmstadt.de>>url:https://makerspace-darmstadt.de||shape="rect"]] erreichbar ist. Sie bietet einige Funktionen: | ||
| 477 | ** Verwaltung der Einweisungen, inklusive Einweisungs-Typen, Angeboten, Erfassen von abgeschlossenen Einweisungen | ||
| 478 | ** Integration in EasyVerein - EasyVerein ist das führende System für Mitglieder, die Homepage synchronisiert einmal Nachts die Mitglieder aus EasyVerein | ||
| 479 | ** Rechnungen einsehen und einreichen - über die API von EasyVerein können Mitglieder hier einfach ihre Beitragsrechnungen einsehen und herunterladen. Ebenso können für den Verein getätigte Auslagen hier eingereicht werden. | ||
| 480 | * [[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. | ||
| 481 | * [[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. | ||
| 482 | |||
| 483 | == Neue Komponenten == | ||
| 484 | |||
| 485 | === Paperless NGX === | ||
| 486 | |||
| 487 | 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. | ||
| 488 | |||
| 489 | 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. | ||
| 490 | |||
| 491 | 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. | ||
| 492 | |||
| 493 | === N8n === | ||
| 494 | |||
| 495 | 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). | ||
| 496 | |||
| 497 | Workflows können automatisch getriggert werden – etwa per Webhook, Zeitplan oder NATS Ereignis – und lassen sich mit Bedingungen, Schleifen und Verzweigungen komplex gestalten. n8n speichert Ausführungsverläufe, meldet Fehler und erlaubt es, einzelne Schritte neu zu starten oder zu ändern. | ||
| 498 | |||
| 499 | 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. | ||
| 500 | |||
| 501 | === NATS === | ||
| 502 | |||
| 503 | 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. | ||
| 504 | |||
| 505 | 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. | ||
| 506 | |||
| 507 | 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. | ||
| 508 | |||
| 509 | == Systemübersicht == | ||
| 510 | |||
| 511 | 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. | ||
| 512 | |||
| 513 | {{confluence_drawio border="true" diagramName="System Architecture" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1034" height="578" revision="5"/}} | ||
| 514 | |||
| 515 | Im Wesentlichen teilt sich die Architektur in zwei Zonen, die **öffentliche** und die **interne** Zone: | ||
| 516 | |||
| 517 | * **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. | ||
| 518 | * 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. | ||
| 519 | |||
| 520 | 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. | ||
| 521 | |||
| 522 | **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. | ||
| 523 | |||
| 524 | == Dokument-Workflows == | ||
| 525 | |||
| 526 | Die beiden entscheidenden Faktoren für den Workflow: | ||
| 527 | |||
| 528 | 1. **Erfordernis der Schriftform** | ||
| 529 | 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 | ||
| 530 | 11. **Nein** - eine Fortgeschrittene elektronische Signatur (FeS) ist ausreichend. | ||
| 531 | 1. Ort der Unterschrift | ||
| 532 | 11. **Remote** - Der Prozess wird typischerweise über die Homepage angestoßen und | ||
| 533 | 11. **Lokal (Makerspace)** - Der Prozess wird als Reaktion auf ein In-Person Event im Makerspace ausgelöst, beispielsweise einer Einweisung oder einer Schlüsselausgabe | ||
| 534 | |||
| 535 | Daraus ergeben sich vier verschiedene Kombinationen (Workflows), die nachstehend genauer beschrieben sind. | ||
| 536 | |||
| 537 | (% class="wrapped" %) | ||
| 538 | |=(% scope="row" %)((( | ||
| 539 | Workflow | ||
| 540 | )))|=((( | ||
| 541 | Schriftform erforderlich | ||
| 542 | )))|=((( | ||
| 543 | Lokal / Remote | ||
| 544 | ))) | ||
| 545 | |=((( | ||
| 546 | Fall 1: Digital Remote | ||
| 547 | )))|((( | ||
| 548 | Nein | ||
| 549 | )))|((( | ||
| 550 | Remote | ||
| 551 | ))) | ||
| 552 | |=((( | ||
| 553 | Fall 2: Digital Makerspace | ||
| 554 | )))|((( | ||
| 555 | Nein | ||
| 556 | )))|((( | ||
| 557 | Lokal | ||
| 558 | ))) | ||
| 559 | |=((( | ||
| 560 | Fall 3: Handschriftlich Remote | ||
| 561 | )))|((( | ||
| 562 | Ja | ||
| 563 | )))|((( | ||
| 564 | Remote | ||
| 565 | ))) | ||
| 566 | |=((( | ||
| 567 | Fall 4: Handschriftlich Makerspace | ||
| 568 | )))|((( | ||
| 569 | Ja | ||
| 570 | )))|((( | ||
| 571 | Lokal | ||
| 572 | ))) | ||
| 573 | |||
| 574 | === Fall 1: Digital + Remote === | ||
| 575 | |||
| 576 | 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. | ||
| 577 | |||
| 578 | **Beispiele**: Lagerverträge, Mitgliedsantrag, SEPA Lastschriftmandat, Übungsleitervertrag, ... | ||
| 579 | |||
| 580 | Die folgende Grafik zeigt den Prozessablauf: | ||
| 581 | |||
| 582 | {{confluence_drawio border="true" diagramName="Fall 1 Ablaufdiagramm" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1138" height="515" revision="4"/}} | ||
| 583 | |||
| 584 | Die einzelnen Schritte hierbei sind: | ||
| 585 | |||
| 586 | 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 | ||
| 587 | 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 | ||
| 588 | 11. Speichert das Backend die Anfrage als Signature Request in der Datenbank | ||
| 589 | 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). | ||
| 590 | 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. | ||
| 591 | 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 | ||
| 592 | 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) | ||
| 593 | 1. Das Backend erstellt ein NATS Event mksp.backend.signature.completed, welches dann in N8n einen Workflow auslöst | ||
| 594 | 1. N8n lädt das von allen Parteien unterschriebene Dokument von Docuseal herunter | ||
| 595 | 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 | ||
| 596 | 1. Wird ein MKSP QR Code gefunden passieren zwei Dinge: | ||
| 597 | 11. Die Paperless Meta Daten werden automatisch zugewiesen. | ||
| 598 | 11. Bei Bedarf (Konfiguration im QR Code) wird ein N8n Webhook ausgelöst | ||
| 599 | 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) | ||
| 600 | |||
| 601 | === Fall 2: Digital + Makerspace === | ||
| 602 | |||
| 603 | 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. | ||
| 604 | |||
| 605 | 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. | ||
| 606 | |||
| 607 | **Beispiele**: Ausgabeformular Schlüsselkarte / RFID Token | ||
| 608 | |||
| 609 | Die folgende Grafik zeigt den Prozessablauf: | ||
| 610 | |||
| 611 | {{confluence_drawio border="true" diagramName="Fall 2 Ablaufdiagramm" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1138" height="499" revision="2"/}} | ||
| 612 | |||
| 613 | Die einzelnen Schritte hierbei sind: | ||
| 614 | |||
| 615 | 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. | ||
| 616 | 1. Tablet sendet im Namen des angemeldeten Benutzers eine Anfrage ans Backend. Die Anfrage wird vom Backend verarbeitet. Danach... | ||
| 617 | 11. Speichert das Backend die Anfrage als Signature Request in der Datenbank | ||
| 618 | 11. Erstellt eine "Submission" in DocuSeal. Diese basiert auf einem Template und enthält so viele Daten wie möglich schon vorausgefüllt. Mindestens aber enthält die Submission den signierten QR Code (siehe unten). | ||
| 619 | 11. ((( | ||
| 620 | Die URL für das Dokument werden als Antwort des API Requests an das Tablet zurück geschickt. Dies enthält die Embed-URL, die direkt auf dem Tablet angezeigt werden kann. Beispiel: | ||
| 621 | |||
| 622 | {{expand}} | ||
| 623 | {{code language="json"}} | ||
| 624 | [ | ||
| 625 | { | ||
| 626 | "id": 430, | ||
| 627 | "uuid": "3845d527-ea14-402a-bd05-e85cd4b28a68", | ||
| 628 | "name": "Vorname Nachname", | ||
| 629 | ... | ||
| 630 | "role": "Mitglied", | ||
| 631 | "embed_src": "https://sign.makerspace-darmstadt.de/s/mMUEBY6Knz1vap" | ||
| 632 | }, | ||
| 633 | { | ||
| 634 | "id": 431, | ||
| 635 | "uuid": "04cbbf45-e3eb-4956-b104-01c0315adc94", | ||
| 636 | "name": null, | ||
| 637 | ... | ||
| 638 | "role": "Verein", | ||
| 639 | "embed_src": "https://sign.makerspace-darmstadt.de/s/k5gvGuBjW5fkb1" | ||
| 640 | } | ||
| 641 | ] | ||
| 642 | {{/code}} | ||
| 643 | {{/expand}} | ||
| 644 | ))) | ||
| 645 | 1. Die beteiligten Personen unterschreiben direkt auf dem Tablet. | ||
| 646 | 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. | ||
| 647 | 1. Das Backend erstellt ein NATS Event mksp.backend.signature.completed, welches dann in N8n einen Workflow auslöst | ||
| 648 | 1. N8n lädt das von allen Parteien unterschriebene Dokument von Docuseal herunter | ||
| 649 | 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 | ||
| 650 | 1. Wird ein MKSP QR Code gefunden passieren zwei Dinge: | ||
| 651 | 11. Die Paperless Meta Daten werden automatisch zugewiesen. | ||
| 652 | 11. Bei Bedarf (Konfiguration im QR Code) wird ein N8n Webhook ausgelöst | ||
| 653 | 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) | ||
| 654 | |||
| 655 | === Fall 3: Handschriftlich + Remote === | ||
| 656 | |||
| 657 | 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. | ||
| 658 | |||
| 659 | **Beispiele**: Einweisungszettel für reine Online-Einweisungen | ||
| 660 | |||
| 661 | {{confluence_drawio border="true" diagramName="Fall 3 Ablaufdiagramm_" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1159" height="467" revision="2"/}} | ||
| 662 | |||
| 663 | Die einzelnen Schritte hierbei sind: | ||
| 664 | |||
| 665 | 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. | ||
| 666 | 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 | ||
| 667 | 11. Speichert das Backend die Anfrage als Signature Request in der Datenbank | ||
| 668 | 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). | ||
| 669 | 11. Das vorausgefüllte Dokument wird im PDF Format heruntergeladen und die Submission wird direkt wieder archived. | ||
| 670 | 1. Das vorausgefüllte PDF wird als Antwort auf die Anfrage an die Website zum Download angeboten. Der Benutzer druckt das PDF aus. | ||
| 671 | 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 | ||
| 672 | 1. Das ausgedruckte Dokument wird vom Benutzer unterschrieben, wenn weitere Parteien notwendig sind, auch diesen zur Unterschrift vorgelegt. | ||
| 673 | 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. | ||
| 674 | 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 | ||
| 675 | 1. Wird ein MKSP QR Code gefunden passieren zwei Dinge: | ||
| 676 | 11. Die Paperless Meta Daten werden automatisch zugewiesen. | ||
| 677 | 11. Es wird ein N8n Webhook ausgelöst | ||
| 678 | 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. | ||
| 679 | 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) | ||
| 680 | |||
| 681 | === Fall 4: Handschriftlich + Makerspace === | ||
| 682 | |||
| 683 | 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. | ||
| 684 | |||
| 685 | **Beispiele**: Einweisungszettel für Vor-Ort Online-Einweisungen | ||
| 686 | |||
| 687 | {{confluence_drawio border="true" diagramName="Fall 4 Ablaufdiagramm" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1208" height="523" revision="3"/}} | ||
| 688 | |||
| 689 | Die einzelnen Schritte hierbei sind: | ||
| 690 | |||
| 691 | 1. Ein autorisierter User meldet sich am Tablet an einer App an, entweder per Makerspace Login (Keycloak) oder per Keyfob. Dort hat der Benutzer dann mehrere Optionen, beispielsweise die Erfassung von Einweisungs-Teilnehmer:innen. | ||
| 692 | 1. Tablet sendet im Namen des angemeldeten Benutzers eine Anfrage ans Backend. Die Anfrage wird vom Backend verarbeitet. Danach... | ||
| 693 | 11. Speichert das Backend die Anfrage als Signature Request in der Datenbank | ||
| 694 | 11. Erstellt mit Hilfe einer Docuseal Submission ein PDF Dokument. Dieses basiert auf einem Template und enthält so viele Daten wie möglich schon vorausgefüllt. Mindestens aber den signierten QR Code (siehe unten). | ||
| 695 | 1. Das Tablet druckt das oder die heruntergeladenen PDF Datei(en) aus. | ||
| 696 | 1. Die Parteien unterschreiben das Dokument handschriftlich und werfen es in den Briefkasten. | ||
| 697 | 1. Ein Mitglied der Mitgliederverwaltung prüft das Dokument auf Korrektheit (dokumentenechte Unterschrift, vollständig ausgefüllt) und scannt es mit Hilfe des ScanSnap Scanners ein. | ||
| 698 | 1. Das Dokument landet automatisch auf einem Netzwerklaufwerk auf dem Makerspace NAS. Dort wird es von Paperless erkannt und automatisch verarbeitet. Das Post Consumption Script (siehe unten) scannt das Dokument auf einen MKSP QR Code | ||
| 699 | 1. Wird ein MKSP QR Code gefunden passieren zwei Dinge: | ||
| 700 | 11. Die Paperless Meta Daten werden automatisch zugewiesen. | ||
| 701 | 11. Es wird ein N8n Webhook ausgelöst | ||
| 702 | 1. Als Teil des N8n Workflows informiert N8n das Backend darüber, dass das Dokument eingescannt und verarbeitet wurde. Der Vorgang wird entsprechend in der Datenbank als erledigt markiert. | ||
| 703 | 1. (Optional): Wurde im vorherigen Schritt über den Webhook ein N8n Workflow ausgelöst, kann dieser nun weitere Schritte unternehmen (beispielsweise Vikunja Tasks erzeugen, Mails verschicken, oder ähnlich) | ||
| 704 | |||
| 705 | = Paperless NGX = | ||
| 706 | |||
| 707 | Das Herzstück der digitalen Mitgliederakte bildet Paperless NGX. Es wird im Makerspace lokal betrieben und ist daher nur aus dem Netzwerk des Makerspaces oder [[per VPN>>doc:xwiki:IN.IT Infrastruktur.IT im Makerspace.[HOWTO] Makerspace VPN.WebHome]] erreichbar. Der Zugang zu Paperless ist über OpenID Connect an [[doc:xwiki:IN.IT Infrastruktur.Services.Keycloak.WebHome]] gekoppelt, Zugang besteht nur für Mitglieder der Gruppen **Vorstand** und **Mitgliederverwaltung**. | ||
| 708 | |||
| 709 | == Paperless Übersicht == | ||
| 710 | |||
| 711 | **Dokumente** sind die primären Ressourcen in Paperless. Ein Dokument kann über mehrere Wege in Paperless aufgenommen werden (der Prozess wird **Ingestion** genannt): | ||
| 712 | |||
| 713 | * **Per E-Mail**: es sind zwei Mail-Adressen eingerichtet, eingehende Anhänge werden automatisch von Paperless verarbeitet. Die QR Code Verarbeitung (siehe unten) findet hier ebenfalls Anwendung. | ||
| 714 | ** Die Mitgliederverwaltung: [[mitglieder-dokumente@makerspace-darmstadt.de>>mailto:mitglieder-dokumente@makerspace-darmstadt.de||shape="rect"]] | ||
| 715 | ** Den Vorstand: [[vorstand-dokumente@makerspace-darmstadt.de>>mailto:vorstand-dokumente@makerspace-darmstadt.de||shape="rect"]] | ||
| 716 | * **Per Ordner**: Auf unserem NAS gibt es einen speziellen Ordner, der in Paperless eingebunden ist. Alle Dokumente, die in diesen Ordner gelegt werden, werden automatisch von Paperless verarbeitet. Dieser Ordner wird hauptsächlich vom Dokumentenscanner verwendet, der die gescannten Dokumente ablegt. Dies ermöglicht einen einfachen Scan mit einem einfachen Button, die Dokumente werden dann automatisch in Paperless erkannt | ||
| 717 | * **Per Weboberfläche**: Es ist ebenfalls möglich, Dokumente manuell über die Weboberfläche hinzuzufügen. | ||
| 718 | |||
| 719 | Die folgenden Grafik gibt eine Übersicht: | ||
| 720 | |||
| 721 | {{confluence_drawio border="true" diagramName="Ingest Diagram" simpleViewer="false" links="auto" tbstyle="top" lbox="true" diagramWidth="1016" height="451" revision="3"/}} | ||
| 722 | |||
| 723 | Die Konfiguration des Scanners ist so eingerichtet, dass nur zwei Buttons auf dem Display sichtbar sind: | ||
| 724 | |||
| 725 | * **SCAN Vorstand** - Platziert das Dokument in dem Consumption Ordner für den Vorstand, Rechte und Tags werden dann automatisch gesetzt | ||
| 726 | * **SCAN MV** - Platziert das Dokument in dem Consumption Ordner für die Mitgliederverwaltung, Rechte und Tags werden dann automatisch gesetzt | ||
| 727 | |||
| 728 | == Übersicht der Metadaten == | ||
| 729 | |||
| 730 | Dokumente werden dann Meta-Daten zugeordnet, die eine spätere Suche und Zuordnung erleichtern. Diese Meta-Daten sind: | ||
| 731 | |||
| 732 | * **Korrespondent**: Im Prinzip der "Gesprächspartner", beispielsweise der Absender eines Briefs. Im Falle der Mitgliederverwaltung wird für jedes Mitglied und jeden registrierten Gast automatisch im Hintergrund ein Korrespondent angelegt. Die Korrespondenten heißen: | ||
| 733 | ** Für **Mitglieder**: //Vorname Nachname (#Mitgliedsnummer)//, also beispielsweise "//Daniel Herrmann (#250)//" | ||
| 734 | ** Für **Gäste**: //Vorname Nachname (GEindeutigeNummer)//, also beispielsweise "//Max Mustermann (G1244)//" | ||
| 735 | ** Bei **Vereinseintritt** und **Vereinsaustritt** werden die Korrespondenten automatisch umbenannt, auch Namensänderungen werden automatisch verarbeitet. | ||
| 736 | * **Tags**: Einem Dokument können beliebig viele Tags zugewiesen werden. **Tags** dienen der einfacheren **Zuordnung** und dem **Wiederfinden** von Dokumenten. Es gibt allerdings auch spezielle Tags für Dokumente die eingelesen aber noch nicht bearbeitet wurden, so genannte "Inbox Tags": | ||
| 737 | ** (% style="color:var(--ds-icon-success,#22a06b);" %)**Inbox Mitgliederverwaltung**(%%) - Alle **Dokumente** die **per Mail oder per Ordner** für die **Gruppe Mitgliederverwaltung** aufgenommen wurden und **nicht automatisch zugeordnet** werden konnten. | ||
| 738 | ** (% style="color:var(--ds-icon-accent-blue,#1d7afc);" %)**Inbox Vorstand**(%%) - Alle **Dokumente** die **per Mail oder per Ordner** für die **Gruppe Vorstand** aufgenommen wurden und **nicht automatisch zugeordnet** werden konnten. | ||
| 739 | * **Dokumenten-Typen**: Einem Dokument wird exakt ein Typ zugewiesen. Dokumenten Typen sind im Prinzip einfache Gruppen. Für die Mitgliederverwaltung sind die Gruppen gemäß der folgenden Liste festgelegt, können aber natürlich bei Bedarf erweitert werden. | ||
| 740 | ** Mitgliedsantrag | ||
| 741 | ** SEPA Lastschriftmandat | ||
| 742 | ** Studienbescheinigung | ||
| 743 | ** Bestätigung Schlüsselausgabe | ||
| 744 | ** Verpflichtungserklärung Datenschutz | ||
| 745 | ** Übungsleitervertrag | ||
| 746 | ** Nutzungsvereinbarung Schulungsinhalte | ||
| 747 | ** Bestellung als Einweiser:in | ||
| 748 | ** Haftungsausschluss | ||
| 749 | ** Einweisungszettel | ||
| 750 | ** Lagervertrag Kistenlager | ||
| 751 | ** Lagervertrag Projektlager | ||
| 752 | * ((( | ||
| 753 | **Storage Path**: Speicherpfade sind ein fortgeschrittenes Feature, welches kontrolliert, wie die Dateien im unterliegenden Dateisystem gespeichert werden. In der Regel arbeitet man nicht direkt mit den Dateien, aber wenn man aus lange Sicht mal aus Paperless NGX weg ziehen möchte kann es sinnvoll sein, die Dokumente in einer Struktur zu speichern, die man theoretisch auch manuell durchsuchen könnte. Details finden sich in der [[Dokumentation von Paperless zu File Name Handling>>url:https://docs.paperless-ngx.com/advanced_usage/#file-name-handling||shape="rect"]]. | ||
| 754 | \\{{info title="Verhalten von Paperless"}}(% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %)Paperless checks the filename of a document whenever it is saved. Changing (or deleting) a (%%)[[storage path>>url:https://docs.paperless-ngx.com/advanced_usage/#storage-paths||style="text-decoration: none;" shape="rect"]](% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %) will automatically be reflected in the file system. However, when changing (% style="text-decoration: none;" %){{code language="none"}}PAPERLESS_FILENAME_FORMAT{{/code}}(% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %) you will need to manually run the (%%)[[ | ||
| 755 | |||
| 756 | {{code language="none"}} | ||
| 757 | document renamer | ||
| 758 | {{/code}}>>url:https://docs.paperless-ngx.com/administration/#renamer||style="text-decoration: none;" shape="rect"]](% style="text-decoration: none;color:var(--ds-text-accent-purple-bolder,#352c63);" %) to move any existing documents.{{/info}} | ||
| 759 | In unserem Fall kommen die folgenden Speicherpfade zum Einsatz: | ||
| 760 | \\ | ||
| 761 | |||
| 762 | |=(% scope="col" %)((( | ||
| 763 | Name | ||
| 764 | )))|=(% scope="col" %)((( | ||
| 765 | Definition | ||
| 766 | )))|=(% scope="col" %)((( | ||
| 767 | Sichtbar für | ||
| 768 | )))|=(% scope="col" %)((( | ||
| 769 | Anwendung | ||
| 770 | ))) | ||
| 771 | |((( | ||
| 772 | Mitglieder Einweisungszettel | ||
| 773 | )))|((( | ||
| 774 | (% class="code" %) | ||
| 775 | ((( | ||
| 776 | ~{~{ correspondent }}/Einweisungen/~{~{ document_type }}-~{~{ tag_list }}-~{~{ created }}-~{~{ doc_pk }} | ||
| 777 | ))) | ||
| 778 | )))|((( | ||
| 779 | Mitgliederverwaltung | ||
| 780 | )))|((( | ||
| 781 | Einweisungszettel | ||
| 782 | ))) | ||
| 783 | |((( | ||
| 784 | Mitglieder Unterlagen | ||
| 785 | )))|((( | ||
| 786 | (% class="code" %) | ||
| 787 | ((( | ||
| 788 | ~{~{ correspondent }}/~{~{ document_type }}-~{~{ created }}-~{~{ doc_pk }} | ||
| 789 | ))) | ||
| 790 | )))|((( | ||
| 791 | Mitgliederverwaltung | ||
| 792 | )))|((( | ||
| 793 | Alle anderen Mitgliederdokumente | ||
| 794 | ))) | ||
| 795 | |((( | ||
| 796 | Vorstand Dokumente | ||
| 797 | )))|((( | ||
| 798 | (% class="code" %) | ||
| 799 | ((( | ||
| 800 | ~{~{ created_year }}/~{~{ correspondent }}/~{~{ title }} | ||
| 801 | ))) | ||
| 802 | )))|((( | ||
| 803 | Vorstand | ||
| 804 | )))|((( | ||
| 805 | Alle Vorstandsdokumente | ||
| 806 | ))) | ||
| 807 | ))) | ||
| 808 | |||
| 809 | == Automatische Zuordnung von Metadaten == | ||
| 810 | |||
| 811 | Paperless unterstützt die automatische Zuordnung von Metadaten basierend auf festen Strings. So kann man beispielsweise angeben, dass ein Dokumententyp "Haftungsausschluss" zugewiesen werden soll, wenn der String "Haftungsausschluss" irgendwo im Dokument vorkommt. Dies ist allerdings auf eine korrekte Funktion der Texterkennung angewiesen und funktioniert erfahrungsgemäß nur in manchen Fällen, sodass mindestens eine manuelle Überprüfung trotzdem notwendig kommt. Wenn beispielsweise ein Brief mit dem Satz "ich dachte, ich hätte den Haftungsausschluss bereits abgegeben, könntet ihr dies bitte prüfen" erfasst wird, würde der basierend auf der Regel ebenfalls kategorisiert werden. | ||
| 812 | |||
| 813 | **Aus diesem Grund wird auf jedes Dokument einen spezieller QR Code aufgedruckt**. Der QR code wird vom Post-Consume Script verwendet um die Metadaten in Paperless zuzuordnen. Weiterhin können Daten übermittelt werden, die dann mittels Webhook an N8n übermittelt werden und dort im Workflow verwendet werden können. Der Aufbau orientiert sich an dem Aufbau eines **JSON Web Tokens (JWT).** | ||
| 814 | |||
| 815 | === (% style="color:var(--ds-text-accent-purple-bolder,#352c63)" %)Barcode erzeugen(%%) === | ||
| 816 | |||
| 817 | (% style="color:var(--ds-text-accent-purple-bolder,#352c63)" %)Der Prozess zur Erzeugung eines QR Codes ist wie folgt: | ||
| 818 | |||
| 819 | * **Payload (Daten) festlegen**. Einige Werte sind verpflichtend, andere können nach Bedarf optional hinzugefügt werden. | ||
| 820 | * JWT erzeugen und signieren. der JWT besteht aus drei Teilen: | ||
| 821 | ** **Header**: **alg** (Algorithmus) und **typ** (JWT) sind verpflichtend. Zusätzlich fügen wir einen Timestamp, eine eindeutige ID und eine Gültigkeitsdauer hinzu. | ||
| 822 | ** **Body**: beinhaltet die eigentlichen Daten. | ||
| 823 | ** **Signature**: Mit Hilfe eines Secrets und wird die Signatur erzeugt und automatisch angehängt. | ||
| 824 | * PDF417 code erzeugen: ein JWT ist per Definition URL safe und kann daher einfach in ein QR code umgewandelt werden. | ||
| 825 | |||
| 826 | === Header === | ||
| 827 | |||
| 828 | Der Header enthält wichtige Meta-Daten, diese werden von der JWT Library automatisch erzeugt und beschreiben in der Regel den verwendeten Key-Typ. | ||
| 829 | |||
| 830 | === Body === | ||
| 831 | |||
| 832 | Die folgenden Claims sind im Body verfügbar. | ||
| 833 | |||
| 834 | |=((( | ||
| 835 | Claim | ||
| 836 | )))|=((( | ||
| 837 | Type | ||
| 838 | )))|=((( | ||
| 839 | Pflicht | ||
| 840 | )))|=((( | ||
| 841 | Beschreibung | ||
| 842 | ))) | ||
| 843 | |((( | ||
| 844 | id | ||
| 845 | )))|((( | ||
| 846 | UUID4 | ||
| 847 | )))|((( | ||
| 848 | ✅️ | ||
| 849 | )))|((( | ||
| 850 | Eindeutige ID dieses Dokuments | ||
| 851 | ))) | ||
| 852 | |((( | ||
| 853 | time | ||
| 854 | )))|((( | ||
| 855 | Zahl | ||
| 856 | )))|((( | ||
| 857 | ✅️ | ||
| 858 | )))|((( | ||
| 859 | UTC Linux-Timestamp an dem das Dokument und der QR Code erzeugt wurden | ||
| 860 | ))) | ||
| 861 | |((( | ||
| 862 | exp | ||
| 863 | )))|((( | ||
| 864 | Zahl | ||
| 865 | )))|((( | ||
| 866 | ✅️ | ||
| 867 | )))|((( | ||
| 868 | UTC Linux-Timestamp der angibt, bis wann das Dokument gültig ist. | ||
| 869 | ))) | ||
| 870 | |((( | ||
| 871 | (% class="code" %) | ||
| 872 | ((( | ||
| 873 | typ | ||
| 874 | ))) | ||
| 875 | )))|((( | ||
| 876 | String | ||
| 877 | )))|((( | ||
| 878 | ✅️ | ||
| 879 | )))|((( | ||
| 880 | Typ des Dokuments basierend auf der unten definierten Liste. | ||
| 881 | ))) | ||
| 882 | |mode|String|✅️ |Kann entweder "digital" oder "manual" sein und bestimmt, ob N8n den unterschriebenen Vertrag ans Backend meldet. | ||
| 883 | |((( | ||
| 884 | (% class="code" %) | ||
| 885 | ((( | ||
| 886 | cor | ||
| 887 | ))) | ||
| 888 | )))|((( | ||
| 889 | String | ||
| 890 | )))|((( | ||
| 891 | ❌️ | ||
| 892 | )))|((( | ||
| 893 | Optional: Name des Korrespondenten, dem das Dokument zugeordnet werden soll | ||
| 894 | ))) | ||
| 895 | |((( | ||
| 896 | tags | ||
| 897 | )))|((( | ||
| 898 | List[String] | ||
| 899 | )))|((( | ||
| 900 | ❌️ | ||
| 901 | )))|((( | ||
| 902 | Liste an Tags, die dem Dokument zugeordnet werden soll | ||
| 903 | ))) | ||
| 904 | |((( | ||
| 905 | spth | ||
| 906 | )))|((( | ||
| 907 | String | ||
| 908 | )))|((( | ||
| 909 | ❌️ | ||
| 910 | )))|((( | ||
| 911 | Storage Path, das dem Dokument zugeordnet werden soll | ||
| 912 | ))) | ||
| 913 | |((( | ||
| 914 | opt | ||
| 915 | )))|((( | ||
| 916 | dict | ||
| 917 | )))|((( | ||
| 918 | ❌️ | ||
| 919 | )))|((( | ||
| 920 | Optionale Attribute, die mit eincodiert werden und dem N8n Workflow übergeben werden. | ||
| 921 | ))) | ||
| 922 | |||
| 923 | === {{id name="DigitaleMitgliederverwaltung-Footer"/}}Footer === | ||
| 924 | |||
| 925 | Der Footer wird automatisch erzeugt und erhält eine Signatur über den Header und den Body, basierend auf einem Algorithmus und einer Signatur. | ||
| 926 | |||
| 927 | {{confluence_tip title="Algorithmus"}} | ||
| 928 | Von den meisten Libraries werden symmetrische und asymmetrische Signaturen unterstützt. Die Verwendung eines symmetrischen Algorithmus ist für uns einfacher. | ||
| 929 | |||
| 930 | Für diesen Anwendungsfall nutzen wir (% style="text-decoration: none;color:var(--ds-text,#333333);" %)**HS256** (HMAC mit SHA-256 Algorithmus). | ||
| 931 | {{/confluence_tip}} | ||
| 932 | |||
| 933 | === Auswahl der Library === | ||
| 934 | |||
| 935 | 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: | ||
| 936 | |||
| 937 | |=((( | ||
| 938 | Name | ||
| 939 | )))|=((( | ||
| 940 | CVE | ||
| 941 | )))|=((( | ||
| 942 | Github | ||
| 943 | )))|=((( | ||
| 944 | GH⭐ | ||
| 945 | )))|=((( | ||
| 946 | Letztes Release | ||
| 947 | )))|=((( | ||
| 948 | Offene Issues | ||
| 949 | )))|=((( | ||
| 950 | Dokumentation | ||
| 951 | )))|=((( | ||
| 952 | Qualität Dokumentation | ||
| 953 | )))|=((( | ||
| 954 | In Backend vorhanden? | ||
| 955 | )))|=((( | ||
| 956 | In Paperless vorhanden? | ||
| 957 | ))) | ||
| 958 | |((( | ||
| 959 | python-jose | ||
| 960 | )))|((( | ||
| 961 | 3/0 | ||
| 962 | )))|((( | ||
| 963 | [[https:~~/~~/github.com/mpdavis/python-jose>>url:https://github.com/mpdavis/python-jose||shape="rect"]] | ||
| 964 | )))|((( | ||
| 965 | 1.7k | ||
| 966 | )))|((( | ||
| 967 | 28.05.2025 | ||
| 968 | )))|((( | ||
| 969 | 83 | ||
| 970 | )))|((( | ||
| 971 | [[https:~~/~~/python-jose.readthedocs.io/en/latest/>>url:https://python-jose.readthedocs.io/en/latest/||shape="rect"]] | ||
| 972 | )))|((( | ||
| 973 | ⛔ Wenige Bespiele, API Dokumentation fehlt komplett | ||
| 974 | )))|((( | ||
| 975 | ❌️ | ||
| 976 | )))|((( | ||
| 977 | ❌️ | ||
| 978 | ))) | ||
| 979 | |((( | ||
| 980 | pyJWT | ||
| 981 | )))|((( | ||
| 982 | 4/0 | ||
| 983 | )))|((( | ||
| 984 | [[https:~~/~~/github.com/jpadilla/pyjwt>>url:https://github.com/jpadilla/pyjwt||shape="rect"]] | ||
| 985 | )))|((( | ||
| 986 | 5.4k | ||
| 987 | )))|((( | ||
| 988 | 28.11.2024 | ||
| 989 | )))|((( | ||
| 990 | 30 | ||
| 991 | )))|((( | ||
| 992 | [[https:~~/~~/pyjwt.readthedocs.io>>url:https://pyjwt.readthedocs.io||shape="rect"]] | ||
| 993 | )))|((( | ||
| 994 | ➕️ Gute Dokumentation, API, Beispiele, Changelog | ||
| 995 | )))|((( | ||
| 996 | ✅️ 2.10.1 | ||
| 997 | Dep von firebase | ||
| 998 | )))|((( | ||
| 999 | ✅️ 2.10.1 | ||
| 1000 | ))) | ||
| 1001 | |((( | ||
| 1002 | JWCrypto | ||
| 1003 | )))|((( | ||
| 1004 | 5/0 | ||
| 1005 | )))|((( | ||
| 1006 | [[https:~~/~~/github.com/latchset/jwcrypto>>url:https://github.com/latchset/jwcrypto||shape="rect"]] | ||
| 1007 | )))|((( | ||
| 1008 | 465 | ||
| 1009 | )))|((( | ||
| 1010 | 06.03.2024 | ||
| 1011 | )))|((( | ||
| 1012 | 8 | ||
| 1013 | )))|((( | ||
| 1014 | [[https:~~/~~/jwcrypto.readthedocs.io>>url:https://jwcrypto.readthedocs.io||shape="rect"]] | ||
| 1015 | )))|((( | ||
| 1016 | ➕️ API Doc, einige Beispiele | ||
| 1017 | )))|((( | ||
| 1018 | ✅️ 1.5.6 | ||
| 1019 | Dep von python-keycloak | ||
| 1020 | )))|((( | ||
| 1021 | ❌️ | ||
| 1022 | ))) | ||
| 1023 | |||
| 1024 | Unsere bevorzugte Library ist **pyjwt**. Diese ist auch in **paperless nativ vorhanden**, sodass wir uns für die Implementierung mittels **pyjwt** entschieden haben. | ||
| 1025 | |||
| 1026 | === PDF417 Code === | ||
| 1027 | |||
| 1028 | 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 | |||
| 1030 | (% style="color:var(--ds-text-accent-purple-bolder,#352c63); text-decoration:none" %)[[image:attach:barcode.jpg||height="250"]] | ||
| 1031 | |||
| 1032 | (% 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 | |||
| 1034 | === Referenz-Implementierung === | ||
| 1035 | |||
| 1036 | 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"]] | ||
| 1037 | |||
| 1038 | === Post Consumption Script === | ||
| 1039 | |||
| 1040 | 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"]] | ||
| 1041 | |||
| 1042 | == Paperless Berechtigungen == | ||
| 1043 | |||
| 1044 | 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. | ||
| 1045 | |||
| 1046 | === Benutzer und Gruppen === | ||
| 1047 | |||
| 1048 | 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: | ||
| 1049 | |||
| 1050 | * **Vorstand**: Für die Mitglieder des Vorstands | ||
| 1051 | * **Mitgliederverwaltung**: Alle Personen, die mit der Verwaltung der Mitglieder betraut sind | ||
| 1052 | * **IT Admin**: IT Administratoren im Makerspace | ||
| 1053 | |||
| 1054 | 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. | ||
| 1055 | |||
| 1056 | === Globale Berechtigungen === | ||
| 1057 | |||
| 1058 | 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: | ||
| 1059 | |||
| 1060 | |=(% scope="row" %)((( | ||
| 1061 | Berechtigung | ||
| 1062 | )))|=((( | ||
| 1063 | Beschreibung | ||
| 1064 | )))|=((( | ||
| 1065 | Mitgliederverwaltung | ||
| 1066 | )))|=((( | ||
| 1067 | Vorstand | ||
| 1068 | )))|=((( | ||
| 1069 | IT Admin | ||
| 1070 | )))|=((( | ||
| 1071 | Notiz | ||
| 1072 | ))) | ||
| 1073 | |=((( | ||
| 1074 | Document | ||
| 1075 | )))|((( | ||
| 1076 | Sehen und bearbeiten von Dokumenten. | ||
| 1077 | )))|((( | ||
| 1078 | ALLE | ||
| 1079 | )))|((( | ||
| 1080 | ALLE | ||
| 1081 | )))|((( | ||
| 1082 | KEINE | ||
| 1083 | )))|((( | ||
| 1084 | Wird zusätzlich durch Berechtigungen auf Objekt-Level eingeschränkt | ||
| 1085 | ))) | ||
| 1086 | |=((( | ||
| 1087 | Tag | ||
| 1088 | )))|((( | ||
| 1089 | Sehen und bearbeiten von Tags. | ||
| 1090 | )))|((( | ||
| 1091 | Anzeigen | ||
| 1092 | )))|((( | ||
| 1093 | ALLE | ||
| 1094 | )))|((( | ||
| 1095 | ALLE | ||
| 1096 | )))|((( | ||
| 1097 | Wird zusätzlich durch Berechtigungen auf Objekt-Level eingeschränkt | ||
| 1098 | ))) | ||
| 1099 | |=((( | ||
| 1100 | Correspondent | ||
| 1101 | )))|((( | ||
| 1102 | Sehen und bearbeiten von Korrespondenten | ||
| 1103 | )))|((( | ||
| 1104 | Anzeigen | ||
| 1105 | )))|((( | ||
| 1106 | ALLE | ||
| 1107 | )))|((( | ||
| 1108 | ALLE | ||
| 1109 | )))|((( | ||
| 1110 | Wird zusätzlich durch Berechtigungen auf Objekt-Level eingeschränkt | ||
| 1111 | ))) | ||
| 1112 | |=((( | ||
| 1113 | DocumentType | ||
| 1114 | )))|((( | ||
| 1115 | Sehen und bearbeiten von Dokument-Typen | ||
| 1116 | )))|((( | ||
| 1117 | Anzeigen | ||
| 1118 | )))|((( | ||
| 1119 | ALLE | ||
| 1120 | )))|((( | ||
| 1121 | ALLE | ||
| 1122 | )))|((( | ||
| 1123 | Wird zusätzlich durch Berechtigungen auf Objekt-Level eingeschränkt | ||
| 1124 | ))) | ||
| 1125 | |=((( | ||
| 1126 | StoragePath | ||
| 1127 | )))|((( | ||
| 1128 | Sehen und bearbeiten von Speicherpfaden | ||
| 1129 | )))|((( | ||
| 1130 | Anzeigen | ||
| 1131 | )))|((( | ||
| 1132 | Anzeigen | ||
| 1133 | )))|((( | ||
| 1134 | ALLE | ||
| 1135 | )))|((( | ||
| 1136 | Wird zusätzlich durch Berechtigungen auf Objekt-Level eingeschränkt | ||
| 1137 | ))) | ||
| 1138 | |=((( | ||
| 1139 | SavedView | ||
| 1140 | )))|((( | ||
| 1141 | Ansichten erzeugen und speichern | ||
| 1142 | )))|((( | ||
| 1143 | ALLE | ||
| 1144 | )))|((( | ||
| 1145 | ALLE | ||
| 1146 | )))|((( | ||
| 1147 | KEINE | ||
| 1148 | )))|((( | ||
| 1149 | |||
| 1150 | ))) | ||
| 1151 | |=((( | ||
| 1152 | PaperlessTask | ||
| 1153 | )))|((( | ||
| 1154 | Dateiaufgaben einsehen und löschen | ||
| 1155 | )))|((( | ||
| 1156 | KEINE | ||
| 1157 | )))|((( | ||
| 1158 | KEINE | ||
| 1159 | )))|((( | ||
| 1160 | ALLE | ||
| 1161 | )))|((( | ||
| 1162 | |||
| 1163 | ))) | ||
| 1164 | |=((( | ||
| 1165 | AppConfig | ||
| 1166 | )))|((( | ||
| 1167 | Konfiguration von Paperless NGX selbst | ||
| 1168 | )))|((( | ||
| 1169 | KEINE | ||
| 1170 | )))|((( | ||
| 1171 | KEINE | ||
| 1172 | )))|((( | ||
| 1173 | ALLE | ||
| 1174 | )))|((( | ||
| 1175 | |||
| 1176 | ))) | ||
| 1177 | |=((( | ||
| 1178 | UISettings | ||
| 1179 | )))|((( | ||
| 1180 | Persönliche Anzeigeeinstellungen ändern | ||
| 1181 | )))|((( | ||
| 1182 | ALLE | ||
| 1183 | )))|((( | ||
| 1184 | ALLE | ||
| 1185 | )))|((( | ||
| 1186 | ALLE | ||
| 1187 | )))|((( | ||
| 1188 | |||
| 1189 | ))) | ||
| 1190 | |=((( | ||
| 1191 | History | ||
| 1192 | )))|((( | ||
| 1193 | Dokumenten-Audit Log anzeigen oder ändern | ||
| 1194 | )))|((( | ||
| 1195 | Anzeigen | ||
| 1196 | )))|((( | ||
| 1197 | Anzeigen | ||
| 1198 | )))|((( | ||
| 1199 | KEINE | ||
| 1200 | )))|((( | ||
| 1201 | Nur für Dokumente, auf die Zugriff gewährt wurde. | ||
| 1202 | ))) | ||
| 1203 | |=((( | ||
| 1204 | Note | ||
| 1205 | )))|((( | ||
| 1206 | Notizen zu Dokumenten einsehen oder ändern | ||
| 1207 | )))|((( | ||
| 1208 | ALLE | ||
| 1209 | )))|((( | ||
| 1210 | ALLE | ||
| 1211 | )))|((( | ||
| 1212 | KEINE | ||
| 1213 | )))|((( | ||
| 1214 | Nur für Dokumente, auf die Zugriff gewährt wurde. | ||
| 1215 | ))) | ||
| 1216 | |=((( | ||
| 1217 | MailAccount | ||
| 1218 | )))|((( | ||
| 1219 | Mail-Accounts verwalten | ||
| 1220 | )))|((( | ||
| 1221 | KEINE | ||
| 1222 | )))|((( | ||
| 1223 | Anzeigen | ||
| 1224 | )))|((( | ||
| 1225 | ALLE | ||
| 1226 | )))|((( | ||
| 1227 | |||
| 1228 | ))) | ||
| 1229 | |=((( | ||
| 1230 | MailRule | ||
| 1231 | )))|((( | ||
| 1232 | Verarbeitungsregeln für eingehende Mails bearbeiten | ||
| 1233 | )))|((( | ||
| 1234 | KEINE | ||
| 1235 | )))|((( | ||
| 1236 | ALLE | ||
| 1237 | )))|((( | ||
| 1238 | ALLE | ||
| 1239 | )))|((( | ||
| 1240 | |||
| 1241 | ))) | ||
| 1242 | |=((( | ||
| 1243 | User | ||
| 1244 | )))|((( | ||
| 1245 | Benutzer einsehen oder verwalten | ||
| 1246 | )))|((( | ||
| 1247 | KEINE | ||
| 1248 | )))|((( | ||
| 1249 | Anzeigen | ||
| 1250 | )))|((( | ||
| 1251 | ALLE | ||
| 1252 | )))|((( | ||
| 1253 | |||
| 1254 | ))) | ||
| 1255 | |=((( | ||
| 1256 | Group | ||
| 1257 | )))|((( | ||
| 1258 | Gruppen einsehen oder verwalten | ||
| 1259 | )))|((( | ||
| 1260 | KEINE | ||
| 1261 | )))|((( | ||
| 1262 | Anzeigen | ||
| 1263 | )))|((( | ||
| 1264 | ALLE | ||
| 1265 | )))|((( | ||
| 1266 | |||
| 1267 | ))) | ||
| 1268 | |=((( | ||
| 1269 | ShareLink | ||
| 1270 | )))|((( | ||
| 1271 | Öffentliche Share-Links erstellen oder verwalten | ||
| 1272 | )))|((( | ||
| 1273 | KEINE | ||
| 1274 | )))|((( | ||
| 1275 | KEINE | ||
| 1276 | )))|((( | ||
| 1277 | KEINE | ||
| 1278 | )))|((( | ||
| 1279 | |||
| 1280 | ))) | ||
| 1281 | |=((( | ||
| 1282 | CustomField | ||
| 1283 | )))|((( | ||
| 1284 | Custom Fields einsehen oder verwalten | ||
| 1285 | )))|((( | ||
| 1286 | Anzeigen | ||
| 1287 | )))|((( | ||
| 1288 | Anzeigen | ||
| 1289 | )))|((( | ||
| 1290 | ALLE | ||
| 1291 | )))|((( | ||
| 1292 | |||
| 1293 | ))) | ||
| 1294 | |=((( | ||
| 1295 | Workflow | ||
| 1296 | )))|((( | ||
| 1297 | Workflows für neue Dokumente einsehen oder verwalten | ||
| 1298 | )))|((( | ||
| 1299 | KEINE | ||
| 1300 | )))|((( | ||
| 1301 | KEINE | ||
| 1302 | )))|((( | ||
| 1303 | ALLE | ||
| 1304 | )))|((( | ||
| 1305 | |||
| 1306 | ))) | ||
| 1307 | |||
| 1308 | === Objekt-Berechtigungen === | ||
| 1309 | |||
| 1310 | 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: | ||
| 1311 | |||
| 1312 | * Owner / Eigentümer: Das Objekt gehört diesem Benutzer. Der Owner hat immer alle Berechtigungen für das Objekt | ||
| 1313 | * Zusätzliche Berechtigungen: | ||
| 1314 | ** Es können getrennt voneinander Berechtigungen zum Anzeigen und Bearbeiten vergeben werden | ||
| 1315 | ** Diese Berechtigungen können jeweils für einzelne Benutzer oder für Gruppen gewährt werden | ||
| 1316 | |||
| 1317 | Das sieht im Frontend beispielsweise so aus: | ||
| 1318 | |||
| 1319 | [[image:attach:image-2025-8-25_10-19-25.png||thumbnail="true" height="250"]] | ||
| 1320 | |||
| 1321 | {{info title="Berechtigungen"}} | ||
| 1322 | Es sind grundsätzlich sowohl globale als auch objekt-spezifische Berechtigungen notwendig. Wenn ein Benutzer ein Objekt bearbeiten ansehen oder bearbeiten möchte ergibt sich daher die folgende Matrix: | ||
| 1323 | |||
| 1324 | |=((( | ||
| 1325 | Globale Berechtigung | ||
| 1326 | )))|=((( | ||
| 1327 | Owner | ||
| 1328 | )))|=((( | ||
| 1329 | Objekt-Berechtigung | ||
| 1330 | )))|=((( | ||
| 1331 | Ergebnis | ||
| 1332 | ))) | ||
| 1333 | |((( | ||
| 1334 | ❌️ | ||
| 1335 | )))|((( | ||
| 1336 | Egal | ||
| 1337 | )))|((( | ||
| 1338 | Egal | ||
| 1339 | )))|((( | ||
| 1340 | ❌️ | ||
| 1341 | ))) | ||
| 1342 | |((( | ||
| 1343 | ✅️ | ||
| 1344 | )))|((( | ||
| 1345 | ✅️ | ||
| 1346 | )))|((( | ||
| 1347 | Egal | ||
| 1348 | )))|((( | ||
| 1349 | ✅️ | ||
| 1350 | ))) | ||
| 1351 | |((( | ||
| 1352 | ✅️ | ||
| 1353 | )))|((( | ||
| 1354 | ❌️ | ||
| 1355 | )))|((( | ||
| 1356 | ❌️ | ||
| 1357 | )))|((( | ||
| 1358 | ❌️ | ||
| 1359 | ))) | ||
| 1360 | |((( | ||
| 1361 | ✅️ | ||
| 1362 | )))|((( | ||
| 1363 | ❌️ | ||
| 1364 | )))|((( | ||
| 1365 | ✅️ | ||
| 1366 | )))|((( | ||
| 1367 | ✅️ | ||
| 1368 | ))) | ||
| 1369 | |||
| 1370 | Mit anderen Worten, um eine Aktion auszuführen, muss ein Benutzer (a) die globale Berechtigung haben **UND** (b) Owner sein **ODER** Objekt-Berechtigungen haben. | ||
| 1371 | {{/info}} | ||
| 1372 | |||
| 1373 | === Lokale Owner === | ||
| 1374 | |||
| 1375 | 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. | ||
| 1376 | |||
| 1377 | |=(% scope="row" %)((( | ||
| 1378 | Benutzer | ||
| 1379 | )))|=((( | ||
| 1380 | Verwendet für | ||
| 1381 | ))) | ||
| 1382 | |=((( | ||
| 1383 | mksp-mv-owner | ||
| 1384 | )))|((( | ||
| 1385 | Alle Objekte (Dokumente, Dokumenttypen, Tags, Korrespondenten und Speicherpfade), die dem Use-Case **Mitgliederverwaltung** zugewiesen sind | ||
| 1386 | ))) | ||
| 1387 | |=((( | ||
| 1388 | mksp-vs-owner | ||
| 1389 | )))|((( | ||
| 1390 | Alle Objekte (Dokumente, Dokumenttypen, Tags, Korrespondenten und Speicherpfade), die dem Use-Case **Vorstandspost** zugewiesen sind | ||
| 1391 | ))) | ||
| 1392 | |||
| 1393 | === Standard-Objekt-Berechtigungen === | ||
| 1394 | |||
| 1395 | Basierend auf den hier beschrieben Regeln werden für Objekte die folgenden Berechtigungen gesetzt: | ||
| 1396 | |||
| 1397 | |=(% rowspan="2" scope="rowgroup" %)((( | ||
| 1398 | Objekt | ||
| 1399 | |||
| 1400 | )))|=(% colspan="3" scope="colgroup" %)((( | ||
| 1401 | Mitgliederverwaltung | ||
| 1402 | )))|=(% rowspan="7" scope="rowgroup" %)((( | ||
| 1403 | |||
| 1404 | )))|=(% colspan="3" scope="colgroup" %)((( | ||
| 1405 | Vorstandspost | ||
| 1406 | ))) | ||
| 1407 | |=(% scope="col" %)((( | ||
| 1408 | Owner | ||
| 1409 | )))|=((( | ||
| 1410 | Anzeigen | ||
| 1411 | )))|=((( | ||
| 1412 | Bearbeiten | ||
| 1413 | )))|=((( | ||
| 1414 | Owner | ||
| 1415 | )))|=((( | ||
| 1416 | Anzeigen | ||
| 1417 | )))|=((( | ||
| 1418 | Bearbeiten | ||
| 1419 | ))) | ||
| 1420 | |=((( | ||
| 1421 | Dokument | ||
| 1422 | )))|((( | ||
| 1423 | mksp-mv-owner | ||
| 1424 | )))|((( | ||
| 1425 | Mitgliederverwaltung | ||
| 1426 | )))|((( | ||
| 1427 | Mitgliederverwaltung | ||
| 1428 | )))|((( | ||
| 1429 | mksp-vs-owner | ||
| 1430 | )))|((( | ||
| 1431 | Vorstand | ||
| 1432 | )))|((( | ||
| 1433 | Vorstand | ||
| 1434 | ))) | ||
| 1435 | |=((( | ||
| 1436 | Dokumenttyp | ||
| 1437 | )))|((( | ||
| 1438 | mksp-mv-owner | ||
| 1439 | )))|((( | ||
| 1440 | Mitgliederverwaltung, IT Admin | ||
| 1441 | )))|((( | ||
| 1442 | IT Admin | ||
| 1443 | )))|((( | ||
| 1444 | mksp-vs-owner | ||
| 1445 | )))|((( | ||
| 1446 | Vorstand | ||
| 1447 | )))|((( | ||
| 1448 | Vorstand | ||
| 1449 | ))) | ||
| 1450 | |=((( | ||
| 1451 | Tag | ||
| 1452 | )))|((( | ||
| 1453 | mksp-mv-owner | ||
| 1454 | )))|((( | ||
| 1455 | Mitgliederverwaltung, IT Admin | ||
| 1456 | )))|((( | ||
| 1457 | IT Admin | ||
| 1458 | )))|((( | ||
| 1459 | mksp-vs-owner | ||
| 1460 | )))|((( | ||
| 1461 | Vorstand | ||
| 1462 | )))|((( | ||
| 1463 | Vorstand | ||
| 1464 | ))) | ||
| 1465 | |=((( | ||
| 1466 | Korrespondent | ||
| 1467 | )))|((( | ||
| 1468 | mksp-mv-owner | ||
| 1469 | )))|((( | ||
| 1470 | Mitgliederverwaltung, IT Admin | ||
| 1471 | )))|((( | ||
| 1472 | IT Admin | ||
| 1473 | )))|((( | ||
| 1474 | mksp-vs-owner | ||
| 1475 | )))|((( | ||
| 1476 | Vorstand | ||
| 1477 | )))|((( | ||
| 1478 | Vorstand | ||
| 1479 | ))) | ||
| 1480 | |=((( | ||
| 1481 | Speicherpfad | ||
| 1482 | )))|((( | ||
| 1483 | mksp-mv-owner | ||
| 1484 | )))|((( | ||
| 1485 | Mitgliederverwaltung, IT Admin | ||
| 1486 | )))|((( | ||
| 1487 | IT Admin | ||
| 1488 | )))|((( | ||
| 1489 | mksp-vs-owner | ||
| 1490 | )))|((( | ||
| 1491 | Vorstand | ||
| 1492 | )))|((( | ||
| 1493 | IT Admin | ||
| 1494 | ))) | ||
| 1495 | |||
| 1496 | == Workflows == | ||
| 1497 | |||
| 1498 | Paperless Workflows können zur Automatisierung verschiedener Tasks eingesetzt werden. In diesem Fall werden zwei Fälle damit abgedeckt: | ||
| 1499 | |||
| 1500 | * 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. | ||
| 1501 | * 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. | ||
| 1502 | |||
| 1503 | = Offene Punkte = | ||
| 1504 | |||
| 1505 | * Docuseal Logging + Monitoring | ||
| 1506 | * N8n Error Handling |