Task Schedule Setting

Version

Report Server Version	Functional Change
V11.0	/
V11.0.1	1. The Print File method is deleted in File Processing. 2. Retain Only Latest 1 Times is the default option set for Schedule Object > File Processing.
V11.0.2	Multiselected Report Template is added to Object Type.
V11.0.5	If Frequency in Schedule Cycle is Detailed Frequency, the Delete button below will be invisible by default. You can view the button only after selecting one or more detailed frequencies.
V11.0.24	Selecting a single FVS template for the task schedule is supported if you use the JAR package later than the vision updated in 2024-01-26 and FVS later than V2.3.1. Note: You need to install the FVS task schedule export plugin. You can contact our technical support to obtain the plugin.
V11.0.25	Selecting multiple templates for the task schedule is supported if you use the FVS later than V2.3.1. Note: You need to install the FVS task schedule export plugin. You can contact our technical support to obtain the plugin.

Function Description

Setting a scheduled task includes four steps. This document describes the setting items in these four steps.

Log in to FineBI as the admin, choose System Management > Task Schedule > Task Management, and click Add Task to add a scheduled task.

The Basic Setting page is shown in the following figure.

Task Name

Enter the name of the scheduled task.

The task name cannot be empty.

The task name cannot be the same as the names of other scheduled tasks, otherwise, a prompt "The task name already exists." will be displayed.

The task name only contains letters, numbers, underscores, hyphens, dots, and parentheses.

You cannot modify the name of the ongoing task.

Default User Group

Setting Default User Group is to send notifications based on the user group members in the fourth step File Processing. The value of Default User Group can be empty.

Click Edit and add the user group members based on User, Dept., and Role. After the members are added, click OK. The final user group  takes the union of the three and removes duplicates.

There are two ways to add users:

Add users from the decision-making system.

Add users from the server dataset. However, the selected dataset column data needs to be the username in the platform, otherwise, the task execution will fail.

Note:

Usernames in Default User Group cannot contain parentheses, otherwise, the user cannot receive messages.

Scheduling the Object

You can schedule three types of objects: Report Template, Multiselected Report Template, and No Schedule Object.

Note:

In versions older than FVS V2.3.1, only the No Schedule Object option is supported. Then, in section "File Processing", you can learn to fill in the template preview link for notification.

Starting from V 2.3.1 of FVS, after installing the FVS task schedule export plugin, the Report Template type supports you in selecting the FVS template. Starting from V11.0.25 of the Report Server, the Report Template type supports you in multiselecting FVS templates.

1. No Schedule Object

When selecting No Schedule Object for Object Type, you can only set Schedule Result which is generally used for enterprises to send announcements.

2. Report Template

When you select Report Template for Object Type, the object can be used to push, save, and view the execution results of the report. The following settings are supported.

3. Multiselected Report Template

When selecting Multiselected Report Template for Object Type, you can select multiple templates but only use the email to push the execution results. The following settings are supported.

The settings for Multiselected Report Template are similar to those for Report Template. Set Parameter, File Name, and Appendix Archive can be configured separately for each template. You can adjust the order of templates by dragging them.

If Formula Judgment or Judgement of Custom Class is used in the execution condition and related to the template content, only the first selected template is supported.

In File Processing, the processing method only supports Email Notification. If a formula is used in the title or body of the email, only the first selected template is supported.

Selecting a Template

Select a template in the path %FR_HOME%\webapps\webroot\WEB-INF\reportlets, which cannot be empty.

Note:

1. Task Schedule does not support you in triggering events set in Web Attribute of the template.

2. When you select multiple report templates, a single task can support to select no more than 35 templates.

Type

Choose the execution method of the report.

If the template is a regular report, there are three types: Preview (default), Data Entry, and Analysis.

Only Preview will be available if the template is a dashboard or FVS dashboard.

Note:

1. The type you select on the page is consistent with the type selected during the normal access to the template. For example, if you are advised to select Preview instead of Analysis for large data volume, this recommendation should also be followed in Task Schedule.

2. After installing the Word report plugin, a new Word type will be added to the regular report types. For details, see Setting Scheduled Tasks for Word Reports.

Parameter Setting

Set Parameter affects the result report generated by Task Schedule.

Set Parameter can be used in conjunction with Schedule Result to generate separate report results for members in Default User Group.

There are two types of Input Method for the parameter setting:

Default: Supports data types with selectable values. You can manually fill in the values. Supports String, Integer, Double, Date, Boolean, and Formula types.

Dataset: The data type of the value is Automatic Matching, and the value can be selected from the data columns in the server dataset.

Note:

1. Clicking the Refresh button will allow you to quickly obtain the parameters and their default values in the template, but it will cause manually added parameters to disappear.

2. When there are multiple values for the FVS dashboard dataset parameters, a random value is selected for display.

Schedule Result

Note:

If the value of Default User Group in Task Schedule > Basic Setting is empty, the Schedule Result function will be grayed out and unavailable.

If you select the Generate Result (Except for General Result) Separately Based on User in Default User Group setting item, independent report results will be generated for all members in Default User Group.

In this case, the folder for independent report results is named after the username of the default user group member, and a general report result is also generated.

The parameters related to the username will take effect.

If the setting is deselected, only general report results will be generated.

File Name

The name of the generated result file includes the result report and attachment (Excel, Word, PDF) names, and it supports formula input, such as ${now()}.

If you do not enter the name, the generated result report and attachment names will use the template name (without suffix).

Appendix Archive

You can choose the type of attachment to generate, including Result Report (.cpr file), excel03, excel07, word, and pdf.

The attachment generated by the FVS Dashboard only supports the result report (.frr_fvs file), PDF, and PPT attachment types.

If you select the option for Appendix Archive, attachments in different formats will be generated after the scheduled task ends.

The attachment content is the content of the selected template in section "Selecting a Template". The attachment is saved in the path %BI_HOME%\webapps\webroot\WEB-INF\schedule.

You need to note the following points:

In the Word attachment, chart components in FRM reports are not supported, only cell element charts are supported.

When you set Task Schedule, if the template selected in the Schedule Object step is a dashboard, and excel03, excel07, word, or pdf are selected for Appendix Archive, the generated attachment does not support body background color.

When the attachment generated by the FVS template is too large (commonly a complex 3D template), it may cause the email to fail to send.

Processing the File

File Processing allows you to configure the file processing logic, defaulting to Retain Only Latest 1 Times.

If you select Clear Upon Task End, all result files (including CPR files and attachments) will be cleared after the task is completed.

Therefore, when the set scheduled task needs to utilize the scheduled task attachment, such as selecting Email Notification, Attachment Upload by FTP, Custom Attachment Processing, etc. in Use Attachment in the File Processing step, the result file will be cleaned up and cannot be found. At the same time, when you access Timed Result Link, an error "Sorry, you cannot view this page. Index: 0, Size: 0. Contact the administrator if access is required." will be displayed.

The file is saved in webroot\WEB-INF\schedule, stored according to the task name and time, with each file generated every minute stored in a separate folder.

Note:

When the number of generated result reports exceeds 10, a prompt will be displayed when you click Next: "There is N sets of result files expected to be generated, which may cause the calculation to be too large. Do you want to continue?" If you click Continue, you will jump to the next step for setting Schedule Cycle.

The Schedule Cycle setting page is shown in the following figure.

Start Time

You can set the start time for the scheduled task to run. Start Time supports two types of configuration:

Execute Immediately After Configuration: Execute immediately after the scheduled task is set up.

Set Start Time: Execute the task after the specified start time (to the second).

Frequency

1. Only Execute Once

The task will only be executed once.

2. Fixed Interval

The execution interval can be set in minutes, hours, days, or weeks.

3. Detailed Frequency Setting

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

Note:

1. After you set the detailed frequency, there is no need to check the box beside the frequency, and all frequencies will take effect.

2. In the project from version V11.0.5 onwards, the delete button below the detailed frequency is invisible by default. The deletion button only appears when one or more detailed frequencies are selected.

3. If a scheduled task has multiple detailed frequencies set, the next run time will display on the Task Management page according to the first detailed frequency, but the actual execution time will still be determined by all the detailed values.

A prompt will pop up if the set detailed frequency is not triggered: "The following execution frequency cannot be triggered. Ensure that the frequency settings have no conflict with the task start time and end time."

4. Expression Setting

You can set the execution frequency through expression form.

The text box set by the expression can be manually filled with cronExpression, or you can click View Preset Expression to select the corresponding expression and modify it. When you click View Preset Expression, the preset expression window will expand. Click an expression, and the text box above will display and save the corresponding cronExpression. Click Collapse Preset Expression and the preset expression window will be collapsed. For details, see Expression Setting for Task Schedule Execution Frequency.

A prompt will pop up if the execution frequency set by the expression does not trigger during the task execution: "The following execution frequency cannot be triggered. Ensure that the frequency settings have no conflict with the task start time and end time."

Note:

If the expression is set incorrectly, a prompt "Format Error" will be displayed.

End Time

End Time includes four settings: End After Task Is Executed Once, Indefinite, Set End Time, and Extra Repeated Execution Times.

The setting options for End Time will vary depending on the selected Frequency, as shown in the following table.

Execution Condition

Execution conditions refer to the judgment before a scheduled task is executed. The task will only be executed when the conditions are met. Otherwise, the task will not be executed or will be delayed for some time before being verified and executed.

Note:

If you select the FVS visualization dashboard as the template, only the parameters in section "parameter setting" are supported in Formula Judgment and Custom Class Judgment, and the parameters in the FVS visualization template are not supported.

Task Restart

Task Restart is a preventive measure designed to automatically restart the scheduled task that may be interrupted during execution, such as network issues causing email sending failures and failure to meet execution conditions.

If a scheduled task is interrupted during execution and automatic restart is set, the task will be restarted according to the automatic restart settings until the task is executed or reaches the maximum number of restarts set. Task Restart is disabled by default.

Restarting a scheduled task follows the following rules:

If Snapshot Generation fails, the corresponding attachment sending will not be executed.

The restart strategy applies to three judgments: condition judgment, snapshot generation, and attachment sending. Each aspect is judged, and if any fails, whether the restart strategy has been taken will be determined.

During restart, the principle of task minimization is followed. If the snapshot generation is normal, but attachment sending has issues, you only need to resend the attachment that failed to be sent previously (email, FTP, or custom attachment processing).

The File Process page supports multiple processing methods.

Note:

1. When you select No Schedule Object as Schedule Object, only four processing methods are supported: Platform Notification,  Email Notification, SMS Notification, and Client Notification.

2. When you select the multiselected report template as Schedule Object, only Email Notification is supported.

Attachment Language

If you select Appendix Archive in Schedule Object, the language of the attachment generated after the task can be modified.

The super admin can modify the attachment language through the FINE_CONF_ENTITY Visual Configuration plugin. The settings take effect after the server is restarted.

Note:

For details about modifying field values in tables of FineDB databases, see FINE_CONF_ENTITY Visual Configuration.