Custom Object

What It Models

A custom object gives an organization its own record category, such as a boat register. Its definition governs properties, names, lifecycle, access and optional placement; custom apps group categories in navigation.

Identity and Attributes

Stable keys identify the object in addresses and shared descriptions. Mutable settings are replaced at a version; explicit actions activate, archive and restore the definition.

Relationships

Metadata owns its property definitions, and custom records refer to the parent object. An optional protected relationship type supplies ownership.

Invariants

Activation validates naming before ordinary records can be written. Identity limits, publication safeguards, placement checks and roles-only reach constrain later changes.

How It Is Stored and Shared

Custom Objects writes object and app configuration. Catalogue, layout and relationship consumers read those definitions, and activation supplies shared Explorer recipes. Draft ownership choices currently remain in browser storage.

Open Design Questions

Draft-owner persistence and unenforced stored limits need decisions. Reset also leaves retained definitions temporarily without their properties until reload succeeds.

Relationships

To	Cardinality	Ownership	Crosses a service
`DOM-PFM-MTD-002`	one-to-many	Metadata owns the properties stored as custom fields for this object's record-type identity.	no
`DOM-PFM-MTD-005`	one-to-many	Records reference their parent object, and the database prevents deletion of a parent with records.	no
`DOM-PFM-MTD-006`	many-to-one	The object selects its owner type; Associations prevents retirement while that selection remains.	no
`DOM-PFM-MTD-001`	many-to-one	The shared catalogue computes entries for draft and active custom objects without adding registry rows.	no

Invariants

Invariant	Enforced at	Provenance
`INV-DOM-PFM-MTD-004-01` Keys and record-type identities remain unique and unchanged across archival, and a workspace can hold fifty custom objects.	service, database	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-objects.integration.spec.js#refuses an object id the tenant already has,
`INV-DOM-PFM-MTD-004-02` Replacement cannot alter identity or status; lifecycle actions control status changes.	api, service	test services-platform:modules/custom-objects/tests/e2e/custom-objects.e2e.spec.js#answers 400 to a replacement that changes the status, which only the actions chang
`INV-DOM-PFM-MTD-004-03` Active definitions need an unarchived supported naming property and no more than three unarchived secondary properties.	service, database	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-objects.integration.spec.js#refuses activating a draft whose display prop
`INV-DOM-PFM-MTD-004-04` An owner relationship must be active, target this object and permit at most one owner per record.	service, database	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-objects.integration.spec.js#refuses an owner type that gives a record man
`INV-DOM-PFM-MTD-004-05` Publication cannot be disabled while any record remains published.	service	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-objects.integration.spec.js#refuses turning publication off while the rec
`INV-DOM-PFM-MTD-004-06` Archived definitions reject replacement; restoration produces a draft requiring fresh activation.	service	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-objects.integration.spec.js#restores an archived object as a draft, keepi
`INV-DOM-PFM-MTD-004-07` Placement accepts a console app or unarchived local custom app, and app archival refuses remaining draft or active placements.	service	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-apps.integration.spec.js#refuses to archive an app while a draft and an a
`INV-DOM-PFM-MTD-004-08` Object and app mutations audit changed field names without recording their values.	service	test services-platform:modules/custom-objects/tests/integration/services/persistence/custom-objects.integration.spec.js#records the replacement with the fields it ch
`INV-DOM-PFM-MTD-004-09` Roles-only reach requires an active role assignment scoped to the object.	service	test services-platform:modules/custom-objects/tests/e2e/custom-object-records.e2e.spec.js#keeps a roles-only object from a customer-wide assignment, answering as if

Planning

Design

Custom Object ​

What It Models ​

Identity and Attributes ​

Relationships ​

Invariants ​

How It Is Stored and Shared ​

Open Design Questions ​

Relationships

Invariants

Custom Object

What It Models

Identity and Attributes

Relationships

Invariants

How It Is Stored and Shared

Open Design Questions