All Categories
Sisense
Jump to Dashboard Setup Guide for QBeeQ Plugins

Jump to Dashboard Setup Guide for QBeeQ Plugins

This guide walks you through the required setup and configuration steps to enable the Sisense Jump to Dashboard (JTD) plugin for use with QBeeQ-compatible plugins. Jump to Dashboard is a certified add-on that is included with every Sisense installation, it is disabled by default and requires additional configuration to work correctly with some QBeeQ widgets.

ℹī¸

Some QBeeQ plugins can be configured directly from the Sisense design panel, while others require manual updates to plugin files within Sisense File Management.

This guide is intended for Sisense Admins with access to File Management and plugin configuration files. Familiarity with Sisense plugins and basic JavaScript configuration is recommended.

Installing Jump to Dashboard

Jump To Dashboard (JTD) is a Sisense certified add-on, meaning that it comes installed together with Sisense and you do not need to perform any separate download or installation. However, it is disabled by default, and you must enable it (see below) in order to use it.

💡

You will need access to multiple different sub-folders within the plugin folder in File Management. It is recommended to have multiple windows open to make it easier to reference and make changes.

Enable the Jump to Dashboard plugin

  1. Navigate to Admin > Server & Hardware > Add-ons
  1. If the plugin is disabled, enable it
 
Notion image

Check the Jump to Dashboard version

  1. Navigate to Admin > App Configuration > File Management > plugins > jumpToDashboard
  1. Open the plugin.json file and find the pluginInfraVersion property and its value
Notion image
 

If your system is running version 1, jump to these instructions. For version 2, jump to these instructions.

Configure for "pluginInfraVersion": 1

  1. Navigate to plugins > QBeeQFramework
  1. Open the config.j file
  1. Locate the "isNewJTD" property
  1. Set the value to false
  1. Save the file
Notion image

Add the configuration to the widget script

  1. Open the widget in the widget editor
  1. Edit the widget script
  1. Add the drilled dashboard configuration to the widget script 
      2. prism.jumpToDashboard(widget, { "drilledDashboardDisplayType": 2 });
ℹī¸

To make additional customizations via the widget script, please see Configuring Jump to Dashboard per widget and the Details tab of the Jump to Dashboard Marketplace listing.

Add plugin to widgetTypes.js

  1. Navigate to plugins > jumpToDashboard > js > constants
  1. Open the widgetTypes.js file
  1. Locate the allowedTypes array
  1. Add "QBeeQAdvancedIndicator" and/or "QBeeQGeojsonMap" to the array, depending on the plugin you are configuring for (KPI Card or Super Map)
  1. Save the file
      2. Notion image

Add plugin to DrillToDashboardNavigateTypeRightClick.js

  1. Navigate to js > drillToDashboardNavigateType
  1. Open the file DrillToDashboardNavigateTypeRightClick.js
  1. Locate the this.allowedTypes array
  1. Add "QBeeQAdvancedIndicator" and/or "QBeeQGeojsonMap" to the array, depending on the plugin you are configuring for (KPI Card or Super Map)
  1. Save the file
Notion image

Configure for "pluginInfraVersion": 2

  1. Navigate to plugins > QBeeQFramework
  1. Locate and open the config.j file
  1. Locate the "isNewJTD" property
  1. Set the value to true
  1. Save the file
Notion image

Add plugin to widgetTypes.js

  1. Navigate to plugins > jumpToDashboard > js > constants
  1. Locate and open the widgetTypes.js file
  1. Locate the allowedTypes array
  1. Add "QBeeQAdvancedIndicator" or "QBeeQGeojsonMap" , or both to the array, depending on the plugin you are configuring for (KPI Card or Super Map)
  1. Save the file
Notion image

Add plugin to DrillToDashboardNavigateTypeRightClick.js

  1. Navigate to plugins > jumpToDashboard > js > drillToDashboardNavigateType
  1. Locate and open the DrillToDashboardNavigateTypeRightClick.js file
  1. Locate the this.allowedTypes array
  1. Add "QBeeQAdvancedIndicator" or "QBeeQGeojsonMap" , or both to the array, depending on the plugin you are configuring for (KPI Card or Super Map)
  1. Save the file
Notion image

Update the Jump to Dashboard plugin version

💡

Changing the version to a higher number than the current version ensures that the version does not revert to the default settings or configuration during a Sisense version upgrade.

  1. Navigate to the the /plugin/jumpToDashboard/ folder
  1. Open the file plugin.json file
  1. Change the version to a higher major version from the current version
Notion image

Configure global and widget JTD settings

See the official Sisense Jump to Dashboard documentation for Configuring Global JTD Settings and Configuring JTD Per Widget

Limitations

Please refer to the official Sisense documentation for details on Jump to Dashboard limitations.

 
Did this answer your question?
😞
😐
🤩

Last updated on April 23, 2025

Widget Tabber - Set Default Tab Super Map Custom Layers