Maintain Valid Custom Records

Purpose

Record keepers need to capture and correct the organization information without breaking its definitions. The record store applies the object contract to every write.

How It Works

A record keeper creates a record for an active object. Platform validates the supplied properties and applies creation defaults. It assigns the number and derives a readable name. Edits use the version the person read and distinguish a patch from a replacement. File values are prepared through the managed asset pipeline. A rejected write identifies the field that needs attention without returning the rejected value. Successful writes retain audit information and can produce history and business events, while reads return the available property values and linked records.

Relationships

Custom objects provide the definition and custom fields provide value contracts. Relationships, history and event delivery extend the effects of a successful record write.

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: Record keepers need to capture and correct the organization information without breaking its definitions.A rejected write identifies the field that needs attention without returning the rejected value.
Surfaces: consoleapi
Preconditions: Writes target an active object; identity reads can address records of other object states.
Postconditions: Record mutations leave transactional audits; individual API reads record a view.
Intent sources: services-platform:docs/milestones/PLAT-M5-custom-records.md#Scope (the record store), PLAT-M5 D3, D4, D5, D9, D17services-platform:docs/milestones/plans/PLAT-M5-plan.md#PLAT-M5-S03, S04, S05, S06services-platform:docs/proposals/custom-objects/09-decisions.md#D-01, D-02

Controls

