Konfiguration des Process Monitorings
Im Folgenden werden die verschiedenen Konfigurationsmöglichkeiten des Process Monitorings vorgestellt und beschrieben.
Allgemeine Modulkonfiguration
Zu den Einstellungsmöglichkeiten gelangen Sie über den Administrationsbereich im Reiter Process Monitoring > Allgemein.
Einstellung (ID) | Typ | Beschreibung |
---|---|---|
Gruppe: module |
||
Module_DataCountLimit |
Integer |
Maximale Datenmenge, die im Monitor-Modul geladen wird. |
Module_DataViewLimit |
Integer |
Maximale Ergebnismenge, die man im Monitor-Modul anzeigen und durchscrollen kann. |
Module_ForceLoad |
Boolean |
Erzwingt das initiale Laden auch bei Ladestrategie onDemand, damit Ladeabhängigkeiten berücksichtigt werden können. |
Module_Icon |
Text |
Definiert das verwendete Standard-Icon für den Modultyp Dashboard. |
Module_QueryBufferLimitInMB |
Integer |
Maximale Ergebnismenge in MB bei Abfrage der Daten aus OpenSearch. |
Module_RestrictInstanceAccess |
Boolean |
De-/Aktiviert die Zugriffsbeschränkung für diesen Modultyp über ein spezifisches Recht. Dieses muss einem Nutzer explizit zugewiesen werden. |
Module_URL |
Text |
Gibt den modulspezifischen Basis-Pfad des REST-Interfaces des Monitor-Moduls an. |
Gruppe: plugin |
||
PluginConfiguration |
Json |
Falls das Modul plugin-fähig ist, kann hier die Konfiguration des Plugins eingetragen bzw. verfeinert werden. |
Gruppe: security |
||
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 Monitoring > Komponenten.
Einstellung (ID) | Typ | Beschreibung |
---|---|---|
Gruppe: module |
||
FunctionToolbar_LeftContent |
json |
Siehe Monitor-Schnellfunktionen. |
FunctionToolbar_RightContent |
json |
Siehe Monitor-Schnellfunktionen. |
ModuleHeader_Content |
json |
Siehe Monitor-Schnellfunktionen. |
Module_CustomViews |
bool |
De-/Aktiviert das "Ansichten-Menü" für den Monitor. |
Module_Description |
text |
Beschreibungstext für den Modulheader |
Module_Header |
bool |
De-/Aktivierung des Modulheaders. |
Module_Icon |
text |
Verwendetes Icon im Modulheader |
Module_Name |
text |
Name des Monitors |
Gruppe: security |
||
SanitizeHTML |
bool |
Wenn aktiviert, werden Javascripte und ungültige Elemente automatisch entfernt. Siehe HTML Sanitizing. |
Gruppe: data |
||
Data_Filter |
json |
Möglichkeit, um die Monitordaten anhand von Nutzerrechten einzuschränken. Default:
|
Data_HistoryIndex |
text |
OpenSearch Index-Name für Prozesshistorie. |
Data_ProcessIndex |
text |
OpenSearch Index-Name für Prozesse. |
Data_ProcessExcludedFields |
json |
Liste der Daten-Felder, die vom Monitor-Daten ausgeschlossen sind. Beispiel
|
Data_RefreshBuffer |
integer |
Definiert, über welchen Zeitraum Änderungsevents vom Monitor-Backend gesammelt werden,
bevor ein Update-Event für die Anzeige im Monitor erfolgt. |
Monitor_DataCountLimit |
integer |
Limitiert die Anzahl angezeigter Daten. Der Wert sollte kleiner oder gleich |
Monitor_DataViewLimit |
integer |
Limitiert die Anzahl zu ladender Daten. Ein Wert von 300 sollte nicht unterschritten werden. |
Gruppe: configuration |
||
Monitor_AutoUpdate |
bool |
De-/Aktivieren der automatischen Datenaktualisierung. |
Monitor_CascadingDynamicFilter |
bool |
Wenn dieser Wert aktiv ist, dann werden bei den Vorschlagslisten in den Filtern bereits bestehende Filter berücksichtigt (siehe Über Auswahlliste filtern). |
Monitor_Collaboration |
json |
Hier wird die Integration des Process Collaboration-Moduls gesteuert, falls vorhanden. Default:
|
Monitor_ColumnConfig |
json |
Konfiguration der Ansichts- und Filtereinstellungen der Monitorspalten. |
Monitor_ColumnHistoryConfig |
json |
Konfiguration der Spalten in der Prozesshistorien Tabelle. |
Monitor_ColumnList |
json |
Ansicht des Spaltenmodells der Monitor-Daten sowie der definierten Indexeinstellungen. |
Monitor_CountFilteredColumns |
bool |
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. |
Monitor_CustomRenderer |
json |
Definition der Custom Renderer zur Anpassung der Darstellung von Spaltenwerten. Default:
|
Monitor_DateFormat |
text |
Standardformat für die Darstellung von Zeitangaben. |
Monitor_DefaultMimeType |
text |
Definiert den Standard-Mimetype für die Darstellung von angehängten Dokumenten. |
Monitor_DynamicRowStyle |
bool |
De-/Aktivierung der Funktion zur Anpassung der Darstellung einer Monitor-Zeile anhand des Inhaltes. |
Monitor_DynamicRowStyleConfig |
json |
Ermöglichst das Einfärben/Stylen ganzer Zeilen abhängig von deren Werten. Beispiel:
|
Monitor_FileReferenceColumn |
text |
Name das Feldes, das eine Referenz auf Binärdaten innerhalb des Datensatzes enthält. |
Monitor_GridTextSelektion |
bool |
Ermöglicht die Textselektion in der Tabelle. Dies kann bei der Selektion von mehreren Zeilen störend sein. |
Monitor_HideDefaultTableHeaderTooltip |
bool |
Verhindert die Tooltip-Anzeige des technischen Feldnamens, der die aktuelle Spalte zugrunde liegt. |
Monitor_HistoryID |
text |
Name des Feldes in den (historischen) Detaildaten, das den Fremdschlüsselbezug zu den primären Daten herstellt. |
Monitor_HistoryList |
json |
Ansicht des Spaltenmodells der History-Daten sowie der definierten Indexeinstellungen. |
Monitor_HistorySubID |
text |
Name des Feldes, das zusätzlich zur column_historyId den Primärschlüssel bildet. |
Monitor_InitialGroupColumn |
text |
Feld, nach dem die Anzeige initial gruppiert werden soll. |
Monitor_InteractionColumn |
text |
Name des Feldes, das die Referenzwerte für manuelle Eingriffe über das Process Interaction-Modul enthält. |
Monitor_InteractionColumnValue |
text |
Definiert den Wert zur Anzeige der Process Interaction-Formulare oder -Funktionen. |
Monitor_MainSortColumn |
text |
Spalte nach der initial sortiert wird. |
Monitor_MainSortDirection |
||
Monitor_MimeTypeColumn |
text |
Name des Feldes, das den Mimetype eines Dokumentes des Datensatzes enthält. |
Monitor_MultipleGrids |
bool |
De-/Aktiviert die Möglichkeit mehrere Grids mit gefilterten Datensets zu erzeugen. |
Monitor_MultipleGridsConfig |
json |
Konfiguration der verschiedenen Monitor-Grids sowie der verwendeten Datenfilter. Default:
|
Monitor_MultiSort |
bool |
Ermöglicht das Sortieren nach mehreren Spalten |
Monitor_MultiSortCount |
integer |
Maximale Anzahl der Spalten, nach der sortiert werden darf. |
Monitor_MultiSortReverseOrder |
bool |
De-/Aktiviert die Invertierung der Sortierreihenfolge. |
Monitor_ProcessID |
text |
Name des Feldes, das die eindeutige ID des Datensatzes enthält. |
Monitor_ShowFilterBar |
bool |
Aktiviert die Filterleiste am Tabellenkopf. |
Monitor_ShowGridHeader |
bool |
Blendet einen zusätzlichen Header für die einzelnen Monitor-Grids ein. |
Monitor_ShowLoadingMask |
bool |
Anzeige einer Lademaske während neue Daten geladen werden |
Monitor_StatusColumn |
text |
Name des Feldes, das den Status des Datensatzes enthält. |
Monitor_TimestampColumn |
text |
Name des Feldes, das den Bezug zur Zeitachse definiert. Dies ist wichtig für Sortierungen und Widgets. |
Gruppe: detailView (sieh auch Konfiguration der Monitor-Detailansichten) |
||
DetailView_East |
bool |
Zeige Splitansicht-Option im Kontextmenü an Siehe auch Konfiguration der Monitor-Detailansichten. |
DetailView_EastConfig |
json |
Konfiguration der Detailansicht für Prozessdaten in der Split-View. Siehe auch Konfiguration der Monitor-Detailansichten. Default:
|
DetailView_EastInitialShow |
bool |
Zeige Detail-Splitansicht automatisch beim Öffnen des Monitors an Siehe auch Konfiguration der Monitor-Detailansichten. |
DetailView_Inline |
bool |
Zeige Expand-Button zum Öffnen der InlineDetailView Siehe auch Konfiguration der Monitor-Detailansichten. |
json |
Konfiguration der Detailansicht für Prozessdaten in der Inline-View. Siehe auch Konfiguration der Monitor-Detailansichten. Default:
|
|
DetailView_Popup |
bool |
Zeige DetailPopUp bei Doppelklick auf Prozesseintrag (Zeile) Siehe auch Konfiguration der Monitor-Detailansichten. |
DetailView_PopupConfig |
json |
Konfiguration der Detailansicht für Prozessdaten in der Popup-View. Siehe auch Konfiguration der Monitor-Detailansichten. Default:
|
Gruppe: function |
||
Function_ChangeState |
bool |
De-/Aktivieren der manuellen Statuswechselfunktion. |
Function_ChangeStateConfig |
json |
Konfiguration der Funktionsparameter für den Statuswechsel. Default:
|
Function_ChangeStateEndpoint |
text |
Name des REST-Endpunktes für den Status Wechsel |
Function_ContrlAperakViewEndpoint |
text |
Name des REST-Endpunktes für die APERAL Ansicht |
Function_FileDownloadEndpoint |
text |
Name des REST-Endpunktes für den Dateidownload |
Function_InubitBackendConnection |
text |
Hier muss die ID der zugehörigen Backend-Connection angegeben werden, unter der der relevante INUBIT-Server erreichbar ist. |
Function_InubitBaseURL |
text |
Pfad zu den INUBIT HTTP-Services |
Function_InubitDBGridID |
text |
Definiert die Grid-ID zur Abfrage der korrekten Datenbank. (Bosch PM Legacy Parameter) |
Function_InubitDBTablePrefix |
text |
Definiert den Table-Prefix zur Abfrage der korrekten Datenbanktabelle. (Bosch PM Legacy Parameter) |
Function_InubitPMMandant |
text |
Definiert den Mandanten-Namen zur Abfrage mandanten-spezifischer Daten. (Bosch PM Legacy Parameter) |
Function_ProcessActions |
bool |
Prozessaktionen aktivieren |
Function_ProcessActionsEndpoint |
text |
Name des REST-Endpunktes für den Prozess Aktionen |
Function_ProcessActionsParallel |
bool |
Erlauben, dass der Benutzer mehrere Prozessaktionen auf einmal anstoßen kann. |
Function_ProcessActionsPrefix |
text |
Prefix der als Indikator für Felder mit Prozessaktionen genutzt wird. |
Function_ProcessActionsSeperator |
text |
Separator für mehrere Prozessaktionen in einem Feld |
Function_ProcessStarter |
bool |
Prozess-Starter de-/aktivieren |
Function_ProcessStarterConfig |
json |
Konfiguration für die Prozess-Starter-Funktion. |
Function_ProcessStarterEndpoint |
text |
Name des REST-Endpunktes für den Prozess Starter (siehe Konfiguration Prozess Starter). |
Maximale Datei Größe für Vorschau |
number |
Die maximale Größe (Characters) von einer Datei für Vorschau Funktion. Wenn die tatsächliche Dateigröße größer als diese Konfiguration ist, wird keine Vorschau angeboten und ein Herunterladen ist erforderlich. Zu große Datei kann zu Performanz-Problem führen. Default: 300000 |
Monitor_ResourceSavingMode |
bool |
Beim Ressourcen-Schonenden werden Aggregations-Zugriffe auf den Index unterbunden, um RAM-Speicher auf dem System zu sparen. |
Function_FileDownloadMultiple |
bool |
Ermöglicht den Multi Attachment-Download als Zip-File über das Markieren von mehreren Monitor-Zeilen. Der Download wird über die BPC-Toolbar oder das Kontextmenü angeboten. |
Function_ProcessExportCSV |
bool |
Export in CSV Format aktivieren. |
Function_ProcessExportCSVHiddenColumns |
bool |
Ausgeblendete Spalten in CSV Export aufnehmen. |
Function_ProcessExportCSVSeperator |
text |
CSV Trennzeichen. |
Function_ProcessExportCSVCustomHeader |
bool |
Spaltenbeschriftung aus column_config (text) nehmen. |
Function_ProcessExportJSONUseUTCDateFormat |
bool |
Ausgabe der Datumsfelder im JSON/UTC-Format. |
Function_ProcessExportXLSX |
bool |
Export in Excel Format aktivieren. |
Function_ProcessExportXLSXAutoResize |
bool |
Spaltenbreite automatisch bestimmen. |
Function_ProcessExportXLSXHiddenColumns |
bool |
Ausgeblendete Spalten in Excel Export aufnehmen. |
Function_ProcessExportXLSXCustomHeader |
bool |
Spaltenbeschriftung aus column_config (text) nehmen. |
Function_FileDownload |
bool |
De-/Aktiviert die Einblendung einer Download-Spalte für Attachments im Haupt-Grid. |
Function_ProcessStar |
bool |
De-/Aktiviert die Prozess-Starter-Funktion zum manuellen Auslösen von definierten automatisierten Prozessen. |
Function_FileDownloadZIPEndpoint |
text |
Name des REST-Endpunktes für den Multi-Dateidownload |
Function_ProcessNotificationDisplayMode |
text |
Modus der Benachrichtigungen von Prozess-Startern und -Aktionen. Kann Toast (Kurze Einblendung), PopUp (Fenster, muss bestätigt werden) oder Silent (kein visueller Hinweis) sein. |
Gruppe: export |
||
Function_ProcessExport |
bool |
De-/Aktivierung der Monitor-Exportfunktionen. |
Function_ProcessExportDialogDefaults |
json |
Legt die Vorbelegung im Export-Fenster fest. Default:
|
Maximales Export-Limit |
integer |
Maximales Export-Limit beim Excel. Default: 1000 |
Gruppe: export_csv |
||
Gruppe: export_xlsx |
||
Gruppe: export_json |
Zeilen dynamisch anhand des Inhaltes gestalten
Es ist möglich, über das Monitor Setting row_style
CSS-Styles für die jeweilige Zeile anhand der Daten zu definieren.
Mit dem weiteren Setting row_styleEnabled
kann man dies Feature de/aktivieren, global - für alle definierten Views.
[
{
"columnList": ["STATUS"],
"rowClasses": ".-STATUS-ERROR {background-color: rgba(255, 211, 211, 0.2);}",
"views": ["viewA", "viewB"]
},
{
"columnList": ["STATUS"],
"rowClasses": ".-STATUS-ERROR {background-color: green;}",
"views": ["viewC", "viewD"]
}
]
Einerseits werden über columnList
die Spalten aufgelistet, deren Inhalte für die Gestaltung relevant sind.
Das ist notwendig, um unnötige CSS-Klassen-Zuordnungen zu erstellen, die die Browser-Performance belasten.
Für jede gelistete Spalte wird an jeder Zeile eine CSS-Klasse mit dem Schema "MONITORID-SPALTENNAME-SPALTENWERT" erzeugt.
Der CSS-String im Feld rowClasses
wird als Stylesheet im Dokument erzeugt.
Dabei müssen keine Monitor-IDs eingetragen werden, diese werden automatisch eingefügt bzw. wird ".-" durch ".MONITORID-" ersetzt.
Der Spaltenwert wird immer in UPPERCASE angegeben.
Sollten mehrere CSS-Regeln zutreffen und sich Angaben überschneiden (z.B. Hintergrundfarbe), entscheidet der Browser selbst, welche Angabe er nutzt.
Man kann jedoch einzelne Angaben priorisieren.
Dies geschieht mit der standard CSS-Angabe !important
.
Zuletzt sollte unter views
angegeben werden, in welchen Ansichten die Gestaltung eingesetzt werden soll (falls function_gridMultipleViews
aktiviert ist).
Ein Monitor lässt sich mit mehreren Style-Regeln gestalten.
Wenn keine Views angegeben werden, werden die Regeln für alle Ansichten im Monitor eingesetzt.