Overview
Version
Report Server Version | Functional Change |
11.0 | / |
11.0.2 | Built-in Template Limit enhancement function |
11.0.5 | If Data Export Volume Limit Per Chart is triggered, the record is logged in the INFO-level system log. |
Application Scenarios
You (as the admin) may need/want to:
Set limitation for templates with overly complex internal calculation logic which may cause system crashes.
Get a recommended value because you are unsure of the appropriate values set in Template Limit after enabling this function.
Know which templates triggered the limitations after enabling Template Limit.
Know how to optimize templates (with limitations) unavailable to business personnel, so that these personnel can view them.
Functions
Log in to the decision-making platform as the admin, and choose System Management > Intelligent O&M > Load Management > Template Limit.
1. You can set Max Number of Rows Per Dataset, Max Number of Cells Per Template, Max SQL Execution Period (s), Max Number of Cells in Imported Excel, and Record Submission Limit (allowing you to determine whether to allow the generation of Cartesian product). If the set limit is reached, the system rejects the request and pops up a prompt.
2. You can set limitations for all templates and relax the limitations for some templates or optimize some.
3. Recommended limit values are provided in Template Limit.
4.You can know which templates are suspended from calculation due to template limitations.
Notes
1. Template Limit is unavailable if you purchase the Intelligent O&M function point without registration.
2. In FineReport V11.0.2 and later versions, the Template Limit Enhancement plugin is converted to a built-in function, replacing the original Template Limit function.
In FineReport versions before V11.0.2, you need to install the Template Limit Enhancement plugin to use the Template Limit function introduced in this document.
To get the plugin, contact technical support.
For details about how to install plugins in the designer, see Designer Plugin Management.
For details about how to install plugins on the server, see Server Plugin Management.
Limit Function Description
Limit Function | Explanation | Notes | |
Max Number of Rows Per Dataset | Limit the number of rows in a dataset within the template. For example, set the value to 30000, indicating that the system displays an error message if the number of rows in a single dataset reaches 30000. You can customize the prompt content. The default error message is displayed as shown in the following figure.
| 1. Wherever any dataset in the template reaches the set limit, the alert configuration is triggered. 2. Max Number of Rows Per Dataset cannot be set to values less than 300. | |
Max Number of Cells Per Template | Limit the number of cells in a template. For example, set the value to 300000, indicating that the system displays an error message if the number of cells in a single template reaches 300000. You can customize the prompt content. The default error message is displayed as shown in the following figure.
| Max Number of Cells Per Template cannot be set to values less than 5000. | |
Max SQL Execution Period (s) | Limit the SQL execution period in a template. For example, set the value to 60, indicating that the system displays an error message if the SQL execution period in a single template exceeds 60 seconds. You can customize the prompt content. The default error message is displayed as shown in the following figure.
| Max SQL Execution Period (s) needs to be set to a positive integer. | |
Max Number of Cells in Imported Excel | Limit the number of cells in the imported Excel file. For example, set the value to 300000, indicating that the system displays an error message if the number of cells in the imported Excel file exceeds 300000. The prompt is displayed in a pop-up window on the right side, preventing the current report content from losing. You can customize the prompt content. The default error message is displayed as shown in the following figure. Sorry, the number of cells in the imported Excel exceeds the limit. To solve it, import lower amounts of data. If you are an administrator, you can change this limit under Intelligent O&M > Load Management > Template Limit.
| 1. Max Number of Cells in Imported Excel cannot be set to values less than 5000. 2. The limit also takes effect for batch imports of Excel files and submission. The limit value for batch imports is the same as that for single import. | |
Record Submission Limit | Disallow Cartesian product filling | Record Submission Limit is disabled by default, in which case the Cartesian product filling is disallowed. The system displays an error message if the Cartesian product is entered. The prompt is displayed in a pop-up window on the right side, preventing the current report content from losing. You can customize the prompt content. The default error message is displayed as shown in the following figure. To prevent Cartesian product filling from causing data submission failure, check the parent-child cell setting of templates. If you are an administrator, you can enable Allow Cartesian Product under Intelligent O&M > Load Management > Template Limit. | / |
Allow Cartesian product filling | To prevent a large number of submission records caused by Cartesian product filling from posing a risk of system crash, you need to enable Record Submission Limit before enabling Allow Cartesian Product. Allow Cartesian Product is enabled by default after Record Submission Limit is enabled. Allow Cartesian Product can limit the number of submission records. For example, set the value to 30000, indicating that the system displays an error message if the number of submission records from the Cartesian product filling exceeds 30000. The prompt is displayed in a pop-up window on the right side, preventing the current report content from losing. You can customize the prompt content. The default error message is displayed as shown in the following figure. Sorry, the number of filled record rows exceeds the limit. To solve it, fill lower amounts of data. If you are an administrator, you can change this limit under Intelligent O&M > Load Management > Template Limit.
| After Allow Cartesian Product is enabled, Max Number of Records Submitted During Filling cannot be set to values less than 300. | |
Data Export Volume Limit Per Chart | This function (enabled by default) allows you to customize the maximum number of data records exported per chart. Max Number of Data Records Exported Per Chart cannot be set to values more than 20000. 1. If Data Export Volume Limit Per Chart is disabled, the chart is exported with the actual number of data records. 2. If Data Export Volume Limit Per Chart is enabled and the chart data records do not exceed the set limit, the chart is exported with the actual number of data records. 2. If Data Export Volume Limit Per Chart is enabled and the chart data records exceed the set limit, the chart is exported with the set number of data records. If you customize the maximum number of data records or disable Data Export Volume Limit Per Chart and an exception occurs during export, an image is exported with the message indicating that too large data export volume causes failed export of the chart, and you need to export lower amounts of data. | 1. The number of data records refers to the number of graphical elements created on the frontend, rather than the number of datasets. For example, if a column chart has three categories and each category has two series, six data records are exported. 2. Data Export Volume Limit Per Chart can be set only in General Limit. | |
Setting General Limit
General Limit takes effect for all templates in the current report system. Admins can set limits for templates. If the set limit is reached, the system rejects the request and pops up a prompt.
You can set Dataset Row Limit, Template Cell Limit, SQL Execution Period Limit, Excel Import Limit, Record Submission Limit, and Data Export Volume Limit Per Chart, in which only Record Submission Limit is disabled by default.
Manually Setting Limit
On the General Limit tab page, you (as the admin) can set limit value in any limit function and customize Limit Exceeded Prompt. Click Save.
Viewing Recommended Settings
On the General Limit tab page, click Viewing Recommended Settings, and you can view the recommended settings in the template limit.
If you hope the recommended settings are used in the template limit, click One-click Configuration. The recommended values are entered automatically in the General Limit settings. Click Save.
Limit Relaxation
Limit Relaxation only takes effect for the selected templates. If only a few templates require displaying a large amount of data, you can set limits for these templates separately. Other templates still use the general limit with smaller values.
Admins can set limits for templates. If the set limit is reached, the system rejects the request and pops up a prompt.
Setting Limit Relaxation
You can set Dataset Row Limit, Template Cell Limit, SQL Execution Period Limit, Excel Import Limit, and Record Submission Limit. All are enabled by default.
On the Limit Relaxation tab page, you can set limits for the selected templates. No template is selected by default. Click Save.
Canceling Limit Relaxation
1. List of templates added in the limit relaxation is shown in the following figure.
2. You can click Use General Limit in the template list and click Save to cancel the general limit.
Click the refresh icon, and the above selected row disappears.
Limit Triggering Record
If a report triggers the template limit, it is recorded in Limit Triggering Record.
Viewing Reasons for Templates Limited
You can click Template Name to view reasons for triggering the limit.
For example, click Employment Data, and you can view that the template is limited because it exceeds the maximum rows set in Dataset Row Limit.
Placing Limited Templates to Limit Relaxation
1. Click Relax Limit, and the button name is changed into Adjust Limit Relaxation Value. Click Save. Then the selected template is added in Limit Relaxation.
2. The Employment Data template is added in the Limit Relaxation tab page.
