Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section


Column


Document Properties Marker
overridefalse


Short DescriptionIn order to completely restore the projectdoc document index, not only must the Lucene index be re-created and the projectdoc document cache cleared, but the internal projectdoc structures must also be rebuilt.
Doctypetopichide
NameTroubleshooting Reindexer for 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
valuereleased

hide
Type

Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTrouble Shooting
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
Deprecated5.0
Sort Keyhide
enable-heading-numbersfalsehide




Column
width40%


Panel
titleContents

Table of Contents
indent10px
stylenone



...

Section
show-titlefalse
titleDescription

The projectdoc Site Indexer is required after the database has been restored, a space has been imported, or for some reason the index is corrupt. This reindex may also be 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 after an update will be provided in the release notes of each version.

Not only needs the Lucene index be updated, but also the projectdoc caches need to be cleared and the projectdoc internal structure needs to be updated. Since the projectdoc Toolbox has no control over the standard Lucene Reindex Process, a projectdoc Reindex is required to be started via the projectdoc REST API. This can be done selectively on projectdoc spaces or on the complete site.

Note that the regular Lucene Reindex Process does no harm on the projectdoc document information in the database. Since the document are processed in random order, the contents of the properties may not be up-to-date. A reindex with the projectdoc Site Reindex will update the internal structures, the Lucene Index, and the cache.


Deprecated Box
titleDeprecated since Version 5

The Index Service is deprecated since version 5 of the projectdoc Toolbox.

Use the Rebuilder Service instead. Please refer to the

Static Document Link
documentprojectdoc Rebuild Manual
for details.


Section
titleSummary


Section
titleProcedure

The procedure consists of only one simple step. 

Caution Box

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


Section
titleRun 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.

Code Block
{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.

Note Box

The API documentation for the projectdoc Site Indexer is on this page.



...