Overview
Version
| FineReport Version | Functional Change |
|---|---|
11.5.13 | Added the scheduled task scan function, including automatic pre-scan when a task is saved, edited, or copied, manual pre-scan on the task management page, and a panel for displaying scan details. |
Function Description
The function adds a pre-run scan for scheduled tasks, helping you identify issues in advance and trace them afterward. Before a task starts, the system verifies the configuration, environment, resources, and permissions, and flags anything that could cause the task to fail.
The function addresses the pain point where problems are discovered only after task failures. In the past, the issues behind many scheduling failures could have been detected in advance, but they only surfaced after the task actually failed, leaving teams to troubleshoot the problems and deal with large numbers of support tickets. Running scans can detect these problems before the task runs.
The scan covers the following six common failure types.
| Failure Type | Typical Symptom |
|---|---|
| Required fonts are missing on the server. | Garbled characters appear in exported reports. |
The FVS scheduling environment is not fully configured. | Chromium fails to start. |
JavaScript (JS) events are used in templates. | JS events do not take effect in scheduled tasks, so the result may differ from the previewed one. |
The data source password has expired. | The connection fails only when the task runs. |
The system user bound to the scheduled task is no longer active. | Permission and execution exceptions occur. |
The recipient email address is incorrect. | All reports fail to be delivered. |
Scan Triggering
The scan flags potential risks but does not prevent tasks from running. It can be triggered automatically or manually.
Note:1. After you upgrade to FineReport V11.5.13, the scan status of all existing scheduled tasks defaults to Not Scanned. You need to create a new task, copy a task, or trigger a scan manually to update the scan status.
2. Only one task is scanned at a time; the others wait in a queue of up to 30 tasks. When a task is queued, the system indicates that it is waiting to be scanned.
Automatic Scan (Triggered on Save/Edit/Copy)
Automatic scan helps you find problems in real time during daily configuration, with no extra operation required. The trigger behaviors are as follows:
1. When you add, edit, or copy a task and save it under System Management > Task Schedule > Task Management, a scan is triggered automatically.
2. The scan does not interrupt your operation, and the result is updated in Scan Status.
Manual Scan (Triggered in Task Management)
You can perform a manual scan when a thorough scan is required. A manual scan checks every scan item in sequence and typically completes within one minute. The steps are as follows:
1. Choose System Management > Task Schedule > Task Management.
2. In the row of the target task, click the xxx icon on the right. Scan Status changes to Scanning, and the scan starts.
3. After the scan completes, Scan Status of the task updates automatically with the latest result.
Scan Status and Result
Scan Status Description
Scan Status shows the current status of each task. The meaning and recommended action for each status are as follows:
| Scan Status | Description | Recommended Action |
|---|---|---|
Abnormal | At least one ERROR-level item failed to pass the scan. These issues will cause the task to fail when it runs. | Fix the issues before running the task. |
Warning | The task is free of ERROR-level issues, but WARNING-level issues are found, such as missing fonts. The task can still run, but the result may be affected. | Review the warnings before running the task. |
Passed | All items passed the scan. This status is set when the most recent manual scan succeeds, and remains valid for 48 hours. | No action is required. The status automatically reverts to Not Scanned after 48 hours. |
Scanning | A manual or automatic scan is in progress. | Wait for the scan to complete. |
Not Scanned | The task has not been scanned yet, or has been reverted to this status. | Manually trigger the scan. |
Failed | The scan itself failed to run. See the scan result for the failure reason. | Review the error details and try again. |
Note:
Scan Result Detail
Click the status of any task in Scan Status to open the scan result panel and view the scan details. The panel shows:
1. The start time and duration
2. The number of errors and warnings
3. A list of scan items, each including an icon indicating the level, the location, a description, and a suggested fix.
At the bottom of the panel:
Click Rescan to run another manual scan for the task.
Click Resolve to open the task editing page and resolve the issues.
