Run the projectdoc Site Indexer

The following call runs a projectdoc Site Reindexer on all spaces, traversing each page. Each page is reindexed with Lucene and the internal structure is created.

{your-site}/confluence/rest/projectdoc-internal/1/indexer/site?reindex=true

In case not all spaces are projectdoc spaces, you may limit the reindex to these spaces by their space keys (spaceKeys). List the space keys comma-separated with no space characters: spaceKey1,spaceKey2,spaceKey3.

projectdoc Site Indexer

The projectdoc Site Indexer is a REST service to refresh the index and cache for a collection spaces (or all spaces in case no space key is specified).

{your-site}/confluence/rest/projectdoc-internal/1/indexer/site

The following request parameters are supported.

The service starts a long running task in the background. Therefore the returned code is 202 (Accepted) on success, 500 on errors. On success the response contains a reference to the long running task.

Clear the projectdoc Documents Cache

The projectdoc caches provide properties for the projectdoc documents. These properties are only used for rendering, not for Lucene searches.

To refresh the projectdoc documents cache run the following steps.

1. As a admin go to the "General configuration" section in the Confluence Administration
   
2. Under "Administration" click "Cache Management"
3. Find the projectdoc caches
   
4. Click "Flush" to clear the "projectdoc Document Cache"

Rebuild Doctype Cache

The doctype cache provides information about doctypes at runtime. This information is required for instance for ancestor queries.

To rebuild the doctype cache the admin is required to have the projectdoc-admin role (other roles also have the required privilege, see Cache Refresh Actions for details).

1. On a projectdoc page click on the page tool icon
   
2. Then click "Refresh Doctype Cache" (dependent on your roles not all menu items may be available)
   

Run the Lucene Indexer

The reindexer updates the Lucene database for full text queries.

1. As a admin go to the "General configuration" section in the Confluence Administration
   
2. Under "Administration" click "Content Indexing"
   
3. Click "Rebuild" to run the indexer

Clearing projectdoc Tables

The projectdoc Toolbox uses Active Objects (AO) tables to persistently cache projectdoc documents for performance reasons. The tables are only used for caching and store no information that cannot be derived from your Confluence pages. Therefore it is possible to clear those tables and repopulate them.

In case you have cleared the database tables, a simple Lucene reindex is not sufficient. You need to use the Indexer REST service to properly repopulate the AO tables. If you do not use this service, the projectdoc Toolbox won't be able to find projectdoc documents. A query, for instance employed by the Display Table Macro, will present not hits.

The following curl call shows how to start the projectdoc Reindexer without flushing the caches.

curl -n -s -X POST -H "Content-Type: application/json" "https://my.example.com/confluence/rest/projectdoc-internal/1/indexer/spaces"

Please change the URL part "my.example.com/confluence" to point to your Confluence server.