文档首页 / 快速开始

快速开始

从启动程序、初始化、登录,到用演示数据做出第一张网格报表并预览、发布的完整步骤。

概述

本文用 Sight Report 走通一条最短路径:启动程序 → 初始化 → 登录 → 新建网格报表 → 建 SQL 数据集 → 把字段拖进单元格 → 预览并发布。全程使用初始化时可选导入的演示数据,不需要自备数据库。

预计时间约 10 分钟。Sight Wall 的入门见文末「创建第一个大屏」。

前置条件

  • 已获得 Sight Report 程序包,其中包含 sight-report.jar、start.sh、start.bat、install.sh、install.bat。
  • 服务器已安装 Java 21 或更高版本(JDK 或 JRE 均可),且 java 在 PATH 中。2.0.61 之前的版本必须是 JDK。用 java -version 验证。
  • 其他环境要求见 系统要求。

操作步骤

1. 启动程序

在程序包所在目录执行:

系统 命令
Linux / macOS ./start.sh
Windows start.bat

脚本默认使用 prod 配置,监听端口 9091,前台运行,按 Ctrl+C 停止。启动脚本发现 Java 版本低于 21 或找不到 java 时会报错退出。

要长期运行,可安装为系统服务:Linux / macOS 执行 sudo ./install.sh,Windows 以管理员身份运行 install.bat。服务名取自 jar 名(sight-report)。

程序会在同级目录生成 data/(本地数据、配置、授权信息、备份)和 logs/(运行日志)。

2. 初始化

浏览器访问 http://<服务器IP>:9091/setup,按向导完成:

  1. 「数据库配置」:选择「内置数据库」。
  2. 「管理员账号」:填写用户名和密码(密码不少于 6 位,需同时含字母、数字、特殊字符),保持勾选「导入演示数据(推荐首次使用时勾选)」,点击「确定」。
  3. 出现“设置完成!”后点击「进入系统」。

各选项的完整说明见 首次初始化与登录。

3. 登录

在登录页输入刚设置的「用户账号」和「密码」,点击「登 录」。

4. 确认数据连接

打开「系统 > 数据连接」,「数据连接」页签的列表中应有一条名为 demo 的连接,它指向平台自己的数据库,演示表都建在其中。

提示:使用自己的业务库时,点击「新建数据连接」,填写「数据连接名称」「数据库类型」「主机」「端口」「数据库名称」「用户名」「密码」,先点「测试连接」再点「保存」。数据库类型后带“(需上传驱动)”的,需先在同页的「驱动管理」页签中「上传驱动」(仅支持 .jar 格式的 JDBC 驱动)。详见 数据源配置。

5. 新建网格报表

  1. 打开「系统 > 报表设计」。
  2. 点击右上角「新建」,选择「新建网格报表」。
  3. 在弹窗中填写「名称」(必填,最多 50 个字符),如 大区销售统计;「保存到」可选择目录,点击「确定」。
  4. 提示“创建成功”后,设计器会自动在新窗口打开。若浏览器拦截了新窗口,在列表中双击这一行即可打开设计器。

6. 新建 SQL 数据集

  1. 在设计器左侧的「模板数据集」页签中,点击「新建SQL数据集」。
  2. 「数据集名称」填 大区销售,「数据连接」选 demo。
  3. 在「SQL」框中输入:
select 所在大区,
       count(*) as 订单数,
       sum(订单金额) as 销售额
from demo_销售订单
where 订单状态 <> '已取消'
group by 所在大区
order by 销售额 desc
  1. 点击「数据预览」,应返回 7 行(华东、西北、华南、东北、西南、华北、华中)。
  2. 点击「确定」。保存时系统会读取 SQL 的输出列作为数据集字段,左侧数据集树中出现 大区销售 及其字段 所在大区、订单数、销售额。

7. 把字段放进单元格

  1. 在第 1 行的 A1、B1、C1 中分别输入表头文字:大区、订单数、销售额。
  2. 从左侧数据集树把字段拖到单元格:所在大区 拖到 A2,订单数 拖到 B2,销售额 拖到 C2。
  3. 选中 A2,在单元格设置的「数据」页签可看到「数据集」「数据字段」,「取值方式」为「列表」;在「布局」页签可看到「展开方向」为「↓ 向下」。这是从数据集树拖入字段时的默认设置,表示该格按数据集的行数向下逐行展开。

8. 预览、保存与发布

  1. 点击顶栏的「预览」。报表按数据向下展开,应显示 7 行,第一行为 华东,订单数 1045,销售额约 49735811.14(数值显示格式以单元格格式为准)。
  2. 点击「保存」保存草稿。
  3. 点击「发布」并按提示确认。发布成功后可在报表列表打开查看页(/report-view/<报表ID>)。

注意:导出和公开链接都要求报表已发布。草稿状态下调用导出接口会返回“报表尚未发布,无法查看!”。

演示数据的预期结果

上述 SQL 在演示数据上的完整结果如下(订单状态为“已取消”的订单被排除,共 4261 单):

所在大区 订单数 销售额
华东 1045 49735811.14
西北 627 30158182.91
华南 638 29540394.48
东北 645 28794167.14
西南 491 23211423.84
华北 431 21621643.41
华中 384 17622352.72

创建第一个大屏

Sight Wall 是独立程序,默认端口 9090,启动与初始化的方式与上文相同(sight-wall.jar,访问 /setup)。登录后:

  1. 打开「大屏设计 > 大屏管理」,点击右上角「新建大屏」。
  2. 在模板目录中挑选一个模板,点击「选用此模板」。
  3. 进入设计器后,在左栏「数据集」中新建数据集并给组件绑定数据;模板自带的是示例数据,上线前要换成真实数据。
  4. 使用工具栏的「自检」检查问题,预览确认后发布,在大屏管理列表中分享链接。

详见 创建第一个大屏。

注意事项

注意:升级时只替换 sight-report.jar,不要镜像同步或删除整个安装目录,否则 data/ 中的数据库、授权信息和备份会一并丢失。

提示:启动时可通过环境变量调整内存,例如 JVM_XMX=8g ./start.sh。不设置时 JVM 按可用内存的 75% 自适应,生产环境建议显式设置为 8g 或以上。

相关文档

联系我们

请填写您的信息,我们将在 1 个工作日内与您联系。