Page tree

Versions Compared

Key

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

...

Section
titleUpgrade Instructions

Please follow this short guide to update your existing installation to this new version of the projectdoc Toolbox. For detailed information on dependencies, please consult the documentation of the add-ons.

Section
titleInstallation Order

Please install the projectdoc Toolbox first, then the extensions and finally update the doctype add-ons.

So this is the basic order:

  1. projectdoc Toolbox
  2. extension add-ons (start with Web API Extension)
  3. doctype add-ons (start with Core Doctypes)

Please install only those add-ons that are actually used! In case you do not use the Web API, there is no need to install it. (smile)


Section
titleConfiguration


Section
titlePage Size

Due to requirements of Confluence Data Center, the result set returned on queries is now limited to the page size configured in the administration section.

The default value is 100. Therefore there is a warning or error message if there are more than 100 hits in the result.

You may want to alter this value according to the resources provided for Confluence and the use cases to support with the projectdoc Toolbox.

Note Box
titlePage Size is Max Size for Macros

The name page size may be misleading as this is currently implemented as the maximum size of the result set for macros. It is the page size for paging when using the REST API.

Since the projectdoc Toolbox is used to create documentation to be exported to PDF, there is no use of paging in the macros. Therefore no macro currently supports paging. Users are required to adjust their queries so that the rendered content in HTML can be exported to PDF and both versions show the same result.



Section
titleDynamic Values

The use of dynamic values may impose problems. Users may expect that a query as a property value will be updated on every change of any page of Confluence. This is actually not the case. Therefore the use of dynamic properties (properties whose value are not fixed after the page has been saved) is limited to some very specific use cases. With other words: typically dynamic values for properties must not be used.

This version provides tools to help users to prevent making mistakes by making false assumptions. The handling of dynamic values is now controlled via the administration screen, where a mode can be configured. Per default it is set to allow. It is recommended to use a value of lenient (if users know exactly what to do and still need dynamic property values to implement their use cases) or strict (to prevent to force dynamic values where they do not belong). If the default mode does not work for your use cases, off will deactivate the checks completely.

For more information, please refer to 

Static Document Link
documentDynamic Property Values



Section
hidetrue
titleRefresh

Due to the following issues a refresh is required to update properties of projectdoc documents in the database.

Jira
serversmartics JIRA
columnIdsissuekey,summary,issuetype,priority,description
columnskey,summary,type,priority,description
maximumIssues1000
jqlQueryproject = 'projectdoc Toolbox' && (fixVersion IN ('6.0.0')) && "Break" ='runtime (fix with reindex)' ORDER BY priority DESC, type DESC
serverId79ad43bc-d289-364e-bfc7-46c09847bebd

In case you do not use any of these features, there is no need for a refresh.

Please refer to 

Static Document Link
documentprojectdoc Rebuild Manual
for details on how to refresh projectdoc documents.


...