Konfiguration des Process Dashboards

Im Folgenden werden die verschiedenen Konfigurationsmöglichkeiten des Process Dashboards vorgestellt und beschrieben.

Allgemeine Modulkonfiguration

Zu den Einstellungsmöglichkeiten gelangen Sie über den Administrationsbereich im Reiter Process Dashboard > Allgemein.

Einstellung (ID) Typ Beschreibung

Einstellung (ID)	Typ	Beschreibung
Gruppe: module
Module_ForceLoad (`moduleForceLoad`)	bool	Wenn dieser Wert aktiv ist, dann wird das Modul beim Laden der BPC Oberfläche mitgeladen. Dies gilt auch, wenn der Wert `moduleLoadStrategy` auf "onDemand" gestellt ist.
Module_Icon (`module_iconCls`)	text	Icon des jeweiligen Moduls im Reiter des Administrationsbereichs
Module_RestrictInstanceAccess (`module_restrictInstanceAccess`)	bool	Für die Verwendung von Modulkomponenten kann der Zugriff eingeschränkt werden. Wird die Konfiguration für den eingeschränkten Zugriff gesetzt (true), so muss für jede Komponente das entsprechende Recht extra vergeben werden, damit der Anwender auf die Komponente zugreifen kann.
Gruppe: plugin
PluginConfiguration (`plugin_configuration`)	json	Falls das Modul plugin-fähig ist, kann hier die Konfiguration des Plugins eingetragen bzw. verfeinert werden.
Gruppe: security
SanitizeHTML (`sanitizeHtml`)	bool	Wenn aktiviert, werden Javascripte und ungültige Elemente automatisch entfernt. Siehe HTML Sanitizing.

Gruppe: module

Module_ForceLoad
(moduleForceLoad)

bool

Wenn dieser Wert aktiv ist, dann wird das Modul beim Laden der BPC Oberfläche mitgeladen.
Dies gilt auch, wenn der Wert moduleLoadStrategy auf "onDemand" gestellt ist.

Module_Icon
(module_iconCls)

text

Icon des jeweiligen Moduls im Reiter des Administrationsbereichs

Module_RestrictInstanceAccess
(module_restrictInstanceAccess)

bool

Für die Verwendung von Modulkomponenten kann der Zugriff eingeschränkt werden. Wird die Konfiguration für den eingeschränkten Zugriff gesetzt (true), so muss für jede Komponente das entsprechende Recht extra vergeben werden, damit der Anwender auf die Komponente zugreifen kann.

Gruppe: plugin

PluginConfiguration
(plugin_configuration)

json

Falls das Modul plugin-fähig ist, kann hier die Konfiguration des Plugins eingetragen bzw. verfeinert werden.

Gruppe: security

SanitizeHTML
(sanitizeHtml)

bool

Wenn aktiviert, werden Javascripte und ungültige Elemente automatisch entfernt. Siehe HTML Sanitizing.

Komponenten-Konfiguration

Zu den Einstellungsmöglichkeiten gelangen Sie über den Administrationsbereich im Reiter Process Dashboard > Komponenten.

Einstellung (ID) Typ Beschreibung

