Configuration of multiple grids/views

This page explains the option of configuring multiple tabular views in a monitor. The views are based on the same database, the configured index of the monitor. However, they can be restricted using filters, e.g. they can, however, be restricted using filters, e.g. logical rules or rights.

To activate multiple views for a monitor, the configuration parameter function_gridMultipleViews must be set to true.

All other functions are then controlled via the parameter function_gridMultipleViewsConfig.

Multiple grids configuration

The individual views are defined in function_gridMultipleViewsConfig under views. Each view has the following information:

id
Unique id for the view.
Is used for referencing the view, e.g. in the dashboard widget
title
Used as a title in the tab or header
filter
Restricts the monitor data in the view
organisation
Restrict visibility to organization(s) (optional)
role
Restrict visibility to role(s) (optional)
right
Restrict visibility to permission(s) (optional)

Example

{
  (...),
  "views": [
    {
      "filter": {
        "bool": {
          "must_not": [],
          "should": [],
          "must": [
            {
              "match_all": {}
            }
          ]
        }
      },
      "id": "allView",
      "title": "Gesamtansicht"
    },
    {
      "filter": {
        "bool": {
          "must_not": [
            {
              "match_all": {}
            }
          ],
          "should": [],
          "must": []
        }
      },
      "id": "noView",
      "role": [
        "bpcAdmin"
      ],
      "title": "Leer"
    }
  ]
}

View mode

The arrangement of the views can be controlled via the parameter multiViewMode within function_gridMultipleViewsConfig. Currently, the specifications tabbed and stacked are possible.

This screenshot shows where the parameter can be found:

tabbed

Shows the grids in a tab view:

function_gridMultipleViewsConfig

{
  "multiViewMode": "tabbed",
  (...)
}

Initial view

Unless otherwise specified, the first view is always displayed first. To change the behaviour, a default view (defaultView) must be specified within function_gridMultipleViewsConfig. This can refer directly to an ID of a view or be controlled via the user’s organizations/roles/rights.

Referencing a view

{
    (...),
    "defaultView": "allView",
  "views": [
    {
      "filter": {},
      "id": "allView",
      "title": "Gesamtansicht"
    }
  ]
}

View by organizations/roles/rights

If organizations/roles/rights are specified, the first suitable entry for the current user is searched for. The following sequence is checked: Organizations → Roles → Rights. If no matching entry is found, the first defined view is used.

Example

{
  "defaultView": {
    "organisation": {
      "orgX": "allView",
      "orgY": "noView"
    },
    "role": {
      "bpcAdmin": "noView"
    },
    "right": {
      "right1": "allView"
    }
  },
  (...)
}

Keywords: