第二章 BIRT设计器概述及本地化支持（续）(转载)

最新推荐文章于 2020-12-26 09:02:09 发布

David_WY

最新推荐文章于 2020-12-26 09:02:09 发布

阅读量201

点赞数

分类专栏： BIRT 文章标签： BIRT

BIRT 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

2.3 BIRT Runtime配置详解

一.web.xml

参数配置context-param

<context-param>
  <param-name>BIRT_VIEWER_LOCALE</param-name>
  <param-value>en-US</param-value>
</context-param>

<!--
     Default timezone setting.
     Examples: "Europe/Paris", "GMT+1".
     Defaults to the container's timezone.
     时区
     格式："Europe/Paris", "GMT+1"

默认为容器的时区
  -->
<context-param>
  <param-name>BIRT_VIEWER_TIMEZONE</param-name>
  <param-value></param-value>
</context-param>


<context-param>
  <param-name>BIRT_VIEWER_WORKING_FOLDER</param-name>
  <param-value></param-value>
</context-param>


<context-param>
  <param-name>BIRT_VIEWER_DOCUMENT_FOLDER</param-name>
  <param-value></param-value>
</context-param>

<context-param>
  <param-name>WORKING_FOLDER_ACCESS_ONLY</param-name>
  <param-value>true</param-value>
</context-param>

<context-param>
  <param-name>BIRT_VIEWER_IMAGE_DIR</param-name>
  <param-value></param-value>
</context-param>

<context-param>
  <param-name>BIRT_VIEWER_LOG_DIR</param-name>
  <param-value></param-value>
</context-param>

<context-param>
  <param-name>BIRT_VIEWER_SCRIPTLIB_DIR</param-name>
  <param-value></param-value>
</context-param>


<context-param>
  <param-name>BIRT_RESOURCE_PATH</param-name>
  <param-value></param-value>
</context-param>

<context-param>
  <param-name>BIRT_VIEWER_MAX_ROWS</param-name>
  <param-value></param-value>
</context-param>

<context-param>
  <param-name>BIRT_VIEWER_MAX_CUBE_ROWLEVELS</param-name>
  <param-value></param-value>
</context-param>
<context-param>
  <param-name>BIRT_VIEWER_MAX_CUBE_COLUMNLEVELS</param-name>
  <param-value></param-value>
</context-param>

<context-param>
  <param-name>BIRT_VIEWER_CUBE_MEMORY_SIZE</param-name>
  <param-value></param-value>
</context-param>

<context-param>
  <param-name>BIRT_VIEWER_CONFIG_FILE</param-name>
  <param-value>WEB-INF/viewer.properties</param-value>
</context-param>

<context-param>
  <param-name>BIRT_VIEWER_PRINT_SERVERSIDE</param-name>
  <param-value>ON</param-value>
</context-param>

<context-param>
  <param-name>HTML_ENABLE_AGENTSTYLE_ENGINE</param-name>
  <param-value>true</param-value>
</context-param>

<context-param>
  <param-name>BIRT_FILENAME_GENERATOR_CLASS</param-name>
  <param-value>org.eclipse.birt.report.utility.filename.DefaultFilenameGenerator</param-value>
</context-param>

二. Servlet模式说明

<servlet>
<servlet-name>ViewerServlet</servlet-name>
<servlet-class>org.eclipse.birt.report.servlet.ViewerServlet</servlet-class>
</servlet>

<servlet>
<servlet-name>EngineServlet</servlet-name>
<servlet-class>org.eclipse.birt.report.servlet.BirtEngineServlet</servlet-class>
</servlet>

<!--

frameset ---- 采用Ajax框架，可以显示工具条，导航条和TOC面板，实现复杂的操作，

如分页处理，导出数据，导出报表，打印等。

该模式下会自动生成report document文件(预览report design文件)到特定的目录

(用户可以用参数指定，也可以定义在web.xml里)。采用Ajax，速度较慢。

-->

<servlet-mapping>
<servlet-name>ViewerServlet</servlet-name>
<url-pattern>/frameset</url-pattern>
</servlet-mapping>

