Related Items List Block – related records as a list¶
The related items list shows the records on the other side of a relationship as a list, each entry drawn with a form. How the entries look, how they are grouped and sorted, is decided by a list definition. Use it where a table row is too little for one record.
This page is part of the form block reference.
1. At a glance¶
| Purpose | Related records as a list of small forms, with quick filters and built-in buttons |
| Typical use | Comments of a ticket, contact persons of a customer as cards |
| Related | Lists, Related Items Grid Block, Related Items Timeline Block |
The block is only offered in forms that belong to an entity.
2. Settings¶
| Setting | Meaning | Default / required |
|---|---|---|
| "Relationship" | The relationship whose records are shown | Required. Without it the block shows nothing. |
| "List" | The list definition of the related entity: the form of an entry, grouping, sorting, toolbar | Required. Without it the block shows nothing. |
| "Filter" | Condition evaluated per related record; only records for which it is true are shown. Always active. | all related records |
| "Quick Filters" | A filter definition whose badges and sort options are offered above the list. Only expression filters are offered. | none |
| "Row Click" | Action run when an entry is clicked, against the related record of that entry | none |
| "Link Button", "Unlink Button", "Add Button", "Delete Button" | Built-in buttons, as on the Related Items Grid Block | off |
In addition, the block has the settings every block has, except "Flush".
3. Behaviour¶
The block behaves like the Related Items Grid Block: a click makes the entry the current record of the relationship, the filter is applied before the quick filters, and the built-in buttons are placed in front of the toolbar of the list. Unsaved related records are shown as well. The block has no preview form – the entries themselves are forms.
4. Example¶
Comments of a ticket. "Relationship" = "Ticket → Comments", "List" = "Comment Cards" (author, time, text, sorted newest first), "Add Button" on.