Overview
Version
| FineBI Version | Functional Change |
|---|---|
| 6.0 | / |
| 6.1.1 | The Use Component Alert Attachment option is added to Email Notification to send attachments of alert component and dashboards. |
Application Scenarios
You often need to analyze abnormal data values when creating components for better guiding business development.
However, detecting abnormal values manually is inefficient. You may expect the system to proactively notify relevant personnel after abnormal values appear.
Functions
By using Alert Judgment in Task Schedule, it is possible to actively push the abnormal values of the components to the user for timely processing or optimization.
Alert Judgment:
1. Supports table components in FineBI templates, not chart components or non-FineBI templates.
2. Allows setting alert conditions for the analyzed result fields in the component.
3. Supports Email Notification and Client Notification.
Example
The Sales and Profit Analysis dashboard under Business Theme > Sales Management > A Chain Supermarket Sales Report has a component called MOM Growth Rate of Growth Profit Margin.
Set up a scheduled task to check whether there are values of Gross Profit-Chain Growth Rate less than 0 in the component MOM Growth Rate of Growth Profit Margin at 18:00 every day. If there are values less than 0, it is necessary to email the sales manager of the sales department.
Setting a Sender
The scheduled task requires sending an email to the sales manager of the sales department, so a sender is necessary, otherwise the sending will fail.
Log into FineBI as the admin, choose Manage > System > Mailbox, click Add Sender to add a sender, and click OK.
Note:1. The configuration steps may vary based on the type of the sender's email. For details, see Mailbox.
2. After configuration, click Send Test Mail to ensure that the mailbox is available.
Setting a Recipient
You need to first bind a mailbox for the sales manager Alice to email her in the scheduled task.
Log into FineBI as the admin, choose Manage > User > All Users to edit the user information of Alice (sales manager) and enter her Mailbox information, and click OK.
Note:
Adding a Task
Log into FineBI as the admin, choose Manage > Task Schedule > Task Management, and click Add Task to add a scheduled task.
Basic Settings
1. Set Profit_Data as Task Name.
2. Click Edit in Default User Group.
Select Sales Manager in Sales department, and click OK.
Note:
Confirm that All Departments:Sales department:Sales Manager is selected in Dept., and click OK to finish setting the default user group.
Click Next.
Task Scheduling Object
1. Object Type: BI Template
2. Select Template: the Sales and Profit Analysis dashboard under Business Theme > Sales Management > A Chain Supermarket Sales Report
3. File Name: ${today()} Profit Data
4. Accessory Archive: pdf
Click Next.
Scheduling Cycle
1. Set execution frequency
Select Detailed Frequency Setting as Frequency, and click Add.
Set 18:00 as Time.
Select Daily as Execution Date, and Select All as Month.
Click OK to successfully add the detail frequency.
2. Set execution conditions
Tick the detail frequency added in the previous step.
Conditions: Warning Judgment
Select component: MOM Growth Rate of Growth Profit Margin
Early warning condition: The value of Gross Profit-Chain Growth Rate is Less than 0.
Click Next.
File Processing
1. Select Email Notification as the Processing method.
2. In the Email Notification settings:
Sender: The FineBI system is default sender, and you can select other senders from the drop-down menu.
Recipient: Default User Group
Subject: ${today()} Profit Data
Mail Content: Today's MOM growth rate of gross profit margin is less than 0, please pay attention to the abnormal values in time.
Tick Body preview component content.
Tick Use Attachments.
Click Save.
Demonstration
Since the task is executed at 18:00 every day, the task effect cannot be seen immediately.
To see the effect immediately, you can go to Manage > Task Schedule > Task Management to find the task, and select Run Once.
After the task is executed once, Alice, Sales Manager in Sales department, receives an email from the FineBI system in her bound mailbox.
The email content is shown in the following figure:
Function Details
Prerequisite
To use the Alert Judgment function, the following prerequisites need to be met.
Object types
Alert Judgment only takes effect on FineBI dashboards.
You need to select BI Template in Task Schedule > Dispatcher Object > Object Type, otherwise the Alert Judgment task cannot be set.
Selecting a Template
Alert Judgment only takes effect on table components in FineBI dashboards.
You need to select a dashboard containing table components in Dispatcher Object > Select Template, otherwise there will be no available components in Alert Judgment.
Component Selecting
After selecting Alert Judgment as Execution Condition, you can select a component in Select component.
1. Component options include all table components with data permissions in the dashboard, sorted by component creation date.
2. The FineBI system can only perform Alert Judgment on one table component in a task, and does not support multiple selections.
3. After a component is selected and a alert condition is added, switching another component will clear the previous set alert condition.
Note:
Alert Condition
Allow selecting result fields of table components, including dimensions and indicators.
1. Dimension
Display grouped result values and other ungrouped original values.
The date field is the original value grouped by year, month, and day.
The same field will be displayed in the order of display in the analysis area.
2. Indicator
Display result values, excluding row grand totals and row subtotals within a group.
3. Result filters, table properties, and hidden fields cannot be set.
Task Execution
When the alert task is executed:
The system will first check if the alert conditions are abnormal (such as field permission missing and field missing).
If the alert conditions are abnormal, the alert task will fail to execute.
If the alert conditions are normal, the alert task will continue to execute.
After the alert conditions are judged as normal, the corresponding alert judgment will be executed in sequence according to the task user group.
If the task executes abnormally on user A, the system will skip. The skipped user will be marked in the task execution details.
If the task executes successfully on user B, the system will send an alert notification.
The system will execute sequentially until the task is completed, and the failure of the execution on a single user does not affect the executions of the remaining users.
Notes
Schedule Object
Schedule Result
1. If you do not select Schedule Result, the system will determine whether to send alerts to the entire user group based on the data permissions of the component owner.
2. If you select Schedule Result, the system will determine whether to send alerts to a certain user based on the data permissions of each member in the user group.
After selecting this button, different data results can be sent to different users based on the set row and column permissions.
Appendix Archive
If you select any option of Appendix Archive, the system will generate separate attachments for archiving the alert component and the dashboard.
Schedule Cycle
To ensure the efficiency and usability of the alert task, you are advised to set the execution frequency of the alert task to no less than once per hour.
Condition Invalidation
After you complete the scheduled task setup, the alert conditions for the alert judgment may be invalidated and marked in red.
1. Cause
When a field is missing, the field will be highlighted in red, and a prompt will pop up: The current field is missing.
When the corresponding user does not have permission of this field, the field will be highlighted in red, and a prompt will pop up: No permission for this field.
Note:Changing the grouping type of a field will not affect the execution of user's warning tasks.
If the corresponding warning conditions can still be matched after the group is changed, the corresponding warning will still be triggered.
2. Condition Type
OR Condition: If a single warning condition become invalid, it does not affect other valid conditions.
AND Condition: If any AND Condition in the scheduled task become invalid, the task execution will fail.
Email Notification
1. Previewing the content in the body
If you have configured Alert Judgement in a scheduled task, the Use Component Alert Attachment option will be added to File Processing > Email Notification > Mail Content.
You can select Preview Template in Body and Preview Component in Body as needed.
If you select both two options, the email body displays the alert component content first, and then the dashboard content.
2. Using the attachment
If you have configured Alert Judgement and selected Appendix Archive in a scheduled task, then in File Processing > Email Notification > Mail Content:
In versions before 6.1.1, Use Template Attachment can be selected. After you select the option, email attachments will include two files: one for the dashboard and one for the alert component.
In version 6.1.1 and later, the Use Component Alert Attachment option is added to Email Notification. You can select Use Template Attachment and Use Component Alert Attachment as needed.
