Activity Stream Plugin

Provides APIs to store wiki events in the database

Description

Features

The activity stream plugin offers to store events in dedicated database tables, in order both to avoid heavy XWiki documents run-time processing (while for example retrieving recent page edits), and to allow new custom types of events, beyond the ones related to the documents life-cycle. The plugin API offers methods to record events in the database, either based on a document or custom events ; as well as methods to retrieve those events. Events can be filtered by the wiki space they concern, the name of the stream they have been recorded to, the user that has triggered its record, and other parameters. They can also be grouped by priority in order to display only the most relevant ones when the stream is very active.

Installation

Download and place the plugin JAR in the WEB-INF/lib/ folder of your XWiki installation.

Activate the plugin by editing your WEB-INF/xwiki.cfg file as follows and restart your XWiki instance:

Activate the Hibernate mapping by editing your WEB-INF/hibernate.cfg.xml file, and adding the following line as follow under your database standard XWiki configuration :

Prerequisites & Installation Instructions

Follow these steps:

• Add the JAR in your container classpath (WEB-INF/lib)
• Edit xwiki.cfg and add the following line to the list of plugins :
  xwiki.plugins=\
        [...]
         ... ,\
       <plugin package>
• Restart your container
• Verify the plugin is properly installed by typing the following in a wiki page :
  {{velocity}}
  $xwiki.<plugin name>.name
  {{/velocity}}

  If the installation has been successful, you will see <plugin name>.