Skip to content

Update Demo User Guide for new ALERTS panel (replaces EVENT ADJUDICATOR) #284

Description

@Justus-at-Tazama

Context

The tazama-lf/tazama-demo repo is migrating the legacy EVENT ADJUDICATOR panel to a new ALERTS panel containing three sub-panels (EVENT FLOW, TYPOLOGY PROCESSOR, EVENT ADJUDICATOR). The implementation PR is tracked at tazama-lf/tazama-demo#124 and the full spec is in that PR's description (originated from temp-files/alerts-result.md).

The current Demo User Guide at Guides/demo-ui-guide.md documents the legacy single EVENT ADJUDICATOR panel with a single status light and a yellow ALRT badge. After the demo-side PR merges, the guide will be out of step with the UI.

What needs to change in Guides/demo-ui-guide.md

Update the section(s) covering the right-hand-side EVENT ADJUDICATOR panel to describe the new ALERTS panel layout and behaviour. Specifically:

  1. Panel name: EVENT ADJUDICATOR -> ALERTS.
  2. Sub-panels: the single panel body is now three vertically-stacked sub-panels of equal height:
    • EVENT FLOW - mirrors the upstream EFRuP rule outcome.
    • TYPOLOGY PROCESSOR - shows when an interdicting typology fires.
    • EVENT ADJUDICATOR - shows the final adjudicator decision.
  3. Sub-panel layout: each sub-panel has a small uppercase gradient header (EVENT FLOW / TYPOLOGY PROCESSOR / EVENT ADJUDICATOR), a status light on the left, and a centred recessed-pill outcome label on the right. The pill is omitted entirely when there is no outcome (the TYPOLOGY PROCESSOR and EVENT ADJUDICATOR sub-panels render no pill until their first message arrives).
  4. Outcome mapping (status-light colour / pill label):
    • EVENT FLOW:
      • no message yet -> grey light, NONE pill
      • EFRuP rule result subRuleRef = block -> red light, BLOCK pill
      • EFRuP rule result subRuleRef = override -> green light, OVERRIDE pill
      • EFRuP rule result subRuleRef = none -> grey light, NONE pill
      • EFRuP rule result subRuleRef = .err -> previous state is preserved; an error line is logged to the browser console (EFRuP error <reason>).
    • TYPOLOGY PROCESSOR:
      • no message yet -> grey light, no pill
      • any message on the interdiction-service-tp socket subject -> red light, INTERDICT pill (terminal; once shown, stays interdict for the rest of the transaction).
    • EVENT ADJUDICATOR:
      • no message yet -> grey light, no pill
      • report.status = ALRT -> red light, ALRT pill
      • report.status = NALT -> green light, NALT pill
  5. Transaction boundary: when a new transaction is submitted (new MsgId registered as the active correlation id), all three sub-panels are atomically reset to their default state.
  6. Removed visuals: the legacy single yellow ALRT badge and the single combined status indicator that lived next to the EVENT ADJUDICATOR h2 are gone. Anything in the guide describing them should be removed.

Source-of-truth references

  • Demo repo PR description (when opened) - full spec, screenshots if available.
  • temp-files/alerts-result.md in the demo repo (working spec used to drive the migration). Sections most relevant to the guide: §4 (layout), §5 (state -> display mapping), §6.5 (transaction boundary), §7 (component sketch).
  • Provider socket-handler shapes are in store/processors/processor.provider.tsx of the demo repo.

Suggested PR scope

  • Update Guides/demo-ui-guide.md only. No structural changes to the docs site needed.
  • Include a screenshot of the new panel if possible (the demo repo has a running TEST_MODE that drives all three sub-panels to red BLOCK / INTERDICT / ALRT for a deterministic capture).
  • Target dev per the docs repo's contribution conventions.

Spec reference

This issue is the tazama-lf/docs follow-up tracked by spec step 9 (A15 audit, "raise an issue in the /docs repository to update the Demo User Guide") of the ALERTS panel migration in tazama-lf/tazama-demo.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions