Skip to Content
CLIProcesses-Befehle

Processes-Befehle

Der Namespace pc processes bietet jedes auf der verbundenen Engine deployte Prozessmodell als eigenes Kommando an.

pc processes <processModelId> startet eine Instanz — mit denselben Parametern wie pc engine start-process-model. Hat das Modell nur ein Start-Event, wird es automatisch gewählt.

Verwendung

pc processes # deployte Prozessmodelle auflisten pc processes <processModelId> [startEventId] [options]

Prozessmodelle auflisten

pc processes ohne Argument gibt die deployten Prozessmodelle als Tabelle aus:

pc processes
SpalteInhalt
IDID des Prozessmodells
NameAnzeigename
Start Event IDsIDs der Start-Events
DocumentationBeschreibung aus der BPMN-<documentation> auf Prozessebene

Die Spalte Documentation pflegst du im Studio am Prozess selbst. In der Text-Tabelle wird sie auf 80 Zeichen gekürzt, in der JSON-Ausgabe steht sie vollständig:

pc processes -o json | jq '.result[] | {id, documentation}'

pc processes --help zeigt weiterhin die Hilfe mit den Prozessmodellen als Sub-Kommandos. Bei Weiterleitung in eine Pipe gibt pc processes automatisch JSON aus.

Argumente

NameObligatorischBeschreibung
processModelIdJaID des deployten Prozessmodells
startEventIdNeinID des Start-Events — optional, wenn das Modell nur ein Start-Event hat

Optionen

Es gelten dieselben Optionen wie bei pc engine start-process-model:

Name, KürzelDefaultBeschreibung
--correlation-idSetzt eine vordefinierte Correlation ID für die Prozessinstanz
--output, -otextSteuert das Ausgabeformat: text oder json
--start-token{}Setzt den Start-Token aus einem JSON-String
--start-token-from-fileLiest den Start-Token als JSON aus einer Datei
--start-token-from-stdinLiest den Start-Token als JSON von STDIN
--waitWartet, bis die gestartete Prozessinstanz zu Ende gelaufen ist

Beispiele

# Deployte Prozessmodelle als Tabelle auflisten (inkl. Documentation) pc processes # Prozessmodell starten (Start-Event automatisch, wenn nur eines existiert) pc processes MyOrder_Process # Bestimmtes Start-Event starten und auf das Ergebnis warten pc processes MyOrder_Process StartEvent_1 --wait # Mit Start-Token starten pc processes MyOrder_Process --start-token '{"amount": 42}'

Tab-Completion

Mit installierter Shell-Completion (pc completion --install) schlägt pc processes <TAB> die deployten Prozessmodelle vor.

Die Prozessliste wird nur von der Engine abgefragt, wenn processes tatsächlich aufgerufen wird — alle anderen Kommandos bleiben offline. Ist die Engine nicht erreichbar, bleibt pc processes --help trotzdem nutzbar.