I. Overview
Task Schedule can be set if a report needs to be generated and published regularly. Once set, the server will complete the task at a specified time, generate the required files, and even distribute the results through email, SMS, platform messages to inform users, allowing them to make timely analysis and decisions.
| You will learn |
|---|
|
II. Introduction
1. Login the Decision-making System and go to settings
1) Click Manage -> Task Schedule to go to the configuration interface.
2) You can set timers via decision-making system, or visit this configuration page directly by http://localhost:8075/webroot/decision/timer .
2. Task Management
Scheduled tasks can be created, modified and deleted in the Task Management interface. Please refer to Task Schedule Setting Steps for detailed instructions on task scheduling.
The newly created tasks will be displayed in Task Schedule panel, where you can edit, copy, view and delete a task, or set it to run only once.
Note: "- -" will be displayed under Use Template column for tasks with Object Type set to "No Dispatcher Object".
3. Run Monitoring
Similar to the log feature, Run Monitoring is used to briefly record information about task running.
1) By default, Run Monitoring feature will only show the runtime data of tasks for the day. You can type into the search box to filter historical information. Clicking the search button without typing in anything will bring all the Task Schedule data for all dates to display.
2) The Run Monitoring tab contains all the tasks in progress with jar versions released on and after 8th Jul, 2020. Running tasks will be displayed under "Task in Progress" in the Run Monitoring tab.
Note: the "Task in Progress" list contains all running tasks, regardless of their dates of execution, by default.
4. View Attachments
Once the scheduled task is executed, attachments generated by the task will be saved under %FR_HOME%\webapps\webroot\WEB-INF\schedule by default.
5. Global Setting
1) You can set reminders for run failures sent via SMS, platform notifications and emails, with task name and time of failure included in the message. Click the Global Setting button on the top left of Task Schedule interface to set Run Failure Reminder. There are 3 types of messages, which are SMS Reminder, Platform Message and Email Reminder. Task name and time of failure will be included in the message. For more information on how to configure mailbox services, please refer to Mailbox Management.
Note:
If Task Restart is enabled for a scheduled task, then no message will be sent when it is successfully restarted. Only tasks failed to restart will trigger notifications.
2) Notifications will be sent if the scheduled task failed to execute. For instance:
System Message:
Email:
III. Execution
The execution flow of a scheduled task is as follows:
First, task conditions are checked upon the start of the task. If it returns True then a snapshot will be generated; otherwise, proceed to check if Task Restart has been enabled.
With Task Restart enabled, the system goes back to the beginning and re-check the conditions again after an interval of time.
With Task Restart disabled, the task is ended.
If a snapshot is successfully generated, then proceed to send the attachment; otherwise, proceed to check if Task Restart has been enabled.
With Task Restart enabled, the system goes back to the beginning and re-check the conditions again after an interval of time.
With Task Restart disabled, the task is ended.
The task will be ended whether the attachment is sent or not.
IV. Use Formulas
Most formulas available in the report are supported here.
The scope and description of formulas are shown in the following table:
| FineReport Template Type | Where to Use the Formula | Remarks |
|---|---|---|
General report | Dispatcher Object - Set Parameter Dispatcher Object - File Name Scheduling Cycle - Conditions - Formula Judgment File Process - Platform Notification - Theme and Content File Process - Email Notification - Theme and Content File Process - Client Notification - Theme and Content File Process - SMS Notification - SMS Parameter | -- |
Aggregation Report and Dashboard | Dispatcher Object - File Name Scheduling Cycle - Conditions - Formula Judgment File Process - Platform Notification - Theme and Content File Process - Email Notification - Theme and Content File Process - Client Notification - Theme and Content File Process - SMS Notification - SMS Parameter | 1. Only cell values from the default sheet can be acquired. Cross-sheet value acquiring is not supported 2. In aggregation reports, the parameters must be written in the form of block1~A1 (instead of A1) regardless of the number of blocks. |
Note:With jar versions released on 26th Apr, 2020 and later, the Task Schedule feature supports getting cell values from aggregation reports in the setup process.
V. Delete the User Info Error Messages in Tasks
With jar versions released on and after 8th Jun, 2020, running tasks after deleting users, roles, departments or positions in Default User Group (please refer to Task Schedule Setting Steps for setup instructions) adds an error-level alert into the fanruan.log file.
The specific logic behind this alert is as follows:
Deleted Object | Scenarios | Error Alerts |
|---|---|---|
user | Platform user: 1 user: 1-line error message 200 users: 1-line error message prompting all 200 users deleted More than 200 users: 1-line error message, only prompting 200 users deleted Custom user: All users that are not in the field will be included in the error message, up to 200 users | Format: Some users in the default user group do not exist, please check the task schedule: [pp(pp)] Example: Some users in the default user group do not exist, please check the task schedule: [Sun Jiancheng(Billy), Wang Guoqiang(Cherry)] |
role | 1 role: 1-line error message Multiple roles: 1-line error message | Some roles in the default user group do not exist. Please check the task schedule. |
department | 1 department: 1-line error message Multiple departments: 1-line error message | Some department positions in the default user group do not exist. Please check the task schedule. |
position | 1 position: 1-line error message Multiple positions: 1-line error message | Some department positions in the default user group do not exist. Please check the task schedule. |
