Report Debugger

Version

Application Scenario

During a report preview, you need to verify the correctness of the SQL statements executed by the report or check which SQL statements have been executed by the report.

Generally, SQL statements cannot be viewed in online reports. The SQL statements can only be accessed in the logs during the runtime of the designer. However, the logs in the designer are extensive. You cannot quickly and easily locate the required SQL statements.

The Report Debugger plugin allows you to directly view the most recent SQL statements executed by the report at any time on the preview page, making it easier to identify SQL issues.

Function Description

• If  you have installed the plugin, you can view the SQL statements and input parameters on the report preview page.

• You can save the SQL statements of the previewed report.

• You can adjust the window size of Database Query in the FineReport designer.

Note: The plugin cannot be used together with the Custom Column plugin.

Plugin Installation

You can contact our technical support to obtain the plugin.

For details about how to install the plugin in the designer, see Designer Plugin Management.

For details about how to install the plugin on the server, see Server Plugin Management.

Procedure

1. If you have installed the plugin, you will see a button in the upper right of the report preview page, as shown in the following figure. If the button blocks the report data, you can move the button flexibly within the report preview page.

2. Click the button mentioned above and the most recent dataset running condition of the current session query on the current page will be displayed, as shown in the following figure.

a. Full-screen button and close button

b. Report name, which is consistent with that displayed in the browser during the report preview

c. Template relative path and absolute path, which helps find the path where the report template is located

d. Information about the dataset

• Dataset type: Two types of queries are available, namely the database query and non-database query. The SQL statements will be displayed only for database queries.

• Running state: It shows whether the dataset was executed during the generation of the report content.

• Running time: It represents the time taken to execute the dataset, measured in milliseconds (ms).

• Parameters: It represents the parameter list of the dataset. If the dataset has been executed, the execution values of the parameters will be displayed. Otherwise, the original values will be displayed.

• Content: It refers to the SQL statement(s) executed for the dataset. If the dataset has been executed, the execution content of the dataset will be displayed. Otherwise, the original content will be displayed.

e. Export and Copy buttons

• Export: The Export button allows you to export the debugging content to a text file.

• Copy: The Copy button allows you to copy the debugging content to the clipboard.

3. Authorize users.

By default, this plugin is only accessible to administrators or in the designer. To allow other users to access the plugin, you can authorize them to use the plugin accordingly.

In the decision-making system, choose System Management > Report Debugger, select users to be authorized from the drop-down list of Authorized Users, and click Save, as shown in the following figure.

4. Validate login.

Validate Login is disabled by default.

If Validate Login is enabled, the authorized users can access the plugin after login. Validate Login, together with Authorized Users, determines whether the plugin can be accessed.

In the decision-making system, choose System Management > Report Debugger, enable/disable Validate Login, and click Save.

Note: You are advised to disable Validate Login in the designer.

Supported Browser

Currently, this plugin does not support the IE browser. You are advised to use the newest browsers such as Firefox, Chrome, Edge, and Safari.

Usage Permission

By default, this plugin is only accessible to super administrators or in the designer. To allow other users to access the plugin, you can set items through Authorized Users and Validate Login.