Rhythm 2.0 Specifications

Appearance

DOM-PFM-MTD-006Relationship

Markdown

DOM-PFM-MTD-006

Relationship

Markdown
  • DocumentDraft
  • ImplementationObserved

Planning

Specified by
CON-PFM-MTD-006

Design

Owned by
SVC-PFM-MTD-associations

KindDomain objectProduct areaPlatformModuleMetadata and Organization-defined RecordsRevision1

Read atservices-platform ad3f6a65react-console baf6dae3

Relationship ​

What It Models ​

Relationships let an organization connect records with its own vocabulary. A type defines direction, endpoint categories and policy; a link records a connection between specific records.

Identity and Attributes ​

Type shape and link endpoints are fixed. Labels and permitted policies can change; link dates and annotations are replaceable. An end date stops occupancy only after that day passes.

Relationships ​

Endpoints are contacts, organizations or custom records. A qualifying type can supply ownership, and every endpoint owner must apply the corresponding deletion and merge contract.

Invariants ​

Locks and span checks protect ordinary occupancy. Policy prevents native cascades, protects owner types and couples endpoint deletion with link consequences.

How It Is Stored and Shared ​

Associations writes types and links. CRM uses Platform’s database functions inside its own transaction, and database capture records changes for the first side and a custom second side.

Open Design Questions ​

Required-link settings and type-count limits are not enforced. Native-record link history is retained here but still lacks a CRM timeline presentation.

Relationships

ToCardinalityOwnershipCrosses a serviceOn archive or delete
DOM-PFM-MTD-001many-to-manyA type owns its category choices and resolves endpoints through the registry or a registered resolver.yes
DOM-PFM-MTD-005many-to-manyAssociations stores links to custom records; their store supplies endpoint resolution and cascade deletion.no
DOM-PFM-MTD-004one-to-manyA custom object selects one owner type, protecting that type from retirement while selected.no

Invariants

InvariantProtectsEnforced atProvenance
INV-DOM-PFM-MTD-006-01
Endpoint types, cardinality and dating are fixed for the life of a relationship type.
servicetest
services-platform:modules/associations/tests/integration/services/persistence/association-types.integration.spec.js#refuses a change of cardinality, the shape o
INV-DOM-PFM-MTD-006-02
Cascade policies cannot remove contacts or organizations.
service, databasetest
services-platform:modules/associations/tests/integration/services/persistence/association-types.integration.spec.js#refuses a cascade that would delete a native
INV-DOM-PFM-MTD-006-03
A type named as any object's owner cannot be removed or deactivated; removal of a currently used type deactivates it.
servicetest
services-platform:modules/associations/tests/integration/services/persistence/association-types.integration.spec.js#refuses deactivating the type of one object,
INV-DOM-PFM-MTD-006-04
Ordinary place checks reject overlapping spans for a pair, restricted endpoint or first-side primary, while adjacent spans are permitted.
service, databasetest
services-platform:modules/associations/tests/integration/services/persistence/associations.in-force.integration.spec.js#refuses a second link of a one-place typ
INV-DOM-PFM-MTD-006-05
Conflicting concurrent link writes cannot both acquire the same place.
service, databasetest
services-platform:modules/associations/tests/integration/services/persistence/associations.in-force.integration.spec.js#refuses one of two writers of overlappin
INV-DOM-PFM-MTD-006-06
Link identity retains type and endpoints, disallows self-links and admits ordered dates only for dated types.
service, databasetest
services-platform:modules/associations/tests/integration/services/persistence/associations.integration.spec.js#refuses an end before the start on a dated type
INV-DOM-PFM-MTD-006-07
Creation caps links at one thousand per record, type and side, counting ended links; merges may exceed the cap.
servicetest
services-platform:modules/associations/tests/integration/services/persistence/associations.integration.spec.js#refuses an association past the per-record limit
INV-DOM-PFM-MTD-006-08
Endpoint deletion applies side-specific detach, cascade and restrict policies in the caller's transaction and removes ended links regardless of policy.
databasetest
services-platform:modules/associations/tests/integration/db/apply-endpoint-deletion.integration.spec.js#answers what endpointDeletionOutcome says for an open as
INV-DOM-PFM-MTD-006-09
Deletion and merge functions restrict changes to the session workspace and authorized application roles.
databasetest
services-platform:modules/associations/tests/integration/db/apply-endpoint-deletion.integration.spec.js#refuses another tenant than the transaction’s with 42501
INV-DOM-PFM-MTD-006-10
Merge redirects duplicate endpoints to the survivor, ends collisions on the merge day and clears extra primary flags; a repeated apply has no remaining moves.
databasetest
services-platform:modules/associations/tests/integration/db/associations-merge.integration.spec.js#counts the associations held by m, and says how many end inst

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