Custom entities
Overview

The framework lets platform admins define their own record types ("classes") without code. Each class has tables, fields, detail tabs and optional behaviors; the app then generates the grid, form and sidebar entry.

Where to find it

Admin area, Framework (/admin/framework). The page is titled Classes.

PagePathPurpose
Classes/admin/frameworkList, publish/unpublish, New class, Clone module
New Class/admin/framework/newDefine a class from scratch
Class editor/admin/framework/<classId>Edit tables, fields, tabs, behaviors
Form Designer/admin/framework/formsDesign the form layout per entity
Class proposals/admin/framework/proposalsMove classes and layouts between environments

Key concepts

  • A class contains tables with a role: Master (top-level sidebar entry with a detail page), Reference (a lookup) or Child (reached through a master's detail tab).
  • A class is a draft until published. Publishing makes its tables routable; grant it to an organization on the Organization Features screen to show it in that organization's sidebar.
  • Unpublishing removes it from routing and sidebars. No data is deleted.

Tips

  • Changes are never applied silently: Review & apply shows the exact SQL first.
  • See the related pages: classes, form designer, clone module, deleting records.