Modules and entities

Building in Qorekit needs the administration permission Add and change entities and fields. Administrators have it; other roles get it in roles and permissions.

Modules

A module is a group of entities in the menu, such as Sales or Support. It holds no data of its own.

• Add module at the bottom of the menu creates one.
• The settings of a module (its name, key, icon and colour) open from the module's entry in the menu.
• Only an empty module can be deleted. Move or delete its entities first, including those in the trash.

Entities

An entity is one kind of record, such as companies, contacts or tickets. Qorekit creates a database table for each entity the moment you add it.

Add entity, under a module in the menu, creates one. Give it a plural name, since it names the list: Customers rather than Customer.

Keys

Modules, entities and fields each have a key: lowercase letters, numbers and underscores, such as customers or due_date. Keys appear in addresses (/e/customers) and in the REST API. Qorekit suggests one from the name.

You can change a key later, but links and programs that used the old key stop working. Change names freely; change keys only when you must.

Entity settings

Entity settings, on the entity's page, holds:

• Heading: the field that names a record in lists, in related record fields and in the record panel. By default it is the first short text field. Choose a field that tells records apart, such as a name or a title.
• Icon and colour, shown in the menu.

The users entity

Users are an entity too, kept in the system. You cannot delete it or its built-in fields, but you can add your own fields to users, such as a department or a phone number, in Administration › Users.

Where to go next

• Fields: adding and changing an entity's fields.
• The list of an entity: which columns people see, in which order.