Configuring the Jump to Dashboard Advanced Analytics plugin in a report

This article details the JumpToDashboard Advanced Analytics plugin, its purpose and its configuration.

Jump to Dashboard is an add-on that creates shortcuts from a widget in a given report to another widget in a different report, via a new browser tab or a contextual window. The plugin can be used in chart, pivot and indicator widgets. It is used to present additional information about specific data on demand by jumping across reports, without needing to present all the data in a single report (thus not hindering the performance of individual reports). For instance, in a sales performance context, a widget in Report A could display the total sales amount by employee and have the details of the sales, such as product quantities and prices, available by right clicking the name of an employee in the widget.

This is an attention message.

Only super admin users can configure the Jump to Dashboard functionality on an Advanced Analytics report widget.

Configuring Jump to Dashboard

To configure an Advanced Analytics report widget to use Jump to Dashboard, a specific syntax needs to be added to the script of the specific widget.

To edit the script of a widget, proceed as follows:

1. Open the (Undefined variable: CompoVariables_WA.Analysis), and then navigate to the Advanced Analytics report in which you want to work.

2. Make sure you are in edit mode by clicking the "Edit" tab, located in the upper right corner of the application window.

3. In the report, locate the widget with which you want to use Jump to Dashboard. Keep in mind that the plugin is only supported with charts, pivots and indicators.

4. Click the pen icon located in the upper right corner of the widget to edit the widget, as illustrated in the following figure:

The widget is opened in full screen with all editable parameters.

5. Click the icon located in the toolbar at the top of the center panel. A contextual menu is displayed, as illustrated in the following figure:

6. Click Edit Script in the contextual menu. The script editor is opened in a new tab/window.

7. Enter the following syntax in the script editor:

Copy

prism.jumpToDashboard(widget, {
    parameterName1: parameterValue1,
    parameterName2: parameterValue2,
    parameterName3: parameterValue3
});

8. Click Save in the upper right corner of the script editor.

9. Close the script editor and then return to your report.

The following table lists the available parameters that can be used when configuring Jump to Dashboard in an Advanced Analytics report widget:

Parameter	Description	Value Type	Values
drilledDashboardDisplayType	Specifies how the secondary report will be displayed	Integer	1: new tab 2: pop-up (default) 3: current tab
displayFilterPanel	Specifies whether the filter panel should be displayed in the target report window	Boolean	True (default) False
displayDashboardsPanel	Specifies whether the dashboards panel should be displayed in the target report window	Boolean	True (default) False
displayHeaderRow	Specifies whether the header row should be displayed in the target report window	Boolean	True (default) False
displayToolbarRow	Specifies whether the toolbar should be displayed in the target report window	Boolean	True (default) False
drillToDashboardRightMenuCaption	Specifies the caption for the menu displayed upon right-clicking on the widget	String	Jump to Dashboard X (default) Any value is possible
drillToDashboardNavigateType	Specifies how to navigate to the target report	Integer	1: right-click on a pivot cell/point or indicator (for pivot, indicator and chart widgets) 2: link on pivot cells (default) (for pivot widgets) 3: clink on indicator widget, rich text editor, image
drillToDashboardNavigateTypePivot
drillToDashboardNavigateTypeCharts
drillToDashboardNavigateTypeOthers
modalWindowWidth	Width, in pixels, of the popup window when the target report is displayed in a popup	Number	N/A
modalWindowHeight	Height, in pixels, of the popup window when the target report is displayed in a popup	Number	N/A
modalWindowResize	When the selected display type is popup, this parameter allows users to resize the popup.	Boolean	True False (default)
excludeFilterDims	Specifies dimensions to be excluded from the target report filters	Array	“[table.dimension]”
includeFilterDims	Specifies dimensions to be included in the target report filters	Array	“[table.dimension]”
showJTDIcon	Specifies whether an icon should be displayed in widgets in which Jump to Dashboard is included	Boolean	True (default) False
dashboardId	ID of the target report. When this parameter is set to null, a target report menu will be available in the widget editor.	String	Null (default) Target report ID
dashboardIds	Multiple target reports.	Object array	[]{id:””, caption:””}
dashboardCaption	Caption of the target report.	String	N/A

Case Study - Jumping from One Report to Another

In the following example, we will configure Jump to Dashboard with one source report and one target report, for a sales reporting purposes.

To perform this configuration, proceed as follows:

1. First, create a report that displays the global sales of a company; with a pivot widget. Your final report should look similar to the following figure:

1. Create a second report, which displays the sale details by employee, with information such as product name, quantity, unit price, total amount and date/period of sale.

2. Open the script editor for the widget of the report created in step 1. Refer to steps 4-6 in the section Configuring Jump to Dashboard above.

3. In the script editor, paste the following script (by changing the relevant information, such as the dashboard ID):

Copy

prism.jumpToDashboard(widget, {
    dashboardId: "61d2d34937ca3d0035ded533",
    drillToDashboardRightMenuCaption : "See sales details",
    drillToDashboardNavigateTypePivot : 1,
    displayFilterPane: false,
    displayDashboardsPane: false,
    displayToolbarRow: false,
    displayHeaderRow: false
});

Refer to the parameter table above for details related to the parameters and their meaning.

This is a tip message.

You can retrieve the dashboard ID of the target dashboard by opening the property panel of the report in the Analysis component, under the Dashboard ID field. For more information, refer to Viewing the Properties of an Advanced Analytics Report.

The two reports are now linked, as illustrated in the following figures:

This is a tip message.

To link the source widget to several target reports, the same procedure can be used, except that the parameter dashboardIds needs to be used instead of dashboardId, as illustrated in the following script example:

Copy

prism.jumpToDashboard(widget, {
    dashboardIds: [{"61d2d34937ca3d0035ded533",caption:"See sales details"},{"61d3205937ca3d0035ded598",caption:"Sales amount by product"}
    drillToDashboardRightMenuCaption :"Go to",
    drillToDashboardNavigateTypePivot : 1,
    displayFilterPane: false,
    displayDashboardsPane: false,
    displayToolbarRow: false,
    displayHeaderRow: false
});

When using this script, the menu displayed upon right-clicking the widget would then have two options, as illustrated in the following figure: