Reference & Data Model
Key terms
Five terms are enough to understand every page of this part: entity, field, relation, state and data type.
Entity
Section titled “Entity”An entity is a kind of record, for example Project (project) or Task (task). Every entity has a business name from the interface and a technical name. A single project is a record of that entity.
A field is a property of a record, for example Title (title) or Target end (target_end_date). Fields have a type (text, number, amount, date, yes/no, selection, reference) and are required or optional. A required field without a value prevents saving.
Relation
Section titled “Relation”A relation connects two entities. Three kinds occur:
| Kind | Meaning | Example |
|---|---|---|
| belongs to | The record refers to exactly one record of another entity. | A task belongs to exactly one segment. |
| has many | The reverse direction: a record has any number of children. | A segment has many tasks. |
| n:m | Both sides can have several; an assignment table mediates. | An employee has many skills, a skill many employees. |
A “belongs to” relation is required or optional. A task needs a segment (required), a work package is optional. For every relation it is also defined what happens when the target is archived or deleted; see Lifecycle of a record.
A state is a field with a fixed list of values that describes the processing status, such as the phase of a project or the status of a gate. States are set by you, by a workflow or by the system. Details in States and selection values.
Data types
Section titled “Data types”Every entity belongs to a data type. The data type determines the chapter.
| Data type | What defines it | Example |
|---|---|---|
| Master data | Catalogs of the organization, independent of any project, maintained centrally. | Employee (employee), Material (good) |
| Planning data | Structure and schedule of an undertaking. | Project (project), Segment (segment), Milestone (milestone) |
| Resource data | Who and what is scheduled and booked for a task. | Project member (project_member), Planned effort (employee_usage) |
| Time tracking data | Hours actually worked, with approval. | Time log (time_log), Time entry (time_entry) |
| Financial data | Budgets, planned and booked amounts, earnings, purchases. | Cost item (cost_item), Actual booking (cost_occurrence) |
| Risk data | Uncertainties with value and probability, plus measures. | Risk (risk), Opportunity (chance) |
| Issue data | Matters outside the work plan, with comments. | Issue (issue) |
| Knowledge data | Documented assessments and findings at a point in time. | Status report (state_report), Key takeaway (key_takeaway) |
| Platform data | Organization, users, settings, automation. | User (app_user), Workflow definition (workflow_definition) |
| Calculated data | Derived by the system from other data; not directly editable. | KPI value (kpi_value), system-generated Actual booking |
The guides explain the distinction between master data and project data: Guides › Master data vs. project data.