通知
通知用于将Cat2Bug-Platform系统内的缺陷、报告等事件消息发送给指定负责人或关注此问题的成员。 因此,Cat2Bug-Platform从0.4.1开始,将支持通过系统内通知管理、邮件、钉钉群发、钉钉个人单发、企业微信个人单发等方式发送通知信息。
通知配置
注意
当前通知配置只针对当前项目,因此每个项目都会有不同的配置选项,如果在当前项目中没有配置,将采用默认选项。
系统内通知配置
Cat2Bug-Platform内部的通知功能默认是开启状态,点击系统右上角导航栏中的铃铛图标,可进入当前用户的通知列表界面。
在通知列表的右侧,点击齿轮图标按钮,打开配置弹出框。
在【发送选项】中,配置接收什么模块的通知。 点击【接收平台】页签,可以看到所有平台的配置选项,【系统内部通知】默认是开启状态。 用户可以通过开关按钮及选项前的勾选框来选择以何种方式展示新的消息。
开启通知音效:用于配置在收到新通知时,所播放的背景提示音。
在右上角实时显示通知窗口:当收到新消息时,用于在浏览器右上角显示通知提示窗口。
邮件配置
邮件配置用户将通知发送到指定邮箱,目前可以设置当前成员的收件地址。
提示
默认收件地址为注册用户时填写的EMail地址,也可通过【个人中心】进行修改默认EMail。
如需用企业自己的邮件服务器发送邮件,需要修改Cat2Bug-Platform后台程序的邮件服务器相关参数,请通过压缩软件打开cat2bug-platofrm.jar文件,修改./BOOT-INF/classes/application.yml文件中的参数,参数说明如下:
spring:
mail:
# smtp服务器地址,请修改为公司邮件服务器地址
host: smtp.sparkspace.huaweicloud.com
# smtp服务器端口
port: 465
# 默认邮件账号
username: demo@cat2bug.com
# 默认邮件密码
password: bfwcyhkm5jnnY5wJ
# 默认发送邮件地址
from: demo@cat2bug.com
# 默认邮件编码
default-encoding: UTF-8
properties:
mail:
smtp:
auth: true
ssl:
enable: true
socketFactory:
port: 465
class: javax.net.ssl.SSLSocketFactory
注意
以上实例中提供的邮件服务器地址、账号和密码,用于展示与测试,会不定期停机维护,如需更稳定邮件服务,请修改为企业自己的邮件服务器配置。
钉钉配置
钉钉配置用于从钉钉应用中接收Cat2Bug-Platform通知信息,目前支持钉钉群接收通知、钉钉个人账号接收通知两种方式。
钉钉群接收通知配置
钉钉群通知只需要在钉钉群中创建机器人,然后在Cat2Bug-Platform通知中配置WebHook和关键词两个参数;
- 根据以下图中顺序在钉钉群创建机器人。
- 将在钉钉机器人中添加的关键词和Webhook填写到Cat2Bug-Platform系统配置中,点击保存按钮。
- 验证配置是否正确,指派一个缺陷的处理人为当前账号,将会在钉钉群中收到通知信息。
钉钉个人账号接收通知配置
钉钉个人通知需要在钉钉开放平台创建应用、Cat2Bug-Platform项目中配置应用参数、成员个人配置中设置接收账号三步,才能正常收取个人通知。
- 钉钉开放平台配置
- 用管理员账号登陆钉钉开放平台https://open.dingtalk.com ,点击【开发者后台】按钮。
- 根据下图顺序创建应用
- 发布应用版本
- Cat2Bug-Platform项目中的配置
- 复制钉钉开放平台【凭证与基础信息】中的Client ID和Client Secret。
- 复制制钉钉开放平台【机器人】中的RobotCode。
- 将复制的Client ID、Client Secret、RobotCode粘贴到Cat2Bug-Platform项目配置中。
- Cat2Bug-Platform成员配置
每个成员都需要一对一的进行账号配置,在通知配置中,设置单人User ID,此参数需要从钉钉OA系统中获取。
- 以管理员账号登陆钉钉管理后台https://oa.dingtalk.com ,选择左侧【通讯录】->【成员管理】,点击对应用户,复制右侧弹框的UserID。
- 将UserID粘贴到Cat2Bug-Platform通知配置中的【钉钉机器人】->【单发User ID】中。
注意
钉钉成员UserID可以配置在Cat2Bug-Platform个人中心中,当通知配置中没有设置UserID,会自动读取个人中心中的UserID作为默认账号。
- 验证配置是否正确,指派一个缺陷的处理人为当前账号,将会在钉钉中收到通知信息。
企业微信配置
企业微信配置用于从企业微信应用中接收Cat2Bug-Platform通知信息,目前支持个人账号接收通知, 个人接收通知需要对企业微信平台、Cat2Bug-Platform项目配置、Cat2Bug-Platform个人通知配置三块进行配置。
企业微信平台配置
- 用企业管理员的账号登陆企业微信平台https://work.weixin.qq.com
- 选择【应用管理】菜单,点击【创建应用】功能创建发送消息的应用。
- 上传图标,填写应用名称,可见范围选择您想发送消息的部门,之后点击【创建应用】按钮。
- 进入应用界面后配置企业可信IP。
注意
可信IP为Cat2Bug-Platform平台外网IP地址,不配置此项,企业微信将无法正常接收通知消息。
项目中的配置
- 复制企业微信应用详情上方的AgentId(应用ID)和Secret(应用密钥)值。
- 在企业微信中,选择导航栏中的【我的企业】菜单, 复制最下放的【企业ID】。
- 在Cat2Bug-Platform项目配置中,设置从企业微信中复制的的AgentId(应用ID),Secret(应用密钥)和企业ID,如下图:
成员个人配置
- 从企业微信【通讯录】中复制用户账号。
- 复制企业微信账号到Cat2Bug-Platform通知配置中。
- 验证配置是否正确,指派一个缺陷的处理人为当前账号,将会在企业微信中收到通知信息。
如何使用通知功能
手动发送通知
在Cat2Bug-Platform系统中,可以手动指定接收成员发送通知信息,目前团队创建人、团队管理员、项目创建人、项目管理员可以执行此功能。
缺陷通知
在缺陷管理中,缺陷处理人的更新和关注缺陷的成员,可以接收指定缺陷的变更信息,在通知配置中,用户可以自行设置是否接收缺陷通知,默认接收。
报告通知
在报告管理中,新建报告可以触发通知,在通知配置中,用户可以自行设置是否接收报告通知,默认不接收。