Der VereinWiki-Quellcode von N8n Workflow Engine
Version 14.1 von Daniel Herrmann am 2026/02/22 19:52
Verstecke letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | 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). |
| 2 | |||
| |
9.1 | 3 | = Inhaltsverzeichnis = |
| 4 | |||
| 5 | {{toc/}} | ||
| 6 | |||
| |
3.1 | 7 | = Workflow Übersicht = |
| |
1.1 | 8 | |
| |
3.2 | 9 | Workflows bestehen grundsätzlich aus einem oder mehreren **Triggern** und einer oder mehreren **Aktionen**. Im Folgenden werden nur die für die Mitgliederverwaltung relevanten Workflows beschrieben, N8n kann aber natürlich auch für andere Automatisierung verwendet werden. |
| 10 | |||
| |
3.4 | 11 | == Workflows für Dokumente == |
| 12 | |||
| 13 | === Document Consumed Workflow === | ||
| 14 | |||
| |
14.1 | 15 | Dieser Workflow wird durch das [[Paperless Post-Consume Script>>doc:PROJ.Digitale Mitgliederverwaltung.Paperless NGX.WebHome]] ausgelöst, immer dann, wenn ein **QR Code mit dem korrekten Inhalt **erkannt wird. Die Idee hier ist, dass **ausgedruckte und handschriftliche Dokumente **automatisch verarbeitet werden können. |
| |
3.4 | 16 | |
| |
14.1 | 17 | Im Prinzip ersetzt dieser Workflow den Docuseal Webhook, der automatisch dem Backend bescheid gibt, wenn alle Parteien unterschrieben haben. Bei ausgedruckten Dokumenten passiert dies stattdessen hierüber. |
| 18 | |||
| 19 | [[image:1771785973968-394.png||height="150"]] | ||
| 20 | |||
| 21 | Der Workflow: | ||
| 22 | |||
| 23 | * wird über ein Webhook vom Post Consume Script ausgelesen. Als Inhalt wird der Inhalt des dekodierten QR Codes übergeben | ||
| 24 | * nur handschriftlich unterschriebene Dokumente werden verarbeitet | ||
| 25 | * dem Backend wird signalisiert, dass das Dokument erfolgreich verarbeitet wurde | ||
| 26 | |||
| 27 | Als Konsequenz kann das Backend weitere automatische Aktionen ausführen, beispielsweise vorläufige oder dauerhafte Berechtigungen eintragen. | ||
| 28 | |||
| |
3.4 | 29 | === Paperless Papierkorb === |
| 30 | |||
| |
14.1 | 31 | **In Paperless kann nur der Owner Dokumente in den Papierkorb verschieben**. Dies lässt sich leider nicht anders konfigurieren, sodass wir uns hier mit einem Workaround behelfen: die Mitgliederverwaltung und/oder der Vorstand können dem Dokument **ein Tag zuweisen**. **Dieses Tag löst einen Workflow in Paperless aus:** |
| |
3.4 | 32 | |
| |
14.1 | 33 | [[image:1771786279823-587.png||height="250"]] |
| 34 | |||
| 35 | Dieser Workflow löst zwei Dinge aus (leider ist Dokument löschen keine verfügbare Aktion): | ||
| 36 | |||
| 37 | * er entfernt das Tag wieder, um Rekursion zu vermeiden | ||
| 38 | * und löst ein N8n Webhook aus | ||
| 39 | |||
| 40 | **Der N8n Workflow löscht dann das Dokument.** | ||
| 41 | |||
| 42 | [[image:1771786234093-932.png||height="150"]] | ||
| 43 | |||
| |
3.4 | 44 | == Cron Jobs - Sync von Daten == |
| 45 | |||
| |
3.3 | 46 | === Sync Tags für Einweisungen === |
| 47 | |||
| 48 | ToDo | ||
| 49 | |||
| 50 | === Sync Document Types === | ||
| 51 | |||
| 52 | ToDo | ||
| 53 | |||
| |
3.4 | 54 | == Backend Event Workflows == |
| |
3.3 | 55 | |
| |
3.5 | 56 | Bestimmte Events aus dem Backend werden über NATS als Event gepublished. Details dazu sind auf der [[Seite zu NATS>>doc:PROJ.Digitale Mitgliederverwaltung.Technische Dokumentation.NATS Setup.WebHome]] beschrieben. Hier werden die Events beschrieben, die Paperless betreffen: |
| |
1.1 | 57 | |
| |
4.1 | 58 | === mksp.docuseal.signature.completed === |
| |
3.5 | 59 | |
| |
9.2 | 60 | Dieses Event wird ausgelöst, wenn im Backend ein Signatur-Prozess abgeschlossen ist (d.h. alle Parteien haben unterschrieben und die Unterschrift wurde im Backend erfasst). Dies kann auf zwei Arten passieren: |
| |
3.3 | 61 | |
| |
14.1 | 62 | * Bei **rein digitalen Signaturen** durch einen über **Docuseal ausgelösten Webhook** |
| 63 | * Bei **handschriftlich** unterschrieben Zetteln durch **Einscannen** und den oben beschrieben **"Document Consumed" N8n Workflow** | ||
| |
9.2 | 64 | |
| |
14.1 | 65 | [[image:1771785764191-239.png||height="150"]] |
| 66 | |||
| 67 | **Der Workflow löst nur bei digitalen Dokumenten eine Aktion aus**. Bei handschriftlich unterschriebenen Dokumenten ist das Dokument bereits eingescannt. Für digital unterschriebene Signaturen: | ||
| 68 | |||
| 69 | * wird der Status der Submission aus Docuseal ausgelesen | ||
| 70 | * wird das PDF mit den Unterschriften aller Parteien runtergeladen... | ||
| 71 | * und anschließend in Docuseal hochgeladen und dort verarbeitet. | ||
| 72 | |||
| |
4.1 | 73 | === mksp.backend.user.created === |
| |
3.5 | 74 | |
| |
5.3 | 75 | Dieser Workflow wird immer dann getriggert, wenn im Backend ein **neuer User** angelegt wird. Die Informationen aus der NATS Nachricht werden dann verwendet, um den **Korrespondenten in Paperless anzulegen**. |
| |
3.5 | 76 | |
| |
5.2 | 77 | [[image:1771784637258-114.png||height="200"]] |
| 78 | |||
| |
5.3 | 79 | Die folgenden Aktionen werden ausgeführt: |
| |
5.2 | 80 | |
| |
8.1 | 81 | 1. Parallel werden **alle Gruppen und Benutzer **aus Paperless ausgelesen |
| 82 | 1. Es wird auf die relevanten Gruppen und Benutzer gefiltert. Ziel ist es, **die ID der entsprechenden Gruppen und Benutzer auszulesen**. Wir sind **interessiert an den Gruppen für die Mitgliederverwaltung und die IT Admins** sowie dem statischen **MV Owner**. | ||
| 83 | 1. Zuletzt wird der Subflow "Create Paperless Correspondent" angelegt. Dieser bekommt als Info: | ||
| 84 | 11. **firstname** - aus NATS Trigger | ||
| 85 | 11. **lastname** - aus NATS Trigger | ||
| 86 | 11. **isGuest** - true wenn membership_number in NATS Trigger = null, false otherwise | ||
| 87 | 11. **membership_number** - aus NATS Trigger | ||
| 88 | 11. **user_id** - aus NATS Trigger | ||
| 89 | 11. **owner_id** - ID des MV Data Owner Benutzers | ||
| 90 | 11. **permissions** - siehe unten | ||
| 91 | 11. **backend_url** - URL des Makerspace Backends | ||
| |
5.3 | 92 | |
| |
8.1 | 93 | Der Subflow erzeugt dann den Display-Namen des Korrespondenten und **speichert die Paperless-ID über die Backend-API zurück ins Backend.** Der **Display-Name **setzt sich wie folgt zusammen: |
| 94 | |||
| 95 | |=Nutzer-Typ|=Format|=Beispiel | ||
| 96 | |Mitglied|Vorname Nachname (#Mitgliedsnummer)|Daniel Herrmann (#250) | ||
| 97 | |Gast|Vorname Nachname (Gast #Nutzer-ID)|Daniel Herrmann (Gast #1) | ||
| 98 | |||
| 99 | Die **Berechtigungen** werden dabei wie folgt gesetzt: | ||
| 100 | |||
| 101 | {{code language="none"}} | ||
| 102 | {"view":{"users":[],"groups":[{{ $('Static Data').item.json.mv_group_id }}]},"change":{"users":[],"groups":[{{ $('Static Data').item.json.it_admin_group_id }}]}} | ||
| 103 | {{/code}} | ||
| 104 | |||
| 105 | D.h. Owner (und damit alle Rechte) hat der statische MV Owner Nutzer. Alle Mitglieder der Gruppe "Mitgliederverwaltung" können den Korrespondenten sehen (notwendig für Zuweisung und Filterung), IT-Admins können diese verändern. | ||
| 106 | |||
| |
4.1 | 107 | === mksp.backend.user.converted_to_guest === |
| |
3.5 | 108 | |
| |
8.1 | 109 | Dieser Workflow wird dann ausgelöst, wenn ein Mitglied den Verein verlässt und daher zum Gast wird. |
| |
4.1 | 110 | |
| |
8.1 | 111 | [[image:1771785245954-780.png||height="150"]] |
| 112 | |||
| 113 | Alle notwendigen Daten (inklusive der Paperless Korrespondent-ID) sind im NATS Event vorhanden. Es wird also lediglich ein neuer Display-Name erzeugt (Format: siehe Tabelle oben) und der Korrespondent wird aktualisiert. | ||
| 114 | |||
| |
4.1 | 115 | === mksp.backend.user.converted_to_member === |
| 116 | |||
| |
9.1 | 117 | Dieser Workflow wird dann ausgelöst, wenn ein neues Mitglied dem Verein beitritt. |
| |
8.1 | 118 | |
| 119 | [[image:1771785309574-242.png||height="150"]] | ||
| 120 | |||
| 121 | Alle notwendigen Daten (inklusive der Paperless Korrespondent-ID) sind im NATS Event vorhanden. Es wird also lediglich ein neuer Display-Name erzeugt (Format: siehe Tabelle oben) und der Korrespondent wird aktualisiert. | ||
| 122 | |||
| 123 | == Subflows == | ||
| 124 | |||
| |
4.1 | 125 | ToDo |
| 126 | |||
| |
3.1 | 127 | = Community Nodes = |
| |
1.1 | 128 | |
| 129 | asd |