【已下架插件文档】第三方消息接口集成插件
该插件目前已下架帆软市场,本文档仅提供给历史使用了该插件的客户,帆软目前不再提供该插件的任何获取渠道。
1. 概述
1.1 版本
报表服务器版本
插件版本
11.0.5
V1.0
1.2 应用场景
与第三方短信接口或者消息接口对接,发送消息
1.3 功能描述
需要有【短信平台】功能点
支持阿里云短信接口和http服务接口
支持发送系统短信提醒
支持定时任务发送消息
2. 插件介绍
2.2.1 全局设置
在决策平台的<管理系统>-<第三方消息>中,点击左上角齿轮图标,显示页面,如下图所示
(1)、发送系统短信提醒:若启用,则对接的第三方消息接口可以发送系统短信提醒,此处优先级最高
(2)、公共参数:消息配置里面使用的公共变量,针对多次用到的一样值的公共变量,可以在这使用设置,且后配置的公共参数可以引用先配置的公共参数
若是冒号(:)为分隔符,则为常量,不进行任何处理 例如 a:sfdsf
若是井号(#)为分隔符,则为对进行转义符合处理,换行符(\n),制表符(\t),不进行公式计算 例如 a#sfd\nsf
若是等号(=)为分隔符,则进行公式计算 例如 a=now()
2.2.2 消息接口管理
(1)、在决策平台的<管理系统>-<第三方消息>-<所有消息配置>中,如下图所示
添加消息配置:新增消息接口配置
编辑按钮:编辑消息接口配置
状态按钮:禁用或启用消息接口配置
删除按钮:删除消息接口配置
(2)、消息接口配置
公共配置如下所示
消息编号:消息接口的唯一标识,不区分大小写
消息类型:http服务和阿里云短信服务
消息说明:消息的简单介绍
发送短信提醒:消息接口是否发送系统短信提醒
消息签名名称:阿里云接口短信服务需要用
模板编号对照表:系统内置短信编号与消息接口的消息编号对照,作为系统内置短信编号转为消息接口的消息编号的字典,在发送系统短信消息时使用; 格式为 内置短信编号=消息接口的消息编号;多个则要换行隔开
消息类型为http服务的配置,如下图所示
对于http服务的接口,请用postman工具测试通过再添加到消息配置里
http服务请求方法:支持GET和POST方法
http服务地址:支持公式
http服务请求头:格式为 key:value ,多个用换行隔开,支持公式
http服务请求类型:包含无,form-data,x-www-form-urlencoded,任意格式的文本
http服务请求内容:当http服务请求类型为form-data和x-www-form-urlencoded时,格式为 key=value,支持公式
http服务请求内容编码:UTF-8,GBK
消息类型为阿里云短信服务的配置,如下图所示
密钥编号:阿里云分配的密钥编号
密钥:阿里云分配的密钥
接入地址:阿里云短信服务的接入地址,可为空
2.2.3 定时任务发送消息
在决策平台的<管理系统>-<定时调度>-<文件处理>中的<处理方式>选择<第三方消息>,如下图所示
(1)、如上图位置1和位置2的配置项说明
消息编号:消息接口的唯一标识
手机号:发送消息的手机号,多个用逗号隔开
消息模板编号:消息接口的模板编号
消息模板参数:消息接口的模板参数
消息模板参数名称:消息接口的模板参数名称,多个名称用竖线隔开
消息模板参数值:消息接口的模板参数值,多个名称用竖线隔开
消息内容:要发送的内容,支持公式
(2)、数据集配置说明
数据集配置字段不用所有都要选择对应数据集字段,可为<不选>,但必须至少有一个配置字段要选择数据集字段
在生成实际配置信息时,是以位置1的配置数据为模板,将数据集的配置信息将其对应替换后,最终生成对应配置信息
2.2.4 内置参数
序号
参数名称
参数说明
1
third_party_message_fr_username
用户名
2
third_party_message_fr_real_name
用户姓名
3
third_party_message_email
邮箱
4
third_party_message_mobile
手机号码
5
third_party_message_fr_sms_template_id
系统短信模板编号
6
third_party_message_fr_sms_content
系统短信内容
7
third_party_message_template_id
消息模板编号
8
third_party_message_template_params
消息模板参数
9
third_party_message_template_param_names
消息模板参数名称
10
third_party_message_template_param_values
消息模板参数值
11
third_party_message_template_content
消息模板内容
这些参数可以在http服务接口中使用
2.2.5 短信事件
在报表模板的控件事件里面等事件里面发送短信
在事件中选择<第三方消息>,如下图所示
(1)、用户
用户名:发送消息的用户,多个用逗号隔开,支持公式
部门名称:发送消息的部门名称,根据部门名称获取当前部门以及子部门的所有用户,多个用逗号隔开,支持公式
角色名称:发送消息的角色名称,根据角色名称获取当前角色的所有用户,多个用逗号隔开,支持公式
手机号:发送消息的手机号,多个用逗号隔开,支持公式
(2)、配置
消息编号:消息接口的唯一标识,支持公式
消息模板编号:消息接口的模板编号,支持公式
消息模板参数:消息接口的模板参数,支持公式
消息模板参数名称:消息接口的模板参数名称,多个名称用竖线隔开,支持公式
消息模板参数值:消息接口的模板参数值,多个名称用竖线隔开,支持公式
(3)、消息内容
消息内容:要发送的内容,支持公式
3. 示例
3.1 http服务
例如:
接口地址为http://localhost:8075/webroot/decision/url/message/test/send
请求方法为post
请求内容
<message>
<mobile>手机号</mobile>
<content>短信内容</content>
</message>
消息配置如下
http服务请求内容为
<message>
<mobile>${third_party_message_mobile}</mobile>
<content>${third_party_message_template_content}</content>
</message>
3.2 阿里云短信服务
主要针对阿里云短信服务发送报表平台内置短信时,申请阿里云短信模板时,要和文末的内置短信模板里的参数一样才行
例如: 内置短信模板
消息编号
消息内容
20
您的手机验证码为#verifiecode#,请于10分钟内正确输入。
申请阿里云短信模板时,参数必须为verifiecode
消息配置里面的模板编号对照表填写如下
4. 注意事项
(1)、在决策平台中,<管理系统>-<注册管理>-<功能列表>的<已注册功能点>中必须有<短信平台>模块,插件才能正常使用
(2)、在测试发送消息时,请将日志等级改为INFO,方便排除问题,如下图所示
5. 内置短信模板列表
序号
消息编号
消息内容
1
10
尊敬的管理员,#taskname#于#time#运行失败,请知晓。
2
11
尊敬的#name#,您有一个工单号为:#order_number#的待处理工单,请您及时处理!
3
13
您好,#webname#系统内存持续#m#分钟内存高于#n#,可能存在宕机风险,请及时关注。
4
14
尊敬的管理员,#taskname#于#time#运行失败,请知晓。
5
15
您好,#taskname#于#time#运行成功。
6
16
您的手机验证码为#Verifiecode#,请于10分钟内正确输入。
7
17
您好,#webname#系统内存持续#m#分钟内存高于#n#,可能存在宕机风险,请及时关注。
8
18
恭喜!您的短信服务已经配置成功。
9
20
您的手机验证码为#verifiecode#,请于10分钟内正确输入。
10
49
您好,#webname#系统日志文件已大于#logsize#M,请及时登录平台进行日志清理。
11
50
您好,#webname#系统#clustername#内存持续#m#分钟内存高于#n#,可能存在宕机风险,请及时关注。
12
51
你好,#task#出错,请及时处理。该任务开始执行时间:#time#
13
54
#name#您好,上报任务#task#已经发起,请尽快处理!
14
63
节点#nodename2#,与节点#nodename1#系统时间相差超过#time_different#秒,为避免影响用户使用,请及时调整使各节点时间保持一致。
15
64
节点#nodename#已脱离集群环境,可能原因为:节点FullGC、节点宕机、节点间通信不畅、节点负载过高、其他异常。为避免影响用户使用,请及时检查该节点状态,若该节点长时间无法自行恢复,则建议重启该节点。
16
89
节点#nodename#,与节点#node1name#的jar包不一致,将影响集群工程的稳定性,请前往集群节点管理页面查看详细异常信息,并及时处理。
17
90
节点#nodename#情况异常,用户不能正常访问,请及时检查该节点状态。
18
125
您有个#proname#任务即将过期,请您尽快办理。
19
134
Redis集群#ip_port#节点已无法正常使用,可能原因为:节点宕机、内存已满、其他异常。为避免影响用户使用,请前往状态服务器配置页面查看详情,并及时处理。
20
135
文件服务器出现无法读写的情况,可能原因为:文件服务器宕机、磁盘已满、其他异常。为避免影响用户使用,请及时检查文件服务器状态。
21
136
您好,#webname#系统#clustername#当前负载状态过高,可能存在宕机风险,请及时关注。建议使用管理系统-智能运维-云端运维功能分析当前系统存在的性能问题。
22
239
您好,预警任务#warningname#达到阈值被触发,请及时关注!模板路径:#templatePath#
23
264
更新任务「#job_name#」结束。任务开始于#year#年#month#月#day#日#hr_min#,累计耗时#c_hr#时#c_min#分#c_sec#秒,完成任务:基础表更新 #success_basetable#/#total_basetable# ,自助数据集更新 #success_dataset#/#total_dataset# , 关联更新 #success_relation#/#total_relation#。
24
265
报表系统已宕机,请访问运维工具关注问题处理状态或及时进行系统重启。
25
266
报表系统已宕机,自动重启系统失败,请及时进行手动重启。
26
269
检查到系统环境配置存有不合理项,请及时查看并改正不合理项。
27
276
你好,备份失败,请及时处理,备份时间:#time#
28
367
集群节点#node_name#与基准节点存在不一致文件,且无法自动同步。请检查该节点状态
29
368
集群节点#node_name#与基准节点存在不一致文件,已自动同步与基准节点一致,不一致文件备份在该节点工程WEB-INF/#directory#/下
30
509
尊敬的管理员,用户管理-同步用户于#time#运行失败,可手动触发同步,以查看详细报错。
31
550
Dear administrator, "User>Sync user" failed to run at #time#, you can trigger the sync manually to view the detailed error report.
32
551
尊敬的管理員,使用者管理-同步使用者於#time#執行失敗,可手動觸發同步,以檢視詳細報錯。
33
573
您好,#etltask# 运行失败,开始执行时间为 #begintime#,结束时间为 #endtime#,请前往 -- 查看详情。
34
587
您好,检测到系统有宕机记录,请访问管理系统——智能运维——宕机处理页面中的宕机自助向导,查看宕机原因,并依据推荐解决方案进行处理
35
600
尊敬的#name#,#taskname#于#time#已更新,请及时关注。
36
602
#date#日有#templatecount#张模板在使用中出现共#errorcount#次报错,请至智能运维-平台日志中查看并处理模板报错。
37
605
您好,#webname#中,生成数据-定时计算任务“#taskname#”执行异常,生成数据失败。请及时登录系统处理
38
606
您好,#webname#中,生成数据-定时计算任务“#taskname#”执行成功,已完成#dataTypeText#(#dateRangeText#)数据计算
39
613
您的授权许可将于#remainDay#天后过期,请尽快重新授权。
40
631
Your license will expire in #remainDay# day(s). Please register again as soon as possible.
41
632
您的授權許可將於#remainDay#天后過期,請儘快重新授權。
42
998
节点#nodename1#与节点#nodename2#之间通信异常,无法加入节点管理,请检查集群节点间通信端口是否已开放。
43
999
节点#node_name#的#type#模块存在异常,暂无法正常提供服务,请及时对异常状况进行排查
44
1016
您的#fileName# 文件已经导出完成,可以在文件中心进行文件下载。
45
1017
当前#nodeName# #diskName#目录磁盘空间不足,仅剩余#usableSpace#GB,请尽快扩容磁盘或及时清理。
46
1036
#user#在报表#reportPath#中增加了评论,评论内容为:#content#
47
1089
管道任务 #jobname# 异常中止,可能是脏数据达到阈值或其他导致任务无法继续运行的异常因素,请及时处理。
48
1090
#taskName# 任务更新成功
49
1091
#taskName# 任务更新失败,失败模块为#moduleName#
50
1106
所在模板:#templatename#\n当前数值:#number#\n触发条件:#condition#\n点击链接查看模板:#url#
51
1109
预警名称:#taskname# \n所在模板:#templatename# \n当前数值:#number# \n触发条件:#condition# \n点击链接查看模板:#url#
52
1140
您好,管道任务「#taskname#」中,数据源表「#tablename#」#changetype#,#applyresult#,请前往「任务运维」-「管道任务」模块,在对应管道任务日志中查看详情。
53
1141
预警已生成对应待办,目前您是责任人,请在“管理预警任务-预警待办中心”及时进行处理。
54
1227
预警名称:#taskname# \n所在模板:#templatename# \n触发条件:#condition# \n点击链接查看模板:#url#
55
1230
您好,定时任务「#etltask#」 运行失败,开始执行时间为 #begintime#,结束时间为 #endtime#,请前往「任务运维-定时任务-运行记录」查看详情。
56
1261
您好,定时任务「#etltask#」 运行失败,开始执行时间为 #begintime#,结束时间为 #endtime#,#errormessage#。更多信息请前往「任务运维-定时任务-运行记录」查看详情。
57
1278
您好,#etltask# 运行失败,开始执行时间为 #begintime#,结束时间为 #endtime#,请前往「任务运维-数据开发-运行记录」查看详情。
58
1279
您好,#etltask# 运行失败,开始执行时间为 #begintime#,结束时间为 #endtime#,请前往「数据开发-任务运维-运行记录」查看详情。
59
1280
#taskname#预警已生成对应待办,目前您是责任人,请在“管理预警任务-预警待办中心”及时进行处理
60
1286
您好,数据开发任务「#taskname#」中,产生脏数据,请前往「任务运维」-「定时任务」模块,在对应任务日志中查看详情。
61
1287
您好,数据开发任务「#taskname#」中,产生脏数据,原因为#errorReason#,请前往「任务运维」-「定时任务」模块,在对应任务日志中查看详情。
62
1404
您好,定时任务「#taskname#」中,节点「#nodename#」数据源表「#tablename#」结构发生变化,请前往「任务运维」-「定时任务」模块,在对应任务日志中查看详情。