Dashboard Quick Actions

The dashboard provides various quick actions on its interface. Similar to plugins, the individual actions can be placed in different locations and in any order.

Positioning and Configuring Actions

Actions can be positioned on the dashboard in the administration area using the following Parameters:

Toolbar_LeftContent: BPC Toolbar (left)
Toolbar_RightContent: BPC Toolbar (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

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

Overview of Quick Functions

All available quick functions are described below. Some functions can be further configured 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. This will cause any user-made changes—such as widget heights and column widths—that were saved only locally in the browser to be lost.

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

Warning about unsaved changes

ID: saveWarning

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

Save

ID: save

Button to save the current state of the dashboard.

Add Widget

ID: add

Button to add additional widgets.

Refresh

ID: refresh

Button to refresh the widget data. The actual refresh is delegated to the individual widgets.

Keywords: