Release Notes for XWiki Enterprise 3.1 Milestone 2

Last modified by Thomas Mortagne on 2017/03/24

Second milestone of the XWiki Enterprise 3.1 version (Roadmap). This is mostly an "upgrade" release in which we've upgraded lots of third party libraries we use. In addition we're now requiring Java 6 at runtime.

New and Noteworthy (since XWiki Enterprise 3.1M1)


For developers

  • XCOMMONS-10: Add support for injecting Logger with @Inject. Now you can have the XWiki Commons logging implementation inserted into your module using dependency injection.



  • No changes were added to translations.

Known issues

Test Report

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

Backward Compatibility and Migration Notes

Java 1.6

XWiki Enterprise 3.1 Milestone 2 and all subsequent versions will be compiled with Java6, Java5 is no longer supported.

Deprecated XClass database tables removed

In XWIKI-6624 a set of database tables and their supporting infrastructure were removed. These tables held XWiki Class information but since XWiki 1.0, the table method of storage has been deprecated and non-default. If upgrading from a pre-1.0 version of XWiki, it is important to make sure you are using the XML XWiki class storage and not the database tables first.

WYSIWYG Editor Configuration

In order to implement XWIKI-6618 we changed the format of the menu bar configuration. If you exclude the XWiki.WysiwygEditorConfig page when you upgrade your wiki pages (which you should do in order to preserve your WYSIWYG editor configuration) then you have to:

  1. edit the XWiki.WysiwygEditorConfig page with the object editor
  2. remove deprecated properties (you have to do this because we changed the type of the Menu Bar property to accommodate the new format)
  3. change the value of the Menu Bar property to use the following JSON format:
     "feature" : "link",
     "subMenu" : ["linkEdit", "linkRemove", "linkWikiPage", "linkAttachment", "|", "linkWebPage", "linkEmail"]
     "feature" : "image",
     "subMenu" : ["imageInsertAttached", "imageInsertURL", "imageEdit", "imageRemove"]
     "feature" : "table",
     "subMenu" : ["inserttable", "insertcolbefore", "insertcolafter", "deletecol", "|", "insertrowbefore", "insertrowafter", "deleterow", "|", "deletetable"]
     "feature" : "macro",
     "subMenu" : ["macroInsert", "macroEdit", "|", "macroRefresh", "|", "macroCollapse", "macroExpand"]
     "feature" : "import",
     "subMenu" : ["importOffice"]

If importing XWiki.WysiwygEditorConfig or XWiki.WysiwygEditorConfigTemplate fails then you have to follow this steps in order to update the WYSIWYG editor configuration:

  1. Revert the XWiki.WysiwygEditorConfigClass page to its previous version, i.e. the version before the import
  2. Delete the XWiki.WysiwygEditorConfig and XWiki.WysiwygEditorConfigTemplate pages from your wiki
  3. Import only the XWiki.WysiwygEditorConfigClass page from the upgrade XAR
  4. Import the XWiki.WysiwygEditorConfig and XWiki.WysiwygEditorConfigTemplate pages from the upgrade XAR

General Notes

If you're running in a multiwiki setup you'll also need to define the property to your xwiki.cfg file or explicitly name all databases to be migrated as in,db2,....

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

Always make sure you compare your xwiki.cfg file with the newest version since some configuration parameters were added. Note 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.

API Breakages

No APIs were modified since XWiki Enterprise 3.0.

Get Connected