cogProvide a store implementation for Event Stream based on the legacy Activity Stream.
TypeJAR
CategoryAPI
Developed by

XWiki Development Team

Rating
Rate!
0 Votes
LicenseGNU Lesser General Public License 2.1

Description

This extension is the default implementation and the store of Event Stream Module and it replaces Activity Stream Plugin.

Configuration

The following configuration options can be found in WEB-INF/xwiki.properties:

#-------------------------------------------------------------------------------------
# Event Stream
#-------------------------------------------------------------------------------------

#-# [Since 11.1RC1]
#-# The Event Stream, on which the notifications are based, stores data in a dedicated table in the database.
#-# Each wiki has its own database. The feature can be configured to store its data into the database corresponding to
#-# the wiki, into the main database (default: xwiki) or both. These options should not be both set to false (in this
#-# case the local store will be forced).
#-# Important note: disabling storage in the main store will prevent the notifications from retrieving events from
#-# subwikis. Moreover, disabling the main store makes impossible for global users to watch pages from subwikis. It is
#-# not recommended.
#-#
#-# This feature was originally implemented by the Activity Stream plugin so these settings might sound familiar to you.
#-#
#-# The default is :
# eventstream.uselocalstore = true
#-#
#-# The default is :
# eventstream.usemainstore = true
#-#
#-# Number of days the events should be kept (0 or any negative value: infinite duration)
#-# Note: if this value is greater than 0 a scheduler job will be created, this job will then be fired every week to
#-# delete events older than the configured value.
#-# The default is :
# eventstream.daystokeepevents = 0

Cleaning up the Event Stream

If you want to clean older entries from the Event Stream you have to un-comment the following line from xwiki.properties:

# eventstream.daystokeepevents = 0

Instead of 0, you must put the number of days the events should be kept. For example if you put the value 1, only the events from today and yesterday will be kept, the rest will be removed.
Please note that you will have to restart your wiki. After restarting, XWiki will create a job in the Scheduler space. You can fine tune the job's parameters according to your needs.

Prerequisites & Installation Instructions

Before XWiki 11.1.1 and XWiki 11.2RC1, you need to 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 :

<!-- Mapping files -->
[...]  
<mapping resource="eventstream.hbm.xml"/>
Tags:
Created by Guillaume Delhumeau on 2019/02/04 16:22
    

Get Connected