---
url: /v6.2/app-subscribe.md
---
# 订阅

平台支持将应用中的仪表盘立即推送或定时推送给组织内外的用户，方便目标用户即时查看到自己需要的业务指标，作为开展业务的决策依据，及时响应并调整业务方向。

平台的数据分析员，对于拥有管理权限的应用，包括创作模块的个人空间、团队空间应用和应用模块中的应用，都可以进行邮件推送设置。每个应用可以设置多个订阅，为不同的用户推送不同的内容。

租户场景也支持订阅功能，并且可以对平台方分享的应用设置订阅任务。

### 新建订阅任务

每个订阅任务包括订阅名称和订阅发送。订阅发送根据发送方式不同，设置内容方式也不同，包括以下方式：邮件通知、企业微信、飞书、Webhook 、 钉钉。这几种方式可同时使用，如同时设置邮件通知和企业微信订阅方式。

#### 选择用户

飞书、钉钉、企业微信推送方式在选择系统内用户时，用户选择界面将会展示用户是否绑定了对应第三方应用的账号。

![](/images/app-creation/app-setup-034.png)

> 选择的系统内用户如果没有绑定对应第三方应用账号，任务执行时，将跳过该用户。用户组与组织架构中未绑定对应第三方应用账号的行为同上。

##### 一键复制粘贴

6.2 版本新增**一键复制粘贴**功能。支持直接在任务的"查看"界面一键复制账号信息，即可完成信息的快速提取；在新任务中一键粘贴即可完成复用，提升订阅任务配置效率。

![](/images/app/mail-push/app-mailpush-copy-paste.png)

#### 模板变量

支持在推送内容的正文以及标题使用模板变量。

例子:

```text
这是临时订阅消息{{%%system.dashboard.url}}
```

##### 支持的模板变量列表如下:

| 变量名                      | 描述                                                                                          |
|--------------------------|---------------------------------------------------------------------------------------------|
| system.app.title         | 应用标题                                                                                        |
| system.app.url           | 应用链接                                                                                        |
| system.today             | 当前日期                                                                                        |
| system.app.share.url.pwd | 应用启用公开链接时，并且开启了需要访问密码选项时，将会使用公开链接的访问密码覆盖该模板变量。若是未开启公开链接、或者未开启需要访问密码，并且同时使用了该模板变量，那么将以提示文本替代 |

##### 仅Webhook推送方式支持的模板变量列表如下:

| 变量名                  | 描述               |
|----------------------|------------------|
| system.dashboard.url | 仪表盘标题与仪表盘链接的组合文本 |

#### 邮件通知

邮件通知是以邮件的形式通知仪表盘相关业务信息，在使用邮件通知时请先确认配置了[SMTP](smtp.md)服务。

##### 信息配置

* 选择用户：填写邮件通知的系统用户。
* 其他邮件地址：当收件人不是系统用户时，填写收件人邮箱地址。
* 邮件内容：包括邮件标题、邮件正文、选择仪表盘。
  邮件内容支持自定义纯文本、支持系统参数、应用参数和用户属性。
  * 系统参数有应用名称、应用 URL 和邮件推送日期。
  * 应用参数
  * 用户属性
    下面示例展示使用各种参数及用户属性书写的邮件内容及邮件发送时的情况。
    ![](/images/app/mail-push/app-mailpush-edit-1.png)

    ![](/images/app/mail-push/app-mailpush-edit-2.png)
* 高级配置：支持使用订阅创建者的身份导出数据并生成消息内容、正文预览仪表盘图片、正文附加仪表盘链接、附加仪表盘数据(仪表盘分析的结果数据，以文件形式展示于邮件附件)。

##### 导出图表注释

6.2 版本新增**导出图表注释**功能。订阅任务勾选导出 Excel 数据时支持导出图表注释，确保数据在传递过程中的完整性。

![](/images/app/mail-push/app-mailpush-chart-annotation.png)

##### 超大附件生成下载链接

数据分析师给用户设置邮件订阅或预警推送时，由于不同邮件服务器对于超大附件会有大小限制，从而导致给客户发送邮件失败，6.1版本中支持将邮件附件生成下载链接进行推送（如图）。
![](/images/app/mail-push/app-mailpush-edit-3.png)

* 邮件附件多大时可下载链接生成，可通过环境变量`MESSAGE_PUSH_CONFIG_APP_EMAIL_ATTACHEMENT_MAX_SIZE_MB`控制，默认25M。
* 生成的下载链接有有效期，可通过环境变量`MESSAGE_PUSH_CONFIG_APP_EMAIL_ATTACHEMENT_RETENTION_DAYS`控制，默认7天。且会在邮件正文中提示。

![](/images/app/mail-push/app-mailpush-edit-4.png)

#### 企业微信

