JumpToDashboard Plugin - How to Use and Customize
This article provides a detailed guide on how to use the JumpToDashboard plugin and describes its possible configurations. The guide covers the following topics:
- Get Started
- Customize your target (_drill) dashboard:
- JumpToDashboard config file
- Widget level customization
- Hide dashboard panels
- Change navigation type
- A pivot table navigation type
- Multiple target dashboards on a pivot
Get Started
To get started with the JumpToDashboard default plugin configuration, please follow the instructions below (Linux-based Sisense screenshots):
- Enable the JumpToDashboard plugin under the Admin tab > Server & Hardware > Add-ons.
- Create a parent dashboard (the dashboard to jump from).
- Create a target dashboard you would like to jump to with “_drill” in the prefix and be sure you use the same ElastiCube as in the parent dashboard.
- Open the edit mode of the widget in the parent dashboard that will trigger a jump to action and click the 3 dots menu. You should be able to see the 'Jump to dashboard' menu. Choose your "_drill dashboard" you created in step #3.
- Apply the changes and refresh the page.
- Now you can right click on the value in the chart and jump to the dashboard you set up! 🙂
Customize your target (_drill) dashboard
There are 2 different layers of the JumpToDashbaord plugin customization: the plugin config file and JavaScript code on a widget level. If you need to apply the global changes to the plugin’s behavior to make it work for all target (_drill) dashboards, you must do that on the config file level. If you want to have a specific behavior for a specific ‘jump to’ dashboard, please follow the ‘Widget level customization’ guide.
Please note that the widget-level customization would override any configurations defined in the config file.
JumpToDashboard config file
If you want to customize the plugin on a global level to have the same behavior for all 'jump to' dashboards, the best way to do this is to update the JumpToDashboard config file.
In order to find the file, click on the Admin tab > System Management (under Server & Hardware) > File Management > plugins > jumpToDashboard > js > config.js:
For example, if you want to change the prefix "_drill" for your target dashboards to be any different one, you need to modify the value for the drilledDashboardPrefix parameter and save the file. This will work globally for all 'jump to' dashboards.
Another example is if you want to jump from one dashboard based on ElastiCube A to another dashboard based on ElastiCube B, you need to put the sameCubeRestriction to be false.
In the same way, you can modify the navigation types for all 'jump to' dashboards at once by modifying this config file.
Widget level customization
While the default settings of the Jump to Dashboard add-on do not require any JavaScript configuration, you can change the settings per widget by editing the widget’s script on a widget level in its edit mode by clicking the 3 dots menu and choosing 'Edit Script':
The general script syntax example is provided below. All you need to do is to use the parameters that will help you control the functionality required for your use case.
prism.jumpToDashboard(widget, { parameter1:value, parameter2:value, parameter3:value});
To remove all settings defined (erasing the script will still keep the previous settings):
prism.jumpToDashboard(widget, { });
The list of parameters to be modified can be found in the ‘Technical Details’ section in the marketplace guide or in the read.me file in the plugins directory under the Admin tab > Server & Hardware > System Management -> File Management > plugins > jumpToDashboard:
Let’s review a couple of the most commonly used customizations on a widget level.
Hide dashboard panels
If you want to hide panels in your target ("_drill") dashboard, it’s possible to achieve it with the help of JavaScript code applied on a widget level.
For example, to hide the left-hand side panel, toolbar, and header, you can use the script below:
prism.jumpToDashboard(widget, { displayDashboardsPane:false, displayToolbarRow :false, displayHeaderRow :false});
Change navigation type
To open a target dashboard in the same tab, you can use drilledDashboardDisplayType:3 parameter in your script. To open it in a separate tab, use drilledDashboardDisplayType:1.
The example script will look like this:
prism.jumpToDashboard(widget, { displayDashboardsPane:false, displayToolbarRow :false, displayHeaderRow :false, drilledDashboardDisplayType:1});
A pivot table navigation types
By default, when you configure the jump to the dashboard for a pivot table, you will be able to jump from the values that will be highlighted in blue (hyperlinks). Clicking on a value, you’ll get the drill dashboard. This is drillToDashboardNavigateTypePivot:2 parameter.
To be able to jump from the rows (Days in Date and CountryName in our example), you can change the drillToDashboardNavigateTypePivot to 1 and you’ll be able to right-click on a pivot cell:
Multiple target dashboards on a pivot
The navigation type drillToDashboardNavigateTypePivot:1 for a pivot table allows you to set multiple target dashboards like on the screenshot below:
The example widget script is below:
prism.jumpToDashboard(widget, {
drillToDashboardNavigateTypePivot: 1,
dashboardIds: [{
id: "568a8d9eaca677c414000001",
caption: "Dashboard Name"
},
{
id: "123a8d9f3fd678c433000003",
caption: "Other New Name"
}
]
});
It’s also possible to jump to different dashboards from different pivot columns:
prism.jumpToDashboard(widget, {
multipleTargetDashboardsForPivot: true,
targetDashboards: [{
dashboardId: "5c0a6e7797800b7dd0c38b8c",
pivotColumnTitle: "Rev1"
},
{
dashboardId: "5c0a7fd8e13b6049c896b63c",
pivotColumnTitle: "Brand"
}
]
});
The script could be adjusted further with additional parameters to achieve your goal and provide your users with the best experience.
Enjoy the plugin and feel free to share your feedback with us! 😉
