Configuring Process Monitoring

Individually selectable icon that is displayed before the title.
If no icon is to be displayed, e.g. "none" can be entered. If the field is empty, a standard icon is selected.

Base path of the module to its offered REST API.
Should not be changed.

Queries can query data up to this limit. If in doubt, the query should filter the data more specifically. A very high value can have a negative impact on performance.

When querying or searching via an index, the number of data records that match the current query is only counted up to this value. A very high value can have a negative impact on performance.

Maximum result quantity in MB that is accepted when querying the data from OpenSearch. A limit that is too large can have a negative impact on the RAM consumption of the system.

Configuration of plugins that are to be displayed within this module. The plugin configuration page of the respective module should be used for customization.

Name or title of the module/component.

Can be used as an additional description that is displayed in the module header.

Individually selectable icon that is displayed before the title.
If no icon is to be displayed, e.g. "none" can be entered. If the field is empty, a standard icon is selected.

Changes to the monitor (e.g. filters) are mapped in the URL. This allows you to switch between these states using the browser's forward/back function.

In resource-saving mode, aggregations to the index are prevented in order to reduce memory consumption in OpenSearch. This can lead to individual functions being restricted.

Additional content in the module header.
These are only displayed if you are in the administration area.
Available values: "deployment"

See Monitor Quick Actions

An array is defined in these settings. Each array element consists of either a string that corresponds to the ID of the desired action or an object that has at least one id attribute and refers to the desired action. If only a string is specified, the action is displayed with the default values for the options. If an object is specified, the options of the actions can be influenced via an additional config attribute.
Possible values: "metadata", "favorites",
"search",
"processstarter",
"changestate",
"processaction",
"export",
"views",
"refresh"

See Monitor Quick Actions

An array is defined in these settings. Each array element consists of either a string that corresponds to the ID of the desired action or an object that has at least one id attribute and refers to the desired action. If only a string is specified, the action is displayed with the default values for the options. If an object is specified, the options of the actions can be influenced via an additional config attribute.
Possible values: "metadata", "favorites",
"search",
"processstarter",
"changestate",
"processaction",
"export",
"views",
"refresh"

See Monitor Quick Actions

Enables the 'Views Menu' for the monitor.

Activates automatic data updating. Changes to the data are automatically recognized and reloaded.

OpenSearch index name for monitor data.

OpenSearch index name for child data that can be viewed via the detail view

This filter can be used to restrict the data displayed. Users do not have the option of bypassing it. The filter can also take into account the organizations, roles, rights or names of the current user.

See Restrict the visibility of monitor data

The operator specifies how the filters for organisations, roles, rights and users are logical linked. With OR (default), all data that fulfils one of the filter settings is displayed. With AND, only data that fulfils all filter settings is displayed.

See Restrict the visibility of monitor data

Standard format for displaying dates

See ExtJS Datumsformat

List of data fields that are excluded from the monitor data. This means that the fields are not transferred to the monitor, even if they are in the index. For example, sensitive or large unused data can be excluded.
Example
["originator", "level"]

During this period (in seconds), change events are collected by the monitor backend before data is reloaded for display in the monitor. This setting is particularly useful for monitors where the data is constantly changing.

When querying or searching via an index, the number of data records that match the current query is only counted up to this value. A very high value can have a negative impact on performance.
The value -1 means that the setting from the general monitor settings is used.

Queries can query data up to this limit. If in doubt, the query should filter the data more specifically. A very high value can have a negative impact on performance.
The value -1 means that the setting from the general monitor settings is used.

Defines the default MIME type for displaying attached documents.
All valid MIME types, such as application/text, are possible.

When this value is active, the suggestion lists in the filters will consider already applied filters.

See Über Auswahlliste filtern

Definition of custom renderers to customize the display of column values.

See monitor:admin/configuration_monitor_columns.adoc#renderer_customrenderer

Enables the feature for customizing the appearance of a monitor row based on its content.

See Dynamically format rows based on their content

Settings for dynamic styling. In columnList, the columns whose content is to be taken into account for styling are listed. Styles for CSS classes are then defined in rowClasses. The name of the classes is formed according to the syntax .-column-name-content. For example, for the column "Status" you can style rows with the value "Error" using the class name .-STATUS-ERROR.

See Dynamically format rows based on their content

Column by which initial sorting takes place.

Direction in which the initial sorting is performed.

Allows sorting by multiple columns.

Maximum number of columns to be sorted by. If this is exceeded, the sorting is removed from the column with the currently lowest priority.

Applies the columns for sorting in reverse order for multiple sorting.

Enables the use of multiple grids (tables) in one monitor. These are displayed in different tabs. Each grid can be assigned a basic filter that is used to filter the data.

