Data Alert Use Instruction

This document briefly introduces the installation method and functions of Data Alert plugin. For details about adaptive plugin versions, see Data Alert Overview.

Obtaining Plugin

Data Alert plugin is built into FineReport 11.0.17 and later versions, with no need to install manually.

For projects before version 11.0.17 or upgraded from other minor versions, you can obtain the plugin at https://community.finereport.com/plugin/?id=82.

Plugin Installation

For details about installing plugins in the designer, see Designer Plugin Management.

For details about installing plugins on the server, see Server Plugin Management.

Plugin Authorization

To use this plugin, you need to purchase data alert function point in FineReport License registration. For details, contact FanRuan sales consultants.

• If the project is not officially registered, you can try its full functions after installing Data Alert plugin.

• If the project is registered but the data alert function point is not, you can only create two alert tasks with the plugin.

Permissions for Creating an Alert Task

Note:

To use the data alert function in the FVS template, you need to enable Template Authentication. For details, see section "Creating an Alert Task in Designer or URL Preview".

Creating an Alert Task in the Decision-making System

1. After the plugin is installed, the super admin needs to assign the viewing permissions of reports to different users in the decision-making system. For details, see Directory Viewing Permission.

For example, assign the viewing permission of the Complicated Multi-Value Query template to user Tom.

2. After completion, the super admin needs to enable Hierarchical Authorization.

3. The super admin needs to assign Data Alert permission to specified users in Common Permission Configuration. After the permission is assigned, users can use the data alert function in the decision-making system.

For example, assign Data Alert permission to user Tom.

4. To allow users to select other departments or roles as recipients of the data alert task, the super admin needs to assign Personnel Management permission of the corresponding department or role to users. Recipients need to have the viewing permission of the corresponding report.

For example, to allow Tom to select the Development Department as the recipient of the alert task, the super admin needs to assign the Personnel Management permission of the development department to Tom, and assign the preview permission of the corresponding template to the development department.

Creating an Alert Task in Designer or URL Preview

Note:

Super admin needs to configure the mailbox for the system and relevant personnel first, then they can use the data alert function.

1. After the plugin is installed, the super admin needs to enable Template Authentication.

2. The following steps are consistent with those in section "Creating an Alert Task in the Decision-making System".

Permissions for Subscribing to an Alert Task

Only after the super admin assigns the following permissions to users, can they subscribe to tasks visible to everyone, as shown in the following figure.

• Using permission of Data Alert plugin

• Viewing permission of the report used to create an alert task

Permissions for Managing an Alert Task

Data Alert plugin supports the management of alert tasks and alert to-do lists. For details, see Managing Alert Task.

Applicable Preview Mode

Data Entry Preview, Data Analysis Preview, and Pagination Preview modes are supported in ordinary reports. PC preview is supported in dashboards.

You can use the data alert function in visualization dashboards with the Data Alert plugin V1.6.2 and later versions, as well as the FineVis Data Visualization plugin V1.17.1 and later versions.

Applicable Object

You can set an alert task for numeric cells, extended cells, pie charts (except multi-layer pie charts), bar charts, column charts, line charts, area charts, gauges, and combination charts of the above charts.

Basic Settings

Basic Settings include Alert Status Alert Status, Alert Name, Triggering Condition, and Detection Frequency. To create an alert task for a chart, you need to set Chart Type, Category, and Series.

• Alert Status Alert Status: allows you to enable or disable alert tasks.

• Alert Name: allows customizing the name of an alert task.

• Triggering Condition: supports multiple triggering conditions including More than, Less than, Equal to, Not Equal to, More than/Equal to, Less than/Equal to, Between, Not Between, Contains null, and Does not contain null.

• Detection Frequency: supports multiple frequencies for detection including Every Hour, Every Day, Every Week, Every Month, and Every Year. For example, if you set the alert task to detect every hour, the detection will be performed accordingly.

Note:

If extracted data cache is used and the detection frequency is higher than the data update frequency, a prompt box pops up, indicating that the detection frequency is too high and bottom data cannot be updated timely. You are advised to select a low-frequency detection.

• Chart Type: allows selecting the chart type when you create an alert task for a combination chart.

• Category: allows selecting the data category in the chart.

• Series: allows selecting the data series in the chart.

• Mute Duplicate Notification: If the switch is enabled, notifications with same content (data part) as the last time will not be pushed until next data updates reach alert conditions.

Alert Notification

Alert Notification includes Receiver and Notification Method.

Receiver

Receiver includes Designated Receiver and Dynamic Receiver.

Note:

If you need to select other roles as Receiver when creating an alert, the admin needs to assign Personnel Management permission to these roles.

Notification Method

Receiving method includes E-mail, Message, Platform Notification, Client Notification, and API Notification.

You can customize the receiving content or quote variables.

1. E-mail: sends email notifications after the alert condition is triggered.

Note:

If E-mail is selected, the super admin needs to configure the mailbox for the system and relevant personnel first, then they can use the data alert function, otherwise a prompt box will pop up, indicating that the saving is failed because the sender mailbox is not configured in the system. For details about mailbox configuration, see Email Service.

Other Messages (default to display in the format of Result Link) is supported in E-mail, as shown in the following figure.

• Result Link: displays the report content with a hyperlink in the email.

• Alert Object: displays the report content with an image in the email.

2. Message: If Message is selected, message service needs to be configured in the system, otherwise a prompt will pop up, indicating that the account is not bound to a phone number. 

For details about SMS configuration methods and the relevant charging rules, see SMS Service.

3. Platform Notification: sends notifications through the platform after the alert condition is triggered.

4. Client Notification: sends notifications through the DataAnalyst app after the alert condition is triggered. /

According to the method of client notification, the report content is displayed with a hyperlink in the notification by default. You can select Alert Object in Other Messages to display the report content with an image in the notification.

Note:

If the alert object is a table, the report content cannot be included in the client notification.

5. API Notification: sends notifications to customized platforms and apps. /

More Settings

More Settings includes Privacy Setting and Alert To-Do Task.

• Privacy Setting: includes Available to All and Available Only to Myself and Receiver. If you select Available to All, users with the data alert and report viewing permissions can view and subscribe to the alert task. Then they can receive data alert notifications.

• Alert To-Do Task: includes Generate Alert To-Do Task, Responsible Person, and Solve Within N Day(s) After Alert is Triggered.

Note:

Only after the super admin assigns the data alert permission to the responsible personnel, can they handle alert to-do tasks.

Data Alert Management

Go to the task management page by choosing System Management > Data Alert or clicking Alert Task Management on the report page.

The task management page includes Alert I Created, Received Alert, Alert Created by Other Users, and Alert To-Do Center.

• Alert I Created: allows viewing the historical trend chart and the preview template of the task, and deleting the alert task.

• Received Alert: allows viewing the historical trend chart and the preview template of the task, and unsubscribing from the alert task.

• Alert To-Do Center: allows viewing the processing status and estimated solving time of the relevant task.

• Alert Created by Other Users: (only available for the super admin) allows deleting the alert task created by other users and viewing the template and historical trend chart of the alert task.

Different effects can be displayed according to different triggering conditions in the historical trend chart, as shown in the following table.