Skip to content

General settings

The Overview tab of an entity definition collects the settings that give a record type its identity and baseline behavior. Four cards matter most: Base settings, feature switches, Audit settings, and Display settings.

  • Internal name — the technical identifier used for storage and APIs. It must start with a Latin letter and be unique ignoring case.
  • Display name (singular) and Display name (plural) — the user-facing labels for one record and for lists and sections.
  • Status — a computed label: Active, Limited (read-only or some operations disabled), or Pending deletion.
  • Read-only — blocks create, update, archive, restore, delete, assignments, and import for the whole record type.
  • Operation locks — a finer runtime operation policy: disable specific actions (Create, Update, Archive, Restore, Delete, Assignments, Import, Export) without making the whole entity read-only.

Per-entity toggles for Comments, Attachments, and Tags.

Search is configured separately on the Search tab. Add one or more explicit paths to scalar fields, related records, child Table rows, or supported system content. Search is unavailable while the target list is empty.

  • Audit trail enabled — whether record changes are recorded as governed history.
  • Retention policy — keep audit entries forever or for a fixed number of days.

Association entities always keep their audit trail on.

  • Number prefix — an optional prefix for auto-generated record numbers.
  • Backend default sort — an ordered list of sort targets used by API list queries when the caller does not send an explicit sort. When empty, the fallback is record number, then record id.
  • Display name rule and Subtitle rule — ordered presentation rules that compute each record’s display name and subtitle for lists, lookups, references, cards, dashboards, and reports. See Presentation and statements.

Entity record access is owned by Security Statements linked through Permission Assignments. Root View controls discovery, actions and fields refine that access, and governed Responsibilities plus Assignment Rules control responsibility changes. Configure these artifacts in the three Security sections of the Entity Definition; see Entity security.