Installing Information Console : Installing Information Console on Windows : Using the WAR file to install
 
Using the WAR file to install
If Actuate supports your application server, you can deploy Information Console as a WAR file. See your application server documentation about how to deploy a WAR file. For information about application servers on which Actuate supports deployment of Information Console, see the Supported Products Matrix for this release on the Actuate Support site at the following URL:
http://support.actuate.com/documentation/spm
Customize Information Console for your local environment, if necessary, before beginning deployment. To customize the application for your local environment, follow the steps in “Preparing the WAR file,” later in this section. Deploy the customized Information Console WAR file to the application server instead of the ActuateInformationConsole.war file that ships with Information Console.
General deployment tasks
You must configure the Information Console WAR and application server for integration. You must also verify that you have a standard J2EE installation.
To integrate your application server with Actuate, complete the following tasks:
*Configure the application server to operate with Actuate products.
*Configure the Information Console WAR to integrate with the application server as described in “Preparing the WAR file,” later in this chapter.
*Deploy Information Console to the application server.
*If the application server has deployment tools, use those tools to integrate the application server with Actuate products. For more information about deployment tools, see your application server’s documentation.
*If your application server does not have deployment tools, add the Actuate context root to your application server, typically by modifying the application server’s configuration file.
Preparing the server
Actuate recommends the following configuration for best performance:
*Use at least a two-CPU machine for Information Console.
*If BIRT iHub system uses more than four CPUs, configure one CPU for Information Console for every two CPUs that iHub uses.
Set the following configuration values on the application or web server:
*On a machine with 1 GB of physical memory, set the Java heap size to a value between 256 MB and 512 MB.
*Set the number of threads to a value between 50 and 75.
Preparing the WAR file
You can use a WAR file to deploy Information Console to many supported servers. Table 7‑1 describes the Information Console configuration parameters to review and update before deployment.
Table 7‑1 Information Console configuration parameters
Parameter name
Description
Action
BIRT_RESOURCE_PATH
The location of the standard templates and properties files that BIRT Studio uses. This location can be in a WAR file or on a disk.
If you specify a location on disk, copy the contents of the Information Console resources folder to this physical location on the file system.
DEFAULT_LOCALE
The default locale is en_US. You can leave this value unchanged. A user can select a locale at login.
If you change the locale, select the new locale from the locales in /WEB‑INF/Localemap.xml.
DEFAULT_TIMEZONE
The default time zone is Pacific Standard Time (PST). You can leave this value unchanged. A user can select a time zone at login.
If you change the time zone, select the new time zone from the time zones in the TimeZones.xml file, in the WEB‑INF directory.
SERVER_DEFAULT
This value specifies the iHub URL to which the Information Console application connects if you do not specify a server URL. The default value is http://localhost:8000
Update this value to the machine and port of the server. Change localhost to the iHub machine name or IP address. Change 8000 to the iHub port number.
DEFAULT_VOLUME
This value specifies the default Encyclopedia volume for Information Console. If you do not specify a volume in an Information Console URL, the JSP application attempts to log in to this volume. The default value is localhost.
Update this value to the name of an Encyclopedia volume.
BIRT_VIEWER_LOG_DIR
The location of the files that log Actuate BIRT viewer activity.
You must create this physical location on the file system.
LOG_FILE_LOCATION
The location of the files that log Information Console activity.
You must create this physical location on the file system.
TEMP_FOLDER_LOCATION
The location where Information Console creates temporary files.
You must create this physical location on the file system.
TRANSIENT_STORE_PATH
The location where Information Console creates temporary files.
You must create this physical location on the file system.