Dashboard Views

🎉

Dashboard Views is now Dashboard Views

Dashboard Views eliminate the need to manually adjust filters every time users need to view a dashboard’s data in a new context, allowing them to quickly access and reuse previously saved filter conditions across your dashboards.

📄

Release Notes for Dashboard Views can be found here.

Installation

Dashboard Views can be installed by an Admin, following the directions in Installing QBeeQ Plugins.

Operating system and version support:

  • Linux - Latest
  • Windows - Latest
 

Configuration - config.js

Dashboard Views uses a config.js file for installation and configuration. This file controls the global behavior across your entire Sisense instance.

To locate this file:

  1. Go to the Admin tab > App Configurations > File Management
  1. Continue to the plugins folder > QBeeQViews folder > select the config.js file

You can edit the file's code directly in the user interface.

var settings = { 
menu: ["filter", "dashboard"],
sharingOptions: ["private", "shared", "public"], 
allowedUserGroupsForPublicBookmarkCreation: [],
allowedUserGroupsForDashboardGroupsManagement:[],
sharedViewsUserGroupsFilter: ["*"], 
sharedViewsUserGroupsExcluded: ["Admins"], 
defaultDashboardConfiguration: true, 
enableGrouping: true,
OnlyUseExistingFilters: true,  
enableAutoGrouping: true,
filterIconAlignment: "left",
ConsiderPerspectivesAsRootModel: true,
serverUrl : "https://dev.qbeeq.pl",
ExportImportBookmarkAndBookmarkGroup: true,
defaultViews: true ,
useEncrypted: true, 
passPhrase: '67566B59703373367638792F423F46D5A7134743777',
button_background_color: "#ffcb05", 
button_text_color: "#3a4356", 
font_family: "Open Sans", 
popup_text_color: "#505f7b", 
popup_background_color : "white",
button_hover_color : "yellow"
includePrimaryFilters: true,
} 

}

var widgetControllerSettings = {
    includeWidgetControllerSelections: true,
    includeWidgetControllerDefault: true, 
    widgetControllerDescription: "Include all user-defined filters and selections in the saved" ,//allows customization of the label in the UI dialogue
    dataCheck: true, 
}

menu

An array that determines if the Dashboard Views icon is displayed in the dashboard header, in the filter panel, or both. Dashboard Views options will also appear in the three-dot menu. The values in the array are not required to be in a particular order.

The default icon can be changed by uploading an SVG file, named bookmark_icon.svg to the QBeeQViews folder. You will be prompted to replace the existing file. The new icon image will be applied when the plugin is rebuilt, which should be done automatically.

⚠️

When changing the view icon, please use the name 'bookmark-icon.svg

Value
Behavior
dashboard
Displays as an icon in the header, and as an option in the header’s three-dot menu
filter
Displays as an icon in the filter panel, and as an option in the panel’s three-dot menu

sharingOptions

The options included in the array allow Views to be shared with specific user groups.

When included in the array, the options are visible in the UI, but the list of eligible user groups is not displayed to users. The values in the array are not required to be in a particular order.

Value
Behavior
private
Displayed as an option to the user in the UI. Views are visible to the creator.
public
Displayed as an option to the user in the UI. Views are visible to all the users that have access to the dashboard or dashboard group.
shared
Displayed as an option to the user in the UI. Views are visible to all the users that are in the same user group as the user that created the view. See Shared Views for more information about using this configuration, behavior and use cases.
ℹ️

sharedViewsUserGroupsFilter and sharedViewsUserGroupsExcluded can be used with sharingOptions to further define sharing permissions based on Sisense user groups.

allowedUserGroupsForPublicBookmarkCreation

Defines an array of Sisense user groups that can create public Views for all users. Any users who are not included in the defined user groups will be able to see and use public Views, but will not have the option to create them.

⚠️

If the value for this setting is empty andsharingOptions array includes ’public’This setting will be enabled by default for all users

allowedUserGroupsForDashboardGroupsManagement

 

sharedViewsUserGroupsFilter

ℹ️

To use this feature, `shared` must be included in the sharingOptions array

