Konfiguration des Process Monitorings

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

Überblick Monitoring-Administration

Allgemeine Modulkonfiguration

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

Modul

Allgemeine Modul Einstellungen

Name (ID) Beschreibung

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.

Basispfad REST-API
(moduleUrl)

Basispfad des Moduls zu seiner angebotenen REST-API.
Sollte nicht geändert werden.

Daten Abfragelimit
(monitor_data_view_limit)

Abfragen können bis zu diesem Limit Daten abfragen. Im Zweifelsfall sollte die Abfrage die Daten spezifischer Filtern. Ein sehr hoher Wert kann die Performance negativ beeinflussen.

Daten Zähllimit
(monitor_data_count_limit)

Beim Abfragen oder Suchen über einen Index wird nur bis zu diesem Wert gezählt, wie viele Datensätze auf die aktuelle Abfrage passen. Ein sehr hoher Wert kann die Performance negativ beeinflussen.

OpenSearch Pufferlimit
(monitor_query_buffer_limit_in_mb)

Maximale Ergebnismenge in MB die bei einer Abfrage der Daten aus OpenSearch entgegengenommen wird. Ein zu großes Limit kann den RAM-Verbrauch des Systems negativ beeinflussen.

Plugin

Einstellungen zur Verwaltung von Plugins im Modul

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.

Komponenten-Konfiguration

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

Modul

Allgemeine Modul Einstellungen

Name (ID) Beschreibung

Benutzerdefinierte Ansichten
(function_saveView)

Aktiviert das "Ansichten-Menü" für den Monitor.

Name
(module_name)

Name bzw. Titel des Modules/der Komponente.

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.

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"

Toolbar links
(appToolbarLeftContent)

In diesen Einstellungen wird ein Array definiert. Jedes Array-Element besteht entweder aus einem String, der der ID der gewünschten Aktion entspricht oder einem Object, welches mindestens ein Attribut id besitzt und auf die gewünschte Aktion verweist. Wird nur ein String angegeben, so wird die Aktion mit den Standardwerten für die Optionen dargestellt. Wir ein Objekt angegeben, kann man über ein zusätzliches Attribut config die Optionen der Aktionen beeinflussen.
Mögliche Werte: "metadata", "favorites",
"search",
"processstarter",
"changestate",
"processaction",
"export",
"views",
"refresh"

Toolbar rechts
(appToolbarRightContent)

In diesen Einstellungen wird ein Array definiert. Jedes Array-Element besteht entweder aus einem String, der der ID der gewünschten Aktion entspricht oder einem Object, welches mindestens ein Attribut id besitzt und auf die gewünschte Aktion verweist. Wird nur ein String angegeben, so wird die Aktion mit den Standardwerten für die Optionen dargestellt. Wir ein Objekt angegeben, kann man über ein zusätzliches Attribut config die Optionen der Aktionen beeinflussen.
Mögliche Werte: "metadata", "favorites",
"search",
"processstarter",
"changestate",
"processaction",
"export",
"views",
"refresh"

Konfiguration

Modulspezifische Einstellungen

Name (ID) Beschreibung

Mehrfach-Grid Aktiv
(function_gridMultipleViews)

Ermöglicht die Verwendung von mehreren Grids(Tabellen) in einem Monitor. Diese werden in verschiedenen Tabs dargestellt. Jedes Grid kann einen Basisfilter erhalten, der für das Filtern der Daten genutzt wird.

Mehrfach-Grid-Einstellungen
(function_gridMultipleViewsConfig)

Konfiguration der verschiedenen Monitor-Grids sowie der verwendeten Datenfilter.

Spalte
(grid_mainSortColumn)

Spalte, nach der initial sortiert wird.

Richtung
(grid_mainSortDirection)

Richtung, nach der initial sortiert wird.

Einstellung dynamisches Styling
(row_style)

Einstellungen für das dynamische Styling. In <code>columnList</code> werden die Spalten aufgelistet, deren Inhalt beim Styling berücksichtigt werden sollen. In <code>rowClasses</code> werden dann Styles für CSS-Klassen definiert. Der Name der Klassen bildet sich nach der Syntax <code>.-SPALTENNAME-INHALT</code>. Z.B. für die Spalte "Status" kann man Zeilen mir den Wert "Error" über den Klassennamen <code>.-STATUS-ERROR</code> stylen.

