Rhythm 2.0 Specifications

Appearance

CAP-PFM-ELG-011List qualifying subjects and assess a draft’s impact

Markdown

CAP-PFM-ELG-011

List qualifying subjects and assess a draft’s impact

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationPartially observed

Planning

Feature
FEAT-PFM-ELG-03
Exercised by
FAS-PFM-ELG-03-01, FAS-PFM-ELG-03-02, FAS-PFM-ELG-03-03, FAS-PFM-ELG-03-04, FAS-PFM-ELG-03-05
Key concepts
CON-PFM-ELG-003, CON-PFM-ELG-001
Actors
ACT-PFM-023
Journeys
JNY-PFM-ELG-003
Depends on
CAP-PFM-ELG-008
Related
CAP-PFM-ELG-004, CAP-PFM-ELG-010
Open questions
OQ-PFM-ELG-001, OQ-PFM-ELG-002
Proved by
ATS-PFM-ELG-011

Implementation

Executable suites
TST-PFM-ELG-167, TST-PFM-ELG-264, TST-PFM-ELG-265, TST-PFM-ELG-266, TST-PFM-ELG-267, TST-PFM-ELG-268, TST-PFM-ELG-271, TST-PFM-ELG-274, TST-PFM-ELG-275, TST-PFM-ELG-414, TST-PFM-ELG-437, TST-PFM-ELG-458, TST-PFM-ELG-460, TST-PFM-ELG-464, TST-PFM-ELG-489

KindCapabilityProduct areaPlatformModuleEligibility, Responsibilities and AttentionRevision1

Read atservices-platform ad3f6a65react-console baf6dae3

List qualifying subjects and assess a draft’s impact ​

Purpose ​

A population run explains the reach of one version. A simulation helps staff assess how a proposed expression changes that reach.

How It Works ​

The caller chooses a version, date and subject scope. Dataset query authority is required in addition to the run or simulation permission. Platform submits background work and returns its identity. Pages persist progress so interrupted work can resume. Eligible-only work can avoid records already excluded by database predicates. Completed results offer counts, subject pages and optional exports. Comparisons identify changes between runs or versions. A draft simulation adds the consumers and references affected by publication. A publisher can attach that result or record a skip. Staff currently have no run list or cancel action, and scheduled retention cleanup is missing.

Relationships ​

  • Determine eligibility with an explanation supplies the evaluation pipeline for each subject page.

The Formal Contract

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

Outcomes
Completed bulk work separates qualifying, refusing and uncertain subjects.A release can cite its measured impact on subjects.
Surfaces
consoleapijob
Intent sources
services-platform:docs/milestones/PLAT-M12-eligibility-who-qualifies.md#Scope in one paragraph

Controls

33 controls apply, from the corpus control catalogue.

TC-AVL-004 TC-AVL-005 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-DAT-005 TC-IAM-001 TC-IAM-002 TC-IAM-004 TC-IAM-005 TC-IAM-006 TC-LOG-001 TC-LOG-004 TC-LOG-005 TC-MON-001 TC-PI-001 TC-PI-002 TC-PI-003 TC-PI-004 TC-PI-005 TC-PRV-001 TC-PRV-002 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-VEN-001 TC-VEN-002 TC-VEN-003

Permissions

KeyChecked atScope
platform.eligibility.populationapitenant
platform.eligibility.publishapitenant
crm.contacts.queryservicetenant

Business Rules

