Configuration of the Process Dashboard

The various configuration options for the Process Dashboard are presented and described below.

General module configuration

You can access the setting options via the administration area in the tab Process Dashboard > General tab.

Module

General module settings

Name (ID) Description

Name (`ID`)	Description
Restrict Access (`module_restrictInstanceAccess`)	If this option is activated, users require additional authorization for each component in order to use it. The right to use the module is <code>loadModule_MODULE-ID</code>, where MODULE-ID corresponds to the technical ID of the module. The right to use a specific module component is <code>useModuleInstance_MODULE-INSTANCE-ID</code>, where MODULE-INSTANCE-ID corresponds to the ID of the respective component.
Icon (`module_iconCls`)	Individually selectable icon that is displayed before the title. If no icon is to be displayed, e.g. "none" can be entered. If the field is empty, a standard icon is selected.
Force Module Load (`moduleForceLoad`)	Forces the initial loading of the module in the browser, even with the loading strategy "onDemand".

Restrict Access
(module_restrictInstanceAccess)

If this option is activated, users require additional authorization for each component in order to use it.
The right to use the module is <code>loadModule_MODULE-ID</code>, where MODULE-ID corresponds to the technical ID of the module.
The right to use a specific module component is <code>useModuleInstance_MODULE-INSTANCE-ID</code>, where MODULE-INSTANCE-ID corresponds to the ID of the respective component.

Icon
(module_iconCls)

Individually selectable icon that is displayed before the title.
If no icon is to be displayed, e.g. "none" can be entered. If the field is empty, a standard icon is selected.

Force Module Load
(moduleForceLoad)

Forces the initial loading of the module in the browser, even with the loading strategy "onDemand".

Plugin

Settings for managing plugins in the module

Name (ID) Description

Name (`ID`)	Description
Plugin Configuration (`plugin_configuration`)	Configuration of plugins that are to be displayed within this module. The plugin configuration page of the respective module should be used for customization. See Plugins

Plugin Configuration
(plugin_configuration)

Configuration of plugins that are to be displayed within this module. The plugin configuration page of the respective module should be used for customization.

See Plugins

Security

Application security settings

Name (ID) Description

Name (`ID`)	Description
Sanitize HTML (`sanitizeHtml`)	If activated, JavasScript and invalid elements are automatically removed. See HTML Sanitizing in the BPC documentation. See HTML Sanitizing

Sanitize HTML
(sanitizeHtml)

If activated, JavasScript and invalid elements are automatically removed. See HTML Sanitizing in the BPC documentation.

See HTML Sanitizing

Component configuration

You can access the setting options via the administration area in the tab Process Dashboard > Components tab.

Module

General module settings

Name (ID) Description

Name (`ID`)	Description
Module Name (`module_name`)	Name or title of the module/component.
Module Icon (`module_iconCls`)	Individually selectable icon that is displayed before the title. If no icon is to be displayed, e.g. "none" can be entered. If the field is empty, a standard icon is selected.
Module Description (`moduleHeader_description`)	Can be used as an additional description that is displayed in the module header.
Module Header Content (`moduleHeaderContent`)	Additional content in the module header. These are only displayed if you are in the administration area. Available values: "deployment"

Module Name
(module_name)

Name or title of the module/component.

Module Icon
(module_iconCls)

Individually selectable icon that is displayed before the title.
If no icon is to be displayed, e.g. "none" can be entered. If the field is empty, a standard icon is selected.

Module Description
(moduleHeader_description)

Can be used as an additional description that is displayed in the module header.

Module Header Content
(moduleHeaderContent)

Additional content in the module header.
These are only displayed if you are in the administration area.
Available values: "deployment"

Configuration

Module-specific settings

Name (ID) Description

Name (`ID`)	Description
Layout (`layout`)	Display of the dashboard in columns (default) or as a table
Number of Columns (`numberOfColumns`)	Number of Columns in Dashboard
Number of Rows (`numberOfRows`)	Number of Rows in Dashboard
Internal Configuration (`configuration`)	The configuration of the dashboard is done through the user interface. In some cases, it may be helpful to edit it in JSON format. See Customizing the dashboard view and JSON Konfiguration

Layout
(layout)

Display of the dashboard in columns (default) or as a table

Number of Columns
(numberOfColumns)

Number of Columns in Dashboard

Number of Rows
(numberOfRows)

Number of Rows in Dashboard

Internal Configuration
(configuration)

The configuration of the dashboard is done through the user interface. In some cases, it may be helpful to edit it in JSON format.

See Customizing the dashboard view and JSON Konfiguration

Refresh

Settings for automatic dashboard refresh.

Name (ID) Description

Name (`ID`)	Description
Enable (`function_forceDashboardRefresh`)	Enable automatic dashboard refresh
Interval (`refreshInterval`)	Interval in seconds for automatically refreshing the dashboard

Enable
(function_forceDashboardRefresh)

Enable automatic dashboard refresh

Interval
(refreshInterval)

Interval in seconds for automatically refreshing the dashboard

Widget Header

Settings to customize the widget header.

Name (ID) Description

Name (`ID`)	Description
Information Icon (`function_widgetInfo`)	All widgets included in this dashboard will have an icon in their header. Hovering the mouse over the icon will display information about the widget.
Enable Widget Movement (`function_widgetMove`)	All widgets included in this dashboard will have an icon in their header. Clicking the icon opens a menu, allowing you to move the respective widget.
Enable Widget Refresh (`function_widgetRefresh`)	All widgets included in this dashboard will have an icon in their header. Clicking the icon refreshes the widget.
Enable Module Jump (`function_widgetJump`)	All widgets included in this dashboard will have a jump icon in their header. Clicking the icon will navigate to the associated module.

Information Icon
(function_widgetInfo)

All widgets included in this dashboard will have an icon in their header. Hovering the mouse over the icon will display information about the widget.

Enable Widget Movement
(function_widgetMove)

All widgets included in this dashboard will have an icon in their header. Clicking the icon opens a menu, allowing you to move the respective widget.

Enable Widget Refresh
(function_widgetRefresh)

All widgets included in this dashboard will have an icon in their header. Clicking the icon refreshes the widget.

Enable Module Jump
(function_widgetJump)

All widgets included in this dashboard will have a jump icon in their header. Clicking the icon will navigate to the associated module.

Settings to customize the toolbars.

See Dashboard quick functions

Name (ID) Description

Name (`ID`)	Description
Enable Refresh in Toolbar (`function_toolbarRefresh`)	Displays the refresh button in the header toolbar of the widget
Left Toolbar (`appToolbarLeftContent`)	Content of the toolbar on the left side. The order of the elements affects their arrangement in the toolbar and can be adjusted in this field via drag and drop.
Right Toolbar (`appToolbarRightContent`)	Content of the toolbar on the right side. The order of the elements affects their arrangement in the toolbar and can be adjusted in this field via drag and drop.

Enable Refresh in Toolbar
(function_toolbarRefresh)

Displays the refresh button in the header toolbar of the widget

Left Toolbar
(appToolbarLeftContent)

Content of the toolbar on the left side.
The order of the elements affects their arrangement in the toolbar and can be adjusted in this field via drag and drop.

Right Toolbar
(appToolbarRightContent)

Content of the toolbar on the right side.
The order of the elements affects their arrangement in the toolbar and can be adjusted in this field via drag and drop.

Configuration with the JSON editor

This setting Dashboard configuration configuration contains a JSON array that contains parameters for the individual widgets.

Excerpt of an example configuration

[
    {
        "columnFlex": 307,
        "widgetConfiguration": {
            "name": "CORE_SESSIONS_WIDGET_NAME",
            "additionalActions": [],
            "description": "CORE_SESSIONS_WIDGET_DESCRIPTION",
            "iconCls": "x-fal fa-users",
            "title": "foo"
        },
        "widgetId": 1678110392218,
        "flex": 1,
        "collapsed": false,
        "column": 0,
        "cellIndex": "0-0",
        "colspan": 1,
        "rowspan": 1,
        "className": "BPC.view.widget.sessions.SessionGrid",
        "collapsible": true,
        "height": null
    },
  ...
]

Field Data type Description

Field	Data type	Description
columnFlex	Number	Width of the column in relation to the other `columnFlex` of the other columns. The assignment to the column is made via `column`. (Only for column layout)
widgetConfiguration	JSON	Widget specific configuration.
widgetId	String	Internal ID
flex	Number	Height of the widget in relation to the other `flex` of the other widgets in the same column. (Only for column layout)
collapsed	Boolean	`true` if the widget is initially to be displayed collapsed.
column	Integer	Index of the column in which the widget is to be displayed. The first column has the index 0.
cellIndex	String	Index of the cell (<Spalte>-<Zeile>) in which the widget is to be displayed. (Only for table layout)
colspan	Number	Specifies how many columns a cell should cover horizontally. If colspan: 2 is set, the cell takes up two columns. (Only for table layout)
rowspan	Number	Specifies how many rows a cell should cover vertically. If rowspan: 2 is set, the cell takes up two rows. (Only for table layout)
className	String	Class name of the widget to be loaded.
collapsible	Boolean	`false` to prevent the widget from being collapsed.
height	Number	Fixed height for the widget. Requires `flex` to be set to 0.

columnFlex

Number

Width of the column in relation to the other columnFlex of the other columns. The assignment to the column is made via column.
(Only for column layout)

widgetConfiguration

JSON

Widget specific configuration.

widgetId

String

Internal ID

flex

Number

Height of the widget in relation to the other flex of the other widgets in the same column.
(Only for column layout)

collapsed

Boolean

true if the widget is initially to be displayed collapsed.

column

Integer

Index of the column in which the widget is to be displayed. The first column has the index 0.

cellIndex

String

Index of the cell (<Spalte>-<Zeile>) in which the widget is to be displayed.
(Only for table layout)

colspan

Number

Specifies how many columns a cell should cover horizontally. If colspan: 2 is set, the cell takes up two columns.
(Only for table layout)

rowspan

Number

Specifies how many rows a cell should cover vertically. If rowspan: 2 is set, the cell takes up two rows.
(Only for table layout)

className

String

Class name of the widget to be loaded.

collapsible

Boolean

false to prevent the widget from being collapsed.

height

Number

Fixed height for the widget. Requires flex to be set to 0.

Keywords:

Configuration of the Process Dashboard

General module configuration

Module

Plugin

Security

Component configuration

Module

Configuration

Refresh

Widget Header

Toolbars

Configuration with the JSON editor