Personal bookmarks

  • Article

In reports you embed for your organization, report consumers can create personal bookmarks. Personal bookmarks are created by capturing report page states, including filters, slicers, and visual states, and giving them friendly names. Users can then quickly return to these states by selecting the bookmarks. Personal bookmarks are available only to their creators, and creating them doesn't require write permissions for the report.

Note

This feature is disabled by default and is supported only for the embed for your organization (user owns data) solution.

To enable personal bookmarks in embedded reports for your organization:

  1. Verify that your Azure Active Directory (Azure AD) app has the UserState.ReadWrite.All permission.

  2. Set the personalBookmarksEnabled property in the loadConfiguration settings, to true:

        let config = {
        type: 'report',
        ...
        settings: {
            personalBookmarksEnabled: true
        }
    };

  3. Make the bookmark pane visible in the report.

Using personal bookmarks

In order to create, apply, delete, update or rename a personal bookmark, the bookmark pane should be visible. When enabled and the user has the right permissions, the personal bookmarks tab will show in the bookmark pane.

You can make the bookmark pane visible in the report in two ways. The first option is to show the report action bar, which has a Bookmarks button for users to open and close the bookmarks pane.

The second option is to show and hide the bookmarks pane programmatically by using the panes object in the report settings.

let embedConfig = {
   ...
   settings: {
      panes: {
         bookmarks: {
            visible: true
         }
      }
   }
};

To update the report settings at runtime see Update report settings at runtime.

Note

Actions for personal bookmarks aren't supported by APIs. For report bookmarks, see report bookmarks.

Next steps

Use the action bar to enhance user experience

Persistent filters

Enhance your users' experience with bookmarks