Penstock

Guide / Start here

Erste Schritte

Von einer leeren Installation zu einem geprüften, deployten Prozess in etwa zehn Minuten.

Free

1. Penstock installieren

Penstock gibt es in mehr als einer Form. Die Funktionen sind in jeder gleich. Wählen Sie die, die Sie nutzen.

Penstock installieren

JetBrains

Öffnen Sie Settings | Plugins | Marketplace in einer beliebigen JetBrains-IDE ab 2023.1, suchen Sie nach Penstock und klicken Sie auf Install. Oder öffnen Sie die Marketplace-Seite. Siehe Installation in einer JetBrains-IDE.

VS Code

Installieren Sie die Erweiterung aus dem Visual Studio Marketplace, in VS Code 1.88 oder neuer. Siehe Installation in VS Code.

Command line

Installieren Sie es einmal, oder führen Sie es ohne Installation aus. Es braucht Node.js 22.22.2 oder neuer in 22, 24.15.0 oder neuer in 24, oder 26 und neuer. Das Paket ist auf npm.

npm install -g @kern0x1b/penstock-cli
npx @kern0x1b/penstock-cli

Ein Projekt kann außerdem mit einem Wrapper-Skript eine Version festlegen. Siehe Befehlszeile.

Führen Sie in VS Code dies in einem Terminal aus, oder öffnen Sie die Seite der Erweiterung und klicken Sie auf Install:

code --install-extension penstock.penstock

2. Das Beispiel ausprobieren

Am schnellsten sehen Sie alles in Aktion mit dem Beispiel: ein kleiner Bestellprozess mit Workern, einer Entscheidung, einem Formular und Testfällen. Das Beispielprojekt erklärt jede Datei. Schreiben Sie es in einen leeren Ordner.

Das Beispiel schreiben

JetBrains

Öffnen Sie ein leeres Projekt, und öffnen Sie das Tool-Fenster Penstock. Es bietet Camunda 8 order process und Camunda 7 order process an. Klicken Sie auf eines, und bestätigen Sie den Dialog Start from an example mit Create. Eine Benachrichtigung sagt, wo das Beispiel liegt.

VS Code

Öffnen Sie einen leeren Ordner in VS Code, und öffnen Sie die Ansicht Penstock in der Activity Bar. Ein Projekt ohne Diagramme bietet die Beispiele an. Wählen Sie Camunda 8 order process oder Camunda 7 order process, um es anzulegen.

Command line

Führen Sie in einem leeren Ordner penstock init --example camunda-8 aus, oder --example camunda-7. Es schreibt die Dateien und den Wrapper penstockw.

penstock init --example camunda-8
Ein Terminal, das penstock init --example camunda-8 ausführt. Es listet die Dateien, die es geschrieben hat: penstock.yaml, README.md, .gitignore, pom.xml, application.yaml, order-process.bpmn, shipping-method.dmn, approve-order.form, zwei Java-Dateien, test-cases/order-process.json, einen Ordner node-worker und die Wrapper-Dateien
Was der Beispielbefehl in einen leeren Ordner schreibt.

3. Ansehen, prüfen, deployen

  1. Öffnen Sie src/main/resources/order-process.bpmn im Editor. Das Diagramm erscheint.
  2. Klicken Sie auf Check. Eine Karte listet, was nicht stimmt. Ein frisches Beispiel hat keine Fehler. Siehe Diagrammprüfung.
  3. Klicken Sie auf Deploy. Ein Popover öffnet sich und fragt beim ersten Mal nach der Adresse der Engine. Geben Sie sie ein, speichern Sie, und deployen Sie erneut. Siehe Deployment.

So geht es in Ihrem Tool

JetBrains

Öffnen Sie die Datei aus der Project-Ansicht oder dem Penstock-Tool-Fenster. Check und Deploy sind in der Werkzeugleiste des Editors.

VS Code

Öffnen Sie die Datei aus dem Explorer. Check und Deploy sind in der Werkzeugleiste des Editors.

Command line

Es gibt keinen Editor, nutzen Sie daher die Befehle:

penstock check .
penstock deploy . --dry-run
penstock deploy .

Mit Ihrem eigenen Diagramm beginnen

  1. Öffnen Sie eine .bpmn-Datei. Wenn Sie keine haben, legen Sie eine Datei namens process.bpmn an und öffnen Sie sie. Eine leere Datei ist in Ordnung.
  2. Wenn das Diagramm nichts über seine Engine sagt, erscheint über der Arbeitsfläche eine Zeile: Which engine runs this diagram? Klicken Sie auf Camunda 8, Operaton, CIB seven, Camunda 7, Flowable, Activiti oder Classic BPMN. Die Antwort wird in penstock.yaml im Stammverzeichnis des Projekts geschrieben, die angelegt wird, wenn es keine gibt. Die Frage kommt nur einmal.
  3. Zeichnen Sie. Ziehen Sie Elemente aus der Palette links, oder klicken Sie auf ein Element und nutzen Sie das kleine Pad daneben. Ein Diagramm bearbeiten zeigt, wie es geht.
  4. Wählen Sie ein Element aus, und füllen Sie seine Eigenschaften im Tab Properties rechts aus. Der Eigenschaftenbereich erklärt die Gruppen.
  5. Klicken Sie auf Check. Beheben Sie, was dort gelistet wird, in der Karte oder im Tab Problems.

