Dashboard quick functions

The dashboard provides various quick functions on its interface. 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 configuration of actions

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

Toolbar_LeftContent: BPC toolbar on the left
Toolbar_RightContent: BPC toolbar right
ModuleHeader_Content: Module header

Syntax

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 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

[
    "resetuserstate",
    "saveWarning",
    "save",
    "add",
    "refresh"
]

Overview of the quick functions

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

Some actions are only displayed if the current user is allowed to edit the dashboard.

Reset local changes

ID: resetuserstate

Resets the dashboard to the saved configuration. Changes made by the user, such as widget heights and column widths that were only saved locally in the browser, are lost.

The button is only displayed if there are also locally saved changes.

Warning of unsaved changes

ID: saveWarning

Displays a warning that there are unsaved changes. Clicking on the text saves the changes to the dashboard.

Save

ID: save

Button for saving the current dashboard status.

Add widget

ID: add

Button for adding further widgets.

Update

ID: refresh

Button for updating the widget data. The actual update is delegated to the individual widgets.

Keywords: