.png?fit=max&auto=format&n=V5LGcGniNC1X_QJO&q=85&s=8c9ba3ce9a0d0045976180c9f669af26){kind=logo}
Schema Designer
The Schema Designer is the visual tool for building your data model. Object types appear as nodes on a canvas, and relations between them appear as connecting arrows. You can see the full structure of your schema at a glance and edit it by clicking directly on the canvas. Open a schema and click the Designer tab to enter the canvas view.The canvas
The canvas gives you a live visual representation of your data model.Creating a schema
1
Go to Registry
Click Registry in the main navigation sidebar. Registry is an instance-level module — it is not inside any Space.
2
Create a new schema
Click + New Schema. Enter a name, optionally choose an icon and color, and click Create.
3
Open the designer
The new schema opens with an empty canvas. Click Designer to start building your model.
Creating object types
1
Click + Add Object Type
In the Designer toolbar, click + Add Object Type.
2
Fill in the details
Enter the object type name (for example,
Customer or Server). Optionally choose an icon and a color to help visually distinguish this type on the canvas and in the browser. Set a key prefix if you plan to use CSV import — this prefix appears in auto-generated IDs.3
Create
Click Create. The new object type appears as a node on the canvas.
Adding attributes to an object type
1
Open the object type
Click the object type node on the canvas. A side panel opens showing the type’s current attributes.
2
Click + Add Attribute
Click + Add Attribute in the side panel.
3
Configure the attribute
Fill in the attribute settings:
4
Save
Click Save. The attribute is added to the object type immediately.
Every object type should have exactly one attribute marked as the label. If no label attribute is set, objects of that type display their internal ID instead of a meaningful name.
Defining relations between object types
A relation is a directed link from one object type to another, defined through an attribute of type Relation.1
Open the source object type
Click the object type node that will hold the relation field (the “from” side). For example,
Contract if you want to link contracts to customers.2
Add a Relation attribute
Click + Add Attribute and set the type to Relation.
3
Select the target type
In the Relates to field, select the object type this relation points to (for example,
Customer).4
Name the attribute
Give the attribute a descriptive name (for example,
Customer or Linked Customer). This name appears as a field label in object forms.5
Save
Click Save. An arrow now appears on the canvas connecting the two object types, representing the relation.
Editing the canvas layout
Drag any node to reposition it on the canvas. The layout is saved automatically and is per-schema — each schema has its own canvas arrangement. Repositioning nodes is purely visual; it does not change the data model.Editing an existing schema
You can modify a schema’s data model at any time:- Add attributes — click the object type node and use + Add Attribute.
- Edit an attribute — click the attribute name in the side panel to change its settings. You can rename it, change whether it is required, or change its unique constraint. You cannot change an attribute’s type after it has been created.
- Delete an attribute — click the trash icon next to the attribute. See the warning above.
- Delete an object type — click Delete type in the side panel. This permanently deletes all objects of that type and all their field values.
- Edit a relation — click the arrow on the canvas to open and edit the relation attribute.