Download: Parameters Widget
Introduction
This article explains how to add user input boxes for use as parameters in Widget Formulas.
Purpose/Benefits
This plugin is an extension of an earlier plugin, but adds the ability to have multiple parameters in the same area.
It also provides an option for setting default values for each parameter.
Steps
The following steps will walk through the process of adding the new chart type and creating a sample.
STEP 1 - ADD THE PLUGIN
For Versions 7.1 and below - download the attachment and unzip the contents into your C:\Program Files\Sisense\PrismWeb\plugins\ folder.
For 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 plugins service.
Now, when you create a new widget the parameters widget should show up in the list of widget types.
STEP 2 - ADD THE DEFAULT VALUES INTO THE ELASTICUBE
Edit the included Excel file to have the number of parameters you'll need, as well as the default values for each parameter.
In the screenshot below, we are adding in support for up to 5 numeric input parameters.
Once this structure is defined, add it to your Elasticube and perform a build. You should not connect this to any other table, it should be a stand alone.
This doesn't have to be driven from the included Excel sheet, but you should make sure this table is named Parameters in the Elasticube.
STEP 3 - CREATE THE WIDGET
On your dashboard, click the Create Widget button and select Advanced Configuration.
Next, select Parameters from the chart types menu.
Under items, add in 1 or more fields from the Elasticube's Parameters table.
You can override the field names, either in the Elasticube or just the labels in the dashboard.
Each input box will default to the values from your Excel sheet, but users in the dashboard will have the option to override the values.
You can also adjust whether the dashboard updates with these new values immediately after entering them, or if you want the end user to set all the parameters first and then click an UPDATE button.
When finished, click the APPLY button to save this widget to the dashboard.
STEP 4 - REFERENCE THE PARAMETERS IN FORMULAS
At this point, users can update the inputs but you need to reference these parameters within Widget formulas in order to take effect.
Create/edit a widget's formula and add in a reference to a field from the Elasticube's Parameters table.
The formula editor will default to a SUM of this field, but rename it to @fieldname.value .
For example if your parameter field is named P2 in the Elasticube, then it should be renamed to @P2.value.
In the widget editor the formula will use the default values, but once in the dashboard it should take on the user-input values instead.
Note: the parameter name p1 is case sensitive. So make sure to perform the rename to exactly p1 and not P1
Notes
- This plugin does not save user inputs, each dashboard load will start with the default values.
- If you want to name your Parameters table something different, then you will need to update the included config.js file settings.table property to match.
- This example used an Excel sheet to manage the default parameter values, but these can be persisted anywhere (database, google sheet, etc).
Hello, I'm trying to use this plugin on Version: L2023.2.0.152, and I'm having some difficulties. I have the plugin installed, the spreadsheet/table loaded, and a widget created. The issue I'm experiencing is there are no input boxes displaying in the widget after adding the fields from the parameters table, only the Reset and Cancel buttons. Any assistance is greatly appreciated,.
