Successfully!

Error!

Tracking Instruction for the Data Alert Function

  • Last update：  2024-03-19

    • Overview

    This document summarizes the storage locations of data alert tasks and introduces fields corresponding to each configuration item.

    1. The configuration information of data alert tasks is stored in fine_conf_entity of the FineDB table.

    2. The information of to-be-processed alert tasks is stored in fine_sentinel_todos of the FineDB table.

    3. If the data alert task detection is triggered, a snapshot will be generated for the alert object. The alert snapshot is used to record the status at that time and its information is stored in fine_sentinel_records of the FineDB table.

    Field Description

    The following table describes the basic information of each field.

    Configuration Item
    		Corresponding Field NameTypeDescription

    Basic Settings

    taskID

    Character String

    Specifies the task ID (a randomly generated UUID), which is generated after an alert task is created.

    taskName

    Character String

    Specifies the name of an alert task.

    createTime

    Long Integer

    Specifies the creation time generated after an alert task is created.

    creator

    Character String

    Specifies the creator of an alert task.

    source

    Character String

    Specifies the source template and its path of an alert task.

    Triggering Condition

    rule

    Tree Structure

    Saves the rule of each indicator. For example: if the triggering condition in a detail table is that F2 is more than 1, the corresponding field content is as follows.

    "rule": {
            "expr": "GreaterThan",
            "args": [
                {
                    "expr": "____WatchTarget____",
                    "args": [
                        {
                            "expr": "Detail Table.cpt::0::F2"
                        }
                    ]
                },
                {
                    "expr": "1"
                }
            ]
        },



    triggers

    Array

    Checks the frequency array, as shown in the following table.

    Array
    		Definition

    ;;;;29

    The alert task is executed at the 29th minute per hour.

    ;;;3;30

    The alert task is executed at 3:30 AM every day.

    ;;1,2,3;15;0

    The alert task is executed at 15:00 on the 1st, 2nd, and 3rd days of every month.

    1,3;;28,29;12;0

    The alert task is executed at 12:00 PM on the 28th and 29th days of January and March every year.

     

    Notification

    notifyInterval

    Integer

    Specifies the notification interval (unit: hour).

    notifyTypes

    Integer Array

    Specifies the notification type. 0 represents E-mail, 1 represents SMS, 2 represents Platform Notification, 6 represents APP Notification, and 8 represents the Webhook interface.

    notifyContents

    Array

    Specifies the custom notification content. You can customize the notification type (namely the value of notifyType), the template of the notification content (namely the value of contentTemplate), and the attachment type (namely the value of extensionType, with 0 representing Link, 1 representing Image, and 2 representing File).

    areas

    Object

    Specifies the alert object. For example, if you create an alert task for cell D5 (where data is located) and cell A7 (where the chart is located) in the GettingStartedEN report, the corresponding field content is as follows.

     

    receivers

    MAP

    Specifies the selected user, department, and role based on the user dimension.

    Key: 0 represents to select receivers based on User, 1 represents to select receivers based on Department, and 2 represents to select receivers based on Role.

    Value: The selected key-value array, where key is the ID (namely the user/department/role) and value is the name.

    Privacy Setting

    exclusive

    Boolean

    Determines whether the alert task is available to all. true: The alert task is available to all. false: The alert task is available only to the creator and the receiver.


    Attachment List


    Theme： Report Application
    Already the First
    Already the Last
    • Helpful
    • Not helpful
    • Only read
    中文（简体） 中文（繁體） 日本語
    English

    Doc Feedback