Skip to Content
Low-CodeAPI ReferenceEngine Nodes Referenz

Engine Nodes Referenz

Diese Referenz dokumentiert alle Engine Nodes, die fuer die Integration von Node-RED-Flows mit der Engine verfuegbar sind.

processcube-engine-config

Kategorie: Konfiguration

Die zentrale Konfigurationsnode fuer die Engine-Verbindung. Sie wird von allen anderen Engine Nodes referenziert.

EigenschaftTypBeschreibung
NameStringBezeichnung der Konfiguration (z.B. “Produktion”, “Entwicklung”)
Engine URLStringURL der Engine (z.B. http://engine:8000)

process-start

Kategorie: Prozesssteuerung

Startet eine neue Prozessinstanz in der Engine.

Konfiguration:

EigenschaftTypBeschreibung
Engine URLConfigReferenz auf processcube-engine-config
ProcessModelStringID des zu startenden Prozessmodells
StarteventStringID des Startevents

Input (msg):

PropertyTypBeschreibung
msg.payloadObjectStartparameter fuer den Prozess (optional)

Output (msg):

PropertyTypBeschreibung
msg.payloadObjectDaten der gestarteten Prozessinstanz
msg.payload.processInstanceIdStringID der neuen Prozessinstanz

Beispiel:

// Prozess mit Startparametern starten msg.payload = { customerName: "Max Mustermann", orderId: "ORD-2025-001", priority: "high" };

process-terminate

Kategorie: Prozesssteuerung

Beendet eine laufende Prozessinstanz in der Engine.

Konfiguration:

EigenschaftTypBeschreibung
Engine URLConfigReferenz auf processcube-engine-config

Input (msg):

PropertyTypBeschreibung
msg.payloadStringInstanz-ID der zu terminierenden Prozessinstanz

Output (msg):

PropertyTypBeschreibung
msg.payloadStringInstanz-ID der terminierten Prozessinstanz

usertask-input

Kategorie: UserTask

Sucht nach UserTasks auf der Engine und gibt diese zur Bearbeitung in Node-RED aus.

Konfiguration:

EigenschaftTypBeschreibung
Engine URLConfigReferenz auf processcube-engine-config
QueryJSONFilter-Query fuer die UserTask-Suche
Force Send Payload as ArrayBooleanErgebnis immer als Array senden
Send MultiBooleanFuer jeden UserTask eine separate Nachricht senden

Input (msg):

PropertyTypBeschreibung
msg.payloadObjectQuery-Parameter fuer die Suche (optional, ueberschreibt Konfiguration)

Output (msg):

PropertyTypBeschreibung
msg.payloadObject/ArrayGefundene UserTask(s) mit allen Details
msg.payload.flowNodeInstanceIdStringID der FlowNode-Instanz
msg.payload.userTaskConfigObjectKonfiguration des UserTasks (Formularfelder etc.)

usertask-output

Kategorie: UserTask

Sendet das Ergebnis eines bearbeiteten UserTasks an die Engine zurueck.

Konfiguration:

EigenschaftTypBeschreibung
Engine URLConfigReferenz auf processcube-engine-config
ResultString/JSONataSpeicherort oder Definition des Resultats

Input (msg):

PropertyTypBeschreibung
msg.payloadObjectResultat, das an die Engine gesendet wird
msg.flowNodeInstanceIdStringID der UserTask-Instanz (von usertask-input)

Beispiel:

// UserTask-Ergebnis senden msg.payload = { approved: true, comment: "Freigabe erteilt", approvedBy: "admin" };

usertask-event-listener

Kategorie: Events

Abonniert Events, die sich auf UserTasks beziehen.

Konfiguration:

EigenschaftTypBeschreibung
Engine URLConfigReferenz auf processcube-engine-config
ProcessModelIdStringID des Prozessmodells (optional)
EventAuswahlnew, finished, reserved, reservation-canceled
QueryJSONZusaetzliche Filterkriterien

Output (msg):

{ "flowNodeInstanceId": "...", "userTaskEvent": { /* Event-Details */ }, "userTask": { /* UserTask-Instanzobjekt */ }, "action": "new", "type": "usertask" }

process-event-listener

Kategorie: Events

Abonniert prozessbezogene Events der Engine.

Konfiguration:

EigenschaftTypBeschreibung
Engine URLConfigReferenz auf processcube-engine-config
ProcessModelIdStringID des Prozessmodells
EventAuswahlSiehe Event-Liste unten
QueryJSONZusaetzliche Filterkriterien

Verfuegbare Events:

EventBeschreibung
startingProzessinstanz wird gestartet
startedProzessinstanz wurde gestartet
resumedPausierte Instanz wird fortgesetzt
finishedInstanz erfolgreich beendet
terminatedInstanz wurde terminiert
errorFehler in der Instanz
owner-changedBesitzer der Instanz geaendert
instance-deletedInstanz wurde geloescht
is-executable-changedAusfuehrbarkeitsstatus geaendert
deployedProzessmodell deployed
undeployedProzessmodell entfernt

Output (msg):

{ "processInstanceId": "...", "action": "started", "type": "process" }

externaltask-input

Kategorie: External Task

Erstellt eine Subscription fuer External Tasks mit einem bestimmten Topic, lockt diese und gibt sie zur Abarbeitung in Node-RED aus.

Konfiguration:

EigenschaftTypBeschreibung
Engine URLConfigReferenz auf processcube-engine-config
TopicStringTopic der External Task

Output (msg):

PropertyTypBeschreibung
msg.payloadObjectDaten der External Task aus der Engine
msg.flowNodeInstanceIdStringID der FlowNode-Instanz
msg.externalTaskIdStringID der External Task

Umgebungsvariablen:

VariableStandardBeschreibung
NODE_RED_ETW_HEARTBEAT_LOGGINGtrueHeartbeat-Requests in Logs ausgeben
NODE_RED_ETW_STEP_LOGGINGtrueFortschritt der External Task protokollieren
NODE_RED_ETW_STOP_IF_FAILEDfalseBei Fehler External Task stoppen

externaltask-output

Kategorie: External Task

Sendet das Ergebnis einer in Node-RED bearbeiteten External Task an die Engine zurueck.

Input (msg):

PropertyTypBeschreibung
msg.payloadObjectResultat der External Task
(Metadaten)-Automatisch von externaltask-input bereitgestellt

externaltask-error

Kategorie: External Task

Meldet einen Fehler bei der Verarbeitung einer External Task an die Engine.

Konfiguration:

EigenschaftTypBeschreibung
Error CodeStringFehlercode, der an die Engine uebergeben wird

Input (msg):

PropertyTypBeschreibung
msg.payloadObjectZusaetzliche Fehlerdaten (optional)
(Metadaten)-Automatisch von externaltask-input bereitgestellt

Beispiel-Flow:

[externaltask-input: Topic "pdf-erstellen"] → [function: PDF generieren] → (Erfolg) → [externaltask-output] → (Fehler) → [externaltask-error: Code "PDF_GENERATION_FAILED"]

externaltask-event-listener

Kategorie: Events

Abonniert Events, die sich auf External Tasks beziehen.

Konfiguration:

EigenschaftTypBeschreibung
Engine URLConfigReferenz auf processcube-engine-config
ProcessModelIdStringID der External Task
EventAuswahlcreated, locked, unlocked

Output (msg):

{ "flowNodeInstanceId": "...", "externalTaskEvent": { /* Event-Daten */ }, "action": "created", "type": "externaltask" }

processdefinition-query

Kategorie: Abfragen

Sucht auf der Engine nach Prozessdefinitionen oder Prozessmodellen.

Konfiguration:

EigenschaftTypBeschreibung
Engine URLConfigReferenz auf processcube-engine-config
QueryJSONFilter-Query fuer die Suche
Models onlyBooleanNur Prozessmodelle zurueckgeben

Input (msg):

PropertyTypBeschreibung
msg.payloadObjectQuery-Parameter (optional)

Output (msg):

PropertyTypBeschreibung
msg.payloadArrayGefundene Prozessdefinitionen/Modelle
msg.totalCountNumberGesamtanzahl der Treffer

processinstance-query

Kategorie: Abfragen

Sucht auf der Engine nach Prozessinstanzen.

Konfiguration:

EigenschaftTypBeschreibung
Engine URLConfigReferenz auf processcube-engine-config
QueryJSONFilter-Query fuer die Suche

Input (msg):

PropertyTypBeschreibung
msg.payloadObjectQuery-Parameter (optional)

Output (msg):

PropertyTypBeschreibung
msg.payloadArrayGefundene Prozessinstanzen
msg.totalCountNumberGesamtanzahl der Treffer

signal-event-trigger

Kategorie: Events

Loest ein Signal-Event in der Engine aus.

Konfiguration:

EigenschaftTypBeschreibung
Engine URLConfigReferenz auf processcube-engine-config
Signal EventStringName des auszuloesenden Signals

Input (msg):

PropertyTypBeschreibung
msg.processinstanceidStringID der Prozessinstanz
msg.payloadObjectOptionaler Payload fuer das Signal

Output (msg):

PropertyTypBeschreibung
msg.payloadObjectResultat des Event-Triggers

message-event-trigger

Kategorie: Events

Loest ein Message-Event in der Engine aus.

Konfiguration:

EigenschaftTypBeschreibung
Engine URLConfigReferenz auf processcube-engine-config
Message EventStringName der auszuloesenden Message

Input (msg):

PropertyTypBeschreibung
msg.processinstanceidStringID der Prozessinstanz
msg.payloadObjectOptionaler Payload fuer die Message

Output (msg):

PropertyTypBeschreibung
msg.payloadObjectResultat des Event-Triggers

dataobject-instance-query

Kategorie: Abfragen

Fragt DataObject-Instanzen auf der Engine ab. DataObjects sind Datenobjekte, die innerhalb eines BPMN-Prozesses definiert sind.

Konfiguration:

EigenschaftTypBeschreibung
Engine URLConfigReferenz auf processcube-engine-config
QueryJSONFilter-Query fuer die Suche

Input (msg):

PropertyTypBeschreibung
msg.payloadObjectQuery-Parameter (optional)

Output (msg):

PropertyTypBeschreibung
msg.payloadArrayGefundene DataObject-Instanzen

check-authorization

Kategorie: Autorisierung

Prueft, ob der aktuelle Benutzer eine bestimmte Berechtigung besitzt.

Konfiguration:

EigenschaftTypBeschreibung
Engine URLConfigReferenz auf processcube-engine-config

Input (msg):

PropertyTypBeschreibung
msg.payloadObjectAutorisierungsparameter (Claim, Ressource)

Output (msg):

PropertyTypBeschreibung
msg.payloadBooleantrue wenn autorisiert, false wenn nicht

Weiterführende Informationen