Create custom entities
Custom entities represent non-standard business objects such as equipment types, room types, or any other item category your organization needs to track. Each entity type has its own set of custom fields, and you create individual entity instances with specific field values.
Note: For conceptual background, see Forms overview.
Before you begin
- The service entities feature must be enabled for your organization. If the custom entities option does not appear in your settings, contact your Zenoti administrator.
- You need administrator access at the organization level.
Permission: Add or Edit under ServiceEntities in the Administrator section of the security role β Required to create and manage entity types and instances.
Permission: Add or Edit under CustomFields in the Administrator section of the security role β Required to define custom fields for entity types.
How custom entities work
Custom entities use a type-and-instance model:
- Entity type β Defines a category of entity (for example, "Laser Equipment" or "Treatment Room") along with the custom fields that describe items in that category.
- Entity instance β A specific item that belongs to an entity type (for example, "Laser Unit #3" or "Room 201A"). Each instance stores values for the fields defined on its entity type.
Entity types also support parent-child hierarchies. A parent entity type can contain child types, allowing you to organize entities into nested categories. For example, a "Medical Equipment" parent type might contain "Laser Equipment" and "Imaging Equipment" child types.
Define an entity type
Navigate to Configuration > Forms > Form creation > Custom entities.
Click Add Entity Type.
Enter a name for the entity type.
Define the custom fields for this entity type. Each entity type supports up to 10 custom attributes. For each field, configure:
Property Description Field name A descriptive label for the attribute. Data type The value type for this field. See the supported data types below.
Supported data types:
| Data type | Use for |
|---|---|
| Text | Short names, codes, descriptions, and any free-form alphanumeric content. |
| Number | Whole-number values (quantity, count, duration in minutes). |
| Decimal number | Values with fractional parts (currency, percentage, decimal-precision measurements). |
| Date & time | Scheduled dates, installation dates, and timestamps. The picker captures both the calendar date and the time of day; if you only need the date portion, leave the time at its default value. |
| Yes/No | Boolean on/off attributes rendered as a toggle or checkbox. |
| Reference ID | Dropdown-to-entity references (for example, linking to another entity instance). The reference ID is chosen from a list; users do not type it directly. |
- Optionally, assign a parent entity type to create a hierarchy.
- Click Save.
Create an entity instance
After you define an entity type, create instances that represent individual items.
Navigate to Configuration > Forms > Form creation > Custom entities.
Select the entity type you want to add an instance to.
Click Add Entity.
Enter the entity details:
Field Description Entity name A unique name for this entity instance. Entity code A unique identifier code. Description A brief description of the entity. Fill in the custom field values based on the fields defined for the entity type. Each field accepts a value matching its configured data type.
Click Save.
Entity type hierarchies
Parent-child hierarchies let you group entity types under broader categories.
- When you create a new entity type, you can assign it a parent entity type.
- Child types inherit the organizational context of their parent, but each type maintains its own set of custom fields.
- Use hierarchies to create logical groupings. For example:
- Equipment (parent)
- Laser Equipment (child)
- Imaging Equipment (child)
This structure helps you organize a large number of entity types and filter entities by category.