List screens

List screens will only be built as scrollable and page up/page down functionality will not be included. If needed for older devices this can be completed as a custom enhancement.

A list screen will comprise a header section and body section, so typically always has the following configuration options.

Body section configuration elements

The body section of a list screen includes configurable fields of selected data, grouped together in sections (sometimes called buttons, as the sections are typically clicked to access the next screen).

• The screen itself, which is always set up with data type ‘E – List Screen Config’ allowing all the fields and their controls to be set up. See the section on List Screen Configuration.
• ACTIONS option which is always set up with data type ‘H - Screen Action Config’. See the section on Action Configuration.
• SORT option which is always set up with data type ‘C – String List’. See the section on Sort Configuration.

Header section configuration elements

• HEADER option for the header section, which is set up with data type ‘D - Detail Screen Config’ allowing all the fields and their controls to be set up. See the section on Detail Screen Configuration.

• HEADER_EX option to control whether the header section should be displayed initially as expanded (i.e. visible) or compressed (i.e. only visible by selecting the expansion icon). The following options are available:

  • blank - the header section will be hidden / collapsed

  • A - the header section will be displayed / expanded

  • B – the header section with be collapsed but, if there is no data to display, it will be disabled, i.e. the icon and panel will not be displayed at all.

The header section will include the fields that have been defined in the app master data for the HEADER, but only if they have the same value as all the items in the body section.

In addition to the available fields in the structures linked to the app, there may be some total or count fields available to summarise the totals or counts from the list body, specific to each app.

Any field in the LIST can have one of the following suffixes added into the HEADER. The naming convention is a field name followed by a suffix outlining the type of entry. The suffixes are:

• _COUNT – this will display the number of different values in the list.

• _SUM – this can only be used for numeric fields and will total up the quantity from all the items in the list for that field.

• _MIN – this will display the lowest value.

• _MAX – this will display the largest value.

There is also a special LIST_COUNT which is available for any header screen that will display the number of items in the list.

List screen example

Filter

A ‘filter’ bar will be displayed at the top of any list screen if any items in the body of the list are configured with FILTER activated.

Only these items will be considered when searching / filtering the item list. If no items are configured for FILTER, the filter bar will not appear on the screen.