29 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-IAM-001 TC-IAM-002 TC-IAM-004 TC-IAM-005 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-LOG-005 TC-MON-002 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.read`	api	record
`platform.custom-records.create`	api	record
`platform.custom-records.update`	api	record

Business Rules

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

Id	Rule	Kind	Enforced at	Provenance
`01`must prove Confirmed	Record writes require an active object; records of draft or archived objects remain readable by identity with their links, reject writes and cannot be reached through another object path. origin: services-platform:docs/milestones/PLAT-M5-custom-records.md#PLAT-M5 D3 (Andrew, 2026-10-19: readable, read-only) proved by `ATS-PFM-MTD-008-12`, `ATS-PFM-MTD-012-01`, `TST-PFM-MTD-051`, `TST-PFM-MTD-065`	lifecycle	service	test services-platform:modules/custom-objects/tests/e2e/custom-object-records.e2e.spec.js#refuses every write of it with 409 and changes nothing
`02`must prove Confirmed	Property validation uses live definitions and typed conversion, names invalid or unavailable properties without disclosing rejected values and uses the object label in its refusal. origin: services-platform:docs/milestones/PLAT-M5-custom-records.md#PLAT-M5 D4 proved by `ATS-PFM-MTD-012-02`, `TST-PFM-MTD-065`	validation	service	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#names the object’s label in that refusal, never "custom records" (D4)
`03`must prove Confirmed	API-required properties need a value at creation and reject attempts to clear them. proved by `ATS-PFM-MTD-012-03`, `TST-PFM-MTD-065`	validation	service	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#refuses a record without a property required by the API
`04`must prove Confirmed	Visibility validation rejects non-null submitted changes to hidden properties while retaining untouched stored values; conditional requirement checks resulting visible values, and unknown evaluations neither require nor hide. origin: services-platform:docs/milestones/plans/PLAT-M5-plan.md#PLAT-M5-S04 proved by `ATS-PFM-MTD-012-04`, `ATS-PFM-MTD-012-15`, `TST-PFM-MTD-004`, `TST-PFM-MTD-065`, `TST-PFM-MTD-076`	validation	service, console	observed services-platform:modules/custom-objects/services/persistence/custom-object-records.ts:requireRecordRules
`05`must prove Confirmed	Creation fills omitted, empty or null properties from compatible defaults using literals, workspace dates or caller contact, while supplied values override defaults. proved by `ATS-PFM-MTD-012-05`, `TST-PFM-MTD-065`	calculation	service	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#defaults a date to the tenant’s today, and a text to its literal
`06`must prove Confirmed	References must resolve to a record of their target type in the workspace, with custom-object targets requiring unarchived records of the specified object. proved by `ATS-PFM-MTD-012-06`, `TST-PFM-MTD-065`	validation	service	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#refuses a manufacturer that is a boat
`07`must prove Confirmed	Unique-property reservations reject duplicate values without saving, name the holder, normalize text case and surrounding whitespace and release a reservation when its value changes. origin: services-platform:docs/milestones/plans/PLAT-M5-plan.md#PLAT-M5-S05 proved by `ATS-PFM-MTD-006-10`, `ATS-PFM-MTD-012-07`, `TST-PFM-MTD-005`, `TST-PFM-MTD-065`	validation	service, database, console	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#refuses a hull number another boat holds, naming the property and the boat
`08`must prove Confirmed	Display properties reject internal line breaks by property name, trim boundary line breaks and leave unrelated properties unaffected. origin: services-platform:docs/milestones/PLAT-M5-custom-records.md#PLAT-M5 D5 (Andrew, 2026-10-19: "Refuse, name the field") proved by `ATS-PFM-MTD-012-08`, `TST-PFM-MTD-065`	validation	service	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#refuses a create whose secondary display property holds one, naming the property, and writes no record
`09`must prove Confirmed	Each save derives the name from the primary display value or prefixed record number plus populated secondary values, limits it to five hundred characters and assigns numbers from the object sequence. origin: services-platform:docs/proposals/custom-objects/09-decisions.md#2. Choices taken as internal (record numbering, display name composition) proved by `ATS-PFM-MTD-012-09`, `TST-PFM-MTD-065`, `TST-PFM-MTD-076`	calculation	service	test services-platform:modules/custom-objects/tests/unit/record-rules.spec.ts#is the number with the object’s prefix when the display property holds nothing
`10`must prove Confirmed	Patches affect named properties and use null to clear them, while replacements clear omitted live properties and accept a complete record representation. proved by `ATS-PFM-MTD-012-10`, `ATS-PFM-MTD-012-19`, `TST-PFM-MTD-065`	policy	api, service	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#clears every property a replacement leaves out
`11`must prove Confirmed	Updates require the read version and respect update locks; archived records reject editing and publication but remain deletable when the object is active and deletion safeguards allow it. origin: services-platform:docs/milestones/plans/PLAT-M5-plan.md#PLAT-M5-S06 proved by `ATS-PFM-MTD-012-11`, `ATS-PFM-MTD-012-16`, `TST-PFM-MTD-006`, `TST-PFM-MTD-065`	validation	service, console	test react-console:acceptance/custom-objects/playwright/journeys/PLAT-M5-S06.spec.ts#PLAT-M5-S06: two registrars edit one boat; the second is told and nothing is lost
`12`must prove Confirmed	Caller-supplied external identifiers are unique within the object and reject conflicting creation or patch requests. proved by `ATS-PFM-MTD-012-12`, `TST-PFM-MTD-065`	validation	service, database	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#refuses a create under an external id another record of the object holds, naming sys_external_id
`13`must prove Confirmed	New image and file values pass through managed asset preparation before saving, with unavailable or unsavable sources reported at the property without exposing the address. proved by `ATS-PFM-MTD-007-08`, `ATS-PFM-MTD-012-13`, `ATS-PFM-MTD-012-18`, `TST-PFM-MTD-065`	validation	service	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#names a create’s missing upload at properties.<key>, without the address sent
`14`must prove Confirmed	Record lists default to unarchived entries ordered by name, offer bounded pages and publication, archive and prefix filters, while reads include grouped links and write view audits and mutations audit actions without values. proved by `ATS-PFM-MTD-012-14`, `TST-PFM-MTD-051`, `TST-PFM-MTD-065`	policy	service	test services-platform:modules/custom-objects/tests/e2e/custom-object-records.e2e.spec.js#audits the read of a record as a view
`15`must prove Confirmed	Decimal, currency and percent storage also records an exact precision-scaled integer, leaving that shadow empty when the value exceeds the supported safe integer range. proved by `ATS-PFM-MTD-012-17`, `TST-PFM-MTD-065`, `TST-PFM-MTD-076`	calculation	service	test services-platform:modules/custom-objects/tests/unit/record-rules.spec.ts#is null for a value whose scaled form is beyond a safe integer

Scenarios

Id	Given	When	Then	Provenance
`01`	Boat is active with contact ownership configured.	Create Miss Daisy for Jane Smith from its app.	The first boat number appears in the Explorer and Jane Boats card.	test react-console:acceptance/custom-objects/playwright/journeys/PLAT-M5-S03.spec.ts#PLAT-M5-S03: a registrar creates a boat owned by a contact: numbered 1, listed, and on the contact's Boats card
`02`	A boat already reserves a unique hull number.	Create another boat using the same text in different case with extra boundary spaces.	The refusal identifies Hull Number and its existing holder without saving the duplicate.	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#refuses the same hull number in another case and with spaces around it

Edge Cases

Id	Given	When	Then	Provenance
`03`	A custom object includes an HTML property.	Save markup in that property.	The finding records an unresolved sanitization obligation in the storage path.	unknown FND-PFM-MTD-012

Planning

Implementation

Maintain Valid Custom Records ​

Purpose ​

How It Works ​

Relationships ​