第三方消息接口集成插件

1.1 版本

1.2 应用场景

与第三方短信接口或者消息接口对接，发送消息

1.3 功能描述

需要有【短信平台】功能点

支持阿里云短信接口和http服务接口

支持发送系统短信提醒

支持定时任务发送消息

2.1 插件安装

点击下载插件：第三方消息接口集成插件

设计器插件安装方法请参见：设计器插件管理

服务器安装插件方法请参见：服务器插件管理

2.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 内置参数

这些参数可以在http服务接口中使用

2.2.5 短信事件

在报表模板的控件事件里面等事件里面发送短信

在事件中选择<第三方消息>，如下图所示

(1)、用户

用户名：发送消息的用户,多个用逗号隔开，支持公式

部门名称：发送消息的部门名称，根据部门名称获取当前部门以及子部门的所有用户,多个用逗号隔开，支持公式

角色名称：发送消息的角色名称，根据角色名称获取当前角色的所有用户,多个用逗号隔开，支持公式

手机号：发送消息的手机号,多个用逗号隔开，支持公式

(2)、配置

消息编号：消息接口的唯一标识，支持公式

消息模板编号：消息接口的模板编号，支持公式

消息模板参数：消息接口的模板参数，支持公式

消息模板参数名称：消息接口的模板参数名称,多个名称用竖线隔开，支持公式

消息模板参数值：消息接口的模板参数值,多个名称用竖线隔开，支持公式

(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 阿里云短信服务

主要针对阿里云短信服务发送报表平台内置短信时，申请阿里云短信模板时，要和文末的内置短信模板里的参数一样才行

例如: 内置短信模板

申请阿里云短信模板时,参数必须为verifiecode

消息配置里面的模板编号对照表填写如下

(1)、在决策平台中,<管理系统>-<注册管理>-<功能列表>的<已注册功能点>中必须有<短信平台>模块,插件才能正常使用

(2)、在测试发送消息时，请将日志等级改为INFO，方便排除问题，如下图所示