List screen configuration

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 6 minutes to read

    • Configure a list screen so that your users can see a list of records from their mobile app. To access a record from the list, a user only needs to tap the record name.

    Before you begin

    Role required: admin

    About this task

    Create a simple list screen with a single data source, single segment, and default filters and empty state.

    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 either select an existing icon or create an icon.
      This icon displays in the launcher screen when you add it to your list screen. For more information about creating icons, Mobile icons.
    7. In the Screen segmentssection, 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 Streamssection, 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, select New to create a new data item for your list stream, or select Choose to reference an existing data item.
      For more information on creating data items, see Data items.
    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

      Option to add an embedded screen within a 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.
      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.
    14. In the Data section, select the table that contains the data you want to populate on your card.
    15. In the View using section, select the Card option.
      Note:
      The legacy card option is also available, however legacy cards do not have the same capabilities as regular cards.
    16. In the Card section, select New.
    17. 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.
    18. In the Data section, select the table that contains the data you want to populate on your card.
    19. In the Card template field, select Choose to reference an exisiting card template.
    20. Select Save.
    21. Optional: To customize elements and attributes of your card, do the following:
      1. Select the Open in Mobile Card Builder button.

        The Mobile Card Builder tool displays in a new tab.

      2. Make any required changes to your incident list card. For more information about working with Mobile Card Builder, see Mobile Card Builder.
      3. Select Save.

    Result

    Figure 1. List screen primary screen
    List scrnen.

    What to do next

    • Use embedded screens within your list screen- List screens can be configured to include record screens. Adding an embedded screen enables users to tap on a record, the contents of which are displayed in a new screen. As an admin, you configure this option in List item config record. For more information, see Configure a record screen for use with a list screen.
    • Configure mobile functions for your list screen - List screen can include top menu functions and footer functions to determine the type of action users can perform on a list screen. As an admin, you configure this option in List screen record. For more information see, Mobile functions and Associate a function with a location in the app.
    • Configure role access for records in your list screen - Use the role access option to configure the records in your list screen to only be displayed to selected roles. As an admin, you configure this option in List screen record.