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.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Name | String | Bezeichnung der Konfiguration (z.B. “Produktion”, “Entwicklung”) |
| Engine URL | String | URL der Engine (z.B. http://engine:8000) |
process-start
Kategorie: Prozesssteuerung
Startet eine neue Prozessinstanz in der Engine.
Konfiguration:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Engine URL | Config | Referenz auf processcube-engine-config |
| ProcessModel | String | ID des zu startenden Prozessmodells |
| Startevent | String | ID des Startevents |
Input (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Object | Startparameter fuer den Prozess (optional) |
Output (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Object | Daten der gestarteten Prozessinstanz |
msg.payload.processInstanceId | String | ID 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:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Engine URL | Config | Referenz auf processcube-engine-config |
Input (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | String | Instanz-ID der zu terminierenden Prozessinstanz |
Output (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | String | Instanz-ID der terminierten Prozessinstanz |
usertask-input
Kategorie: UserTask
Sucht nach UserTasks auf der Engine und gibt diese zur Bearbeitung in Node-RED aus.
Konfiguration:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Engine URL | Config | Referenz auf processcube-engine-config |
| Query | JSON | Filter-Query fuer die UserTask-Suche |
| Force Send Payload as Array | Boolean | Ergebnis immer als Array senden |
| Send Multi | Boolean | Fuer jeden UserTask eine separate Nachricht senden |
Input (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Object | Query-Parameter fuer die Suche (optional, ueberschreibt Konfiguration) |
Output (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Object/Array | Gefundene UserTask(s) mit allen Details |
msg.payload.flowNodeInstanceId | String | ID der FlowNode-Instanz |
msg.payload.userTaskConfig | Object | Konfiguration des UserTasks (Formularfelder etc.) |
usertask-output
Kategorie: UserTask
Sendet das Ergebnis eines bearbeiteten UserTasks an die Engine zurueck.
Konfiguration:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Engine URL | Config | Referenz auf processcube-engine-config |
| Result | String/JSONata | Speicherort oder Definition des Resultats |
Input (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Object | Resultat, das an die Engine gesendet wird |
msg.flowNodeInstanceId | String | ID 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:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Engine URL | Config | Referenz auf processcube-engine-config |
| ProcessModelId | String | ID des Prozessmodells (optional) |
| Event | Auswahl | new, finished, reserved, reservation-canceled |
| Query | JSON | Zusaetzliche 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:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Engine URL | Config | Referenz auf processcube-engine-config |
| ProcessModelId | String | ID des Prozessmodells |
| Event | Auswahl | Siehe Event-Liste unten |
| Query | JSON | Zusaetzliche Filterkriterien |
Verfuegbare Events:
| Event | Beschreibung |
|---|---|
starting | Prozessinstanz wird gestartet |
started | Prozessinstanz wurde gestartet |
resumed | Pausierte Instanz wird fortgesetzt |
finished | Instanz erfolgreich beendet |
terminated | Instanz wurde terminiert |
error | Fehler in der Instanz |
owner-changed | Besitzer der Instanz geaendert |
instance-deleted | Instanz wurde geloescht |
is-executable-changed | Ausfuehrbarkeitsstatus geaendert |
deployed | Prozessmodell deployed |
undeployed | Prozessmodell 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:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Engine URL | Config | Referenz auf processcube-engine-config |
| Topic | String | Topic der External Task |
Output (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Object | Daten der External Task aus der Engine |
msg.flowNodeInstanceId | String | ID der FlowNode-Instanz |
msg.externalTaskId | String | ID der External Task |
Umgebungsvariablen:
| Variable | Standard | Beschreibung |
|---|---|---|
NODE_RED_ETW_HEARTBEAT_LOGGING | true | Heartbeat-Requests in Logs ausgeben |
NODE_RED_ETW_STEP_LOGGING | true | Fortschritt der External Task protokollieren |
NODE_RED_ETW_STOP_IF_FAILED | false | Bei 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):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Object | Resultat 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:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Error Code | String | Fehlercode, der an die Engine uebergeben wird |
Input (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Object | Zusaetzliche 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:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Engine URL | Config | Referenz auf processcube-engine-config |
| ProcessModelId | String | ID der External Task |
| Event | Auswahl | created, 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:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Engine URL | Config | Referenz auf processcube-engine-config |
| Query | JSON | Filter-Query fuer die Suche |
| Models only | Boolean | Nur Prozessmodelle zurueckgeben |
Input (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Object | Query-Parameter (optional) |
Output (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Array | Gefundene Prozessdefinitionen/Modelle |
msg.totalCount | Number | Gesamtanzahl der Treffer |
processinstance-query
Kategorie: Abfragen
Sucht auf der Engine nach Prozessinstanzen.
Konfiguration:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Engine URL | Config | Referenz auf processcube-engine-config |
| Query | JSON | Filter-Query fuer die Suche |
Input (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Object | Query-Parameter (optional) |
Output (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Array | Gefundene Prozessinstanzen |
msg.totalCount | Number | Gesamtanzahl der Treffer |
signal-event-trigger
Kategorie: Events
Loest ein Signal-Event in der Engine aus.
Konfiguration:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Engine URL | Config | Referenz auf processcube-engine-config |
| Signal Event | String | Name des auszuloesenden Signals |
Input (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.processinstanceid | String | ID der Prozessinstanz |
msg.payload | Object | Optionaler Payload fuer das Signal |
Output (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Object | Resultat des Event-Triggers |
message-event-trigger
Kategorie: Events
Loest ein Message-Event in der Engine aus.
Konfiguration:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Engine URL | Config | Referenz auf processcube-engine-config |
| Message Event | String | Name der auszuloesenden Message |
Input (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.processinstanceid | String | ID der Prozessinstanz |
msg.payload | Object | Optionaler Payload fuer die Message |
Output (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Object | Resultat 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:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Engine URL | Config | Referenz auf processcube-engine-config |
| Query | JSON | Filter-Query fuer die Suche |
Input (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Object | Query-Parameter (optional) |
Output (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Array | Gefundene DataObject-Instanzen |
check-authorization
Kategorie: Autorisierung
Prueft, ob der aktuelle Benutzer eine bestimmte Berechtigung besitzt.
Konfiguration:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Engine URL | Config | Referenz auf processcube-engine-config |
Input (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Object | Autorisierungsparameter (Claim, Ressource) |
Output (msg):
| Property | Typ | Beschreibung |
|---|---|---|
msg.payload | Boolean | true wenn autorisiert, false wenn nicht |
Weiterführende Informationen
- ProcessCube® Konzepte — Engine-Integration verstehen
- UI Nodes Referenz — UI-Komponenten
- Workflow-Integration — Praxisbeispiele