Your first module
This walk-through builds a small contact list in a few minutes: a Sales module with Companies and Contacts, where each contact belongs to a company. You need an account that may manage the schema; the administrator made during installation can.
1. Add a module
On the home page, choose Build your first module (or Add module in the menu). Name it Sales. The key, used in links and the API, fills itself in; you can change it now, before anything uses it.
You can give the module an icon and a colour. Both show in the menu.
2. Add the Companies entity
In the menu, under Sales, choose Add entity and name it Companies. Qorekit creates a database table for it at once.
An empty entity asks for its first field. Choose Add field:
| Name | Type | Settings |
|---|---|---|
| Name | Short text | Required |
| Website | Web address | |
| Industry | Single choice | a new choice list, see below |
The first short text field becomes the heading: the name records are known by in lists, in links between records and in the record panel. You can choose another field as the heading in the entity settings.
A choice list for industries
A single choice field needs a choice list. Open Administration › Choice lists, choose New choice list, name it Industries and type a few items, one per line (Software, Retail, Manufacturing). Then come back and pick the list in the field's settings.
3. Add the Contacts entity
Add a second entity, Contacts, with these fields:
| Name | Type | Settings |
|---|---|---|
| First name | Short text | Required |
| Last name | Short text | |
| Unique | ||
| Company | Related record | Related entity: Companies |
The Related record field links each contact to a company. In the contact's form you pick the company by typing part of its name.
4. Add records
Open Companies and choose New record. Add two or three companies, then add contacts and pick their companies.
5. Decide what the list shows
Each entity's list shows a few columns by default. To choose them, open the entity and choose Design, then the List tab: drag the columns you want into order, pick the default sort, and Publish. See the list of an entity.
6. Let others in
Add people in Administration › Users and give them roles. A role decides, for each entity, whether its users may see, add, change and delete records, and whether that means all records or only their own. See roles and permissions.