Overview
The Object Array row type provides an editable data grid for managing a list of items that are stored directly as a property on the current record. Unlike a Related List, which queries separate records from another entity, an Object Array works with data embedded within the record itself.
This is ideal for small, structured lists that are tightly coupled to the parent record and do not need to exist as independent records.
When to Use
Use the Object Array row type when:
- You need a small editable table within a record (e.g. a list of line items, checklist entries, or criteria)
- The data belongs exclusively to the current record and does not need to be queried independently
- Users need to add, edit, and remove rows inline without navigating to separate records
- The data is relatively simple and does not require its own full entity definition
Object Array vs. Related List
| Feature | Object Array | Related List |
|---|---|---|
| Data storage | Embedded within the parent record as an array property | Separate records in their own entity type |
| Editing | Inline editing within the grid | Opens a separate record editor |
| Independence | Data cannot be queried independently of the parent | Records exist independently and can be queried, linked, and reported on |
| Best for | Small, simple lists (typically under 50 items) | Larger collections of complex, independently meaningful records |
| Creating new items | Add row button inserts a new row directly in the grid | Add button opens a new record editor |
Properties
| Property | Required | Description |
|---|---|---|
| Type | Yes | Must be set to objectarray |
| Property | Yes | The name of the property on the record that contains the array data. This property stores the array of items. |
| Header | No | A heading displayed above the grid. |
| Entity | No | An optional entity type code. When provided, the grid columns are derived from this entity's definition. |
| Fields / Local Fields | No | An array of field definitions for the grid columns. Use this to define custom columns when not referencing an entity definition. |
| Min Height | No | The minimum height of the grid in pixels. |
| Read Only | No | When set to true, hides the Add button and prevents editing. The grid becomes a read-only display. |
| Full Height | No | When enabled, the grid expands to fill available vertical space. |
| Visibility | No | A condition controlling when this row is visible. |
Inline Editing
Object Array grids support inline editing. Users can click on a cell to edit its value directly within the grid, without opening a separate editor. Changes are saved when the parent record is saved, keeping all array data in sync with the rest of the record.
Users can add new rows using the Add button, which inserts a blank row at the bottom of the grid. Rows can be removed by selecting them and using the delete function.
Example Uses
- Checklist items — a list of verification checks with checkboxes and descriptions
- Cost line items — a breakdown of costs with description, quantity, and amount columns
- Criteria lists — scoring or evaluation criteria with names and weights
- Configuration entries — key-value pairs or settings specific to the record