操作手册

数颜报表工具集基于数颜报表引擎研发而成,报表引擎的内核基于 Java 和 MySQL 实现,提供了设计报表和渲染报表的能力,报表引擎中的数据集加载器具备加载主流数据库数据的能力,这使得渲染报表时需要的业务数据可以存储在 MySQL、Oracle、SQL Server、PostgreSQL 和 ClickHouse 数据库中,存储业务数据的数据库,我们称之为报表业务数据库,存储报表引擎数据的数据库,我们称之为报表引擎数据库。

注意 报表业务数据库可以是 MySQL、Oracle、SQL Server、PostgreSQL 和 ClickHouse,也可以同时有多个和多种数据库,但报表引擎数据库目前只能是 MySQL。

安装操作

数颜报表设计器和报表浏览器采用 B/S 架构,基于 Java 和 MySQL 实现,可以在 Windows 和 Linux 操作系统中安装和运行,但在安装和运行之前,必须确保操作系统中已经安装好 Java 运行环境、可以访问报表引擎数据库和报表业务数据库。

环境

  • 安装和运行报表设计器和报表浏览器的服务器操作系统可以是 Windows 或 Linux

  • 服务器必须安装 JDK(或JRE,最低版本:1.8)

  • 服务器可以访问报表引擎数据库:MySQL(最低版本:5.7)

  • 服务器可以访问报表业务数据库:MySQL、Oracle、SQL Server、PostgreSQL、ClickHouse

方法

  • 从官方获得软件压缩包,在安装目录中解压即可

在 Windows 操作系统中执行命令

打开命令执行目录,用鼠标单击地址栏,地址栏内容呈现为全选状态,此时输入 cmd 三个字符,敲回车键,即可打开命令执行窗口,在命令执行窗口输入命令,敲回车键,即可执行命令。

  • 进入安装目录(所在的根目录),启动安装辅助工具,执行下列命令:
run.bat -start
sh ./run.sh start
  • 打开网页浏览器,输入安装辅助工具地址http://localhost:52080/

安装辅助工具能够降低安装工作的难度,请根据实际情况输入安装辅助工具地址。

  • 在呈现的网页中,选择报表设计器(或浏览器)

  • 更新配置文件

此处更新报表设计器(或浏览器)使用的配置文件,请做好以下配置,点击更新配置文件按钮。

数据库地址:报表设计器(或浏览器)使用的数据库地址,用户设置报表引擎数据库地址。

数据库用户:报表设计器(或浏览器)使用的数据库用户,用户设置报表引擎数据库用户。

数据库密码:报表设计器(或浏览器)使用的数据库密码,用户设置报表引擎数据库密码。

文件夹地址:报表设计器(或浏览器)使用的文件夹地址,用于设置报表模板文件夹地址。

服务器端口:报表设计器(或浏览器)使用的服务器端口,用于设置 Web 应用程序的端口。

许可证内容:用于设置报表设计器使用许可证的内容,报表浏览器不需要安装许可证。

  • 安装数据库

此处安装报表设计器(或浏览器)使用的数据库:请确定数据库配置无误后,点击安装数据库按钮,安装成功后,会在更新配置文件时指定的数据库中,创建报表引擎专用表,并初始化这些表的数据。

  • 安装许可证

此处安装报表设计器使用许可证:请从官方获得许可证内容,并复制到上图许可证内容处,点击安装许可证按钮,安装成功后,报表设计器才能被正常使用。

维护操作

日常维护工作主要包括启用、停用和配置,启用和停用都是执行命令,配置则借助安装辅助工具完成。

启用

  • 启用报表设计器

进入安装目录(所在的根目录),执行下列命令:

cd apps/report-builder
run.bat -start
cd apps/report-builder/
sh ./run.sh start
  • 启用报表浏览器

进入安装目录(所在的根目录),执行下列命令:

cd apps/report-browser
run.bat -start
cd apps/report-browser/
sh ./run.sh start

停用

  • 停用报表设计器

进入安装目录(所在的根目录),执行下列命令:

cd apps/report-builder
run.bat -stop
cd apps/report-builder/
sh ./run.sh stop
  • 停用报表浏览器

进入安装目录(所在的根目录),执行下列命令:

cd apps/report-browser
run.bat -stop
cd apps/report-browser/
sh ./run.sh stop

配置

打开浏览器,输入安装辅助工具地址,进入安装辅助工具主界面,选中报表设计器(或报表浏览器),设置好各配置项的值,点击更新配置文件按钮,即可完成配置工作。

这里的数据库地址是报表引擎数据库的地址,是按照JDBC规范配置数据库连接字符串,文件夹地址是存储报表模板文件的目录地址。

使用操作 - 报表设计器

报表设计器可以在现代浏览器中正常使用,现代浏览器能够理解和支持 HTML、XHTML、CSS3、ES6、W3C Document Object Model(DOM)。

