Retire or Publish Custom Records

Purpose

Records administrators need deliberate lifecycle actions for custom records. Publication, archival and deletion serve different staff outcomes.

How It Works

An authorized administrator chooses an action on the record. Publication changes its public standing when the object permits publication. Archive removes a record from normal browsing while preserving information. Restore makes that record available again. Delete permanently removes the record after its version and relationship checks. Cascades can reach dependent custom records and roll back if a safeguard refuses any member. Each action records its audit, history and applicable event effects for later review.

Relationships

Access grants lifecycle permissions. Relationship policy governs deletion effects, and history explains the committed changes.

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: Records administrators need deliberate lifecycle actions for custom records.Cascades can reach dependent custom records and roll back if a safeguard refuses any member.
Surfaces: consoleapi
Preconditions: The owning custom object is active.
Postconditions: Lifecycle actions leave audits, and deletion removes owned values and links while detaching assets.
Intent sources: services-platform:docs/proposals/custom-objects/09-decisions.md#D-19 (Andrew, 2026-10-18: archive under the delete key)services-platform:docs/milestones/PLAT-M5-custom-records.md#PLAT-M5 B1, B5, D3services-platform:docs/milestones/PLAT-M6-custom-record-relationships.md#Changes requested (2026-10-21, "All or nothing")services-platform:docs/milestones/plans/PLAT-M5-plan.md#PLAT-M5-S07

Controls

23 controls apply, from the corpus control catalogue.

TC-AVL-005 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-DAT-001 TC-DAT-003 TC-DAT-004 TC-LOG-001 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-LOG-005 TC-PI-001 TC-PI-003 TC-PI-005 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.publish`	api	record
`platform.custom-records.delete`	api	record

Business Rules

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

Id	Rule	Kind	Enforced at	Provenance
`01`must prove Confirmed	Publishable records begin in draft and accept draft, pending-review, published or unpublished states; entering publication sets its time, leaving it clears the time and nonpublishable objects reject publication. proved by `ATS-PFM-MTD-013-01`, `ATS-PFM-MTD-013-11`, `TST-PFM-MTD-065`	lifecycle	service, database	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#refuses publication on an object that is not publishable
`02`must prove Confirmed	Record archival retains values, files and links while excluding ordinary-list entries and refusing edits, publication and repeated archival until restoration; deletion remains available for an active object. origin: services-platform:docs/proposals/custom-objects/09-decisions.md#D-19 proved by `ATS-PFM-MTD-013-02`, `TST-PFM-MTD-065`	lifecycle	service	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#archives a record with everything kept
`03`must prove Confirmed	Permanent deletion requires the current version, removes record and owned value reservations and detaches files for retirement. proved by `ATS-PFM-MTD-013-03`, `TST-PFM-MTD-065`	lifecycle	service, database	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#deletes a record with its values and unique values
`04`must prove Confirmed	A restricting link in force prevents deletion without removing anything, including a link whose end date is still current or future. origin: services-platform:docs/milestones/plans/PLAT-M6-plan.md#5. D2 (Andrew, 2026-10-21: in force until it ends) proved by `ATS-PFM-MTD-013-04`, `TST-PFM-MTD-037`, `TST-PFM-MTD-065`	validation	service, database	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#refuses to delete a record an open restricting association names, and removes nothing
`05`must prove Confirmed	Cascading deletion follows linked custom records through the same safeguards to a maximum depth of ten and rolls back the entire deletion when any member is refused. origin: services-platform:docs/milestones/PLAT-M6-custom-record-relationships.md#Changes requested (Andrew, 2026-10-21: "All or nothing") proved by `ATS-PFM-MTD-013-05`, `ATS-PFM-MTD-013-10`, `TST-PFM-MTD-022`, `TST-PFM-MTD-037`, `TST-PFM-MTD-065`	invariant	service, database, console	test react-console:acceptance/custom-objects/playwright/journeys/PLAT-M6-S08.spec.ts#PLAT-M6-S08: an insured boat cannot be deleted and a builder's deletion takes its boats except the refused one
`06`must prove Confirmed	Deletion announcements order link removals first, cascaded records from deepest to shallowest next and the originating record last. origin: services-platform:docs/milestones/PLAT-M5-custom-records.md#PLAT-M5 B1 (Andrew, 2026-10-19: "Dependants first") proved by `ATS-PFM-MTD-013-06`, `ATS-PFM-MTD-015-08`, `ATS-PFM-MTD-019-10`, `TST-PFM-MTD-065`	policy	service, database	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#writes every dependant’s event before the record it depended on: the associations, then the cascade deepest first (B1)
`07`must prove Confirmed	Owner cascades still delete records of archived or draft objects even though direct deletion from those objects is refused. origin: services-platform:docs/milestones/PLAT-M5-custom-records.md#PLAT-M5 B5 (Andrew, 2026-10-19: "Rule applies anyway") proved by `ATS-PFM-MTD-013-07`, `TST-PFM-MTD-065`	policy	service, database	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#applies the owner’s cascade to a record of an archived custom object (B5: the rule applies whatever the type’s state)
`08`must prove Confirmed	Publication, archival, restoration and deletion record audit events in their transaction, including the chosen publication state. proved by `ATS-PFM-MTD-013-08`, `TST-PFM-MTD-065`	policy	service	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#records the publication and its state in the audit events
`09`must prove Confirmed	Authorized record-page actions offer publication, unpublication, archival, restoration and confirmed deletion, explaining restricting links in a refused deletion confirmation. origin: services-platform:docs/milestones/plans/PLAT-M5-plan.md#PLAT-M5-S07 proved by `ATS-PFM-MTD-013-09`, `TST-PFM-MTD-007`, `TST-PFM-MTD-022`	policy	console	test react-console:acceptance/custom-objects/playwright/journeys/PLAT-M5-S07.spec.ts#PLAT-M5-S07: publish, archive and restore from the boat page; History names each revision and who made it
`10` Confirmed	Direct store deletion consults an optional external deletion check, but no integration registers it and cross-service deletion does not consult it.	policy	service	documented services-platform:docs/associations.md#The contract for another service (CRM's contact and organization deletes)

Scenarios

Id	Given	When	Then	Provenance
`01`	A records administrator opens the first boat record.	Publish it, archive it and restore it.	The actions succeed and History identifies their revisions and authors.	test react-console:acceptance/custom-objects/playwright/journeys/PLAT-M5-S07.spec.ts#PLAT-M5-S07: publish, archive and restore from the boat page; History names each revision and who made it

Edge Cases

Id	Given	When	Then	Provenance
`02`	A builder cascades to boats and one boat has restricting insurance.	Try deleting the builder, then repeat after the insurance ends.	The protected deletion removes nothing; after the protection ends, the builder and its dependent boats are removed.	documented services-platform:docs/milestones/plans/PLAT-M6-plan.md#PLAT-M6-S08

Planning

Implementation

Retire or Publish Custom Records ​

Purpose ​

How It Works ​

Relationships ​