Rhythm 2.0 Specifications

Appearance

CAP-CRM-ACT-001Log one interaction for all related people and organizations

Markdown

CAP-CRM-ACT-001

Log one interaction for all related people and organizations

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-CRM-ACT-01
Key concepts
CON-CRM-ACT-001
Actors
ACT-CRM-001, ACT-CRM-004
Journeys
JNY-CRM-ACT-001, JNY-CRM-ACT-004
Depends on
CAP-CRM-ACT-008
Related
CAP-CRM-ACT-002, CAP-CRM-ACT-003, CAP-CRM-ACT-005
Proved by
ATS-CRM-ACT-001

KindCapabilityProduct areaCRMModuleActivities, Follow-ups and Task WorkRevision2

Read atservices-crm a8d1364freact-console baf6dae3

Log one interaction for all related people and organizations ​

Purpose ​

Staff capture an interaction once and connect it to every CRM record involved.

How It Works ​

A coordinator starts from a contact or organization and chooses Log Activity. They select the activity type and enter the details the form presents. Linked records describe everyone involved, while the primary selection establishes the preferred record context. Rhythm applies the type’s defaults to omitted details. An activity can have empty ownership after editing, but an initial user save fills it from the caller even when No Owner is selected. Formatted notes pass through cleaning before storage. A refused save returns the detected problems and does not retain the activity. A repeated create can recover the original record after a lost response. The customer’s migration and integration processes can also supply activities through their separate import paths.

Relationships ​

  • Activity configuration supplies the available types and form choices.
  • Record timelines present saved interactions in their related contexts.
  • Follow-up creation adds work to an initial activity save.

The Formal Contract

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

Outcomes
A shared account of the interactionDetails suited to the activity typeNo duplicate entry after a retried create
Surfaces
consoleapijob
Preconditions
At least one activity type is active in the workspace.All selected contacts and organizations belong to this workspace.
Postconditions
Activity details and links commit together or are rolled back together.
Intent sources
services-crm:docs/milestones/CRM-M8-activities-and-tasks.md#D-43services-crm:docs/milestones/CRM-M8-activities-and-tasks.md#D-50services-crm:docs/milestones/CRM-M8-activities-and-tasks.md#D-51R2-ARCH-001 D1 (Andrew 2026-10-19), recorded at services-crm:docs/migrations/activities/README.md#9. Decisions

Controls

18 controls apply, from the corpus control catalogue.

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

Permissions

KeyChecked atScope
crm.activities.createapitenant
crm.activities.createconsoletenant

Business Rules

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