<!--

run ---- 也采用Ajax框架，但不实现frameset的复杂功能，

不会生成临时的report document文件(预览report design文件)，也不支持分页，

这个主要是应用在BIRT Designer里的preview tab里，

可以支持cancel操作，其它不怎么常用。采用Ajax，速度较慢。

-->
<servlet-mapping>
<servlet-name>ViewerServlet</servlet-name>
<url-pattern>/run</url-pattern>
</servlet-mapping>

<!--

preview --- 没有用到Ajax框架，直接调用底层Engine API对报表进行render，

把生成的报表内容直接输出到浏览器。

这种模式和run模式调用的是相同的Engine API，

唯一区别在于run采用Ajax获取报表内容，而preview直接输出到浏览器。

如果要支持分页，用户需要在URL上定义__page和__pagerange参数。

需要特别说明的是，在这几种预览模式中，preview的速度是最快的。

-->
<servlet-mapping>
<servlet-name>EngineServlet</servlet-name>
<url-pattern>/preview</url-pattern>
</servlet-mapping>

<!--

download --- 用于导出报表数据，

当你使用frameset工具条里的导出数据功能时，会用到这个模式。

-->

<servlet-mapping>
<servlet-name>EngineServlet</servlet-name>
<url-pattern>/download</url-pattern>
</servlet-mapping>

<!--

parameter --- 该模式主要用于生成一个参数对话框，一般用户不常用，

用户可以直接通过提供的JSP Tag--parameterPage去实现参数对话框，不需要直接调用。

-->

<servlet-mapping>
<servlet-name>EngineServlet</servlet-name>
<url-pattern>/parameter</url-pattern>
</servlet-mapping>

<!--

document --- 该模式主要是为了从report design文件生成report document文件。

用户可以在URL上提定document文件生成存放的路径(存放在server端)，如果未指定，

会直接生成rptdocument发送到客户端浏览器，用户可以下载到客户端。

-->

<servlet-mapping>
<servlet-name>EngineServlet</servlet-name>
<url-pattern>/document</url-pattern>
</servlet-mapping>

<!--

output --- 该模式类似于frameset，会自动生成report document文件(预览report design文件)，

区别在于output不采用Ajax，而是将生成的报表内容直接输出到浏览器。

-->

<servlet-mapping>
<servlet-name>EngineServlet</servlet-name>
<url-pattern>/output</url-pattern>
</servlet-mapping>

<!--

extract---

-->
<servlet-mapping>
<servlet-name>EngineServlet</servlet-name>
<url-pattern>/extract</url-pattern>
</servlet-mapping>

三.viewer.properties参数设置

viewer.properties文件主要是定义一些扩展的参数。

# configurable variable for JSP base href. Please uncomment the below line.
#base_url=http://127.0.0.1:8080
该设置主要应用于代理服务器的情况下，在使用代理服务器后，从request里获取的URI并非真正的URI，需要在这里定义。

# [EXTENSION SETTING]
viewer.extension.html=html
viewer.extension.pdf=pdf
viewer.extension.postscript=ps
viewer.extension.doc=doc
viewer.extension.xls=xls
viewer.extension.ppt=ppt
定义输出的报表文件的后缀名，和format相关联。

# [OUTPUT FORMAT LABEL NAME]
viewer.label.html=HTML
viewer.label.pdf=PDF
viewer.label.postscript=PostScript
viewer.label.doc=Word
viewer.label.xls=Excel
viewer.label.ppt=PowerPoint
定义导出报表对话框里的报表格式列表，和format相关联，这样名字会更有意义。

# [CSV SEPARATOR]
viewer.sep.0=,
viewer.sep.1=;
viewer.sep.2=:
viewer.sep.3=|
viewer.sep.4=/t
支持多种CSV分隔符，用户也可以增加新的分隔符(只支持char，而不是string)。

但同时需要修改JSP文件和Messages.properties文件。

# [LOGGERS]
# "logger."+class=level
# if no level is specified or the text "DEFAULT",
# then the default level from the web.xml will be used
logger.org.eclipse.datatools.connectivity.oda=DEFAULT
logger.org.eclipse.datatools.enablement.oda=DEFAULT
当前的日志都是通过Engine输出的，如果需要其它组件的日志输出，可以在这里定义。

注意格式必须为logger.org……。而且该组件必须实现了java的logger。
可以单独为该组件设置日志级别，如果设为DEFAULT，就会使用web.xml里的设置。

四、URL参数

下面是一些主要用到的URL参数。

“__report”
定义要预览的rptdesign文件路径，支持相对路径和绝对路径，相对路径是相对于web.xml中定义的工作目录。

“__document”
定义要预览的rptdocument文件路径，同样支持相对和绝对路径。相对路径是相对于web.xml中定义的工作目录。

在同时定义了__report和__document参数时，以__document为优先，如未找到相应的document文件，

才会从design文件生成document文件(frameset/output)或是直接去render这个design文件(preview/run)。

“__title”
定义报表显示的标题。

“__showtitle”
是否显示frameset模式下上方的标题部分。true | false

“__toolbar”
是否显示frameset模式下的工具条。true | false

“__navigationbar”
是否显示frameset模式下的导航条。true | false

“__parameterpage”
是否强制弹出或不弹出报表参数对话框。true | false

“__format”
输出报表的格式，默认为html。现在支持：pdf | doc | xls | postscript | ppt

“__locale”
设置Locale信息，如 __locale=zh_CN，注意必须是国家加语言。

“__svg”
设置chart输出是否以SVG格式输出。true | false. frameset和run模式下，

会采用javascript判断客户端浏览器是否支持svg，但并非对所有浏览器有效。

“__bookmark”
设置页面要定位的书签名字。

“__istoc”
指定定位的书签是不是一个TOC名字。这个主要用于定位到一个TOC上。

如为true,就会根据__bookmark参数值去获取一个真正的书签名，从而实现正常的跳转。

“__rtl”
指定HTML页面输出是否需要right to left。支持不同国家的阅读习惯，如阿拉伯国家是从右到左的。

“__page”
指定要输出的报表页数，这个依赖于报表的分页设计(page break)。

“__pagerange”
指定要输出的报表页数范围。如1,3,5-9。

“__resourceFolder”
定义资源目录路径。同web.xml中的BIRT_RESOURCE_PATH设置。

“__asattachment”
是否以附件方式下载报表，如生成PDF或是其它格式里。默认是inline。

“__masterpage”
是否要显示master page。true | false

“__designer”
该参数主要是应用在BIRT Designer环境下，如会读取cache的报表参数等等，一般不用。true | false

“__overwrite”
该参数同web.xml定义的参数，不过web.xml里是全局设置，在URL上通过参数可以定义本次操作的设置。

“__imageID”
内部参数，用于image的引用，一般不用。

“__maxrows”
设置Dataset查询的最大记录数，要注意这个设置是全局的，会影响后面所有的请求。

主要用于BIRT Designer下，提高报表设计效率。同web.xml中的BIRT_VIEWER_MAX_ROWS设置。

“__maxlevels”
设置查询获取Cube的最大级数。同上面的__maxrows，也主要用于BIRT Designer设计环境。
同web.xml中的BIRT_VIEWER_MAX_CUBE_LEVELS设置。

“__cubememsize”
同web.xml中的BIRT_VIEWER_CUBE_MEMORY_SIZE参数设置。

“__instanceid”
如果查看BIRT输出的HTML代码，你就可以看到一些HTML Element会有一个iid的属性(如table)，

这个就是instanceid。这个是Engine动态生成的，不可提前预知。

所以你需要从HTML代码中得到这个值。该参数主要是为了获取reportlet(报表片断，

如只输出报表中的一个Table或是一个Chart)。需要配合__isreportlet参数。

“__isreportlet”
       指定当前输出是不是一个reportlet。true | false
       特别说明：为了输出一个reportlet，BIRT现在提供两种方式。
       1．为要输出的对象(表格或是Chart)定义一个bookmark，然后可以用下面的URL输出reportlet.
       http://localhost:8080/birt/frameset?__report=test.rptdesign&__bookmark=bk&__isreportlet=true

2．采用instanceid，但这个值事先是无法预知的，需要预览一次后从HTML代码中得到。

       然后用下面的URL输出reportlet.
       http://localhost:8080/birt/output?__report=test.rptdesign&__instanceid=iid&__isreportlet=true
       还有就是要注意，reportlet只支持document文档。如果是预览design文档去输出reportlet，

就必须要使用frameset/output(自动生成document文档)。

“__clean”
BIRT里临时生成的一些文件都是和session相关的，比如临时document文件，还有image文件。

这些文件也可以通过session进行管理，这个参数就是指定是否需要在session

timeout的时候清除这些临时文件。默认值是true。
true | false

“__dpi”
可以设置输出Chart的dpi数值。

“__fittopage”
暂时这个参数只对PDF和postscript格式报表有效，指定是否调整至适合页面。

“__pagebreakonly”
暂时这个参数只对PDF和postscript格式报表有效，指定是否只采用BIRT报表内定的分页设置。

这个参数一般需要和__fittopage联合使用。

“__agentstyle”
同web.xml中的HTML_ENABLE_AGENTSTYLE_ENGINE参数设置。

========================== 后台Server端打印相关参数 ==========================
“__action” 定义执行的指令名称。当前只支持print指令，用于后台服务器打印。

“__printer” 后台打印机名称。

“__printer_copies” 对应打印机的打印份数参数。

“__printer_collate” 对应打印机的双面打印参数。

“__printer_duplex” 对应打印机的duplex参数。

“__printer_mode” 对应打印机的模式参数。是单色还是彩色。

“__printer_pagesize” 对应打印机的纸型参数。比如A4。

========================== JSP Tag相关参数 ===================================
“__id”
viewer的ID号，这个参数一般不常用，主要用于JSP Tag中，如在一个页面插入两个BIRT Viewer，

而且预览同一个报表文件，这时候因为在一个session下面，所以需要用不同的ID去生成单独的document文件。

不至于都生成同一个document文件上，从而引发冲突。

“__pattern”
在JSP Tag中用于指定要提交的Servlet Pattern名字，如frameset/output/run/preview等。

主要用于采用parameter模式生成parameter dialog对话框时。

“__target”
可以指定提交到的窗口名称。如_blank,_self等。

“__nocache”
指定是否会用到cache的报表参数值，这些cache的值一般保存在rptconfig文件里。

在设计报表并预览的时候，可以保存输入的报表参数值。这个在runtime的时候不常用。

========================== 报表参数相关 ===================================
“__isnull”
指定当前的报表参数为null值，后面是报表的参数名。

“__islocale”
指定当前的报表参数值是和Locale/Format相关的，

必须用特定的Locale/Format转化参数值(从String转化为Object)。格式为__islocale=paramName。

“__isdisplay__”
指定报表参数的displayText值,格式为__isdisplay__paramName=displayText。

可以在报表中引用displayText值，如params[“p1”].displayText。在URL上传displayText时如下(报表参数名为p1)：
&__isdisplay__p1=hello

“__islocale__”
指定该报表参数值是Locale/Format相关的，同时给定了参数值。格式为__islocale__paramName=paramValue。

========================== Export Data参数 ===================================
“__exportEncoding”
该参数应用于导出数据为CSV中，可以指定导出的文件编码，如GBK或是GB2312等。

“__sep”
该参数应用于导出数据为CSV中，可以指定数据分隔符，如逗号，冒号等。

“__exportdatatype”
该参数应用于导出数据为CSV中，可以指定是否输出数据类型。true | false

“ResultSetName”
要导出数据的记录集名字。

“SelectedColumnNumber”
要导出的栏位数。

“SelectedColumn”
要导出的数据栏位名称。

具体可以查看BirtSimpleExportDataDialog.js文件。

五、其它参数设置
在BIRT Viewer里还有一个比较特殊的参数应用，就是用户可以自定义自已的servlet，

       然后传递对象到Application Context中，在报表中就可以从全局的Application Context去获取到这个对象。
       这里相关的有两个内定的参数，AppContextKey和AppContextValue。下面是一个简单的示例。
       public void service( HttpServletRequest request,

          HttpServletResponse response ) throws ServletException,IOException, BirtException  {
           String myKeyName = "mykey";
           List values = new ArrayList();
           values.add( "hello" );  values.add( new Date() );
           request.setAttribute( "AppContextKey", myKeyName );
           request.setAttribute( "AppContextValue", values );
           RequestDispatcher rd = request.getRequestDispatcher( "/frameset" );
           rd.include( request, response );

}

2.4一个简单的BIRT的报表案例

创建报表工程

选择文件->新建->项目。如下图中的新建项目将显示可以创建的项目的类型。

图2-19 新建报表

展开商业智能和报表工具（Business Intelligence and Reporting Tools），选择报表项目（Report Project），然后选择下一步。

在新建报表项目的工程名称中输入下列文本My Report，如图所示：

图2-20 新建报表项目

要添加项目，请选择完成。现在可在导航器视图中看到该项目，如图所示。

图2-21 报表导航器

创建报表

选择文件->新建->报表。如下图：

图2-22 新建报表

选择My Report，输入报表文件名称，如：Customers.rptdesign

选择下一步。

可以通过一下方式创建报表：

从空白报表开始设计

使用预定义的报表模版

图2-23 选择模板

选择完成。新报表将出现在主窗口中，布局编辑器将显示空的报表页。如下图所示：

图2-24报表编辑器

数据源配置

在布局编辑器中开始设计报表之前，构建 BIRT 数据源以将报表连接至数据库或其他类型的数据源。构建数据源时，要指定驱动程序类、数据源名称和其他连接信息（例如，用户名和密码）。Birt自带一个已经配置为与 BIRT 报表设计器配合使用的样本数据库 Classic Models，对于本教程使用的是Derby数据库。

选择数据资源管理器(Data Explorer)。如果使用缺省报表设计透视图，则数据资源管理器位于布局编辑器的左边，在选用板（Palette）的旁边，如图所示。如果它尚未打开，则选择窗口->显示视图->数据资源管理器。

图2-25 数据资源管理器

右键单击Data Sources然后从上下文菜单中选择新建数据源。新建数据源显示可以创建的数据源的类型，如图所示。

图2-26 新建数据源

Classic Models Inc.Sample DataBase ———上面说过是BIRT样本数据库。

Flat File Data Source ———从CSV、SSV、TSV、PSV四种格式的文件获取数据源。

JDBC Data Source ——— 通过配置jdbc连接数据库。

Script Data Source ——— 通过编写脚本获取数据源。

Web Services Data Source ——— 通过web service方式获取数据源。

XML Data Source ——— 从xml文件获取数据源。

这里我们介绍通过示例数据库配置数据源。

图2-27 完成数据源的建立

完成以后编辑数据源，可以看到如下界面

图2-28 测试数据源

测试连接，会看到测试成功。

图2-29 测试数据源成功

后文我们会详细介绍怎么配置JDBC数据源，管理驱动程序。

创建数据集

数据集标识要从数据源检索的数据。我们是通过连接至 JDBC 数据源，则使用 SQL SELECT 语句来标识要检索的数据。

在数据资源管理器（Data Explorer）中，右键单击数据集（Data Set）并从上下文菜单中选择新建数据集。

在新建数据集的数据集名称中，输入下列文本，如图所示：

图2-30 新建数据集

对于其他字段选择缺省值。

Data Set Types 数据集类型一般使用jdabc数据源连接分为两种：一种是SQL Select Query为select查询，一种是SQL Stored Procedure Query存储过程查询（使用存储过程查询，必须数据库中已创建存储过程）。

Data Source显示先前创建的数据源的名称。

Data Set Types 指示该数据集使用 SQL Select Query查询。

选择下一步（Next）。

