Guide / Start here

The example project

A small order process that runs from the first minute, so you can see every part of Penstock work on something real.

Free Test cases need Pro. Every machine starts with 30 days of Pro.

What it is

The example is an order process. A user approves the order. A worker charges the card. A decision picks the shipping method. The process waits for a message that the parcel has shipped. Then a receipt is sent. If the card is declined, the order ends early.

There are two versions. Pick the engine you use.

Write it into a folder

Write the example into an empty folder. If the folder is not empty, Penstock stops and writes nothing. It never overwrites your files. A .git folder does not count as content. Penstock also adds the penstockw wrapper scripts and adds penstock.local.yaml to .gitignore.

penstock init --example camunda-8

The files

Run it

The README written into the folder has the exact commands and versions. In short:

1. Start the engine. On Camunda 8, start Camunda 8 Run. On Camunda 7, run mvn spring-boot:run. The web apps open at http://localhost:8080. The login is demo and demo.
2. Look at the diagrams and check them. See Getting started.
3. Deploy the process, the decision and the form. See Deployment. On Camunda 7 they are also deployed when the app starts.
4. Start the workers, each in its own terminal.
5. Start an order. A home order under 1000 is paid and ships standard. Use "amount": 5000 to see the card declined.
6. Approve it in Tasklist, then send the message shipment-confirmed to tell the process the parcel has shipped.

Run the scenarios

The example has three scenarios. Running them deploys a test build, mocks the workers and runs them against your local engine. The first run on a local engine asks once whether it may. See Scenarios.

• A home order is approved, paid, shipped standard and completed.
• An order from abroad ships internationally.
• A declined card ends the order without a shipment.

penstock scenarios run .

What you see

• The check finds nothing wrong. Every task has a worker, the decision and the form exist, and the drawing is clean.
• The project model shows the process with its workers, its message, its decision, its form and its error code. See Your project as a model.
• The process has two ways through it: the order completes, or the card is declined.

$ penstock check .
ok    src/main/resources/approve-order.form
ok    src/main/resources/order-process.bpmn
ok    src/main/resources/shipping-method.dmn

$ penstock scenarios list .
src/main/resources/order-process.bpmn  2 scenario(s)
   1. Order received → Approve order → Charge card → Decide shipping method → Shipment confirmed → Send receipt → Order completed
   2. Order received → Approve order → Charge card → Card declined → Payment declined
        Card declined fires on Charge card

Common problems

"is not empty. An example is written into an empty folder"

Run the command in a new, empty folder. Penstock refuses to write into a folder that has files, so nothing of yours is overwritten.

"Unknown example"

The only names are camunda-8 and camunda-7.

Deploy says the engine is not reachable.

Start the engine first, and check deployment.url in penstock.yaml. See Deployment.

The scenarios ask a question the first time.

Scenarios deploy a test build. On a local engine Penstock asks once before it does. See Scenarios.