1. 概述
1.1 功能简介
本文将简单介绍插件的安装以及插件具体的功能详情。插件适用版本可参考:数据预警插件简介
1.2 注意事项
1)只支持使用仪表板内的表格、折线图、柱形图、仪表盘、KPI指标卡和折线图与柱形图组合的自定义图表设置预警。
2)数据预警任务支持邮件、短信、平台通知、客户端通知、应用接口通知五种方式。客户端通知支持钉钉、飞书、微信、App通知四种方式,需要先进行集成后才可使用。
3)任务创建者和接收人需要绑定邮箱/短信,否则悬浮接收人右侧的小感叹号提示“未绑定邮箱、电话号码的用户无法通过对应渠道接收预警信息”。绑定邮箱可参考:用户设置 。
4)公共链接分享的仪表板,没有数据预警按钮。
5)为防止宕机并优化性能,经过维度过滤后的数据最多能支持 100W 条参与预警计算。
1.3 参数设置
1.3.1 数据预警是否保留仪表板过滤效果
6.0.14在 fine_conf_entity可视化配置 新增参数 SystemOptimizationConfig.useAllVisibleDataForSentinel 控制数据预警的数据是否保留仪表板的过滤效果。
参数名 | 参数描述 | 参数值 |
---|---|---|
SystemOptimizationConfig.useAllVisibleDataForSentinel | 数据预警对模板过滤条件是否保留 | 参数值需为布尔型,默认为true true:应用全量仪表板数据(用户可见即可用) 参数值为true时,应用全量仪表板数据(用户可见即可用) false:保留仪表板默认过滤情况,用户仅可使用仪表板默认展示数据进行预警,预览时调整的过滤条件不生效 |
1.3.2 异常数据推送条数控制
fine_conf_entity可视化配置 新增参数 SentinelConfig.showDetailAbnormalData 控制数据预警「异常数据」推送的是全部异常数据还是部分异常数据。
参数名 | 参数描述 | 参数值 |
---|---|---|
SentinelConfig.showDetailAbnormalData | 控制数据预警「异常数据」推送显示全部异常数据还是只保留1条异常数据 | 参数值需为布尔型,默认为true true:“异常数据”变量中的内容包含全部异常数据 false:“异常数据”变量中的内容包含对应条件下的异常数据 |
使用说明:
「异常数据」显示全部异常数据时,推送的内容会逐条显示异常数据信息。如下图所示:
推送全部异常数据可能会导致内容超长无法接收到消息
针对「异常数据」变量截取5000个字符,超出5000字符的部分不生成通知内容,不影响其他内容长度
2. 安装插件
2.1 安装插件
1)获取插件:数据预警插件
2)进入「管理系统>插件管理>从本地安装」插件。详情可参考文档:插件管理
3)如果希望超管之外的用户也能使用数据预警插件。需要先对其进行权限配置。详情见第3章。
2.2 插件授权
使用该插件需要在 FineBI 的 License 注册中购买数据预警功能点,详情请咨询销售顾问。
工程未正式注册,安装数据预警插件可试用插件全功能。
工程已注册但未注册数据预警功能点,使用数据预警插件时仅支持创建两个预警任务。
3. 插件权限说明
3.1 创建预警用户
超管如果需要给其他用户「创建预警」的权限。需要在「管理系统」中分配权限。
1)插件安装完成后,管理员需要在为不同的用户分配报表的查看权限,详情可参考:目录查看权限。
2)该插件安装成功后。
平台上的模板、通过目录访问的模板,可以直接使用预警功能
把BI仪表板集成到其他系统直接预览,需要开启「模板认证」功能。
3)管理员对其设置数据预警权限。
该插件安装成功后,需要开启「分级授权」功能,并在「普通权限配置」中对相关人员开通「数据预警」权限后才能使用。
①设置分级授权。如下图所示:
注:分级授权的需要注册「集团权限控制」功能点,如果没有注册,无法开启分级授权,只有超管用户可以创建预警。
②打开数据预警权限。如下图所示:
3.2 普通用户
如果未进行权限配置,支持接受消息提醒。
3.3 订阅用户
超管需要为用户开通如下权限,用户才能订阅所有人可见的任务。
数据预警使用权限
创建预警任务的仪表板的查看权限
注:配置了动态接收人的预警任务不支持订阅。
3.4 超级管理员
1)超管有插件的最高权限,可创建、管理任务。
2)超管在管理预警任务时,还能够管理其他用户创建的任务。如下图所示:
3)超管还支持进行「预警设置」,配置第三方预警应用信息。详情见:数据预警接口
4. 功能介绍
4.1 功能入口
1)安装预警插件后,在分析主题的仪表板预览处出现「创建预警」按钮,提示用户可创建预警任务。
2)仪表板界面也有入口进入。如下图所示:
3)目录中的仪表板也支持数据预警。如下图所示:
点击「创建预警」之后,可以看到界面如下:
如果仪表板已添加数据预警条件,并且「隐私设置」为所有人可见。
用户在预览仪表板时,可以在「创建预警」界面,添加「订阅」关注数值变化。如下图所示:
4.2 创建预警任务
预警任务设置主要分为三部分:「基本设置」、「预警通知」、「更多设置」。点击「创建预警任务」进入设置界面。
4.2.1 基础设置
1)「预警名称」:可以自定义预警任务名称。
2)「选择组件」:可以选择仪表板内表格、图表组件。
(目前支持创建数据预警的组件:表格、折线图、柱形图、仪表盘、KPI指标卡和折线图与柱形图组合的自定义图表。)
3)「维度」:选择表格组件下的维度字段并添加条件。(不支持设置了钻取的字段)
若维度是日期字段,可以选择「日期范围/最近N条数据」设置预警范围。
最近N条数据实际就等于动态时间,比如仪表板的数据是以天为粒度的,最近2条数据就是对仪表板里的数据以日期做排序取top2的效果,相当于最近2天的数据。
注:字段来源于明细表时,不支持设置「最近N条数据」。
因为最近N条数据,本质上是在做topn排序后选最近N条,而明细表不支持topn的功能。
4)「触发条件」:仅支持选择数值字段。①支持添加多个条件,并选择是「满足所有条件」或「满足任一条件」;②判断方式支持大于、小于、等于、不等于、大于等于、小于等于、介于、不介于、任一为空、全部非空多种触发条件。
5)「检测通知」:支持设置多种检测频率。可选择每年/每月/每周/每天/每小时检测一次。如设置每小时00分检测一次,则整点时刻都会执行检测。开启重复通知免打扰:若数据检测与上次通知内容一致,则不再触发通知。
4.2.2 预警通知
接收人
接收人主要包括:「接收人」和「通知方式」。
「接收人」:支持设置「指定接收人」和「动态接收人」。
注:如果选择不到想要的接收人,是因为管理员没有给用户授予对应的「人员管理的管理权限」,需要联系企业管理员设置。
接收人 | 详细说明 |
---|---|
指定接收人 | 可以根据用户、部门、角色设置接收人,支持多选接收人(勾选谁通知谁)。 注:当设置者仅有某父部门的其中一个子部门的管理权限时, 6.1.2及之前版本:数据预警接收人选择该子部门,父部门直属用户及全部子部门的用户均可收到预警通知。 6.1.3及之后版本:数据预警接收人选择该子部门,仅该子部门用户可以收到预警通知。 升级前创建的数据预警任务,升级后不会自动切换接收人逻辑,可通过编辑并保存,即可优化。 |
动态接收人 | 可以根据用户、部门、角色设置接收人
若部门名称是「技术支持」,那么会给所有的子节点(最下层节点)为「技术支持」的部门发送消息。 若部门的结构是「帆软-华东-技术支持」,那这个部门里的用户都会收到消息(技术支持是最下层的节点)。 若部门的结构是「帆软-华东-技术支持-技术支持A组」,仅「技术支持A组」可以收到消息。
用户-按钮-用户名 点击按钮可以进行组件里面用户列的选择,选中的用户列和平台的用户信息做匹配,匹配到的用户+用户所在维度的指标触发了预警 = 该用户收到通知 注意事项:
|
通知方式
支持邮件、短信、平台通知、客户端通知、应用接口通知。
注1:客户端通知支持钉钉、飞书、企业微信、App通知,需要先进行集成后才可使用。
注2:应用接口通知需要管理员在「管理系统>数据预警>预警设置」中添加 第三方预警应用 后,才可使用。
文本内容 |
可以引用的变量有:预警名称、所在模板、触发维度、触发条件、触发时间、满足条件数据个数、满足条件最大值、满足条件最小值、异常数据 注:短信不支持自定义文本内容。 若添加变量「异常数据」,支持自定义异常数据通知显示的维度字段。 当预警对象为「数量」,选择「是否已交货、合同类型」,预警条件为是否已交货为否、合同类型为购买合同时,最大异常数据量为172.0。效果如下图所示: 注:默认只显示一条异常数据,示例显示的是3条预警数据中的最大值。如果需要显示所有异常数据可修改参数配置,详情参见 1.3.2 节。 |
其他内容 | 其中邮件支持「其他内容」设置,可选择「结果链接」或「预警对象」,默认为「结果链接」。
|
4.2.3 更多设置
「更多设置」主要包括:「隐私设置」和「预警待办」。
隐私设置 | 支持设置为公开或仅自己和接收人可见; 当设置为公开时,拥有数据预警权限和报表查看权限的用户可查看此任务,并订阅此任务,订阅后用户可收到数据预警通知 |
预警待办 | 预警触发之后会形成待办,发送给责任人进行处理,并设置触发预警后需要解决问题的时间 |
注:超管需要为责任人开通数据预警权限后,责任人才能处理预警待办。
4.3 管理预警任务
4.3.1 功能入口
1)仪表板预览界面
2)管理系统界面
4.3.2 功能介绍
任务管理界面主要包括:「我创建的预警」、「我接收的预警」、「其他用户创建的预警」、「预警待办中心」,如下图所示:
「我创建的预警」:可以查看任务的历史趋势图以及预览模板,或删除预警任务、立即执行任务。
「我接收的预警」:可以查看任务的历史趋势图以及预览模板,或取消订阅任务。
「预警待办中心」:可以查看相关待办的处理状态以及预计解决时间。
「其他用户创建的预警」:仅超管拥有此功能,可删除其他用户创建的预警任务,或查看预警任务的模板和历史趋势图。
详情请参见:管理预警任务
注:仪表板上添加的数据预警任务在仪表板删除后,在数据预警任务管理界面依旧显示任务,需要用户手动删除。
5. 示例
示例详情参见文档:数据预警插件示例、【动态接收人】数据预警插件示例