Configuration Options

1. Information

All the configuration keys referred on this page are optional and therefore are not required to startup Sakai with SiteStats. These keys should go in sakai.properties

Upgrading from 0.5.x releases Please note that the configuration keys in sakai.properties have changed in the pre_1-0 release. You need to review your configuration based on the information provided on this page. Starting Sakai with invalid configuration keys will lead to a startup failure.

2. Site Stats configuration options

2.1. Default chart rendering options

2.2. Event aggregation configuration options

Configuration key	Description	Version	Default value
collectThreadEnabled@org.sakaiproject.sitestats.api.StatsUpdateManager	Enable/disable collect thread	1.0+	true
collectThreadUpdateInterval@org.sakaiproject.sitestats.api.StatsUpdateManager	Db update interval for collect thread (in ms)	1.0+	4000
collectAdminEvents@org.sakaiproject.sitestats.api.StatsUpdateManager	Aggregate administrator events?	1.0+	false
collectEventsForSiteWithToolOnly@org.sakaiproject.sitestats.api.StatsUpdateManager	Aggregate events ONLY for sites with SiteStats tool?	1.0+	true
showAnonymousAccessEvents@org.sakaiproject.sitestats.api.StatsManager	Aggregate anonymous access events for public sites (with .anon role)	2.4.x 2.5.x 2.0+	true
lastJobRunDateVisible@org.sakaiproject.sitestats.api.StatsManager	Show/hide date from last event processed by the quartz job in tool overview page:	1.0+	true if collectThreadEnabled = false, false otherwise
maxEventsPerRun@org.sakaiproject.sitestats.api.StatsAggregateJob	Max # of events to be aggregated by the Quartz job	1.0+	50000
startEventId@org.sakaiproject.sitestats.api.StatsAggregateJob	First eventId to be processed by the Quartz job. If not specified, job will use the higher eventId available in SAKAI_EVENT when Sakai started up. This is for the first job run only - after that, status is maintained in SST_JOB_RUN table	1.0+	By default, will use the higher eventId available in SAKAI_EVENT when Sakai started up
driverClassName@org.sakaiproject.sitestats.api.StatsAggregateJob	DB driver class name. Use this if SAKAI_EVENT and SAKAI_SESSION lives on a different database from the Sakai one	1.0+	none
url@org.sakaiproject.sitestats.api.StatsAggregateJob	Jdbc url for the alternative database. Use this if SAKAI_EVENT and SAKAI_SESSION lives on a different database from the Sakai one	1.0+	none
username@org.sakaiproject.sitestats.api.StatsAggregateJob	Username for accessing the alternative database. Use this if SAKAI_EVENT and SAKAI_SESSION lives on a different database from the Sakai one	1.0+	none
password@org.sakaiproject.sitestats.api.StatsAggregateJob	Password for accessing the alternative database. Use this if SAKAI_EVENT and SAKAI_SESSION lives on a different database from the Sakai one	1.0+	none

2.3. Tool/event support (add/remove)

Generated events may differ between Sakai releases SiteStats have different event definition files for different Sakai releases. You may want to point * toolEventsDefinitionFile* setting below to the appropriate file in your installation (view folder content). A filename without version number means it is for the current sakai release.

Note: The recommendation here is to not replace the default bundled configuration file in order to get support for additional tools uppon SiteStats updates.

Warning When adding new tool events, the event description must be specified in the appropriate resource bundle file located in the sitestats/sitestats-impl/src/bundle/org/sakaiproject/sitestats/impl/bundle folder!

2.3.1 Tool event definition file (excerpt)

Below is an excerpt of the tool event definition file used by SiteStats.

<?xml version="1.0" encoding="UTF-8" ?>
<toolEventsDef>
	<!-- announcements -->
	<tool
		toolId="sakai.announcements"
		selected="true">
		<event eventId="annc.new" selected="true"/>
		<event eventId="annc.revise.own" selected="true"/>
		<event eventId="annc.revise.any" selected="true"/>
		<event eventId="annc.delete.own" selected="true"/>
		<event eventId="annc.delete.any" selected="true"/>
		<eventParserTip for="contextId" separator="/" index="3"/>
	</tool>
<!-- (...) -->
</toolEventsDef>

XML Fields Description

Example event reference for an Announcement logged event:
annc.new | /announcement/channel/~e65550f9-14c5-41ac-80be-a0657febd4ca/main

2.4. Enabling tracking of site visits

In Sakai 2.4.x / 2.5.x:
In order to be possible to track site visits in Sakai, the list of users present in site must be enabled (Sakai Presence service). If

is not applied into your sakai installation (most probable), the following configuration key is required in sakai.properties:

display.users.present = true

In Sakai trunk / 2.6+:
The list of users present in site is not a requirement anymore (see

) as long as the following configuration key is specified in sakai.properties:

presence.events.log = true

Common:
The tool will hide all visits related information if presence events are disabled in sakai.properties. However, you can force the enable/disable of visits related information in SiteStats:

2.5. External database configuration options

Version This feature requires SiteStats version >= 1.2 or trunk.

By default, the datasource connection pool is configured as follows:

• initialSize = 3
• maxActive = 5
• maxIdle = 3
• minIdle = 3
• timeBetweenEvictionRunsMillis = -1
  More datasource options are available at the Apache Commons API javadocs page.
  
  

3. Other configuration options

3.1 Enabling tracking of Wiki page reads

Depending on

resolution, you may need to either add a configuration key to sakai.properties (see jira) or manually perform the following change (with Sakai offline):

1. open /rwiki-tool/tool/src/webapp/WEB-INF/commandComponents.xml
2. set property trackReads of bean uk.ac.cam.caret.sakai.rwiki.tool.service.api.CommandService to true
3. save the file and redeploy rwiki component