You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

projectdoc Toolbox

To completely reestablish the projectdoc document index the Lucene index is required to be rebuilt and the projectdoc document cache needs to be cleared.

Audience
Type
Level of Experience
Since
2.0

A reindex is only required if the algorithm for storing information by the projectdoc Toolbox in the Lucene index has been changed. The fact that this procedure is required will be provided in the release notes of each version.

 

This is the recommended procedure for the projectdoc Toolbox version 2.0 and up.

The procedure for earlier versions is not very different, but recursion detection for references is a feature for display property macros added to 2.0. Users usually do not define recursions, but may do so very rarely unintentionally. Recursions in references are no problem as long as the cache is in place. If the cache is removed, recursions are detected by Confluence on a stack overflow. This may drain on resources until all recursions are resolved. Version 2.0 will detect recursions based on display property macros more quickly and render an error box as a value to the properties instead (if and only if the document cache is empty).

Procedure

Usually running the Lucene Indexer via the admin view is sufficient.

Run the Lucene Indexer

The reindexer updates the Lucene database for full text queries.

 

A reindex can take quite a long time for large sites. Please make sure to run the indexer at an appropriate time for your organization!

  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

Alternative Procedure

Run the following steps to reindex and refresh the projectdoc caches.

 

Refreshing documents that are linking extensively multi-directional may need several refreshes.

In certain contexts, using the Refresh Page Tree (see Cache Refresh Actions) may help to refresh a tree top-down from the root to the leaves.

Clear the projectdoc Documents Cache

First refresh the projectdoc documents cache.

  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.

 

A reindex can take quite a long time for large sites. Please make sure to run the indexer at an appropriate time for your organization!

  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

Resources

Cache Refresh Actions
projectdoc documents are stored in caches for quick access. Users may want to clear one of these caches.
Search Tips
Tips on specifying search queries for Lucene. This also applies to projectdoc's query macros.
Logging
List of loggers for monitoring projectdoc.
  • No labels