Skip to Content
CLIEngine-Befehlepc engine send-message

pc engine send-message

Sendet ein Message-Event an die verbundene Engine — optional gezielt an eine bestimmte Prozessinstanz.

Prozesse, die auf ein Message-Intermediate-Catch-Event oder ein Message-Start-Event warten, werden durch die Message ausgelöst.

Verwendung

pc engine send-message <messageName> [options] pc engine msg <messageName> [options]

Argumente

NameObligatorischBeschreibung
messageNameJaName der zu sendenden Message

Optionen

Name, KürzelDefaultBeschreibung
--process-instance-idSendet die Message nur an die angegebene Prozessinstanz
--correlation-idSetzt eine eigene Correlation ID für die Message (erfordert Engine v19.2.0)
--payloadSetzt den Message-Payload aus einem JSON-String
--payload-from-fileLiest den Message-Payload als JSON aus einer Datei
--payload-from-stdinLiest den Message-Payload als JSON von STDIN
--output, -otextSteuert das Ausgabeformat: text oder json

Beispiele

Message senden

pc engine send-message OrderReceived

Message mit Payload senden

pc engine send-message OrderReceived --payload '{"orderId": 42}'

Message an eine bestimmte Prozessinstanz senden

pc engine send-message OrderReceived --process-instance-id <ID>

Payload aus Datei oder STDIN

pc engine send-message OrderReceived --payload-from-file order.json cat order.json | pc engine send-message OrderReceived --payload-from-stdin

Als Eingabe-Format wird JSON5  verwendet, dessen Regeln weniger strikt sind als bei normalem JSON (z.B. erlaubt JSON5 Kommentare). Die Ausgabe der CLI ist immer striktes, standardkonformes JSON.