Introduction

It is formerly known as the Datalist Inbox Menu in Joget DX 7.

Unlike the Inbox UI Element which is limited to its own set of predefined columns, the List Inbox UI Element allows you to define your own data list columns to display important values for your list records.

List Inbox Properties

Configure List Inbox

Figure 1: List Inbox Properties

NameDescription
LabelThe page component label. You can add Font Awesome Icons to your menu labels.
Menu ID

Item link slug. Optional field.

Ensure that value defined here is unique to other page components in the app since the first matching/conflicting ID will take precedence in page loading.

List

Datalist to load.

This is especially 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, process instance IDs generated are now a UUID, instead of a predictable ID format previously used in Joget v6.

(Click image above for enlarged view)

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 next field)
  • Assignments for selected Activity only (you will then have select the activity name in the next field)


Figure 2: Sample List Inbox in runtime

UI

Figure 3: UI Properties


NameDescription
Show Number of Rows in Menu

Show Number of Rows In Menu.


The additional query will be performed to return the record count every time the UI loads.

Show Assignment Details

Enables the option to show assignment details in a tooltip upon mousing over a record.

Note

Should you wish to have the SLA indicators visible, please see Enabling Data Collection for SLA Implementation.  

Show Assignment in Popup DialogOpen the assignment inside a popup dialog, instead of loading it on the current page.
List View Custom HeaderWrite HTML to customize the list header of the list inbox UI element.
List View Custom FooterWrite HTML to customize the list footer of the list inbox UI element.
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

Figure 4: Advanced Properties


NameDescription
UI Key Name

Define a column name to pre-filter the list via the UI key value.

See UI Key for more info.

Performance & Offline

Cache Settings

Name

Description

Scope

Caching options 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.


PWA Offline Settings

Note: PWA Offline support is dependent on the theme used.

Name

Description

Enable cache for offline supportEnable caching for offline support, usually set for use on mobile browsers.
Cache all List links in first pageEnable caching for any list links present on the first page of this UI menu.
Cache list actions (Non post action)Enable caching for any non-POST list actions (if any) in the List.

Read Progressive Web Application (PWA) for more information.



  • No labels