Caching and Persistent States in the Monitor
This page describes which monitor settings serve as default values and can be overridden by persisted states. It also explains how local browser state, saved views, and multiple grids affect the visible behavior of a monitor.
The monitor operates with multiple levels of persistence. Initial values for the monitor’s behavior are loaded from the monitor configuration. In addition, the monitor stores states locally in the browser. Furthermore, saved views can contain a complete monitor state on the server side, which can be reapplied later.
Which states are retained locally
The monitor stores grid-related states locally in the browser. If there are multiple grids, this applies separately to each grid.
In particular, the following are retained locally:
-
Sorting of a grid
-
Filters of a grid
-
Freezing of the currently displayed or selected records; see Freezing Records
-
Grouping of a grid
-
Column state of a grid
-
Visibility, order, and width of columns
-
the monitor’s global search (across all grids)
-
the active grid in a multi-grid monitor
Changes a user makes to these properties are stored in the browser’s local storage.
These locally stored states are reapplied when the monitor is reloaded.
Settings that can be overridden by the local state
Some monitor settings initially provide only a default value when the monitor is created. As soon as a local state already exists for the monitor, it can override the configured values.
This applies in particular to:
Changes to these settings are therefore usually not visible after a browser refresh. A previously saved local state or an applied monitor view continues to take precedence.
Example: grid_mainSortColumn
The setting grid_mainSortColumn defines the column by which the monitor is initially sorted.
If a user later applies a different sort order in the monitor, this state is saved locally. After a browser refresh, this user-defined sort order is retained. Even a subsequent change to this setting in the configuration will not be visible.
The changed configuration will not become visible again until at least one of the following occurs:
-
the monitor state is reset
-
the local browser state is cleared
-
a saved view with the corresponding sort order is applied
-
the monitor is opened with an explicitly passed state
Interaction between configuration, local state, and saved view
The current configuration is not the only factor affecting a monitor’s visible display. Local states and, if applicable, saved views also influence the monitor.
In practice, the following priority order (from highest to lowest) is important:
-
A monitor state passed via URL Parameters; see Monitor Deeplink
-
An explicitly loaded view
-
An existing local state of the monitor or the grid
-
The monitor configuration
For administrators, this means:
|
Changes to sorting, filtering, or columns in the configuration are not automatically visible upon the next reload. Users may still see an older local state. |
Discard cached data
If you want to discard cached monitor data, you can reset the current view; see Reset View.
Alternatively, the browser’s local storage can be cleared or reset; see “ Resetting Local Storage.”
This removes locally stored monitor states, so that the monitor configuration is used.
