Birt参数配置详解

  1 <!--
  2      Default locale setting.
  3      设置默认的Locale信息。
  4  -->
  5  <context-param>
  6   <param-name>BIRT_VIEWER_LOCALE</param-name>
  7   <param-value>en-US</param-value>
  8  </context-param>
  9 
 10  
 11 
 12  <!-- 
 13      Default timezone setting.
 14      Examples: "Europe/Paris", "GMT+1".
 15      Defaults to the container‘s timezone.  时区
 16   -->
 17  <context-param>
 18   <param-name>BIRT_VIEWER_TIMEZONE</param-name>
 19   <param-value></param-value>
 20  </context-param>
 21  
 22  <!--
 23     Report resources directory for preview. Defaults to ${birt home}
 24     设置BIRT Viewer的工作目录。
 25     用户可以把report design或是report document文件存放在这个目录下，
 26     这样就可以在URL上采用相对路径去预览这些报表文件了。默认是当前根目录。
 27  -->
 28  <context-param>
 29   <param-name>BIRT_VIEWER_WORKING_FOLDER</param-name>
 30   <param-value></param-value>
 31  </context-param>
 32  
 33  <!--
 34     Temporary document files directory. Defaults to ${birt home}/documents
 35     设置生成的document文件的存放路径。默认是documents目录。
 36  -->
 37  <context-param>
 38   <param-name>BIRT_VIEWER_DOCUMENT_FOLDER</param-name>
 39   <param-value></param-value>
 40  </context-param>
 41 
 42  
 43 
 44  <!--
 45     Flag whether the report resources can only be accessed under the
 46     working folder. Defaults to true
 47     简单的报表访问限制控制实现，如果设为true,哪就只能预览存放在工作目录下的报表文件。默认值是false。
 48  -->
 49  <context-param>
 50   <param-name>WORKING_FOLDER_ACCESS_ONLY</param-name>
 51   <param-value>true</param-value>
 52  </context-param>
 53 
 54  
 55 
 56  <!--
 57     Temporary image/chart directory. Defaults to ${birt home}/report/images
 58     设置生成的临时图片的存放路径。默认是report/images目录。
 59  -->
 60  <context-param>
 61   <param-name>BIRT_VIEWER_IMAGE_DIR</param-name>
 62   <param-value></param-value>
 63  </context-param>
 64 
 65  
 66 
 67  <!--
 68     Engine log directory. Defaults to ${birt home}/logs
 69     设置生成的日志文件存放路径。默认是logs目录。
 70  -->
 71  <context-param>
 72   <param-name>BIRT_VIEWER_LOG_DIR</param-name>
 73   <param-value></param-value>
 74  </context-param>
 75 
 76  
 77 
 78  <!--
 79     Report engine log level
 80     设置日志的level，可选的值有：ALL|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST|OFF。级别由高到低。
 81  -->
 82  <context-param>
 83   <param-name>BIRT_VIEWER_LOG_LEVEL</param-name>
 84   <param-value>WARNING</param-value>
 85  </context-param>
 86 
 87  
 88 
 89  <!--
 90     Directory where to store all the birt report script libraries (JARs).
 91     Defaults to ${birt home}/scriptlib
 92     设置用户script lib文件的存放目录( 在报表中用到的Java Event Handler Class )。
 93     默认值是scriptlib。
 94  -->
 95  <context-param>
 96   <param-name>BIRT_VIEWER_SCRIPTLIB_DIR</param-name>
 97   <param-value></param-value>
 98  </context-param>
 99  