Ein Diagramm öffnen

JetBrains

Doppelklicken Sie auf eine .bpmn-Datei in der Project-Ansicht oder im Penstock-Tool-Fenster. Die Tabs BPMN Editor und Text am Fuß des Editors wechseln zwischen dem Bild und dem XML. Siehe Der Editor in der IDE.

VS Code

Doppelklicken Sie im Explorer auf eine .bpmn-Datei. Sie öffnet sich im Penstock-Editor. Penstock: Open as text öffnet das XML daneben. Siehe Wo Sie was in VS Code finden.

Command line

Nicht verfügbar in Command line. Die Befehlszeile hat keinen Editor. Nutzen Sie penstock show, um ein Diagramm aufzulisten, und penstock edit, um es zu ändern.

Was Sie sehen

Ein Diagramm im Editor mit der Werkzeugleiste oben, der Palette neben der Arbeitsfläche, dem Tab Properties der Seitenleiste rechts und den Editor-Tabs unten
Ein Diagramm im Editor: oben die Werkzeugleiste, neben der Arbeitsfläche die Palette, rechts in der Seitenleiste die Eigenschaften des ausgewählten Elements und unten die Editor-Tabs.

Die erste Minute

Die Einführungstour in Ihrem Tool

JetBrains

Wenn sich der Editor zum ersten Mal öffnet, führt er Sie mit jeweils wenigen Worten durch sechs Dinge: die Palette, den Eigenschaftenbereich, Check, das Tool-Fenster, bei dem er zeigt, dass es in der Leiste am Rand der IDE liegt, Deploy und das Menü More. Die Tour wird einmal gezeigt, und dass sie gesehen wurde, wird in ~/.penstock/preferences.json neben den Einstellungen der Werkzeugleiste gespeichert. Show the tour again ist im Menü More unter Help.

VS Code

Wenn sich der Editor zum ersten Mal öffnet, zeigt er eine kurze Tour. Sie wird einmal gezeigt. Penstock: Show the tour again in der Command Palette oder Show the tour again im Menü More spielt sie erneut ab.

Command line

Nicht verfügbar in Command line. Es gibt keinen Editor und daher keine Tour. penstock doctor gibt die Einrichtung aus, auf die sie hinweisen würde.

Die meistgenutzten Aktionen sind anfangs an die Werkzeugleiste angeheftet: Auto-Layout, Check, Simulate, Monitor, Scenarios, Coverage, Migrate to Camunda 8, Deploy und der Schalter für die Seitenleiste. Die Pinnadel in jeder Zeile des Menüs More und der Befehlspalette nimmt eine Aktion in die Leiste auf oder entfernt sie daraus. Siehe Die Werkzeugleiste und das Menü More.

Welche Dateien sich im Editor öffnen

DateienÖffnet sich in
.bpmn, .bpmn.xml, .bpmn20.xmlDer BPMN-Editor
.dmnDer DMN-Editor
.form mit einem Camunda-FormularDer Formular-Editor

Wie es weitergeht

Häufige Probleme

Deploy fehlt in der Werkzeugleiste.
Deploy wird für Projekte mit Camunda 7, Camunda 8, Operaton und CIB seven angezeigt. Projekte mit Classic BPMN, Flowable und Activiti haben es nicht. Ändern Sie die Engine in penstock.yaml.
Die Frage nach der Engine ist nicht erschienen.
Sie erscheint nur bei einem leeren Diagramm. Ein Diagramm, das bereits sagt, für welche Engine es ist, oder ein Projekt mit engine in penstock.yaml wird nicht gefragt.
Das Beispiel wurde nicht geschrieben.
Ein Beispiel wird nur in einen leeren Ordner geschrieben, daher überschreibt es nie Ihre Dateien.

Die Testphase und der Kauf

Jeder Rechner startet mit 30 Tagen Pro. Für die Testphase melden Sie sich nicht an und geben keine Karte ein. Wenn sie endet, ist der Rechner im Tarif Free, und die Editoren, Prüfungen und Deploy funktionieren weiter.

Zum Kaufen nutzen Sie einen dieser Links. Der Checkout von Polar öffnet sich in Ihrem Browser, und wenn Sie bezahlt haben, bemerkt Penstock das und fragt nach dem Code, der an Ihre E-Mail-Adresse geschickt wurde. Es gibt keinen Schlüssel zum Kopieren. Dieselbe Lizenz funktioniert in jedem Tool auf dem Rechner.

FreeKostenlos, und jeder neue Rechner startet mit 30 Tagen Pro.
Pro$9 pro Monat oder $90 pro Jahr
Team$29 pro Monat oder $290 pro Jahr für jeden Platz

Wie Sie sie aktivieren, was eine Lizenz abdeckt, Team-Plätze, Pipelines, Offline-Arbeit, der Umzug auf einen anderen Rechner und die Kündigung stehen unter Kaufen und anmelden. Was jeder Tarif enthält, steht unter Tarife und Lizenz.