Rhythm 2.0 Specifications

Appearance

CAP-PFM-TNL-010Supply application data for workspace exports

Markdown

CAP-PFM-TNL-010

Supply application data for workspace exports

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-PFM-TNL-03
Key concepts
CON-PFM-TNL-003
Actors
ACT-PFM-012
Depends on
CAP-PFM-TNL-007
Open questions
OQ-PFM-TNL-004
Proved by
ATS-PFM-TNL-010

KindCapabilityProduct areaPlatformModuleWorkspace Lifecycle Across ApplicationsRevision2

Read atservices-platform ad3f6a65services-crm a8d1364fservices-commerce c8b66a98services-committees 36129c24services-membership 5994c270services-submissions 64236c19services-websites 5fc6823cservices-marketing d071a159

Supply application data for workspace exports ​

Purpose ​

Application participants contribute classified workspace datasets to the separate export process.

How It Works ​

The export coordinator asks an application participant for a dataset batch. The application reads in the requested workspace and writes a part to its staging area. Its answer supplies the information and cursor needed for continuation. Dataset declarations account for included tables and explain withheld records. Credentials and operational bookkeeping can be excluded deliberately. CRM rejects datasets and staging prefixes outside its declaration before reading. Other exporting applications implement their own contract checks. Committees and Marketing do not currently serve export. Scheduling, package delivery and the overall export remain responsibilities of the export module.

Relationships ​

  • Account for each application’s lifecycle responsibilities: Its result establishes the state or declared resources needed by this operation.

The Formal Contract

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

Outcomes
Declared tables have dataset coverage or an explicit withholding classification.Export batches contain only the requested workspace’s values.The caller drives continuation within the application’s staging area.
Surfaces
job
Intent sources
services-platform:docs/proposals/tenant-data-export/20-risks-tradeoffs-decisions.md#D-02

Controls

36 controls apply, from the corpus control catalogue.

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

Business Rules

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

IdRuleKindEnforced atProvenance
01must prove
Confirmed
An exporting application returns one workspace dataset batch and the part information and cursor needed to continue.
origin: services-platform:docs/proposals/tenant-data-export/20-risks-tradeoffs-decisions.md#D-02 (Andrew, 2026-10-18)
no proof recorded yet
policyservicetest
services-crm:modules/tenant-lifecycle/tests/integration/services/export/tenant-export.integration.spec.js#pages a dataset of more records than a batch holds, the cursor carrying it on
02must prove
Confirmed
Export classification assigns every declared table to a dataset or to a stated withholding class and reason; unclassified tables fail completeness checks.
origin: services-platform:docs/proposals/tenant-data-export/20-risks-tradeoffs-decisions.md#D-02
no proof recorded yet
invariantservicetest
services-crm:modules/tenant-lifecycle/tests/integration/services/export/tenant-export.integration.spec.js#withholds every declared table it does not export, each with its class and reason
03must prove
Confirmed
Exported records identify the requested workspace and the package contains no other workspace’s values.
origin: services-platform:docs/proposals/tenant-data-export/20-risks-tradeoffs-decisions.md#D-02
no proof recorded yet
invariantservice, databasetest
services-crm:modules/tenant-lifecycle/tests/integration/services/export/tenant-export.integration.spec.js#carries no value of the other tenant anywhere in the package
04must prove
Confirmed
CRM rejects undeclared datasets and staging prefixes outside its application area before export reads.
origin: services-platform:docs/proposals/tenant-data-export/20-risks-tradeoffs-decisions.md#D-02
no proof recorded yet
validationservicetest
services-crm:modules/tenant-lifecycle/tests/integration/services/export/tenant-export.integration.spec.js#refuses a staging prefix outside this service’s own as an invalid request, before anything is read
05
Confirmed
Exports omit credentials, connection secrets and operational records such as carrier connection references and workflow approvals.
origin: services-platform:docs/proposals/tenant-data-export/20-risks-tradeoffs-decisions.md#D-02
policyservicetest
services-commerce:modules/tenant-lifecycle/tests/unit/exports/export-round-trip.spec.js#withholds a carrier account’s connection reference
06
Proposed
CRM, Commerce, Submissions, Websites and Membership implement export; Committees and Marketing currently do not.
policyserviceobserved
services-committees:modules/tenant-lifecycle/services/lifecycle/tenant-lifecycle-operations.ts:TENANT_LIFECYCLE_OPERATIONS

Scenarios

IdGivenWhenThenProvenance
01The customer requests a complete data package.The coordinator pages CRM’s contact dataset.Contact batches include their custom values and provide continuation until complete.test
services-crm:modules/tenant-lifecycle/tests/integration/services/export/tenant-export.integration.spec.js#carries every custom-field value on its parent, with its value, and none on a contact role or an activity (R2-ARCH-001)

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