List Inbox Menu

Introduction

The List Inbox Menu in Joget DX 8 offers enhanced flexibility compared to the standard Inbox UI Element. It allows you to define custom data list columns and display important information from your list records. Let's explore the properties you can configure for the List Inbox Menu:

Configure list inbox

To configure List Inbox properties, in UI Builder, drag and drop the List Inbox element onto the canvas and click on it.

When adding List Inbox, you will see the following fields available for configuration:

• Label: The UI menu label. You can add Font Awesome Icons to your menu labels.
• Menu ID: Item link slug. Optional field.
  Ensure that the value defined here is unique to other UI menus in the app since the first matching/conflicting ID will take precedence in page loading.
• List: Select the data list to load in the List Inbox Menu.
  
  Important
  When Database SQL Query List Data Store is used to query the selected data list's records, ensure that the id of the records in the data list matches the process instance ID or record ID of the actual assignment.
  In Joget DX 8, process instance IDs generated are now a UUID.
  
• Assignments to Display: 
  

  Available options:

  • All assignments (All assignments for the current app only)
  • Assignments for all Apps (Assignment for all apps in your Joget platform)
  • Assignments for a Process only (you will then have to select the process name in the following field)
  • Assignments for selected Activity only (you will then have to select the activity name in the following field)

UI

The UI settings for the List Inbox Menu allow you to customize the user interface elements to enhance user interaction and visibility of important data. You can configure options such as displaying the number of rows, showing assignment details in tooltips, opening assignments in a popup dialog, and adding custom HTML for headers and footers in both the list view and assignment view.

Fields to Configure:

• Show Number of Rows in Menu: check to display the number of rows in the menu.
  Note
  The additional query will be performed to return the record count every time the UI loads.
• Show Assignment Details: check to enable the ability to show assignment details in a tooltip when hovering over a record.
  
   
  
  Note
  Should you wish to have the SLA indicators visible, see Enabling Data Collection for SLA Implementation.  
• Show Assignment in Popup Dialog: Open assignments in a popup dialog instead of loading them on the current page.
• List View Custom Header: Write HTML to customize the list header of the list inbox UI element.
• List View Custom Footer: Write HTML to customize the list inbox UI element's list footer.
• Assignment View Custom Header: Write HTML to customize the header of the assignment form.
  The assignment form is the form you see upon clicking on a task assignment in the list inbox.

• Assignment View Custom Footer: Write HTML to customize the footer of the assignment form.
  The assignment form is the form you see upon clicking on a task assignment in the list inbox.

Advanced

The Advanced settings provide additional configuration options for the List Inbox Menu. You can define a UI Key Name to pre-filter the list using a specific column name, helping to streamline data presentation based on predefined criteria.

Field to Configure:

• UI Key Name: Define a column name to pre-filter the list using the UI Key value.

Performance & offline settings

Performance and Offline Settings ensure the List Inbox Menu operates efficiently and remains accessible even without an internet connection. You can configure cache settings to improve performance by storing data locally and setting up offline support for mobile browsers, ensuring a seamless user experience regardless of connectivity.

Cache settings

Cache settings in Joget allow you to define how calendar data is cached to improve performance. 

Fields to Configure:

• Scope:
  Options include are: 
  
  • None: No caching.
  • Application: Cache content by application where all users will see the same content.
  • User: Cache by username.
• Duration (s): Duration in seconds to cache content, defaults to 20 seconds if applicable.

For more information, see Performance Improvement with UI Caching.

PWA offline settings

PWA Offline Settings enable the List Inbox Menu to support offline functionality, which is essential for mobile users. You can enable caching for offline support, ensuring the List Inbox Menu and its actions remain functional even when there is no internet connection. This includes caching non-POST list actions and all list links on the first page, providing a robust offline experience.

Fileds to configure:

• Enable cache for offline support: Check this to enable caching for offline support, usually set for mobile browsers.
• Cache List Actions (Non Post Action): Enable caching for any non-POST list actions (if any) in the List.
• Cache All List Links on First Page: Enable caching for any List links present on the first page of this UI menu.

For more information, see the Progressive Web Application (PWA) documentation.