Skip to Content
Low-CodeAPI ReferenceAPI-Referenz

API-Referenz

Diese Referenz dokumentiert alle ProcessCube®-spezifischen Nodes und Extensions, die in der LowCode-Umgebung verfuegbar sind. Sie ist in drei Bereiche gegliedert.

Bereiche

Engine Nodes

Die Engine Nodes bilden die Schnittstelle zwischen Node-RED und der Engine. Sie ermoeglichen es, BPMN-Prozesse zu starten, UserTasks zu bearbeiten, Events auszuloesen und Prozessdaten abzufragen. Alle Engine Nodes benoetigen eine processcube-engine-config Node fuer die Verbindungskonfiguration.

Enthaltene Nodes:

  • Prozesssteuerung (Start, Terminate)
  • UserTask-Verarbeitung (Input, Output, Event Listener)
  • External-Task-Worker (Input, Output, Error, Event Listener)
  • Abfragen (Processdefinition Query, Processinstance Query, DataObject Instance Query)
  • Events (Signal Event Trigger, Message Event Trigger, Process Event Listener)
  • Autorisierung (Check Authorization)

UI Nodes

Die UI Nodes erweitern die Dashboard-2-Bibliothek um ProcessCube®-spezifische Oberflaechenkomponenten. Sie ermoeglichen die Erstellung von Benutzeroberflächen fuer UserTasks, Datenvisualisierung und Prozessfortschritt.

Enthaltene Nodes:

  • Dynamic Form (UserTask-Formulare)
  • Dynamic Table (Datentabellen)
  • UI Page Navigation (Seitensteuerung)
  • Audio Capture (Audioaufnahme)
  • Process Progress Bar (Prozessfortschritt)

Runtime Extensions

Die Runtime Extensions erweitern die Node-RED-Runtime um Funktionen fuer den produktiven Betrieb. Sie umfassen Speicheroptimierung, Health Checks, Datenbankmigrationen, Ausfuehrungstracing und Metriken.

Enthaltene Extensions:

  • Storage Extension (Git-optimierte Flow-Speicherung)
  • Readiness Probe (Kubernetes Health Checks)
  • Migration Extension (Datenbank-Migrationen)
  • Trace Execution (Flow-Ausfuehrungsverfolgung)
  • Metrics (Prometheus-Metriken)

Allgemeine Hinweise

Engine-Konfiguration

Alle Engine Nodes verwenden die processcube-engine-config Node, um die Verbindung zur Engine herzustellen. Konfigurieren Sie diese einmal und waehlen Sie sie in allen Engine Nodes aus.

Fehlerbehandlung

Alle Nodes unterstuetzen die Standard-Node-RED-Fehlerbehandlung ueber Catch Nodes. Im Fehlerfall wird msg.error mit Details zum aufgetretenen Fehler befuellt.

Umgebungsvariablen

Viele Konfigurationsoptionen koennen ueber Umgebungsvariablen gesteuert werden. Details finden Sie in der Konfigurationsreferenz.