Custom Objects
Tables this company defines for itself: name the object, add its fields, and it gets a screen, search, import, audit and its own grants (Custom Objects tab). Nothing here changes a standard screen. Limits: 50 objects, 80 fields and a million records each. Switch an object off to hide it and keep its records; delete it only on purpose.
Where to find it
- Module: Platform
- Group: Configuration
- Section: Custom Objects
- Screen: Custom Objects
Address in the console: /platform/custom-objects
List · 8 columns · 9 fields on its form · 2 of them required · 6 actions
What the list shows
These are the columns of the list, in the order they are drawn. Any of them can be sorted on, filtered on, hidden, or exported.
| Column | Kind | Field name |
|---|---|---|
| Key | Code | object_key |
| Object | Text | label |
| Number prefix | Code | prefix |
| Fields | Number | field_count |
| Records | Number | record_count |
| Has status | Yes or no | has_status |
| On | Yes or no | is_active |
| Screen | Code | screen |
The form
What is asked for when a record is created here. Required fields are marked; a choice drawn from a configuration list is one an administrator can extend without a release.
| Field | Type | Choices | Notes |
|---|---|---|---|
| Key required | Text | Lower case letters, digits and underscores, e.g. site_visit. It cannot be changed later. | |
| Name (singular) required | Text | What one record is called, e.g. Site visit. | |
| Name (plural) | Text | Shown on the list and the tab, e.g. Site visits. | |
| Number prefix | Text | Records are numbered PREFIX-000001: 2 to 6 capital letters or digits. | |
| What it is for | Long text | Shown at the top of the object's screen. | |
| Records have a status | Yes or no | Adds a Status field limited to the statuses below, and the status hooks apply. | |
| Statuses | Text | Comma-separated, the first is the status of a new record, e.g. open, review, closed. | |
| Title field (a field key) | Text | The field that names a record on a list or a link. Leave empty for the record number. | |
| On | Yes or no | Switch off to hide the object from everybody and keep its records. |
What you can do here
Import a design
Import an object design
Asks for: Design file*
Fields primary
Open its screen
Grant to a role
Let a role use this object
Asks for: Role code* May look at the records May add records May change records May delete records
Export design
Delete with its records
Asks for confirmation: Delete this object, its fields and every record in it? This cannot be undone. To keep the records, switch the object off instead.
* required
The rules that apply here
Everything on this screen obeys the platform rules rather than rules of its own. The ones worth knowing before you use it:
- Narrowing a list — search, conditions, sort, totals, export and saved views.
- What may be changed — the five grounds a record may not be edited on.
- Companies and business units — what the switcher above this list is doing to it.
- Creating a record — required fields, where choices come from, and how the number is allocated.
- Importing a spreadsheet — this screen accepts one, and it runs through the same rules as typing.