Inlorus
How-to

Design a workflow at the platform

A workflow at the platform runs on a platform entity in every tenant that reads it — until the tenant publishes its own — and a package carries it. You give it states, transitions with their permission, required fields, guards and effects, and publish it.

For: Builder, Platform administrator

Prerequisite

  • metadata.write at the platform.
  • A platform entity (Metadata Designer). For an effect that runs an action, a platform action with a published version (see Define an action).

Steps

  1. Switch to the platform and open Workflow & EntityView Designer, tab Workflow.
  2. Under Define a workflow, choose the entity, give a key (for example engagement_life) and a name, and press Define workflow. It starts as draft version 1.
  3. Press Open and add the states in order — for an engagement: Proposed, Active, Delivered, Closed (tick Final state). The first is where a record starts.
  4. Add the transitions — Start (Proposed → Active), Deliver (Active → Delivered), Close (Delivered → Closed) — each optionally with the permission it needs and the fields it requires.
  5. Add a guard where a move depends on the record: for example Close runs only while Status is “delivered”.
  6. Add an effect: on Deliver, after the record moves, run an action such as engagement.mark_delivered.
  7. Press Publish version 1. If an effect names an action the platform does not have, or one with no published version, publishing is refused and the reason is listed.
  8. Add the workflow to a capability's Contents to ship it in a package.

Result

Every tenant that reads the entity runs the workflow on its own records: its flow board says it shows the platform's workflow, the records' progress is the tenant's, and the effect's action runs for the person who moved the record — checked for their permission and the record's rules, and in the tenant's trail. A tenant that publishes its own workflow on the entity runs its own instead.

Keep in mind A published version cannot be changed: New draft version copies it into a draft to change and publish in its place. Removing a state or transition from a draft is not built yet. Platform workflow versions carry no metadata revision yet; the version number is what a package locks.

Tip The Workflow & EntityView Designer's help topic lists every part of a transition and why a publish is refused.