Sticky Filters

By:
Sisense
  • Technical Details
The Sticky Filters add-on allows users to configure dashboard filters that remain active as they navigate from one dashboard to another. Whenever the Sticky Filters option is enabled, the selected filter will be saved as a sticky filter for any dashboard the user may navigate to that contains that filter. If a filter marked as sticky does not exist in a dashboard, it will remain active in the filters collection so that it can be used when the user arrives to a dashboard that has that filter. Filters will be marked as ‘sticky’ at the dashboard level.  When arriving at a dashboard where sticky filters have not been activated, filter behavior will revert to the Sisense default. Note: Every change in the sticky filter setting will require republishing of the dashboard.

Installation

  1. Download the attachment.
  2. Extract the .zip folder into the plugins folder. If the folder does not exist, create it prior to extracting the .zip file.
    For V7.1 and earlier: C:\Program Files\Sisense\PrismWeb\plugins
    For V7.2 and later: C:\Program Files\Sisense\app\plugins
  3. Configure the config.js file described below.
  4. Refresh your dashboard.

Implementation

  1. Create dashboard A and dashboard B with the same datasource.
  2. Add the same filter A to both dashboards.
  3. Configure the config.js file in the plugins folder to contain filter A.
  4. Update filter A selection on dashboard A.
  5. Open dashboard B.

The filter A selection on dashboard B should be the same as dashboard A.

Configuration

In the config.js file located inside the plugin folder, you define which filters are sticky filters in the stickyFiltersList array.

The “stickyFiltersList” array should be updated to contain all of the dimension phrase strings pertaining to each filter, for example:

mod.stickyFiltersList = [

   “[country.Country]”,

   “[Commerce.Gender]”,

   “[Commerce.Age Range]”,

   “[Brand.Brand]”,

   “[Commerce.Date (Calendar)]”,

];

Limitations

  1. The plugin does not support SisenseJS.
  2. The plugin does not take into account different ElastiCubes. All dimensions with the same name from all ElastiCubes will be set as sticky if they are configured in the config.js file.
  3. Cascading filters: Sticky filters are applied on cascading filters only if the selections are not filtered out by the parent items. If a selection cannot be applied to an item, its value is set to:
    • In the case of single selections,  the value is changed to the first option available.
    • In the case of multi-selections,  the value is set to ‘Include All’
    • If there are no members matching to the parents’ selections, the filter selection is not being changed.
This is a premium Sisense add-on. For pricing details please get in touch with your CSM: Get the Add-On