Auto Add Filter Based On User

Introduction

This article explains how to automatically add a dashboard filter, based on the logged in user.

Purpose/Benefits

In order to provide a better user experience, you may want to automatically set a filter on your dashboards based on the logged in user. This plugin checks the dashboard as it loads and looks for any filters that match the Elasticube. If it finds any in the config file, it uses the user's email address to find a selection value and adds the filter automatically

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.

Step 2 - Configure The Plugin

Open the config.js file to manage the auto filters. There is a config variable, which contains a list of the filters to add. Each filter should include the following properties

server - the server of the Elasticube (in case of remote Elasticube servers)
elasticube - the name of the Elasticube this filter applies to
filter - the filter that will be added to the dashboard, this object has dimension ([Table.Column]), datatype, and title as properties
queryMatch - the field that will match the logged in user's email, you need to specify the dimension and datatype
querySelection - the field to query for, the values we get back will be added to the dashboard filter
type - can be "first" or "all", determines what to do with multiple results from the query (use only the first result or multi-select all of them)

Example

Based on the Elasticube below, we want to get the logged in user's ID from the Users table and add a filter for the API Calls table

//	Define config settings
var config = {
	"maxResults": 50,
	"filters": [
		{
			"server": "localhost",
			"elasticube": "Sisense Usage",
			"filter": {			
				"dim": "[API Calls.userId]",
				"datatype": "text",
				"title": "User ID"
			},
			"queryMatch": {	
				"dim": "[users.email]",
				"datatype": "text"
			},				
			"querySelection": {
				"dim": "[users._id]",
				"datatype": "text"
			},
			"type": "first"
		}
	]
}

Notes/Reference

In order to match the logged in user with the filter, you must use the email as it's the only unique identified for users in Sisense

Release Notes

11-Sep-2018 (Ronen Avidor) - update code to correct API endpoint under 7.2 release

Keith Johnson October 04, 2017 17:59

This is something that have wanted for quite a while. I've tested it, and it seems to automatically attach itself to every dashboard using this EC. Is that correct? We only need it on some of the dashboards.

John Fisher October 10, 2017 20:06

How would I use this with two seperate cubes and two dashboards? I have been able to get it to work with one.

John Fisher October 17, 2017 18:05

We got this working with two elasticubes. You just copy the config section again in the .js file with the new settings. In order to get it to work you will need to sign-out of the dashboad and back in. Refreshing the web page will not work. We also reset IIS too.

Keith Johnson October 29, 2017 14:40

Is it possible to use this type of mechanism in a widget script instead of a plugin?

Joseph Peters December 12, 2017 21:22

Is it possible to use this for emailed dashboards? I want to be able to send users information about their specific department in a daily email and can't use data security.

John Fisher March 27, 2018 16:24

Is there a way to get the filter to default to "Include all" if there is no value provided from the table?

John Fisher March 28, 2018 10:55

Is it possible to use this to setup a dependent filter?

Robert Hauenstein September 07, 2018 19:18

This broke with 7.2. I recieve the following error:

POST http://url-here:port/jaql/query 404 (Not Found)

Does anyone have any ideas?

Ronen Avidor September 11, 2018 23:37

Hi Robert,

Just uploaded an updated version, please download and give it a try/

Ronen

Robert Hauenstein September 14, 2018 14:16

Thank you Ronen!

Eloy Meira November 02, 2018 15:25

Hi,

I was able to use this to create a custom filter but how do you create more than one? I tried different ways but could not add more filters.

This below is the one I created and it works but we need more filters.

// Define config settings
var config = {
"maxResults": 3000,
"filters": [
{
"server": "localhost",
"elasticube": "Sales360",
"filter": {
"dim": "[users.sales_org]",
"datatype": "text",
"title": "User_Email"
},
"queryMatch": {
"dim": "[users.sales_user]",
"datatype": "text"
},
"querySelection": {
"dim": "[users.sales_org]",
"datatype": "text"
},
"type": "first"
}
]

}