Skip to content
SureTillSureTillSureTill Docs

Entity Types

Where: Settings > Entity Types
Who can use it: Sidebar permission: settings.update or manage settings.
Open this page in SureTill

The Entity Types page with three counters, a search box and a list of entity types that expand to show their states.

An entity type is a template for a kind of record, with a list of states it can be in. For example a Table type could have the states Available, Busy and Cleaning. Ticket Types can require entity types. The page shows three counters: Entity Types, Total States and Transitions.

Step by step: create an entity type with states

Section titled “Step by step: create an entity type with states”
  1. Open Settings > Entity Types and click New Entity Type.
  2. Type the Name, for example Waiter or Table.
  3. Optionally type the Entity Model and the Display Format.
  4. Keep Active on and click Create.
  5. Click the new type to expand it, then click Add State.
  6. Type the state Name, choose the Color and click Create. Repeat for each state.
The new entity type window on the Entity Types page
New Entity Type: the window that opens.

Step by step: change or delete

Section titled “Step by step: change or delete”
  1. Edit a type: click the pencil icon on its row.
  2. Delete a type: click the bin icon and confirm. The type and all its states are deleted.
  3. Edit a state: expand the type and click the pencil icon on the state.
  4. Delete a state: click the bin icon on the state and confirm.

Every setting explained

Section titled “Every setting explained”
Setting What it does
Search box Filters the types by name.
Type row Shows the name, the number of states and transitions, the model if one is set, and an Active or Inactive badge. Click it to expand.
Name (type) Required. The system makes a unique short name from it for internal use.
Entity Model Optional. The data model the type refers to, for example App\Models\Customer.
Display Format Optional. Meant for a text pattern such as {name} ({phone}). The text is saved as a template and shown again when you edit the type.
Active (type) Switch. Default: on.
States list Each state shows a color dot, its name and a Default badge.
Name (state) Required.
Color A color picker. Default: #3b82f6.
Sort Order A whole number. Default: 0.
Icon (Lucide name) Optional icon name such as circle, check or x.
Default State Switch. Marks the default state of the type. Turning it on for a state removes the mark from the other states of the same type.
Transitions A read-only list of allowed moves from one state to another, with an Auto badge and the trigger event when they exist. This page does not create transitions.
Section titled “Related articles”