Hide Export Options Plugin (Excel, PDF, and more)

December 28, 2017 20:34

This plugin allows an admin to hide export options from a widget's download menu. Features include the ability to select specific charts and menu options to hide and the ability to whitelist user roles so these users can continue to view and use all download options.

Installation

Simply extract this folder into your Sisense installation's ../PrismWeb/plugins directory. If you are using version 7.2 and higher unzip the contents into your C:\Program Files\Sisense\app\plugins\ folder. From there, you can manipulate the included config.js file to configure which download options you would like to hide.

Configuration

By changing the values inside the arrays in config.js, the user can change which menu options are hidden on widgets and configure which chart types and roles are affected. Additionally, the user can whitelist certain roles, or allow them to still view the export options. By default, the 'admin' is still allowed to view and use all download options. Below are three tables containing the chart, menu item, and role names and their corresponding config.js values.

Update History

7 Nov 18 - Updated for 7.2 and automatically removes download menu item when no viable download options are enabled.

Limitations

In the current version, the effects are applied to all listed chart types for all non-whitelisted users.

Comments

23 comments

Nick Bernini May 09, 2018 23:40

This plugin is not working in 7.1. Is it possible to get an updated version?

0

Comment actions Permalink
Jason Sears May 10, 2018 13:41

Hi Nick,

I investigated the plugin on version 7.1 today and didn't notice any regression.

Would it be possible to provide more information?

Also, I would make sure that you check out the config.js file inside the plugin folder to make sure the defined behavior matches up with what you're expecting.

Best,

Jason

0

Comment actions Permalink
Michele Wilborn July 09, 2018 15:25

This plugin is not working for me in version 7.1 as well. I am not sure what additional information I can provide. I have the plugin installed. I changed the config to stop all downloads for any consumer but it is not working.

0

Comment actions Permalink
Jason Sears July 09, 2018 17:14

Hi Michele,

I feel like this could be a configuration issue, the supported roles option is a whitelist, not a blacklist.

So any role you specify in that array will be allowed to download. Any other role should be disabled.

If you'd like to attach this part of your config file, I'd be glad to take a look.

0

Comment actions Permalink
Kenneth Leeman August 24, 2018 12:58

Is there a way that a specific user can be given download capabilities (Excel) for a specific dashboard or widget

even though the Rest API does not allow role of 'viewer' to download

0

Comment actions Permalink
David Wit September 20, 2018 16:17

I am having same issue in 7.1+   Here is my configuration. When I log in as a viewer, can still download.

mod.hideExportSettings = {
    supportedWidgets: ['indicator', 'chart/pie', 'chart/column', 'chart/bar', 'chart/line', 'chart/area', 'pivot', 'tablewidget', 'chart/scatter', 'treemap', 'heatmap', 'map/scatter', 'map/area', 'sunburst', 'chart/boxplot', 'chart/polar'],    // only the charts listed here will be affected
    searchTerms: ['pdf', 'excel','csv'], // these menu items will be hidden
    supportedRoles: ['super','contributor']   // these roles are whitelisted: users with these permissions
                                // can still see and use widget menu exports
};

Any help would be much appreciated

0

Comment actions Permalink
Kenneth Leeman October 11, 2018 16:51

I have the role of admin and when this plugin is enabled I do not see all the export options for a pivot table.

Excel is not available. We are on 7.2.0.12014. I have been working with Jake and ticket # 84802. We found that I was able to see all options if I disabled the plugin.

0

Comment actions Permalink
Jason Sears October 11, 2018 18:08 (Edited October 11, 2018 18:09)

Hi Kenneth,

Can you try adding 'admin' to the supportedRoles array?

Best,

Jason

0

Comment actions Permalink
Jeremy Naiden December 18, 2018 20:23

Are there any security implications to consider when using this plugin?

0

Comment actions Permalink
Jason Sears December 18, 2018 20:26 (Edited December 18, 2018 20:26)

Hi Jeremy,

I think the main thing to consider is that this is a client-side solution, so it can't be fully depended on as a security layer.

If you have secure data, it's always best to take additional measures (such as applying data security rules) to protect your data.

Best, Jason

0

Comment actions Permalink
Jeremy Naiden December 20, 2018 20:22

Thanks Jason. That's a good note. In our case it would be mostly to hide the export function if/when we find something undesirable in the data export. This would help us have better control over ex portability.

Thanks again for developing this!

0

Comment actions Permalink
Hital Patel December 21, 2018 15:22

The admin role works when added to the white list but when I try to add other roles like designer or viewer, I am unable to see the download option when logged in as designer or viewer. Any idea why the designer or viewer role is not being recognized as whitlisted?

0

Comment actions Permalink
Jason Sears December 21, 2018 15:28

Hi Hital,

Are you using 'contributor' and 'consumer' in the config file instead of 'designer' and 'viewer'? These first two are how these roles are labeled in the system. The readme.md file included in the plugin should have additional information regarding this.

Hope this helps!!

0

Comment actions Permalink
Hital Patel December 21, 2018 15:52

Thanks Jason, worked!

Anyway to perform this feature using groups?

0

Comment actions Permalink
Jason Sears December 21, 2018 16:05

Hi Hital,

I don't anticipate that would be difficult to implement, I will see if I can add it to the plugin for you.

- Jason

0

Comment actions Permalink
Hital Patel December 21, 2018 17:46

Got it to work using groups Thanks Jason

-1

Comment actions Permalink
Kateryna Pokora March 04, 2019 09:21

Hi Jason,

Could you please share the version for groups?

0

Comment actions Permalink
Tripti Jaiswal June 12, 2019 10:55

Hi Jason,

Kindly share the version for groups?

0

Comment actions Permalink
Tripti Jaiswal June 12, 2019 11:00

Also,this plugin is not working for me in version 7.4.2. as well. I am not sure what additional information I can provide. I have the plugin installed. Even the viewers and designers can see widget menu export.

Regards
Tripti - Qbeeq

0

Comment actions Permalink
Anjali Yadav August 09, 2019 14:25

Hi

It seems this is for turning OFF the download feature completely .

Any tips on how to turn OFF just the Pivot excel download feature ?

An

0

Comment actions Permalink

Elliott Herz August 09, 2019 16:43

Hi Anjali,

Here is a dashboard script example of turning off csv + excel download option for every widget on a dashboard:

dashboard.on('beforewidgetmenu', function(w, args) {
	for(var i=0; i<args.items.length; i++) {
		if(args.items[i].caption === 'Download') {
			for(var j=0; j<args.items[i].items.length; j++) {
				try { //needed because of separator objects
					if(args.items[i].items[j].command.title === 'dashboard.widget.commands.csv.title' || args.items[i].items[j].command.title === 'dashboard.widget.commands.excel.title') { //check csv/excel download
						args.items[i].items.splice(j, 1);
					}	
				}
				catch {
					//do nothing	
				}
			}
		}
	}
});

You can add an if statement into the code to limit for just pivot tables from here.

Hope this helps!

Best, Elliott

Anjali Yadav August 09, 2019 16:53

Thank you, Elliott.

Awesome script work as-always!

1

Comment actions Permalink
Elliott Herz August 09, 2019 16:56

I'm glad I could help out! =D

0

Comment actions Permalink

Please sign in to leave a comment.

Comments

Didn't find what you were looking for?