Custom Filters

[intapiuser]

Download: Custom Filter

Introduction

This article explains how to create custom filters as a plugin in Sisense.

Purpose/Benefits

Sisense comes with a set of native/robust filter options, but these are always displayed on the right side of the dashboard.  If you wanted to create your own set of custom filters, this plugin shows an example for how this could look. 

Steps

The following steps will walk through the process of adding the plugin and creating a custom filter.

STEP 1 - ADD THE PLUGIN

Download the attachment and unzip the contents into your C:\Program Files\Sisense\PrismWeb\plugins\ folder. If you are using version 7.2 and higher unzip the contents into your C:\Program Files\Sisense\app\plugins\ folder. If the plugins folder doesn't exist, just create it. After those files have been unzipped there, you may also have to restart the web server. Now when you create a new widget, FILTER should show up in the list of options

STEP 2 - CREATE THE FILTER

On your dashboard, click the Create Widget button and select Advanced Configuration. Next, select Filter from the chart types menu.  Pick a dimension you want to filter against, and you should see a filter menu displayed.

 By default, the items that show up in the menu will be filtered by any dashboard filters that are set.  If you want to ignore certain filters, make sure to disable the dashboard filter from the widget editor's Filters pane (see the City filter above)

Back on the dashboard, you can use the new filter menu to make selection and the filters will be added automatically to the dashboard.  This works whether you are showing the filters pane or not, and with embedded solutions.

Notes

• This plugin supports only text-based filter dimensions
• All formatting/styling is handled through CSS, so if you want to customize it just modify the file widget.css
• The HTML generated for the menu is defined in widget-template.html

References

• Dropdown Menu Reference - The dropdown menu used in this plugin came from example 3 on this site