Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionTo completely reestablish the projectdoc document index the Lucene index is required to be rebuilt and the projectdoc document cache needs to be cleared.
Doctypetopichide
NameReindex projectdoc Documents
Short Name
Parent
Parent Property
property-nameName
hide
Audience

Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesConfluence Administrator, Documentation Gardener
propertyAudience


Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags
Tag List
propertyTags

Iteration

Iteration
valuefinished

hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
propertyType

Level of Experience

Name List
doctypeexperience-level
render-no-hits-as-blanktrue
namesProficient
propertyLevel of Experience
empty-as-nonefalse


Expected Duration
Sponsors

Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors


Since2.0
Sort Keyhide
Section
show-titlefalse
titleDescription

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.

...

Section
titleProcedure

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

The reindexer updates the Lucene database for full text queries.

Steps
Section
titleRun the Lucene Indexer
Caution Box

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!

  • As a admin go to the "General configuration" section in the Confluence Administration
    Image Removed
  • Under "Administration" click "Content Indexing"
    Image Removed
  • Click "Rebuild" to run the indexer
    Section
    titleClear the projectdoc Documents Cache

    After the reindexer is finished you need to 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"
    Section
    titleRebuild 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)
    Section
    titleRun the Lucene Indexer

    The reindexer updates the Lucene database for full text queries.

    Caution Box

    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
      Image Added
    2. Under "Administration" click "Content Indexing"
      Image Added
    3. Click "Rebuild" to run the indexer
    Section
    titlePrerequisites

    ...