Successfully!

Error!

Data Alert Third Party Notification Interface Configuration

  • Last update:  2023-06-12
  • Overview

    Version

    Report Server Version
    Plugin Version

    11.0.9

    1.6.0

    Application Scenarios

    The data alert plugin currently only supports email, message, platform notification, and client notifications for some apps. However, in practical applications, you may encounter complex warning notification scenarios. At the same time, most companies have their own OA or dedicated notification platforms. In order to meet the timeliness of warning information notification and better comply with different notification habits, the data alert plugin open interface supports notification on custom platforms or apps, improving the effectiveness of data alert.

    Setting Method

    For details about data alert plugin installation and permission configuration, see Data Alert Plugin.

    Setting Up Entrance

    Log in as the super admin, enter the decision-making platform, select Manage > Data Alert, click , and you can go to the Third-party alert app configuration page.

    Configuring the Page

    Click Add app to start configuration. You need to fill in the following configuration items according to the actual situation.

    Configuration Item

    Required or not

    Explanation

    App name

    Yes

    Can be customized.

    App description

    No

    Can be customized.

    App status

    Yes

    Single selection is required. Defaults to be enabled and cannot be deselected.

    ·If you select Enable, when creating an alert task, you can select Client Notification and choose the app on the push terminal.

    ·If you select Disable, when creating an alert task, you can select Client Notification, but the application name is invisible on the push terminal.

    Request URL

    Yes

    Can be customized.

    Request method

    Yes

    Single selection is required. It includes two methods: POST and GET.

    Defaults to POST request method and cannot be deselected

    Request header

    Yes

    Need to enter corresponding keys and values.

    · Click to add key-value pairs in the request header.

    · Click to delete key-value pairs, and keep at least one key-value pair.

    Some APIs require specific headers to be sent with the request, usually to provide more metadata about the   operation being performed. You can set these here by entering any key-value pairs you need.

    Request body

    Yes

    Can be customized. The content filled in the body will be sent as the notification body when the alert is triggered on the push terminal. Only supports JOSN/XML/TEXT and the following parameters:

    ·Trigger time: ${triggeredTime}, and the format is yyyy-MM-dd HH:mm:ss

    ·Warning name: ${taskName}

    ·Template location: ${templatePath}

    ·Access address: ${targetLink}, related platform address such as webroot/decision/view/report?viewlet=GettingStarted.cpt

    ·Triggerring conditions: ${ruleDescription}, configured condition description

    ·Recipient: ${receiveUsers}, the receiver string is concatenated with a half-width comma

    ·Number of data that meets the conditions: ${ruleMatchDataCount}

    ·Maximum value that meets the conditions: ${ruleMatchDataMax}

    ·Minimum value that meets the condition: ${ruleMatchDataMin}

    Demonstration

    After completing the configuration, if you have the data alert permission, you can tick App interface notification in Alert Notification > Notification type, and then select the corresponding app.


    Attachment List


    Theme: Rachel
    Already the First
    Already the Last
    • Helpful
    • Not helpful
    • Only read

    Doc Feedback