Rhythm 2.0 Specifications

Appearance

CAP-ACC-CLS-016Include close history in data export and erasure

Markdown

CAP-ACC-CLS-016

Include close history in data export and erasure

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-ACC-CLS-04
Exercised by
FAS-ACC-CLS-04-03, FAS-ACC-CLS-04-05
Key concepts
CON-ACC-CLS-004
Actors
ACT-ACC-014
Related
CAP-ACC-CLS-014
Proved by
ATS-ACC-CLS-016

Implementation

Executable suites
TST-ACC-CLS-048

KindCapabilityProduct areaAccountingModuleMonth-End ClosingRevision1

Read atservices-accounting f47cb263

Include close history in data export and erasure ​

Purpose ​

Customer data operations account for close records and their dependencies when exporting or deleting a workspace.

How It Works ​

Platform requests the Accounting data operation. The fiscal-close export definition selects customer runs and embeds their captured snapshots. It withholds operational jobs and retry keys. A job reference remains with the run. Each export batch has its own consistency boundary and creation cutoff. Erasure follows the dependencies in reverse order. Snapshots are removed before jobs and runs. Only then can Books remove referenced periods. Trying to delete those periods first returns a database refusal. Another workspace’s close history remains untouched.

Relationships ​

  • The close record defines the customer history exported here.
  • Accounting Maintenance hosts the participant used by Platform’s data operations.

The Formal Contract

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

Outcomes
Exports include the customer’s retained closing history.Erasure removes that history in dependency order and isolates other workspaces.
Surfaces
job
Constraints
Platform orchestrates customer data operations through the participant hosted by Accounting Maintenance.

Controls

21 controls apply, from the corpus control catalogue.

TC-IAM-001 TC-IAM-005 TC-IAM-006 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-DAT-001 TC-DAT-002 TC-DAT-004 TC-DAT-005 TC-LOG-001 TC-LOG-002 TC-LOG-003 TC-LOG-005 TC-PI-002 TC-PI-003 TC-PI-005

Business Rules

5 rules, 5 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
The fiscal-close export includes close and reopen runs with any captured snapshot embedded in its run.
origin: workspace data export chapter 04 §2.4 (class 1 data)
proved by ATS-ACC-CLS-016-01, ATS-ACC-CLS-016-03
policyserviceobserved
services-accounting:modules/fiscal-close/export/fiscal-close.dataset.ts:fiscalCloseExport
02must prove
Proposed
Operational job rows and the request retry key are withheld from the export, while the run retains its job reference.
origin: workspace data export chapter 04 §2.4 (Rhythm operational data withheld)
proved by ATS-ACC-CLS-016-01, ATS-ACC-CLS-016-03
policyserviceobserved
services-accounting:modules/fiscal-close/export/fiscal-close.dataset.ts:fiscalCloseExport
03must prove
Proposed
Export consistency applies per batch, and requests created after the export cutoff are omitted.
proved by ATS-ACC-CLS-016-01, ATS-ACC-CLS-016-03
lifecycleserviceobserved
services-accounting:modules/fiscal-close/export/fiscal-close.dataset.ts:fiscalCloseExport
04must prove
Proposed
Erasure removes snapshots, then close and reopen jobs, then runs before removing their referenced periods.
proved by ATS-ACC-CLS-016-02, ATS-ACC-CLS-016-03, ATS-ACC-CLS-016-04, TST-ACC-CLS-048
invariantdatabasetest
services-accounting:modules/maintenance/tests/integration/services/participants/fiscal-close-participant.integration.spec.js#is refused by the database when the configuration is purged before fiscal close, whose runs name its periods
05must prove
Proposed
Purging close history removes only records belonging to the selected workspace.
proved by ATS-ACC-CLS-016-02, ATS-ACC-CLS-016-03, ATS-ACC-CLS-016-04, TST-ACC-CLS-048
invariantdatabasetest
services-accounting:modules/maintenance/tests/integration/services/participants/fiscal-close-participant.integration.spec.js#leaves the other tenant’s rows exactly as they were

Scenarios

IdGivenWhenThenProvenance
01Two workspaces retain close histories and one is selected for erasure.The lifecycle participant removes the selected history.It removes snapshots, jobs and runs before periods and preserves the other workspace’s records.test
services-accounting:modules/maintenance/tests/integration/services/participants/fiscal-close-participant.integration.spec.js#empties fiscal close’s tables of the tenant

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