Rhythm 2.0 Specifications

Appearance

CAP-PFM-CSH-001Use a consistent console frame

Markdown

CAP-PFM-CSH-001

Use a consistent console frame

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-PFM-CSH-01
Key concepts
CON-PFM-CSH-001
Actors
ACT-PFM-001, ACT-PFM-002, ACT-PFM-004, ACT-PFM-005
Journeys
JNY-PFM-CSH-001
Related
CAP-PFM-CSH-006, CAP-PFM-CSH-011, CAP-PFM-CSH-013
Open questions
OQ-PFM-CSH-002
Proved by
ATS-PFM-CSH-001

KindCapabilityProduct areaPlatformModuleConsole Shell and NavigationRevision2

Read atreact-console baf6dae3services-platform ad3f6a65

Use a consistent console frame ​

Purpose ​

Staff recognize their workspace and reach shared tools from a common frame around console pages.

How It Works ​

A person opens a console page and waits for their access context. Startup screens explain problems before any working page is mounted. Once access is known, the shared frame gives the page a recognizable setting. A notice makes an unexpected workspace choice visible during subsequent work. Hosted tools supply their own behavior within that setting. The product should retire the sample currency helper when the sample dashboard is replaced.

Relationships ​

  • Security supplies the identity and access context required at startup.
  • Navigation and workspace entry determine the menu and workspace shown in the frame.
  • Queries, Operations, Notifications, Accounting and the AI teammate supply the hosted tools.

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Outcomes
Identity and workspace context accompany everyday work.Startup problems provide a clear explanation and recovery path.
Surfaces
console

Controls

33 controls apply, from the corpus control catalogue.

TC-AVL-001 TC-AVL-004 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-CRY-001 TC-CRY-002 TC-CRY-003 TC-CRY-004 TC-DAT-001 TC-DAT-002 TC-DAT-003 TC-DAT-004 TC-IAM-001 TC-IAM-002 TC-IAM-004 TC-IAM-005 TC-LOG-005 TC-MON-001 TC-MON-002 TC-MON-003 TC-PI-001 TC-PI-002 TC-PI-003 TC-PI-004 TC-PI-005 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-VEN-001 TC-VEN-002 TC-VEN-003

Permissions

KeyChecked atScope
platform.security-self.readapitenant

Business Rules

8 rules, 4 to be proved before approval. A rule's product intent is derived from its origin: 0 confirmed by a product decision, the rest inheriting this capability's proposed.

IdRuleKindEnforced atProvenance
01
Proposed
The header orders the Rhythm logo, menu toggle, workspace switcher or Rhythm HQ label, Quick Search, working business unit and currency, Recent Items, alerts and Ask Jazz AI.
policyconsoleobserved
react-console:components/console/site-header.tsx:SiteHeader
02
Proposed
Ask Jazz AI disappears on the dedicated assistant page and indicates its pressed state while the assistant panel is open.
policyconsoleobserved
react-console:components/console/site-header.tsx:SiteHeader
03must prove
Proposed
Before the security context answers, startup occupies the full page without a header, navigation or workspace name.
no proof recorded yet
invariantconsoletest
react-console:e2e/dev/initialisation.dev.spec.ts#asks the Platform exactly one thing first, and shows nothing until it is answered
04must prove
Proposed
No access identifies the signed-in address and offers sign-out, a load failure offers retry and sign-out, and missing configuration displays setup guidance and the missing settings.
no proof recorded yet
policyconsoleobserved
react-console:components/console/console-boot-screens.tsx:consoleBootScreens
05must prove
Proposed
An unexpected starting workspace is explained by a notice above the console that remains until dismissed.
no proof recorded yet
lifecycleconsoletest
react-console:e2e/controlled/tenant-unavailable.controlled.spec.ts#falls back to the default tenant, with a word of explanation, rather than refusing access
06
Proposed
Confirmation toasts sit at the lower right with clearance above an editor’s fixed action bar.
policyconsoleobserved
react-console:components/console/console-shell.tsx:ConsoleShell
07must prove
Proposed
The sample-money helper uses five fixed currency choices and rates, rounds converted US-dollar base values to cents and formats them separately from the header’s working currency.
no proof recorded yet
calculationconsoleobserved
react-console:components/console/console-provider.tsx:useMoney
08
Proposed
The frame hosts search, recent work, alerts, working context, the assistant and staff-access information, with each hosted function governed by its owning module.
policyconsoleinferred
react-console:components/console/console-shell.tsx:ConsoleShell; app/(console)/layout.tsx

Scenarios

IdGivenWhenThenProvenance
01The remembered workspace is no longer operational.The person loads the console.The default workspace opens with a dismissible explanation.test
react-console:e2e/controlled/tenant-unavailable.controlled.spec.ts#falls back to the default tenant, with a word of explanation, rather than refusing access
02Platform fails to provide the person’s access context.The console initializes.The failure screen provides retry and sign-out without a working frame.observed
react-console:components/console/console-boot-screens.tsx:consoleBootScreens

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.

Rhythm Software