Configure a group list screen

Create a group list to provide a view of a list of records grouped by a field you specify.

Before you begin

Before you can create a group list screen, you must create a data item with a group configuration. For more information on configuring a data item, see Configure a standard data item, and note the optional steps for setting the Group by field.

Role required: admin

Procedure

1. Navigate to All > System Mobile > Mobile App Builder.
   The Mobile App Builder opens in a new browser tab and displays the application scope selection screen.
2. Search for the application scope you are working in and then select the name of the application scope.
   The Mobile App Builder categories home screen displays.
3. Select the Screens category, and then select New.
4. Select the List option in the Create a screen page, and then select Continue.
5. Complete the fields as needed.

   Table 1. List screen record

   Field	Description
   Properties
   Name	The name of your list screen. This name appears as a tile in the mobile application.
   Description	Additional information about your list screen.
   Screen Settings
   Available offline	Option to determine whether the screen is available in offline mode or not.
   Hide screen name	Option to determine whether the screen name is not shown as the screen header. This is useful if the text already appears in the header name or if it does not provide any value to the user.
   Hide filters	Option to prevent the list from displaying a list filter.
   Icon	Icon used to represent your list screen when added to a launcher screen.
   Custom filter	Option to add a custom filter for filtering record types by category.
   Empty state	Configure what displays in an empty space when no data is available to show.
   Screen segments	Configure additional screen segments for the list screen.
   Top menu function instances	Option to determine whether to use top menu functions to display additional options.
   Footer function instances	Option to determine whether to use footer functions to display additional options.
   UI parameters	Change how a field or UI element behaves.
   Dynamic screen title	Allows you to create an element and map it to a UI parameter. Use it to pass a value from one screen to another and include it in the title of the destination screen.
   Role access	Determine which user roles can access this screen. If you have selected no roles, users with any role will have access to the screen.

6. In the Icon section add an icon.
   This icon displays in the launcher screen when you add it to your group list screen.
7. In the Screen segments section, select New.
8. Complete the fields as needed.

   Table 2. Screen segment record

   Field	Description
   Properties
   Name	Name for the screen segment screen.
   Order	The order in which the segment appears on the screen. Segments display from the lowest to the highest value.
   Screen	Displays the list name from the list screen record.
   Max number of offline rows	The number of rows displayed for offline viewing.
   Streams	Records that connect data items and list item config records to the list screen.
   Interleave sort
   Sort list stream interleave field	Determine whether the list stream interleave field is sorted in ascending or descending order.

9. In the Streams section, select New.
10. Complete the fields as needed.

    Table 3. List stream record

    Field	Description
    Properties
    Name	Name for the stream.
    Table	Choose the relevant table that contains data to display in your list.
    Interleaved field	Select the field you want to use to interleave your data item.
    Data item	Data items are queries on a selected table that provide the data presented in a screen.
    List item config	Determine how each record appears and the actions associated with it.

11. In the Data Item section choose an existing data item for a grouped list, and then select Apply.
12. In the List item config section, select New.
13. Complete the fields as needed.

    Table 4. List item config record

    Field	Description
    Name	Name for the list item config.
    Settings - List item config order	The order in which this list item config will render when multiple list item configs are connected to a list stream.
    Data	The table associated with your data item.
    Conditions	The conditions that determine what is shown if there are multiple list item configs in a list stream.
    View using	How the list item config can be viewed.
    Card / Legacy card	Cards visually display information from different records.
    On tap	Determines how the mobile app responds to a tap on the screen. Select Use a function instance.
    On tap function instance	Determine what actions appear when a user taps on a list item. Select a navigation function or select New to create one. For more information about creating a navigation function, see Navigation functions. Note: This option only appears when Use a function instance is selected for On tap.
    Embedded screen	Not a valid option for a group list screen. Note: This option only appears when Navigate to screen is selected for On tap.
    Leading swipe function instances	Determines the actions performed or that appear when a user initiates a swipe gesture from the front of a list item. Note: This function type can't be used on a grouped list.
    Trailing swipe function instances	Determines the actions performed or that appear when a user initiates a swipe gesture from the back of a list item. Note: This function type can't be used on a grouped list.

14. In the Data section, select the same table used in the Data item section within the list stream record.
15. In the Card section, select Choose to use an existing card or select New to create one.
16. Complete the fields as needed.

    Table 5. Card record

    Field	Description
    Name	Name for the new card.
    Description	Additional information about the card.
    Active	Select whether the card record is active or not.
    Data	The table associated with your data item.
    Card template	The layout of UI elements used within the card.
    UI rules	The UI rule associated with this card.

17. In the Card template field, select Choose.
18. Search for the item Grouped Listand select Apply.
    Note:

    The Grouped List card template is a default template from the base system.
19. Return to the list item config record by selecting it from the configuration tree.
20. In the On tap section, select Use a function instance.
    The On tap function instance displays.
21. In the On tap function instance section, select New to determine what actions appear when a user taps on a list item.
22. Complete the fields as needed.

    Table 6. Function instance record

    Field	Description
    Properties
    Name	Name for the new function instance.
    Description	Additional information about the function instance.
    Settings
    Display label	Label that is visible to end users.
    Order	The order which the function instance appears on the card. Function instances display from the lowest to the highest value.
    Active	Select whether the function instance record is active or not.
    Disable offline	Option to determine whether the function instance record is available in offline mode or not.
    Icon	Icon used to represent your function when added to this function instance record.
    Function placement
    Parent table	The parent table that the function instance applies to. Note: This field is automatically populated.
    Parent	The parent of the function instance to which the list item config applies. Note: This field is automatically populated.
    Location	The location of the function on your mobile screen. Note: This field is automatically populated.
    Function	The function used within this function instance.

23. In the Function section, select Choose to use a function or select New to create one.
    For more information on mobile functions, see Mobile functions.
24. Select Save.

Result

You now have an screen displaying a list of records, grouped by the field you defined in your data item.

Figure 1. Group List screen