Rhythm 2.0 Specifications

Appearance

CAP-PFM-DJE-018Enable product records to use the shared job engine

Markdown

CAP-PFM-DJE-018

Enable product records to use the shared job engine

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-04, FAS-PFM-DJE-05-05
Key concepts
CON-PFM-DJE-001
Actors
ACT-PFM-035, ACT-PFM-036, ACT-PFM-037
Related
CAP-PFM-DJE-001, CAP-PFM-DJE-016
Proved by
ATS-PFM-DJE-018

Implementation

Executable suites
TST-PFM-DJE-015, TST-PFM-DJE-035, TST-PFM-DJE-037, TST-PFM-DJE-168, TST-PFM-DJE-169

KindCapabilityProduct areaPlatformModuleData Job EngineRevision1

Read atmacroservice-libraries 54536a44services-platform ad3f6a65services-crm a8d1364fservices-membership 5994c270

Enable product records to use the shared job engine ​

Purpose ​

Product areas connect their own record rules and persistence to a common job engine rather than defining separate bulk-processing behavior.

How It Works ​

Each product area declares which record operations can use the engine. The declaration connects input contracts and authority to domain validation and writes. Unsupported declarations fail before serving requests. Consumer persistence supplies the common job records under workspace security. CRM uses workers and bulk workflows for its record jobs. Platform processes bounded datasets within request handling after the submission transaction commits. Its field definitions and custom records still use their domain rules. Platform has no rollback declaration for these imports. Membership’s operation declarations remain incomplete integration rather than runnable job surfaces. The product should complete that foundation before relying on Membership migration.

Relationships ​

  • Submission selects declared operations.
  • Migration runs submit supported datasets to those operation surfaces.

The Formal Contract

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

Outcomes
Operation declarations connect domain behavior to shared processing.Platform metadata and custom records use the common engine.Invalid operation contracts fail during initialization.
Surfaces
apijob
Intent sources
services-platform:docs/milestones/plans/PLAT-M19-plan.md#S17services-platform:docs/milestones/plans/PLAT-M19-plan.md#6. Approach

Controls

37 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-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-003 TC-DAT-004 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-004 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-VEN-001 TC-VEN-002 TC-VEN-003

Permissions

KeyChecked atScope
platform.custom-fields.bulkapitenant
platform.custom-fields.createapitenant
platform.custom-fields.updateapitenant
platform.custom-records.createapitenant
platform.custom-records.updateservicerecord
platform.associations.createapitenant
platform.associations.updateapitenant

Business Rules

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

IdRuleKindEnforced atProvenance
01must prove
Confirmed
An operation declaration identifies accepted input versions, permissions, editable fields, matching keys, dependencies, grouping, suppression choices and domain checks and writes; missing versions or deletes with editable fields or rollback are refused at initialization.
proved by ATS-PFM-DJE-001-15, ATS-PFM-DJE-018-01, ATS-PFM-DJE-018-09, TST-PFM-DJE-015, TST-PFM-DJE-037
validationservicetest
macroservice-libraries:packages/data-jobs/src/validate-data-job-request.spec.ts#refuses a delete that declares patchable fields, which a delete never sets
02must prove
Confirmed
Consumers host eight base engine tables with fail-closed workspace security; receipt completion allows updates, rejection evidence is insert-and-read only, and queue, submission and mapping rows have their declared deletion grants.
proved by ATS-PFM-DJE-018-02, TST-PFM-DJE-035
invariantdatabaseobserved
macroservice-libraries:packages/data-jobs/src/row-level-security.ts:PRIVILEGES
03must prove
Confirmed
Platform field-definition import uses metadata creation, update, archive and restore behavior; insert refuses an existing definition and incoming archived state is applied after its write.
origin: services-platform:docs/milestones/plans/PLAT-M19-plan.md#S17
proved by ATS-PFM-DJE-018-03, TST-PFM-DJE-168
policyservicetest
services-platform:modules/data-jobs/tests/integration/services/jobs/custom-field-data-jobs.integration.spec.js#refuses the same change as an insert, naming the definition rather than writing a second one
04must prove
Confirmed
Supplied field rules replace the definition’s rule set, omitted rules remain intact, references to later definitions refuse the line, and archived definitions carry no rules.
proved by ATS-PFM-DJE-018-04
policyservicedocumented
services-platform:docs/data-jobs/platform-data-operations.md#1.1 A definition's rules (the package format)
05must prove
Confirmed
Platform claims and processes queued batches in request handling after submission commits; exhausted transient errors pause work because there is no external queue redelivery.
proved by ATS-PFM-DJE-018-05
policyservicedocumented
services-platform:docs/data-jobs/platform-data-operations.md#3. The batches run in the submitting request
06must prove
Confirmed
Platform parses uploaded datasets at submission and refuses more than 500 nonblank record lines with their count.
proved by ATS-PFM-DJE-018-06
validationserviceobserved
services-platform:modules/data-jobs/services/jobs/custom-field-data-jobs.ts:parseDatasetLines
07must prove
Confirmed
Field-definition jobs require bulk and the appropriate create or update authority; custom-record and association jobs require their domain permissions with object scope checked for each line.
proved by ATS-PFM-DJE-001-15, ATS-PFM-DJE-016-18, ATS-PFM-DJE-018-07, ATS-PFM-DJE-018-09, ATS-PFM-DJE-018-10, TST-PFM-DJE-168
permissionapi, servicetest
services-platform:modules/data-jobs/tests/integration/services/jobs/custom-field-data-jobs.integration.spec.js#refuses a caller who may create a definition but holds no bulk right
08must prove
Confirmed
Custom-record prevalidation includes domain write rules, within-file uniqueness and association limits, with line-specific refusals and unchanged outcomes on repeated input.
origin: services-platform:docs/milestones/plans/PLAT-M19-plan.md#S17
proved by ATS-PFM-DJE-016-18, ATS-PFM-DJE-018-08, ATS-PFM-DJE-018-10, TST-PFM-DJE-169
policyservicetest
services-platform:modules/data-jobs/tests/integration/services/jobs/custom-object-data-jobs.integration.spec.js#refuses a hull number an earlier line of the same file holds, naming that line
09
Confirmed
Platform operations expose no rollback, leaving workspace reset as the recovery path for an unsuitable initial load.
policyservicedocumented
services-platform:docs/data-jobs/platform-data-operations.md#There is no `/rollback`
10
Confirmed
Membership declares organizational structure operations and parent dependencies but has no engine persistence, job routes or worker to execute them.
policyserviceobserved
services-membership:modules/data-jobs/services/operations/structure-data-operations.ts

Scenarios

IdGivenWhenThenProvenance
01A field-definition dataset contains two eligible definitions and one invalid definition.The administrator submits its import.The two valid definitions apply and the invalid line becomes a refusal on a completed-with-rejections job.test
services-platform:modules/data-jobs/tests/integration/services/jobs/custom-field-data-jobs.integration.spec.js#applies the two good definitions and rejects only the bad one

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