@openinc/node-red-contrib-openservice 1.0.2
Node-RED nodes for open.SERVICE: create and update tickets, maintenance plans and executions — plus clearly marked demo-data generators
@openinc/node-red-contrib-openservice
Node-RED-Nodes für open.SERVICE: Tickets, Wartungspläne und Durchführungen aus Flows anlegen und ändern — für Integrationen in Produktion (Maschinen, SPS, Leitsysteme, Importe) und, klar getrennt, zum Erzeugen von Demodaten.
Die Nodes rufen die Automatisierungs-Endpunkte des open.INC-Parse-Servers auf
(@openinc/parse-server-opendash, features/openservice/automation). Dort
läuft dieselbe Logik wie im Frontend und bei den Alarm-Aktionen: Formular-
Konfiguration mit Vorbelegungen und Regeln, laufende Nummer, Berechtigungen,
Benachrichtigungen, Vorlagen.
Voraussetzungen
- open.INC-Parse-Server mit den Endpunkten
openinc-openservice-create-ticket,-update-ticket,-create-schedule,-record-execution @openinc/node-red-contrib-openinc-parse— dessen Konfigurations-Nodeopeninc-parse-configist die Verbindung. Wird als Abhängigkeit mitinstalliert.- Node-RED ≥ 3, Node.js ≥ 18
Verbindung und Rechte
| Verbindung | Mandant | Rechte | Einsatz |
|---|---|---|---|
| Session-Token eines techn. Benutzers | der des Benutzers | wie im Frontend (Rolle des Benutzers) | Produktion |
| Master-Key | im Node wählen | Server schreibt als er selbst | Demo, Skripte |
Mit Master-Key wählt jeder Node den Mandanten und optional den
handelnden Benutzer (Ersteller, Kommentar-Autor, Durchführender — immer ein
Benutzer dieses Mandanten). Beides lässt sich pro Nachricht mit
msg.tenantId / msg.actingUserId überschreiben.
Die Auswahllisten im Editor (Mandant, Formular, Vorlage, Maschine, …) lädt die Runtime über die deployte Verbindung — nach dem Anlegen der Verbindung also einmal deployen.
Nodes für Produktion (Kategorie „open.SERVICE“)
| Node | Endpunkt | macht |
|---|---|---|
| Ticket anlegen | openinc-openservice-create-ticket |
Ticket über ein Ticketformular, mit Status, Maschine, Ausfall |
| Ticket ändern | openinc-openservice-update-ticket |
Status, Felder, Ausfallende, Zuweisung, Kommentar |
| Wartungsplan anlegen | openinc-openservice-create-schedule |
einmaliger Termin oder wiederkehrender Plan, aus Vorlage |
| Wartung erfassen | openinc-openservice-record-execution |
abgeschlossenes Durchführungsprotokoll |
Die Einstellungen eines Nodes sind Vorgaben; msg.payload überschreibt sie
und kann jeden weiteren Parameter des Endpunkts tragen. Die Hilfe jedes Nodes
listet sie auf. Fehler des Servers landen beim catch-Node
(msg.error.message, msg.error.code).
Herkunft (origin) — Tickets ohne gespeicherte Id wiederfinden
Konvention: automation:node-red:<kennung>, z. B.
automation:node-red:linie2:notaus. Das Frontend zeigt solche Datensätze als
„Automatisch erzeugt von Node-RED“. Mit Nur ein offenes Ticket je Herkunft
(unique) entsteht kein zweites Ticket, solange eines offen ist; Ticket
ändern findet das offene Ticket über payload.origin. Beispiel:
examples/Stoerung-als-Ticket.json (Import → Beispiele).
Nodes für Demodaten (Kategorie „open.SERVICE Demo“)
Erzeugen Demodaten — nicht in einem produktiven Mandanten verwenden. Alles, was sie anlegen, trägt die Herkunft
automation:demo:…und wird im Frontend als „Demodaten“ markiert.
| Node | macht |
|---|---|
| DEMO: Stammdaten anlegen | Status (nur fehlende), Tags, Projekte, Werk mit Hallen und Maschinen, Vorlagen, 8 Pläne — idempotent |
| DEMO: Ticket-Simulation | je Takt: ggf. neues Ticket (Störung/Wartung/Prüfung), offene Tickets laufen durch die Status |
| DEMO: Wartungs-Simulation | je Takt: fällige Pläne durchführen (je Plan pünktlich/spät/unregelmäßig), Befunde, Einzeltermine |
Die Demo läuft mit der Zeit: Start ist „jetzt“, nach ein paar Tagen Laufzeit gibt es eine glaubwürdige Historie — Tickets mit Kommentaren, Ausfallzeiten (MTBF/MTTR), Protokolle, Prognosen der Wartungspläne. Wählt man in DEMO: Stammdaten die Quelle der Demo-Sensorik, erben die Maschinen deren Source-Tag und der KPI-Job rechnet die Kennzahlen neben den Sensordaten.
Fertiger Flow: examples/Demodaten-Instanz.json — Verbindung, Mandant,
Verantwortlichen und Techniker setzen, deployen.
Entwicklung
npm install
npm run build # tsc + Editor-Dateien nach dist/
npm test # Build + Tests (Node-RED-Runtime gegen einen Parse-Mock)
npm run dev # tsc --watch
npm run pack # Build + .tgz zum Installieren in Node-RED (Palette → Upload)
Lokal einbinden: im Node-RED-Benutzerverzeichnis
npm install <pfad>/node-red-contrib-openservice und Node-RED neu starten.
Aufbau:
src/lib/client.ts— Verbindung überopeninc-parse-config, Aufruf der Endpunktesrc/lib/lookup.ts— Admin-Route/openservice/lookupfür die Auswahllistensrc/lib/demo/— Demo-Katalog, Stammdaten, Simulationensrc/nodes/<typ>/— Runtime (.ts) und Editor (.html) je Noderesources/openservice-editor.js— gemeinsame Editor-Helfer (Picker)scripts/editor-spec.py— erzeugt die Editor-HTML aus einer Spezifikation
Lizenz
MIT © open.INC GmbH