历史版本17 :应用接口配置 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

1. 概述编辑

1.1 版本

报表服务器版本插件版本
11.0.91.6.1

1.2 应用场景

数据预警插件目前仅支持邮件、短信、平台、部分客户端通知。但在实际应用中经常会遇到复杂的预警接收场景，同时大部分公司内部都会有自己的 OA 或者专用通知平台，为满足预警信息通知的及时性以及更符合用户接收通知的习惯，数据预警插件开放接口支持通知到自定义的平台或应用，提高数据预警效果。

2. 设置方式编辑

需要完成数据预警插件安装以及权限配置，可参考：数据预警插件简介

2.1 设置入口

超管登录数据决策平台后，选择「管理系统>数据预警」，点击设置按钮，即可进入「第三方预警应用」设置界面，点击添加「添加应用」即可开始进行配置，如下图所示：

2023-03-29_11-28-10.png

2.2 设置页面

点击添加「添加应用」即可开始进行配置，用户需要根据实际情况填写如下配置项，如下表所示：

2023-07-12_17-20-46.png

配置项是否必填说明
应用名称是用户可自定义输入应用名称
应用说明否用户可自定义输入应用说明
应用状态是

单选必选，默认选择「启用」状态，不可取消选择

  • 启用：用户创建预警时，勾选「客户端通知」，在推送终端可选该应用

  • 停用：用户创建预警时，勾选「客户端通知」，在推送终端该应用名不可见

请求地址URL是用户可自定义输入请求地址URL
请求方式是

单选必选，分为 POST 和 GET 两种方式。

默认选择 POST 请求方式，不可取消选择

请求头是

需要输入对应的键和值

  • 点击“＋”可添加请求头中的键值对。

  • 点击“－”可删除已编辑的键值对，最少保留 1 条键值对。

某些 API 要求随请求一起发送特定标头，通常是为了提供有关正在执行的操作的更多元数据，可以在这里设置这些，输入您需要的任何键值对。

请求body是

用户可自定义输入，在 body 中填入的内容将作为通知正文内容在预警触发时发送到推送终端，仅支持 json / xml / text，同时支持如下参数：

  • 触发时间：${triggeredTime}，格式为yyyy-MM-dd HH:mm:ss

  • 预警名称：${taskName}

  • 所在模版：${templatePath}，模版路径

  • 访问地址：${targetLink}，平台相对地址如webroot/decision/view/report?viewlet=GettingStarted.cpt

  • 触发条件：${ruleDescription}，配置的条件描述

  • 接受人：${receiveUsers}，接受者字符串使用半角逗号","拼接

  • 满足条件的数据个数：${ruleMatchDataCount}，个数

  • 满足条件的最大值：${ruleMatchDataMax}

  • 满足条件的最小值：${ruleMatchDataMin}

  • 获取预警创建页的通知内容：${notifyContent} ，

若在请求body中添加了 ${notifyContent} 参数，则完成预警任务创建后，在应用中实际接收到的内容 = 应用界面中填写的「请求body」+ 预警创建页的通知内容。

若不添加${notifyContent}参数，则在应用中实际接收到的内容 = 应用界面中填写的「请求body」。

2.3 设置预警任务

超管完成应用配置后，拥有数据预警权限的用户即可在「预警通知>通知方式」中勾选「应用接口通知」。

基本设置可参考：创建预警任务示例

在「预警通知>通知方式」中勾选「应用接口通知」，即可选择对应的应用，如下图所示：

2023-07-10_11-32-41.png

2.4 效果预览

超管在应用配置界面的「请求body」中填写必要的通知内容，用户在「预警通知」中自定义通知内容，使通知内容更灵活。如下图所示：