Dynamisches Styling von Zeilen
(row_styleEnabled)

Aktivierung der Funktion zur Anpassung der Darstellung einzelner Monitor-Zeilen (z.B. eingefärbter Hintergrund) anhand deren Inhaltes.

Gefilterte Spalten zählen
(gui_countFilteredColumns)

Zählt die Filter nach betroffenen Spalten, nicht nach Anzahl der Filter selbst. Dies kann unterschiedlich sein, wenn auf einer Spalte mehrere Filter gelegt wurden.

Textauswahl
(grid_textSelectionEnabled)

Ermöglicht die Textselektion in der Tabelle. Dies kann bei der Selektion von mehreren Zeilen störend sein.

Lademaske
(grid_showLoadMask)

Anzeige einer Lademaske während neue Daten geladen werden

Benutzerdefinierte Renderer
(column_customRenderer)

Definition der benutzerdefinierten Renderer zur Anpassung der Darstellung von Spaltenwerten.

Datei
(column_file)

Name der Spalte, die Dateninhalte enthält oder auf eine Datei verweist.

MIME-Type
(column_mimetype)

Name des Feldes, das den Mimetype der im Datensatz enthaltenen oder referenzierten Datei enthält.

Child Sub-ID
(column_historySubId)

Name des Feldes, das zusätzlich zur Child ID den Primärschlüssel bildet.

Child ID
(column_historyId)

Name des Feldes in den Child-Daten, das den Fremdschlüsselbezug zu den primären (parent) Daten herstellt.

Primärschlüssel
(column_id)

Name des Feldes, das die eindeutige ID des Datensatzes enthält.

Status
(column_status)

Name des Feldes, das den Status des Datensatzes enthält.

Standard-MIME-Typ
(column_default_mimetype)

Definiert den Standard-Mimetype für die Darstellung von angehängten Dokumenten.
Alle zulässigen Mimetypes, wie z.B. application/text, möglich.

Gruppierung
(column_groupField)

Nach diesem Feld wird die Anzeige initial gruppiert. Der Anwender kann die Gruppierung über die Oberfläche selbstständig ändern.

Zeitstempel
(column_timeseries)

Name des Feldes, das den Bezug zur Zeitachse definiert. Dies ist wichtig für Sortierungen und Widgets.

Mehrfachsortierung
(sort_multi)

Ermöglicht das Sortieren nach mehreren Spalten

Spaltenanzahl
(sort_multiColumnCount)

Maximale Anzahl der Spalten, nach der sortiert werden darf. Wird diese überschritten, so wird die Sortierung an der Spalte mit der aktuell niedrigsten Priorität entfernt.

Umgekehrte Mehrfachsortierung
(sort_multiReversedOrder)

Wendet bei Mehrfachsortierung die Spalten zum Sortieren in umgekehrter Reihenfolge an.

Datumsformat
(date_format)

Standardformat für die Darstellung von Zeitangaben.

Feldliste
(column_list)

List der in den Daten enthaltenen Felder und deren Datentypen. Dies entspricht dem Mapping des OpenSearch Indexes.
Wird automatisch generiert und kann nicht manuell geändert werden.

Child Feldliste
(column_historyList)

List der in den Daten enthaltenen Felder und deren Datentypen. Dies entspricht dem Mapping des OpenSearch Indexes.
Wird automatisch generiert und kann nicht manuell geändert werden.

Spaltenkonfiguration
(column_config)

Konfiguration der Ansichts- und Filtereinstellungen der Monitorspalten.
Wird initial automatisch generiert. Manuelle Anpassungen möglich.

Spaltenkonfiguration Childdaten
(column_historyConfig)

Konfiguration der Spalten für die Darstellung der Child-Daten in den Detailansichten.
Wird initial automatisch generiert. Manuelle Anpassungen möglich.

Collaboration
(module_collab_descriptor)

Einstellung für die Verbindung zum Collaboration-Modul

Automatische Aktualisierung
(function_autoUpdate)

Aktiviert die automatische Datenaktualisierung. Änderungen der Daten werden automatisch erkannt und nachgeladen.

Filterleiste
(gui_showFilterBar)

Aktiviert die Filterleiste am Tabellenkopf.

Filter berücksichtigen
(function_filterRespectOtherColumns)

Wenn dieser Wert aktiv ist, dann werden bei den Vorschlagslisten in den Filtern bereits bestehende Filter berücksichtigt.

