--- id: CAP-CRM-REG-015 title: Share regions through record references and exports feature: FEAT-CRM-REG-01 product_area: crm module: regions revision: 2 status: draft product_intent: proposed implementation_evidence: observed supersedes: [] source_sha: services-crm: a8d1364f1dd44b723bb5f9acba12f983e9ec8d69 react-console: baf6dae382d6f41dce976c7f848667ccc37e076f intent_sources: - >- services-crm:docs/migrations/crm-regions/README.md#2026-10-12 — Final acceptance (second pass), decision 2026-10-11: no import of Rhythm 1.0 region data purpose: Regional definitions support references on CRM records and accompany the workspace’s exported configuration. outcomes: - CRM records can reference the registered Region object. - Workspace exports carry regional definitions and saved policy. concepts: - CON-CRM-REG-001 - CON-CRM-REG-002 actors: - ACT-CRM-003 - ACT-CRM-005 surfaces: - api - job preconditions: [] postconditions: [] permissions: [] rules: - id: BR-CAP-CRM-REG-015-01 proved_by: [] statement: >- Platform metadata registers the Region object with identifier, name, description and active fields as a reference target for CRM records. kind: policy enforced_at: - service must_prove: false provenance: observed source: 'services-crm:modules/regions/metadata/regions.object.ts:regionsObject' origin: none - id: BR-CAP-CRM-REG-015-02 proved_by: [ATS-CRM-REG-001-10, ATS-CRM-REG-015-01, ATS-CRM-REG-015-02] statement: Workspace export includes inactive and active regions in the same public shape returned by region reads. kind: policy enforced_at: - service must_prove: false provenance: observed source: 'services-crm:modules/regions/export/regions.dataset.ts:regionsDataset' origin: none - id: BR-CAP-CRM-REG-015-03 proved_by: [ATS-CRM-REG-015-01, ATS-CRM-REG-015-02] statement: >- Export includes one saved assignment-settings record with ordered criteria and declares dependencies on region and address-type exports; workspaces without saved settings export no settings row. kind: policy enforced_at: - service must_prove: false provenance: observed source: >- services-crm:modules/regions/export/region-assignment-settings.dataset.ts:regionAssignmentSettingsDataset origin: none - id: BR-CAP-CRM-REG-015-04 proved_by: [ATS-CRM-REG-015-02, ATS-CRM-REG-015-03] statement: Regional exports omit recalculation runs and the internal policy generation count. kind: policy enforced_at: - service must_prove: false provenance: inferred source: >- services-crm:modules/regions/export/region-assignment-settings.dataset.ts; services-crm:modules/regions/export/regions.dataset.ts origin: none note: >- Neither export declaration includes recalculation runs, and the settings reader omits the generation counter from its public record. - id: BR-CAP-CRM-REG-015-05 proved_by: [] statement: >- The acceptance catalogue records Regions as unavailable for direct dataset queries and for traversal to region fields through a record reference. kind: policy enforced_at: - service must_prove: false provenance: documented source: 'react-console:acceptance/crm/inventory/business-rules.json#RUL-CRM-QRY-016' origin: none - id: BR-CAP-CRM-REG-015-06 proved_by: [] statement: >- The migration decision excludes importing Rhythm 1.0 regional data; placement instead follows subsequent deciding-address changes or explicit recalculation. kind: policy enforced_at: - service must_prove: false provenance: documented source: 'services-crm:docs/migrations/crm-regions/README.md#2026-10-11 second pass' origin: >- services-crm:docs/migrations/crm-regions/README.md#2026-10-12 — Final acceptance (second pass), decision 2026-10-11: no import of Rhythm 1.0 region data scenarios: - id: SC-CAP-CRM-REG-015-01 given: A workspace has regional definitions and saved assignment rules. when: Its data export includes regional configuration. then: Active and inactive regions accompany the single saved settings record with ordered rules. provenance: inferred source: 'services-crm:modules/regions/export/region-assignment-settings.reader.ts:regionAssignmentSettingsReader' edge_cases: [] constraints: [] depends_on: - CAP-CRM-REG-001 related: - CAP-CRM-REG-001 - CAP-CRM-REG-003 journeys: [] open_questions: [] evidence: - >- services-crm: Examined the pinned regional implementation, its declared constraints and the supporting records. - 'react-console: Examined the pinned regional configuration surfaces and their available test evidence.' - 'services-crm:docs/migrations/crm-regions/README.md' - 'services-crm:modules/regions/metadata/regions.object.ts' - 'services-crm:modules/regions/export/regions.dataset.ts' - 'services-crm:modules/regions/export/region-assignment-settings.dataset.ts' - 'react-console:acceptance/crm/inventory/business-rules.json' - 'services-crm:modules/regions/export/region-assignment-settings.reader.ts' controls: [TC-DAT-001, TC-DAT-002, TC-DAT-003, TC-DAT-005, TC-LOG-005, TC-PI-001, TC-PRV-001, TC-PRV-002, TC-TEN-001, TC-TEN-002, TC-TEN-003] exercised_by: [FAS-CRM-REG-01-02] suites: [] --- # Share regions through record references and exports ## Purpose Regional definitions support references on CRM records and accompany the workspace’s exported configuration. ## How It Works Regions registers its record shape as a metadata reference target. Contacts and organizations can use that target to identify their region. The regional export supplies active and inactive definitions through the public record reader. Saved settings export as a single record with their ordered rules embedded. Region and address-type exports are dependencies of that settings dataset. Workspaces without a saved settings row contribute no settings record. Internal generation counts and recalculation history are omitted. The acceptance catalogue records a query limitation for traversing regional references. The migration decision excludes legacy regional imports; normal placement and recalculation establish the new assignments. ## Relationships - Maintain the region catalogue supplies the regional catalogue used by the surrounding work. - Configure automatic placement and its address sources establishes participation and address-source choices for placement.