Rhythm 2.0 Specifications

Appearance

CAP-PFM-DJE-017Reset a loading workspace and review its release

Markdown

CAP-PFM-DJE-017

Reset a loading workspace and review its release

Markdown
  • DocumentDraft
  • Product intentConfirmed
  • ImplementationPartially observed

Planning

Feature
FEAT-PFM-DJE-05
Exercised by
FAS-PFM-DJE-05-01, FAS-PFM-DJE-05-02, FAS-PFM-DJE-05-03, FAS-PFM-DJE-05-05
Key concepts
CON-PFM-DJE-005, CON-PFM-DJE-004
Actors
ACT-PFM-037, ACT-PFM-038
Journeys
JNY-PFM-DJE-004
Related
CAP-PFM-DJE-016, CAP-PFM-DJE-015
Proved by
ATS-PFM-DJE-017

Implementation

Executable suites
TST-PFM-DJE-122

KindCapabilityProduct areaPlatformModuleData Job EngineRevision1

Read atservices-platform ad3f6a65services-crm a8d1364f

Reset a loading workspace and review its release ​

Purpose ​

Implementation staff recover from a faulty initial load while a separate activation decision controls when ordinary workspace work can resume.

How It Works ​

Implementation staff request reset when correcting individual records cannot repair an initial load. They confirm the intended workspace and its loading context. The reset contract checks participant support before removal. Participant work clears loaded records and mappings while retaining the resources needed to load again. A failed sequence can leave partial removal and must be addressed before repeating it. Existing CRM fixtures demonstrate repeatable removal and reload within their tested participant set. Reconciliation then supports review of the new load. A separately authorized operator releases the workspace through activation. The planned blocker check is absent, so an active lifecycle is currently not proof that the load passed readiness.

Relationships ​

  • Migration runs supply the initial load that reset clears.
  • Producer-key reconciliation supports review before release.

The Formal Contract

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

Outcomes
Reset clears loaded domain data while retaining implementation support records.The cited reload fixtures preserve records and numbering.Activation has separate authority and a planned readiness gate.
Surfaces
api
Intent sources
services-platform:docs/milestones/PLAT-M19-data-job-engine-foundations.md#D5services-platform:docs/milestones/plans/PLAT-M19-plan.md#S23services-platform:docs/milestones/plans/PLAT-M22-plan.md#A1services-platform:docs/milestones/plans/PLAT-M22-plan.md#A3services-platform:docs/milestones/plans/PLAT-M22-plan.md#9. Acceptance scenarios

Controls

33 controls apply, from the corpus control catalogue.

TC-AVL-001 TC-AVL-004 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-AZ-005 TC-CHG-001 TC-CHG-002 TC-CHG-003 TC-CHG-004 TC-CHG-005 TC-CHG-006 TC-CHG-007 TC-DAT-001 TC-DAT-002 TC-DAT-003 TC-DAT-006 TC-IAM-003 TC-LOG-001 TC-LOG-004 TC-LOG-005 TC-MON-001 TC-PI-001 TC-PI-002 TC-PI-004 TC-PI-005 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-VEN-001 TC-VEN-002 TC-VEN-003

Permissions

KeyChecked atScope
hq.data-runs.manageapiglobal
hq.tenants.activateapiglobal

Business Rules

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

IdRuleKindEnforced atProvenance
01must prove
Confirmed
The reset contract requires implementation status, loading lifecycle and the workspace identifier as confirmation, with eligibility checked before recording and processing the reset.
origin: services-platform:docs/milestones/PLAT-M19-data-job-engine-foundations.md#D5
proved by ATS-PFM-DJE-017-01
validationservicedocumented
services-platform:docs/data-jobs/tenant-reset.md#1. When a tenant may be reset
02must prove
Confirmed
The reset contract clears participating domain data, jobs and producer mappings while preserving security, uploads, run records and retained implementation configuration; CRM fixtures demonstrate removal of loaded CRM records.
origin: services-platform:docs/milestones/plans/PLAT-M19-plan.md#S23
proved by ATS-PFM-DJE-011-12, ATS-PFM-DJE-015-08, ATS-PFM-DJE-016-17, ATS-PFM-DJE-017-02, ATS-PFM-DJE-017-08, ATS-PFM-DJE-017-09, ATS-PFM-DJE-017-10, TST-PFM-DJE-122
policyservicetest
services-crm:modules/data-jobs/tests/integration/services/jobs/initial-import-guarantees.integration.spec.js#removes everything the load wrote: no contact, organization, imported type or crosswalk row is left
03must prove
Confirmed
The reset contract refuses unsupported service participants before any removal.
proved by ATS-PFM-DJE-017-03
validationservicedocumented
services-platform:docs/data-jobs/tenant-reset.md#3.1 Declaring support
04must prove
Confirmed
In the cited reset fixtures, repeating reset removes nothing, another workspace remains intact and reloading the package reproduces records and numbers.
origin: services-platform:docs/milestones/plans/PLAT-M22-plan.md#9. Acceptance scenarios
proved by ATS-PFM-DJE-011-12, ATS-PFM-DJE-015-08, ATS-PFM-DJE-016-17, ATS-PFM-DJE-017-04, ATS-PFM-DJE-017-08, ATS-PFM-DJE-017-09, ATS-PFM-DJE-017-10, TST-PFM-DJE-122
invariantservice, databasetest
services-crm:modules/data-jobs/tests/integration/services/jobs/initial-import-guarantees.integration.spec.js#reloads the same records as the load before the reset, numbers included
05
Confirmed
A failed reset can leave domain data partly removed while the workspace remains loading; another attempt starts the participant sequence again.
proved by ATS-PFM-DJE-016-17, ATS-PFM-DJE-017-09
lifecycleservicedocumented
services-platform:docs/data-jobs/tenant-reset.md#1. When a tenant may be reset
06must prove
Confirmed
Activation uses permission separate from loading and reset, restoring active lifecycle without changing workspace status.
origin: services-platform:docs/milestones/plans/PLAT-M22-plan.md#A3
proved by ATS-PFM-DJE-017-05
permissionapidocumented
services-platform:docs/data-jobs/data-runs.md#7. The summary and the readiness verdict
07must prove
Confirmed
The product should refuse activation while load-readiness blockers remain; the cited activation implementation does not yet apply that gate.
origin: services-platform:docs/milestones/plans/PLAT-M22-plan.md#A3
proved by ATS-PFM-DJE-017-06
policydocumented
services-platform:docs/milestones/plans/PLAT-M22-plan.md#A3
08must prove
Confirmed
A loading workspace permits its users to reach allowed job and reconciliation routes while ordinary routes report unavailable.
origin: services-platform:docs/milestones/plans/PLAT-M19-plan.md#A7
proved by ATS-PFM-DJE-017-07
policyapidocumented
services-platform:docs/data-jobs/platform-data-operations.md#Reading a load back by source key

Scenarios

IdGivenWhenThenProvenance
01A loading workspace received input with incorrect mappings.Staff reset its data and register corrected input.The earlier loaded records are removed and the new load uses retained implementation support, including uploads and users.test
services-crm:modules/data-jobs/tests/integration/services/jobs/initial-import-guarantees.integration.spec.js#applies every item of every file of the reload, nothing being recognised from before the reset

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