Tooltip am Spaltenkopf deaktivieren
(hideDefaultTableHeaderTooltip)

Verhindert die Tooltip-Anzeige des technischen Feldnamens, der der aktuellen Spalte zugrunde liegt.

Zustand in URL
(gui_stateBrowsing)

Änderungen am Monitor (z.B. Filter) werden in der URL abgebildet. Damit kann man über die Vor/Zurück Funktion vom Browser zwischen diesen Zuständen wechseln.

Daten

Einstellungen zu den Daten

Name (ID) Beschreibung

Index
(data_index)

OpenSearch Index-Name für Monitordaten.

Ausgeschlossene Felder
(data_excludedFields)

Liste der Daten-Felder, die aus den Monitor-Daten ausgeschlossen sind. Das bedeutet, dass die Felder, auch wenn sie im Index vorliegen, nicht an den Monitor übertragen werden. So können z.B. sensible oder große unbenutzte Daten ausgeschlossen werden.
Beispiel
["originator", "level"]

Child Index
(data_historyIndex)

OpenSearch Index-Name für Child-Daten, die über die Detailansicht eingesehen werden können.

Datenfilter
(data_filter)

Über diesen Filter können die angezeigten Daten eingeschränkt werden. Benutzer haben nicht die Möglichkeit diesen zu umgehen. Der Filter kann auch die Organisationen, Rollen, Rechte oder Namen des aktuellen Nutzers berücksichtigen.

Filteroperator
(data_filter_operator)

Der Operator gibt an, wie die Filter für Organisationen, Rollen, Rechte und Nutzer miteinander verknüpft werden. Mit ODER (Standard) werden alle Daten angezeigt, die eine der Filtereinstellungen erfüllen. Mit UND werden nur Daten angezeigt, die alle Filtereinstellungen erfüllen.

Aktualisierungspuffer
(data_refreshBuffer)

{}

Daten Abfragelimit
(instance_data_view_limit)

Abfragen können bis zu diesem Limit Daten abfragen. Im Zweifelsfall sollte die Abfrage die Daten spezifischer Filtern. Ein sehr hoher Wert kann die Performance negativ beeinflussen.
Der Wert <code>-1</code> bedeutet, dass die Einstellung aus den allgemeinen Monitor-Einstellungen verwendet wird.

Daten Zähllimit
(instance_data_count_limit)

Beim Abfragen oder Suchen über einen Index wird nur bis zu diesem Wert gezählt, wie viele Datensätze auf die aktuelle Abfrage passen. Ein sehr hoher Wert kann die Performance negativ beeinflussen.
Der Wert <code>-1</code> bedeutet, dass die Einstellung aus den allgemeinen Monitor-Einstellungen verwendet wird.

Detail Ansicht

Einstellungen der verschiedenen Detailfenster, welche im Monitor aktiviert werden können.

Name (ID) Beschreibung

Split-Modus
(detailView_east)

Aktiviert die Splitansicht-Option im Kontextmenü. Darüber lässt sich die Detailansicht im Split-Modus anzeigen.

Initialer Split-Modus
(detailView_eastInitialShow)

Zeigt die Detailansicht im Split-Modus automatisch beim Öffnen des Monitors an.

Split-Modus Einstellungen
(detailView_eastConfig)

Einstellungen der Detailansicht für Prozessdaten in der Split-View.
In einer Detailansicht lassen sich die Daten des Datensatzes aufbereitet darstellen, Child-Daten zu diesem Datensatz anzeigen oder andere kontextbezogene Inhalte anzeigen.

Inline
(detailView_inline)

Zeige Expand-Button zum Öffnen der InlineDetailView

Inline Einstellungen
(detailView_inlineConfig)

Einstellungen der Detailansicht für Prozessdaten in der Inline-Ansicht. Die Inline-Ansicht wird über ein + Symbol am Anfang der Zeile eingeblendet.
In einer Detailansicht lassen sich die Daten des Datensatzes aufbereitet darstellen, Child-Daten zu diesem Datensatz anzeigen oder andere kontextbezogene Inhalte anzeigen.

Popup
(detailView_popup)

Zeige DetailPopUp bei Doppelklick auf Prozesseintrag (Zeile)

Popup Einstellungen
(detailView_popupConfig)