注意 推荐使用谷歌 Chrome 浏览器。

请在网页浏览器地址栏中输入报表设计器地址:http://localhost:52081/,出现登录界面,输入用户和密码,点击登录按钮,进入报表设计器主界面。

注意 请根据实际情况输入报表设计器地址,默认用户和密码是 adminok

报表设计器能够新建、修改、测试、发布、迁移和部署报表,报表设计的主要工作是定义报表中使用了哪些数据集、基于这些数据集提供了哪些查询方式和展示内容,而数据集是属于某个特定数据库,设计报表之前,应先定义好数据库和数据集。

从上可知:报表设计的一般过程应是先定义好数据库和数据集、后设计报表

报表设计器的左上角是数颜 LOGO,点击可以展开或收缩左侧栏,左侧栏有四个图标,从上到下是报表、数据库、数据集、设置的视图切换按钮,点击按钮可以展开左侧栏和切换到对应的视图环境。

报表

  • 新建:可以新建报表、目录,设置报表或目录的名称、备注。
  • 删除:可以删除报表、目录,请谨慎操作,删除后不能恢复。
  • 编辑:可以编辑报表、目录,修改报表或目录的名称、备注。
  • 排序:可以拖拽报表节点,调整报表在目录中的显示顺序。
  • 打开:可以打开报表模板,进行预览、运行或设计报表的工作。
  • 预览:可以查看报表的仿真效果,加载模拟数据渲染报表,验证设计和预期的效果是否一致。
  • 运行:可以查看报表的真实效果,加载真实数据渲染报表,验证设计和预期的效果是否一致。
  • 设计:可以设计报表模板,定义报表的查询方式和展示内容,持续优化调整,达成预期效果。
  • 测试:可以预览运行报表,验证设计和预期的效果是否一致。
  • 发布:可以导出报表模板,保存到特定目录,以备后用。
  • 部署:可以导入报表模板,以供再次设计。
  • 备份:可以导出报表模板,转移到特定存储设备,以备后用。
  • 迁移:可以导出报表模板,转移到其他环境,再导入报表模板。

数据库

  • 新建:可以新建数据库,指定数据库地址、用户和密码。
  • 删除:可以删除数据库,请谨慎操作,删除后不能恢复。
  • 编辑:可以编辑数据库,修改数据库地址、用户和密码。
  • 排序:可以调整数据库显示位置,请参考报表排序操作。
  • 查看:可以查看数据库,确认数据库的地址等基本信息。

数据集

  • 新建:可以新建数据集、目录,设置名称、备注。
  • 删除:可以删除数据集、目录,请谨慎操作,删除后不能恢复。
  • 编辑:可以编辑数据集、目录,修改名称、备注。
  • 排序:可以调整数据集显示位置,请参考报表排序操作。
  • 查看:可以查看数据集,确认数据集的数据来源、查询参数、返回字段和模拟数据。
  • 定义:可以定义数据集,设置数据集的数据来源、查询参数、返回字段和模拟数据。
  • 引用:可以引用数据集,在报表中添加和删除对数据集的引用关系。

设置

  • 用户:可以新增和删除用户、启用和停用账号、为用户分配角色、重置密码。
  • 权限:可以新增和删除角色、启用和停用角色、为角色分配权限。
  • 密码:可以修改当前登录用户的密码。

其他

  • 切换用户:可以切换当前登录用户。
  • 回到首页:可以回到系统首页。
  • 退出系统:可以直接关闭浏览器或浏览器标签页,就能安全退出系统。

使用操作 - 报表浏览器

报表浏览器都可以在现代浏览器中正常使用,现代浏览器能够理解和支持 HTML、XHTML、CSS3、ES6、W3C Document Object Model(DOM)。

注意 推荐使用谷歌 Chrome 浏览器

请在网页浏览器地址栏中输入报表浏览器地址:http://localhost:52082/,出现登录界面,输入用户和密码,点击登录按钮,进入报表浏览器主界面。

注意 请根据实际情况输入报表浏览器地址,默认用户和密码是 adminok

报表

  • 查看:可以查看报表内容。
  • 打印:可以打印报表内容,基于现代浏览器打印技术实现。
  • 部署:可以导入报表模板,实现在浏览器中部署报表。
  • 备份:可以导出报表模板,转移到特定存储设备,以备后用。
  • 迁移:可以导出报表模板,转移到其他环境,再导入报表模板。

数据库

  • 设置:可以设置数据库的地址、用户和密码。

设置

  • 用户:可以新增和删除用户、启用和停用账号、为用户分配角色、重置密码。
  • 权限:可以新增和删除角色、启用和停用角色、为角色分配权限。
  • 密码:可以修改当前登录用户的密码。

其他

  • 切换用户:可以切换当前登录用户。
  • 回到首页:可以回到系统首页。
  • 退出系统:可以直接关闭浏览器或浏览器标签页,就能安全退出系统。