Explain Custom Record Changes

Purpose

Readers need to understand corrections and lifecycle actions without reconstructing them from current values. Transactional history supplies that account.

How It Works

A reader opens the record history using its separate permission. The service checks access to the object and the existing record. It returns a timeline ordered from recent to earlier changes. Opening a revision groups changed information as staff recognize it in the form. Field and option labels make the values understandable. Deleted or archived-object records can retain readable history. CRM endpoint link changes are also captured by Platform, but the CRM drawer does not currently combine them with its own timeline.

Relationships

Record saves and relationship changes supply revisions. Object descriptions supply labels and grouping, while Security governs readership.

Show evidence (sources, provenance, origins, pinned commits)

The Formal Contract

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

Outcomes: Readers need to understand corrections and lifecycle actions without reconstructing them from current values.Deleted or archived-object records can retain readable history.
Surfaces: consoleapi
Intent sources: services-platform:docs/milestones/PLAT-M5-custom-records.md#Scope (audit and record history), PLAT-M5 D3services-platform:docs/milestones/plans/PLAT-M5-plan.md#PLAT-M5-S07services-platform:docs/record-history.md

Controls

22 controls apply, from the corpus control catalogue.

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

Permissions

Key	Checked at	Scope
`platform.custom-records.history`	api	record
`platform.custom-records.read`	service	record

Business Rules

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

Id	Rule	Kind	Enforced at	Provenance
`01`must prove Confirmed	Committed record, value and relationship changes capture author, time, source and before-and-after fields in transactional history, while unchanged business values create no revision. proved by `ATS-PFM-MTD-012-18`, `ATS-PFM-MTD-013-10`, `ATS-PFM-MTD-014-01`, `ATS-PFM-MTD-014-06`, `ATS-PFM-MTD-019-10`, `TST-PFM-MTD-007`, `TST-PFM-MTD-057`, `TST-PFM-MTD-070`	invariant	database	test services-platform:modules/custom-objects/tests/integration/services/history/custom-object-record-history.integration.spec.js#answers the association, the update and the creation, newest first
`02`must prove Confirmed	Revision presentation follows form sections and property labels, resolves option labels, includes composed names and labels relationship changes from the relevant side. proved by `ATS-PFM-MTD-014-02`, `TST-PFM-MTD-057`	calculation	service	test services-platform:modules/custom-objects/tests/integration/services/history/custom-object-record-history.integration.spec.js#names each changed property by its label, with its values before and after as the drawer shows them
`03`must prove Confirmed	History requires its own permission and object reach, additionally checks record read access while the record exists and permits deleted-record history under history access. proved by `ATS-PFM-MTD-011-08`, `ATS-PFM-MTD-014-03`, `ATS-PFM-MTD-014-07`, `TST-PFM-MTD-057`	permission	api, service	test services-platform:modules/custom-objects/tests/integration/services/history/custom-object-record-history.integration.spec.js#refuses a caller who may read boats but not their history
`04`must prove Confirmed	Archived object records retain readable timelines, individual revisions and actor lists. origin: services-platform:docs/milestones/PLAT-M5-custom-records.md#PLAT-M5 D3 proved by `ATS-PFM-MTD-014-04`, `TST-PFM-MTD-057`	policy	service	test services-platform:modules/custom-objects/tests/integration/services/history/custom-object-record-history.integration.spec.js#answers the timeline of a record of an archived object
`05`must prove Confirmed	Link changes enter the starting record history and the other endpoint history when it is a custom record; CRM endpoint revisions are stored in Platform and remain absent from the CRM drawer. proved by `ATS-PFM-MTD-014-06`, `ATS-PFM-MTD-018-13`, `TST-PFM-MTD-070`	policy	database	documented services-platform:docs/associations.md#7a. History
`06`must prove Confirmed	CRM merge changes to custom records capture one revision per transaction, including reference values before the move and the surviving contact afterwards. origin: services-platform:docs/milestones/plans/PLAT-M6-plan.md#5. D4 (Andrew, 2026-10-21: move to survivor) proved by `ATS-PFM-MTD-014-05`, `ATS-PFM-MTD-014-07`, `TST-PFM-MTD-053`	policy	database	test services-platform:modules/custom-objects/tests/integration/db/custom-object-records-merge.integration.spec.js#attributes the change to the merge: its source, its actor and its merge id
`07`must prove Confirmed	History supports actor, operation, source and date filters, rejects unsupported parameters and remains until authorized workspace lifecycle purging removes it. no proof recorded yet	policy	api, database	test services-platform:modules/custom-objects/tests/e2e/custom-object-record-history.e2e.spec.js#refuses a query parameter the timeline does not take
`08`must prove Confirmed	Revision presentation includes only properties available in the current description and admitted by the caller’s audience, so archived property values remain retained but undisplayed. no proof recorded yet	policy	service	observed services-platform:modules/custom-objects/history/custom-object-record-history.config.ts:presentationOf

Scenarios

Id	Given	When	Then	Provenance
`01`	A boat has creation, edit and ownership revisions.	Open the timeline.	Ownership, editing and creation appear from most recent to earliest, each with its author.	test services-platform:modules/custom-objects/tests/e2e/custom-object-record-history.e2e.spec.js#answers the boat’s timeline, its patch and its creation newest first

Planning

Implementation

Explain Custom Record Changes ​

Purpose ​

How It Works ​

Relationships ​