Einstellungen der Detailansicht für Prozessdaten in der Popup-View.
In einer Detailansicht lassen sich die Daten des Datensatzes aufbereitet darstellen, Child-Daten zu diesem Datensatz anzeigen oder andere kontextbezogene Inhalte anzeigen.

Export

Allgemeine Einstellungen zum Datenexport

Name (ID) Beschreibung

Aktiv
(function_exportEnable)

Erlaubt den Export von Daten aus dem Monitor. Die angebotenen Formate können separat aktiviert und konfiguriert werden.

Datensatzlimit
(function_maxExportLimit)

Maximale Anzahl an Datensätzen, die im Export enthalten sind. Dieser Wert kann im Export-Dialog geändert werden. Ein hoher Wert kann bei großen Datensätzen den RAM-Verbrauch des Servers negativ beeinflussen.

Export-Dialog
(function_exportDialogDefaults)

Legt die Vorbelegung im Export-Fenster fest.

CSV Export

Einstellungen zum Datenexport im CSV Format

Name (ID) Beschreibung

Aktiv
(function_exportConfigCsv)

Aktiviert die Option den Export im CSV-Format durchzuführen.
Achtung: Zusätzlich muss der Export in den allgemeinen Einstellungen aktiviert sein.

CSV-Trennzeichen
(function_exportConfigCsvSeparator)

Legt den CSV-Spaltentrenner fest.

Ausgeblendete Spalten einschließen
(function_exportConfigCsvInclHidden)

Ausgeblendete Spalten im Export einschließen

Konfigurierte Spaltennamen
(function_exportConfigCsvUseCustomColumnHeaders)

Spaltenbeschriftung wird aus der Spaltenkonfiguration verwendet. Ansonsten wird der Feldname verwendet, wie er in Index steht.

JSON Export

Einstellungen zum Datenexport im JSON Format

Name (ID) Beschreibung

Aktiv
(function_exportConfigJson)

Aktiviert die Option den Export im JSON-Format durchzuführen.
Achtung: Zusätzlich muss der Export in den allgemeinen Einstellungen aktiviert sein.

Ausgeblendete Spalten einschließen
(function_exportConfigJsonInclHidden)

Ausgeblendete Spalten im Export einschließen

Konfigurierte Spaltennamen
(function_exportConfigJsonUseCustomColumnHeaders)

Spaltenbeschriftung wird aus der Spaltenkonfiguration verwendet. Ansonsten wird der Feldname verwendet, wie er in Index steht.

UTC-Datumsformat
(function_exportConfigJsonUseUTCDateFormat)

Legt fest, ob Datumsangaben im UTC-Format ausgegeben werden sollen oder in dem Format "yyyy-MM-dd HH:mm:ss" und der Zeitzone des Benutzers/Browsers.

XLSX Export

Einstellungen zum Datenexport im XLSX Format

Name (ID) Beschreibung

Aktiv
(function_exportConfigXlsx)

Aktiviert die Option den Export im Excel-Format(XLSX) durchzuführen.
Achtung: Zusätzlich muss der Export in den allgemeinen Einstellungen aktiviert sein.

Ausgeblendete Spalten einschließen
(function_exportConfigXlsxInclHidden)

Ausgeblendete Spalten im Export einschließen

Konfigurierte Spaltennamen
(function_exportConfigXlsxUseCustomColumnHeaders)

Spaltenbeschriftung wird aus der Spaltenkonfiguration verwendet. Ansonsten wird der Feldname verwendet, wie er in Index steht.

Automatische Spaltenbreite
(function_exportConfigXlsxAutoResizeColumns)

Spaltenbreite wird automatisch bestimmt.

Erweiterte Einstellungen

Erweiterte Einstellungen

Name (ID) Beschreibung

Endpunkt oder Prozessor
(actionEndpointProcessor)

Auswahl des REST-Endpunktes oder Prozessors für die Prozess-Aktionen

Basis-URL für INUBIT
(inubit_baseUrl)

Pfad zu den INUBIT HTTP-Services

Endpunkt oder Prozessor
(changeStateEndpointProcessor)

Auswahl des REST-Endpunktes oder Prozessors für den Status-Wechsel

Präfix für INUBIT-Datenbanktabellen
(inubit_dbTablePrefix)

Definiert den Table-Prefix zur Abfrage der korrekten Datenbanktabelle. (Bosch PM Legacy Parameter)

