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.

Setting (ID) Type Description

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

Group: module

Module_ForceLoad
(moduleForceLoad)

bool

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

Module_Icon
(module_iconCls)

text

Icon of the respective module in the tab of the administration area

Module_RestrictInstanceAccess
(module_restrictInstanceAccess)

bool

Access can be restricted for the use of module components. If the configuration for restricted access is set (true), the corresponding right must be assigned separately for each component, so that the user can access the component.

Group: plugin

PluginConfiguration
(plugin_configuration)

json

If the module is plugin-enabled, the configuration of the plugin can be set here Plugin can be entered or refined here.

Group: security

SanitizeHTML
(sanitizeHtml)

bool

If activated, javascripts and invalid elements are automatically removed. See HTML Sanitizing.

Component configuration

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

Setting (ID) Type Description

Setting (ID)	Type	Description
Group: module
Module_Header (`moduleHeader_enabled`)	bool	Enables the activation/deactivation of an additional display and function area in the header of the module. Content of the module header see Dashboard quick functions (["resetuserstate", "saveWarning", "save", "add", "refresh"])
Module_Description (`moduleHeader_description`)	text	Enables the storage of a short description of the module. Is displayed as a tooltip of the module header.
Module_Icon (`module_iconCls`)	text	Defines the display icon of the module. The icons of the FontAwesome library are available for selection.
Module_Name (`module_name`)	text	Defines the display name of the module.
Group: security
SanitizeHTML (`sanitizeHtml`)	bool	If activated, Javascripts and invalid elements are automatically removed. See HTML Sanitizing.
Group: Configuration
Dashboard layout (`layout`)	text	Display of 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. Only affects the table layout.
Dashboard configuration (`configuration`)	JSON	The dashboard is configured via the user interface, see Customizing the dashboard view. In some cases, it can be helpful to edit these in JSON format, see Configuration with the JSON editor.
Group: Refresh
Enable auto-refresh (`function_forceDashboardRefresh`)	Bool	Enable auto-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 receive an icon in their header. Information about the widget is displayed at the touch of a mouse.
Enable widget movement (`function_widgetMove`)	Bool	All widgets contained in this dashboard receive an icon in their header. A menu opens with a mouse click, which enables the associated widget to be moved.
Enable widget refresh (`function_widgetRefresh`)	Bool	All widgets contained in this dashboard receive an icon in their header. Click to refresh the widget.
Enable module jump (`function_widgetJump`)	Bool	All widgets contained in this dashboard receive a jump icon in their header. Click to jump to the associated module.
Group: Toolbar
Activate update in toolbar (`function_toolbarRefresh`)	Bool	Activate the update via the toolbar
Content toolbar left (`appToolbarLeftContent`)	JSON	Content of the toolbar on the left side see Dashboard quick functions
Content of the toolbar on the right (`appToolbarRightContent`)	JSON	Content of the toolbar on the right see Dashboard quick functions

Group: module

Module_Header
(moduleHeader_enabled)

bool

Enables the activation/deactivation of an additional display and function area in the header of the module.
Content of the module header see Dashboard quick functions
(["resetuserstate", "saveWarning", "save", "add", "refresh"])

Module_Description
(moduleHeader_description)

text

Enables the storage of a short description of the module. Is displayed as a tooltip of the module header.

Module_Icon
(module_iconCls)

text

Defines the display icon of the module. The icons of the FontAwesome library are available for selection.

Module_Name
(module_name)

text

Defines the display name of the module.

Group: security

SanitizeHTML
(sanitizeHtml)

bool

If activated, Javascripts and invalid elements are automatically removed. See HTML Sanitizing.

Group: Configuration

Dashboard layout
(layout)

text

Display of 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.
Only affects the table layout.

Dashboard configuration
(configuration)

JSON

The dashboard is configured via the user interface, see Customizing the dashboard view.
In some cases, it can be helpful to edit these in JSON format, see Configuration with the JSON editor.

Group: Refresh

Enable auto-refresh
(function_forceDashboardRefresh)

Bool

Enable auto-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 receive an icon in their header. Information about the widget is displayed at the touch of a mouse.

Enable widget movement
(function_widgetMove)

Bool

All widgets contained in this dashboard receive an icon in their header. A menu opens with a mouse click, which enables the associated widget to be moved.

Enable widget refresh
(function_widgetRefresh)

Bool

All widgets contained in this dashboard receive an icon in their header. Click to refresh the widget.

Enable module jump
(function_widgetJump)

Bool

All widgets contained in this dashboard receive a jump icon in their header. Click to jump to the associated module.

Group: Toolbar

Activate update in toolbar
(function_toolbarRefresh)

Bool

Activate the update via the toolbar

Content toolbar left
(appToolbarLeftContent)

JSON

Content of the toolbar on the left side see Dashboard quick functions

Content of the toolbar on the right
(appToolbarRightContent)

JSON

Content of the toolbar on the right see Dashboard quick functions

Configuration with the JSON editor

This setting Dashboard configuration configuration contains a JSON array which contains 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 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: