1 概述

本安装文档主要指导报表系统部署和配置,包括

  • 配置WEB应用,使得能够支持报表系统访问。
  • 配置报表系统的知识库和相关属性。

详细的报表配置请参考《报表配置手册》

1.1 约束条件

本安装文档适用的报表系统版本为V3.4版本,新版本中部分配置可能产生变更,请检查您的报表系统版本是否为适合的版本。
本文档的受众为报表系统开发人员、报表开发人员、前端实施维护人员和系统管理员。

2 安装

本节描述安装的所需条件和安装步骤。

2.1 必要条件

2.1.1 WEB容器

报表系统需要一个Web容器作为宿主进行部署,这里所谓的Web容器就是我们常用的TomcatResinJBOSSBea WeblogicIBM Websphere等等。
报表系统作为Web容器的一个Servlet而存在,理论上来讲,报表系统能够部署到任意符合JSP1.3标准的web容器中,常用的Web容器的版本需求如下:

  • Tomcat 5.5以上版本
  • WebSphere 5.1以上版本
  • JBOSS 4.0以上版本
  • Weblogic 7.0以上版本

在以下的文档中,我们集中讨论在Tomcat5.5以上版本和IBM Websphere5.1以上版本中部署的步骤。
WEB容器中有几个目录需要明确:

  • ROOT目录:也称跟目录,是WEB站点部署之后客户访问的最顶层目录,一般使用http://site_server:port/访问这个目录。对于多站点部署的应用,根目录特指报表系统部署的宿主Web虚拟站点的根目录。
  • WEB-INF目录:JSP站点所必须的配置目录,在根目录下,名称为"WEB-INF",不能改变,只能从服务器端访问,不能从客户端使用http协议访问。
  • Class目录:部署web应用所需要的java类文件的目录,在WEB-INF目录下,名称为"classes",不能改变。
  • Lib目录:部署Web应用所需要的附加库文件的目录,在WEB-INF目录下,名称为"lib",不能改变。
  • 站点配置文件web.xml:在Web-INF目录下的一个固定文件,配置整个虚拟站点的访问规则和行为。
  • 日志文件:日志文件主要是为了调试报表系统而建立,默认的情况下,日志文件是以sqlreport.log为文件名,在WEB服务器的日志文件目录下可以找到这个文件,你也可以使用服务器的Console输出观察这些日志的输出。

2.1.2 报表引擎所适用的库文件

报表文件使用的库文件包括以下版本的库

  • Spring 2.1以上版本
  • Apache POI 3.0以上版本
  • Dom4J 1.6.1以上版本
  • jdbc2_0-stdext
  • oscache-2.1 以上版本
  • c3p0-0.9.0 以上版本
  • ant-1.6.5 以上版本
  • log4j-1.2.11 以上版本

如果需要编译源代码,还需要junit-3.8.1以上版本。

2.1.2.1 检查POI版本是否合适

POIApache基金会开发的一套操作Microsoft Office系列文档的开源JAVA库,目前的最新发布版本为poi-3.0.2-FINAL-20080204,可以在http://poi.apache.org下载更新的版本。报表系统主要使用POI作为导出Excel文件的支撑库。
ApachePOI3版本中做了一些模型上的改动,导致某些调用方法约束的变化,所以报表系统需要严格限制POI的版本。在报表系统实际应用中,POI库只有在"导出报表数据到Excel"的时候调用,所以可以在安装完成之后进行POI版本的校验。
具体校验的步骤如下:
1、在客户端打开Internet Explorer,访问任意一张可用的报表。
2、点击报表工具栏上面的"Excel"按钮,执行导出Excel操作。
3、到报表系统服务器上检查报表输出的日志信息,定位到如下的标识位置
-----------------------POI LIB-----------------------
D:\develop\JavaProjects\enrisingReport\webRoot\WEB-INF\lib\poi-3.0.2-FINAL-20080204.jar
----------------------------------------------
这个文本就是导出使用的POI库的地址。
POI库的开发是大致向下兼容的,一般而言,可以删除旧版本的POI库并使用新的POI版本库替换。

2.2 安装

2.2.1 介质

安装介质包含以下几个部分的文件
1config目录:报表配置的主文件,一般第一次部署之后这个不用替换,否则可能会导致现在正在使用的报表定义丢失。
2libs目录:报表系统所需要的全部库文件列表。
3main目录:报表系统自身的代码包。代码包可能以两种方式发布,class文件和jar文件
4web目录:报表系统所需要的WEB支撑的文件。
安装介质包可以从发布的SVN站点上取得。

2.2.2 安装步骤

1、停止当前使用的Web容器,以下使用tomcat作为配置的示例。
2、打开 WEB-INF目录 下的web.xml文件,添加一个Servlet到配置中
    <servlet>
        <servlet-name>SqlReportServlet</servlet-name>
        <servlet-class>com.enrising.report.engineer.render.SqlReportServlet</servlet-class>
    </servlet>

    <servlet-mapping>
        <servlet-name>SqlReportServlet</servlet-name>
        <url-pattern>*.rpt</url-pattern>
    </servlet-mapping>
3、拷贝 main下面的文件和lib下面的文件到 Lib目录
4、拷贝 config 目录下的所有文件到 Web-INF目录下的classessqlreport目录,拷贝完成的目录结构应该为
    WEB-INF\classes\sqlreport\reports
    WEB-INF\classes\sqlreport\com.enrising.report.engineer.xml
    WEB-INF\classes\sqlreport\com.enrising.report.engineer.spring.xml
5、拷贝部署下web目录下的文件到站点根目录下的sqlreport目录,拷贝完成之后目录结构应该为
    \sqlreport\help
    \sqlreport\images
    \sqlreport\script
    \sqlreport\customizePage.jsp
6、启动应用
7、在客户端输入 http://server:port/test.rpt,如果出现报表引擎报错,则表明报表配置成功。