IdRuleKindEnforced atProvenance
01must prove
Proposed
An activity links between one and 200 distinct workspace records, and each link identifies either a contact or an organization.
✓ A meeting involving two contacts and their organization saves as one activity.✗ A single link identifying a contact and an organization fails validation.
no proof recorded yet
validationapi, service, databasetest
services-crm:modules/activities/tests/integration/services/persistence/activities.integration.spec.js#refuses an activity linked to nothing
02must prove
Confirmed
Only one link can be primary; if none is selected, Rhythm makes the first link primary.
origin: services-crm:docs/milestones/CRM-M8-activities-and-tasks.md#D-50
no proof recorded yet
policyservice, databasetest
services-crm:modules/activities/tests/integration/services/persistence/activities.integration.spec.js#makes the first link the primary one when none says it is
03must prove
Proposed
Creating an activity requires an active activity type from the same workspace.
no proof recorded yet
validationservicetest
services-crm:modules/activities/tests/integration/services/persistence/activities.integration.spec.js#refuses an inactive type for a new activity
04must prove
Proposed
Field modes control hidden and required details, with required duration and outcome checked only on completion and hidden attendees still permitted as links.
no proof recorded yet
validationconsole, serviceobserved
services-crm:modules/activities/services/activities/field-modes.ts:fieldModeProblems
05must prove
Proposed
An activity type that requires attendees needs a linked contact other than the primary record.
no proof recorded yet
validationconsole, servicetest
services-crm:modules/activities/tests/integration/services/persistence/activities.integration.spec.js#asks for an attendee besides the primary record when the type requires attendees
06must prove
Proposed
A newly selected outcome must be active and belong to the selected activity type, with the type relationship also checked in storage.
no proof recorded yet
validationservice, databasetest
services-crm:modules/activities/tests/integration/services/persistence/activities.integration.spec.js#refuses an outcome of another type
07must prove
Proposed
The end cannot precede the start, duration must be between zero and 1,440 minutes, and the subject cannot exceed 500 characters; refusals identify the affected field.
no proof recorded yet
validationservice, databasetest
services-crm:modules/activities/tests/integration/services/persistence/activities.integration.spec.js#refuses an end before the start
08must prove
Proposed
Rhythm cleans formatted notes of scripts, styles, frames, event handlers and unsafe links, treats content reduced to nothing as empty, and limits the result to 100,000 characters.
no proof recorded yet
calculationservice, databasetest
services-crm:modules/activities/tests/unit/services/activities/activity-body.spec.js#drops a script and its content
09must prove
Proposed
A new activity defaults to the current time, its type’s initial status and visible default duration, and the signed-in user as owner.
no proof recorded yet
calculationservicetest
services-crm:modules/activities/tests/integration/services/persistence/activities.integration.spec.js#defaults the status, the time and the owner from the type, the clock and the caller
10
Confirmed
Ownership is optional and remains separate from creation and modification attribution.
origin: services-crm:docs/milestones/CRM-M8-activities-and-tasks.md#D-51
policyconsole, servicetest
react-console:lib/activities/form-rules.test.ts#does not ask for an owner: an activity may have none (D-51)
11must prove
Confirmed
Repeating an identical create under the same client-selected identifier returns the existing activity, while different content under that identifier causes a conflict.
origin: services-crm:docs/milestones/CRM-M8-activities-and-tasks.md#D-43
no proof recorded yet
invariantservice, databasetest
services-crm:modules/activities/tests/integration/services/persistence/activities.create-retries.integration.spec.js#makes one activity
12must prove
Proposed
Rhythm supplies the activity’s origin, and an imported external reference must be unique within its workspace.
no proof recorded yet
invariantservice, databasetest
services-crm:modules/activities/tests/integration/services/persistence/activities.integration.spec.js#records sys_origin and sys_external_id from the source it is given
13must prove
Proposed
Activity saves reject custom field values because activities do not support custom fields.
origin: R2-ARCH-001 D1 (Andrew 2026-10-19), recorded at services-crm:docs/migrations/activities/README.md#9. Decisions
no proof recorded yet
validationapitest
services-crm:modules/activities/tests/e2e/activities.e2e.spec.js#refuses a custom field value, an activity having no custom fields (R2-ARCH-001): 400 naming custom_fields
14
Proposed
For a future-dated new activity, the console selects Scheduled unless the user already chose a status; editing preserves the saved status.
policyconsoletest
react-console:lib/activities/schedule-status.test.ts#keeps a status the person chose
15must prove
Proposed
A field-mode refusal reports the detected field problems together, and a rejected transaction keeps neither its activity nor its follow-up.
no proof recorded yet
invariantserviceobserved
services-crm:modules/activities/services/persistence/activities.ts:saveNewActivity
16must prove
Proposed
Hiding the attendee control leaves additional contact links valid.
no proof recorded yet
validationservicetest
services-crm:modules/activities/tests/unit/services/activities/field-modes.spec.js#refuses nothing about the links when attendees are hidden
17must prove
Proposed
A user create replaces absent or empty ownership with the caller, while a subsequent edit can retain empty ownership.
no proof recorded yet
calculationserviceobserved
services-crm:modules/activities/services/persistence/activities.ts:activityValuesOf

Scenarios

IdGivenWhenThenProvenance
01The coordinator opens a member record with Meeting available.Record a meeting linked to the member, an attending colleague and that colleague’s organization.The same meeting appears on all three timelines with the member primary.test
react-console:acceptance/crm/playwright/journeys/cross-application/CRM-ACC-0690.spec.ts#CRM-ACC-0690
02Call requires direction and an outcome for completed work.Submit a completed call with both details missing.The refusal identifies both fields and leaves no saved call.test
services-crm:modules/activities/tests/integration/services/persistence/activities.integration.spec.js#refuses a call with no direction and no outcome, naming both

Edge Cases

IdGivenWhenThenProvenance
03The browser receives no answer to an activity create.Retry the identical create from the console.Rhythm returns the existing activity without another entry.test
react-console:lib/activities/retry-safe-writes.test.ts#answers a lost response with the activity it logged, and logs no second 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