The Data Model workspace shows the tables, fields, and relationships that describe the information your app stores.
Use this workspace to compare the app's structure with your requirements. Use Mockup to inspect the pages that need that information.
Where to find it
Open an app from Your Apps on the Studio home page. Data Model is the fourth tab at the top center of the editor, with a database icon.
In a narrow window, the tabs show only icons. Ctrl+4 also opens Data Model.
What the model tells you
Tables represent different kinds of stored information. Fields describe the values and rules for each kind. Relationships connect records across those kinds.
For example, a client request app can have these tables. The names are examples:
| Table | What to inspect |
|---|---|
clients | Fields for a client's name and email address |
requests | Fields for a request's title, description, and status |
A relationship between requests and clients can describe which client belongs to each request. A required title is a separate field rule.
Read Entities and records for the difference between a table's structure and an individual record.
When to use Data Model
Use Data Model after you ask Orbit Agent to change the information your app stores:
- After a new model, compare its tables with the kinds of information you requested.
- After a new field, check the field and its rules on the intended table.
- After a relationship change, check the link between the intended tables.
For the example app, a model check asks whether requests has a title and a client link. It does not ask whether a person can submit a request through a page.
What a model check does not prove
The model does not prove that a page displays a field or lets a person select a related record. It also does not prove that your live app has the change.
After you inspect the model, check the mockup for the pages that use the data. Then test the app before launch.
Change the model
Define a data model when you need to describe the app's stored information to Orbit Agent.
For a smaller change, use Add a field or Link records. Those guides include example requests and checks.