Activity Stream Application

Last modified by Admin on 2024/07/05 17:56

cogDisplay all activity in the wiki or farm
TypeXAR
Category
Developed by

XWiki Development Team

Rating
1 Votes
LicenseGNU Lesser General Public License 2.1
Compatibility

XWiki Enterprise 2.6 and above

Installable with the Extension Manager

Description

Since XWiki 10.9RC1, this application is deprecated. It means we will no longer support it. Instead, the recommended extension to use is Notifications Application, which offers the same features but with more performances.

Since XWiki 11.1RC1, if you want to install Activity Stream Plugin anyway, you need to remove the file xwiki-platform-eventstream-store-*.*.jar from the WEB-INF/lib folder, because this macro depends on Activity Stream Plugin, and these modules cannot be installed together.

The Activity Stream Application contains an Activity Macro that listens to the following events:

  • create, edit, delete events for pages
  • comments events
  • attachments events
  • annotations events

Usage

Parameters definition

NameOptionalAllowed valuesDefault valueDescription
entriesyesString set to a numerical value20Number of entries to display the activity for
subentriesyesString set to a numerical value10Number of activities to show for each entry
wikisyesList of stringsSince 5.4:
  • On the main wiki: all wikis where the user has the view rights
  • On other wikis: the current wiki
Before 5.4:
  • the current wiki
Comma separated list of wikis to display activity for
spacesyesList of stringsAll spaces when not specifiedComma separated list of local serialized references of the spaces to display the activity for
authorsyesList of stringsAll authors when not specifiedComma separated list of authors whose modifications to show
tagsyesList of strings Comma separated list of tags to display activity for
minoryesString set to "true" or "false"falseWhether to show modifications that create minor versions or not
rssyesString set to "true" or "false"falseWhether to show activity rss link or not

Examples

List all activity for the current wiki:

{{activity/}}

List all activity for the current space and for the Admin user only:

{{velocity}}
{{activity spaces="$doc.space" authors="XWiki.Admin"/}}
{{/velocity}}

Screenshot

activity.png

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Dependencies

Dependencies for this extension (org.xwiki.platform:xwiki-platform-activitystream-ui 12.5.1):

Get Connected