Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Repaired outdated UsageEvent documentation

...

A usage instrumentation plugin is configured as a Spring bean in the applicationContext.xml for each of the various user interface web applications.  It will require the injection of an instance of EventService, which it will use to register itself on the UsageEvent bus.  See the configuration file for examples.

More than one such plugin may be configured – each will receive all usage events.

If you wish to write your own, it must extend singleton plugin for the abstract class org.dspace.appusage.statisticsAbstractUsageEventListener.AbstractUsageEvent.

The Passive Plugin

The Passive plugin is provided as the class org.dspace.appusage.statistics.PassiveUsageEventPassiveUsageEventListener. It absorbs events without effect. Use the Passive plugin when you have no use for usage event postings. This is the default if no plugin is configured., and serves as a simple example of how to write a UsageEvent listener.

The Tab File Logger Plugin

The Tab File Logger plugin is provided as the class org.dspace.appusage.statisticsTabFileUsageEventListener. UsageEventTabFileLogger. It writes event records to a file in tab-separated column format. If left unconfigured, an error will be noted in the DSpace log and no file will be producedit will write to [DSpace]/log/usage-events.tsv. To specify the file path, provide an absolute path, or a path relative to log.dir, as the value for usageEvent.tabFileLogger.file in dspace.cfg.

Property:

webui.submit.upload.required

 

JSPUI: Per item visual indicators for browse and search results

...