projectdoc Toolbox

Controls the parameter to use for running queries with the projectdoc Toolbox.

Users with administrator privileges can configure the processing of queries conducted by the projectdoc Toolbox.

Page Size

Controls the maximum number of hits returned for a query.

The main concern is on large installations, that a single user query is limited on the resources it uses. This is a requirement to run on Confluence Data Center.

The default value is 100 hits per page. Administrators may use this configuration to adjust this value according to the resources provided to their Confluence installation.

In case the service provides paging, all results can be retrieved page-by-page.

The Web API supports paging. Macros do not. If a macro is limited by the page size, then either a warning or error message (depends on the macro in use) is rendered.

The query results of the following macros are limited by the page size.

NameShort Description
Aspect References Macro
Autoconnect to aspect documents.
Calculation Macro
Run calculations on a set of result documents and renders the results.
Child Documents Macro
Renders the list of child documents, matching the given filter criteria.
Display List Macro
Lists references to projectdoc documents in a list. List contain names and optional short descriptions.
Display List Template Macro
Lists references to projectdoc documents in a list. List items are defined by templates referencing properties.
Display Table Macro
Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided.
Index Card Macro
Renders transcluded content fetched from documents of a result set.
Index Entries Table Macro
Renders a table of index entries.
Tasks Report Macro
Similar to the original Tasks Report Macro provided by Confluence, but allows to select on document with a Where clause.
Transclude Documents Macro
Renders transcluded content fetched from documents of a result set.

The following macros process tables and will render an error message if the underlying macros render a warning message.

NameShort Description
Count Macro
Renders the count of rows, list items, or definition terms.
Table Merger Macro
Merges tables (and lists) into one table (or list).
Table Set Macro
Applies a simple set operation on tables in its body.

Resources

More information on this topic is available by the following resources.

Limitations on Query Results
The number of hits for document queries is limited due to performance reasons.