反馈已提交

网络繁忙

您正在浏览的是 FineBI6.1 帮助文档,点击跳转至: FineBI5.1帮助文档

管理应用接口

  • 文档创建者:April陶
  • 历史版本:14
  • 最近更新:wang-sd 于 2024-05-05
  • 1. 概述

    1.1 版本

    FineBI版本数据预警插件版本功能变更
    6.0.11V1.6.1
    6.0.11V1.6.2

    应用接口通知新增如下自定义变量:

    • 列表中最大值:${listMaxData} 

    • 列表中最小值:${listMinData} 

    • 预警任务ID:${taskID} 

    • 预警对象源:${taskSource} 

    • 预警任务创建人:${taskCreator} 

    • 是否生成待办:${createTodo} 

    • 预警待办责任人:${todoAssignee}

    • 预警待办解决时长:${daysToSolve} 

    6.0.16V1.7.0应用接口通知新增 abnormalData 自定义变量

    1.2 应用场景

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

    2. 设置方式

    需要完成数据预警插件安装以及权限配置,可参考:数据预警插件

    2.1 设置入口

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

    2023-04-20_16-50-18.png

    2.2 设置页面

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

    2023-07-10_13-54-20.png

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

    单选必选,默认选择启用状态,不可取消选择

    • 启用:用户创建预警时,勾选客户端通知,在推送终端可选该应用

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

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

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

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

    请求头

    需要输入对应的键和值

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

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

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

    请求body

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

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

    • 预警名称:${taskName}

    • 模板路径:${templatePath},

    • 模板目录显示名称:${displayname}

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

    • 触发条件:${ruleDescription},配置的条件描述

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

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

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

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

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

    • 列表中最大值:${listMaxData} 

    • 列表中最小值:${listMinData} 

    • 预警任务ID:${taskID} 

    • 预警对象源:${taskSource} 

    • 预警任务创建人:${taskCreator} 

    • 是否生成待办:${createTodo} 

    • 预警待办责任人:${todoAssignee}

    • 预警待办解决时长:${daysToSolve} 

    • 预警异常数据:${abnormalData} 

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

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

    2.3 设置预警

    完成配置后保存,拥有数据预警权限的用户可在「预警接收>接受方式」中勾选「应用接口通知」,即可选择对应的应用,如下图所示:

    2023-05-25_16-57-02.png


    2.4 效果预览

    完成预警任务创建后,用户在应用中实际接收到的内容 = 应用界面中填写的请求body」+ 预警创建页的通知内容。

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

    1689039382aBrB.png

    附件列表


    主题: 制作可视化组件

    鼠标选中内容,快速反馈问题

    鼠标选中存在疑惑的内容,即可快速反馈问题,我们将会跟进处理。

    不再提示

    10s后关闭



    AI

    联系我们
    在线支持
    获取专业技术支持,快速帮助您解决问题
    工作日9:00-12:00,13:30-17:30在线
    页面反馈
    针对当前网页的建议、问题反馈
    售前咨询
    采购需求/获取报价/预约演示
    或拨打: 400-811-8890 转1
    qr
    热线电话
    咨询/故障救援热线:400-811-8890转2
    总裁办24H投诉:17312781526
    提交页面反馈
    仅适用于当前网页的意见收集,帆软产品问题请在 问答板块提问前往服务平台 获取技术支持