1. 概述
本文将简单介绍插件的安装以及插件具体的功能详情。插件适用版本可参考:数据预警插件
1.1 视频介绍
2. 插件安装
2.1 获取插件
从官网新下载安装的 11.0.17 及之后版本,数据预警插件已经内置在工程中,无需安装。
11.0.17 之前版本或从其他小版本升级的工程,请前往帆软市场获取插件安装包:数据预警插件
2.2 插件安装
设计器插件安装方法参照:设计器插件管理
服务器安装插件方法参照:服务器插件管理
2.3 插件授权
使用该插件需要在 FineReport 的 License 注册中购买数据预警功能点,详情请咨询销售顾问。
工程未正式注册,安装数据预警插件可试用插件全功能。
工程已注册但未注册数据预警功能点,使用数据预警插件时仅支持创建两个预警任务。
3. 插件权限说明
3.1 创建预警任务权限
注:若需要在FVS模板中使用数据预警功能,则需要开通模板认证,可参考 3.1.2 节。
3.1.1 在数据决策系统中创建预警任务
1)插件安装完成后,超管需要在数据决策系统中为不同的用户分配报表的查看权限,详情可参考:目录查看权限。
例如:为用户 Tom 开通「条件查询与图表联动」模板的查看权限,如下图所示:
2)完成后,超管需要开启「分级授权」功能,如下图所示:
注:分级授权的需要注册「集团权限控制」功能点,如果没有注册,无法开启分级授权,只有超管用户可以创建预警。
3)超管需要在「普通权限配置」中为指定的用户开通「数据预警」权限,开通权限后用户即可在数据决策系统中使用数据预警功能。
例如:为用户 Tom 开通数据预警权限,如下图所示:
4)用户需要选择其他部门或角色作为数据预警任务的接收人,需要超管为用户开通对应部门或角色的「人员管理」权限,同时接受人开通对应报表的查看权限。
例如:Tom 需要选择开发部作为预警任务的接受人,需要为 Tom 开通开发部的人员管理权限,同时为开发部开通对应模板的预览权限,如下图所示:
3.1.2 在设计器或URL预览时创建预警任务
注1:超管需要对系统和相关人员配置好 邮箱 后才能使用数据预警功能。
1)插件安装完成后,超管需要开启「模板认证」功能,如下图所示:
2)后续步骤与本文 2.1 节一致。
3.2 订阅预警任务权限
超管需要为用户开通如下权限,用户才能订阅所有人可见的任务,如下所示:
数据预警使用权限
创建预警任务的报表的查看权限
3.3 管理预警任务权限
数据预警插件支持对预警任务、预警待办进行管理,详情可参考:管理预警任务
4. 功能说明
4.1 使用前提
1)模板类型和预览模式
对于普通报表:仅在「填报预览」、「分析预览」、「分页预览」模式下支持数据预警
对于决策报表:仅在「PC端预览」模式下支持数据预警
对于 1.6.2 及之后版本的数据预警插件,且 1.17.1 及之后版本的 FineVis 数据可视化插件:数据预警功能可在 FineVis 可视化看板中使用
2)模板内容元素
数据预警插件支持对数值类型的单元格以及扩展出来的单元格内容设置预警事件。如模板中不存在数值类型的单元格,无法创建预警
数据预警支持对饼图(不包含多层饼图)、柱形图、条形图、折线图、面积图、仪表盘及以上图表的组合图设置预警事件。不支持其他普通图表,不支持扩展图表类型中的任何图表
4.2 基础设置
「基本设置」主要包括:「预警状态」「预警名称」,「触发条件」、「检测通知」。若对图表创建预警任务则需要设置「图表类型」「分类」「系列」
「预警状态」:可以自定义预警任务的启用或停用。
「预警名称」:可以自定义预警任务名称。
「触发条件」:支持大于、小于、等于、不等于、大于等于、小于等于、介于、不介于、任一为空、全部非空多种触发条件。
「检测通知」:支持设置多种检测通知的频率,可选择每年/每月/每周/每天/每小时检测一次。如设置每小时00分检测一次,则每天的整点时刻都会执行检测。
注:如果使用了抽数缓存,当检测频率大于数据更新频率,会提示“当前检测频率过高,底层数据更新不及时”,建议选择低频的检测。
「图表类型」:对组合图创建预警任务时,需要选择创建预警任务的图表类型。
「分类」:选择图表中的数据分类。
「系列」:选择图表中的数据系列。
「重复通知免打扰」:开启后,若本次通知内容(数据部分)上次一致,则不再触发通知,直到下次数据更新后达到预警条件再次触发通知。
注:「重复通知免打扰」不支持动态接收人。
4.3 预警通知
「预警通知」主要包括:「接收人」和「通知方式」。
4.3.1 接收人
接收人:分为「指定接收人」和「动态接收人」。
注:接收人为动态接收人的预警任务不支持订阅。
接收人 | 详细说明 |
---|---|
指定接收人 | 可以根据用户、部门、角色设置接收人,支持多选接收人。 注:当设置者仅有某父部门的其中一个子部门的管理权限时, 11.0.28 及之前版本:数据预警接收人选择该子部门,父部门直属用户及全部子部门的用户均可收到预警通知。 11.0.29 及之后版本:数据预警接收人选择该子部门,仅该子部门用户可以收到预警通知。 升级前创建的数据预警任务,升级后不会自动切换接收人逻辑,可通过编辑并保存,即可优化。 |
动态接收人 | 可以根据用户、部门、角色设置接收人。
若报表里体现的部门名称是「技术支持」,那么会给所有的名称为「技术支持」的部门及其下子部门中的用户发送消息。例如:
注意事项:
|
注:用户创建预警时若需要选择其他角色作为接收人,需要管理员同时给用户开放对应角色的人员管理权限。
4.3.2 通知方式
接收方式:支持邮件、短信、平台通知、客户端通知、应用接口通知。
接收内容支持自定义编辑,支持引用变量。
变量名 | 变量值 |
---|---|
触发时间 | ${triggeredTime} |
预警名称 | ${taskName} |
模板路径 | ${templatePath} |
模板目录名称 | ${dispalyname} |
触发条件 | ${ruleDescription} |
触发预警条数 | ${ruleMatchDataCount} |
触发预警最大值 | ${ruleMatchDataMax} |
触发预警最小值 | ${ruleMatchDataMin} |
列表中最大值 | ${listMaxData} |
列表中最小值 | ${listMinData} |
监控目标链接 | ${targetLink} |
所有接收者 | ${receiveUsers} |
1)邮件:触发预警条件后,将通过邮件发送通知。
注:通过邮件通知,超管需要对系统和相关人员配置好邮箱后才能使用数据预警功能。,否则将会出现提示:系统未配置发件人邮箱,保存失败。配置发件人邮箱可参考: 邮箱
邮件支持「其他内容」设置,默认为「结果链接」,如下图所示:
「结果链接」:将报表内容在邮件中显示为超链形式。
「预警对象」:将报表内容在邮件中显示为图片形式。
2)短信:若通过短信通知,数据决策系统需要配置短信,否则将会出现提示:系统未配置短信服务,无法通过短信接收预警。
短信如何配置可参考:配置短信平台,短信的相关收费规则可参考:短信收费规则。
注:短信通知不支持自定义文本消息内容。
3)平台通知:触发预警条件后,将通过平台发送通知,设置如下图所示:
4)客户端通知:触发预警条件后,将通过 APP 发送通知。支持钉钉、飞书、微信、App通知四种方式,需要先进行集成后才可使用。
根据客户端的通知方式,默认将报表内容在通知中显示为超链形式,或设置为「预警对象」将报表内容在通知中显示为图片形式。
注1:当预警对象为表格内容时,客户端的通知无法将报表内容在通知中显示。
注2:动态接收人存在多个接收用户对应多个通知内容时,可能会出现高频调用客户系统接口的情况,需要客户系统放开限制。
5)应用接口通知:支持通知到自定义的平台或应用。详细配置可参考:应用接口配置
4.4 更多设置
「更多设置」主要包括:「隐私设置」和「预警待办」。
隐私设置 | 支持设置为公开或仅自己和接收人可见。 当设置为公开时,拥有数据预警权限和报表查看权限的用户可查看此任务,并订阅此任务,订阅后用户可收到数据预警通知。 |
预警待办 | 预警触发之后会形成待办,发送给责任人进行处理,并设置触发预警后需要解决问题的时间。 |
注:超管需要为责任人开通数据预警权限后,责任人才能处理预警待办。
4.5 预警管理
通过「管理系统>数据预警」或在报表页面中点击「管理预警任务」即可进入任务管理界面。
任务管理界面主要包括:「我创建的预警」、「我接收的预警」、「其他用户创建的预警」、「预警待办中心」,如下图所示。
「我创建的预警」:可立即执行预警任务一次,支持启用或停用预警任务,可以查看任务的历史趋势图、预览模板,或删除预警任务。
「我接收的预警」:可以查看任务的历史趋势图以及预览模板,或取消订阅任务。
「预警待办中心」:可以查看相关待办的处理状态以及预计解决时间。
「其他用户创建的预警」:仅超管拥有此功能,可删除其他用户创建的预警任务,或查看预警任务的模板和历史趋势图。
其中历史趋势图可以根据触发条件不同展示不同的效果,如下表所示:
判断条件 | 展示内容 |
---|---|
大于、小于 | 极值(包括极大值和极小值) |
等于、不等于 | 符合触发条件的数据个数 |
大于等于、小于等于 | 极值(包括极大值和极小值) |
介于、超出范围 | 极值(包括极大值和极小值) |
任一为空,全部非空 | 符合触发条件的数据个数 |