The designer

Publishing a Workflow

From a draft to a published workflow: states, transitions, effects and the checks before publishing.

Publishing a Workflow

  1. Under Define a workflow, choose the Entity and enter a key and a name. It starts as draft version 1.
  2. Add the States in order. The first State you add is the one a record starts in (marked start). Tick Final state for one a record moves no further from.
  3. Add the Transitions: key, name, from and to, and optionally the permission a person needs to take it and the fields it requires (they must have a value).
  4. Add guards: a transition runs only while a field of the record passes a test (is, is not, is one of).
  5. Add effects: after the record moves (or before — a refused one then stops the move), set a field value or run an action by its key. An action is found where the workflow runs: at the platform the platform's; in a tenant its own first, then the platform's.
  6. Press Publish version N. Publishing is refused, with the reason, without a State or with an effect that names an action that does not exist or has no published version.

Keep in mind A published version can no longer be edited: press New draft version to copy it into a draft, change it and publish it in its place. Removing a state or a transition from a draft is not built yet.