XWiki Connector

Prerequisites

Before configuring the XWiki connector in Wikit Connect:

1. An XWiki instance accessible from the Wikit Connect servers.
2. A user account with read access on the wikis and spaces to synchronize (if authentication is enabled).
3. The XWiki REST API must be enabled on your instance (enabled by default in XWiki).

Connector Configuration

The XWiki connector synchronizes pages and attachments from your XWiki instance to Wikit Semantics. It supports multi-wiki synchronization and allows targeting specific spaces.

Field Name	Format / Type	Required	Comment
Base URL	URL	✅	URL of your XWiki instance (e.g., https://xwiki.mycompany.com)
Wiki ID	Identifier	➖	ID of the target wiki. If not set, all wikis in the instance are discovered automatically
Spaces to synchronize	List of texts	➖	List of space IDs to synchronize. If not set, all spaces are synchronized. Example: test includes test, test/toto, test/pagetest1
Spaces to exclude	List of texts	➖	List of space IDs to exclude from synchronization (filters on the short space name)
Enable authentication	Yes / No	✅	Indicates whether Basic authentication is required to access the API
Username	Free text	➖	Username for Basic authentication (required if authentication is enabled)
Password	Password / Token	➖	Password for Basic authentication (required if authentication is enabled)
Include attachments	Yes / No	✅	Indicates whether attachments from XWiki pages should be synchronized

💡 Fields marked ✅ are required for the connector to work.

How the Connector Works

The XWiki connector synchronizes pages and attachments:

• Wiki discovery: if the Wiki ID field is filled in, only that wiki is processed. Otherwise, all available wikis are automatically discovered via the XWiki API.
• Space discovery: for each wiki, all spaces (parents and children) are retrieved. If Spaces to synchronize is set, only spaces whose path exactly matches or starts with one of the provided IDs are processed. Spaces whose name appears in Spaces to exclude are ignored in all cases.
• Page synchronization: for each space, pages are retrieved (up to 1,000 per space). The HTML content of each page is downloaded and converted to Markdown before being stored in Wikit Semantics.
• Attachment synchronization: if Include attachments is enabled, files attached to each page are retrieved and synchronized. Only file types supported by Wikit Connect are processed.

FAQ

How do I target a specific space and its sub-spaces?

Enter the short identifier of the space in the Spaces to synchronize field. For example, entering test will synchronize the test space as well as all its sub-spaces (test/toto, test/pagetest1, etc.). You can enter multiple identifiers to target several distinct spaces.

How do I exclude a space from synchronization?

Enter the short name of the space in the Spaces to exclude field. This filter applies to the short space name (last part of the path) and is active regardless of the Spaces to synchronize configuration.

Are all page attachments synchronized?

Only attachments whose file type is supported by Wikit Connect are synchronized. Unrecognized formats are ignored. Make sure the Include attachments option is enabled for attachments to be taken into account.

The XWiki instance is accessible without authentication. Do I still need to fill in credentials?

No. If your XWiki instance allows anonymous read access, you can disable the Enable authentication option and leave the Username and Password fields empty. However, for restricted-access instances, authentication is mandatory.