The OpenOffice.org sensor collects data regarding developer activities using the OpenOffice.org suite. The OpenOffice.org sensor represents this data using the Activity SDT, documented in Section 25.2, “Activity”. Currently, the most important Activity event recorded by this sensor is the "state change" event, which is used to generate the Active Time abstraction.
OpenOffice.org is a multiplatform and multilingual office suite and an open-source project. Compatible with all other major office suites, the product is free to download, use, and distribute. Currently the following components are supported by the sensor: Writer, Impress, Math, Draw, Calc, Base and the help system.
The OpenOffice.org sensor requires OpenOffice.org 2.0 (or later) and Java 1.5.0 or later. Make sure that you selected and enabled an appropriated Java 1.5.0 or later for OpenOffice.org under "Tools > Options > Java" as illustrated in Figure 26.48, “ Configure the Java runtime environment of OpenOffice.org ”.
Use the OpenOffice "Package Manager" to remove an old sensor (Tools > Package Manager from the menu or use command line tool "unopkg gui" from console).
Follow the instructions in Chapter 2, Client-side configuration: Tool sensor installation to set your Hackystat host and user key.
In the HackyInstaller main window, select the OpenOffice.org sensor and press "Configure Selected Sensor". In the following dialog press the Install button and choose the location to download the "hackyOpenOffice.uno.zip" file.
Once the sensor package is downloaded from the Hackystat server, you must manually install it into OpenOffice.org using its package manager. To do this from within OpenOffice.org, choose "Tools > Package Manager" from OpenOffice menu and add the package to the context "My Packages".
Figure 26.50, “ OpenOffice.org sensor installer configuration window ” shows what the configuration window should look like after "hackyOpenOffice.uno.zip" file has been downloaded and installed.
This sensor supports the following properties and paths:
Enable OpenOffice.org Sensor: This property controls whether the sensor is active or not. If not checked, the sensor will not collect or send data even if installed. If checked, then Activity sensor data will be collected.
OPENOFFICE_HOME: This path specifies the OpenOffice.org installation folder.
The first step in verifying your Hackystat sensor installation is to make sure that there is the new entry in the OpenOffice.org menu "Tools > Add-Ons > Hackystat Sensor Info" and click it to open the dialog. Figure 26.51, “ Sensor information dialog of the Hackystat sensor for OpenOffice.org ” illustrates how the sensor information dialog could look like.
Table 26.12, “OpenOffice.org sensor installation information” lists the Hackystat information gathered by the OpenOffice.org sensor installation.
Table 26.12. OpenOffice.org sensor installation information
| Senor Information | Possible Values | Description |
|---|---|---|
| File sensor.properties | available / Not available | Displays whether the sensor.properties file exists. |
| Sensor enabled | true / false | Shows the value of the ENABLE_OPENOFFICE_SENSOR entry in your sensor.properties file. This entry does not consider the value set in the OpenOffice.org package manager. |
| Hackystat host | URL of the Hackystat Host | Displays the value of the HACKYSTAT_HOST entry in your sensor.properties file. |
| Host is alive | true / false | Displays whether the hackystat server can be found and is responding to Hackystat requests. |
After installing the sensor, bring up an OpenOffice.org application and edit a file for a few minutes and exit OpenOffice.org again. This will trigger a send of the data to the server (make sure the OpenOffice Quickstarter was closed as well). Then login to your account on the Hackystat server, and use the "List Sensor Data" command on the Extras page to verify that Activity data for today's date was received by the server for the "OpenOffice" tool, as illustrated in Figure 26.52, “ List Sensor Data with OpenOffice.org data ”.
The first step in troubleshooting your sensor installation is to verify that your Hackystat host and key settings are valid and that you can contact the Hackystat server, as described in Section 2.4, “HackyInstaller GUI: Setting and verifying the Hackystat host and user key”
A common installation problem is attempting to install the sensor with an unsupported version of OpenOffice.org or Java. Make sure you are using OpenOffice 2.0 and Java 1.5.0 or later, which must be set enabled under "Tools > Options > Java" (see Figure 26.48, “ Configure the Java runtime environment of OpenOffice.org ”).
To verify an UNO package is installed and enabled within OpenOffice properly, also check the package manager ("Tools > Package Manager"), as illustrated in Figure 26.49, “ UNO package manager dialog showing installed and enabled sensor package ”.
The OpenOffice.org sensor writes out a file called openoffice.0.log to the .hackystat/logs directory in your homedirectory that can be useful in debugging your installation. Under normal conditions, this file should look similar to Example 26.63, “openoffice.0.log file”.
Example 26.63. openoffice.0.log file
Hackystat Version: 6.3.1124 (November 24 2004 12:05:38)
SensorShell started at: 12/07/2004 11:05:13
Type 'help' for a list of commands.
Host: http://hackystat.ics.hawaii.edu/ is available and key is valid.
Defined shell command: Dependency
Defined shell command: Issue
Defined shell command: CodeIssue
Defined shell command: EvolSdt
Defined shell command: Perf
Defined shell command: FileMetric
Defined shell command: ReviewIssue
Defined shell command: Activity
Defined shell command: Cli
Defined shell command: ReviewActivity
Defined shell command: Coverage
Defined shell command: DevEvent
Defined shell command: UnitTest
Defined shell command: BuffTrans
Defined shell command: Commit
Defined shell command: Build
#> AutoSend [10]
AutoSend OK (set to 10 minutes)
AutoSend enabled every 10 minutes.
Checking for offline data to recover.
No offline data found.
#> Activity [set, tool=OpenOffice]
set OK
#> Activity [add, type=Tool Startup, data=]
Activity add OK (1 total)
#> Activity [add, type=Open File, data=/home/arthur/area51/test.odt]
Activity add OK (2 total)
#> send
Sending sensor data (02/22 15:40:25)
Ping: Ping OK (contacted server http://141.44.25.36:8080/ with valid key.)
Dependency: Send OK (No entries to send.)
AutoSend: AutoSend OK ('send' command ignored)
Issue: Send OK (No entries to send.)
CodeIssue: Send OK (No entries to send.)
EvolSdt: Send OK (No entries to send.)
Perf: Send OK (No entries to send.)
FileMetric: Send OK (No entries to send.)
ReviewIssue: Send OK (No entries to send.)
Activity: Send OK (2 entries)
Cli: Send OK (No entries to send.)
ReviewActivity: Send OK (No entries to send.)
DevEvent: Send OK (No entries to send.)
Coverage: Send OK (No entries to send.)
Commit: Send OK (No entries to send.)
BuffTrans: Send OK (No entries to send.)
UnitTest: Send OK (No entries to send.)
Build: Send OK (No entries to send.)
Make sure the Package Manager (unopkg) is closed and not used by an other process (also try closing OpenOffice and Quickstarter if opened). HackyInstaller may not access unopkg otherwise, because the Package Manager must be used exclusively. Also check unopkg does exist in the subdirectory "program" of the OpenOffice installation folder.
If none of the above troubleshooting activities solves your problem, then you should send an email to your Hackystat Administrator to request help. Please include in your email the following information:
The output from 'java -version'.
The output from 'java -jar sensorshell.jar -verify'.
The contents of your sensor.properties file.
The contents of the openoffice.0.log file.
A description of the problem you are having.
To disable OpenOffice.org sensor data collection temporarily, invoke HackyInstaller, bring up the OpenOffice.org configuration window, and uncheck the "Enable OpenOffice.org sensor" property, and apply the setting. To permanently uninstall the OpenOffice sensor, use the OpenOffice Package Manger.