Rhythm 2.0 Specifications

Appearance

DOM-PFM-QRY-006Monthly Snapshot

Markdown

DOM-PFM-QRY-006

Monthly Snapshot

Markdown
  • DocumentDraft
  • ImplementationObserved

Planning

Specified by
CON-PFM-QRY-006

Design

Owned by
SVC-PFM-QRY-snapshots

KindDomain objectProduct areaPlatformModuleQuestions, record exploration and data deliveryRevision1

Read atservices-platform ad3f6a65

Monthly Snapshot ​

What It Models ​

Monthly snapshots preserve a versioned view for later reporting. The shared ledger makes missing, skipped and failed periods visible as operational outcomes.

Identity and Attributes ​

Every type owns its generation behavior and rows. The workspace’s time zone defines its calendar periods; staff policy controls eligibility.

Relationships ​

The available-period interface is ready for a report selector, but the corresponding console integration remains unfinished.

Invariants ​

The invariant rows separate final publication atomicity from chunk staging. Earlier published versions remain current when final validation fails.

How It Is Stored and Shared ​

The snapshot service declares the shared ledger and Platform self-test types. Owner roles use the shared library; the jobs HTTP function hosts snapshot routes.

Open Design Questions ​

Cross-application staff reruns and backfills remain outside the implemented scope. Product must reconcile the failed-run row-retention promise with chunked generation.

Relationships

ToCardinalityOwnershipCrosses a serviceOn archive or delete
DOM-PFM-QRY-003one-to-manyAvailable-period reads support an intended report month selector; the console has not connected that selector.no

Invariants

InvariantProtectsEnforced atProvenance
INV-DOM-PFM-QRY-006-01
Unique indexes allow one active run and one current version for each workspace, type and period.
databaseobserved
services-platform:modules/snapshots/db/snapshot-runs.table.ts (the library's active and current unique indexes)
INV-DOM-PFM-QRY-006-02
Final validation and publication commit together. Small-run failures discard all generated rows; chunked failures can retain committed but unpublished rows.
service, databaseobserved
services-platform:node_modules/@rhythmsoftware/macroservice-snapshots/dist/snapshot-run-workflow.js:advanceSnapshotRun
INV-DOM-PFM-QRY-006-03
Database security confines each owning service to its runs and prevents application roles from deleting ledger rows.
databaseobserved
services-platform:modules/snapshots/db/snapshot-runs.table.ts (migration 0105, snapshotSecuritySql)
INV-DOM-PFM-QRY-006-04
Runs preserve earlier versions as history until workspace deletion removes the workspace’s data.
serviceobserved
services-platform:modules/snapshots/services/persistence/snapshot-runs.ts
INV-DOM-PFM-QRY-006-05
The planner inserts only period version one, so repeated planning does not create duplicate scheduled versions.
database, serviceobserved
services-platform:modules/snapshots/aws/logic/snapshots-functions.lambda.ts
INV-DOM-PFM-QRY-006-06
Admission respects the configured total cap and permits at most one admitted backfill.
serviceobserved
services-platform:modules/snapshots/aws/snapshots.configuration.ts
INV-DOM-PFM-QRY-006-07
Workspace period reads remain workspace-scoped and select the current version, or otherwise the highest version, for each month.
service, databasetest
services-platform:modules/snapshots/tests/e2e/snapshots.e2e.spec.js#refuses another customer’s user the tenant’s periods

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