Guide / Test and run
Timeline
The timeline puts one run on a time axis under the canvas: a lane for each element, a bar for each visit. Move the playhead and the tokens on the diagram go back to where they were at that moment.
What it is
The Monitor tells you what the engine is doing now, and a scenario run tells you what happened in a test. The timeline tells you when. It reads one run, either an instance of the process or a scenario run, and draws it as a chart under the diagram: time runs to the right, each element of the run has a lane, and each time the process was in that element is a bar. A wait shows as a long bar, a loop as many bars in one lane, a parallel branch as two lanes that overlap.
Unlike Token simulation, which is a picture of what could happen, the timeline replays a run that did. Picking an instance only reads it from the engine. Nothing is written to the engine, and moving the playhead never changes the diagram.
Open it
- Choose a run. Either press Use on an instance in the Monitor tab, or pick a finished instance from its History, or run a scenario in the Scenarios tab.
- Choose Timeline in the More menu or the command palette. It is a toggle, so the same action closes it. It is not pinned to the toolbar by default.
- The timeline opens under the canvas. With nothing picked it says No run to show. and Pick an instance in Monitor, or run a scenario, and its steps appear here.
When both an instance and a scenario run are available, Instance and Scenario run in the header choose which one is drawn. A newly run scenario takes over, and so does an instance you pick. While it reads the run it says Reading the run…. For an instance that is still running, bars end at the moment it was read, and Refresh reads it again.
Drag the grip on the top edge to make the timeline taller or shorter, or focus the grip and press the up or down arrow key.
Read the chart
| Lanes | One for each element the run reached. A sub-process is indented over what is inside it. A number on a lane is how many times the run visited it, when it was more than once. |
| Bars | One for each visit, from the moment the element was entered to the moment it was left. A step that took no time is a thin mark. Short bars that lie close together are drawn as one and say 3 short steps. Zoom in to see them apart. |
| Folded waits | A long wait with nothing happening is folded to a short stretch labelled folded with its length, so the steps on either side stay readable. |
| Ruler | The time since the run started, along the top. |
| Playhead | A line at the moment you are looking at. The readout in the header gives the time at it, the length of the run and the step, as in 3/8. |
Colour the bars
The header has three channels. A bar reads the same way as the badges on the canvas.
| Channel | What the colour means |
|---|---|
| Status | Completed, Active, Failed or Terminated, in the colours of the status badges. The legend is under the chart. |
| Duration | The longer the visit, the stronger the colour. The legend gives the range, from 0 to the longest visit. |
| Coverage | The more often a lane was visited, the stronger the colour. Elements of the diagram that the run never reached are added as lanes marked Not reached, and the legend says 5 of 9 elements reached. |
Move through the run
Press play, or drag the playhead along the chart. The tokens on the canvas move along the sequence flows to where they were at that moment, and the elements are marked as they were then. The transport buttons are, in order, To the start, Previous step, Play, Next step and To the end. The number beside them, 1x, 2x or 4x, is the playback speed. Zoom out, Zoom in and Fit to width change the scale of the time axis.
Click a bar to select its element on the canvas and see the step under the chart: the element, its state, which visit it was, when it started and ended, how long it took, the activity instance, an incident if it had one, and whether a scenario answered it (Answered by the scenario). Changed variables lists the variables the step changed, as a name and its value, and its value before when the engine says it. How exact that is depends on the engine: see Running scenarios.
Keyboard
The chart is a single stop on the Tab key. With the focus on it, the keys are:
| Key | What it does |
|---|---|
| Left, Right | Go to the previous or the next step of the run. |
| Shift+Left, Shift+Right | Go to the previous or the next visit of the element in the row you are on. |
| Shift+Up, Shift+Down | Change the row. The element of the row is selected on the canvas. |
| Home, End | Jump to the start or the end of the run. |
| Space | Play or pause. |
| +, -, 0 | Zoom in, zoom out, fit the run to the width. |
| Enter | Select the element of the row on the canvas. |
While the run is paused, a screen reader hears each step as Step 3 of 8: Check stock, or Before the first step. While it plays, the status line stays quiet, so it does not talk over itself.
With reduced motion on in your system, the timeline does not animate: pressing play jumps to the end of the run, and the keys and the buttons still step through it.
What you see
- A chart under the canvas with a lane for each element and a bar for each visit.
- The tokens on the diagram at the moment of the playhead.
- The step under the chart, with the variables it changed.
Common problems
- "No run to show."
- Nothing is picked. Press Use on an instance in Monitor, or run a scenario.
- "This run has no steps yet."
- The engine has not recorded a step for the instance. Press Refresh in a moment.
- "Unable to read the run".
- The engine did not answer, or refused the question. The message gives the reason. Check the profile in force and press Refresh. See Monitor.
- There is no Timeline action.
- The timeline is for Camunda 7, Camunda 8, Operaton and CIB seven diagrams. A decision and a form have none.
- The bars of a running instance stop at the edge.
- Bars of an instance that is still running end at the moment it was read. Press Refresh to read it again.