Bookmark favorites

General principles

By default, when displaying an empty container, ActiveUI displays categorized tiles for each available widget.

The tiles displayed can be modified in three ways:

  • Adding new tiles which are bookmark favorites
  • Adding new tiles, which changes the default widget bookmarks
  • Removing tiles that a user does not want to see, or should not have access to

Adding a new Bookmark Favorite Tile

The bookmark favorites feature permits users to add custom tiles in the empty container, providing quick access to the bookmarks they need the most.

From the UI

To do so, right-click on a bookmark favorite in the bookmarks tree, and select "Add to favorites".

  • Fill out the category section, by either selecting an already existing category, or typing a new category name.
  • Fill out the name you want to give to your favorite, and submit.

Programmatically:

The bookmark favorites feature is based on the Settings mechanism and the Content Server.

Therefore, a bookmark favorite defined in the:

  • default preferences/permissions will be seen by all users (if not overridden at a more granular level).
  • roles/ROLE_USER preferences/permissions will only be seen by the members of this ROLE_USER role.
  • user/USER_A preferences/permissions will only be seen by USER_A.

To create a new bookmark favorite, add a new key, starting with the mandatory prefix bookmarks.favorites.*. A suffix is needed, but there are no constraints on it, except that it must be unique, and must not contain any more dots.

Regarding the value of the setting, the mandatory attributes are:

  • A type attribute, corresponding to the plugin key of the widget (pivot-table, chart, etc)
  • Either an id or a value attribute

If an id attribute is specified, then the bookmark favorite will reference the existing bookmark having this id.

Here is an example of a bookmark favorite referencing a bookmark id:

{
  "map": {
    "bookmarks.favorites.pivot-table-18f": {
      "category": "data",
      "id": "18f",
      "name": "PnL per Desk",
      "type": "pivot-table"
    }
  }
}

If the value attribute is specified, then the bookmark favorite is defined as a new bookmark (though it will not appear in the bookmarks tree):

{
  "bookmarks.favorites.pivot-table-by-value": {
    "category": "data",
    "name": "PivotTable v2",
    "type": "pivot-table",
    "value": {
      "style": {},
      "showTitleBar": false,
      "containerKey": "pivot-table",
      "body": {
        "serverUrl": "",
        "mdx": "SELECT ...",
        "contextValues": {},
        "updateMode": "once",
        "configuration": {
        "...": "..."
      }
    }
  }
}

Removing Tiles

From the UI, users can remove tiles they do not want to see, by right-clicking on them and selecting Hide default widget, or Delete favorite if they added the tile as a favorite themselves. Default widgets can be un-hidden by using the dock action Show all default widgets. However, deleting a user favorite is not a recoverable operation.

It is also possible to hide tiles that are regular widgets, like the drillthrough or the pivot table, by proceeding the same way. In this case, a new setting key is written in the Content Server, with the following template: "bookmarks.favorites.container-key.hidden": true A Content Server admin can delete this key, and the widget will appear again in the user's dock.

Suppose that a bookmark favorite with key bookmarks.favorites.pivot-table-example was created in the default/preferences file (so everyone can see it), but you want to hide it from USER_A. Then add the following setting "bookmarks.favorites.pivot-table-example.hidden": true in the USER_A/preferences file.

← AuthenticationCharts →