企业微信方式是以企业微信消息的形式通知用户，并且支持在消息中添加仪表盘信息。
企业微信方式开启前需要在[认证方式](authorization.md#企业微信)中进行令牌信息配置，请联系系统管理员进行配置（配置一次即可），否则会影响功能使用。

使用企业微信方式订阅仪表盘消息时，需要配置以下内容，包括：

* 消息标题：必填，不超过100个字，支持使用参数信息。
* 选择用户：选填， 选择系统内的用户。
* 填写其他成员：选填，手动填写企业微信内用户的用户 id，支持输入多个用户，使用英文逗号隔开。企业微信`userid`
  获取教程：[教程链接](https://developer.work.weixin.qq.com/document/path/90665#userid)。
* 消息内容：系统默认发送了固定的消息内容，支持用户自定义消息内容。自定义纯文本、支持系统参数、应用参数和用户属性。
* 选择仪表盘：选择订阅消息中发送的仪表盘信息。
* 高级配置：可以在消息中附加仪表盘快照图片和仪表盘链接等。

> 系统内用户、其他成员至少有一项不能为空。

![](/images/app-creation/app-setup-035.png)

#### 飞书

飞书方式是在飞书 app
中以消息的形式通知用户，并且支持在消息中添加仪表盘信息。飞书方式开启前需要在[认证方式](authorization.md#飞书)
中进行令牌信息配置，请联系系统管理员进行配置（配置一次即可），否则会影响功能使用。

使用飞书方式订阅仪表盘消息时，需要配置以下内容，包括：

* 消息标题：必填，不超过100个字，支持使用参数信息。
* 选择用户：选填， 选择系统内的用户。
* 填写其他成员：选填，手动填写飞书内用户的用户 id，支持输入多个用户，使用英文逗号隔开。飞书`user_id`
  获取教程：[教程链接](https://open.feishu.cn/document/server-docs/contact-v3/user/batch_get_id)。
* 消息内容：系统默认发送了固定的消息内容，支持用户自定义消息内容。自定义纯文本、支持系统参数、应用参数和用户属性。
* 选择仪表盘：选择订阅消息中发送的仪表盘信息。
* 高级配置：可以在消息中附加仪表盘快照图片和仪表盘链接。

> 1. 系统内用户、其他成员至少有一项不能为空。
> 2. 飞书的用户 id 存在三种类型，手动输入的`user_id`，需要类型是`user_id`的用户 id。如果用户 id 类型错误，将会导致推送结果出现异常。

![img.png](/images/app-creation/app-setup-032.png)

#### 钉钉

钉钉方式是在钉钉 app
中以消息的形式通知用户，并且支持在消息中添加仪表盘信息。钉钉方式开启前需要在[认证方式](authorization.md#钉钉)
中进行令牌信息配置，请联系系统管理员进行配置（配置一次即可），否则会影响功能使用。

> 钉钉推送，除了认证所需的配置之外，还需要配置AgentId。

使用钉钉方式订阅仪表盘消息时，需要配置以下内容，包括：

* 消息标题：必填，不超过100个字，支持使用参数信息。
* 选择用户：选填， 选择系统内的用户。
* 填写其他成员：选填，手动填写钉钉内用户的用户 id，支持输入多个用户，使用英文逗号隔开。钉钉`userid`
  获取教程：[教程链接](https://open.dingtalk.com/document/orgapp/query-users-by-phone-number)。
* 消息内容：系统默认发送了固定的消息内容，支持用户自定义消息内容。自定义纯文本、支持系统参数、应用参数和用户属性。
* 选择仪表盘：选择订阅消息中发送的仪表盘信息。
* 高级配置：可以在消息中附加仪表盘快照图片和仪表盘链接。

> 1. 系统内用户、其他成员至少有一项不能为空。
> 2. 由于钉钉消息限制，钉钉的附带仪表盘链接功能最多只能附带 6 个仪表盘的链接，若超出 6 个仪表盘，将在推送消息中附带提示内容。
> 3. 由于钉钉消息限制，钉钉的消息中附加仪表盘快照图片功能最多只能附带 1 个仪表盘的图片，若在勾选该功能时，选择的仪表盘超出了 1
>    个，将在推送消息中附带提示内容。

![img.png](/images/app-creation/app-setup-033.png)

#### Webhook

使用 Webhook 时，用户需要自定义消息请求方式及请求内容。

* URL：系统向对应的 HTTP 地址发送请求，URL 后面可以拼接参数。
* 请求方式：支持 GET、POST、PUT、DELETE 四种方式。
* 请求头部和请求体：根据预警内容填写请求头部和请求体，请求头部和请求体中都可以携带预警信息。 示例中使用 POST
  方式发送消息，在请求体中填写预警内容，通知用户处理。GET 方式的请求仅包含请求头部。
* 选择仪表盘：选择仪表盘，作为定时发送内容。

![](/images/app-creation/app-setup-029.png)

### 订阅推送计划

邮件订阅设置完成，在订阅列表页面点击订阅时展示为设置详情。在详情页右上角可以点击“立即推送”，将应用立即推送给目标对象。也可以选择“推送计划”设置定时邮件推送，邮件即在约定的时间送达收件人。

![](/images/app-creation/app-setup-015.png)

* 基本信息：设置执行时重试次数及任务的优先级。任务优先级分高、中、低三个级别。高级别的任务优先处理。
* 调度信息：
  * 设置任务的调度时间，可设置多个调度时间。 支持按小时、天、周、月的方式设置执行计划。
    * 小时：可设置每小时的第几分钟更新。
    * 天：可以设置每天具体的时间点更新。
    * 周：可以设置每周的周几的具体时间点更新，可以多选。
    * 月：可以设置每月的第几天的具体时间点更新，可以多选。
    * 自定义：可以自行设置更新的时间点。
  * 设置任务的前置依赖，可设置多个前置依赖任务。
  * 设置依赖等待时间。
* 告警信息：开启失败告警，当任务执行失败后，会以邮件形式通知到收件人。

### 订阅推送记录

在上述邮件推送详情页的右上角选择“推送记录”可查看该应用的所有推送历史以及推送日志。

![](/images/app-creation/app-setup-016.png)

### 推送权限规则

• 系统内用户收到邮件推送的内容，数据权限同`应用` -> `设置` -> `数据权限`。

• 系统外用户收到邮件推送的内容，数据权限同应用作者权限。