The first step in deploying the Java Component WAR file is editing the web.xml file. Extract web.xml from the WAR file, then edit web.xml to set configuration parameters for one or more components that you purchased or are evaluating. The tables in this section describe these parameters and actions you take. Perform these actions as you edit web.xml.
How to edit web.xml
To access web.xml for editing, first decompress the WAR file that contains web.xml. Next, configure parameters for the Java Components that you want to use.
1 Create a directory named /temp. Java Components writes temporary files to this directory after deployment.
2 Decompress the ActuateJavaComponent.war file in a subdirectory of /temp. Type the following command:
jar -xf ActuateJavaComponent.war
Use this command on Windows or Linux. The BIRT Java Component files appear in the subdirectory of /temp.
Figure 2‑1 Files extracted from ActuateJavaComponent.war
Keep all downloaded files together in their original relative locations.
3 Using a text editor that accepts UTF‑8 encoding, edit web.xml in /WEB-INF to configure the parameters for the BIRT Java Components you purchased or are evaluating.
4 Save and close web.xml.
5 Perform this step only if you are deploying BIRT Java Component using one of the following WAR files:
WAS_ActuateBIRTJavaComponent.war
For deploying Information Console to the IBM WebSphere application server. WAS_ActuateBIRTJavaComponent.ear contains WAS_ActuateBIRTJavaComponent.war.
WL_ActuateBIRTJavaComponent.war
For deploying Information Console to the Oracle WebLogic application server.
Remove the WEB-INF/lib/el-api.jar file from the WAR file if the /lib directory for your application server also contains el-api.jar. The presence of el-api.jar in both the Information Console WEB-INF/lib directory and the application server /lib directory may cause errors.
Configuring locale parameters
The locale parameters, described in Table 2‑1, are applicable to all Java Components.
Table 2‑1 Locale parameters
Parameter name
Description
Action
DEFAULT_LOCALE
The value of this parameter determines the default locale. The default locale is en_US. Users can select a locale when they log in.
Use the default locale or a value from Localemap.xml in the WEB‑INF directory.
DEFAULT_TIMEZONE
The value of this parameter determines the default time zone. The default time zone is Pacific Standard Time (PST).
Use the default time zone or a value from Timezonemap.xml in the WEB‑INF directory.
For example, changing the DEFAULT_LOCALE parameter value to es_ES changes the locale to Spain, and the interface changes to Spanish, as shown in Figure 2‑3.
Figure 2‑2 Using the Actuate Java Components interface localized to Spain
Configuring parameters for Deployment Kit
The components for BIRT Deployment Kit have additional core configuration parameters in web.xml. Table 2‑2 describes these parameters. Update these parameters before deployment.
For BIRT Deployment Kit, also review the parameters described in Table 2‑3.
Table 2‑2 Deployment Kit parameters
Parameter name
Description
Action
LOG_FILE_LOCATION
The location of the files that log Deployment Kit activities.
You must create this physical location on the file system. The default value is /logs.
TEMP_FOLDER_LOCATION
The location where Deployment Kit creates temporary files.
You must create this physical location on the file system. There is no default value.
TRANSIENT_STORE_PATH
Another location where Deployment Kit creates temporary files.
You must create this physical location on the file system. The default value is /temp.
Configuring parameters for BIRT Viewer and BIRT Interactive Viewer
The BIRT Viewer and BIRT Interactive Viewer components also have core configuration parameters in web.xml. Table 2‑3 describes these configuration parameters. Consider changing these parameters to optimize performance.
Table 2‑3 BIRT Viewer parameters
Parameter name
Description
Action
BIRT_ARCHIVE_ MEMORY_TOTALSIZE
Total memory available for BIRT report document files in kilobytes. The default value is 50 MB.
None required
REPOSITORY_CACHE_ TIMEOUT_SEC
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.
None required
Configuring parameters for Report Studio
Report Studio component has one configuration parameter, shown in Table 2‑4. Edit the parameter to change the path to BIRT resources. BIRT resources include libraries and templates for Actuate BIRT report designs and Actuate Report Studio.
Table 2‑4 Report Studio parameter
Parameter name
Description
Action
BIRT_RESOURCE_PATH
Path to Actuate BIRT shared resources. The default value is the following directory:
WAS_ActuateBIRTJavaComponent.war