Rhythm 2.0 Specifications

Appearance

CAP-MBR-STR-007Describe a unit’s dated relationships with organizations

Markdown

CAP-MBR-STR-007

Describe a unit’s dated relationships with organizations

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-MBR-STR-02
Exercised by
FAS-MBR-STR-02-01, FAS-MBR-STR-02-02, FAS-MBR-STR-02-03, FAS-MBR-STR-02-04, FAS-MBR-STR-02-05
Key concepts
CON-MBR-STR-002
Actors
ACT-MBR-001, ACT-MBR-002
Journeys
JNY-MBR-STR-001
Depends on
CAP-MBR-STR-006
Related
CAP-MBR-STR-003, CAP-MBR-STR-020
Proved by
ATS-MBR-STR-007

Implementation

Executable suites
TST-MBR-STR-077, TST-MBR-STR-080, TST-MBR-STR-081, TST-MBR-STR-087, TST-MBR-STR-100

KindCapabilityProduct areaMembershipModuleOrganizational Structure, Membership Configuration and TermsRevision1

Read atservices-membership 5994c270react-console baf6dae3

Describe a unit’s dated relationships with organizations ​

Purpose ​

Staff distinguish the legal, operating and financial organizations associated with a unit over time.

How It Works ​

An administrator chooses a relationship purpose and the CRM organization being associated with the unit. The relationship carries an effective start and optional end. Standard purposes distinguish the legal entity, operator, dues beneficiary and financial recipient. Customers can define additional purposes. Staff preserve incorporation changes by ending one legal period and beginning another. Overlapping legal periods are rejected. Other purposes can coexist over the same dates. Ending a relationship keeps the row for history and cannot extend an already recorded ending. CRM existence is not verified by these operations. Retired and merged units can still receive organization links, so staff must review the unit’s situation deliberately. The product should establish how organization verification and CRM merge handling work before presenting these links as dependable external references.

Relationships ​

  • The unit record provides the identity each dated relationship belongs to.
  • Unit merges retain these relationships for staff to resolve.
  • Provisioning supplies the standard relationship purposes.

The Formal Contract

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

Outcomes
Organizational relationships retain dates and a recognizable purpose.Legal-entity periods avoid simultaneous conflicting organizations.
Surfaces
api

Controls

37 controls apply, from the corpus control catalogue.

TC-AVL-002 TC-AVL-003 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-AZ-005 TC-AZ-006 TC-CHG-001 TC-CHG-002 TC-CHG-003 TC-CHG-004 TC-CRY-001 TC-CRY-002 TC-CRY-003 TC-DAT-001 TC-DAT-002 TC-DAT-003 TC-DAT-007 TC-IAM-001 TC-IAM-002 TC-IAM-004 TC-IAM-005 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-LOG-005 TC-PI-001 TC-PI-003 TC-PI-005 TC-PRV-001 TC-PRV-002 TC-SEC-001 TC-SEC-004 TC-TEN-001 TC-TEN-002 TC-TEN-003

Permissions

KeyChecked atScope
membership.structure.readapitenant
membership.structure.manageapitenant
membership.application.accessapitenant

Business Rules

10 rules, 7 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
An organization link includes an organization reference, a known workspace relationship kind and a start date, with optional end and notes.
proved by ATS-MBR-STR-007-01, TST-MBR-STR-081
validationapi, serviceobserved
services-membership:modules/structure/services/persistence/organizational-unit-organizations.ts:linkOrganization
02must prove
Proposed
An organization relationship cannot finish before its start date.
proved by ATS-MBR-STR-007-02, TST-MBR-STR-081
validationservice, databaseobserved
services-membership:modules/structure/services/persistence/organizational-unit-organizations.ts:requireDates
03must prove
Proposed
Legal-entity periods for one unit cannot overlap or have two open periods; other relationship kinds permit overlap.
proved by ATS-MBR-STR-007-03, TST-MBR-STR-080, TST-MBR-STR-100
invariantservice, databasetest
services-membership:tests/e2e/structure-api.e2e.spec.ts#the structure API, end to end in process › refuses a second open legal entity, 409 legal_entity_already_open
04must prove
Proposed
Ending a link retains its history and may repeat or shorten the end date, but cannot extend it or edit other link details.
proved by ATS-MBR-STR-004-08, ATS-MBR-STR-007-04, TST-MBR-STR-080
lifecycleserviceobserved
services-membership:modules/structure/services/persistence/organizational-unit-organizations.ts:unlinkOrganization
05
Proposed
The organization reference accepts 1–100 characters without checking that CRM contains the organization.
validationapiobserved
services-membership:modules/structure/aws/api/structure-requests.ts:linkBody
06must prove
Proposed
Additional relationship kinds use supplied or name-derived identifiers and reject duplicate identifiers within the workspace.
proved by ATS-MBR-STR-007-05, ATS-MBR-STR-007-09, ATS-MBR-STR-020-09, TST-MBR-STR-100
validationservicetest
services-membership:tests/e2e/structure-api.e2e.spec.ts#the structure API, end to end in process › creates a relationship type with an id derived from its name
07must prove
Proposed
Relationship kinds have no rename, retirement or deletion operation, and an inactive kind still accepts links.
proved by ATS-MBR-STR-007-07
policyapi, serviceobserved
services-membership:modules/structure/services/persistence/organizational-unit-relationship-types.ts:createOrganizationalUnitRelationshipType
08
Proposed
Organization links can be added to inactive and merged units.
proved by ATS-MBR-STR-007-08, TST-MBR-STR-077
policyserviceobserved
services-membership:modules/structure/services/persistence/organizational-unit-organizations.ts:linkOrganization
09must prove
Proposed
Link changes retain versions identifying the actor.
proved by ATS-MBR-STR-006-10, ATS-MBR-STR-007-06, TST-MBR-STR-087
invariantdatabasedocumented
services-membership:docs/migrations/structure/README.md#Tables and migrations
10
Proposed
Link creation has no repeat-request recognition, allowing duplicate non-legal-entity links.
policyservicedocumented
react-console:acceptance/membership/journeys/structure/MBR-ACC-0017.json

Scenarios

IdGivenWhenThenProvenance
01Atlanta becomes incorporated at the beginning of 2024.Staff record Atlanta Chapter Inc. as legal entity from incorporation.The dated relationship begins in 2024 without identifying a legal entity for the preceding period.test
services-membership:tests/acceptance/structure/MBR-ACC-0021.acceptance.ts#MBR-ACC-0021 scenario 11: Atlanta Chapter's incorporation, linked with dates

Edge Cases

IdGivenWhenThenProvenance
02A client does not receive its first organization-link response.It repeats the same operating-organization creation.The service records a second equivalent link.documented
react-console:acceptance/membership/journeys/structure/MBR-ACC-0017.json

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