Data Model Definition Page

Select a Data Model from the Explorer panel to open its definition page. The page displays the Data Model's metadata, its linked schema and field definitions, and the modules and queries associated with it.

Data Model Info

The Data Model Info card displays identifying and status metadata for the Data Model.

Schema

The Schema card displays the Schema linked to this Data Model, including its name, ID, version, and publication status.

The following actions are available:

• View Schema: opens the Schema definition page.

• Update Schema: begins the multi-step flow for linking the Data Model to a different Schema. See Updating a Schema below.

Schema Properties

The Schema Properties section displays all fields defined in the linked Schema. Each field row shows the field name, its data type, and a required badge if the field is required. Use Expand All and Collapse All to control the accordion state.

The Schema Properties section is read-only. To change field definitions, update the linked Schema.

Associated Modules

The Associated Modules section lists all modules bound to this Data Model. Select Open on any row to open that module in the Module Builder.

Associated Queries

The Associated Queries section lists all query-builder queries that reference this Data Model. Select View on any row to open that query in the query editor.

Data Model Actions

Select the ⋮ (ellipsis) icon at the top right of the definition page to open the actions menu. The following actions are available:

Updating a Schema

To update the linked Schema, complete the following steps:

1. Select Update Schema from the ⋮ (ellipsis) menu or the Schema card.

2. Choose a published Schema from the workspace, or upload a new JSON Schema file.

3. The platform displays a side-by-side comparison of the current Schema and the new Schema. Review all field additions, removals, and type changes before continuing.

4. Review the affected modules list to understand which modules might be impacted by the schema change.

5. Select Confirm to apply the update. The Data Model links to the new Schema immediately.

Important: Updating the Schema does not migrate existing records. When Strict Validation is enabled, existing records that no longer conform to the new Schema are rejected the next time they are written. Ensure existing records are compatible with the new Schema before confirming the update.

Data Model Settings

Select Settings from the ⋮ (ellipsis) menu to open the Data Model Settings dialog. The dialog is organized into three sections.

Data Versioning

Model Permissions

Model Permissions control which roles can access this Data Model and at what permission level. Each row in the permissions table represents a role in the workspace. Set the permission level for each role to control read and write access to all records in this Data Model.

Field Permissions

Field Permissions let Creators restrict access to individual fields in the Data Model. Select a field from the field list, then set the permission level for each role. Field-level permissions take precedence over model-level permissions for the fields they cover.

Select Save to apply all permission changes across all three sections in a single update.