Add Widget Script Indicator

February 03, 2016 05:35

Introduction

This article explains how to add an icon to indicate if a custom script exists for the widget. The icon can also act as a shortcut button to open the Script Editor page and the Widget Editor page.

Purpose/Benefits

JavaScript scripts can be added to widgets in Sisense to extend and customize functionality. Dashboard designers may find it hard to identify at a glance which widgets have a custom script attached.

This plugin adds an icon indicating that a script is present.

Steps

The following steps will walk you through the process of adding the plugin and the indicator icon.

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.

Step 2 – Configure Settings (optional)

Open the config.js file located in the plugins folder in a text editor such as Notepad++ where you can edit the options to your liking.

The available options are:

widget_indicator_on	true, false	Display or hide the indicator icon
open_on_click_enabled	0,1,2	Specify the button’s action: 0 – no action 1 – open the script in a Script Editor window. 2 - (default) - open the widget in a Widget Editor window and the sctip in a Script Editor window

Notes

The script indicator icon will only be visible to Designer and Admin roles.

Updates:

** 23/08/2017 - Console error has been found and fixed.

** 01/07/2018 - Adjust to version 7

Comments

13 comments

Movile Service May 07, 2016 15:54

Very nice!

But nowadays the Text widget does not have an edit button, but it is possible to add script into it. So we need to discover it´s widgetId in order to chenge the script. It would be very nice if scriptIconIndicator works with Text Widgets.

0

Comment actions Permalink
Julien Laroche June 06, 2017 15:47

Hi David, I was debugging another plugin with Lidor Rosencovich and he realized that the Widget Script Indicator plugin was generating some unwanted errors in the console when buttonObj is undefined. He added a condition to check if buttonObj is defined to get rid of all the errors. So it's fixed on our version, but would you mind to fix the official plugin also? Thanks

0

Comment actions Permalink
Oxana Noa Umansky September 06, 2017 17:00 (Edited September 06, 2017 17:08)

Hi Julien,

Thanks for following up on this and sending over the fixed version!

Just wanted to make sure that anyone who reads the comments in the future knows that the current plugin version is the most up to date.

Oxana

0

Comment actions Permalink
Aviv Avidan December 18, 2017 10:27

is it possible to enable the icon also when there's no script in it? so when I click it I can edit the script right ahead without entering the widget edit page.

0

Comment actions Permalink
Michael Becker December 18, 2017 11:04

Hi Aviv,

There is a plugin which moved edit script button to the dashboard level menu. I can't find it now, but there was something like that on the community. Maybe Oxana could help on locating it? :)

0

Comment actions Permalink
Sam Ovenshine December 19, 2017 16:09

@Aviv, if you look at the plugin script (scriptIndicator.js), here are lines 29-30:

// Check if the widget has a script and that the user is not a viewer
if (args.widget.script && !args.widget.dashboard.userAuth.base.isConsumer){

You would need to remove the first condition, save the file, and restart IIS.

0

Comment actions Permalink
Aviv Avidan December 20, 2017 09:04

thanks @Sam, it worked

0

Comment actions Permalink
Lee Herman March 09, 2018 21:27

Has anyone tried this in v7? I installed it, restarted iis. No icons are visible.

-1

Comment actions Permalink
Lee Herman March 09, 2018 21:35

Ah, it only appears when there's a script. Duh.

-1

Comment actions Permalink
Jim Thomas September 25, 2018 16:58

Is it possible that this plugin is not working for v7.2? It doesn't seem to be working for me. Also I have been using the AddEditScriptToWidgetDashboardMenu plugin for several years, but it has disappeared from the Plugins list.

0

Comment actions Permalink
Jeremy Naiden January 02, 2019 16:33

Hi David,

It appears that this is hosted on your Google drive. Would you mind granting access, please?

Thanks!

0

Comment actions Permalink
Sandy Ward April 03, 2019 19:02

Hi - I downloaded for V7.2 and it does not seem to be working - no icons are visible where there are widget scripts.

thanks for any help you can give-

Sandy

0

Comment actions Permalink
Ted Whalen June 04, 2019 20:10

Does anyone know if this Plugin works with Sisense version 7.4.x? I cannot get this plugin to work on 7.4.x.

0

Comment actions Permalink

Please sign in to leave a comment.

Step 1 – Add the Plugin

Step 2 – Configure Settings (optional)

Comments

Didn't find what you were looking for?