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.

Modul

Allgemeine Modul Einstellungen

Name (ID) Beschreibung

Name (`ID`)	Beschreibung
Zugriff einschränken (`module_restrictInstanceAccess`)	Wenn diese Option aktiviert ist, benötigen Benutzer eine zusätzliche Berechtigung für jede Komponente, um sie zu verwendet. Das Recht zum Verwenden des Moduls lautet <code>loadModule_MODULE-ID</code>, wobei MODULE-ID der technischen ID des Moduls entspricht. Das Recht zum Verwenden einer konkreten Modul-Komponente lautet <code>useModuleInstance_MODULE-INSTANCE-ID</code>, wobei MODULE-INSTANCE-ID der ID der jeweiligen Komponente entspricht.
Icon (`module_iconCls`)	Individuell auswählbares Icon, das vor dem Titel angezeigt wird. Falls kein Symbol angezeigt werden soll, kann z.B. "none" eingetragen werden. Bei leerem Feld wird ein Standard-Icon gewählt.
Modul immer laden (`moduleForceLoad`)	Erzwingt das initiale Laden des Moduls im Browser, auch bei der Ladestrategie "onDemand".

Zugriff einschränken
(module_restrictInstanceAccess)

Wenn diese Option aktiviert ist, benötigen Benutzer eine zusätzliche Berechtigung für jede Komponente, um sie zu verwendet.
Das Recht zum Verwenden des Moduls lautet <code>loadModule_MODULE-ID</code>, wobei MODULE-ID der technischen ID des Moduls entspricht.
Das Recht zum Verwenden einer konkreten Modul-Komponente lautet <code>useModuleInstance_MODULE-INSTANCE-ID</code>, wobei MODULE-INSTANCE-ID der ID der jeweiligen Komponente entspricht.

Icon
(module_iconCls)

Individuell auswählbares Icon, das vor dem Titel angezeigt wird.
Falls kein Symbol angezeigt werden soll, kann z.B. "none" eingetragen werden. Bei leerem Feld wird ein Standard-Icon gewählt.

Modul immer laden
(moduleForceLoad)

Erzwingt das initiale Laden des Moduls im Browser, auch bei der Ladestrategie "onDemand".

Plugin

Einstellungen zur Verwaltung von Plugins im Modul

Name (ID) Beschreibung

Name (`ID`)	Beschreibung
Plugin-Konfiguration (`plugin_configuration`)	Konfiguration von Plugins, die innerhalb dieses Moduls angezeigt werden sollen. Für die Anpassung sollte die Plugin-Konfigurations-Seite des jeweiligen Moduls genutzt werden. Siehe Plugins

Plugin-Konfiguration
(plugin_configuration)

Konfiguration von Plugins, die innerhalb dieses Moduls angezeigt werden sollen. Für die Anpassung sollte die Plugin-Konfigurations-Seite des jeweiligen Moduls genutzt werden.

Siehe Plugins

Sicherheit

Einstellungen zur Applikationssicherheit

Name (ID) Beschreibung

Name (`ID`)	Beschreibung
HTML-Bereinigung (`sanitizeHtml`)	Wenn aktiviert, werden JavaScript und ungültige Elemente automatisch entfernt. Siehe HTML Sanitizing in der BPC Dokumentation. Siehe HTML Sanitizing

HTML-Bereinigung
(sanitizeHtml)

Wenn aktiviert, werden JavaScript und ungültige Elemente automatisch entfernt. Siehe HTML Sanitizing in der BPC Dokumentation.

Siehe HTML Sanitizing

Komponenten-Konfiguration

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

Modul

Allgemeine Modul Einstellungen

Name (ID) Beschreibung

Name (`ID`)	Beschreibung
Modul-Name (`module_name`)	Name bzw. Titel des Modules/der Komponente.
Modul-Icon (`module_iconCls`)	Individuell auswählbares Icon, das vor dem Titel angezeigt wird. Falls kein Symbol angezeigt werden soll, kann z.B. "none" eingetragen werden. Bei leerem Feld wird ein Standard-Icon gewählt.
Modul-Beschreibung (`moduleHeader_description`)	Kann als zusätzliche Beschreibung genutzt werden, die im Modulheader angezeigt wird.
Modulheader (`moduleHeaderContent`)	Zusätzliche Inhalte im Modulheader. Diese werden nur angezeigt, wenn man im Administrationsbereich ist. Verfügbare Werte: "deployment"

Modul-Name
(module_name)

Name bzw. Titel des Modules/der Komponente.

Modul-Icon
(module_iconCls)

Individuell auswählbares Icon, das vor dem Titel angezeigt wird.
Falls kein Symbol angezeigt werden soll, kann z.B. "none" eingetragen werden. Bei leerem Feld wird ein Standard-Icon gewählt.

Modul-Beschreibung
(moduleHeader_description)

Kann als zusätzliche Beschreibung genutzt werden, die im Modulheader angezeigt wird.

