XWiki Connector

For a general introduction to the connector, please refer to .

XWiki Configuration

Crawl User

The connector needs a crawl user which has the following permissions:

  1. Read access to all wikis, spaces, pages and documents, which should be indexed

  2. Permission to the wiki, space and page restrictions

  3. Read access to all users and all groups

  4. Read access to all group memberships

Password Policy

The crawl user must have no password rotation, or the password needs to be reset when it changes.

Content Source Configuration

The content source configuration of the connector comprises the following mandatory configuration fields.

Screenshot of the configuration dialog

  1. Instance base URL. This is the fully qualified domain name or host name of the XWiki instance, including port, without trailing slash.

  2. Public keys for SSL certificates: this configuration is needed, if you run the environment with self-signed certificates, or certificates which are not known to the Java key store.
    We use a straight-forward approach to validate SSL certificates. In order to render a certificate valid, add the modulus of the public key into this text field. You can access this modulus by viewing the certificate within the browser.

Details of a Self Signed Certificate

  1. Login: is the user name which is used by the connector to crawl the instance. Please see the section above for the necessary user permissions.

  2. Password: is the corresponding password for the crawl user

  3. Use e-mail as principal id: This will configure the connector to set the given user mail as the user id in the principal crawls. For instance a mail jane@organization.com will thus be used by the search engine to filter for Jane’s groups.

  4. Excluded wikis. This is a list of wiki ids which should be excluded from crawling

  5. Excluded spaces. This is a list of space ids which should be excluded from crawling

  6. Excluded folders. This is a list of regular expressions which will be applied to the relative item path’s. If a path matches, then the connector will stop crawling down into this branch. In turn, you can exclude technical items from the indexing scope.

  7. Excluded files from crawling: here you can add file extensions to filter attachments which should not be sent to the search engine.

  8. Rate Limiting. This will define a rate limiting for the connector, i.e., limit the number of API requests per second (across all threads).

  9. Page size for requests. Defines how many pages will be fetched per API request. Default is 100.

  10. Response timeout (ms). Defines how long the connector until an API call is aborted and the operation be marked as failed.

  11. Connection timeout (ms). Defines how long the connector waits for a connection for an API call.

  12. Socket timeout (ms). Defines how long the connector waits for receiving all data from an API call.

  13. The general settings are described at General Crawl Settings and you can leave these with its default values.

After entering the configuration parameters, click on validate. This validates the content crawl configuration directly against the content source. If there are issues when connecting, the validator will indicate these on the page. Otherwise, you can save the configuration and continue with Content Transformation configuration.

Recommended Crawl Schedules

Alfresco does not offer a change log but is relatively fast in delivering metadata. This means that incremental crawls are not supported right now.

Therefore, we recommend to configure full scans to run every 4 to 12 hours, full scan principal crawls to run twice a day. For more information see Crawl Scheduling .