diff --git a/elsa/runs-and-instances.md b/elsa/runs-and-instances.md new file mode 100644 index 0000000..49d4bf9 --- /dev/null +++ b/elsa/runs-and-instances.md @@ -0,0 +1,21 @@ +# Runs & instances + +Every dispatch of a published definition creates a **workflow instance** (a run). + +- `/flows/runs` lists the instances of the selected runtime. +- `/flows/runs/:id` shows one instance: state, incidents, journal, executions + and the call stack. + +## Statuses + +- **Running** — the instance is still executing. +- **Finished** — reached an end activity without incidents. +- **Faulted** — one or more activities raised an incident. + +Open an incident to see the activity, the message and the stack trace captured +by the engine. + +
+Runs are stored by the engine per runtime. Switch the runtime in the page header +to inspect the instances of a self-hosted engine. +