1. 概述
1.1 版本
报表服务器版本 | 插件名称 | 插件版本 | 功能变动 |
---|---|---|---|
11.0 | 模板消息事件 | V1.7.5 | - |
注:安装此插件必须开通 WebSocket 端口,否则平台消息提醒时不会弹出提示框,详情参见文档:WebSocket端口未开放提醒
1.2 应用场景
实时推送消息至移动端,可以做到信息的快速传输。无论是一线人员还是企业管理者,都可以随时随地通过手机了解业务状态,提高数据的信息价值。
员工进行信息填报后,需要实时推送微信消息,告知上级及时审批。
领导填写信息后,可以选择不同责任人,责任人第一时间收到消息提醒和对应任务。
银行登记 ETC 客户后,需要将 ETC 客户情况实时推送给领导,领导可以及时了解到 ETC 客户信息。
1.3 功能简介
模板消息事件支持移动端,填报成功后,即时推送消息至 App、微信、钉钉,让消息的快速和精准传递变得更加简单。
通过 模板消息事件 插件、钉钉管理 插件、微信管理 插件,达成此功能。
1.4 注意事项
1)若微信钉钉集成要通过模板消息事件插件发送单个模板的链接。支持在集成插件中,直接生成单个模板访问链接,并为模板设置参数,在本文 3.1.2 节使用。不需要自己拼接链接。
2)模板消息插件不支持推送至二级及以下部门用户。
2. 插件介绍
2.1 准备工作
安装「 模板消息事件 」插件。
若要推送至 App,需安装并配置好 App ,参考文档:App 使用
若要推送至微信钉钉,需安装 钉钉管理 插件、微信管理 插件并绑定数据决策系统。建议设置好单点登录。
2.2 模板消息设置入口
1)右击某一单元格,选择「控件设置>事件编辑」,新增事件中,增加「模板消息」,如下图所示:
2)点击「菜单模板>模板 Web 属性」,三种预览方式下的「事件设置」中都增加「模板消息」,如下图所示:
3. 示例
下面以一个简单的实例进行说明,填报成功后,通知对应人查看模板。
3.1 添加模板 Web 属性
打开模板:%FR_HOME%\webapps\webroot\WEB-INF\reportlets\doc\Form\LineForm\LineForm.cpt
点击「模板>模板 Web属性」,选择「填报页面设置」,选择「为该模板单独设置」,添加「填报成功」事件,事件类型为「模板消息」,如下图所示:
3.1.1 设置消息接收对象
模板消息可以发送给平台用户、角色和机构部门,最终接收对象为三项的并集。
这里以用户做示例,发送模板消息给 Alice 。
注:可以输入多用户,以逗号隔开,例如:用户1,用户2,用户3。
注:用户、角色、部门不能同时为空。
3.1.2 填写消息内容
1)客户端:
默认支持 PC 平台及 App 。用户可通过安装钉钉 / 微信管理插件,增加微信 / 钉钉客户端。
「微信/钉钉应用」选择框下拉读取微信/钉钉插件中配置的应用名称。
不勾选微信/钉钉复选框时,微信 / 钉钉应用下拉框灰化不可编辑。
2)链接:
示例:decision/view/report?viewlet=LineForm.cpt&op=h5
表示模板消息发送后打开的模板,该模板以「分页预览」的方式打开。
链接不能为空。
注1:通过“生成钉钉链接”,参数名和参数值中都不能包含中文,否则 PC 端传参会失败。
注2:微信钉钉集成后,如果想生成模板推送链接,在「应用快捷配置」中「生成单个模板链接」,同时可以为模板添加设置参数。微信集成参见文档:企业微信集成 2.2.3 节;钉钉集成参见:钉钉管理插件 2.7.2 节。
3)标题:模板消息发送的标题。
4)内容:消息提示内容。
5)封面图:
选填建议尺寸 640*320,即宽高比 2:1,5M 以内 JPG、PNG 格式图片。
选择图片后显示样式为适应。
封面图只在微信、钉钉中有效
如下图所示:
注:链接、标题、内容中都支持输入公式。使用参数时,参数默认值只能取到模板参数和全局参数,数据集参数默认值获取不到
注:链接、标题、内容中如有中文或特殊字符(如+ \ /)等需要正确转换
3.1.3 模板消息事件全局校验
模板消息事件的设置需满足以下条件,按照优先顺序,只提示第一个错误信息。
优先级 | 校验对象 | 提示信息 |
---|---|---|
1 | 消息接收对象不允许为空 | 用户名、角色和部门不能同时为空 |
2 | 应用不允许为空 | 请设置推送的微信应用/钉钉应用 |
3 | 链接不允许为空 | 链接不能为空 |
4 | 标题不允许为空 | 标题不能为空 |
5 | 内容不允许为空 | 内容不能为空 |
3.2 决策系统中添加模板
设置完点击事件后,将模板保存。启动内置服务器。
在浏览器中输入 http://localhost:8075/webroot/decision ,登录管理员账号,打开 FineReport 报表平台。
点击「管理系统>目录管理」将报表添加到决策系统中。
打开模板,修改数据后,点击提交,跳出「消息发送成功」提示,即将消息发送给 Alice,如下图所示:
注:如果消息不在平台里发送,单独访问模板时发送,取不到用户时,跳出「消息发送失败,无发送者」提示。如下图所示:
3.3 效果查看
3.3.1 PC 端
登录 Alice 的账号,模板消息已经发送过来,点击右上角,点击「我的消息>模板消息>处理」,即可跳转到对应模板。
或者直接点击右下角新消息的「处理」,即可跳转到对应模板。如下图所示:
3.3.2 App
使用与 Alice 匹配的账号登录 App ,可以在消息中看到模板消息事件通知。如下图所示:
3.3.3 微信
使用与 Alice 匹配的账号登录企业微信,可以看到绑定的应用发送了模板消息事件通知,点击即可查看。如下图所示:
3.3.4 钉钉
使用与 Alice 匹配的账号登录钉钉,可以看到绑定的应用发送了模板消息事件通知,点击即可查看。如下图所示: