Task Schedule Settings

1. Version 

2. Function introduction

For the basic introduction and operation method of the timing scheduling function, please refer to the document: Timing Scheduling

There are four operation steps in the timed scheduling task setting, namely: basic setting , scheduling object , scheduling period , and file processing . As shown below:

administrator enters the data decision system and clicks Manage>Task Schedule>Add a Task , as shown in the following figure:

Note: If ordinary users need to set timed scheduling tasks, an administrator is required. After enabling hierarchical authorization , configure the access authority of "Manage > Task Schedule" for it . For details, please refer to Scheduled Scheduling Management Privileges

The "Basic Settings" interface is shown as follows:

1. Task name

Fill in the name of the scheduled task.

• Task name cannot be empty.

• The task name cannot be repeated with other scheduled tasks, otherwise it will prompt "Task name already exists".

• Task names are only allowed to contain letters, Chinese characters, numbers, underscores, minus signs, dots and brackets.

2. Default User Group

Purpose: The purpose of setting the default user group is to send notifications according to the members of the user group in the fourth step "File Processing". The default user group can be empty.

Settings: Click the "Edit" button to support adding default user group members based on "Users, Departments, and Roles". Click "OK" to add them successfully. The final user group takes the union of the three and removes duplicates.

There are two ways to add users:

• Platform: Users come from the decision-making system.

• Custom User: The user originates from the server dataset. However, the selected data set column data needs to be the user      name in the platform, otherwise the task execution cannot be successful.

There are three types of objects in the scheduling object step, namely: report template, BI template, and non-scheduled object.

1. Report Template

"Report template" is the template under the installation path %FineBI_HOME%\webapps\webroot\WEB-INF\reportlets folder, which is the FineReport template.

report template for the scheduling object , please refer to Section 4.1 of the detailed setting steps of scheduled scheduling tasks .

2. BI Templates

If the object type is selected as BI template, as shown in the following figure:

1) Object type

BI Templates: Dashboards created in a BI project.

2) Choose a template

Select the dashboard created in the BI project, it cannot be empty.

3) Filter setting

Supports adding filter conditions to the selected dashboard. For example, adding filter conditions to the selected sales management center cockpit belongs to the data of 2017, as shown in the following figure:

Note 1: The account that sets the timing scheduling needs to have the authorization authority of the business package to filter the fields in the business package in "Filter Settings".

Note 2: If "Client Notification" is selected as the file processing method, the filter setting will only take effect for timed result links, not for custom links.

4) Scheduling results

In addition to generic results, results are generated individually based on users in the Default User Group; this Scheduled Results button must be selectable by selecting a user in the Default User Group. After checking this button, different data results can be sent to different users according to the set row and column permissions .

Note: The user must have the permission of the business package used by the BI template to select the "Schedule Result" option, otherwise the preview of the template will fail.

5) File name

Generate the name of the result file, including the result report, attachments (excel, word, pdf), and support formula input, such as ${now()} .

If not filled in, the resulting report and the attachment name will use the template name (remove the suffix).

Note: You need to check the scheduling result button to use the formula, and the same is true for input formulas such as execution conditions later.

6) Attachment Archive

Option to generate attachment types including: excel and pdf

If you select the option after the attachment is archived, attachments in different formats will be generated after the scheduled scheduling task ends.

The content of the attachment is the selected template content, which is saved in the %BI_HOME%\webapps\webroot\WEB-INF\schedule folder. As shown below:

7) File processing

The logic of file processing can be configured, and "Do not clean up" is selected by default.

If you select "Clean up when the task ends", all result files (including cpr and attachments) will be cleaned up after the task ends.

Therefore, when the set timing scheduling task needs to use the timing scheduling accessory, for example, in In the file processing step, check "Email Notification, FTP Upload Attachment, Custom Attachment Processing" in "Use Attachment", etc., the resulting file will be cleaned up and cannot be found. At the same time, an error will be reported when accessing the "Timed Result Link": Sorry, you cannot view this page, Index: 0, Size: 0, if you need access, please contact the administrator

Note: When more than 10 result reports are generated, a prompt message will pop up when you click Next: "It is estimated that N sets of result files will be generated, which may lead to excessive calculation. Do you want to continue?" If you click Continue, skip to the next step Scheduling period settings.

3. No scheduling objects

When "No Scheduling Object" is selected for the scheduling object, only "Scheduling Result" can be set, which is generally used for enterprises to send announcements.

The interface of "Scheduling Period" is shown in the following figure:

1. Start time

Set the start execution time of the scheduled task. Two configurations are supported:

• Execute immediately after configuration: The scheduled task is executed immediately after the setting of the scheduled task is completed.

• Set start time: Execute the task after the specified start time, support accurate to seconds.

2. Execution frequency

1) only execute once

The task will only be executed once.

2) Simple repetitive execution

The time period of the execution interval can be set in minutes, hours, day, and week.

3) Detailed frequency settings

Set the execution frequency in the format of month, day, hour, and minute. Can be freely combined.

Note 1: After setting the detailed frequency, it is not necessary to check the box of the frequency, all the frequencies will take effect.

Note 2: If multiple detailed frequencies are set for a scheduled task, the next running time displayed on the task management page. It will be displayed according to the first detail, but the real execution time is still all detail values. 

2020-08-04 and later JARs, if the set detailed frequency is not triggered, a pop-up window will prompt: The following execution frequency cannot be triggered. Please check the frequency setting and ensure that there is no conflict with the task start time and end time ,As shown below:

4) Expression setting

Set the execution frequency in the form of an expression.

You can manually fill in cronExpression in the text box of the expression setting, or you can directly select the corresponding expression by clicking the expression setting button next to it. When you click the "Preset Expression" button, expand the preset expression window and click on the , the text box on it will display and save the corresponding cronExpression. Click the Collapse Preset Expression button again to collapse the preset expression window. For details, please refer to the document: Expression Settings

2020-08-04 and later JARs, if the execution frequency set by the expression is not triggered during the execution of the task, a pop-up window will prompt: The following execution frequency cannot be triggered. Please check the frequency setting and ensure that there is no conflict with the task start time and end time ,As shown below:

Note: 2020-08-04 and later JARs, if the expression is set incorrectly, it will directly prompt: format error

3. End time

The end time includes four setting items: "End after the task is executed once, indefinitely, set the end time, and additional repeated execution times".

Depending on the execution frequency, the setting items of the end time will also be different. Please refer to the following table for details:

4. Execution Conditions

The execution condition refers to the judgment before executing the timed task. The timed task is executed only when the condition is satisfied. If it is not satisfied, it is not executed or the execution is checked after a delay.

5. Task restart

The task restart setting is a preventive measure used for automatic restart when the execution of scheduled tasks may be interrupted (such as failure to send emails due to network reasons, interruption if execution conditions are not met, etc.).

If the execution of a scheduled task is interrupted and automatic restart is set, the scheduled task will be re-executed according to the setting of the automatic restart item until it succeeds or reaches the maximum number of restarts set. The task restart setting is not enabled by default.

Scheduled task execution restarts follow the following rules:

• If the "snapshot generation" fails, the      corresponding attachment sending will not be executed.

• The restart strategy is applicable to the three      aspects of "condition judgment, snapshot generation, and attachment      sending", and the judgment is made one by one. If it is unsuccessful,      it is determined whether the restart strategy is adopted.

• Follow the task minimization principle when      restarting: if the snapshot is generated normally and there is a problem      with sending attachments, then only the attachments need to be resent, and      only the items that failed to be sent before (email, FTP, custom      attachment processing, which one fails to send is the one Can).

The "File Processing" interface supports multiple processing methods, as shown in the following figure:

In the "Scheduled Object" step, if "Attachment Archive" is checked, the language of the attachments generated after the scheduled task is completed can be modified.

The super administrator can change the language of the attachments generated by the scheduled scheduler through the "fine_conf_entity visual configuration plugin". The settings take effect after restarting the server.

Note: For the method of modifying table field values in FineDB database, please refer to Modification of Common Table Fields in FineDB .