Field Roles - Primary Key, Title Field, and Others
Learn about the various roles an Entity Field can have such as Primary Key, Import Key, Title Field, Type Identifier, and so on.
Field Roles
A Field Role is a role performed by a field in an Entity's schema. Following are the roles that can be assigned to an Entity Field:
Role | Description | Inherited From Patterns | Property To Set |
|---|---|---|---|
Primary Key | The primary key of the Entity's database table. | YES | Field > Properties > Is Pk |
Import Key | Fields used during the data import process to identify records. Since imported data may not have the primary key values, other non-primary key fields can be used to match and update existing records | YES | Field > Properties > Is Import Key |
Title Field | Acts as the title/label for a record. This field is shown at the beginning of the search results and is shown as a label in dropdowns. If an Entity has multiple title fields, then a concatenated value is shown. | YES | Field > Properties > Is Title Property |
Tenant Identifier | This field holds the tenant ID when the application is multi-tenant. | YES | Entity > Properties > Tenant Identifier |
Type Identifier | This field holds the Entity ID. When multiple Entities are being persisted in the same database table this field can be used to identify the Entity of the record. | YES | Entity > Properties > Type Identifier |
Deletion Identifier | The deleted flag indicates if a record is in a Deleted state. | YES | Entity > Properties > Deletion Identifier |