Dashboard Export

Version

Application Scenario

FineReport 11.0 includes two types of dashboards: dashboards and old dashboards. The main difference between them lies in the adaptation attribute.

Besides, dashboards and old dashboards also differ in the export method. This document mainly introduces how to export dashboards with the new adaptation attribute on PC in FineReport 11.0. For the export method for old dashboards, see Dashboard Export Plugin.

Function Description

In FineReport 11.0.1 and 11.0

You can export dashboards as Excel, PDF, Word, and PNG files.

• The export interface for the general dashboard is &export_format=xxx, where xxx represents the parameter corresponding to the export format.

• You need to add sessionID in the export suffix for dashboards with parameters to form &export_format=xxx&sessionID=***.

• You can customize the size during export by adding the parameter &width=1920&height=1080 at the end of the suffix.

• You can modify the file name during export by adding the parameter &__filename__=File name at the end of the suffix.

In FineReport 11.0.22 and Later Versions

You can export dashboards as Excel, PDF, Word, and PNG files.

• The export interface for the general dashboard is &op=export&format=xxx or &export_format=xxx, where xxx represents the parameter corresponding to the export format.

• You need to add the export suffix sessionID for the dashboard with parameters to form &op=export&format=xxx&sessionID=*** or &export_format=xxx&sessionID=***.

• You can customize the size during export by adding the parameter &width=1920&height=1080 at the end of the suffix.

• You can modify the file name during export by adding the parameter &__filename__=File name at the end of the suffix.

Export Scenario Introduction

The following table shows supported (represented by the checkmark) and unsupported (represented by the blank content) scenarios during export.

If you want to export dashboards without parameters as Excel, PDF, Word, or PNG files, you only need to add the suffix &op=export&format=xxx at the end of the URL during the preview on PC and press the Enter key for export. xxx represents the parameter corresponding to the export format, as shown in the following table.

Note:

You can also export dashboards without parameters through the export interface &format=xxx.

For example, export the dashboard as an Excel file, as shown in the following figure.

If parameters exist in a dashboard, the content of the dashboard or components in the dashboard will change with the parameters (such as parameter queries and parent-child reports). In this case, if you want to export dashboards through the URL, you need to add sessionID to export the current query results. Otherwise, the exported content will be inconsistent with the parameter query content.

Note:

When a browser requests a Web service and creates a session, the server generates a unique session identifier (namely sessionID) for each session and returns the session identifier in the form of long integer data. sessionID can be considered as the ID record of the current session.

Adding the After Initialization Event

In a dashboard with parameters, you need to add an After Initialization event for para on the parameter panel to return sessionID.

Select the parameter panel, add an After Initialization event, add a parameter aaa, set Value to Formula, enter the formula sessionID, and enter the following JavaScript code, as shown in the following figure.

Obtaining the sessionID and Exporting the Query Result

1. Save the report and click PC Preview. A dialog box displaying sessionID pops up. Copy the current session ID, and click OK, as shown in the following figure.

Note:

sessionID changes every time you refresh the page.

2. Add the suffix &op=export&format=xxx&sessionID=*** at the end of the URL. xxx represents the parameter corresponding to the format of the to-be-exported file. *** represents the currently-copied sessionID. Press the Enter key to export the current query result.

Template Download

 You can download the example template Exporting FRM Reports with Parameters.frm.

You can also export dashboards with parameters by adding a Button widget on the parameter panel (or directly adding a Button widget in the body), adding the parameter aaa to obtain the current sessionID, and adding a Click event for export.

Adding a Button Widget

Take the above example template as an example. Add a Button widget on the parameter panel and name the button Export Excel, as shown in the following figure.

Adding a Click Event

Select the button widget, add a Click event, add a parameter aaa, set Value to Formula, enter the formula sessionID, and enter the following JavaScript code, as shown in the following figure.

var REPORT_URL ='${servletURL}?viewlet=doc/frm/Exporting FRM Reports with Parameters by Clicking the Button Through JS.frm&op=form_adaptive&op=export&format=excel&sessionID=' + aaa;
window.location = encodeURI(REPORT_URL);

Effect Display

Save the report, click PC Preview, click Query, and click Export Excel. The following figure shows the effect.

Template Download

You can download the example template Exporting FRM Reports with Parameters by Clicking the Button Through JS.frm.