Configuring the Process Dashboard

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

General Module Configuration

You can access the settings via the administration area under the Process Dashboard > Generaltab.

Setting (ID) Type Description

Setting (ID)	Type	Description
Group: module
Module_ForceLoad (`moduleForceLoad`)	bool	If this setting is enabled, the module is loaded when the BPC interface is loaded. This also applies if the value `moduleLoadStrategy` is set to "onDemand."
Module_Icon (`module_iconCls`)	text	Icon for the respective module in the administration area tab
Module_RestrictInstanceAccess (`module_restrictInstanceAccess`)	bool	Access to module components can be restricted. If the configuration for restricted access is set _ to true,_ the corresponding permission must be granted separately for each component, so that You can access the component.
Group: plugin
PluginConfiguration (`plugin_configuration`)	json	If the module supports plugins, the plugin configuration can be entered or refined here.
Group: security
SanitizeHTML (`sanitizeHtml`)	bool	When enabled, JavaScript and invalid elements are automatically removed. See HTML Sanitizing.

Group: module

Module_ForceLoad
(moduleForceLoad)

bool

If this setting is enabled, the module is loaded when the BPC interface is loaded.
This also applies if the value moduleLoadStrategy is set to "onDemand."

Module_Icon
(module_iconCls)

text

Icon for the respective module in the administration area tab

Module_RestrictInstanceAccess
(module_restrictInstanceAccess)

bool

Access to module components can be restricted. If the configuration for restricted access is set _ to true,_ the corresponding permission must be granted separately for each component, so that You can access the component.

Group: plugin

PluginConfiguration
(plugin_configuration)

json

If the module supports plugins, the plugin configuration can be entered or refined here.

Group: security

SanitizeHTML
(sanitizeHtml)

bool

When enabled, JavaScript and invalid elements are automatically removed. See HTML Sanitizing.

Component Configuration

You can access the settings via the administration area under the tab Process Dashboard > Componentstab.

Setting (ID) Type Description

Setting (ID)	Type	Description
Group: module
Module_Header (`moduleHeader_enabled`)	bool	Enables or disables an additional display and function area in the module header. For the contents of the module header, see Dashboard Quick Actions (["resetuserstate","saveWarning","save","add", "refresh"])
Module_Description (`moduleHeader_description`)	text	Allows you to enter a short description of the module. Displayed as a tooltip for the module header.
Module_Icon (`module_iconCls`)	text	Defines the icon displayed for the module. You can choose from the icons in the FontAwesome library.
Module_Name (`module_name`)	text	Defines the display name of the module.
Group: security
SanitizeHTML (`sanitizeHtml`)	bool	When enabled, JavaScript and invalid elements are automatically removed. See HTML Sanitizing.
Group: Configuration
Dashboard layout (`layout`)	text	Display the dashboard in columns (default) or as a table.
Number of columns in the dashboard (`numberOfColumns`)	Integer	Number of columns in the dashboard.
Number of rows in the dashboard (`numberOfRows`)	Integer	Number of rows in the dashboard. Affects only the table layout.
Dashboard Configuration (`configuration`)	JSON	The dashboard is configured via the user interface; see Customize the Dashboard View. In some cases, it may be helpful to edit this in JSON format; see Configuration with the JSON Editor.
Group: Refresh
Enable Auto-Refresh (`function_forceDashboardRefresh`)	Boolean	Enable automatic refresh of the dashboard
Auto-Refresh Interval (`refreshInterval`)	Integer	Interval in seconds for the automatic refresh of the dashboard
Group: Widget Header
Show Information (`function_widgetInfo`)	Bool	All widgets contained in this dashboard will have an icon in their header. Hovering over the widget displays information about it.
Enable Widget Drag (`function_widgetMove`)	Bool	All widgets included in this dashboard will display an icon in their header. Clicking opens a menu that allows you to drag the corresponding widget.
Enable Widget Refresh (`function_widgetRefresh`)	Bool	All widgets contained in this dashboard will display an icon in their header. Clicking the mouse refreshes the widget.
Enable Module Jump (`function_widgetJump`)	Bool	All widgets contained in this dashboard will display a jump icon in their header. Clicking takes you to the corresponding module.
Group: Toolbar
Enable updates in the toolbar (`function_toolbarRefresh`)	Bool	Enable updates via the toolbar
Toolbar content on the left (`appToolbarLeftContent`)	JSON	For the toolbar content on the left, see Dashboard Quick Actions
Toolbar content on the right (`appToolbarRightContent`)	JSON	For the contents of the toolbar on the right, see Dashboard Quick Actions