See Configuring Multiple Grids/Views

Configuration of the various monitor grids and the data filters used.

See Configuring Multiple Grids/Views

Toggle to show or hide the grid filter bar.

Display a load mask during data load.

Count filters by affected columns, not by the number of filters themselves. This can be different if multiple filters have been applied to a single column.

Prevents the tooltip display of the technical field name underlying the current column.

Enables text selection in the table. This can be disruptive when selecting multiple rows.

Configuration of the view and filter settings for monitor columns.
Is initially generated automatically. Manual adjustments possible.

See Configuring Monitor Columns

Name of the field containing the unique ID of the record.

Name of the field in the child data that establishes the foreign key reference to the primary data.

See Configuring Monitor Detail Views

Name of the field that, in addition to the Child ID, forms the primary key.

See Configuring Monitor Detail Views

Name of the field defining the reference to the timeline. This is important for sorting and widgets.

Field by which the display should be initially grouped. The user can change the grouping independently via the interface.

Initial sort direction for grouped values (ASC or DESC).

Name of the field containing the status of the record.

Configuration of the columns for displaying the child data in the detailed views.
Is initially generated automatically. Manual adjustments possible.

See Tabelle ("childGrid")

List of the fields contained in the data and their data types. This corresponds to the mapping of the OpenSearch index.
It is generated automatically and cannot be changed manually.

List of the fields contained in the data and their data types. This corresponds to the mapping of the OpenSearch index.
It is generated automatically and cannot be changed manually.

HTTP proxy and REST endpoint for file download

Enables the use of process starters.
Users also require the bpcMonitor_startProcess right and, if applicable, loadModule_backendconnection.

See Process Starter

Selection of the REST endpoint or processor for the process starter

Configuration for the forms in the process starter.

See Process Starter

Enables the usage of process actions

Selection of the REST endpoint or processor for the process actions

Allows the user to trigger several multiple actions at once.
This only applies to the current browser tab. If parallelism is deactivated, this does not protect against parallel executions by other users or in other browser tabs.

Columns/fields with this prefix are used as the source for the process actions offered.

Separator for multiple process actions within a field.

Any JSON object that is transferred together with the action to add additional configuration values or context information.

Allows the use of bulk actions.

Selection of the REST endpoint or processor for the bulk actions

The actions that the user can use are configured in this JSON.

Allows the user to trigger several multiple actions at once.
This only applies to the current browser tab. If parallelism is deactivated, this does not protect against parallel executions by other users or in other browser tabs.

Any JSON object that is transferred together with the action to add additional configuration values or context information.

Enables the manual state change function.
To allow a user to use this function, they need the bpcmonitor_changeprocessstate permission.
To grant a user permission for selected components, they need specific permissions with the ID of the component: bpcmonitor_changeprocessstate_{MONITORID}.

Selection of the REST endpoint or processor for the state change

Configuration of function parameters for state change.

Enable pop-up detail view for monitor.

Configuration for the popup detail view in the monitor.

Enable inline detail view for monitor.

Settings for the detailed view for process data in the inline view. The inline view is displayed via a + symbol at the beginning of the line.
In a detailed view, the data of the data record can be displayed in a formatted form, child data for this data record can be displayed or other context-related content can be displayed.

Activates the split view option in the context menu. This can be used to display the detail view in split mode.

Settings for the detailed view for process data in the split view.
In a detailed view, the data of the data record can be displayed in a formatted form, child data for this data record can be displayed or other context-related content can be displayed.

Automatically opens the detail view in split mode when the monitor loads.

Allows the export of data from the monitor. The formats offered can be activated and configured separately.

Defines the default setting in the export window.

Activates the option to perform the export in CSV format.
Attention: The export must also be activated in the general settings.

Column label is used from the column configuration. Otherwise the field name is used as it appears in the index.

Include hidden columns in the export

Defines the CSV column separator.

Activates the option to perform the export in JSON format.
Attention: The export must also be activated in the general settings.

Column label is used from the column configuration. Otherwise, the field name is used as it appears in the index.

Include hidden columns in export

Specifies whether dates are to be output in UTC format or in the format "yyyy-MM-dd HH:mm:ss" and the time zone of the user/browser.

Activates the option to export in Excel format (XLSX).
Attention: The export must also be activated in the general settings.

Column width is determined automatically.

Include hidden columns in export

Column label is used from the column configuration. Otherwise the field name is used as it appears in the index.

Maximum number of data records contained in the export. This value can be changed in the export dialog. A high value can have a negative impact on the server's RAM consumption with large data sets.

Settings for Integration with Collaboration Module

Maximum file size (in bytes) allowed for preview. This is to protect the browser from using too much memory.

Notifications that are triggered by actions can be assigned to a specific type.