100  <!--
101     Resource location directory. Defaults to ${birt home}
102     设置用户资源存放路径，这些资源包括library文件，image文件等。默认是当前根目录
103  -->
104  <context-param>
105   <param-name>BIRT_RESOURCE_PATH</param-name>
106   <param-value></param-value>
107  </context-param>
108 
109  
110 
111  <!--
112     Preview report rows limit. An empty value means no limit.
113     设置获取dataset的最大记录数。
114     主要应用于设计报表的时候，预览报表如果记录数太多，会花费很多的时间，也可能会引起out of memory问题。
115     默认是不限制。
116  -->
117  <context-param>
118   <param-name>BIRT_VIEWER_MAX_ROWS</param-name>
119   <param-value></param-value>
120  </context-param>
121 
122  
123 
124  <!--
125     Max cube fetch levels limit for report preview (Only used when
126     previewing a report design file using the preview pattern)
127     设置CUBE查询的最大级数。和前面的参数作用类似。默认是不限制。
128     (仅在preview模式下查看报表时有效)
129  -->
130  <context-param>
131   <param-name>BIRT_VIEWER_MAX_CUBE_ROWLEVELS</param-name>
132   <param-value></param-value>
133  </context-param>
134  <context-param>
135   <param-name>BIRT_VIEWER_MAX_CUBE_COLUMNLEVELS</param-name>
136   <param-value></param-value>
137  </context-param>
138 
139  
140 
141  <!--
142     Memory size in MB for creating a cube.
143     设置在生成CUBE时，可以写在memory中的最大值，单位是MB
144     可以提高效率，写在内存会比直接写在硬盘快很多。但同时也要注意内存占用的问题。
145  -->
146  <context-param>
147   <param-name>BIRT_VIEWER_CUBE_MEMORY_SIZE</param-name>
148   <param-value></param-value>
149  </context-param>
150 
151  
152 
153  <!--
154     Defines the BIRT viewer configuration file
155     定义properties文件的路径，不可以修改。
156  -->
157  <context-param>
158   <param-name>BIRT_VIEWER_CONFIG_FILE</param-name>
159   <param-value>WEB-INF/viewer.properties</param-value>
160  </context-param>
161 
162  
163 
164  <!--
165     Flag whether to allow server-side printing. Possible values are "ON"
166     and "OFF". Defaults to "ON".
167     在frameset工具条上，提供有后台服务器打印的功能，该参数可以设置是打开还是关闭后台打印的功能。
168     默认是打开。可选值为: ON 和 OFF。
169  -->
170  <context-param>
171   <param-name>BIRT_VIEWER_PRINT_SERVERSIDE</param-name>
172   <param-value>ON</param-value>
173  </context-param>
174 
175  
176 
177  <!--
178     Flag whether to force browser-optimized HTML output. Defaults to true
179     这个参数是会传递给Engine的，主要用于一些CSS的兼容性方面的问题。默认值是true。
180  -->
181  <context-param>
182   <param-name>HTML_ENABLE_AGENTSTYLE_ENGINE</param-name>
183   <param-value>true</param-value>
184  </context-param>
185 
186  
187 
188  <!--
189     Filename generator class/factory to use for the exported reports.
190  -->
191  <context-param>
192   <param-name>BIRT_FILENAME_GENERATOR_CLASS</param-name>
193   <param-value>org.eclipse.birt.report.utility.filename.DefaultFilenameGenerator</param-value>
194  </context-param>

  1 <!-- Viewer Servlet, Supports SOAP -->
  2  <servlet>
  3   <servlet-name>ViewerServlet</servlet-name>
  4   <servlet-class>org.eclipse.birt.report.servlet.ViewerServlet</servlet-class>
  5  </servlet>
  6 
  7  <!-- Engine Servlet -->
  8  <servlet>
  9   <servlet-name>EngineServlet</servlet-name>
 10   <servlet-class>org.eclipse.birt.report.servlet.BirtEngineServlet</servlet-class>
 11  </servlet>
 12 
 13  
 14 
 15  <!--  
 16 
 17         frameset ---- 采用Ajax框架，可以显示工具条，导航条和TOC面板，实现复杂的操作，
 18 
 19                              如分页处理，导出数据，导出报表，打印等。
 20 
 21                              该模式下会自动生成report document文件(预览report design文件)到特定的目录
 22 
 23                              (用户可以用参数指定，也可以定义在web.xml里)。采用Ajax，速度较慢。
 24 
 25  -->
 26 
 27  <servlet-mapping>
 28   <servlet-name>ViewerServlet</servlet-name>
 29   <url-pattern>/frameset</url-pattern>
 30  </servlet-mapping>
 31 
 32  
 33 
 34  <!--
 35 
 36        run ---- 也采用Ajax框架，但不实现frameset的复杂功能，
 37 
 38                    不会生成临时的report document文件(预览report design文件)，也不支持分页，
 39 
 40                    这个主要是应用在BIRT Designer里的preview tab里，
 41 
 42                    可以支持cancel操作，其它不怎么常用。采用Ajax，速度较慢。
 43 
 44  -->
 45  <servlet-mapping>
 46   <servlet-name>ViewerServlet</servlet-name>
 47   <url-pattern>/run</url-pattern>
 48  </servlet-mapping>
 49  
 50 
 51  <!--
 52 
 53        preview --- 没有用到Ajax框架，直接调用底层Engine API对报表进行render，
 54 
 55                          把生成的报表内容直接输出到浏览器。
 56 
 57                          这种模式和run模式调用的是相同的Engine API，
 58 
 59                          唯一区别在于run采用Ajax获取报表内容，而preview直接输出到浏览器。
 60 
 61                          如果要支持分页，用户需要在URL上定义__page和__pagerange参数。
 62 
 63                          需要特别说明的是，在这几种预览模式中，preview的速度是最快的。 
 64 
 65  -->
 66  <servlet-mapping>
 67   <servlet-name>EngineServlet</servlet-name>
 68   <url-pattern>/preview</url-pattern>
 69  </servlet-mapping>
 70 
 71  
 72 
 73  <!--
 74 
 75       download --- 用于导出报表数据，
 76 
 77                            当你使用frameset工具条里的导出数据功能时，会用到这个模式。
 78 
 79  -->
 80 
 81  <servlet-mapping>
 82   <servlet-name>EngineServlet</servlet-name>
 83   <url-pattern>/download</url-pattern>
 84  </servlet-mapping>
 85 
 86  
 87 
 88  <!-- 
 89 
 90      parameter --- 该模式主要用于生成一个参数对话框，一般用户不常用，
 91 
 92                            用户可以直接通过提供的JSP Tag--parameterPage去实现参数对话框，不需要直接调用。
 93 
 94  -->
 95 
 96  <servlet-mapping>
 97   <servlet-name>EngineServlet</servlet-name>
 98   <url-pattern>/parameter</url-pattern>
 99  </servlet-mapping>
100 
101  
102 
103  <!--
104 
105       document --- 该模式主要是为了从report design文件生成report document文件。
106 
107                            用户可以在URL上提定document文件生成存放的路径(存放在server端)，如果未指定，
108 
109                            会直接生成rptdocument发送到客户端浏览器，用户可以下载到客户端。
110 
111 -->
112 
113  <servlet-mapping>
114   <servlet-name>EngineServlet</servlet-name>
115   <url-pattern>/document</url-pattern>
116  </servlet-mapping>
117 
118  
119 
120  <!--
121 
122       output --- 该模式类似于frameset，会自动生成report document文件(预览report design文件)，
123 
124                       区别在于output不采用Ajax，而是将生成的报表内容直接输出到浏览器。
125 
126  -->
127 
128  <servlet-mapping>
129   <servlet-name>EngineServlet</servlet-name>
130   <url-pattern>/output</url-pattern>
131  </servlet-mapping>
132  
133 
134  <!--
135 
136       extract--- 。
137 
138  -->
139  <servlet-mapping>
140   <servlet-name>EngineServlet</servlet-name>
141   <url-pattern>/extract</url-pattern>
142  </servlet-mapping>