Betriebsleitfaden

Dieser Leitfaden zeigt Schritt für Schritt, wie Sie mit der CLI Prozesse deployen, starten, überwachen und bei Fehlern eingreifen.

Voraussetzungen

• Die CLI ist installiert
• Sie sind mit einer Engine verbunden

1. Deployment von Prozessmodellen

Um BPMN-Prozesse mit der Engine ausführen zu können, müssen diese zunächst an die Engine übertragen werden. Diesen Schritt bezeichnet man als Deployment:

pc engine deploy-files ./processes/BuchAusleihen.bpmn

Als Ergebnis wird die process_model_id des deployten Prozessmodells angezeigt:

Mehrere Dateien deployen

pc engine deploy-files ./processes/*.bpmn

2. Prozessmodelle anzeigen

Vergewissern Sie sich, welche Prozessmodelle deployed sind:

pc engine list-process-models

3. Prozessinstanz starten

Starten Sie eine Prozessinstanz anhand der Prozessmodell-ID:

pc engine start-process-model BuchAusleihen StartEvent_1

Es folgt eine tabellarische Ausgabe der Eigenschaften der gestarteten Prozessinstanz:

4. Prozessinstanz inspizieren

Zeigen Sie die Details einer gestarteten Prozessinstanz an:

pc engine show-process-instance <processInstanceId>

Die Ausgabe enthält den Status, die FlowNode-Instanzen und deren Verlauf:

5. Prozessinstanzen überwachen

Alle Instanzen auflisten

pc engine list-process-instances

Nach Status filtern

Prozessinstanzen können sich in folgenden Status befinden:

• running - Prozess läuft
• finished - Prozess erfolgreich abgeschlossen
• error - Prozess fehlgeschlagen
• terminated - Prozess manuell beendet

# Fehlgeschlagene Instanzen
pc engine list-process-instances --filter-by-state error
 
# Laufende Instanzen
pc engine list-process-instances --filter-by-state running
 
# Abgeschlossene Instanzen
pc engine list-process-instances --filter-by-state finished

6. Fehlerbehandlung

Wenn ein Service, der aus dem Prozess aufgerufen wird, kurzzeitig nicht zur Verfügung steht, können Aktivitäten fehlschlagen. Prozessinstanzen werden dann in den Status error versetzt.

Einzelne Instanz erneut versuchen

pc engine retry-process-instance <processInstanceId>

Alle fehlgeschlagenen Instanzen erneut versuchen

pc engine lsi --filter-by-state error | pc engine retry-process-instance

Oder mit Template-Pipes:

pc engine lsi --filter-by-state error | pc engine retry {{.processInstanceId}}

Beispiel-Workflow

Ein typischer Betriebsablauf sieht wie folgt aus:

# 1. Prozessmodelle deployen
pc engine deploy-files ./processes/*.bpmn
 
# 2. Prüfen, ob Deployment erfolgreich war
pc engine list-process-models
 
# 3. Prozess starten
pc engine start-process-model MeinProzess StartEvent_1
 
# 4. Status überwachen
pc engine list-process-instances --filter-by-process-model-id MeinProzess
 
# 5. Bei Fehlern: Details inspizieren
pc engine lsi --filter-by-state error | pc engine show {{.processInstanceId}}
 
# 6. Fehlgeschlagene Instanzen erneut versuchen
pc engine lsi --filter-by-state error | pc engine retry {{.processInstanceId}}

Automatisierung

Für automatisierte Workflows verwenden Sie die JSON-Ausgabe:

# Deployment-Ergebnis in JSON
pc engine deploy-files ./processes/*.bpmn --output json
 
# Deployen und direkt starten
pc engine deploy-files process.bpmn | pc engine start {{.processModelId}}
 
# Fehlerhafte Instanzen automatisch wiederholen
pc engine lsi --filter-by-state error | pc engine retry {{.processInstanceId}}