An array that specifies user groups to include access to shared Views, allowing the use of wildcards. See Shared Views for more information about using this configuration, behavior, and use cases.

⚠️

If the user is part of several candidate user groups, the system will prioritize the first relevant group in the array order and share the created Views with all members of this group.

sharedViewsUserGroupsExcluded

ℹ️

To use this feature, `shared` must be included in the sharingOptions array

An array that specifies groups to exclude from accessing shared Views, allowing the use of wildcards. See Shared Views for more information about using this configuration, behavior and use cases.

defaultDashboardConfiguration

Dashboard Views can be enabled or disabled globally for all dashboards using this configuration. Dashboard Views can be enabled or disabled for specific dashboards.

Value
Behavior
true
When set to true, Dashboard Views will be enabled by default on all dashboards in the deployment.
false
When set to false, Dashboard Views will not be enabled on dashboards in the deployment.

enableGrouping

Dashboard groups allow a Designer to manually create a group and apply the same view across multiple dashboards.

Value
Behavior
true
Dashboard Designers will see the option to create dashboard groups under Manage Views.
false
The Manage Views option is not displayed to the user.

enableAutoGrouping

As new dashboards are created using the same data model, Views will automatically be applied. Views can be disabled for specific dashboards if not needed.

ℹ️

Unlike Dashboard Groups, Autogrouping does not have a visible naming convention.

Value
Behavior
true
On creation, a view will be duplicated and applied to all dashboards that are using the same data model.
false
On creation, a view will only apply to the dashboard it was created for.

filterIconAlignment

Specifies the location of the Views icon in the filter panel.

Value
Behavior
left
Displays the icon left justified (Default), shown to the right of the Filters label
right
Displays the icon right justified, shown to the left of the + icon

ConsiderPerspectivesAsRootModel

Allows users to create Views either at the root model or using a specific perspective.

Value
Behavior
true
The view is created at the root model level (default)
false
The view is created at the perspective level

serverUrl

Sets the default value for the Server URL input field in the import popup. This should point to the environment from which Views or groups will be fetched (e.g., a development or staging server).

ExportImportBookmarkAndBookmarkGroup

Controls the access and visibility of the Import Views and Import Groups in the dashboard menu

Value
Behavior
true
The options to import are visible in the dashboard menu
false
The options to import are not visible in the dashboard menu

useEncrypted

The encryption setting for data stored in the view collections. The default value is set to `false` to ensure compatibility with legacy collections created prior to this feature. Encryption only needs to be configured once, which will encrypt existing Views, and all new Views.

💡

It is recommended to encrypt view collections to prevent unauthorized access to data via the Custom Data API

Value
Behavior
true
The view collection and its data is encrypted, stored as hashed data and can’t be decrypted without the passPhrase.
false
The view collection is not encrypted. Data is stored as clear text in the database and queryable using the Custom Data API. This is not recommended.

selectedNamingConvention

The system uses a variable called selectedNamingConvention to determine which naming convention to apply for text and language displayed in the plugin.

💡

If you are a current customer and want to maintain the terminology of Views, you can revert it back here.

To locate this file:

  1. Go to the Admin tab > App Configurations > File Management
  1. Continue to the plugins folder > QBeeQViews folder > select the Views-localization.js file
 
Value
Behavior
new
The system uses the new naming conventions in the newLanguageLocalization object, which has replaced references to Filter Views as Dashboard Views
old
The system uses the legacy naming conventions in the oldLanguageLocalization object, which maintains references to Filter Views terminology

Examples of old and new naming conventions

Notion image
Notion image

passPhrase

The passPhrase is a string value used to encrypt or decrypt view collections when useEncrypted is set to true.

Value
Behavior
true
The view collection and its data is encrypted, stored as hashed data and can’t be decrypted without the passPhrase.
false
The view collection is not encrypted. Data is stored as clear text in the database and queryable using the Custom Data API. This is not recommended.
🛑

Copy and store the passphrase key in a safe place. If the key has already been used to encrypt data, you will not be able to decrypt without it.

OnlyUseExistingFilters

Changes to the dashboard’s data model may remove columns, and thus filters that have been included in Dashboard Views.

Value
Behavior
true
Only filters that are currently present and enabled in the dashboard’s filter panel will be affected when a view is applied. Filters that have been removed, disabled, or hidden (e.g., by script) will not be modified, even if they were part of the original view, ensuring that applying a view only impacts active filters.
false
All filters saved in the view will be applied, regardless of their current visibility or status in the filter panel. This includes filters that are hidden, disabled, or no longer present in the panel. ⚠️ Applying a view can override or reintroduce filters that are not currently shown.

button_background_color

⚠️

This configuration is primarily relevant for Windows deployments. Linux deployments will use the Look and Feel/Themes. However, if for any reason the branding information is not available, then these configurations will be applied.

Value
Behavior
Valid hex code
Defines the text color of the Views button on the dashboard header

button_text_color

⚠️

This configuration is primarily relevant for Windows deployments. Linux deployments will use the Look and Feel/Themes. However, if for any reason the branding information is not available, then these configurations will be applied.

Value
Behavior
Valid hex code
Defines the text color of the Views button on the dashboard header

font_family

⚠️

This configuration is primarily relevant for Windows deployments. Linux deployments will use the Look and Feel/Themes. However, if for any reason the branding information is not available, then these configurations will be applied.

Used to change the font-family for the Views plugin1wqq.

Value
Behavior
font_family: "<font family name>",
Defines the text color of the Views button on the dashboard header

popup_text_color

⚠️

This configuration is relevant for Windows deployments only. Linux deployments will use the Look and Feel/Themes.

Value
Behavior
Valid hex code
Defines the text color displayed when the popup is visible

popup_background_color

Value
Behavior
Valid hex code
Defines the background color of the popup when the popup is visible

button_hover_color

Value
Behavior
Valid hex code
Defines the color of the buttons on hover when the popup is visible

includePrimaryFilters

A setting to include or exclude primary filters as part of the view.

ℹ️

The Primary Filters must be enabled in Admin > Feature Management > Filters > Primary Filters

Value
Behavior
true
When set to true (default), any primary filters that are selected when the view is created, will be saved as part of that view’s data and will be applied when a view is loaded.
false
When set to false, any primary filters that are applied when a view is created will not be saved as part of the view’s data, and will not be applied when a view is loaded.

includeWidgetControllerSelections

Determines whether users can choose to save their Widget Controller selections (e.g., dimensions, measures, break-bys) along with filters when creating a view.

Value
Behavior
true
A checkbox appears when creating a view, allowing users to include Widget Controller selections.
false
The checkbox is hidden, and only filter states are saved; Widget Controller selections are excluded.

includeWidgetControllerDefault

Defines the default selection state of the “Include Widget Controller selections” option.

Value
Behavior
true
The checkbox is pre-selected by default; Widget Controller selections are automatically included unless deselected.
false
The checkbox is unselected by default; users must actively choose to include Widget Controller selections.

widgetControllerDescription

Customizes the label text that appears next to the “Include Widget Controller selections” checkbox in the view creation dialog.

dataCheck

Enables or disables a data validation check before applying a saved view. When active, this ensures that widgets referenced by the Widget Controller still contain valid data, helping prevent user errors caused by schema or data model changes.

Value
Behavior
true
Dashboard Views verifies widget data integrity before applying a saved view. Invalid or missing data prevents the view from loading.
false
No validation is performed; all saved filters and selections apply immediately, even if some widgets lack data.

Enabling Dashboard Views

To enable or disabled Dashboard Views for a specific dashboard:

  1. Click the three-dot menu in the dashboard header or filter panel, determined by the menu configuration
  1. Toggle the switch for Enable Views
 
Notion image

Managing Views

Shared Views

Shared Views allow you to control view sharing by leveraging native Sisense user groups. It ensures Views are shared only with designated groups. This is particularly useful for OEMs serving multiple customers with diverse data access needs by creating Views that are shared only with designated user groups.

sharedViewsUserGroupsFilter and sharedViewsUserGroupsExcluded can be combined to target specific groups while excluding others.

 

sharedViewsUserGroupsFilter

Specifies user groups to include access to shared Views, allowing the use of wildcards. This is suggested when group naming conventions are consistent.

