2023年7月3日发(作者：)

在使用birt报表的时候感觉页面的BIRTReportViewer头标题没有用，想去掉在网上一查原来有详细的参数设置，看来birt的功能还是很强大啊。现在转帖如下：BIRT作为一款功能强大的开源报表工具，其版本的升级更新速度也非常快，从1.0到2.0，一直到最新的2.2.1版本，无论从功能上还是性能上都得到了极大的提高和扩充。BIRT也提供了一个标准的J2EE实现组件，可以发布到支持J2EE应用的webserver服务器上，可以对生成的报表进行预览等操作。在大家使用BIRTViewer的时候，可能会对它日益纷繁的参数设置如云里雾里，在网上论坛里也有很多人碰到这样哪样的问题，同时官方的文档也不细致不全。所以我就对这些参数进行了一个简单系统的总结，希望能对大家的BIRT开发有所帮助。这些参数以2.2.1版本为准，请大家特别注意。t模式说明查看BIRTViewer自带的文件，可以看到有以下几个pattern：frameset----采用Ajax框架，可以显示工具条，导航条和TOC面板，实现复杂的操作，如分页处理，导出数据，导出报表，打印等等。该模式下会自动生成reportdocument文件(预览reportdesign文件)到特定的目录(用户可以用参数指定，也可以定义在里)。采用Ajax，速度较慢。run----也采用Ajax框架，但不实现frameset的复杂功能，不会生成临时的reportdocument文件(预览reportdesign文件)，也不支持分页，这个主要是应用在BIRTDesigner里的previewtab里，可以支持cancel操作，其它不怎么常用。采用Ajax，速度较慢。preview---没有用到Ajax框架，直接调用底层EngineAPI对报表进行render，把生成的报表内容直接输出到浏览器。这种模式和run模式调用的是相同的EngineAPI，唯一区别在于run采用Ajax获取报表内容，而preview直接输出到浏览器。如果要支持分页，用户需要在URL上定义__page和__pagerange参数，这两个参数也会在后面详细说明。需要特别说明的是，在这几种预览模式中，preview的速度是最快的。document---该模式主要是为了从reportdesign文件生成reportdocument文件。用户可以在URL上提定document文件生成存放的路径(存放在server端)，如果未指定，会直接生成rptdocument发送到客户端浏览器，用户可以下载到客户端。output---该模式类似于frameset，会自动生成reportdocument文件(预览reportdesign文件)，区别在于output不采用Ajax，而是将生成的报表内容直接输出到浏览器。parameter---该模式主要用于生成一个参数对话框，一般用户不常用，用户可以直接通过提供的JSPTag--parameterPage去实现参数对话框，不需要直接调用。download---用于导出报表数据为CSV格式，当你使用frameset工具条里的导出数据功能时，会用到这个模式。里的参数设置文件里有许多参数，用户应该根据自已的需求出发对这些参数有一个深入的了解。下面我会对这些参数一一做以说明。[BIRT_VIEWER_LOCALE]设置默认的Locale信息，暂时没有太大意义。因为Locale的信息，首先以URL上定义的__locale为准，如果没有定义，会找到当前浏览器的Locale信息，最后才会用到这里定义的信息。[BIRT_VIEWER_WORKING_FOLDER]设置BIRTViewer的工作目录。用户可以把reportdesign或是reportdocument文件存放在这个目录下，这样就可以在URL上采用相对路径去预览这些报表文件了。默认是当前根目录。当前支持三种形式：相对路径---这个相对当前的WEB应用的contextroot.绝对路径JAVA系统变量---可以在启动服务器时，定义JVM的系统变量，如java–Dmyworkingfolder=D:/reports。这样就可以在中用${myworkingfolder}进行引用了。[BIRT_VIEWER_DOCUMENT_FOLDER]设置生成的document文件的存放路径。默认是documents目录。路径设置同上。[WORKING_FOLDER_ACCESS_ONLY]简单的报表访问限制控制实现，如果设为true,哪就只能预览存放在工作目录下的报表文件。默认值是false。[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]设置用户scriptlib文件的存放目录(在报表中用到的JavaEventHandlerClass)。默认值是scriptlib。路径设置同工作目录设置。[BIRT_RESOURCE_PATH]设置用户资源存放路径，这些资源包括library文件，image文件等。默认是当前根目录。路径设置同工作目录设置。[BIRT_VIEWER_MAX_ROWS]设置获取dataset的最大记录数。主要应用于设计报表的时候，预览报表如果记录数太多，会花费很多的时间，也可能会引起outofmemory问题。默认是不限制。[BIRT_VIEWER_MAX_CUBE_LEVELS]设置CUBE查询的最大级数。和前面的参数作用类似。默认是不限制。[BIRT_VIEWER_CUBE_MEMORY_SIZE]设置在生成CUBE时，可以写在memory中的最大值，单位是MB。可以提高效率，写在内存会比直接写在硬盘快很多。但同时也要注意内存占用的问题。[BIRT_OVERWRITE_DOCUMENT]该参数主要用于frameset/output模式，它们会生成临时的document文件上。如果设为true，则每次刷新页面时，都会重新去生成document文件，如果为false，则不会重新生成，只会用原来的document文件去生成报表内容。[BIRT_VIEWER_CONFIG_FILE]定义properties文件的路径，不可以修改。[BIRT_VIEWER_PRINT_SERVERSIDE]在frameset工具条上，提供有后台服务器打印的功能，该参数可以设置是打开还是关闭后台打印的功能。默认是打开。可选值为:ON和OFF。[HTML_ENABLE_AGENTSTYLE_ENGINE]这个参数是会传递给Engine的，主要用于一些CSS的兼容性方面的问题。默认值是true。ties参数设置ties文件主要是定义一些扩展的参数。#uncommentthebelowline.#base_url=127.0.0.1:8080该设置主要应用于代理服务器的情况下，在使用代理服务器后，从request里获取的URI并非真正的URI，需要在这里定义。#[EXTENSIONSETTING]==ript====ppt定义输出的报表文件的后缀名，和format相关联。#[OUTPUTFORMATLABELNAME]==ript====PowerPoint定义导出报表对话框里的报表格式列表，和format相关联，这样名字会更有意义。#[CSVSEPARATOR].0=,.1=;.2=:.3=|.4=t支持多种CSV分隔符，用户也可以增加新的分隔符(只支持char，而不是string)。但同时需要修改JSP文件和ties文件。#[LOGGERS]#"logger."+class=level#ifnolevelisspecifiedorthetext"DEFAULT",#==DEFAULT当前的日志都是通过Engine输出的，如果需要其它组件的日志输出，可以在这里定义。注意格式必须为……。而且该组件必须实现了java的logger。可以单独为该组件设置日志级别，如果设为DEFAULT，就会使用里的设置。参数下面是一些主要用到的URL参数。“__report”定义要预览的rptdesign文件路径，支持相对路径和绝对路径，相对路径是相对于中定义的工作目录。“__document”定义要预览的rptdocument文件路径，同样支持相对和绝对路径。相对路径是相对于中定义的工作目录。在同时定义了__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|falseframeset和run模式下，会采用javascript判断客户端浏览器是否支持svg，但并非对所有浏览器有效。“__bookmark”设置页面要定位的书签名字。“__istoc”指定定位的书签是不是一个TOC名字。如为true,就会根据__bookmark参数值去获取一个真正的书签名，从而实现正常的跳转。这个主要用于定位到一个TOC上。“__rtl”指定HTML页面输出是否需要righttoleft。支持不同国家的阅读习惯，如阿拉伯国家是从右到左的。“__page”指定要输出的报表页数，这个依赖于报表的分页设计(pagebreak)。“__pagerange”指定要输出的报表页数范围。如1,3,5-9。“__resourceFolder”定义资源目录路径。同中的BIRT_RESOURCE_PATH设置。“__asattachment”是否以附件方式下载报表，如生成PDF或是其它格式里。默认是inline。“__masterpage”是否要显示masterpage。true|false“__designer”该参数主要是应用在BIRTDesigner环境下，如会读取cache的报表参数等等，一般不用。true|false“__overwrite”该参数同定义的参数，不过里是全局设置，在URL上通过参数可以定义本次操作的设置。“__imageID”内部参数，用于image的引用，一般不用。“__maxrows”设置Dataset查询的最大记录数，要注意这个设置是全局的，会影响后面所有的请求。主要用于BIRTDesigner下，提高报表设计效率。同中的BIRT_VIEWER_MAX_ROWS设置。“__maxlevels”设置查询获取Cube的最大级数。同上面的__maxrows，也主要用于BIRTDesigner设计环境。同中的BIRT_VIEWER_MAX_CUBE_LEVELS设置。“__cubememsize”同中的BIRT_VIEWER_CUBE_MEMORY_SIZE参数设置。“__instanceid”如果查看BIRT输出的HTML代码，你就可以看到一些HTMLElement会有一个iid的属性(如table)，这个就是instanceid。这个是Engine动态生成的，不可提前预知。所以你需要从HTML代码中得到这个值。该参数主要是为了获取reportlet(报表片断，如只输出报表中的一个Table或是一个Chart)。需要配合__isreportlet参数。“__isreportlet”指定当前输出是不是一个reportlet。true|false特别说明：为了输出一个reportlet，BIRT现在提供两种方式。1．为要输出的对象(表格或是Chart)定义一个bookmark，然后可以用下面的URL输出://localhost:8080/birt/frameset?__report=ign&__bookmark=bk&__isreportlet=true2．采用instanceid，但这个值事先是无法预知的，需要预览一次后从HTML代码中得到。然后用下面的URL输出://localhost:8080/birt/output?__report=ign&__instanceid=iid&__isreportlet=true还有就是要注意，reportlet只支持document文档。如果是预览design文档去输出reportlet，就必须要使用frameset/output(自动生成document文档)。“__clean”BIRT里临时生成的一些文件都是和session相关的，比如临时document文件，还有image文件。这些文件也可以通过session进行管理，这个参数就是指定是否需要在sessiontimeout的时候清除这些临时文件。默认值是true。true|false“__dpi”可以设置输出Chart的dpi数值。“__fittopage”暂时这个参数只对PDF和postscript格式报表有效，指定是否调整至适合页面。“__pagebreakonly”暂时这个参数只对PDF和postscript格式报表有效，指定是否只采用BIRT报表内定的分页设置。这个参数一般需要和__fittopage联合使用。“__agentstyle”同中的HTML_ENABLE_AGENTSTYLE_ENGINE参数设置。==========================后台Server端打印==========================“__action”定义执行的指令名称。当前只支持print指令，用于后台服务器打印。“__printer”后台打印机名称。“__printer_copies”对应打印机的打印份数参数。“__printer_collate”对应打印机的双面打印参数。“__printer_duplex”对应打印机的duplex参数。“__printer_mode”对应打印机的模式参数。是单色还是彩色。“__printer_pagesize”对应打印机的纸型参数。比如A4。=========================================================================================================JSPTag相关参数相关参数===================================“__id”viewer的ID号，这个参数一般不常用，主要用于JSPTag中，如在一个页面插入两个BIRTViewer，而且预览同一个报表文件，这时候因为在一个session下面，所以需要用不同的ID去生成单独的document文件。不至于都生成同一个document文件上，从而引发冲突。“__pattern”在JSPTag中用于指定要提交的ServletPattern名字，如frameset/output/run/preview等。主要用于采用parameter模式生成parameterdialog对话框时。“__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。=========================================================================================================ExportData参数===================================“__exportEncoding”该参数应用于导出数据为CSV中，可以指定导出的文件编码，如GBK或是GB2312等。“__sep”该参数应用于导出数据为CSV中，可以指定数据分隔符，如逗号，冒号等。“__exportdatatype”该参数应用于导出数据为CSV中，可以指定是否输出数据类型。true|false“ResultSetName”要导出数据的记录集名字。“SelectedColumnNumber”要导出的栏位数。“SelectedColumn”要导出的数据栏位名称。具体可以查看文件。===============================================================================5.其它参数设置在BIRTViewer里还有一个比较特殊的参数应用，就是用户可以自定义自已的servlet，然后传递对象到ApplicationContext中，在报表中就可以从全局的ApplicationContext去获取到这个对象。这里相关的有两个内定的参数，AppContextKey和AppContextValue。下面是一个简单的示例。publicvoidservice(HttpServletRequestrequest,HttpServletResponseresponse)throwsServletException,IOException,BirtException{StringmyKeyName="mykey";Listvalues=newArrayList();("hello");(newDate());ribute("AppContextKey",myKeyName);ribute("AppContextValue",values);RequestDispatcherrd=uestDispatcher("/frameset");e(request,response);}