Using Data Models in Modules

When a module links to a Data Model, the Data Model's schema fields display in the component tray as draggable building blocks. Dragging a field onto the canvas adds a pre-configured component bound to that field for data storage and retrieval. Creators build forms from a shared data definition instead of configuring each component's storage settings individually.

When to Use Data Model Bindings

Link a module to a Data Model when any of the following apply:

• Multiple modules must read and write the same record structure, and the data definition should be shared instead of repeated.

• Components need schema-validated data storage, not ad hoc submission fields.

• The team wants the Module Builder to pre-configure components automatically from a Schema instead of setting up each field individually.

Self-contained forms that store data only for their own module work well with standard submissions and do not need Data Model integration.

Linking a Data Model to a Module

1. Open the module in the Module Builder.

2. In the module toolbar, select the … (ellipsis) icon and choose Settings.

3. In the Module Details section, locate the Data Models field.

4. Select one or more Data Models from the list. Only Data Models in the current workspace are available.

5. Select Save to apply the change.

Data Models becomes available in the library drop-down in the Components tab after the settings are saved.

A Data Model can only be removed from the module when no components in the module are bound to it. When active bindings exist, the platform prevents removal and displays an error.

Using the Data Models Library

After a Data Model is linked, open the Components tab in the component tray, select the library drop-down, and choose Data Models to browse the available fields.

Fields are organized by Data Model. Hover a chip on the mockup above to highlight and navigate to the description of that column. Each field row displays the following:

Fields inside object-type fields display as nested sub-rows. Expand a parent field to browse its children.

Adding Components from Data Models

To add a component bound to a schema field:

1. In the Data Models library, locate the field you want to use.

2. Drag the field row onto the Component Tree canvas.

The platform creates a component pre-configured with the following:

• Label: The field name from the Schema.

• Property key: The field  in the Schema.

• Data binding: A connection to the Data Model that tells the runtime which fields to read and write.

The component type is selected automatically based on the field's data type. For example, a string field produces a Text Field component, a boolean field produces a Checkbox component, and a number field produces a Number component.

Understanding Component Binding

A binding connects a module component to a specific field in a Data Model. When an end-user interacts with a bound component:

• The component reads its initial value from the matching field in the Data Model record.

• When the end-user submits the module, the component writes its value back to that field.

The binding is stored on the component and is visible in the component's Properties panel. The binding includes the Data Model ID and the field path.

Binding is set automatically when you drag a field from the Data Models library. Editing a binding manually in the Properties panel is advanced usage. An incorrect field path or Data Model ID will cause data to be read from or written to the wrong location.