Example

The current user belongs to the following groups: Admins, Customer_3, and AllCustomers. The configuration for sharedViewsUserGroupsFilter is set to: ["Admins", "AllCustomers"].

When this user creates a shared view, it will be visible to all members of the Customer_3 group who have access to the dashboard. This happens because the system prioritizes the Customer_3 group as the relevant group for sharing, even though the filter specifies "Admins" and "AllCustomers." The user's membership in Customer_3 ensures the view is shared appropriately.

 

sharedViewsUserGroupsExcluded

Specifies user groups to exclude and prevent sharing Views with irrelevant groups, allowing the use of wildcards. This is suggested when naming conventions are inconsistent or non-existent

Example

The current user belongs to the following groups: Admins, Customer_3, and AllCustomers. The configuration for sharedViewsUserGroupsFilter is set to: ["Customer_*"].

When this user creates a shared view, it will be visible to all members of the Customer_3 group who have access to the dashboard. This is because the filter pattern ["Customer_*"] matches all user groups starting with "Customer_", and Customer_3 is the group that fits this pattern for the current user.

Importing views and groups

Users can import Views and view groups from a separate Sisense environment—such as development, staging, or production—directly through the dashboard. This simplifies dashboard promotion workflows by eliminating the need for manual scripts or post-import updates.

ℹ️

This version only imports Views and groups relevant to the current dashboard context.

When enabled in the config.js, this feature adds two new options to the view menu in the dashboard UI:

  • Import Views
  • Import Views Group
Notion image

Each option opens a pop-up with three fields:

  • Server URL – pre-filled with a default value from the configuration (serverUrl)
  • Username
  • Password
Notion image

After providing valid credentials and clicking Submit, the application:

  • Fetches the relevant Views or view groups for the current dashboard from the specified server
  • Imports them into the current environment
  • Assigns ownership of the imported items to the user performing the import

Dashboard groups

ℹ️

When enabled, Dashboard groups are only available to Designers

Create a dashboard group

To create a dashboard group:

  1. Click the three-dot menu in the dashboard header or filter panel
  1. Select Views > Manage Views
  1. Create a unique group name
 

Add a dashboard to a group

⚠️

Dashboard group names are unique and case sensitive, and groups are not displayed on creation. To avoid inadvertently creating a new group, refer to a dashboard that you know is part of the group using Views > Manage Views

To add a specific dashboard to an existing group:

  1. Click the three-dot menu in the dashboard header or filter panel
  1. Select Views > Manage Views
  1. Type the name of the dashboard group
  1. Click Add
 

Remove a dashboard from a group

  1. Click the three-dot menu in the dashboard header or filter panel
  1. Select Views
  1. Toggle the switch for Enable Views
 

Delete a dashboard group

⚠️

When a dashboard group is deleted, the association between the dashboard and the group will be removed, but the view will be retained, and can be added to additional group in the future.

  1. Click the three-dot menu in the dashboard header or filter panel
  1. Select Views > Manage Views
  1. Click the trash can next to the group name

Autogroups

When Autogrouping is enabled in the configuration file, it automatically applies Views across all dashboards using the same data model.

If you manage multiple dashboards with the same data model, Autogrouping removes the manual effort of creating distinct dashboard groups, ensuring a seamless and efficient workflow.

 

Autogrouping and Filter Behavior Across Dashboards

If you have multiple dashboards using the same data model, Autogrouping helps by automatically organizing them—eliminating the need to manually create separate dashboard groups.

Multi-data source example

Consider a scenario where a dashboard has three different data sources:

  1. Northwind
  1. Northwind, E-commerce
  1. Northwind, E-commerce, Sales

With Autogrouping enabled, Views created for each dashboard will be visible and shared across all dashboards. This means:

  • Applying filters on Dashboard 3 will affect Dashboards 1 and 2, since they share some data sources.
  • Applying a filter on Dashboard 1 (which has only one source) will still impact Dashboards 2 and 3 because they contain the same data source (Northwind).
 

Controlling Filter Behavior

To limit filters to only those that match the existing data sources on each dashboard, use the OnlyUseExistingFilters option. This ensures that dashboards apply only relevant filters and avoid unwanted data inclusion.

