cogBundle of tools useful to manage an XWiki Farm
TypeXAR
Developed by

Denis Gervalle

Active Installs8
Rating
Rate!
1 Votes
LicenseGNU Lesser General Public License 2.1
Installable with the Extension Manager

Description

This is a bundle of tools for XWiki farm administrator.

The bundle is actually composed of:

Farm Importer

Ease importing a XAR package on multiple wikis.

Instructions:

  • Attach the desired .xar to the FarmTools.FarmImporter page
  • Autocomplete will help you while you type in the xar input of the form
  • You can start the xar import on the selected batch of wikis by pressing the 'Start' button. You can also cancel the operation on the upcoming wikis by pressing the 'Cancel' button

Farm Property Updater

Batch property updater for objects in multiple wikis.
It is currently split in two separate tools:

  • Farm Field Value Updater (FarmTools.FarmFieldValueUpdater)
  • Farm Preferences Updater (FarmTools.FarmPreferencesUpdater)

Both tools allows to change the value of a given object property from one value to another. You select the name of the document containing the object to change (without wiki prefix), and the same document in all wikis will get its object property updated. The object selected is always the first object matching the object class to be updated.

In the Farm Field Value Updater, you can freely choose the object class you want to update, and you can set a constant value to one of its properties.

In the Farm Preferences Updater, the object is always of class 'XWiki.XWikiPreferences', so only properties of this class could be updated. The update is done using a RegEx and a replacement value, so you have the ability to manipulate the existing value to produce the new one.
Additionally, in this second tool, there is a special property named "doc.parent", which allows you to update the parent of any chosen document using the same RegEx mechanism.

Tested on

This extension has been tested with the following configurations.

Extension VersionXWiki FlavorNotes
2.0XWiki Enterprise 5.3
2.3XWiki Enterprise 6.4.8

Declared compatibility is still 5.3, but the tests I have done are on 6.4.8 .

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

Release Notes

v2.3

  • Closed FARMTOOLS-10 Allow the farm field value updater/copier to create the target object if it does not already exist
  • Closed FARMTOOLS-9 Add a tool to delete objects of pages on the farm
  • Closed FARMTOOLS-8 Improve the farm field value updater to allow updating the objects with a value copied from another document

v2.1

  • Closed FARMTOOLS-5 Add a tool to update the default language of pages on a farm
  • Closed FARMTOOLS-4 Add a script that allows to update a class on all wikis
  • Closed FARMTOOLS-3 Add a script that allows to mass delete pages from multiple wikis
  • Closed FARMTOOLS-2 The field value updater does not work on XWiki Enterprise 5.3

v2.0

  • Closed FARMTOOLS-1 Refactor the farm-importer into farm-tools

Dependencies

Dependencies for this extension (org.xwiki.contrib.farmtools:application-farm-tools 2.3):

Tags:
Created by Denis Gervalle on 2015/03/05 19:57
    

Get Connected