projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 22

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version 23

changes.mady.by.user Robert Reiner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 17

...

Section


Column


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
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
valuefinished

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
Sort Keyhide
enable-heading-numbersfalsehide




Column
width40%


Panel
titleContents

Table of Contents
indent10px
stylenone




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.

Caution Box

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).



Section
titleSummary


Section
titleProcedure

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

Steps


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



...

Section
titleAlternative Procedure

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

Note Box

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.


Steps


Section
titleClear 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"


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


Transclusion
documentTroubleshooting Reindexer for projectdoc Documents
idsRun the Lucene Indexer




...

Section
titleClearing 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 reindexer.

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

Read our Tip on REST Login to Confluence with cURL for using curl with Confluence.Please change the URL part "my.example.com/confluence" to point to your Confluence server.

...

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH