在使用birt报表的时候感觉页面的BIRT Report Viewer头标题没有用,想去掉在网上一查原来有详细的参数设置,看来birt的功能还是很强大啊。现在转帖如下:
BIRT作为一款功能强大的开源报表工具,其版本的升级更新速度也非常快,从1.0到2.0,一直到最新的2.2.1版本,无论从功能上还是性能上都得到了极大的提高和扩充。BIRT也提供了一个标准的J2EE实现组件,可以发布到支持J2EE应用的web rver服务器上,可以对生成的报表进行预览等操作。在大家使用BIRT Viewer的时候,可能会对它日益纷繁的参数设置如云里雾里,在网上论坛里也有很多人碰到这样哪样的问题,同时官方的文档也不细致不全。所以我就对这些参数进行了一个简单系统的总结,希望能对大家的BIRT开发有所帮助。这些参数以2.2.1版本为准,请大家特别注意。
1.Servlet模式说明
查看BIRT Viewer自带的l文件,可以看到有以下几个pattern:
framet----采用Ajax框架,可以显示工具条,导航条和TOC面板,实现复杂的操作,如分页处理,导出数据,导出报表,打印等等。该模式下会自动生成report document文件(预览report design文件)到特定的目录(用户可以用参数指定,也可以定义在l里)。采用Ajax,速度较慢。
run----也采用Ajax框架,但不实现framet的复杂功能,不会生成临时的report document 文件(预览repo
rt design文件),也不支持分页,这个主要是应用在BIRT Designer里的preview tab里,可以支持cancel操作,其它不怎么常用。采用Ajax,速度较慢。
草莓酸奶冻preview---没有用到Ajax框架,直接调用底层Engine API对报表进行render,把生成的报表内容直接输出到浏览器。这种模式和run模式调用的是相同的Engine API,唯一区别在于run采用Ajax获取报表内容,而preview直接输出到浏览器。如果要支持分页,用户需要在URL上定义__page和__pagerange参数,这两个参数也会在后面详细说明。需要特别说明的是,在这几种预览模式中,preview的速度是最快的。
document---该模式主要是为了从report design文件生成report document文件。用户可以在URL上提定document文件生成存放的路径(存放在rver端),如果未指定,会直接生成rptdocument发送到客户端浏览器,用户可以下载到客户端。
output---该模式类似于framet,会自动生成report document文件(预览report design 文件),区别在于output不采用Ajax,而是将生成的报表内容直接输出到浏览器。
parameter---该模式主要用于生成一个参数对话框,一般用户不常用,用户可以直接通过提供的JSP Tag--parameterPage去实现参数对话框,不需要直接调用。
download---用于导出报表数据为CSV格式,当你使用framet工具条里的导出数据功能时,会用到这个模式。
l里的参数设置
下面我会对这些参数一一做以说明。
[BIRT_VIEWER_LOCALE]
设置默认的Locale信息,暂时没有太大意义。因为Locale的信息,首先以URL上定义的__locale为准,如果没有定义,会找到当前浏览器的Locale信息,最后才会用到这里定义的信息。
[BIRT_VIEWER_WORKING_FOLDER]
设置BIRT Viewer的工作目录。用户可以把report design或是report document文件存放在这个目录下,这样就可以在URL上采用相对路径去预览这些报表文件了。默认是当前根目录。
当前支持三种形式:
相对路径---这个相对当前的WEB应用的context root.
绝对路径
JAVA系统变量---可以在启动服务器时,定义JVM的系统变量,如java –Dmyworkingfolder=D:/reports。这样就可以在l中用${myworkingfolder}进行引用了。
[BIRT_VIEWER_DOCUMENT_FOLDER]
设置生成的document文件的存放路径。默认是documents目录。路径设置同上。
[WORKING_FOLDER_ACCESS_ONLY]
简单的报表访问限制控制实现,如果设为true,哪就只能预览存放在工作目录下的报表文件。默认值是fal。
[BIRT_VIEWER_IMAGE_DIR]
设置生成的临时图片的存放路径。默认是report/images目录。路径设置同工作目录设置。
[BIRT_VIEWER_LOG_DIR]
设置生成的日志文件存放路径。默认是logs目录。路径设置同工作目录设置。
[BIRT_VIEWER_LOG_LEVEL]
设置日志的level,可选的值有:ALL|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST|OFF。级别由高到低。
[BIRT_VIEWER_SCRIPTLIB_DIR]
设置用户script lib文件的存放目录(在报表中用到的Java Event Handler Class)。默认值是scriptlib。路径设置同工作目录设置。
[BIRT_RESOURCE_PATH]
设置用户资源存放路径,这些资源包括library文件,image文件等。默认是当前根目录。路径设置同工作目录设置。
稳重的近义词
[BIRT_VIEWER_MAX_ROWS]
设置获取datat的最大记录数。主要应用于设计报表的时候,预览报表如果记录数太多,会花费很多的时间,也可能会引起out of memory问题。默认是不限制。
[BIRT_VIEWER_MAX_CUBE_LEVELS]
设置CUBE查询的最大级数。和前面的参数作用类似。默认是不限制。
[BIRT_VIEWER_CUBE_MEMORY_SIZE]
设置在生成CUBE时,可以写在memory中的最大值,单位是MB。可以提高效率,写在内存会比直接写在硬盘快很多。但同时也要注意内存占用的问题。
[BIRT_OVERWRITE_DOCUMENT]
该参数主要用于framet/output模式,它们会生成临时的document文件上。如果设为true,则每次刷新页面时,都会重新去生成document文件,如果为fal,则不会重新生成,只会用原来的document文件去生成报表内容。
[BIRT_VIEWER_CONFIG_FILE]
定义properties文件的路径,不可以修改。
[BIRT_VIEWER_PRINT_SERVERSIDE]
友谊作文在framet工具条上,提供有后台服务器打印的功能,该参数可以设置是打开还是关闭后台打印的功能。默认是打开。可选值为:ON和OFF。
[HTML_ENABLE_AGENTSTYLE_ENGINE]
这个参数是会传递给Engine的,主要用于一些CSS的兼容性方面的问题。默认值是true。
3.viewer.properties参数设置
viewer.properties文件主要是定义一些扩展的参数。
#configurable variable for JSP ba href.Plea uncomment the below line.
#ba_url=127.0.0.1:8080
青椒猪肝该设置主要应用于代理服务器的情况下,在使用代理服务器后,从request里获取的URI 并非真正的URI,需要在这里定义。
#[EXTENSION SETTING]
定义输出的报表文件的后缀名,和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.p.0=,
viewer.p.1=;
10月份viewer.p.2=:
viewer.p.3=|
viewer.p.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 l will be ud
当前的日志都是通过Engine输出的,如果需要其它组件的日志输出,可以在这里定义。注意格式必须为logger……。而且该组件必须实现了java的logger。
可以单独为该组件设置日志级别,如果设为DEFAULT,就会使用l里的设置。
4.URL参数
下面是一些主要用到的URL参数。
“__report”
定义要预览的rptdesign文件路径,支持相对路径和绝对路径,相对路径是相对于l 中定义的工作目录。
“__document”
定义要预览的rptdocument文件路径,同样支持相对和绝对路径。相对路径是相对于l中定义的工作目录。在同时定义了__report和__document参数时,以__document 为优先,如未找到相应的document文件,才会从design文件生成document文件(framet/output)或是直接去render这个design文件(preview/run)。
“__title”
定义报表显示的标题。
“__showtitle”
是否显示framet模式下上方的标题部分。true|fal
“__toolbar”
是否显示framet模式下的工具条。true|fal
“__navigationbar”
是否显示framet模式下的导航条。true|fal
“__parameterpage”
铜板画
是否强制弹出或不弹出报表参数对话框。true|fal
“__format”
输出报表的格式,默认为html。现在支持:pdf|doc|xls|postscript|ppt
“__locale”
设置Locale信息,如__locale=zh_CN,注意必须是国家加语言。
“__svg”
设置chart输出是否以SVG格式输出。true|fal
framet和run模式下,会采用javascript判断客户端浏览器是否支持svg,但并非对所有浏览器有效。
“__bookmark”
设置页面要定位的书签名字。
“__istoc”
指定定位的书签是不是一个TOC名字。如为true,就会根据__bookmark参数值去获取一个真正的书签名,从而实现正常的跳转。这个主要用于定位到一个TOC上。
“__rtl”
指定HTML页面输出是否需要right to left。支持不同国家的阅读习惯,如阿拉伯国家是从右到左的。
“__page”
指定要输出的报表页数,这个依赖于报表的分页设计(page break)。
“__pagerange”
指定要输出的报表页数范围。如1,3,5-9。
“__resourceFolder”
定义资源目录路径。同l中的BIRT_RESOURCE_PATH设置。
“__asattachment”
是否以附件方式下载报表,如生成PDF或是其它格式里。默认是inline。