1. 订阅概述
订阅,是指用户可以指定订阅观远BI系统中的卡片、页面、数据集等内容。订阅的内容将会通过邮件、企业微信、钉钉、云之家、泛微、飞书等渠道,通知到收件人,使用户不需要登录也能知道卡片或者数据集的最新数据变动。
2. 订阅使用简介
通过订阅,可以不用登录也能知道卡片或者数据集的最新数据变动。目前观远支持4种订阅:
卡片订阅,即一个订阅对应单个卡片。
页面订阅,即一个订阅对应一个页面。
合并订阅,即一个订阅对应多个卡片。
数据集订阅,即一个订阅对应一个数据集。
3. 卡片订阅
3.1 创建订阅
入口一:点击卡片右上角的“...”按钮,选择“创建订阅”,进入卡片订阅配置界面,进行具体配置。
入口二:打开右上角九宫格,选择“订阅计划”。
在订阅计划页面,点击右侧的“添加卡片订阅”按钮,即可进入订阅配置界面。
3.2 配置订阅
3.2.1 基础信息
订阅名称(必填):为该订阅创建名称,从而便于在订阅管理中快速找到该订阅。
订阅对象(必填):输入想要订阅的卡片名称,并在搜索结果中选择该卡片。
3.2.2 触发机制
启用订阅(必填):选择“启用”或“禁止”该订阅,启用状态不限制手动触发、URL触发。
有效期(必填):可选择“长期有效”或“时间范围内有效”。若选择“时间范围内有效”:
可设置从开始到结束的日期,若不设置,默认为长期有效;
当订阅周期结束后,点击“手动发送”或调用API依旧能发送订阅;
周期与启用/禁用:启用状态下,周期结束之后,停止发送订阅;禁用状态下,周期还未结束时,依旧不发送。
触发方式:可选择“数据更新后”、“定时执行”、“手动触发”三种触发方式。
数据更新后:当卡片源数据更新后,卡片数据更新,并触发订阅。
定时执行:可以设定每天/每周/每月的某个固定时间发送。
手动触发:在订阅计划界面,手动发送。
URL触发:勾选后,可在外部系统中通过URL直接触发当前订阅的发送。
3.2.3 订阅发送
通知渠道(必填):支持邮件、企业微信、钉钉、云之家、泛微、飞书等多种通知渠道。其中企业微信、钉钉、云之家、飞书支持以“消息通知”和“群机器人”的方式,发送订阅。(更多群机器人内容详见《使用群机器人推送信息通知》)
收件人(必填):收件人可为单个用户或用户组,但必须配有观远账号。选择邮件时,除支持收件用户,还支持密送用户和抄送用户,密送用户之间互相看不到收件信息,抄送用户无需对订阅进行答复和批复。
分发方式(必填):支持全量分发、按条件分发两种方式。
(1)全量分发:将卡片数据全量分发给指定人群。
如渠道选择邮件,则需设置收件用户、抄送用户、密送用户,支持设置用户或用户组;
如渠道选择第三方消息通知,是通过应用将消息发送给单一用户,则需设置收件用户,支持设置用户或用户组;
如渠道选择第三方群机器人,是将消息发送至群聊,需填写群聊机器人的Webhook。
(2)按条件分发:允许为不同用户按需定义订阅内容与数据的可见范围。按需将卡片数据按"数据集字段"过滤分发给不同人群或群聊机器人(Webhook),实现千人千面的订阅卡片,以达到提高数据隐私性、或降低数据噪音等效果。
如一份全国的销售数据,仅将华南区域数据发给华南销售负责人,该设置会同时影响订阅的url、图片和附件。
* 注意:按条件分发仅适用于卡片中的可视化图表(不适于杜邦分析图等复杂卡片),且每个订阅最多支持设置10条规则,每条规则中最多支持5项筛选,每项筛选中最多支持10个值。
3.2.4 订阅内容
通知标题(选填):为该订阅创建通知标题;如未填写,则默认标题为“订阅报告-卡片名称+发送日期”。
通知正文(选填):填写通知正文;如未填写,则默认正文为“您的订阅报告已生成,请查看。卡片详情请点击「卡片详情页链接」请勿直接回复本邮件”。
快捷时间宏(选填):在通知标题和正文中,可直接点击添加时间宏。
图片与附件(选填):若勾选图片或Excel,则会在通知中收到对应卡片的图片和数据表。
通知渠道图片与附件邮件
支持图片和Excel附件
附件中显示的数据,为订阅创建者可见数据
附件最大为50M,如超过50M将发送失败
当订阅对象为复杂报表时,支持添加复杂报表html和Excel
html受邮箱客户端影响较大,建议使用outlook、阿里邮箱客户端,建议应用于文件大小较小(1M以内)的复杂报表
部分复杂报表的样式不支持:冻结首行、主题样式、分页(仅支持第一页)
企业微信
支持图片,且可自定义上传图片
支持JPG、PNG格式,建议分辨率大小为:大图 1068*455,小图150*150
钉钉支持图片云之家不支持泛微不支持飞书
支持图片
需要开通飞书应用权限:“获取与上传图片或文件资源”或“上传文件V2”
跳转链接:可“显示”或“隐藏”卡片详情页链接(现支持钉钉、飞书、企微、云之家、泛微渠道)
3.2.5 失败通知
当订阅发送失败时,可使用订阅预警渠道通知收件人。
邮件、企业微信、钉钉、飞书可选择通知“订阅创建者”、“资源所有者”和“指定收件人”。
3.3 订阅预览
(1)通知渠道为“邮件”,图片内容为“无”
发送后的邮件示例图如下,可以看到,邮件在12:00准时发出。
邮件标题未填写,为默认的“卡片名称”+“发送日期”;
邮件内容未填写,为默认的“卡片详情链接”;
若设置邮件附件,则卡片数据会以表格形式作为附件一起发送。
(2)通知渠道为“邮件”,图片内容为“复杂报表html”
特别提示:
a.当卡片源数据设置了行列权限时,附件中的数据是以订阅创建者的权限为准,为订阅创建者可见数据。
b.当触发时间的模式是“URL触发”时,每次外部链接调用触发一次订阅,效果同手动发送,即不受订阅启用状态影响。
4. 页面订阅
4.1 创建订阅
入口一:点击仪表板页面右上角“...”按钮,选择“页面订阅”,进入页面订阅配置界面,进行具体配置。
入口二:打开右上角九宫格,选择“订阅计划”。
在订阅计划页面,选择页面订阅,点击右侧的“添加页面订阅”按钮,即可进入订阅配置界面。
4.2 配置订阅
进入页面订阅配置界面,该配置界面与卡片订阅大致相同,具体说明见上文3.2 配置订阅,区别在于:
(1)触发方式
勾选“数据更新后”,会出现页面当前的数据集作为触发条件。
勾选想要关联的数据集,当所有勾选的数据集都更新时,系统将自动发送通知至订阅用户。
当数据集被删除或与页面关联失效时,系统会继续根据配置发送页面订阅。
(2)分发方式
页面卡片订阅中的"按条件分发"是基于页面筛选器进行内容过滤(不支持树状筛选器作为联动条件),而卡片订阅的"按条件分发"则基于卡片数据集字段的值过滤。
(3)通知内容
支持添加的图片与附件不同,具体可添加的内容见下表。
通知渠道图片与附件跳转链接邮件
支持图片和PDF附件
附件中显示的数据,为订阅创建者可见数据
附件最大为50M,如超过50M将发送失败
不支持跳转企业微信
支持图片,且可自定义上传图片
支持JPG、PNG格式,建议分辨率大小为:大图 1068*455,小图150*150
仪表板页面和移动轻应用页面钉钉支持图片仪表板页面和移动轻应用页面云之家不支持仪表板页面和移动轻应用页面泛微不支持仪表板页面和移动轻应用页面飞书
支持图片
需要开通飞书应用权限:“获取与上传图片或文件资源”或“上传文件V2”。
仪表板页面和移动轻应用页面
(3)高级设置
在移动端,点击页面订阅消息进入对应仪表板时,若想要仪表板自动只展示消息收到时的日期数据(如日报订阅,点击昨天的日报消息展示昨日的数据,点击今天的消息展示今天的数据),可在高级设置中进行关联筛选设置。
目前关联筛选器仅支持在移动端适用,且仅支持时间宏表达式的筛选方式。
若通知跳转链接为“移动轻应用”,则不支持此设置。
当生成导出附件时,去访问对应页面,将相关值带入页面对应筛选器,并加载数据生成附件。
5. 合并订阅
针对需要卡片较多的订阅,可以将多个卡片的订阅合并为一封邮件发送。
第一步,点击右上角九宫格按钮中的“订阅计划”,进入订阅计划页面。
第二步,选择“合并订阅”,点击“添加合并订阅”按钮。
第三步,填写相关信息,数据来源选择订阅卡片、页面或组合报表,这里支持多张卡片/页面/组合报表的订阅。
其中,图片内容处可选择复杂报表html。
限制说明
当合并订阅选择了多个复杂报表时,Html 中仅展示顺位第一的复杂报表;
部分复杂报表的样式不支持:冻结首行、主题样式、分页(仅支持第一页);
展示效果与用户的邮件客户端有关,建议使用 Outlook、阿里邮箱客户端;
复杂报表内的数据量不宜过大,建议在4000行以内。
6. 数据集订阅
数据集订阅将导出到用户指定的FTP/SFTP服务器,因此首先需要配置相关FTP/SFTP数据账户。
第一步,在数据中心-数据账户内创建相应FTP/SFTP数据账户,账户包括以下配置项:
显示名称
地址(域名/IP地址)
端口:FTP默认为21端口,SFTP默认为22端口
协议(Protocol):FTP/SFTP
目录路径:默认"/"
用户名
密码
第二步,配置数据集订阅计划,选择“订阅计划”-“数据集订阅”-“新增数据集订阅”,配置项包括:
订阅名称:用于在订阅管理中快速找到该订阅
数据集:不可选择直连数据集和实时数据集
拆分订阅:按照数据集的字段进行拆分订阅将数据集拆分成不同的文件至FTP服务器
触发时间:定时执行,可以设定每天/每周/每月的某个固定时间发送
URL触发:可在外部系统中通过URL触发该订阅计划
失败通知:当订阅失败后将通过邮件通知相关用户
文件输出:
格式:导出文件的格式,可以选择Excel或CSV
名称:导出文件的名称,允许使用拆分字段、时间宏或者固定文本
路径:选择一个FTP/SFTP地址,填入一个不包含根目录的文件输出路径,允许使用拆分字段、时间宏或者固定文本
是否带时间戳:选“否”则会覆盖文件,选“是”则会在文件中携带相关时间戳信息
是否启用
7. 订阅管理
订阅创建完成后,在订阅计划界面,可查看到所有创建的订阅,并支持对其进行统一的管理操作。
7.1 管理入口
入口1:点击卡片右上角的“...”按钮,选择“管理订阅”,即可进入订阅计划。
入口2:打开右上角九宫格,选择“订阅计划”,即可进入订阅计划。
7.2 管理设置
在订阅计划中,可对卡片订阅、合并订阅、页面订阅、数据集订阅进行管理设置。具体设置内容如下:
a. 搜索订阅:在搜索栏中,支持按照卡片名称、订阅名称、收件人、创建者进行关键词搜索。
b. 添加订阅:在订阅计划右上角,点击“添加订阅”按钮,即可创建订阅。(具体创建流程见第二章)
c. 查看卡片:点击卡片名称,可查看卡片具体数据,支持对数据进行过滤筛选等操作。
d. 启用订阅:开启后,该订阅将会按照设置好的内容进行发送。
e. 查看发送历史:可查看订阅发送历史和卡片发送历史。
f. 编辑订阅:可编辑修改之前设置好的订阅内容。
g. 发送订阅:点击“手动发送”后,该订阅将会被重新发送。
h. 删除订阅
8. 订阅权限限制
设置订阅,若插入图片、附件,需要设置导出权限。
使用说明
如“导出”权限控制开启,订阅插入图片、附件则需校验创建者的RBAC导出权限和资源是否允许“导出”。
*RBAC 是基于角色的访问控制(Role-Based Access Control )。在 RBAC 中,权限与角色相关联,用户通过成为适当角色的成员而得到这些角色的权限。
具体权限及表现对应关系:
功能触达方式权限限制如不具有导出权限卡片订阅邮件
RBAC仪表板导出权限
&具有该仪表板导出权限
不可导出卡片图片、表格附件xlsx钉钉、飞书、企微
RBAC仪表板导出权限
&具有该仪表板导出权限
不可导出卡片图片页面订阅邮件
RBAC仪表板导出权限
&具有该仪表板导出权限
不可导出页面图片、页面pdf钉钉、飞书
RBAC仪表板导出权限
&具有该仪表板导出权限
不可导出页面图片企微
RBAC仪表板导出权限
&具有该仪表板导出权限
-合并订阅邮件
RBAC仪表板导出权限
&具有该仪表板导出权限
不可导出页面图片、卡片图片、附件数据集订阅-
RBAC仪表板导出权限
&具有该仪表板导出权限
不可新建订阅
特别注意
如历史订阅创建者不具有导出权限,则订阅发送失败报错;
如新增订阅,创建者后续失去导出权限,则订阅会报错。
若您在使用订阅功能时遇到问题,建议前往《订阅与预警常见功能》了解。