Encrypting and decrypting View collection

ℹ️

Script files have been provided for you, and can be found in File Manager > Plugins > QBeeQViews asdashboard_encryption_script.txt and dashboard_decryption_script.txt

To encrypt view collections:

  1. Set useEncrypted to true in the config.js file
  1. Create a new dashboard
  1. Navigate to the three-dot menu > Edit Script
  1. Paste the script code from dashboard_encryption_script.txt file
  1. Update the passphrase to match the value in the config.js file
  1. Click Save and refresh the page
  1. Delete the dashboard

When saved, this code will update the view collections from all dashboards.

To decrypt view collections:

  1. Set useEncrypted to false in the config.js file
  1. Create a new dashboard
  1. Navigate to the three-dot menu > Edit Script
  1. Paste the script code from dashboard_decryption_script.txt file
  1. Update the passphrase to match the value in the config.js file
  1. Click Save and refresh the page
  1. Delete the dashboard

When saved, this code will update the view collections from all dashboards.

Dashboard Views for embedded dashboards

If you are embedding your dashboards and hiding the header and/or the filter panel, you can still provide the Dashboard Views feature by adding a QBeeQ Views widget to your dashboard.

  • The Views button, on click, opens the Dashboard Views dialogue, on the View List tab.
  • The Create Views button, on click, opens the Dashboard Views dialogue, on the Add New View tab

By default, both the Views and Create View buttons will display. In the designer panel, you can control the display label for each button.

To add Dashboard Views to an embedded dashboard:

  1. Create a new widget on the dashboard
  1. Select QBeeQ Filter Bookmark from the dropdown list
  1. In the Design Panel, enable the buttons
  1. Replace the text (optional)
Notion image
Notion image
Setting
Behavior
Views List Button Label
The text displayed on the button. Changing the text does not change the interaction/functionality.
Create Views Button Label
The text displayed on the button. Changing the text does not change the interaction/functionality.
 

Using Dashboard Views

Accessing Dashboard Views

Depending on the configuration, accessing Dashboard Views can be accessed from the dashboard header, filter panel or their respective three-dot menus.

 
Notion image
 

Views list

To view the list of Views available to you, click the icon. Toggle between My Views and Other Views to see all Views available to you.

 
Notion image

Creating a new view

Before creating a new view, select and apply any filters to the dashboard that should be included as part of the view.

To create a new view:

  1. Click on the View icon
  1. Click on the Add New View tab
  1. Provide a unique name for the view
  1. Set the visibility
  1. Include or exclude the widget selection
ℹ️

includeWidgetControllerSelections must be set to true in the config.js and a Widget Controller widget must be present on the dashboard, or else this option will not be visible.

  1. Click Add to save your view

Filters can then be removed and/or changed to create additional Views.

Notion image

Setting a default view

⚠️

Default views must be enabled in the config.js

Users can set a view as the default view for a dashboard When the dashboard loads, the system checks whether a default view has been selected.

  • If a default view exists, the dashboard automatically loads that view first
  • If no default view is set, the dashboard opens in its standard default state

To select a default view:

  1. Open the Dashboard Views list modal
  1. Select a view
  1. Click the radio button
  1. Close the modal
  1. Refresh the dashboard
 
Notion image

Editing a view

🛑

Views are not editable after creation. If changes are required, the view must be deleted and recreated.

Deleting a view

To delete a view:

  1. Open the Views List
  1. Locate the view you want to delete
  1. Click the trash can icon next to the view

When a view is deleted, it will be immediately removed from the Other Views list for all users.

Usage Analytics

Usage Analytics is available as a CSV download for Designers or Admins. The CSV contains information about all Dashboard Views that have been created and stored on the server. This file includes metadata about individual view filters (id, type, dashboardId, createdBy, etc.), user groups, and shared user groups.

To generate a usage analytics CSV:

  1. Click the three-dot menu on the dashboard or in the filter panel
  1. Go to Views > Usage Analytics

When clicked, the file will automatically download.

Did this answer your question?
😞
😐
🤩

Last updated on August 4, 2021