Skip to content

Structures

A Structure is a freeform set of named, typed properties - not tied to any entity, component, or view. Structures exist for one purpose: describing the shape of data going into or coming out of a Database Workflow or Server Function when none of the platform’s other data shapes (an entity, a component, a view) already fit.

If a workflow’s input or output naturally matches an existing entity, component, or view, use that instead - Structures are specifically for the cases where the data being passed around doesn’t correspond to anything already in the data model. “Generate Empty Questionnaire” or “Import Daily Sale - Input” are typical examples: shapes that exist only for one workflow’s input or output, not as data you’d otherwise store.


Navigate to Data Model → Structures to see all structures in the current application, listed by Structure Name with checkboxes for bulk selection. Use + Add Structure to create a new one.


Click a structure to open its detail view, opened either as a slide-in panel (Open) or a full page (Open in Tab) - the same pattern used for entities. A Clone link is available at the top right.

The detail view has two cards:

FieldDescription
Structure NameHuman-readable name, e.g. “Company Info”
Structure IDAuto-generated from the name, e.g. company_info
Application ModuleWhich module this structure belongs to, if any
DescriptionFree text describing what the structure is for, e.g. “Input into Create Customer Company workflow”

Click Edit on this card to change any of these.

The list of named, typed properties that make up the structure - for example, an “Email Address” property of type eMail, a “Phone Number” property of type Phone Number, and a “Company Name” property of type Text.

Click Edit on this card to open the Properties panel, where each property is a row with:

  • A drag handle to reorder properties
  • A Name field
  • A Type field, selected from the same set of types available to entity fields - base types and custom Field Types alike

Use + Add to append a new property row, or Cancel to discard changes without saving.