Release Notes for XWiki Enterprise 4.2 Milestone 1

Version 37.1 by Thomas Mortagne on 2012/07/18

This release is not finished yet, this is a work in progress

New and Noteworthy (since XWiki Enterprise 4.1 version)

JIRA Macro

A new JIRA Macro is now part of the Platform but is not bundled by default (you'll need to install it with the Extension Manager). We previously had a Contributed JIRA Macro but we decided that the JIRA macro was a good candidate to have in the Platform and thus supported by the XWiki Development Team. Compared to the older Contributed JIRA Macro, the new Macro has the following advantages:

  • No Programming Rights required
  • Supports issue ordering
  • Supports ability to register new Styles, new Data Sources and new Field Displayers
  • Displays closed issues as Striked-out
  • Written in Java with automated tests


Extension Manager improvements

Main improvements:

  • Starting with this version you can downgrade an extension. In other words, you can install an older version of an extension even if a newer version is currently installed. This doesn't apply to core extensions, which cannot be uninstalled, upgraded or downgraded individually. In order to downgrade an extension that is already installed you need to search for an older version. Currently this is possible only using the advanced search.


  • From the main wiki of a wiki farm you now have the option to trigger extension jobs (install, uninstall, upgrade, downgrade, etc.) that target all the wikis. For instance, as you can see below, you can install an extension on the entire wiki farm:


  • The log messages have been improved to include links to the affected documents or extensions as indicated in the following image:


Other small improvements include:

  • the progress tab is selected by default when you view the extension details if there is a job running (e.g. install in progress) for that extension
  • when there is a merge conflict, the 'Show changes' button updates the changes asynchronously without reloading the entire page
  • attachments of pages installed with the extension manager now have the right author set: the current user instead of the author from the XAR as it used to be
  • the file size of attachments installed with the extension manager is now properly set
  • the installation process is now more robust with respect to the exceptions that can occur while installing a JAR extension with components


  • Document attachments so far have been displayed in the order in which they are returned by the database, which most of the time happened to be the upload date. Starting with this version attachments are displayed ordered by their filename, which makes it easier to find an attachment, but support for selecting a different order (date, size, author...) will be added soon.
  • Uploading attachments with '+' character in their file names using the WebDAV interface shouldn't pose any more problems.
  • It's now possible to use Velocity scripts in the Copyright field in the Administration.
  • The XWiki Installer now fully works on Windows 7. The XWiki Data is now put in the %APPDATA%\XWiki Enterprise <version>\data directory, while the binaries are installed in Program Files.
  • It is no longer allowed to use scripts in comments.  This reduces the security risk from users that only have comment rights.
  • Macro parameters may now contain macro syntax.  Example: {{box title="{{info}}Hello!{{/info}}" }}Lorem ipsum ...{{/box}}
  • Improve OOB support for JBoss AS7:
    • Removed Struts Taglibs completely since we don't use them and some were defined but not made available, causing errors in deployments on JBoss AS7 ()
    • Fixed Logging conflict between JBoss AS and XWiki ()

For Developers

New Git Module

A new, optional (i.e. not installed by default), Git Module has been added. It allows to easily perform Git operations from within wiki pages. For example to count all commits for the past year and list all committers who's committed code during this period, you could write in a wiki page:

import org.eclipse.jgit.api.*
import org.eclipse.jgit.lib.*
import org.eclipse.jgit.revwalk.*
import org.gitective.core.*
import org.gitective.core.filter.commit.*

def service = services.get("git")
def commonsRepository = service.getRepository("git://", "xwiki-commons")
// Do a Git pull to get latest commits
new Git(commonsRepository).pull().call()
def finder = new CommitFinder(commonsRepository)

def dateFilter = new CommitterDateFilter(System.currentTimeMillis() - 365*24*60*60*1000L)
def countFilter = new CommitCountFilter()
def authorFilter = new AuthorSetFilter()
def filters = new AndCommitFilter()
filters.add(countFilter, authorFilter)

println "There have been ${countFilter.count} commits in the past year!"
println ""

println "The following committers have participated in those commits:"
authorFilter.getPersons().each() {
  println "* ${} (${it.emailAddress})"


  • The transformation context have a "restricted" flag to indicate that macros and other transformations should not perform modifications to the database, expensive computations or other potentially harmful operations.  Developers of macros and other rendering extensions should pay attention to this flag.
  • The messageSender macro now accepts 3 parameters that allow you to customize it by overriding the default displayed visibility levels for a message (that a user can choose from), the default selected visibility level and the default value (in case of user or group visibility). More details on .
  • The new experimental Security API that was first released in XWiki 4.0 is now bundled by default in XWiki Enterprise.
  • It's now possible to access root ComponentManager using "root" role hint:
    private ComponentManager rootComponentManager;
  • A Provider has been added to easily access the context ComponentManager (a proxy which choose the right ComponentManager depending on context information like the current user and the current wiki)
    private Provider<ComponentManager> contextComponentManager;


The following dependencies have been upgraded:

  • Infinispan 5.1.5
  • JDeb 0.11 
  • JGroups 3.1.0
  • Selenium 2.22
  • Tika 1.2

Test Report

You can check the manual test report to learn about what was tested and the results on various browsers.

Tested Browsers

Here's the list of browsers tested with this version (i.e. browsers that we've tested as working - Check the list of supported browsers):


Tested Databases


Known issues

Upgrade Notes

Version-specific Upgrade Notes

  • The and xwiki.temp.dir properties in the xwiki.cfg configuration file are no longer taken into account. The XWiki work dir (now called XWiki Data Directory or XWiki Permanent Directory) is now configured either by setting the System property or by setting the's environment.permanentDirectory property. The temporary directory is not configurable within XWiki but can be configured through your Servlet Container (since XWiki uses the Servlet container's temporary directory). See also Configuring directories.

General Upgrade Notes

If you're running in a multiwiki setup you'll also need to define the property in your xwiki.cfg file if you want to explicitly name some databases to be migrated as the default is now to migrate all databases. Database that are not migrated could not be accessed.

You may also want to import the default wiki XAR in order to benefit from all the improvements listed above.

Always make sure you compare your xwiki.cfg and files with the newest version since some configuration parameters were added. Note that you should add so that XWiki will attempt to automatically migrate your current database to the new schema. Make sure you backup your Database before doing anything.

Comments stored with a custom mapping or custom annotation class

If you happened to use a custom mapping for storing XWiki.XWikiComments objects in a separate table, you may have experienced problems with the migration R40001XWIKI7540. Dealing with custom mappings is outside the scope of the migration so now, if such a custom mapping is detected, the migration is simply skipped. The migration is also skipped if you use a custom annotation class for your annotation objects, other than the default AnnotationCode.AnnotationClass.

If you are in one of the two cases above and the migration is skipped, you will want to make sure that the Annotations docextra tab is still visible. To make it visible, set Administration > Look & Feel > Page Elements > Document metadata visibility > Show document annotations to Yes. You will continue to use your custom annotations (in the Annotations tab) or custom mapped comments (in the Comments tab) as before, without them being merged into one Comments tab, as it happens by default in the latest versions.

Please see for more details.

Custom displayers in the XWikiUsers class

If you have added some custom displayers to new or existing fields in the XWiki.XWikiUsers class, you need to check and make sure that they are written in 2.1 wiki syntax. This is required because the XWikiUsers document will now be forced to use the 2.1 wiki syntax, no matter what syntax you save it with. If your custom displayers are written in 1.0 syntax, for example, and the class document is in 2.1 syntax, they will not render.

API Breakages

The following APIs were modified since version 4.1:


Get Connected