INUBIT Backend-Verbindung
(inubit_proxyId)

Hier muss die ID der zugehörigen Backend-Connection angegeben werden, unter der der relevante INUBIT-Server erreichbar ist.

Endpunkt für Dateidownload
(inubit_referenceEndpoint)

Name des REST-Endpunktes für den Dateidownload

Endpunkt oder Prozessor
(vpsEndpointProcessor)

Auswahl des REST-Endpunktes oder Prozessors für den Prozess-Starter

Maximale Dateigröße für Vorschau
(function_filePreviewSizeLimit)

Maximale Dateigröße(in Byte) die für Vorschau erlaubt ist. Dies soll den Browser vor zu großen Speicherverbrauch schützen.

Einstellungen
(function_processStartConfig)

Einstellungen der im Prozess-Starter angebotenen Elemente.

Aktiv
(function_processActions)

Erlaubt die Verwendung von Prozess-Aktionen.

Aktiv
(function_processStart)

Ermöglicht die Verwendung von Prozess-Startern.
Benutzer benötigen zusätzlich das Recht <code>bpcMonitor_startProcess</code> und ggf. <code>loadModule_backendconnection</code>.

Parallelität
(function_processActionAllowParallel)

Ermöglicht es dem Benutzer mehrere Prozess-Aktionen auf einmal anzustoßen.
Dies bezieht sich nur auf den aktuellen Browsertab. Wenn Parallelität deaktiviert ist, schützt das nicht vor parallelen Ausführungen von anderen Benutzern oder in anderen Browser-Tabs.

Einstellungen
(function_changeStateConfig)

Einstellungen der Funktionsparameter für den Statuswechsel.

Aktiv
(function_changeState)

Ermöglicht die Verwendung der manuellen Statuswechselfunktion.
Damit ein Benutzer diese Funktion nutzen kann, benötigt er das Recht <code>bpcmonitor_changeprocessstate</code>.
Um einem Benutzer das Recht für ausgewählte Komponenten zu geben, benötigt er spezifizierte Rechte mit der ID der Komponente: <code>bpcmonitor_changeprocessstate_&#x7B;MONITORID&#x7D;</code>.

Trennzeichen
(function_processActionSeparator)

Trennzeichen für mehrere Prozess-Aktionen in einem Feld

Spaltenpräfix
(function_processActionPrefix)

Spalten/Felder mit diesem Prefix werden als Quelle für die angebotenen Prozess-Aktionen genutzt.

Metadaten
(function_processActionMetadata)

Ein beliebiges JSON-Objekt, das zusammen mit der Aktion übertragen wird, um zusätzliche Konfigurationswerte oder Kontextinformationen zu ergänzen.

Benachrichtigungstyp für Aktionen
(function_processNotificationDisplayMode)

Benachrichtigungen die durch Aktionen ausgelöst werden, können so einem bestimmten Typen zugeordnet werden.

Ressourcensparmodus
(resource_saving_mode)

Beim Ressourcensparmodus werden Aggregationen auf den Index unterbunden, um den Speicherverbrauch im OpenSearch zu reduzieren. Dies kann dazu führen, dass einzelne Funktionen eingeschränkt sind.

Mehrfach-Aktionen

Einstellungen zu Mehrfach-Aktionen

Name (ID) Beschreibung

Aktiv
(function_bulkActions)

Erlaubt die Verwendung von Mehrfach-Aktionen.

Aktionen
(function_bulkActionConfig)

In diesem JSON werden die Aktionen konfiguriert, die der Anwender nutzen kann.

Endpunkt oder Prozessor
(bulkActionEndpointProcessor)

Auswahl des REST-Endpunktes oder Prozessors für die Mehrfach-Aktionen

Parallelität
(function_bulkActionAllowParallel)

Ermöglicht es dem Benutzer mehrere Mehrfach-Aktionen auf einmal anzustoßen.
Dies bezieht sich nur auf den aktuellen Browsertab. Wenn Parallelität deaktiviert ist, schützt das nicht vor parallelen Ausführungen von anderen Benutzern oder in anderen Browser-Tabs.

Metadaten
(function_bulkActionMetadata)

Ein beliebiges JSON-Objekt, das zusammen mit der Aktion übertragen wird, um zusätzliche Konfigurationswerte oder Kontextinformationen zu ergänzen.


Keywords: