Rhythm 2.0 Specifications

Appearance

CAP-PFM-ELG-005Replace obsolete rules without losing their uses

Markdown

CAP-PFM-ELG-005

Replace obsolete rules without losing their uses

Markdown
  • DocumentDraft
  • Product intentConfirmed
  • ImplementationObserved

Planning

Feature
FEAT-PFM-ELG-01
Exercised by
FAS-PFM-ELG-01-02, FAS-PFM-ELG-01-04
Key concepts
CON-PFM-ELG-001, CON-PFM-ELG-002
Actors
ACT-PFM-023
Depends on
CAP-PFM-ELG-004
Related
CAP-PFM-ELG-002, CAP-PFM-ELG-007
Proved by
ATS-PFM-ELG-005

Implementation

Executable suites
TST-PFM-ELG-172, TST-PFM-ELG-173, TST-PFM-ELG-174, TST-PFM-ELG-175, TST-PFM-ELG-176, TST-PFM-ELG-182, TST-PFM-ELG-186, TST-PFM-ELG-411, TST-PFM-ELG-433, TST-PFM-ELG-450, TST-PFM-ELG-481

KindCapabilityProduct areaPlatformModuleEligibility, Responsibilities and AttentionRevision1

Read atservices-platform ad3f6a65react-console baf6dae3

Replace obsolete rules without losing their uses ​

Purpose ​

Administrators need a controlled path away from an obsolete rule. Retirement preserves dependent decisions while they move to a replacement.

How It Works ​

The administrator reviews dependencies and selects a replacement when appropriate. Deprecation discourages new uses while existing consumers keep working. A transfer report distinguishes moved uses from those needing attention. Pinned dependencies remain a deliberate choice for their owners. Referencing expressions are released again when replacement is valid. The administrator clears remaining dependencies before archive. Restoration makes an archived rule available again. Deletion is reserved for unused work that was never released. Stale lifecycle requests require another read. The product should expose individual-version withdrawal if that remains the intended retirement action.

Relationships ​

  • Release, schedule and restore rule versions releases replacement expressions in rules that include the retired definition.

The Formal Contract

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

Outcomes
Existing consumers continue using deprecated rules while new uses choose alternatives.A replacement operation transfers compatible uses together.Archiving waits until all dependencies have cleared.
Surfaces
consoleapi
Intent sources
services-platform:docs/milestones/plans/PLAT-M11-plan.md#2. Scope

Controls

21 controls apply, from the corpus control catalogue.

TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-DAT-001 TC-DAT-002 TC-DAT-003 TC-DAT-004 TC-IAM-001 TC-IAM-006 TC-LOG-004 TC-LOG-005 TC-PI-001 TC-PI-003 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.eligibility.retireapitenant

Business Rules

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

IdRuleKindEnforced atProvenance
01must prove
Confirmed
Retirement authority is required to deprecate, archive, restore, delete or transfer a rule’s uses; draft-writing and binding authority alone do not suffice.
proved by ATS-PFM-ELG-005-01, TST-PFM-ELG-186, TST-PFM-ELG-411
permissionapitest
services-platform:modules/eligibility/tests/e2e/eligibility-definitions.e2e.spec.js#refuses the deprecation to a writer without the retire permission, 403
02must prove
Confirmed
Deprecation preserves existing evaluations but blocks new uses, with an optional replacement that is active, published and different from the original rule.
proved by ATS-PFM-ELG-005-02, TST-PFM-ELG-172, TST-PFM-ELG-173, TST-PFM-ELG-411
lifecycleservicetest
services-platform:modules/eligibility/tests/e2e/eligibility-definitions.e2e.spec.js#refuses a new binding of the deprecated rule, 409
03must prove
Confirmed
Archive rejects rules still followed or pinned by active bindings or referenced by live rules’ current drafts or published versions, reporting both dependency counts.
proved by ATS-PFM-ELG-002-10, ATS-PFM-ELG-005-03, ATS-PFM-ELG-005-09, TST-PFM-ELG-174, TST-PFM-ELG-450
policyservicetest
services-platform:modules/eligibility/tests/integration/services/persistence/definitions.integration.spec.js#refuses while an active binding follows it, counting the binding, and leaves it active
04must prove
Confirmed
Archive blocks drafts, new bindings and binding reactivation; restoration returns the rule to active standing and removes its replacement designation.
proved by ATS-PFM-ELG-005-04, TST-PFM-ELG-450, TST-PFM-ELG-481
lifecycleservicetest
services-platform:modules/eligibility/tests/unit/lifecycle.spec.js#refuses making a binding of an archived definition active again
05must prove
Confirmed
Replacement moves compatible following bindings without duplicating a consumer use, republishes referencing rules and leaves pinned bindings and references for a person to resolve.
proved by ATS-PFM-ELG-004-14, ATS-PFM-ELG-005-05, ATS-PFM-ELG-005-10, ATS-PFM-ELG-005-11, ATS-PFM-ELG-007-18, TST-PFM-ELG-175, TST-PFM-ELG-433
lifecycleservicetest
services-platform:modules/eligibility/tests/integration/services/governance/lifecycle.integration.spec.js#lists the pinned binding for a person to move, and leaves it on the deprecated definition
06must prove
Confirmed
Transferring references requires an active published replacement and reports any referencing expression that fails validation without publishing it.
proved by ATS-PFM-ELG-005-06, TST-PFM-ELG-176, TST-PFM-ELG-433
validationservicetest
services-platform:modules/eligibility/tests/integration/services/governance/lifecycle.integration.spec.js#refuses a replacement that was never published
07must prove
Confirmed
Deletion removes only never-published rules and their drafts, dependencies and plans, refusing rules with bindings, references or resolved conversion reviews.
proved by ATS-PFM-ELG-005-07, TST-PFM-ELG-411, TST-PFM-ELG-433
policyservicetest
services-platform:modules/eligibility/tests/e2e/eligibility-definitions.e2e.spec.js#refuses a published definition, 409, naming the archive instead
08must prove
Confirmed
A lifecycle request with an obsolete version fails, while a request without a version proceeds against the current record.
origin: services-platform:docs/milestones/plans/PLAT-M11-plan.md#Appendix A. Behaviours that stand as built unless Andrew objects
proved by ATS-PFM-ELG-005-08, TST-PFM-ELG-182, TST-PFM-ELG-450
validationservicetest
services-platform:modules/eligibility/tests/integration/services/persistence/definitions.integration.spec.js#refuses a lifecycle move at a version that is no longer current
09
Confirmed
The product should support withdrawing one published version as the retirement permission describes, but no exposed operation currently offers that action.
lifecycleserviceunknown
FND-PFM-ELG-005

Scenarios

IdGivenWhenThenProvenance
01An expression has one active price use and one published reference.The administrator requests archive.The refusal counts both dependencies; removing them permits archive and later restoration.test
react-console:acceptance/eligibility/playwright/journeys/governance/ELIG-ACC-0142.spec.ts#ELIG-ACC-0142
02An obsolete annual rule designates a rolling replacement.The administrator transfers its dependencies.Followers move, pins remain for manual handling and references receive fresh releases with change notes.test
react-console:acceptance/eligibility/playwright/journeys/governance/ELIG-ACC-0143.spec.ts#ELIG-ACC-0143

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