Rhythm 2.0 Specifications

Appearance

CAP-CRM-REG-014Import a catalogue of regions

Markdown

CAP-CRM-REG-014

Import a catalogue of regions

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationPartially observed

Planning

Feature
FEAT-CRM-REG-01
Key concepts
CON-CRM-REG-001
Actors
ACT-CRM-004, ACT-CRM-003
Depends on
CAP-CRM-REG-001
Related
CAP-CRM-REG-001, CAP-CRM-REG-013
Proved by
ATS-CRM-REG-014

KindCapabilityProduct areaCRMModuleRegionsRevision2

Read atservices-crm a8d1364freact-console baf6dae3

Import a catalogue of regions ​

Purpose ​

Authorized integrations load regional configuration from files through the shared data-job workflow.

How It Works ​

An integration submits a regional file through the shared data-job surface. Every regional job operation requires bulk and update authority together. The hosted routes expose submission, inspection, results and job controls. The Data Job Engine carries out processing and reports row outcomes. Regional row mapping applies the same schema and persistence used by direct regional writes. Invalid identifiers, unusable names or conflicting workspace values can reject a row. Accepted inputs can carry external identifiers and locks. The console currently provides no regional file-import action. Product can decide whether a customer-facing import flow is needed without duplicating the job engine’s responsibilities.

Relationships ​

  • Maintain the region catalogue supplies the regional catalogue used by the surrounding work.
  • Restrict regional work to authorised users defines authority for the regional workflow.

The Formal Contract

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

Outcomes
Valid file rows use regional persistence; rejected rows retain an explanation.
Surfaces
apijob

Controls

24 controls apply, from the corpus control catalogue.

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

Permissions

KeyChecked atScope
crm.regions.bulkapitenant
crm.regions.updateapitenant

Business Rules

6 rules, 3 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
Every regional import operation requires both bulk and update authority and cannot be used with read authority alone.
no proof recorded yet
permissionapitest
services-crm:tests/unit/regions-authorization.spec.ts#the data jobs of regions, which are the configuration data-job routes under /regions › requires crm.regions.bulk AND crm.regions.update of every one of them, which the read key alone does not give
02must prove
Proposed
Regional import exposes twelve operations covering submission, job listing and reading, source-key lookup, results, rejections, application, pause, resume, cancel, retry and conflict revalidation.
no proof recorded yet
policyapitest
services-crm:tests/unit/regions-authorization.spec.ts#the data jobs of regions, which are the configuration data-job routes under /regions › publishes the twelve routes a job of regions has: the submission, the list, the status, the lookup by source key, the two pages, the apply, the four control actions and the revalidation of conflicts
03must prove
Proposed
Imported region rows use the same validation and persistence as direct creation or replacement, including identifier, name and workspace checks.
no proof recorded yet
validationserviceobserved
services-crm:modules/data-jobs/services/operations/configuration-imports.ts:regionImports
04
Proposed
Region imports can supply external identifiers and locks accepted by ordinary creation.
policyserviceobserved
services-crm:modules/data-jobs/services/operations/configuration-imports.ts:regionImports
05
Proposed
The acceptance catalogue describes no regional import control in the console, leaving this workflow available through API operations.
policyconsoledocumented
react-console:acceptance/crm/inventory/capabilities.json#CAP-CRM-CFG-022
06
Proposed
The Data Job Engine owns job execution and controls; Regions hosts the regional routes and delegates the row writes.
policyserviceobserved
services-crm:modules/regions/aws/api/regions.routes.ts:regionsModuleRoutes; services-crm:modules/regions/aws/regions.module.ts:regionsModule

Scenarios

IdGivenWhenThenProvenance
01An integration prepares a file containing a chapter catalogue.It submits and applies the regional data job.Valid rows become regions and an identifier containing a space is rejected.inferred
services-crm:modules/data-jobs/services/operations/configuration-imports.ts:regionImports

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