📊Dashboard

The dashboard is used to display useful information to Valtimo users at a glance. Dashboards can provide the user with statistical information. Using this information, the user will be enabled to prioritize and focus on specific tasks.

A dashboard contains a set of widgets that display data in a customised way. These dashboards and widgets can be configured by an administrator accordingly.

Concepts

  • Dashboard A container for any number of widgets. Multiple dashboards can be configured, which will be shown to the user as tabs.

  • Widget Presents data from a datasource using a display-type to the user.

  • Data-source Every dashboard widget retrieves its data from a data-source.

  • Display-type A display type is responsible for the visualisation of data. For example: bar char, big number, meter, gauge, or any custom. Display types are only available for data-sources that return the required data.

Creating a dashboard

There are two ways of configuring dashboards:

  • Manually via the UI

  • Using autodeployment via the IDE

Configuring dashboards requires:

  • Admin privileges

  • Go to the Admin menu

  • Go to the Dashboard menu

  • Click on Add new dashboard

  • Fill in the form

admin-dashboard-configuration.png
add-new-dashboard.png

When creating a dashboard, two fields need to be filled in:

  • The 'Dashboard name' will be shown to the user on the dashboard page.

  • The 'Description' field is only visible for the system administrator. It will not be shown to the end users.

Adding widgets

After creating a dashboard, widgets can be added to the dashboard.

  • Go to the Admin menu

  • Go to the Dashboard menu

  • Click the dashboard that needs to be configured

  • Click on Add new widget

  • Fill in the form

admin-widget-configuration.png
add-new-widget.png

Access control

Access to dashboards can be configured through access control. More information about access control can be found here.

Resources and actions

Resource type
Action
Effect

com.ritense.dashboard.domain.Dashboard

view

Allows viewing the data of one dashboard.

view_list

Allows viewing the dashboard tabs.

Examples

Permission to view all dashboards and data
[
    {
        "resourceType": "com.ritense.dashboard.domain.Dashboard",
        "action": "view",
        "conditions": []
    },
    {
        "resourceType": "com.ritense.dashboard.domain.Dashboard",
        "action": "view_list",
        "conditions": []
    }
]
Permission to view the data of one specific dashboard
[
   {
      "resourceType": "com.ritense.dashboard.domain.Dashboard",
      "action": "view",
      "conditions": [
         {
            "type": "field",
            "field": "key",
            "operator": "==",
            "value": "management-dashboard"
         }
      ]
   },
   {
      "resourceType": "com.ritense.dashboard.domain.Dashboard",
      "action": "view_list",
      "conditions": [
         {
            "type": "field",
            "field": "key",
            "operator": "==",
            "value": "management-dashboard"
         }
      ]
   }
]

Last updated