How to install the log consolidator application
1 Edit the following settings in consolidatorconfig.xml:
JDBC driver name
URL, specifying the type of JDBC driver and database connection information, including host name, port, and database instance (SID) or service name, using the following syntax:
jdbc:oracle:thin:@//[HOST][:PORT][:SID/SERVICE]
Database login information, including schema, user name and password
Refresh interval
Measured in seconds. The default value is 10 seconds.
You may need to change the refresh interval depending on the amount of logging your system performs. The log consolidator application commits transactions to the database every 10 seconds or when the number of transactions exceeds 80, whichever occurs first.
Usage and error log settings:
Log file names
Number of log files for each type of file
The log file names and number of files must match the actual BIRT iHub configuration.
If you change a BIRT iHub setting, you must also change the corresponding consolidator configuration setting and restart BIRT iHub and the log consolidator application.
The following code example shows the default settings for consolidatorconfig.xml:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<LogConsolidator>
<Database>
<DriverName>oracle.jdbc.OracleDriver</DriverName>
<URL>jdbc:oracle:thin:@dbsrv4-w2k:1521:Oran9i</URL>
<Encoding>UTF8</Encoding>
<Schema>Users</Schema>
<DatabasePropertyList>
<Properties>
<Name>UserName</Name>
<Value>actest</Value>
</Properties>
<Properties>
<Name>Password</Name>
<Value>systest</Value>
</Properties>
</DatabasePropertyList>
</Database>
<Consolidator>
<RefreshInterval>10</RefreshInterval>
<UsageLogEnabled>true</UsageLogEnabled>
<ErrorLogEnabled>false</ErrorLogEnabled>
<UsageLogProperties>
<LogFileName>usage_log</LogFileName>
<NumberOfLogFiles>2</NumberOfLogFiles>
</UsageLogProperties>
<ErrorLogProperties>
<LogFileName>error_log</LogFileName>
<NumberOfLogFiles>2</NumberOfLogFiles>
</ErrorLogProperties>
</Consolidator>
</LogConsolidator>
2 Copy the configuration file, consolidatorconfig.xml, to the following BIRT iHub directory:
$AC_SERVER_HOME/etc
3 Install and run the startup and shutdown files after setting up the database:
On a UNIX system, the following Actuate scripts start and stop the consolidator application:
start_consolidator.sh
Starts the log consolidator application. The script takes $AC_SERVER_HOME as an argument and uses it to set the following path variables:
Configuration file
JAR file directory
CLASSPATH
The script stores the process ID or PID in $AC_SERVER_HOME/etc/consolidator.pid. Add this script to BIRT iHub script start_srvr.sh to start the consolidator application whenever you start BIRT iHub. start_consolidator.sh attempts to start the application five times.
stop_consolidator.sh
Stops the log consolidator application. The script takes $AC_SERVER_HOME as an argument and uses it to read the log consolidator application PID from $AC_SERVER_HOME/etc/consolidator.pid and kills the process. Add this script to BIRT iHub script stop_srvr.sh to stop the consolidator application whenever you stop the BIRT iHub.
On a Windows system, the consolidatorwin.exe utility installs and removes the application as a Windows service, and starts and stops the consolidator application. The BIRT iHub installation process installs and runs the utility in the following directory:
$AC_SERVER_HOME\bin
Use the consolidator.exe utility to install and configure the consolidator application. This utility assumes it is running in the BIRT iHub \bin directory.
The consolidatorwin.exe utility supports the following command line syntax:
consolidatorwin [-H/-?] [-SserviceType] [-UuserName] [-Ppassword]
The command-line arguments specify the following options:
-H requests help on usage
-S specifies the following types of service:
auto adds the log consolidator as the Actuate Usage and Error Logging Consolidator 9 service that starts automatically when Windows restarts.
manual adds the log consolidator as the Actuate Usage and Error Logging Consolidator 9 service that requires manual startup when Windows restarts.
console starts the consolidator at a Windows command prompt.
remove stops the service.
-U specifies the username
The Windows user starting the consolidator application. Actuate recommends using the same user as the user that starts BIRT iHub.
-P specifies the password
The user’s password.
The following command adds the consolidator application as a Windows service that starts automatically when Windows starts:
consolidatorwin -Sauto -UUsername -PPassword