Derzelas Script Runner

Last modified by Admin on 2021/03/17 21:02

cogAn application that simplifies running scripts on large number of documents from one or more wikis.
TypeXAR
CategoryApplication
Developed by

Paul Pantiru

Active Installs0
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

Description

An application that simplifies running scripts on large number of documents from one or more wikis.

This application is mainly intended for developers, but can also be used by people who know a tiny bit of velocity and know exactly what modifications they want to make to their documents.

The idea behind the "simplification" is that you no longer need to write the whole script, but only the actual modification you would do on a single document and it will be applied to all the selected documents.

Usage

After installing the extension, navigate to the "DerzelasScriptRunner" page.
From there you will be able to select the documents you want to run the script on.

documentSelection.png

When you are sure you have selected all the documents you need modified, click continue.

Now you can write or paste your velocity script. Below the little snippet provided you can see a list of all the documents that your script will be applied to.

insertingScript.png

When you are done, you can click the "Apply Script" button. You should be confident in your script (and we recommend you test it on a small number of documents first) because now you are at the point of no return.

Of course this will take some time depending on the number of documents you have selected. While the script is running you can check tomcat logs directly from the this page in case you don't have shh access or something. (only for Linux environments)

After you started applying the scripts a "More details" button will appear. This hides an input with the default value to "/usr/local/tomcat/logs/catalina.out" which you can change if this is not your log file (if you're on jetty for example). If the path to the log file is right and you click the "Update log" button, the last 1000 lines form the logs will be displayed. Each document that has been modified will leave a log entry and so will the end of the script.

MoreDetails.png

When the script has finished, a dialog box will let you know:

applied.png

Happy scripting! emoticon_smile

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

Get Connected