1. 概述编辑
1.1 版本
FineDataLink 版本 | 功能变动 |
---|---|
3.6.1 | 新增节点「消息通知」,可将任务调度结果以企业微信群机器人的形式通知给指定用户 |
4.0.1 | 可将任务调度结果以邮件的形式通知给指定用户 |
4.0.3 | 「消息通知」节点支持的通知渠道新增:短信、企业微信应用推送、钉钉应用推送、钉钉群机器人 |
1.2 应用场景
用户基于以下场景时:
希望可以通过企业微信群机器人/邮件/短信/企业微信应用推送/钉钉应用推送/钉钉群机器人的形式将信息通知给指定用户。
希望通知内容不仅是通知任务执行状态,还希望可以通知任务执行过程中产生的某些计算值和参数值,或者根据实际业务需求自定义通知内容。
通知时机不仅在任务结束时,可能是在某个步骤流的环节成功完成后或者数据异常时进行通知
可使用「消息通知」功能满足需求。
1.3 功能简介
「消息通知」,可将任务调度结果以企业微信群机器人/邮件/短信/企业微信应用推送/钉钉应用推送/钉钉群机器人的形式通知给指定用户。
2. 功能介绍编辑
2.1 企业微信群机器人
界面如下图所示:
具体设置项介绍如下表所示:
设置项 | 介绍 |
---|---|
机器人webhook地址 | 企业微信群机器人 webhook 地址,不允许为空 添加群机器人步骤如下图所示,机器人添加成功的提示页面上会有 webhook 地址 |
消息类型 | 有两种消息类型:文本消息、markdown消息 1)选择「文本消息」时,界面如下图所示:
注:用户ID即企业成员账号,管理员可点击管理后台「通讯录>成员信息」查看成员账号;管理员手机端「工作台>管理企业>编辑成员」查看成员账号
选择文本消息时,支持同时提醒多个群成员,多个群成员 ID 或手机号间通过「半角逗号」分隔,值为「@all」时,提醒所有人。允许引用参数 2)选择「markdown消息」时,界面如下图所示: |
消息内容 | 填写消息内容,允许引用参数。要求如下:
|
2.2 邮件
界面如下图所示:
具体设置项介绍如下表所示:
设置项 | 介绍 |
---|---|
发件人 | 可选已配置在平台中的发件人列表,默认值为平台配置的默认发件人 如果平台没有已配置的发件人,则下拉框为空,配置发件人步骤请参见:邮箱 |
收件人/抄送/密送 | 可选平台内已配置邮箱的用户
|
主题 | 填写邮件主题 支持通过${a}的方式引用参数值(a为参数) |
正文 | 填写邮件正文 支持通过${a}的方式引用参数值(a为参数) |
2.3 短信
界面如下图所示:
短信渠道需要检查平台中帆软通行证和短信平台的配置情况:
如果没有登录帆软通行证,切换到短信渠道后,提示点击登录,以获取短信模板和签名
如果没有开通短信平台,切换到短信渠道后,提示尚未开通短信服务,申请开通短信服务
如果平台中,短信平台已配置,但是没有启用,允许配置节点,在发信时报错
具体设置项介绍如下表所示:
注:开通短信服务请参见:短信;短信申请签名和模板请参见:短信申请签名和模板;短信相关条款请参见:帆软市场短信相关条款
设置项 | 介绍 |
---|---|
收件人 | 短信接收人,默认为空:
|
手机号 | 填写收信手机号,默认为空:
|
短信签名 | 使用的短信签名,默认选中第一项:
|
短信模板 | 使用的短信模板:不可编辑,展示选择的短信模板 |
短信参数 | 传入短信模板的参数。名称默认显示所选短信模板包含的所有参数,值为空:
|
2.4 企业微信应用推送
2.4.1 功能简介
界面如下图所示:
具体设置项介绍如下表所示:
接口调用说明:获取access_token、发送应用消息
设置项 | 介绍 |
---|---|
企业ID | 获取方式请参考:corpid |
应用凭证密钥 | 应用凭证密钥,可在应用管理页面查看。获取方式参考:secret |
AgentId | 发送消息时使用应用的 AgentId,可在应用管理页面查看: |
消息接收成员 |
|
消息接收部门 |
|
消息接收标签 |
|
数据源类型 | 指定消息类型,支持文本消息和Markdown消息 目前支持的 Markdown 语法请参见:支持的Markdown语法 |
消息内容 | 填写消息内容,允许引用参数:
|
是否是保密消息 | 非保密消息可对外分享 保密消息不可分享且内容有水印 |
开启重复消息检查 | 开启重复消息检查后,在重复消息检查间隔内重复推送相同内容消息,会自动忽略 |
重复消息检查间隔 | 指定重复消息检查间隔,单位为秒,默认为 1800 秒 允许输入范围:1800~14400 |
2.4.2 注意点
1)每应用不可超过帐号上限数 200 人次/天。
注:若调用 api 一次发给 1000 人,算 1000 人次;若企业帐号上限是 500 人,则每个应用每天可发送 100000 人次的消息。
2)每应用对同一个成员不可超过 30 次/分钟,超过部分会被丢弃不下发。
3)企业微信应用推送时,被推送人员无应用权限:
全部无权限:消息通知节点会报错。
部分无权限:消息通知正常通知有效的用户,忽略无效的用户,并在 WARN 日志中打印出无效用户名。
2.5 钉钉应用推送
2.5.1 功能简介
界面如下图所示:
具体设置项介绍如下表所示:
接口调用说明:发送工作通知
设置项 | 介绍 |
---|---|
AppKey | 应用的唯一标识Key,可在 钉钉开发者后台 的应用详情页面获取 |
AppSecret | 应用的密钥,可在 钉钉开发者后台 的应用详情页面获取 |
AgentId | 发送消息时使用的微应用的AgentId: |
发送给全部用户 | 是否发送给企业全部用户 不勾选时,展示「消息接收成员」和「消息接收部门」 |
消息接收成员 | 勾选「发送给全部用户」时隐藏:
|
消息接收部门 | 勾选「发送给全部用户」时隐藏:
|
数据源类型 | 选择通知消息类型,支持文本消息和 Markdown 消息 |
消息标题 | 只有选择「Markdown消息」时,才显示「消息标题」输入框 填写消息标题,允许引用参数,不超过100字符 |
消息内容 | 填写消息内容,允许引用参数,不允许为空:
|
2.5.2 注意点
1)钉钉应用推送时,即使接收成员填写不正确,也不会有错误信息,需要用户自行确认调试(钉钉有推送查询接口)。
2)企业内部应用发送消息单次最多只能给 5000 人发送,第三方企业应用发送消息单次最多能给 1000 人发送。
3)给同一员工一天只能发送一条内容相同的消息通知。
4)企业内部应用每天给每个员工最多可发送 500 条消息通知,第三方企业应用最多可发送 100 条。
5)企业内部应用或第三方企业应用发送消息时,每分钟最多有 5000 人可以接收到消息。
2.6 钉钉群机器人
2.6.1 功能简介
界面如下图所示:
具体设置项介绍如下表所示:
接口调用说明:自定义机器人接入
设置项 | 介绍 |
---|---|
机器人Webhook地址 | 填写钉钉群机器人 Webhook 地址,允许引用参数,不允许为空 |
消息类型 | 选择通知消息类型,支持文本消息和 Markdown消息 |
提醒群成员方式 | 选择提醒群成员的方式 |
提醒群成员列表 |
|
消息标题 | 仅Markdown消息类型显示 填写消息标题,允许引用参数,不超过 100 字符 |
消息内容 | 填写消息内容,允许引用参数:
|
2.6.2 注意点
1)每个机器人每分钟最多发送 20 条。
2)如果超过 20 条,会限流 10 分钟。
3)钉钉群机器人安全策略支持情况,仅支持「自定义关键词」与「设置IP白名单」,不支持「加签」策略。
3. 示例一:企业微信群机器人编辑
3.1 前期准备
参考 行列转换 文档中 3.1-3.5 节内容,作为示例基础,用以展示消息通知功能。
3.2 设置消息通知
3.2.1 新增消息通知节点
拖入「消息通知」节点。如下图所示:
3.2.2 设置消息通知节点
注:两种方案的效果一样。
方案一:「提醒群消息方式」选择手机号
「提醒群消息方式」选择手机号。如下图所示:
方案二:「提醒群消息方式」选择用户ID
「提醒群消息方式」选择用户ID。如下图所示:
3.2.3 将节点连接起来
将「数据转换」节点和「消息通知」节点连接起来。如下图所示:
3.3 运行任务
点击右上角的「保存并运行」。如下图所示:
可以看到数据库 etlwendy 中新增了一张表 hanglie,为列转行后数据。如下图所示:
同时,企业微信群中,消息通知给设置的群成员。如下图所示: