Skip to main content

CnFlowRunsWidget

The live flow runs for the viewer's organisation. Reads OpenRegister's flow-runs/active surface and renders one row per run — its flow's name, what triggered it, the step it currently sits on, and how long it has been going. Registered under the flow-runs type and configured by CnFlowRunsWidgetForm.

Every Conduction app runs its flows on OpenRegister's one flow engine (ADR-065), so "what is running right now" has a single answer for the whole instance. That is what makes this widget app-agnostic: an app places it and its users see their live runs without the app shipping a controller, a store or a view.

Content shape​

{
  "limit": 6,
  "pollSeconds": 15,
  "rowRoute": "GraphDetail",
  "runRoute": "RunDetail",
  "subject": "@objectId",
  "emptyText": "No flows are running"
}

Subject mode​

Set subject and the widget becomes a case page's view of the engine: the live list is filtered to that one subject object server-side, and the subject's finished runs render below it under an "Earlier runs" label. A flow that completed no longer looks like nothing happened.

  • subject takes a subject object uuid, or the token @objectId (or @object.<field>). On a detail page the token binds the current object through the injected object context, so a manifest never hardcodes a uuid. While the token cannot resolve, the widget shows its loading state and sends nothing.
  • Terminal rows (completed, stopped, failed, dead_letter) are marked by shape and text, never by colour alone: a hollow dot, a muted name, the section label and the status word.
  • Two empty states: a subject where nothing ever ran says "No flows have run yet"; a subject with history but nothing live keeps the nothing-running line above its history.
  • Polling refetches both reads, so a run that finishes between polls moves to the history instead of vanishing.
  • Consumes the two reads of the openregister change flow-runs-subject-scope. Until that lands server-side, subject is ignored by the active read and the history read shows its quiet error line.

Props​

PropTypeDefaultDescription
contentobject{}The widget config blob (limit, pollSeconds, rowRoute, runRoute, subject, emptyText).
widgetIdstring''Placement id, so the per-widget Refresh action (cn:widget:refresh) reaches this instance.
translateFunctionnullTranslate function. Falls back to the injected cnTranslate.

Notes​

  • Which runs. All NON-terminal statuses: queued, running and suspended. Filtering to literally running would show an empty widget almost always — a run holds that status only during a worker pass, while queued and suspended are where live runs actually wait.
  • Scoping is server-side. The endpoint returns only the caller's organisation's runs, and returns nothing when no organisation resolves. The widget never filters by tenant itself.
  • It polls. A widget titled "running flows" that only reflected the moment the dashboard mounted would be wrong within seconds and would look identical to being right. pollSeconds defaults to 15, is floored at 5, and 0 disables polling. Polling pauses while the browser tab is hidden and refetches once on return.
  • Row clicks are opt-in. With no rowRoute the rows are not clickable, which is correct for an app that has no flow page. When set, the route receives the run's FLOW id as :id — a click on a live run means "show me this flow". A configured runRoute wins on rows that carry a run uuid: the route receives the RUN's uuid as :id, the deep link a case page wants.
  • Empty is normal. Nothing running renders one muted line, not an illustration and not an error.
  • Requires OpenRegister. Without it the endpoint 404s and the widget shows its error line.