Configuring the Information Console using web.xml

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

Table 4-2 Actuate Information Console web.xml parameters

Parameter name

Description

BIRT_RENDER_FORMAT_EMITTER_ID_MAPPING

Specifies which emitter will be used for a specific BIRT report. Valid entries are of the format "render_format:emitter_ID" separated by a semicolon. The default value is:

html:org.eclipse.birt.report.engine.emitter.html;xhtml:com. actuate.birt.report.engine.emitter.xhtml;pdf:org.eclipse.birt.report.engine.emitter.pdf;postscript:org.eclipse.birt.report.engine.emitter.postscript;xls:com.actuate.birt.report.engine.emitter.xls;ppt:org.eclipse.birt.report.engine.emitter.ppt;pptx:com.actuate.birt.report.engine.emitter.pptx;doc:org.eclipse.birt.report.engine.emitter.word;docx:com.actuate.birt.report.engine.emitter.docx

CACHE_CONTROL

Specifies how a web browser caches information using one of the following values:

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 Information Console 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.

CONNECTION_TIMEOUT

Controls how many seconds Actuate Information Console waits for a request to complete before dropping the connection to the application server or Actuate BIRT iServer. Set this value to limit wait times. The default value is 0, meaning the connection is never dropped.

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. Information Console 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, Information Console does not use cookies. Without cookies, many Information Console 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_ESS_
VIEWING_FORMAT

Specifies the default format for viewing spreadsheet reports. Valid values include XLS, XLSX, and PDF. The default value is XLS.

DEFAULT_LOCALE

Specifies the default locale. Information Console sets this parameter value during installation. The locale map is <context root>\WEB-INF\localemap.xml.

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_TIMEZONE

Specifies the default time zone. Information Console 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 Information Console.

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, Information Console creates two error log files:

n	Admin.log records general errors.

n	Soapfault.log records iServer communication errors.

ENABLE_JUL_LOG

Indicates whether to log Information Console activity. This parameter’s default value is TRUE, which enables logging. If you set this parameter to TRUE, Information Console creates log files named reportService.<Service number>.<System name>.<Information Console 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_DASHBOARD_GADGET_GENERATION_WAIT_TIME

Specifies the time to wait, in seconds, for a gadget to generate. This parameter’s default value is 2 seconds.

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 and execute page.

FILES_DEFAULT_VIEW

Specifies the default view for the files and folders list using one of the following values:

n	Categories, the default, displays files organized in rows by type.

n	Detail displays files organized in rows by name.

n	List displays files organized in columns with small icons.

n	Icon displays files organized in columns with large icons.

FORCED_GC_INTERVAL

Indicates the length in seconds of the interval that the Information Console application waits between forced garbage collections. To disable garbage collection, set this parameter to 0, the default value. Use this parameter to tune application server performance. 600 seconds is the recommended value. If the value is too low, the application server performs garbage collection too frequently, slowing the system. If the value is too high, you waste memory. If disabled, the application server controls garbage collection.

INSTALL_MODE

Indicates whether Information Console is installed with iServer. The value is set when Actuate Information Console is installed. Do not change this setting.

JUL_LOG_CONSOLE_LEVEL

The level of Information Console 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 Information Console 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 Information Console activity log file. When a log file reaches this size, Information Console creates a new log file and increments its file number. If the log file number reaches the value of JUL_LOG_FILE_COUNT, Information Console resets the file number to zero 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 Information Console locates the directory in the Information Console home directory. The default value is logs in the Information Console 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 to load when Information Console starts. Valid values are birt and ess. Default value is “birt, ess” which indicates both.

PROGRESSIVE_REFRESH

Controls the interval in seconds at which an Actuate report refreshes itself when running a progressive report. 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 Information Console 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 Information Console and the client. The default value is blank, which indicates that the network does not use a proxy server.

SECURITY_ADAPTER_CLASS

Deprecated. Specifies the fully qualified class of the security manager that controls access to Actuate Information Console functionality. 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 Information Console Ajax Proxy maintains an idle session. The default value is 5000.

TRANSIENT_STORE_MAX_SIZE_KB

Limits the amount of disk space that Actuate Information Console uses for temporary files. The default value is 102400, which is 100MB.

TRANSIENT_STORE_PATH

Path to Actuate Information Console transient files. The default value is set when Information Console is installed. When deploying more than one context root or separate server, set a unique path for each.

TRANSIENT_STORE_TIMEOUT_MIN

Specifies, in minutes, how long to retain Actuate Information Console 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 Information Console. The default value is false, indicating that Excel files open in a separate window.