Field and Field Group Layout, Visibility, and Editability
Learn how to control layout, visibility, and editability of Fields and Field Groups on the Entity Details UI.
Entity Details UI - Field/Group Sequencing
Field Groups on the details UI appear in the order specified in the Schema view of an Entity. See the Reordering Group Sequence section of Creating Fields and Field Groups to change the group sequence.
Fields within a group appear in the order that they are visible in the group. See the Reordering Field Sequence section of Creating Fields and Field Groups to change the field sequence.
Entity Details UI - Visibility and Editability
Field Widths
Widths of fields and all other UI elements are specified on a scale of 1 to 12, with 12 being 100% of the parent width. This is based on Bootstrap's 12-column layout.
Field widths can be controlled from the UI Properties > Field Width property. If this property is unspecified, the field's width is taken from its Group's UI Properties > Field Width property. If the Group's UI Properties > Field Width is unspecified, then the default width is 6 columns (50%) in a standard 12-column layout.
Field/Group Visibility Options
Visibility for Fields and Field Groups on the Entity's Details UI can be controlled using the UI Properties > Visibility property of a Field or a Group. By default, Fields and Groups are always visible if this property is not set.
Conditional visibility of a Field or a Group can be achieved by setting the UI Properties > Visibility to Custom and providing a condition evaluation script in the UI Properties > Custom Visibility Script property.
Group Header Visibility can be controlled using the Properties > Show Group Label property. By default, this property is true, so Group headers are always visible unless this property is unchecked.
Field Editability Options
Editability for Fields on the Entity's Details UI can be controlled using the UI Properties > Enabled property of a Field or a Group. By default, Fields are always editable if this property is not set.
Conditional editability of a Field can be achieved by setting the UI Properties > Enabled to Custom and providing a condition evaluation script in the UI Properties > Custom Enabled Script property.
Entity Details UI - Group Layout Options
By default, all Groups occupy the full width of the screen. However, the group layout may need to be customized. The image below shows an Entity Details UI with 3 cells highlighted:
The example above shows the Details UI for the MultiFamily Asset Entity. It has 4 Field Groups: MultiFamily (default group), Image, Details, and Parking. The Details UI is split into 3 cells:
Cell 1 (blue) has a width of 4 (33%). This cell must contain the Image Group.
Cell 2 (orange) has a width of 8 (66%). This cell must contain the Details Group.
Cell 3 (green) has a width of 12 (100%). This cell must contain the MultiFamily and Parking Groups.
To achieve the layout:
Define the Cell layout in JSON format with the key as the cell number and the value as the cell width. In the Entity's properties, set the following JSON in the UI Properties > Cell Layout property:
{"1":"4","2":"8","3":"12"}Define the Cell-Group mapping (which Group belongs to which cell) in JSON format with the key as the resource ID of the Group and the value as the cell number. In the Entity's properties, set the following JSON in the UI Properties > Section Layout:
{"image":"1","details":"2","multifamily":"3","parking":"3"}