My favorites | Sign in
Project Home Downloads Wiki Issues Source
Search
for
ProjectBrowserProperties  
The projectbrowser.properties configuration file
Featured
Updated Oct 17, 2008 by zsxking

Overview

The ProjectBrowser application reads a number of configuration parameters at startup. The default location for the file containing these properties is:

~/.hackystat/projectbrowser/projectbrowser.properties

This properties file should obey the Java Properties file format. Be careful to not include trailing whitespace, as this might be included as part of the property value.

This page documents the required and optional properties in the projectbrowser.properties file. The project sources and binary distribution contain a sample projectbrowser.properties file.

Name Default Description
projectbrowser.sensorbase.host (none) The sensorbase host.
projectbrowser.dailyprojectdata.host (none) The dailyprojectdata host.
projectbrowser.telemetry.host (none) The telemetry host.
projectbrowser.admin.email (none) (Required) The administrator responsible for this projectbrowser.
projectbrowser.wicket.configuration development The wicket configuration.
projectbrowser.host localhost The host name.
projectbrowser.port 9879 The port.
projectbrowser.context.root projectbrowser The context root.
projectbrowser.logging.level INFO The logging level.
projectbrowser.application.name Hackystat ProjectBrowser Optional text to appear as the header if logo not supplied.
projectbrowser.application.logo (none) Optional URL to a logo to appear as the header.
projectbrowser.sensordata.itemsperpage 50 The SensorData page has a pageable view of items. This parameter controls how many to display on one page.
projectbrowser.availablepage.sensordata true Whether the SensorData page is available.
projectbrowser.availablepage.dailyprojectdata true Whether the DailyProjectData page is available.
projectbrowser.availablepage.telemetry true Whether the Telemetry page is available.
projectbrowser.usagelogging false Whether to log user's usage.

projectbrowser.sensorbase.host

Indicates the sensorbase service that this projectbrowser will communicate with in order to establish user credentials and retrieve raw sensor data.

This connection is checked upon startup and the console will indicate whether a connection was achieved. Users can see which host is attached to this projectbrowser on the home page.

This property is required.

Example: http://dasha.ics.hawaii.edu:9876/sensorbase

projectbrowser.dailyprojectdata.host

Indicates the dailyprojectdata service that this projectbrowser will communicate with in order to retrieve DPD instances.

This connection is checked upon startup and the console will indicate whether a connection was achieved. Users can see which host is attached to this projectbrowser on the home page.

This property is required.

Example: http://dasha.ics.hawaii.edu:9877/dailyprojectdata

projectbrowser.telemetry.host

Indicates the telemetry service that this projectbrowser will communicate with in order to retrieve telemetry data.

This connection is checked upon startup and the console will indicate whether a connection was achieved. Users can see which host is attached to this projectbrowser on the home page.

This property is required.

Example: http://dasha.ics.hawaii.edu:9878/telemetry

projectbrowser.admin.email

The user who should be contacted in case of issues with this projectbrowser. Currently not used.

Example: johnson@hawaii.edu

projectbrowser.wicket.configuration

Wicket has two run-time modes: "development" and "deployment". You can control the mode that Wicket uses with this property.

The default is "deployment".

projectbrowser.application.name

The text that appears in the title bar and in the header.

Default: Hackystat ProjectBrowser

projectbrowser.application.logo

It is possible to put a logo rather than a textual name as the header. This should be a URL to the logo.

Default: none

Example: http://csdl.ics.hawaii.edu/misc/expedia.softfolio.gif

projectbrowser.sensordata.itemsperpage

When displaying raw sensor data in the Sensor Data page, this property controls how many items to display without paging.

Default: 50

projectbrowser.availablepage.*

This set of properties controls which pages are visible. Set the property to "true" to make a page visible.

By default, the following properties are set to true (and thus their corresponding pages are visible):

  • projectbrowser.availablepage.sensordata
  • projectbrowser.availablepage.dailyprojectdata
  • projectbrowser.availablepage.telemetry

As other pages become available for production use, their associated property will be documented here.

projectbrowser.usagelogging

If this property is set to "true", the system will log user's usage in telemetry an portfolio page.

The log files will be in ~/.hackystat/projectbrowser/logs/, with names of org.hackystat.projectbrowser.usage.X.log, where X is a number.


Sign in to add a comment
Powered by Google Project Hosting