查询显示可帮助您创建 SQL 查询的信息。可用项列示数据库中的所有表。可以单击表旁边的加号（+）标志来显示该表的各个列。编辑数据集右边的文本区域显示 SQL SELECT 语句的必需关键字：

在文本区域中，输入下列 SQL SELECT 语句以指定要检索的数据：

如：select * from CLASSICMODELS.CUSTOMERS

虽然数据集编辑器以大写字母显示表和列名称，但可用您喜欢的方式输入这些名称，因为 SQL 不区分大小写。如果您不想输入查询，则可将列和表从可用项拖动到文本区域。

图2-31 编写查询sql

选择完成（Finish）以保存数据集。编辑数据集将显示在查询中指定的列，并提供编辑数据集的选项。

选择预览结果（Preview Results）以确保查询有效并且它返回正确的数据。如果正确输入了 SELECT 语句，您应该看到图中显示的结果。这些是查询返回的数据行。

图2-32 预览查询结果

选择确定，数据集创建成功。

对报表进行布局

1．在本过程中，您在报告页中插入元素以显示先前创建的数据集的数据。先插入一个表元素，然后在该表中插入数据元素。

2．选择选用板“画板（Palette）”。选用板显示所有可布置在报告中的元素。

3．为了以后的表布局美观，我们先从选用板中的“网格（Gird）”元素拖拽放入布局编辑器内（即文件的“布局（Layout）”视图）的报告中，插入时提示您要制定创建的行列数的详细信息：输入1列2行，

4．然后，将选用板中的表元素“表（Table）”拖放到布局编辑器内的报告中。插入表提示您指定要对此表创建的列数和详细信息行数。指定5列和1个详细信息行，然后选择“确定”。具有5列和1个详细信息行的表将出现在布局编辑器中。现在，您就可以在该表中插入数据了。

图2-33 插入网格

图2-34 插入表

5．选择数据资源管理器（Data Explorer）视图。在数据资源管理器视图中，展开“数据集（Data Sets）”，然后展开Customers，在查询中指定的列将出现在Customers下面。

将CUSTOMERNAME从Data Explorer中拖放到表的详细信息行“Detail Row”中的第一个单元格内（如下图）。详细信息行显示报告中的主要数据。在完成的报告中，详细信息行重复显示数据集中的所有数据行。

图2-35 插入数据项

6．然后采用同样的方法将CUSTOMERNUMBER，SALESREPEMPLOYEENUMBER，ADDRESSLINE1，PHONE这四个数据项从Data Explorer中拖放到表的详细信息行中，完成的报告中，详细信息行重复显示数据集中的所有数据行。如下图：

图2-36 表格布局

7．选中报表格左下角的“”（如上图），在下方的视图中会显示本Table的信息：

图2-37 属性编辑器

选择第二项“绑定”，将数据集的下拉框选为“Customer”，下方的Data Colum Binding中就会显示我们数据集中的数据项，通过此步我们将本报表与数据集绑定起来，否则将不能显示（一般将数据集中的数据项拖拽如Table中后，会自动将次数据集的数据项与本报表绑定，我们可以不用进行这步操作。但我们必须得清楚这个操作）。

完成后，表格的基本设置就算做完了。

格式化与预览

通过布局编辑器中选择“Preview”可对我们设计的报表进行预览。

我们通过一系列格式化操作，将报表进行美化。

完成以后则可，通过工具栏中提供的各种不同的视图模式来进行预览，如下：

图2-38 数据预览

使用默认的在Web查看器中查看报表预览结果如下：

图2-39 在web容器中预览报表

这个报表只是一个最基本的报表，后文会详细讲解怎么设置格式，样式，布局，美化报表。

本文转载至：https://blog.csdn.net/z1012890225/article/details/37815907

David_WY

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
第二章 BIRT设计器概述及本地化支持（续）(转载)

2.3 BIRT Runtime配置详解一.web.xml参数配置context-param &lt;!-- Default locale setting. 设置默认的Locale信息。 --&gt; &lt;context-param&gt; &lt;param-name&gt;BIRT_VIEWER_LOCALE&lt;/param-name&gt; &lt;param-...
复制链接

扫一扫