Configuring BIRT Viewer : Configuring an BIRT Viewer using web.xml

Configuring an BIRT Viewer using web.xml

BIRT Interactive Viewer (IV) parameters in web.xml affect how BIRT reports are run and viewed. Table 10-2 describes these configuration parameters for BIRT reports, BIRT Viewer and Interactive Viewer.

Indicates the maximum number of pages that can be exported or printed at a time from an BIRT Viewer. For example, if the value of this parameter is 200, no more than 200 pages will be exported or printed from a report using the viewer.
The number of parameter values to display on the parameters page. If more values exist than are displayed, the user can scroll through the other values. The default value is -1, which displays all values.
BIRT_ARCHIVE_ MEMORY_TOTALSIZE
The total memory available for BIRT report document files, in kilobytes. The default value is 50 megabytes.
The maximum number of rows bound to a chart in a BIRT report. The default value is 10000 rows.
BIRT_DATA_
EXTRACTION_MAX_
BUFFER_SIZE
BIRT_DATA_RESULTSET_MAX_BUFFER_SIZE
BIRT_
HTMLRENDEROPTION_
ENGCASSTYLE
Enables the agentStyleEngine property for the HTML render option for a BIRT report. This setting is related to using a browser’s internal CSS capabilities when rendering reports in HTML. It provides better column alignment and faster rendering, especially in a browser other than Microsoft Internet Explorer. The default value is True.
BIRT_JDBC_
CONNECTION_POOL_
SIZE
Specifies the number of idle connections cached by BIRT JDBC connection pool. The default value is 10.
BIRT_JDBC_
CONNECTION_POOL_
TIMEOUT
Specifies how long an idle connection will remain in the BIRT JDBC connection pool in seconds. The default value is 3600.
BIRT_MAX_MEMORY_
SIZE_ PER_ARCHIVE
The amount of memory used by each BIRT report document file, in kilobytes. A report larger than this size is written to disk instead of being cached in memory. Use this parameter for performance tuning. The default value is 200 kilobytes.
The path to BIRT shared resources, including libraries and templates for the BIRT report designs and BIRT Report Studio. The default value is <context root>\resources
BIRT_SAVE_REPORT_
DOCUMENT_ENABLED
BIRT_SAVE_REPORT_
DOCUMENT_FOLDER
Locale that determines formatting for numbers and dates on BIRT reports. The default value is the locale of the machine on which iPortal is installed.
The level of BIRT Viewer activity to log. Valid values are OFF, SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, in order of the number of messages to log. The default value is OFF.
BIRT_VIEWER_
WORKING_FOLDER
n  
NO-CACHE indicates that the browser does not cache information and forwards all requests to the server. With NO-CACHE, the back and forward buttons in a browser do not always produce expected results, because choosing these buttons always reloads the page from the server.
If multiple users access iPortal from the same machine, they can view the same cached data. Setting CACHE_CONTROL to NO-CACHE prevents different users viewing data cached by the browser.
n  
NO-STORE indicates that information is cached but not archived.
n  
PRIVATE indicates that the information is for a single user and that only a private cache can cache this information. A proxy server does not cache a page with this setting.
n  
PUBLIC indicates that information may be cached, even if it would normally be non-cacheable or cacheable only within an unshared cache.
n  
Unset (no value) is the default value. The browser uses its own default setting when there is no CACHE_CONTROL value.
Caching information reduces the number of server requests that the browser must make and the frequency of expired page messages. Caching increases security risks because of the availability of information in the cache. For additional information about cache control, see the HTTP/1.1 specifications.
DEFAULT_WORKGROUP_FUNCTIONALITY_ROLE
Specifies the functionality role for all users using the BIRT Viewer. The default value is Active Portal Intermediate.
EXPORT_AS_
ATTACHMENT
Determines whether a Microsoft Excel, Powerpoint, or Word report for the BIRT Viewer is opened in the Microsoft Internet Explorer browser or a separate application.
n  
When the value is true, the exported report opens in a separate Microsoft Word, Microsoft Powerpoint, or Microsoft Excel application.
n  
When the value is false, the exported report opens in the browser window with Microsoft Word, Microsoft Powerpoint, or Microsoft Excel embedded inside the browser.
Determines whether the Enable Interactivity option is usable in the BIRT Viewer control menu. If false, the Enable Interactivity option is disabled.
JAVA_REPORT_API_
IMAGE_CACHE_
EXPIRATION
Specifies how long in seconds to cache images for BIRT reports and business reports. The default value is 86,400, which is one day.
Specifies the maximum queue length for the Java Report Engine thread pool. The default value is 1000.
Specifies the maximum number of threads in the Java Report Engine thread pool. The default value is 10.
JREM_THREADPOOL_
MAXSYNC_
TASKRUNTIME
Specifies the maximum time a synchronous report generation is allowed to run. The default value is 600.
JREM_THREADPOOL_
MONITORTHREAD_
POLLINGINTERVAL
Controls the interval in seconds at which the Java Report Engine thread pool checks for Java report execution time-out or queue time-out. The default value is 30.
JREM_THREADPOOL_
SYNC_TASKQUEUE_
TIMEOUT
Specifies the maximum time, in seconds, that a Java synchronous request stays in the Java Report Engine task queue before timing out, in seconds. The default value is 300.
Specifies the number of distinct values to display when a user chooses to filter a report on a column in the BIRT Viewer. The default value is 200.
Specifies, in seconds, how long to retain temporary files that BIRT Viewer creates when a user modifies the appearance of a report. The default value is 900, which is 15 minutes.