关键概念


报表工具的用户和权限系统继承了 EnOS 应用门户。开始之前,需了解 EnOS 应用门户的 相关概念


以下为报表工具的相关概念。

报表


报表是用表格、图表、文本等格式来可视化展示数据的文件。报表工具支持对报表的全生命周期管理,包括:制作和管理报表模板、创建和管理报表生成任务、创建和管理报表订阅。

报表模板


报表模板是指包含参数的报表设计文件,用来定义报表的内容和样式。


根据生效范围的不同,报表模板分为以下类型:

  • 标准模板:报表工具提供的普适性模板,对当前环境里所有 OU 生效。用户无法通过 UI 新建和修改标准模板,如需新建或修改,联系系统管理员。

  • 自定义模板:符合不同用户需求的定制化模板,仅对当前 OU 生效。用户可以通过 UI 上传 BIRT 文件或使用在线编辑器设计自定义模板。


更多信息,参见 设计报表

BIRT


BIRT (Business Intelligence and Reporting Tools) 是 Eclipse 基金会下的一款开源报表系统,它为应用提供商业智能报表功能,包括报表设计功能和报表部署功能。更多信息,参见 BIRT 文档 What is BIRT。BIRT 会生成以下文件:

  • rptdesign 文件:报表的设计文件。

  • rptlibrary 文件:报表的库文件,即报表元素(包括视觉和非视觉组件)的集合。库文件可以在多个报表设计中复用。


用户可以通过上传在 BIRT 中生成的 rptdesign 文件或包含 rptdesign 文件的 zip 格式压缩包,将报表模板托管到报表工具。


更多信息,参见 上传自定义模板

在线编辑器


在线编辑器是报表工具提供的在线制作报表模板的设计器,在线编辑器支持配置报表模板的参数、展示组件等内容并设置页眉页脚、页边距等页面布局。


更多信息,参见 创建自定义模板

组件


组件是指报表工具的在线编辑器中可添加的视觉元素,支持以下类型的组件:

  • 表格:表头和内容样式可按需配置。

  • 图表:即趋势图,包括折线图、柱状图、折线柱状混合图。

  • 文本:可在文本中插入变量和数据项。

  • 图片:上传图片文件展示在模板中。


用户可以按需配置组件的基本信息、展示数据、组件参数和组件样式,模板中组件的大小和位置也可以根据用户喜好进行调整。

参数


参数是指报表模板中实现用户与数据的实时交互、进行数据过滤的动态数值。

_images/RPT-Parameter.png

模板/非模板参数


根据是否仅对模板创建者可见,模板中的参数分为以下类型:

  • 模板参数:仅对模板创建者可见、不对其他用户可见的参数,例如:用于鉴权的应用密钥、口令等需要保密的参数。

  • 非模板参数:对所有用户可见、数值可修改的通用参数,例如:生成报表的场站,生成报表的日期,报表作者等。


模板创建者可以为模板参数和非模板参数设置默认值,其他用户在基于模板预览报表和创建任务时会自动使用参数的默认值。


用户可在以下场景中指定某一参数是否为模板参数:

  • BIRT 文件上传至报表工具后,系统自动识别文件中的参数并展示在列表中,用户可在列表中指定某一参数是否为模板参数。

  • 使用在线编辑器添加自定义参数时,用户可指定该自定义参数是否为模板参数。

全局/组件参数


报表工具的在线编辑器支持用户通过启用参数来定义模板内容。根据生效范围的不同,在线编辑器中制作的模板的参数分为以下类型:

  • 全局参数:适用于报表模板全局的参数。模板创建者可为全局参数设置默认值,其他用户在预览模板和创建任务时会自动使用参数的默认值。

  • 组件参数:适用于模板中特定组件的参数,通常有以下来源:

    • 直接使用全局参数。

    • 基于全局参数进行时间偏移,例如:设置组件的“开始时间”参数值为全局参数“开始时间”的 30 天前。

    • 不关联全局参数,使用固定值作为组件参数值。

默认/自定义参数


根据是否可自定义,全局参数可进一步分为以下类型:

  • 默认参数:在线编辑器提供的默认全局参数。在线编辑器内置以下默认参数:单场站(Single Site)、多场站(Multiple Site)、开始时间(Start Date)、结束时间(End Date)。用户在启用默认参数后可以修改参数默认值,但无法修改参数名称、是否必需和是否为模板参数。

  • 自定义参数:用户根据需求自定义的参数。支持自定义参数的名称、是否必需、是否为模板参数和默认值。

用户组


用户组是指 EnOS 应用门户中的用户分组,同一用户组中的用户具有相同的资产访问权限。报表工具通过为用户组分配模板权限,来批量控制组内用户对特定模板拥有的权限。


更多信息,参见 用户组

模板权限


模板权限是指对报表模板的访问和操作权限,模板创建者可为用户组分配以下模板权限:

  • 使用权限:有权在模板列表中查看模板并基于当前模板创建报表任务及报表订阅。

  • 接收权限:有权收到基于当前模板生成的报表订阅邮件。


更多信息,参见 管理报表模板权限

报表任务


报表任务是指基于指定报表模板生成报表的过程。报表工具支持以下生成方式:

  • 在每天、每周、每月等不同时间频率下由系统自动生成。

  • 用户手动触发生成。


更多信息,参见 创建报表任务

任务记录


任务记录是报表生成任务的详细执行信息,包括以下内容:

  • 任务的相关信息:任务关联模板、任务执行状态、任务执行时间等。

  • 生成的报表的相关信息:报表名称、报表生成时间、报表格式等。


更多信息,参见 管理任务记录

报表订阅


报表订阅是指基于指定报表任务,将生成的报表通过邮件推送给指定接收人的过程。报表工具支持以下订阅方式:

  • 在每天、每周、每月等不同时间频率下由系统自动发送邮件。

  • 用户手动触发发送邮件。


更多信息,参见 创建报表订阅

订阅记录


订阅记录是报表订阅的详细执行信息,包括以下内容:

  • 订阅的相关信息:订阅关联模板、订阅生成方式等。

  • 发送的邮件的相关信息:邮件标题、邮件接收人、邮件发送状态等。


更多信息,参见 管理订阅记录