Introduction

Dashboard displays multiple UI menus from the selected UI in a resizable grid layout.

Dashboard Properties

Configure Dashboard

Figure 1: Dashboard Properties


NameDescription
LabelThe UI menu label. You can add Font Awesome Icons into your menu labels.
Menu ID

Item link slug. Optional field.

Unique field

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

Configuration Mode
  • Using UI
    • UI will need to be selected. All the menus in the selected UI will be included as portlets in the dashboard.
    • See an example of this configuration in the default bundled Expenses Claim app in a default Joget installation.
    • Do not select the same UI where the dashboard menu is in.

  • Using URL Portlet Setting
    • You may configure the path and settings to each portlet.
    • See an example of this configuration in the default bundled Customer Relationship Management app in a default Joget installation.

  • Using UI Menu Plugin 
    • UI Menu Plugin to be selected.

Portlet Setting

You can configure each of the portlet in terms of positioning, dimension, etc.

Only applicable when "Using UI Menu Plugin" option for "Configuration Mode" field is selected.


Figure 2: Sample Dashboard in runtime

UI

Figure 3: UI Properties


NameDescription
Default Portlet Width (Column)Number of columns to show by default. This option only appears in UI configuration mode.
Default Min Grid Cell Height (px)Minimum height for each portlet.
Resizable

Determines whether end user should be able to resize the portlets. This option only appears in UI configuration mode.

Auto Adjust Portlet Height

When checked, portlet height will be automatically adjusted optimally according to its content. This option only appears in UI configuration mode.

Custom Header

Custom HTML to be placed before the portlets.

Custom Footer

Custom HTML to be placed after the portlets.

Advanced

Figure 4: Advanced Properties



Description
Customize Portlet Setting

You can configure each of the portlet in terms of positioning, dimension, etc.

Only applicable when "Using UI" option for "Configuration Mode" field is selected. 

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.

Read Progressive Web Application (PWA) for more information.

AJAX & Events

New Feature

This is a new feature in Joget DX 8.

Event Listening

Figure 7: AJAX & Events - Event Listening

NameDescription
Component Object

The object that will be listening for an event.

This field will dynamically show selectable options depending on the page components used. e.g: if there is a page component called manage meeting in the page, it will automatically show up in this field's select box.

Event NameCustom Event Name.
Matched Action 

Action to be listened for.

  • Hide Component
  • Show Component
  • Show and Reload Component
  • Show and Change URL Component Parameters
  • Reload Page
  • Redirect Page
  • Show and Redirect Component
Add row Adds another row for another event

Event Triggering

Figure 8: AJAX & Events - Event Triggering

NameDescription
Event NameCustom Event Name
Trigger Method

The method used to trigger an event.

  • GET Request
  • POST Request
  • Link Clicked
Parameter NameCustom Parameter Name.
Operator

Logical Operator to be used in evaluating "Parameter" against "Value"

  • Equals To
  • Not Equals To
  • Greater Than 
  • Greater Than
  • Greater Than or Equals To
  • Less than
  • Less than or equals to
  • Is True
  • Is False
  • Is Empty
  • Is Not Empty
  • Contains
  • In
  • Regex Match
ValueThe value that the Parameter will be compared to.
When Not Match Trigger Event NameEvent Name when/if the logical operation is not satisfied.
Add rowAdd another row for another event.




  • No labels