Configuring the Java Component using web.xml

Web.xml contains parameters that control Deployment Kit features. Table 4-2 describes the configuration parameters for the Information Console application.

Table 4-2

Actuate Java Component web.xml parameters

Parameter name	Description
AUTOSUGGEST_DELAY	Configure the delay before the parameters page opens an automatic suggestion tooltip for a parameter. The value is measure in milliseconds, and the default value is 500.
AUTOSUGGEST_LIST_SIZE	Specifies the number of autosuggest entries to display. By default, display everything.
CACHE_CONTROL	Specifies how a web browser caches information using one of the following values: 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 Java Component 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. NO-STORE indicates that information is cached but not archived. Reports in Excel format do not render reliably when using this setting. 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. PUBLIC indicates that information may be cached, even if it would normally be non-cacheable or cacheable only within an unshared cache. 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.
COOKIE_DOMAIN	Specifies the host name of the server setting the cookie. The cookie is only sent to hosts in the specified domain of that host. The value must be the same domain the client accesses. Actuate Java Component automatically sets this parameter. For example, if the client accesses http://www.actuate.com/iportal/login.do, the domain name is actuate.com.
COOKIE_ENABLED	Indicates whether to use cookies to store information between user logins. The default value is true. If false, Java Component does not use cookies. Without cookies, many Java Component features are unavailable or do not persist across sessions. For example, without cookies, user name, language, and time zone settings always use their default values when a new browser session begins.
COOKIE_SECURE	Indicates whether to access and write cookies securely. If true, cookies are only written if a secure connection, such as HTTPS, is established. The default value is false, which enables cookies for all connection types.
DEFAULT_LOCALE	Specifies the default locale. Actuate Java Component sets this parameter value during installation. The locale map is <context root>\WEB-INF\localemap.xml.
DEFAULT_COLUMN_PAGE_BREAK_INTERVAL	Specifies the number of columns to display on one page when viewing a cross tab. Must be a non-negative number. Default value is 10.
DEFAULT_PAGE_BREAK_INTERVAL	Specifies the number of rows to display in one page when viewing a report. If set to 0, there are no page breaks.
DEFAULT_ROW_PAGE_BREAK_INTERVAL	Specifies the number of rows to display on one page when viewing a cross tab. Must be a non-negative number. Default value is 40.
DEFAULT_TIMEZONE	Specifies the default time zone. Actuate Java Component sets this parameter value during installation. The time zone map is <context root>\WEB-INF\TimeZones.xml.
ENABLE_CLIENT_SIDE_REDIRECT	Specifies whether URL redirection is done on the client side or the server side. Set the value to true for client side redirection. The default value is false. For more information about URL redirection, see Using proxy servers with Actuate Java Component.
ENABLE_DEBUG_LOGGING	Indicates whether to record debugging messages in a log file called Debug.log. Set the value to true to enable debug messages in the log file. The default value is false.
ENABLE_ERROR_LOGGING	Indicates whether to log errors. This parameter’s default value is true, which enables error logging. If you set this parameter to true, Java Component creates two error log files: Admin.log records general errors. Soapfault.log records communication errors.
ENABLE_JUL_LOG	Indicates whether to log Actuate Java Component activity. This parameter’s default value is true, which enables logging. If you set this parameter to true, Java Component creates log files named reportService.<Service number>.<System name>.<Java Component start up time stamp>.<File number>.log.
ERROR_LOG_FILE_ROLLOVER	Specifies the time period to wait before starting a new log file. Options are Daily, Monthly, Weekly, and Yearly. The default value is Monthly.
EXECUTE_REPORT_WAIT_TIME	Specifies the time to wait, in seconds, for a report to execute. This parameter’s default value is 20 seconds. For more information about the wait time parameter, see execute report page.
FILES_DEFAULT_VIEW	Specifies the default view for the files and folders list using one of the following values: Categories, the default, displays files organized in rows by type. Detail displays files organized in rows by name. List displays files organized in columns with small icons. Icon displays files organized in columns with large icons.
FORCED_GC_INTERVAL	Indicates the length in seconds of the interval that the Java Component application waits between forced garbage collections. To disable garbage collection, set this parameter to 0, the default value. If you use this parameter, 600 seconds is the recommended value. Use this parameter when tuning application server performance. If the value is too low, the application server performs garbage collection too frequently, slowing your system. If you set the value to high, you waste memory. If disabled, the application server controls garbage collection.
INSTALL_MODE	Indicates whether Java Component is installed with iServer. The value is set when Actuate Java Component is installed. Do not change this setting.
JUL_LOG_CONSOLE_LEVEL	The level of Actuate Java Component activity to log to the console. 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.
JUL_LOG_FILE_COUNT	Specifies the number of log files for a particular time stamp, if the value of ENABLE_JUL_LOG is true.
JUL_LOG_FILE_LEVEL	The level of Actuate Java Component activity to log in a file. Valid values are OFF, SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, in order of the number of messages to log. The default value is WARNING.
JUL_LOG_FILE_SIZE_KB	The maximum size, in kilobytes, for an Actuate Java Component activity log file. When a log file reaches this size, Java Component creates a new log file and increments its file number. If the log file number reaches the value of JUL_LOG_FILE_COUNT, Java Component resets the file number to 0 and overwrites the first log file for the time stamp.
LOG_FILE_LOCATION	Indicates which directory contains the log files. If the value is not an absolute directory path name, Actuate Java Component locates the directory in the Java Component home directory. The default value is logs in the Java Component home directory.
LOGIN_TIMEOUT	Specifies the number of seconds to wait before a session times out. The minimum login timeout is 300 seconds. The maximum value is equivalent to java.lang.Long. Its default value is 1200 seconds.
MAX_BACKUP_ERROR_LOGS	Specifies the maximum number of backup error log files to keep. The default value is 10.
MAX_LIST_SIZE	Limits the number of items returned when getting folder items, jobs, job notices, scheduled jobs, and channels to reduce network traffic. The default value is 150.
PRELOAD_ENGINE_LIST	List of engines that will be loaded when application starts up. Allowed values are "birt" and "ess". Use a comma to separate the names if there are more than one. Engines that are not in the list will be loaded upon request. The default value is birt.
PROGRESSIVE_REFRESH	Controls the interval, in seconds, at which an Actuate report refreshes itself when running a progressive report. The report refresh time starts after the navigation bar loads. The report refreshes first after 15 seconds, then after 60 seconds, and then after the PROGRESSIVE_REFRESH interval. If the value is less than 60, Actuate Java Component uses 60 seconds. This parameter’s default value is 1800 seconds.
PROGRESSIVE_VIEWING_ENABLED	Specifies whether a paginated report starts to display in the browser as soon as the first page has been generated. Valid values are true and false. The default value is true.
PROXY_BASEURL	Indicates a proxy server’s URL if the network uses one between Java Components and the client. The default value is blank, which indicates that the network does not use a proxy server.
SECURITY_ADAPTER_CLASS	Specifies the fully qualified class of the security manager that controls access to Actuate Java Component functionality for single sign-on. The default value is no name.
SESSION_DEFAULT_PARAMETER_VALUE_ID	Specifies the name of the object that stores the HTTP session-level report parameters. This object is an instance of the com.actuate.parameter.SessionLevelParameter class, which is extensible. The default value is SessionDefaultParameterValue.
sessionTimeout	The number of milliseconds the web service Ajax Proxy maintains an idle session. The default value is 5000.
TRANSIENT_STORE_MAX_SIZE_KB	Limits the amount of disk space that Actuate Java Component uses for temporary files. The default value is 102400, which is 100 MB.
TRANSIENT_STORE_PATH	Path to Actuate Java Component transient files. The default value is set when Java Component is installed. When deploying more than one context root, set a unique path for each.
TRANSIENT_STORE_TIMEOUT_MIN	Specifies, in minutes, how long to retain Actuate Java Component transient files. The default value is 40, which is 40 minutes.
VIEW_XLS_IN_REQUESTER	Indicates that a spreadsheet report in Excel format always opens in the same browser as Java Component. The default value is false, indicating that excel documents open in a separate window.

Copyright Actuate Corporation 2012