Einstellung (ID)	Typ	Beschreibung
Gruppe: module
Module_Header (`moduleHeader_enabled`)	bool	Ermöglicht das De-/Aktivieren eines zusätzlichen Anzeige- und Funktionsbereichs im Header des Moduls. Inhalt des Modul-Headers siehe Dashboard-Schnellfunktionen (["resetuserstate","saveWarning","save","add", "refresh"])
Module_Description (`moduleHeader_description`)	text	Ermöglicht das Hinterlegen einer kurzen Beschreibung des Moduls. Wird als Tooltip des Module Headers angezeigt.
Module_Icon (`module_iconCls`)	text	Definiert das Anzeige-Icon des Moduls. Zur Auswahl stehen die Icons der FontAwesome-Bibliothek.
Module_Name (`module_name`)	text	Definiert den Anzeige-Namen des Moduls.
Gruppe: security
SanitizeHTML (`sanitizeHtml`)	bool	Wenn aktiviert, werden Javascripte und ungültige Elemente automatisch entfernt. Siehe HTML Sanitizing.
Gruppe: Configuration
Dashboard-Layout (`layout`)	text	Darstellung des Dashboards in Spalten (Default) oder als Tabelle.
Anzahl der Spalten im Dashboard (`numberOfColumns`)	Integer	Anzahl der Spalten im Dashboard.
Anzahl der Zeilen im Dashboard (`numberOfRows`)	Integer	Anzahl der Zeilen im Dashboard. Wirkt sich nur auf das Tabellen-Layout aus.
Dashboard-Konfiguration (`configuration`)	JSON	Die Konfiguration des Dashboards erfolgt über die Benutzeroberfläche, siehe Dashboard-Ansicht anpassen. In einigen Fällen kann es hilfreich sein, diese im JSON-Format zu bearbeiten siehe Konfiguration mit dem JSON-Editor.
Gruppe: Refresh
Auto-Refresh aktivieren (`function_forceDashboardRefresh`)	Bool	Automatischen Refresh des Dashboards aktivieren
Auto-Refresh-Intervall (`refreshInterval`)	Integer	Intervall in Sekunden für den automatischen Refresh des Dashboards
Gruppe: Widget Header
Informationen anzeigen (`function_widgetInfo`)	Bool	Alle in diesem Dashboard enthaltenen Widgets erhalten in ihrem Header ein Icon. Per Mausberührung werden Informationen zu dem Widget eingeblendet.
Widget-Verschiebung aktivieren (`function_widgetMove`)	Bool	Alle in diesem Dashboard enthaltenen Widgets erhalten in ihrem Header ein Icon. Per Mausklick öffnet sich ein Menu, welches eine Verschiebung des zugehörigen Widgets ermöglicht.
Widget-Aktualisierung aktivieren (`function_widgetRefresh`)	Bool	Alle in diesem Dashboard enthaltenen Widgets erhalten in ihrem Header ein Icon. Per Mausklick erfolgt ein Refresh des Widgets.
Module-Sprung aktivieren (`function_widgetJump`)	Bool	Alle in diesem Dashboard enthaltenen Widgets erhalten in ihrem Header ein Sprung Icon. Per Mausklick erfolgt ein Sprung auf das zugehörige Modul.
Gruppe: Toolbar
Aktualisierung in Toolbar aktivieren (`function_toolbarRefresh`)	Bool	Aktivieren der Aktualisierung über die Toolbar
Inhalt Toolbar links (`appToolbarLeftContent`)	JSON	Inhalt der Toolbar auf der linken Seite siehe Dashboard-Schnellfunktionen
Inhalt Toolbar rechts (`appToolbarRightContent`)	JSON	Inhalt der Toolbar auf der rechten Seite siehe Dashboard-Schnellfunktionen

Gruppe: module

Module_Header
(moduleHeader_enabled)

bool

Ermöglicht das De-/Aktivieren eines zusätzlichen Anzeige- und Funktionsbereichs im Header des Moduls.
Inhalt des Modul-Headers siehe Dashboard-Schnellfunktionen
(["resetuserstate","saveWarning","save","add", "refresh"])

Module_Description
(moduleHeader_description)

text

Ermöglicht das Hinterlegen einer kurzen Beschreibung des Moduls. Wird als Tooltip des Module Headers angezeigt.

Module_Icon
(module_iconCls)

text

Definiert das Anzeige-Icon des Moduls. Zur Auswahl stehen die Icons der FontAwesome-Bibliothek.

Module_Name
(module_name)

text

Definiert den Anzeige-Namen des Moduls.

Gruppe: security

SanitizeHTML
(sanitizeHtml)

bool

Wenn aktiviert, werden Javascripte und ungültige Elemente automatisch entfernt. Siehe HTML Sanitizing.

Gruppe: Configuration

Dashboard-Layout
(layout)

text

Darstellung des Dashboards in Spalten (Default) oder als Tabelle.

Anzahl der Spalten im Dashboard
(numberOfColumns)

Integer

Anzahl der Spalten im Dashboard.

Anzahl der Zeilen im Dashboard
(numberOfRows)

Integer

Anzahl der Zeilen im Dashboard.
Wirkt sich nur auf das Tabellen-Layout aus.

Dashboard-Konfiguration
(configuration)

JSON

Die Konfiguration des Dashboards erfolgt über die Benutzeroberfläche, siehe Dashboard-Ansicht anpassen.
In einigen Fällen kann es hilfreich sein, diese im JSON-Format zu bearbeiten siehe Konfiguration mit dem JSON-Editor.

Gruppe: Refresh

Auto-Refresh aktivieren
(function_forceDashboardRefresh)

Bool

Automatischen Refresh des Dashboards aktivieren

Auto-Refresh-Intervall
(refreshInterval)

Integer

Intervall in Sekunden für den automatischen Refresh des Dashboards

Gruppe: Widget Header

Informationen anzeigen
(function_widgetInfo)

Bool

Alle in diesem Dashboard enthaltenen Widgets erhalten in ihrem Header ein Icon. Per Mausberührung werden Informationen zu dem Widget eingeblendet.

Widget-Verschiebung aktivieren
(function_widgetMove)

Bool

