Workspace Application

Last modified by Admin on 2021/03/19 02:13

chart_organisationXWiki application that manages workspaces.
Developed by

XWiki Development Team

Active Installs3
0 Votes
LicenseGNU Lesser General Public License 2.1

Installable with 3.2RC1+
Bundled with XEM 3.3+
Bundled with XE 5.2+

Installable with the Extension Manager


Since XWiki 5.3, this application has been replaced by the Wiki Application, which have the same features and improve the way we can manage subwikis. You should consider using it. This page is here for old wikis.

In XWiki 5.2, the "workspace" term has been replaced by "wiki".

A workspace is a subwiki that:

  • can be created by regular users, not just admins, where they can collaborate freely on a specific topic. The internal organisation of the workspace is left to its owner and its assigned admins.
  • uses only global users, redirecting any registration request to the main wiki
  • allows global users to join, request to join or be directly invited by a workspace admin, all based on the membership type of the specific workspace
  • can be deleted by its owner once it's no longer needed

The Workspace Manager application offers the UI to:

  • create a workspace
  • add a new "Home" menu (if there is at least one workspace - the feature is hidden otherwise) that provides :
    • a list of available workspaces
    • a link to the main wiki (the main wiki is now called "Home")
    • a link to the user index
    • a link to the administration of the home wiki.
  • update an existing workspace
  • delete a workspace
  • join an open workspace
  • request to join a join-by-request workspace
  • invite to users to an invitation-only workspace
  • manage the membership of a workspace
  • view the list of joined workspaces
  • manage a workspace's attributes
  • easily navigate trough the main wiki and its subwikis


  • You need to make sure the Wiki Manager Plugin is installed before installing this application
  • You need to make sure that the Workspace Module is already installed before installing this application



Who has the right to create a new workspace?

Only the users of the main wikis that have the createwiki right can create new workspaces. The admin can manage this right on the "Wikis" section of the administration.


Prerequisites & Installation Instructions

There are 2 ways to install Workspace Application:

Install: Manually (importing the XAR)


  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

In addition to Steps 1-4, depending on what version you are using please also perform the following:

Before 3.3

  1. Make sure that the Workspace Module is already installed and that the wiki is set up in a functional multi-wiki environment
  2. Install the Workspace Template corresponding to your XWiki version
  3. Go to the WorkspaceManager.Install page to finish and validate the install process

Since 3.3

  1. Make sure that the Workspace Module is already installed and that the wiki is set up in a functional multi-wiki environment
  2. Follow these steps to install the base workspace template to be used by all the newly created workspaces:
    • Download the default XWiki Enterprise xar from here that corresponds to the XWiki version that you have installed. You can also use your own workspace template if you like.
    • Rename the downloaded file from "xwiki-enterprise-ui-all-<version>.xar" to "workspace-template.xar"
    • Go to the page WorkspaceManager.Install; it will complain that the "workspace-template.xar" file is missing
    • Attach the "workspace-template.xar" file and refresh the page.
    • Now it will complain that the workspace template is not installed. Click 'Install' and wait for the page to finish loading. This is a lengthy operation and might take up to one minute or so.
  3. Finally, double check that the WorkspaceManager.Install page reports that everything is installed correctly

Install: Using the Extension Manager (since 4.4)

When installing the Workspace application with the Extension Manager, you need to make sure that you install the Workspace API, Wiki Manager API and Application Manager API extensions on the entire farm.
A simple way to do this is to perform the following steps:

  1. If you're running XWiki < 5.0 (starting with 5.0 the virtual mode is always on by default), set XWiki to virtual mode (set xwiki.virtual=1 in WEB-INF/xwiki.cfg and restart XWiki).
  2. Install the Workspace Application (Workspace UI) on the entire farm. This will install its dependencies on the entire farm.
  3. Uninstall the Workspace Application (Workspace UI) from the entire farm.
  4. Install the Workspace Application (Workspace UI) only on the main wiki.
  5. Perform Step 6 and Step 7 from 'Since 3.3'

Release Notes


  • No changes from previous version.


Dependencies for this extension (org.xwiki.platform:xwiki-platform-workspace-ui 5.2.4):

Get Connected