Monitor Quick Actions

The monitor provides various quick actions on its interface. These are actions that are used frequently and therefore have a quick-access icon. Similar to plugins, the individual actions can be placed in various locations 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 on the left
FunctionToolbar_RightContent: BPC toolbar on the right
ModuleHeader_Content: Module header

Syntax

An array is defined in these settings. Each array element consists either of a string corresponding 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, you can influence the action’s options using an additional attribute: config.

Actions can be specified in any order and with any 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 Quick Functions

All available quick functions are described below. Some functions can be further configured using special options.

Metadata

ID: metadata

The metadata provides information about the number of records, active filters, and sort orders.

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

Favorites View

ID: favorites

Function icon:

Displays a quick selection of views that have been saved as favorites.
If a favorite 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 Configuring Process Actions.

Status Change

ID: changestate

Function icon:

See Process Status Change

Export

ID: export

Function icon:

Allows you to export monitor data.

Views

ID: views

Function icon:

Displays a menu for controlling the monitor views.

Refresh

ID: refresh

Function icon:

Allows manual refreshing of monitor data.

Table 2. Options
Option	Description	Type	Default value
`switchAutoUpdate`	If this option is enabled, You can disable automatic updates for themselves in this monitor.	Boolean	`false`

Plugins

ID: plugins

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

Layout aids for the toolbars

You can also use the following content for the toolbar to influence the arrangement of functions. This content only affects the appearance and has no other function.

Spacer (Tab)

ID: ->

Adds a spacer. This aligns all subsequent content to the right.

Separator

ID: -

A visual separator.

Simple Spacing

ID: SPACE

Adds extra spacing to the next element.

Keywords: