Introduction to the Data Alert Plugin Using

Functions

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

Notes

1. You can only set alert tasks for tables, line charts, bar charts, dashboards, KPI scorecards, and custom charts combining line charts and bar charts within a dashboard.

2. For data alert tasks, you can be notified through emails, SMS, platforms, clients, and APIs.

a. If the system email/SMS/API is not configured, the following prompts pop up when you select Notification Method:

No email address is configured for the system, preventing alerts from being received through emails. Configure the email service first or select other reception method. For details about mailbox configurations, see Mailbox.

The system is not configured with any SMS service and cannot receive any alert through SMS. Configure the SMS service or select other reception methods first. 

The system is not configured with any API and cannot receive any alert. Add the app or select other reception methods in Alert Settings first. For details about API configurations, see Managing APIs.

b. For alert tasks in clients, you can be notified through the DataAnalyst app (after you integrate it with FineBI).

3. The task creator and receiver need to bind their mailboxes/phone numbers, otherwise a prompt (Users bound to no email address or phone number cannot receive alert information through corresponding channels.) occurs when you hover the cursor on the small exclamation mark icon (on the right side of Receiver). 

4. Dashboards shared through public links do not have the Data Alert button.

5. To prevent downtime and optimize performance, up to one million of data records filtered by dimensions can be used in data alert calculations.

Parameter Setting

The Parameter for Determining Whether to Retain the Dashboard Filtering Effect in Data Alerts

The parameter SystemOptimizationConfig.useAllVisibleDataForSentinel has been added in the fine_conf_entity visualization configuration of FineBI 6.0.14, allowing you to determine whether to retain the dashboard filtering effect for data in data alerts.

The Parameter for Determining the Number of Abnormal Data Pushes

The parameter SentinelConfig.showDetailAbnormalData, which determines whether all abnormal data or some abnormal data is pushed in data alert messages, has been added to the fine_conf_entity visualization configuration.

If all abnormal data is displayed, the message conveying abnormal data information will be pushed one by one, as shown in the following figure. 

• If all abnormal data is pushed, the content will be too long for you to receive the message.

• 5,000 characters are extracted for the abnormal data. Notifications will not be generated for content that is beyond 5,000 characters. The length of other content will not be affected.

Installing the Plugin

1. You can contact our technical support to obtain the plugin.

2. Choose System Management > Plugin Management and click Local Install to install the plugin. For details, see Plugin Management.

3. If users other than the super admin want to use the plugin, they need to be assigned permissions first. For details, see section "Plugin Permission Introduction".

Plugin Authorization

To use the plugin, you need to purchase the function point of the Data Alert plugin in FineBI License registration. For details, contact FanRuan's sales consultants.

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

• If the project is registered but the function point of the Data Alert plugin is unregistered, you can only create two alert tasks with the plugin.

Creating Alert Users

To allow other users to create alert tasks, the super admin needs to assign permissions to them in System Management.

1. After the plugin installation, the admin needs to assign the viewing permissions of reports to different users. For details, see

Viewing Permission of Directory.

2. After the plugin installation, you can use the alert function on templates of the platform and templates accessed in Directory.

To integrate FineBI dashboards into other systems for direct preview, you need to enable Template Authentication.

3. The admin sets the Data Alert permissions for alert users.

After the plugin installation, the admin needs to enable Hierarchical Authorization and assign the Data Alert permission to relevant users in Common Permission Configuration.

a. Enable Hierarchical Authorization as shown in the following figure.

Note:

To enable Hierarchical Authorization, you need to register the function point of the group permission control. Without the registration, Hierarchical Authorization cannot be enabled. Only the super admin can create alert tasks.

b. Assign the Data Alert permission.

Common User

Users without permissions can also receive alert messages when data alert tasks are triggered.

Subscription User

Only after the super admin assigns the following permissions to users, can they subscribe to alert tasks visible to everyone.

• Using permissions of the Data Alert plugin

• Viewing permissions of dashboards used to create alert tasks

Note:

You cannot subscribe to alert tasks with dynamic receivers.

Super Admin

1. The super admin has the highest permissions and can create and manage alert tasks.

2. The super admin can manage alert tasks created by other users while managing alert tasks.

3. The super admin can also configure the information of third-party apps in Alert Settings. For details, see Data Alert Interface.

Where to Set

1. Click Data Alert on the preview page of dashboards in My Analysis to create alert tasks.

2. Choose More > Data Alert on the dashboard editing page.

3. Click Data Alert on the preview page of dashboards in Directory.

The page after you click Data Alert is shown in the following figure.

If dashboards have been added with data alert conditions, with Available to All being set in Privacy Setting, users can choose Subscribe on the data alert creation page to follow value changes when previewing dashboards.

Creating an Alert Task

Alert Settings include Basic Settings, Alert Notification, and More Settings. Click Create Alert Task to go to the setting page.

Basic Settings

• Alert Name: You can customize the name of alert tasks.

• Select Component: You can select table and chart components within dashboards.

You can select the following components to create alert tasks: tables, line charts, bar charts, dashboards, KPI indicators, and custom charts combining line charts and bar charts.

• Dimension: You can select dimension fields in table components and add conditions. （Only text fields without the drill setting are supported.）

If you add a date field to Dimension, you can set the alert range to Date Range/Last N Record(s) of Data.

Last N Record(s) of Data represents a dynamic time. For example, if data on a dashboard is granularized by day, the last two records of data are the data of the last two days (namely the top two records of data after sorting data on the dashboard by date).

• Triggering Condition: You can add multiple conditions, with the option Meet All Conditions/Meet Any Condition. The judgment method includes More than, Less than, Equal to, Not Equal to, More than/Equal to, Less than/Equal to, Between, Not Between, Allow Null, and Disallow Null.

• Detection Frequency: You can set multiple detection frequencies, including Every Hour, Every Day, Every Week, Every Month, and Every Year. For example, you can set the detection to be performed every hour.

Alert Notification

Receiver

Alert Notification includes settings of Receiver and Notification Method.

• Receiver includes Designated Receiver and Dynamic Receiver.

Note:

If the admin does not assign the corresponding Personnel Management permission to you, you cannot find the desired receiver in the list. You need to contact the admin to solve this problem.

Receiver	Detailed Introduction
Designated Receiver	Select multiple receivers based on User/Department/Role.
Dynamic Receiver	Select a receiver based on User/Department/Role. User: match the user information on the platform based on Username/User ID in the report. For details about obtaining user ID, see FineDB Table Structure. Department: match the user information on the platform based Department name/Department ID in the report. For details about obtaining department ID, see FineDB Table Structure. The complete department structure uses (-) as a hyphen. Alert tasks can be triggered with a complete match. For example, if the department name is "Technical Support", all sub-nodes (bottom-level nodes) with the same name can receive messages. If the structure of the department is FanRuan-Central East-Technical Support (bottom-level node), all users in this department can receive messages. If the structure of the department is Fanruan-Central East-Technical Support-Technical Support Group A, only Technical Support Group A can receive messages. Role: match the user information on the platform based on Role name/Role ID in the report. For details about obtaining role ID, see FineDB Table Structure. For example, you can set receivers as shown in the following figure. Click the drop-down list icon to select users within components. The system matches the selected users with the user information on the platform. Users can receive messages if matches are successful and alerts are triggered for indicators in the user-located dimension. Note: The match fails if the value of the responsible person field in reports is empty or abnormal. The case of the responsible person field in reports needs to strictly match the case in databases. Only tables are supported. Dynamic receivers can receive real-time alert notification information only related to themselves.

Notification Method

• Notification Method: You can be notified through emails, SMS, platforms, clients, and APIs.

Note:

1. For alert tasks in clients, you can be notified through the DataAnalyst app (after you integrate it with FineBI).

2. Before selecting API Notification, the admin needs to add third-party alert apps under System Management > Data Alert > Alert Settings.

• Text Content: You can customize notification content with variables. If there is more than one triggering condition, the variables for the maximum and minimum values that satisfy the conditions are empty.

The supported variables include Alert Name, Template, Triggering Dimension, Triggering Condition, Triggering Time, Number of Data Records Meeting Conditions, Maximum Value Meeting Conditions, and Minimum Value Meeting Conditions.

If you add the variable Abnormal Data, you can customize the display fields for the abnormal data message. 

For example, set the alert object to Quantity and Abnormal Data Dimension to Whether Delivered and Contract Type. The alert condition is that the maximum abnormal data volume is 172.0 when Whether Delivered belongs to No and Contract Type belongs to Purchased Contract, as shown in the following figure.

Note:

Only one record of abnormal data is displayed by default. The example shows the maximum value among the three records of alert data. If you need to display all abnormal data, you can modify the parameter configuration. For details, see section "The Parameter for Determining the Number of Abnormal Data Pushes."

• Other Content: In E-mail, you can set Other Content to Result Link (default option) or Alert Object.

Result Link: Components in emails are displayed as hyperlinks, which you can click to view details.

Alert Object: Components in emails are displayed as thumbnails, with some components (meeting triggering conditions) pushed in the image format.

More Settings

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

• Privacy Setting: You can set it to Available to All or Available Only to Myself and Receiver.

• Alert To-Do Task: If Generated Alert To-Do Task is ticked, you can set Responsible Person and Resolution Time of alert tasks.

Note:

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

Managing Alert Tasks

Where to Set

1. On the dashboard preview page

2. On the System Management page

Functions

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

• Alert I Created: view historical trend charts, preview templates of alert tasks, and delete alert tasks.

• Received Alert: view historical trend charts, preview templates of alert tasks, and unsubscribe from alert tasks.

• Alert To-Do Center: view the processing status and estimated resolution time of relevant alert tasks, as shown in the following figure.

• Alert Created by Other Users: (available for only the super admin) delete alert tasks created by other users and view templates and historical trend charts of alert tasks.

For details, see Managing Alert Tasks.

For details, see Creating a Data Alert Task and Dynamic Receiver.