Group: module

Module_Header
(moduleHeader_enabled)

bool

Enables or disables an additional display and function area in the module header.
For the contents of the module header, see Dashboard Quick Actions
(["resetuserstate","saveWarning","save","add", "refresh"])

Module_Description
(moduleHeader_description)

text

Allows you to enter a short description of the module. Displayed as a tooltip for the module header.

Module_Icon
(module_iconCls)

text

Defines the icon displayed for the module. You can choose from the icons in the FontAwesome library.

Module_Name
(module_name)

text

Defines the display name of the module.

Group: security

SanitizeHTML
(sanitizeHtml)

bool

When enabled, JavaScript and invalid elements are automatically removed. See HTML Sanitizing.

Group: Configuration

Dashboard layout
(layout)

text

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

Number of columns in the dashboard
(numberOfColumns)

Integer

Number of columns in the dashboard.

Number of rows in the dashboard
(numberOfRows)

Integer

Number of rows in the dashboard.
Affects only the table layout.

Dashboard Configuration
(configuration)

JSON

The dashboard is configured via the user interface; see Customize the Dashboard View.
In some cases, it may be helpful to edit this in JSON format; see Configuration with the JSON Editor.

Group: Refresh

Enable Auto-Refresh
(function_forceDashboardRefresh)

Boolean

Enable automatic refresh of the dashboard

Auto-Refresh Interval
(refreshInterval)

Integer

Interval in seconds for the automatic refresh of the dashboard

Group: Widget Header

Show Information
(function_widgetInfo)

Bool

All widgets contained in this dashboard will have an icon in their header. Hovering over the widget displays information about it.

Enable Widget Drag
(function_widgetMove)

Bool

All widgets included in this dashboard will display an icon in their header. Clicking opens a menu that allows you to drag the corresponding widget.

Enable Widget Refresh
(function_widgetRefresh)

Bool

All widgets contained in this dashboard will display an icon in their header. Clicking the mouse refreshes the widget.

Enable Module Jump
(function_widgetJump)

Bool

All widgets contained in this dashboard will display a jump icon in their header. Clicking takes you to the corresponding module.

Group: Toolbar

Enable updates in the toolbar
(function_toolbarRefresh)

Bool

Enable updates via the toolbar

Toolbar content on the left
(appToolbarLeftContent)

JSON

For the toolbar content on the left, see Dashboard Quick Actions

Toolbar content on the right
(appToolbarRightContent)

JSON

For the contents of the toolbar on the right, see Dashboard Quick Actions

Configuration with the JSON Editor

This "Dashboard Configuration" setting configuration contains a JSON array that includes Parameters for the individual widgets.

Excerpt from a sample 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 relative to the other `columnFlex` columns. The column is assigned via `column`. (Only for column layout)
widgetConfiguration	JSON	Widget-specific configuration.
widgetId	String	Internal ID
flex	Number	Height of the widget relative to the other `flex` remaining widgets in the same column. (Only for column layouts)
collapsed	Boolean	`true` whether the widget should be initially collapsed.
column	Integer	Index of the column in which the widget should be displayed. The first column has an index of 0.
cellIndex	String	Index of the cell (<Spalte>-<Zeile>) in which the widget should be displayed. (Only for table layout)
colspan	Number	Specifies how many columns a cell should span horizontally. If colspan is set to 2, the cell spans two columns. (Table layout only)
rowspan	Number	Specifies how many rows a cell should span vertically. If rowspan is set to 2, the cell spans two rows. (Table layout only)
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 setting `flex` to 0.

columnFlex

Number

Width of the column relative to the other columnFlex columns. The column is assigned via column.
(Only for column layout)

widgetConfiguration

JSON

Widget-specific configuration.

widgetId

String

Internal ID

flex

Number

Height of the widget relative to the other flex remaining widgets in the same column.
(Only for column layouts)

collapsed

Boolean

true whether the widget should be initially collapsed.

column

Integer

Index of the column in which the widget should be displayed. The first column has an index of 0.

cellIndex

String

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

colspan

Number

Specifies how many columns a cell should span horizontally. If colspan is set to 2, the cell spans two columns.
(Table layout only)

rowspan

Number

Specifies how many rows a cell should span vertically. If rowspan is set to 2, the cell spans two rows.
(Table layout only)

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 setting flex to 0.

Keywords: