Rhythm 2.0 Specifications

Appearance

CAP-MBR-STR-017Maintain reasons for membership status actions

Markdown

CAP-MBR-STR-017

Maintain reasons for membership status actions

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-MBR-STR-05
Key concepts
CON-MBR-STR-005
Actors
ACT-MBR-001, ACT-MBR-002
Journeys
JNY-MBR-STR-005
Depends on
CAP-MBR-STR-018
Related
CAP-MBR-STR-016
Proved by
ATS-MBR-STR-017
Exercised by
JNY-MBR-STR-004

KindCapabilityProduct areaMembershipModuleOrganizational Structure, Membership Configuration and TermsRevision1

Read atservices-membership 5994c270react-console baf6dae3

Maintain reasons for membership status actions ​

Purpose ​

Staff configure recognizable explanations for termination, cancellation and suspension.

How It Works ​

An administrator creates the explanations staff need for membership status actions. Each explanation has a readable identity and a selected use. The reason list can be narrowed to that use. The action consumer checks whether a supplied reason is active and appropriate. Retirement removes it from future eligible choices without rewriting past records. Its priority is retained but does not order the list. Names are not required to be unique, so staff may need to distinguish similarly named choices. Changing the selected use remains possible while references exist. That flexibility can make past explanations harder to interpret. The product should decide whether a referenced reason’s use becomes fixed and improve mismatched-action messages.

Relationships ​

  • Status interpretation supplies the context for reasons used by membership actions.
  • Shared configuration operations maintain reason identity and version.

The Formal Contract

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

Outcomes
Status actions can refer to a reason matching their use.Existing records retain their explanation when a reason is retired.
Surfaces
api

Controls

34 controls apply, from the corpus control catalogue.

TC-AVL-002 TC-AVL-003 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-AZ-005 TC-AZ-006 TC-CHG-001 TC-CHG-002 TC-CHG-003 TC-CHG-004 TC-CRY-001 TC-CRY-002 TC-CRY-003 TC-DAT-001 TC-DAT-004 TC-DAT-007 TC-IAM-001 TC-IAM-002 TC-IAM-004 TC-IAM-005 TC-LOG-001 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-PI-001 TC-PI-003 TC-PI-005 TC-SEC-001 TC-SEC-004 TC-TEN-001 TC-TEN-002 TC-TEN-003

Permissions

KeyChecked atScope
membership.configuration.readapitenant
membership.configuration.manageapitenant
membership.application.accessapitenant

Business Rules

6 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
01must prove
Proposed
Each configured reason selects one use: termination, suspension or cancellation.
no proof recorded yet
validationapi, databaseobserved
services-membership:modules/configuration/services/configuration/configuration-records.ts:statusReasonContent
02must prove
Proposed
A supplied action reason must be active and match the action’s use, otherwise the action is refused with an explanation.
no proof recorded yet
validationserviceobserved
services-membership:modules/configuration/services/persistence/membership-status-reasons.ts:requireStatusReason
03
Proposed
Retiring a reason leaves records already referencing it unchanged.
lifecycleservicedocumented
react-console:acceptance/membership/inventory/business-rules.json#RUL-MBR-CFG-022
04must prove
Proposed
Reason priorities do not affect ordering and duplicate names are allowed.
no proof recorded yet
calculationserviceobserved
services-membership:modules/configuration/services/persistence/configuration-store.ts:configurationStore
05
Proposed
A reason’s use can be changed while terms still refer to it.
policyserviceobserved
services-membership:modules/configuration/services/configuration/configuration-records.ts:statusReasonResource
06must prove
Proposed
The reason list supports filtering by its selected use.
no proof recorded yet
calculationapiobserved
services-membership:modules/configuration/aws/api/configuration.routes.ts:configurationModuleRoutes

Scenarios

IdGivenWhenThenProvenance
01Staff need separate explanations for termination, cancellation and suspension.They save a reason for each action category.Each reason records its intended action category.documented
react-console:acceptance/membership/journeys/configuration/MBR-ACC-0105.json

Edge Cases

IdGivenWhenThenProvenance
02A cancellation request selects a suspension-only reason.Staff submit the cancellation.The mismatch is rejected, although the documented message describes termination.documented
react-console:acceptance/membership/journeys/configuration/MBR-ACC-0105.json

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