Flow
Shows an Entity's records in columns by the states of its published Workflow. This is where you move a record from one state to another.
What's on this screen
- One column per state, with the number of records in that state. A card shows the value of the record's primary field.
- If the Entity has a lifecycle definition, the header shows the Active and Passive record counts.
- If the Entity has no published Workflow, a note saying so replaces the board, with a link back to Explorer.
- Not started: records of the Entity that have not started this Workflow yet, so they are in no state. The lane appears only while there are such records, for example records added in Explorer after the Workflow was published.
Starting records
Opening the board changes nothing. To put the records in the Not started lane into the Workflow, press Start at the top of the lane: each one is placed in the Workflow's first state and appears in that column. Starting needs record.write in this tenant; without it the lane shows a note in place of the button, and the server refuses the start as well.
Moving a record
- Drag the card and drop it on the target state's column. Only columns with a defined transition from the record's current state accept the drop.
- Or open the card's ⋮ menu and choose one of the transitions there. The menu lists only the transitions leaving that state.
- If the transition is accepted, the card moves to the new column. If it is refused, a message at the top of the screen gives the reason.
- A transition's effects run with it — set a field, or run an action — and the message says what they did; an effect that was refused after the move is said, and one refused before the move stops it.
Running an action on a record
The card's ⋮ menu has Run an action…: it lists the actions defined for these records — the tenant's own and the platform's — and runs the one you choose, checked on the server: record.write in this tenant, then the action's own permission, whether it applies to the record as it is, and the record's rules. An action you cannot run is listed with the reason, and every run is in the tenant's trail.
When the tenant has no workflow of its own on the entity, the board runs the platform's workflow and says so in its header.
Why a transition is refused
| Case | What it means |
|---|---|
| Not defined | The Workflow has no transition between these two states, or the record is in a final (terminal) state. |
| Permission denied | A permission key is attached to the transition and you don't hold it. |
| Condition, required field or validation | The transition's condition was not met, a required field is empty, or the Entity's validation rule failed. |
| Someone else updated it | The record changed while you were looking at it. Refresh the page and try again. |
Tip Every refused attempt is recorded too. The board opens from Open as flow board in an Explorer column's menu, or at /flow/ followed by the Entity key.