Modulheader
(moduleHeaderContent)

Zusätzliche Inhalte im Modulheader.
Diese werden nur angezeigt, wenn man im Administrationsbereich ist.
Verfügbare Werte: "deployment"

Konfiguration

Modulspezifische Einstellungen

Name (ID) Beschreibung

Name (`ID`)	Beschreibung
Layout (`layout`)	Anzeige des Dashboards in Spalten (Standard) oder als Tabelle
Anzahl der Spalten (`numberOfColumns`)	Anzahl der Spalten im Dashboard
Anzahl der Zeilen (`numberOfRows`)	Anzahl der Zeilen im Dashboard
Interne Konfiguration (`configuration`)	Die Konfiguration des Dashboards erfolgt über die Benutzeroberfläche. In einigen Fällen kann es hilfreich sein, diese im JSON-Format zu bearbeiten. Siehe Dashboard-Ansicht anpassen und JSON Konfiguration

Layout
(layout)

Anzeige des Dashboards in Spalten (Standard) oder als Tabelle

Anzahl der Spalten
(numberOfColumns)

Anzahl der Spalten im Dashboard

Anzahl der Zeilen
(numberOfRows)

Anzahl der Zeilen im Dashboard

Interne Konfiguration
(configuration)

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

Siehe Dashboard-Ansicht anpassen und JSON Konfiguration

Aktualisierung

Einstellungen der automatischen Aktualisierung des Dashboards.

Name (ID) Beschreibung

Name (`ID`)	Beschreibung
Aktiv (`function_forceDashboardRefresh`)	Automatisches Aktualisieren der Dashboard-Inhalte.
Intervall (`refreshInterval`)	Intervall in Sekunden für das automatische Aktualisieren des Dashboards.

Aktiv
(function_forceDashboardRefresh)

Automatisches Aktualisieren der Dashboard-Inhalte.

Intervall
(refreshInterval)

Intervall in Sekunden für das automatische Aktualisieren des Dashboards.

Widget Header

Einstellungen zur Anpassung des Widget-Headers

Name (ID) Beschreibung

Name (`ID`)	Beschreibung
Informationsicon (`function_widgetInfo`)	Alle Widgets in diesem Dashboard erhalten ein Icon im Header. Bei Mouse‑Over zeigt es Informationen zum Widget.
Widget-Verschiebung aktivieren (`function_widgetMove`)	Alle Widgets in diesem Dashboard erhalten ein Verschiebe‑Icon im Header. Per Mausklick öffnet sich ein Menu, welches eine Verschiebung des zugehörigen Widgets ermöglicht.
Widget-Aktualisierung aktivieren (`function_widgetRefresh`)	Alle in diesem Dashboard enthaltenen Widgets erhalten in ihrem Header ein Icon. Per Mausklick erfolgt ein Refresh des Widgets.
Modulsprung aktivieren (`function_widgetJump`)	Alle Widgets in diesem Dashboard erhalten ein Sprung‑Icon im Header. Klick darauf springt zum zugehörigen Modul.

Informationsicon
(function_widgetInfo)

Alle Widgets in diesem Dashboard erhalten ein Icon im Header. Bei Mouse‑Over zeigt es Informationen zum Widget.

Widget-Verschiebung aktivieren
(function_widgetMove)

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

Widget-Aktualisierung aktivieren
(function_widgetRefresh)

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

Modulsprung aktivieren
(function_widgetJump)

Alle Widgets in diesem Dashboard erhalten ein Sprung‑Icon im Header. Klick darauf springt zum zugehörigen Modul.

Einstellungen zur Anpassung der Toolbars

Siehe Dashboard-Schnellfunktionen

Name (ID) Beschreibung

Name (`ID`)	Beschreibung
Refresh-Symbol in Toolbar aktivieren (`function_toolbarRefresh`)	Zeigt den Refresh-Button in der Toolbar des Widgets an
Linke Toolbar (`appToolbarLeftContent`)	Inhalte der Toolbar auf der linken Seite. Die Reihenfolge beeinflusst die Anordnung und kann hier per Drag‑and‑Drop angepasst werden.
Rechte Toolbar (`appToolbarRightContent`)	Inhalte der Toolbar auf der rechten Seite. Die Reihenfolge beeinflusst die Anordnung und kann hier per Drag‑and‑Drop angepasst werden.

Refresh-Symbol in Toolbar aktivieren
(function_toolbarRefresh)

Zeigt den Refresh-Button in der Toolbar des Widgets an

Linke Toolbar
(appToolbarLeftContent)

Inhalte der Toolbar auf der linken Seite.
Die Reihenfolge beeinflusst die Anordnung und kann hier per Drag‑and‑Drop angepasst werden.

Rechte Toolbar
(appToolbarRightContent)

Inhalte der Toolbar auf der rechten Seite.
Die Reihenfolge beeinflusst die Anordnung und kann hier per Drag‑and‑Drop angepasst werden.

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: