projectdoc Toolbox 6.2.13 Release Notes

Bugfix release, including the removal of Autorefresh on Space Import and support for hierarchical events triggered by third-party tools. 

Release Date

Today we released version 6.2.13 of the projectdoc Toolbox on the Atlassian Marketplace!

This version supports Confluence up to version 8.9.x. For Confluence 9.x we will release a separate version of the projectdoc Toolbox.

The projectdoc Toolbox is an add-on for Confluence supporting agile software development teams to collaborate on process, project, system, and product documentation. 

Breaking Changes

List of breaking changes with probably the largest impact on existing installations.

Key Summary T P Description Fix Version/s
PDAC-1811 Remove Autorefresh on Space Import Improvement Major

When the admin imports a space the projectdoc Toolbox starts the refresh of the space if a Build Index is requested. Since we do not render the state of this process in the administration screens, it is difficult for admins to determine whether the process has finished or not.

In addition to that we also should not automatically start a rebuild or refresh, since we do not really know what is the best move.

Therefore, we should leave the decision what to do to update the projectdoc databases to the admin. If a site is imported, a complete rebuild should be started. If only a single space is imported, then maybe only this space should be refreshed, either with the standard Space Admin Refresh or – with more control options – via a REST call.

With this removal we add a box to the Import Screen so that admins are reminded that additional steps may need to be taken. A similar reference has already been implemented on the Content Indexing screen.

We will also render messages to the log on INFO level. This may help analyzing issues by an admin or by the development team.

We consider this a breaking change albeit only an automatic refresh has been removed that may cause harm and can easily be executed manually via existing options. It is listed as a breaking change since a feature has effectively been removed and a removal is a breaking change be definition. We handle it as a bugfix version and not as a major version (according to Semantic Versioning) since we effectively removed a design issue.

6.2.13

Installation Instructions

Install the projectdoc Toolbox to your Confluence instance. There are no additional steps necessary.

Upgrade Instructions

Update the projectdoc Toolbox on your Confluence instance.

If you are using the Information Systems Extension, you need to update that to version 7.0.2.

It is important for administrators who import spaces that with this version a manual rebuild is required. If multiple spaces are imported, a site-wide rebuild is typically the correct choice. If only one space is imported and this space is not referenced by other spaces, a local rebuild on the imported space is typically sufficient (and much faster).

List of Changes

The following changes are part of version 6.2.13 of the projectdoc Toolbox for Confluence

Key Summary T P Description
PDAC-1818 Tour Macro in HTML Export Bug Major

When rendering properties in the TourMacro, the properties of referenced projectdoc Documents do not show up when the HTML Export is running.

It is expected that the properties can be rendered in View, PDF, and HTML Mode.

PDAC-1815 Support third-party Hierarchical Events Improvement Major

The projectdoc Toolbox supports only hierarchical events triggered by Confluence. This implies some optimization on the processing of events on pages.

Third-party events should also be supported to allow users to run their own business processes in their own threads.

Note that Page Tree Moves are currently not supported.

PDAC-1811 Remove Autorefresh on Space Import Improvement Major

When the admin imports a space the projectdoc Toolbox starts the refresh of the space if a Build Index is requested. Since we do not render the state of this process in the administration screens, it is difficult for admins to determine whether the process has finished or not.

In addition to that we also should not automatically start a rebuild or refresh, since we do not really know what is the best move.

Therefore, we should leave the decision what to do to update the projectdoc databases to the admin. If a site is imported, a complete rebuild should be started. If only a single space is imported, then maybe only this space should be refreshed, either with the standard Space Admin Refresh or – with more control options – via a REST call.

With this removal we add a box to the Import Screen so that admins are reminded that additional steps may need to be taken. A similar reference has already been implemented on the Content Indexing screen.

We will also render messages to the log on INFO level. This may help analyzing issues by an admin or by the development team.

We consider this a breaking change albeit only an automatic refresh has been removed that may cause harm and can easily be executed manually via existing options. It is listed as a breaking change since a feature has effectively been removed and a removal is a breaking change be definition. We handle it as a bugfix version and not as a major version (according to Semantic Versioning) since we effectively removed a design issue.

PDAC-1814 Aspect Sections Macro Parameter Type Bug Minor (migrated)

When processing the Aspects Section Macro the following warning is found in the logs: "Unhandled parameterType java.lang.Boolean for macro projectdoc-aspect-sections-macro with value of true."

We need to fix the macro's configuration to provide the type of the parameters to Confluence.

PDAC-1813 Provide a non-null Task Key Bug Minor (migrated)

In some use cases a warn message is logged if a task has not a unique key to identify.

All tasks have names, but this seems not to be sufficient for some use cases. Therefore, we need to override the base method of our task implementations to provide a unique key.

PDAC-1812 False Duplicate Property Reports Bug Minor (migrated)

With the log message "More than one property found:" it seems to indicate that a document has multiple properties by the same name. The message is reporting a false observation. It simply states that the same property has been found on multiple documents that have been found the one result set.

So there is no error and the message must be removed.

PDAC-1810 Required Write Access and Export Improvement Minor (migrated)

Content Macros that do not render if user has no write access to the page the macro is part of, should also not render if the macro is rendered in export mode.

Export mode includes HTML and PDF Export.

Related Releases

This version does not require updates of doctype-add-onsor the Web API Extension.

Extension Add-ons

Information Systems Extension

The following changes are part of the latest Information Systems Extension.

Key Summary T P Status Resolution Description
PDEXINFOSY-50 API Update to projectdoc Toolbox 6.0 Improvement Blocker (migrated) Done Fixed

Changes to the internal API of the projectdoc Toolbox require updates in this extension.

Resources

Additional resources on our website regarding the release of the projectdoc Toolbox.

Release Notes for the projectdoc Toolbox
Relevant information on changes to the projectdoc Toolbox for Confluence introduces by new versions of this app.
Glossary
Terms used in and defined for projectdoc.
FAQs
Questions and answers related to the projectdoc Toolbox and Confluence.