10 rules, 9 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
Population start and read require population authority plus the dataset query permission; simulation start and read require publish authority plus that dataset permission.
proved by ATS-PFM-ELG-011-01, TST-PFM-ELG-267, TST-PFM-ELG-268, TST-PFM-ELG-414
permissionapi, servicetest
services-platform:modules/eligibility/tests/e2e/eligibility-population.e2e.spec.js#refuses a population run to a caller without the dataset query key, 403 naming it
02must prove
Proposed
Population runs evaluate an effective or numbered version on its subject dataset, optionally filtered, rejecting compile failures, nonbatch providers, a foreign dataset, more than 250,000 explicit subjects or saved-query output before creating a run.
proved by ATS-PFM-ELG-011-02, TST-PFM-ELG-264, TST-PFM-ELG-265, TST-PFM-ELG-266, TST-PFM-ELG-464
validationservicetest
services-platform:modules/eligibility/tests/integration/services/population/population-run.integration.spec.js#refuses a rule whose provider type cannot be called in batches, and creates no run
03must prove
Proposed
Eligible-only runs prune subjects excluded by database conditions, but provider-dependent branches cannot eliminate candidates in advance.
proved by ATS-PFM-ELG-011-03, TST-PFM-ELG-274, TST-PFM-ELG-464, TST-PFM-ELG-489
calculationservicetest
services-platform:modules/eligibility/tests/integration/services/population/population-run.integration.spec.js#enumerates only the subjects the sql prefix keeps when the run asks for the eligible alone
04must prove
Proposed
Population jobs persist each cursor page once and resume after interruptions, with runs exceeding one million subjects stopped unless explicitly allowed.
proved by ATS-PFM-ELG-011-04, ATS-PFM-ELG-011-11, ATS-PFM-ELG-012-09, TST-PFM-ELG-464
invariantservicetest
services-platform:modules/eligibility/tests/integration/services/population/population-run.integration.spec.js#records a retried page once: the second attempt from the old cursor changes nothing
05must prove
Proposed
Completed runs expose state counts and ordered pages of at most 1,000 subject references, comparison gains and losses limited to 10,000 each, unchanged counts and optional reference-and-state exports.
proved by ATS-PFM-ELG-011-05, TST-PFM-ELG-275, TST-PFM-ELG-464
calculationservicetest
services-platform:modules/eligibility/tests/integration/services/population/population-run.integration.spec.js#answers the subjects newly eligible against the earlier run, and none no longer eligible
06must prove
Proposed
Simulations compare a draft and publication over recent decision subjects, derived-role holders and any requested scope, returning state changes and affected bindings and references, with nonbatch providers making results partial.
proved by ATS-PFM-ELG-011-06, TST-PFM-ELG-464
calculationservicetest
services-platform:modules/eligibility/tests/integration/services/population/population-run.integration.spec.js#counts each state before and after the change over the same subjects
07must prove
Proposed
Publication may cite a completed simulation of its current draft or record a skip, rejecting both choices together, foreign simulations, unfinished simulations and results for earlier drafts.
proved by ATS-PFM-ELG-004-17, ATS-PFM-ELG-010-09, ATS-PFM-ELG-011-07, ATS-PFM-ELG-011-09, ATS-PFM-ELG-011-10, TST-PFM-ELG-167, TST-PFM-ELG-271, TST-PFM-ELG-464
validationservicetest
services-platform:modules/eligibility/tests/integration/services/population/population-run.integration.spec.js#refuses a publish naming a simulation of another version of the draft
08must prove
Proposed
Population runs have a 90-day retention target and simulations 30 days; the product should enforce expiry, but scheduled cleanup is absent.
proved by ATS-PFM-ELG-011-08, TST-PFM-ELG-458, TST-PFM-ELG-460
lifecycleservicetest
services-platform:modules/eligibility/tests/integration/services/persistence/population-runs.integration.spec.js#expires the settled run once its time has come, and only in its own tenant
09must prove
Proposed
Population and simulation reads conceal other workspaces’ records, and workspace deletion removes their runs and simulations.
proved by ATS-PFM-ELG-011-12, TST-PFM-ELG-437
invariantservice, databaseobserved
services-platform:modules/eligibility/services/maintenance/tenant-participant.ts
10
Proposed
The product exposes run lookup by its returned identity but offers neither a run list nor cancellation.
policyapitest
react-console:acceptance/eligibility/playwright/journeys/population/ELIG-ACC-0450.spec.ts#ELIG-ACC-0450

Scenarios

IdGivenWhenThenProvenance
01A director needs a renewal population.They run the active-member expression on chapter contacts.Completed output gives state counts and pages without omissions or repeats.test
services-platform:modules/eligibility/tests/integration/services/population/population-run.integration.spec.js#succeeds and counts every state of the planted contacts
02A draft broadens the rate to inactive members.The director simulates and publishes with that result.Publication records the gains and losses and queues newly eligible subjects.test
react-console:acceptance/eligibility/playwright/journeys/population/ELIG-ACC-0446.spec.ts#ELIG-ACC-0446

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