Configuration of Process Monitoring
The various configuration options for Process Monitoring are presented and described below.
General module configuration
You can access the settings options via the administration area in the tab Process Monitoring > General tab.
| Setting (ID) | Type | Description |
|---|---|---|
Group: module |
||
Module_DataCountLimit |
Integer |
Maximum amount of data that is loaded in the monitor module. |
Module_DataViewLimit |
Integer |
Maximum amount of results that can be displayed and scrolled through in the monitor module. |
Module_ForceLoad |
Boolean |
Forces the initial load even with load strategy onDemand, so that load dependencies can be taken into account. |
Module_Icon |
Text |
Defines the standard icon used for the Dashboard module type. |
Module_QueryBufferLimitInMB |
Integer |
Maximum result quantity in MB when querying the data from OpenSearch. |
Module_RestrictInstanceAccess |
Boolean |
Activates/deactivates the access restriction for this module type via a specific right. This must be explicitly assigned to a user. |
Module_URL |
Text |
Specifies the module-specific base path of the REST interface of the monitor module. |
Group: plugin |
||
PluginConfiguration |
Json |
If the module is plugin-enabled, the configuration of the plugin can be specified here Plugin can be entered or refined here. |
Group: security |
||
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 Monitoring > Components.
| Setting (ID) | Type | Description |
|---|---|---|
Group: module |
||
FunctionToolbar_LeftContent |
json |
|
FunctionToolbar_RightContent |
json |
|
ModuleHeader_Content |
json |
|
Module_CustomViews |
bool |
Enables/disables the "Views menu" for the monitor. |
Module_Description |
text |
Description text for the module header |
Module_Header |
bool |
Enables/disables the module header. |
Module_Icon |
text |
Icon used in the module header |
Module_Name |
text |
Name of the monitor |
Group: security |
||
SanitizeHTML |
bool |
If activated, Javascripts and invalid elements are automatically removed. See HTML Sanitizing. |
Group: data |
||
Data_Filter |
json |
Option to restrict the monitor data based on user rights. Default:
|
Data_Filter_Operator |
list |
Logical operator for combining multiple data filters for organizations, roles, rights and users. |
Data_HistoryIndex |
text |
OpenSearch Index name for process history. |
Data_ProcessIndex |
text |
OpenSearch Index name for processes. |
Data_ProcessExcludedFields |
json |
List of data fields that are excluded from the monitor data. Example
|
Data_RefreshBuffer |
integer |
Defines the period of time over which change events are collected by the monitor backend,
before an update event for the display in the monitor occurs. |
Monitor_DataCountLimit |
integer |
Limits the number of displayed data. The value should be less than or equal to |
Monitor_DataViewLimit |
integer |
Limits the amount of data to be loaded. The value should not fall below 300. |
Group: configuration |
||
Monitor_AutoUpdate |
bool |
De-/activate automatic data update. |
Monitor_CascadingDynamicFilter |
bool |
If this value is active, existing filters are taken into account in the suggestion lists in the filters. |
Monitor_Collaboration |
json |
The integration of the Process Collaboration module is controlled here, if available. Default:
|
Monitor_ColumnConfig |
json |
Configuration of the view and filter settings of the monitor columns. |
Monitor_ColumnHistoryConfig |
json |
Configuration of the columns in the process history table. |
Monitor_ColumnList |
json |
View of the column model of the monitor data and the defined index settings. |
Monitor_CountFilteredColumns |
bool |
Counts the filters by affected columns, not by the number of filters themselves. This can be different if several filters have been applied to a column. |
Monitor_CustomRenderer |
json |
Definition of the custom renderer for customizing the display of column values. Default:
|
Monitor_DateFormat |
text |
Standard format for displaying time information. |
Monitor_DefaultMimeType |
text |
Defines the default mimetype for the display of attached documents. |
Monitor_DynamicRowStyle |
bool |
Enables/disables the function for adapting the display of a monitor row based on the content. |
Monitor_DynamicRowStyleConfig |
json |
Enables the coloring/styling of entire rows depending on their values. Example:
|
Monitor_FileReferenceColumn |
text |
Name of the field that contains a reference to binary data within the data set. |
Monitor_GridTextSelection |
bool |
Enables text selection in the table. This can be disruptive when selecting multiple rows. |
Monitor_HideDefaultTableHeaderTooltip |
bool |
Prevents the tooltip display of the technical field name on which the current column is based. |
Monitor_HistoryID |
text |
Name of the field in the (historical) detailed data that establishes the foreign key reference to the primary data. |
Monitor_HistoryList |
json |
View of the column model of the history data and the defined index settings. |
Monitor_HistorySubID |
text |
Name of the field that forms the primary key in addition to the column_historyId. |
Monitor_InitialGroupColumn |
text |
Field according to which the display is to be initially grouped. |
Monitor_InteractionColumn |
text |
Name of the field that contains the reference values for manual interventions via the Process Interaction module. |
Monitor_InteractionColumnValue |
text |
Defines the value for displaying the Process Interaction forms or functions. |
Monitor_MainSortColumn |
text |
Column by which initial sorting is performed. |
Monitor_MainSortDirection |
||
Monitor_MimeTypeColumn |
text |
Name of the field that contains the mimetype of a document of the data set. |
Monitor_MultipleGrids |
bool |
Enables/disables the option to create multiple grids with filtered data sets. |
Monitor_MultipleGridsConfig |
json |
Configuration of the various monitor grids and the data filters used. Default:
|
Monitor_MultiSort |
bool |
Enables sorting by multiple columns |
Monitor_MultiSortCount |
integer |
Maximum number of columns by which sorting is permitted. |
Monitor_MultiSortReverseOrder |
bool |
Enables/disables the inversion of the sort order. |
Monitor_ProcessID |
text |
Name of the field that contains the unique ID of the data record. |
Monitor_ShowFilterBar |
bool |
Activates the filter bar at the top of the table. |
Monitor_ShowGridHeader |
bool |
Displays an additional header for the individual monitor grids. |
Monitor_ShowLoadingMask |
bool |
Displays a loading mask while new data is being loaded |
Monitor_StatusColumn |
text |
Name of the field that contains the status of the data set. |
Monitor_TimestampColumn |
text |
Name of the field that defines the reference to the time axis. This is important for sorting and widgets. |
Navigation via states |
bool |
Changes to the monitor state (filter, sorting, etc.) are mapped in the URL. This allows you to navigate through these states using the browser’s back/forward function. |
Group: detailView (see also Configuration of the monitor detail views) |
||
DetailView_East |
bool |
Show split view option in the context menu |
DetailView_EastConfig |
json |
Configuration of the detail view for process data in the split view. Default:
|
DetailView_EastInitialShow |
bool |
Show detail split view automatically when opening the monitor |
DetailView_Inline |
bool |
Show expand button to open the InlineDetailView |
json |
Configuration of the detail view for process data in the inline view. Default:
|
|
DetailView_Popup |
bool |
Show DetailPopUp on double-click on process entry (line) |
DetailView_PopupConfig |
json |
Configuration of the detail view for process data in the popup view. Default:
|
Group: function |
||
Function_ChangeState |
bool |
Enable/disable the manual status change function. |
Function_ChangeStateConfig |
json |
Configuration of the function parameters for the status change. Default:
|
Function_ChangeStateEndpoint |
text |
Name of the REST endpoint for the status change |
Function_ContrlAperakViewEndpoint |
text |
Name of the REST endpoint for theEndpoint for the APERAL view |
Function_FileDownloadEndpoint |
text |
Name of the REST endpoint for the file download |
Function_InubitBackendConnection |
text |
The ID of the associated backend connection must be specified here, under which the relevant INUBIT server can be reached. |
Function_InubitBaseURL |
text |
Path to the INUBIT HTTP Services |
Function_InubitDBGridID |
text |
Defines the grid ID for querying the correct database. (Bosch PM Legacy Parameter) |
Function_InubitDBTablePrefix |
text |
Defines the table prefix for querying the correct database table. (Bosch PM Legacy Parameter) |
Function_InubitPMMandant |
text |
Defines the client name for querying client-specific data. (Bosch PM Legacy Parameter) |
Function_ProcessActions |
bool |
Enable process actions |
Function_ProcessActionsEndpoint |
text |
Name of the REST endpoint for the process actions |
Function_ProcessActionsParallel |
bool |
Allow the user to trigger multiple process actions at once. |
Function_ProcessActionsPrefix |
text |
Prefix that is used as an indicator for fields with process actions. |
Function_ProcessActionsSeperator |
text |
Separator for several process actions in one field |
Function_ProcessStarter |
bool |
Deactivate/activate process starter |
Function_ProcessStarterConfig |
json |
Configuration for the process starter function. |
Function_ProcessStarterEndpoint |
text |
Name of the REST endpoint for the process starter (see Configuration Process Starter). |
Maximum file size for preview |
number |
The maximum size (characters) of a file for preview function. If the actual file size is larger than this configuration, no preview is offered and a download is required. Too large a file can lead to performance problems. Default: 300000 |
Monitor_ResourceSavingMode |
bool |
In resource-saving mode, aggregation accesses to the index are prevented in order to save RAM memory on the system. |
Function_FileDownloadMultiple |
bool |
Enables the multi-attachment download as a zip file by selecting several monitor lines. The download is offered via the BPC toolbar or the context menu. |
Function_ProcessExportCSV |
bool |
Enable export in CSV format. |
Function_ProcessExportCSVHiddenColumns |
bool |
Include hidden columns in CSV export. |
Function_ProcessExportCSVSeperator |
text |
CSV separator. |
Function_ProcessExportCSVCustomHeader |
bool |
Take column label from column_config (text). |
Function_ProcessExportJSONUseUTCDateFormat |
bool |
Output of the date fields in JSON/UTC format. |
Function_ProcessExportXLSX |
bool |
Activate export in Excel format. |
Function_ProcessExportXLSXAutoResize |
bool |
Determine column width automatically. |
Function_ProcessExportXLSXHiddenColumns |
bool |
Include hidden columns in Excel export. |
Function_ProcessExportXLSXCustomHeader |
bool |
Take column labeling from column_config (text). |
Function_FileDownload |
bool |
Enables/disables the display of a download column for attachments in the main grid. |
Function_ProcessStar |
bool |
Enables/disables the process starter function for manual triggering of defined automated processes. |
Function_FileDownloadZIPEndpoint |
text |
Name of the REST endpoint for the multi-file download |
Function_ProcessNotificationDisplayMode |
text |
Mode of the notifications of process starters and actions.
Can be "Toast" (short display), "PopUp" (window, must be confirmed) or "Silent" (no visual notification). |
Group: export |
||
Function_ProcessExport |
bool |
De-/activation of the monitor export functions. |
Function_ProcessExportDialogDefaults |
json |
Defines the default settings in the export window. Default:
|
Maximum export limit |
integer |
Maximum export limit for Excel. Default: 1000 |
Group: export_csv |
||
Group: export_xlsx |
||
Group: export_json |
||
Design rows dynamically based on the content
It is possible to define CSS styles for the respective row based on the data via the monitor setting row_style.
With the further setting row_styleEnabled you can de/activate this feature globally - for all defined 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"]
}
]
On the one hand, the columns whose content is relevant for the design are listed via columnList.
This is necessary to create unnecessary CSS class assignments that burden browser performance.
For each listed column, a CSS class with the schema "MONITORID-SPALTENNAME-SPALTENWERT" is created on each line.
The CSS string in the rowClasses field is created as a stylesheet in the document.
No monitor IDs need to be entered, these are inserted automatically or ".-" is replaced by ".MONITORID-".
The column value is always specified in UPPERCASE.
If several CSS rules apply and specifications overlap (e.g. background color), the browser itself decides which specification it uses.
However, individual specifications can be prioritized.
This is done with the standard CSS specification !important.
Finally, the views in which the design is to be used should be specified at views (if function_gridMultipleViews is activated).
A monitor can be designed with several style rules.
If no views are specified, the rules are used for all views in the monitor.