Monitor quick functions

The monitor provides various quick functions on its user interface. These are actions that are used frequently and therefore provide a quickly accessible function icon. The individual actions can be configured in a similar way to plugins Pluginsthe individual actions can be positioned in different places and in any order.

Positioning and configuring the actions

The actions can be positioned on the monitor in the administration area using the following parameters:

FunctionToolbar_LeftContent: BPC toolbar left
FunctionToolbar_RightContent: BPC toolbar right
ModuleHeader_Content: Module header

Syntax

An array is defined in these settings. Each array element consists either of a string that corresponds to the ID of the desired action or an object that has at least one attribute id 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 attribute config.

Actions can be specified in any order and frequency.

Sample configuration

[
    {
      "id": "metadata",
      "config": {
        "showFilter": false,
        "showSorter": false
        }
    },
    "favorites",
    "search",
    "processaction",
    "export",
    "views",
    "refresh",
    {
      "id": "refresh",
      "config": {
        "switchAutoUpdate": false
        }
    },
    "plugins"
]

Output of the sample configuration:

Overview of the quick functions

All usable quick functions are described below. Some functions can be configured even further by using special options.

Metadata

ID: metadata

The metadata provides information about the number of data records, active filters and sorting.

Table 1. Options
Option	Description	Type	Default value
`showCount`	Shows the number of data records in the monitor, taking into account all active filters. Function icon:	Boolean	`true`
`showFilter`	Shows the number of all active filters. Function icon:	Boolean	`true`
`showSorter`	Shows the number of all active sorts. Function icon:	Boolean	`true`
`showInfoIcon`	Shows an info icon that contains all metadata as a tooltip. Function icon:	Boolean	`false`
`showSelectionCounter`	Shows the number of all selected data records. Function icon:	Boolean	`false`

Favorites view

ID: favorites

Function icon:

Shows a quick selection for views that are marked as favorites Favorites have been saved as favorites.
If a favorites view is currently open, the corresponding icon is highlighted in color.

Search

ID: search

Function icon:

Enables full-text search in the monitor.

Process actions

ID: processaction

Function icon:

See Configuration of process actions.

Status change

ID: changestate

Function icon:

See Process status change

Export

ID: export

Function icon:

Enables the export of the monitor data.

Views

ID: views

Function icon:

Shows a menu for controlling the monitor views.

Refresh

ID: refresh

Function icon:

Enables manual refreshing of the monitor data.

Table 2. Options
Option	Description	Type	Default value
`switchAutoUpdate`	If this option is activated, the user can deactivate the automatic update for themselves in this monitor.	Boolean	`false`

Plugins

ID: plugins

Enables the placement of plugins in the toolbar. In order for plugins to appear in the toolbar, you must first assign Plugins to one of the Monitor Plugins/Hooks. If plugins are not explicitly configured, they are automatically placed on the far right or far left for the right-hand toolbar.

Layout help for the toolbars

You can also use the following content for the toolbar to influence the arrangement of the functions. This content only influences the display and has no further function.

Spacer (tabulator)

ID: ->

Adds a spacer. All subsequent content is aligned to the right.

Separator

ID: -

A visual separator.

Single spacing

ID: SPACER

Adds extra spacing to the next element.

Keywords: