Configure Field Requirements and Exposure

Purpose

Fields need behaviour appropriate to the organization process and audience. Administrators can express that behaviour through a shared rule vocabulary.

How It Works

An administrator opens the rules for a live field. They can define conditions, uniqueness, defaults and readership. Saving replaces the complete rule set. Platform checks that conditions and defaults fit the described record. Uniqueness also requires the custom-record store to verify existing values. Dependent properties can prevent a custom-object field from being archived. Record saves and audience projections use the resulting rules at their own boundaries.

Relationships

Field definitions identify the subject of each rule. Custom-record writes evaluate defaults, requirements and uniqueness; access projections apply exposure.

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: Fields need behaviour appropriate to the organization process and audience.Dependent properties can prevent a custom-object field from being archived.
Surfaces: consoleapi
Preconditions: The target field exists and remains unarchived.
Intent sources: services-platform:docs/proposals/custom-objects/09-decisions.md#D-10 (exposure levels), D-20 (refuse the archive)services-platform:docs/milestones/PLAT-M5-custom-records.md#D-20 and PLAT-M5 D6 (build the deferred definition rules)services-platform:docs/milestones/plans/PLAT-M5-plan.md#PLAT-M5-S04, PLAT-M5-S05, PLAT-M5-S09

Controls

26 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-004 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-fields.read`	api	tenant
`platform.custom-fields.update`	api	tenant

Business Rules

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

Id	Rule	Kind	Enforced at	Provenance
`01`must prove Confirmed	Rules are replaced as a complete set of five possible kinds, with one entry per kind; omitted kinds disappear and the default staff exposure needs no stored entry. proved by `ATS-PFM-MTD-006-01`, `TST-PFM-MTD-109`, `TST-PFM-MTD-120`	policy	service, database	test services-platform:modules/metadata/tests/integration/services/persistence/custom-fields.rules.integration.spec.js#removes the kinds a replacement leaves out
`02`must prove Confirmed	Conditions may reference other fields of the same type using compatible operators, cannot reference their own field and must fit sixteen kilobytes; rejected sets leave existing rules intact. proved by `ATS-PFM-MTD-006-02`, `ATS-PFM-MTD-006-11`, `TST-PFM-MTD-120`, `TST-PFM-MTD-129`	validation	service, database	test services-platform:modules/metadata/tests/integration/services/persistence/custom-fields.rules.integration.spec.js#refuses a condition naming a field the object does not have, and leaves the rules unchanged
`03`must prove Confirmed	Uniqueness rules are supported only for custom objects and are refused with a duplicate-value count until existing records satisfy uniqueness. origin: services-platform:docs/milestones/PLAT-M5-custom-records.md#PLAT-M5 D6 proved by `ATS-PFM-MTD-006-03`, `ATS-PFM-MTD-006-10`, `TST-PFM-MTD-065`, `TST-PFM-MTD-120`	validation	service	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-object-records.integration.spec.js#refuses a unique rule on a property two records already share, with the count
`04`must prove Confirmed	Defaults accept a compatible literal, the workspace current date, the portal caller contact or the caller organization token, and incompatible defaults are refused. proved by `ATS-PFM-MTD-006-04`, `TST-PFM-MTD-129`	validation	service	test services-platform:modules/metadata/tests/unit/custom-object-properties.spec.ts#refuses a default the field cannot hold
`05`must prove Confirmed	Exposure selects the widest permitted readership along the staff, owner, portal and public ladder, with broader levels including narrower audiences and invalid levels rejected. origin: services-platform:docs/proposals/custom-objects/09-decisions.md#D-10 (approved 2026-10-18) proved by `ATS-PFM-MTD-006-05`, `ATS-PFM-MTD-006-10`, `TST-PFM-MTD-109`, `TST-PFM-MTD-129`	policy	service	test services-platform:modules/metadata/tests/unit/custom-object-properties.spec.ts#refuses an exposure off the ladder before the description is read
`06`must prove Confirmed	A custom-object property named by another property condition cannot be archived until those dependencies are changed; the refusal identifies each dependent field and rule without deleting them. origin: services-platform:docs/proposals/custom-objects/09-decisions.md#D-20 (Andrew, 2026-10-18: "Refuse the archive") proved by `ATS-PFM-MTD-005-13`, `ATS-PFM-MTD-006-06`, `TST-PFM-MTD-009`, `TST-PFM-MTD-120`	validation	service	test services-platform:modules/metadata/tests/integration/services/persistence/custom-fields.rules.integration.spec.js#refuses the archive naming each dependent property and rule, and leaves the field and the rules unchanged
`07`must prove Confirmed	Field archival deletes that field’s own rules atomically, and rule replacement is unavailable while the field is archived. proved by `ATS-PFM-MTD-005-13`, `ATS-PFM-MTD-006-07`, `TST-PFM-MTD-120`	lifecycle	service	test services-platform:modules/metadata/tests/integration/services/persistence/custom-fields.rules.integration.spec.js#removes a field’s rules when the field is archived
`08`must prove Confirmed	Writing a field rule advances the workspace query-description stamp in the same transaction. proved by `ATS-PFM-MTD-006-08`, `TST-PFM-MTD-109`	policy	database	test services-platform:modules/metadata/tests/integration/db/custom-field-rules.table.integration.spec.js#moves the tenant’s query description stamp when a rule is written
`09`must prove Confirmed	The archive dependency safeguard applies to custom objects; a registered-type field can be archived despite another field condition naming it. proved by `ATS-PFM-MTD-006-09`, `TST-PFM-MTD-120`	policy	service	test services-platform:modules/metadata/tests/integration/services/persistence/custom-fields.rules.integration.spec.js#does not apply to a native object: a contacts field its rule depends on is archived

Scenarios

Id	Given	When	Then	Provenance
`01`	Survey Due depends on the Insured selection.	Save an insured boat without its survey date, then remove the insured selection and save.	The insured save requires the date and the other save succeeds.	test react-console:acceptance/custom-objects/playwright/journeys/PLAT-M5-S04.spec.ts#PLAT-M5-S04: Survey Due is required only when Insured is ticked

Edge Cases

Id	Given	When	Then	Provenance
`02`	The Survey Due condition references Insured.	Attempt to archive Insured.	The dependency refusal identifies the condition.	test react-console:acceptance/custom-objects/playwright/journeys/PLAT-M5-S09.spec.ts#PLAT-M5-S09: archiving a property another rule depends on is refused, naming the rule

Planning

Implementation

Configure Field Requirements and Exposure ​

Purpose ​

How It Works ​

Relationships ​