Alle in diesem Dashboard enthaltenen Widgets erhalten in ihrem Header ein Icon. Per Mausklick öffnet sich ein Menu, welches eine Verschiebung des zugehörigen Widgets ermöglicht.

Widget-Aktualisierung aktivieren
(function_widgetRefresh)

Bool

Alle in diesem Dashboard enthaltenen Widgets erhalten in ihrem Header ein Icon. Per Mausklick erfolgt ein Refresh des Widgets.

Module-Sprung aktivieren
(function_widgetJump)

Bool

Alle in diesem Dashboard enthaltenen Widgets erhalten in ihrem Header ein Sprung Icon. Per Mausklick erfolgt ein Sprung auf das zugehörige Modul.

Gruppe: Toolbar

Aktualisierung in Toolbar aktivieren
(function_toolbarRefresh)

Bool

Aktivieren der Aktualisierung über die Toolbar

Inhalt Toolbar links
(appToolbarLeftContent)

JSON

Inhalt der Toolbar auf der linken Seite siehe Dashboard-Schnellfunktionen

Inhalt Toolbar rechts
(appToolbarRightContent)

JSON

Inhalt der Toolbar auf der rechten Seite siehe Dashboard-Schnellfunktionen

Konfiguration mit dem JSON-Editor

Diese Einstellung Dashboard-Konfiguration configuration enthält ein JSON Array, welches Parameter für die einzelnen Widgets enthält.

Auszug einer Beispielkonfiguration

[
    {
        "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
    },
  ...
]

Feld Datentyp Beschreibung

Feld	Datentyp	Beschreibung
columnFlex	Number	Breite der Spalte im Verhältnis zu den anderen `columnFlex` der übrigen Spalten. Die Zuweisung zur Spalte erfolgt über `column`. (Nur bei Spalten-Layout)
widgetConfiguration	JSON	Widget spezifische Konfiguration.
widgetId	String	Interne ID
flex	Number	Höhe des Widgets im Verhältnis zu den anderen `flex` der übrigen Widgets in der gleichen Spalte. (Nur bei Spalten-Layout)
collapsed	Boolean	`true` wenn das Widget initial eingeklappt dargestellt werden soll.
column	Integer	Index der Spalte, in dem das Widget angezeigt werden soll. Die erste Spalte hat den Index 0.
cellIndex	String	Index der Zelle (<Spalte>-<Zeile>), in der das Widget angezeigt werden soll. (Nur bei Tabellen-Layout)
colspan	Number	Gibt an, wie viele Spalten eine Zelle horizontal überdecken soll. Wenn colspan: 2 gesetzt ist, nimmt die Zelle zwei Spalten ein. (Nur bei Tabellen-Layout)
rowspan	Number	Gibt an, wie viele Zeilen eine Zelle vertikal überdecken soll. Wenn rowspan: 2 gesetzt ist, nimmt die Zelle zwei Zeilen ein. (Nur bei Tabellen-Layout)
className	String	Klassenname des Widgets, dass geladen werden soll.
collapsible	Boolean	`false` um zu verhindern, dass das Widget eingeklappt werden kann.
height	Number	Feste Höhe für das Widget. Erfordert das Setzen von `flex` auf 0.

columnFlex

Number

Breite der Spalte im Verhältnis zu den anderen columnFlex der übrigen Spalten. Die Zuweisung zur Spalte erfolgt über column.
(Nur bei Spalten-Layout)

widgetConfiguration

JSON

Widget spezifische Konfiguration.

widgetId

String

Interne ID

flex

Number

Höhe des Widgets im Verhältnis zu den anderen flex der übrigen Widgets in der gleichen Spalte.
(Nur bei Spalten-Layout)

collapsed

Boolean

true wenn das Widget initial eingeklappt dargestellt werden soll.

column

Integer

Index der Spalte, in dem das Widget angezeigt werden soll. Die erste Spalte hat den Index 0.

cellIndex

String

Index der Zelle (<Spalte>-<Zeile>), in der das Widget angezeigt werden soll.
(Nur bei Tabellen-Layout)

colspan

Number

Gibt an, wie viele Spalten eine Zelle horizontal überdecken soll. Wenn colspan: 2 gesetzt ist, nimmt die Zelle zwei Spalten ein.
(Nur bei Tabellen-Layout)

rowspan

Number

Gibt an, wie viele Zeilen eine Zelle vertikal überdecken soll. Wenn rowspan: 2 gesetzt ist, nimmt die Zelle zwei Zeilen ein.
(Nur bei Tabellen-Layout)

className

String

Klassenname des Widgets, dass geladen werden soll.

collapsible

Boolean

false um zu verhindern, dass das Widget eingeklappt werden kann.

height

Number

Feste Höhe für das Widget. Erfordert das Setzen von flex auf 0.

Keywords: