Topics

• Home Page
  • Backend section
  • Files section
  • Instance usage section
    • Usage modal
    • Spam modal
    • Recycle bins modal
    • Empty pages modal
  • Health check section
  • Security section
    • Group rights page
    • User rights page
    • Cache check page
    • Transfer rights page
    • User rights on page
  • Cloud section
    • Livedata tables for issues and orders
• UI Administration page
• Requirements

Home Page

The application's home page features access to the dashboard, which is organized into sections.

Backend section

In this section, the user can access information about the backend, including details such as the operating system, server, database, java and XWiki version.
He can also access a modal to view the last lines of log, with a maximum of extracted lines of 50000.

Files section

A user can use this section to view the XWiki configuration and properties files and the last lines of log. These files are also downloadable via a modal in which you can choose which files to download.  

• For the log files, it will return all logs, not just the catalina files.
• For the XWiki properties and configuration files, make sure to exclude the lines that you don't want to be downloaded in Administration page.

An admin can also upload packages on the XWiki installation instance:

• An uploaded archive must have a clear folder structure and the files must be included in the folder where it needs to be applied. 

Example of a structure:

In case of an error, a backup of the original files is saved inside the permanent directory at: /adminTools/backup/. In case the automatic restore fails, manual action is required. The backups are not removed automatically.

Instance usage section

You can use this section to see stats related to the usage of the XWiki instance. Admins have access 4 different modals for monitoring the instance:

Usage modal

Displays a centralized overview of the wikis in your instance

• User count - number of active users in each wiki
• Documents count - number of documents in wiki
• Attachments count - number of attachments in wiki
• Total attachments size - combined size of all the attachments in wiki

Spam modal

• The user can configure the number of comments for a page to be considered spammed in Administration page.
  
   In this image, minimum number for spam has been set to 2 for demonstrative purpose.

Recycle bins modal

Empty pages modal

All modals tables are also accessible in dedicated pages.

Health check section

In this section, you can:

• Run a health check on the instance to make sure it is correctly configured and that there are no memory issues.
• A user can access a help page where links to instructions for configuration and installation are available.
• Flush the instance cache.
• View the JMX cache details. This allows you to get a general overview of the JMX cache, view the details of a specific entry and flush it, or flush the entire JMX cache:

Security section

You can use this section to see a security overview of the XWiki instance. An admin can also use this section to transfer rights from one user to another.

• Group rights page

• User rights page

• Cache check page

• Transfer rights page

  • Transfer rights select page:
    
  • Transfer rights overview:
    

• User rights on page

Cloud section

This section is dedicated to cloud instances, providing a centralized view of the current instance limits, orders, issues and providing links to directly access the XNNG account for users in the Network groups.

• View for Network users members:

• View for admin users:

Livedata tables for issues and orders

• Simple admin users will be able to view the history of orders and issues, but won't be able to access the XNNG instance via any links:

• Users that are members of XWiki Network groups will also be able to directly access an order or issue from the livedata tables:

UI Administration page

In the XWiki Administration, there is an entry that allows you to configure the application:

• You can manually add the server location if the application does not automatically find it (currently supported server is Tomcat)
• You can add the lines that you want to be excluded from the xwiki.cfg and xwiki.properties files. Each line has to be separated with a comma (","), with no empty spaces between.
• You can manually set the minimum spam limit for a page.

Requirements

User have administrator rights.
Tomcat servlet is mandatory.

Installation Steps

This paid extensions requires XWiki 15.10 or above. In order to install the extension, follow the next steps inside your XWiki instance (on cloud or on premise).

Navigate to the Extension Manager

In the Applications Panel click on "More Applications..." and then "Install new applications...". Alternatively navigate directly to the Administration and select the "Extensions" section.

Install the Extension

Search for the extension you wish to install and use the Install button to install it.

Get a License

Navigate to the "Licenses" section of the Administration, fill your details, look for the extension you just installed in the live table and click the buttons to get a trial license or to buy a license.

Install the License

If you have selected a trial license then you're good and there's nothing else to do. Your trial license is automatically installed.

However if you've selected to buy a license you'll be redirected to a page to perform the payment. At the end you need to come back to the "Licenses" administration section and click on the "Check for Updates" button. This will download and apply the license you bought.

Use the Extension

Start using the Extension! Refer to the extension's documentation to know how to use it.

Installing Paid Apps on Subwikis

If you want to install an application on the whole farm (main wiki + subwikis), you can do so directly from the main wiki’s Extension Manager, as seen below:

Extensions can also be installed only on a particular subwiki by global admins. Subwiki admins will not be able to install these extensions due to their limited rights.

Options

The price is per year and varies depending on the support level and the number of users.

Benefits

What do you get when you purchase an XWiki extension?

How to Buy

To buy, install this extension from inside your XWiki instance and follow the instructions.

Release notes

Extension details

License

• GNU Lesser General Public License 2.1

Sources

• https://github.com/xwikisas/application-admintools/tree/master/application-admintools-ui

Issues

• GitHub

Type

• xar

Developed by

• XWiki SAS

Compatibility

• Requires XWiki 15.10 or above.

Dependencies

• com.xwiki.admintools:application-admintools-default 1.4.2
• com.xwiki.admintools:application-admintools-webjar 1.4.2
• com.xwiki.licensing:application-licensing-licensor-api 1.32.3
• org.xwiki.platform:xwiki-platform-dashboard-ui 15.10
• org.xwiki.platform:xwiki-platform-livetable-ui 15.10
• org.xwiki.platform:xwiki-platform-sheet-ui 15.10
• org.xwiki.platform:xwiki-platform-uiextension-ui 15.10
• org.xwiki.platform:xwiki-platform-display-macro 15.10
• com.xwiki.commons:xwiki-pro-commons-pickers-ui 1.4.0