Entwickler Tutorial (Legacy)
Command Line Interface

Command-Line Interface (CLI)

Die ProcessCube CLI ist ein Tool, welches zu Automatisierungszwecken entwickelt wurde. Grundsätzlich bietet die CLI keine exklusiven Funktionen an, macht aber einige Arbeitsschritte bequemer.

Voraussetzungen

  1. Node >= Version 18.0

  2. npm >= Version 10.0

Installation

Bei der Installation stehen zwei Möglichkeiten zur Verfügung. Die erste Möglichkeit ist das Installieren des neuesten Pakets:

npm install --global @5minds/processcube_cli

Die andere Möglichkeit ist es, eine exakte Version zu installieren:

npm install --global @5minds/processcube_cli@2.8.0

Eine Versionsübersicht findet sich hier (opens in a new tab).

Verwendung der CLI

Die CLI lässt sich über den Befehl processcube oder kurz pc verwenden.

Erste Schritte

Nach der erfolgreichen Installation der CLI muss das Studio gestartet und sich mit der CLI eingeloggt werden. Der Befehl dazu lautet:

pc login http://localhost:56000 --root

Mit pc login wird eine Verbindung zur Studio internen Engine, welche unter http://localhost:56000 erreichbar ist, aufgebaut. Der Parameter --root wird für Engine-Instanzen verwendet, welche einen anonymen Zugriff erlauben. Um mehr über die Zugriffsarten zu erfahren, empfiehlt sich die offizielle Dokumentation (opens in a new tab).

Mit dem Befehl pc logout kann die Verbindung wieder getrennt werden.

Kommando-Übersicht

Hier folgt eine kleine Übersicht aller zur Zeit verfügbaren Kommandos. Eine ausführliche Übersicht findet man in der Dokumentation unter Kommandos (opens in a new tab). Dort findet sich zu jedem Kommando eine ausführliche Auflistung der Optionen und Möglichkeiten sowie weitere Beispiele. Da dieser Tutorialabschnitt jedoch nur eine kurze Übersicht darstellen soll, wurden diese zur Vereinfachung weggelassen.

Hilfe

pc --help zeigt alle Befehle, samt zugehörigen Optionen im Terminal an.

Verbindungsstatus

Um sich den Status der aktuellen Sitzung anzuschauen, kann der Befehl pc session-status oder kurz pc st verwendet werden.

Diagramm übertragen

Mit dem Befehl pc deploy-files oder kurt pc deploy können ein oder mehrere Diagramme an die verbundene Engine übertragen werden. Dazu muss dem Befehl der oder die Dateinamen mitgegeben werden. Die Syntax des Befehls lautet:

pc deploy [filenames...] [options]

Hier sind zwei Beispiele für das Deployen von einer bzw. mehrerer Dateien: Eine Datei:

pc deploy example1.bpmn

Mehrerer Dateien:

pc deploy example1.bpmn example2.bpmn

Prozessinstanzen auflisten

pc list-process-instances oder kurz pc lsi zeigt alle Prozessinstanzen der verbundenen Engine. Diese können durch die Optionen des Befehls sortiert und gefiltert werden. Um mehrere Optionen zu verbinden, können diese durch die Pipe | in Form einer Konjunktion bzw. einer „Oder-" verbunden werden.

Die Liste aller Optionen findet man hier (opens in a new tab).

Prozessmodelle auflisten

Mit diesem Befehl pc list-process-models oder kurz pc lsp lassen sich alle Prozessmodelle der verbundenen Engine im Terminal anzeigen. Ebenso wie bei pc lsi lassen sich diese mit dem gleichen Vorgehen filtern und sortieren.

In der Dokumentation (opens in a new tab) findet man eine Auflistung aller Optionen.

Prozessmodelle entfernen

Der Befehl pc remove-process-models oder kurz pc remove dient dem Entfernen von Prozessmodellen aus der verbunden Engine. Dazu muss nur die ID des Modells mit angegeben werden. Es lassen sich auch mehrere Modelle gleichzeitig entfernen.

So sieht die Syntax des Befehls aus:

pc remove [processModelIds...] [options]

Hier sind zwei Beispiele zum Entfernen von Modellen:

Ein Modell:

pc remove example1

Mehrere Modelle:

pc remove example1 example2

Prozessinstanz neu starten

Der Befehl pc retry-process-instance oder kurz pc retry wird verwendet, um fehlgeschlagene Prozessinstanzen neu zu starten. Die Prozessinstanz wird dann an der Stelle neu gestartet, an der sie fehlgeschlagen ist. Um eine Prozessinstanz neu zu starten, muss dessen ID übergeben werden, sodass sich folgender Aufbau des Befehls ergibt:

pc retry [processInstanceIds...] [options]

Beispiel: Um die Instanz mit der ID 'example' neu zu starten, wird folgender Befehl benötigt:

pc retry example

Prozessmodell starten

Um ein Prozessmodell zu starten, kann der Befehl pc start-process-model oder kurz pc start verwendet werden. Dazu muss die Process-Model-ID und die Start-Event-ID übergeben werden, sodass der Befehl folgenden Aufbau hat:

pc start [processModelId] [startEventId] [options]

Ein Beispiel:

pc start Registration.EmailCoupons StartEvent_

Installation einer Erweiterung

Um den ProcessCube zu erweitern, kann dies ebenfalls bequem über die CLI erfolgen.

Der Befehl dafür lautet:

pc install <source>

Der Befehl akzeptiert eine ZIP- oder TGZ-Datei als Quelle. Als Quelle kann entweder eine URL oder eine lokale Datei sein.

Das Installieren einer Erweiterung ist in dem Expert Tutorial genauer beschrieben.

Dokumentation

Die offizielle Dokumentation ist hier (opens in a new tab) zu finden.

Alternativ zur Dokumentation kann die Hilfe-Seite der CLI helfen, welche mit dem Befehl pc --help aufgerufen werden kann.