Rollback tool

Last modified by Oana Florea on 2016/12/20 17:19

arrow_undoRevert XWiki documents to a previous state.
TypeXAR
CategoryApplication
Developed by

Victor Rachieru

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

Description

This tool allows you to undo your screw-ups in a matter of just a few clicks.
The tool is available on the page Admin.Rollback (or URL https://<server>/xwiki/bin/view/Admin/Rollback).

Input

rollback-1.png

Source

This represents the source from which the document list to be rolled back will be extracted.
See below for a list of example inputs.

Rollback example for all documents from the Sandbox space:

RollbackHQL.png

Rollback example for the page Sandbox.WebHome:
RollbackSandbox.png

Source type

Source typeDescriptionSource example
xarXAR file which is attached to document of is present on the filesystem

attach:filename.xar
attach:[email protected]
/usr/local/xwiki/filename.xar

hql queryHibernate query, BaseObject as obj where doc.fullName = obj.name and obj.className = 'XWiki.XWikiUsers'
comma separated listComma separated list of documentsSandbox.TestPage1, Sandbox.TestPage2, Sandbox.TestPage3

Method

Method nameDescription
first known versionRollback to the oldest version in the current history of the document
previous versionRollback to the previous version
before dateRollback to the first version before the specified date

Include minor versions

Take into consideration minor versions in the document history or just stick to the major ones.

Delete if there's no criteria match

If the selected criteria returns no results for a document, delete it.
For example if the criteria is "before 2015/02/15 15:00" and the document has been created on "2015/04/13 12:00", it will be deleted.

Output

List documents

After listing the documents, you can select which ones you actually want to roll back by looking at their status messages and the diff between the current revision and the proposed revision.

rollback-2.png

Perform rollback

After the rollback is performed, the table will show the documents in their post-rollback state.

rollback-3.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
Tags:
Created by Victor Rachieru on 2015/04/13 15:22
    

Get Connected