projectdoc Toolbox 6.0.0 Release Notes

Section

Column

Document Properties Marker

doctype	release-note
override	false

Short Description

Final Data Center Compatibility, Feature release with dynamic value handling and Calculation Macro.

Name

projectdoc Toolbox 6.0.0 Release Notes

Short Name

Parent

Parent Property

property-name	Name

hide

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property	Audience
empty-as-none	true

Subject

Name List

doctype	subject
property	Subject

Sponsors

Name List

doctype	stakeholder
render-no-hits-as-blank	true
property	Sponsors

Sort Key

00006.00000.0000

hide

Section

show-title	false
title	Description

Today we released version

Display Property

property-name	Version

of the projectdoc Toolbox.

This is release provides new features and a couple of fixes and improvements.

Panel

borderColor	darkgrey
borderWidth	2

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

Transclusion

document	HOMESPACE:projectdoc Video Link
ids	projectdoc

Content Marker

hide	true

Info Box
Download the projectdoc Toolbox or visit the projectdoc Toolbox on the Atlassian Marketplace!

Column

width	350px

Panel

title	Release Notes Overview

Table of Contents

indent	15px
exclude	Release Notes\|Description\|Summary\|"References"\|Resources
style	none

Section

title	Summary

Section

title	New and Noteworthy

Section

title	Data Center Compatibility

To save resources on a Data Center installation of Confluence, macros are required to limit the number of hits processed in one request.

Since the projectdoc Toolbox is intended be used to design documents to be exported to formats like PDF, paging is not supported by most macros. If the result set generated by a macro is larger than the configured limit, dependent on the macro either a warning or an error is rendered. Users are required to adjust their queries to pass the limit test.

The following macros are also affected by this limitation.

Tour

header-translations	Title=Macro
replace-title-with-name	true

Title	Short Description
Display Table Macro
Display List Macro
Display List Template Macro
Transclude Documents Macro
Index Card Macro
Index Entries Table Macro
Child Documents Macro
Aspect References Macro
Tasks Report Macro
Calculation Macro

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

Tour

header-translations	Title=Macro
replace-title-with-name	true

Title	Short Description
Count Macro
Table Merger Macro
Table Set Macro

Administrator configure the page size, which defaults to 100, via the administration screen.

Not that also the Web API is limited by the page size. The Web API supports paging.

For more information, please refer to

Static Document Link

document	Limitations on Query Results

.

Section

title	Data Center Support

The following apps are approved to be used on Confluence Data Center.

Section

title	Extensions

The following extensions are available for Confluence Data Center and Confluence Server.

Tour

header-translations	Title=Doctype Add-on

Title	Version
Web API Extension	11.0.0
Information Systems Extension	6.0.0

Section

title	Doctype Add-ons

The following doctype add-ons are available for Confluence Data Center and Confluence Server.

Tour

header-translations	Title=Doctype Add-on

Title	Version
Core Doctypes Add-on	18.0.0
Doctypes for Agile Planning	15.0.0
projectdoc Developer Diaries	14.0.0
Doctypes for Project Management	7.0.0
Doctypes for Service Management	5.0.1
Doctypes for Business Strategy	4.0.2
Doctypes for Software Development	13.0.0
projectdoc Add-on for arc42	11.0.0
Doctypes for Teamwork	4.0.2
Doctypes for V-Modell XT	5.0.0

The following apps are currently not provided for Confluence Data Center. The Maven Extension will not be supported because it relies on libraries which are not updated regularly and the extension is considered unfit to meet the requirements imposed by a data center installation. It may still be used in some use cases.

Section

title	Extensions

The following extensions are not provided for Confluence Data Center.

Tour

header-translations	Title=Doctype Add-on

Title	Remarks
Bookmarklets Extension	May be available in the future
Maven Extension	Is only available for Confluence Server

Section

title	Doctype Add-ons

The user base is considered to small to continue the support of these doctype add-ons. The source for these add-ons is still available on Bitbucket.

Tour

header-translations	Title=Doctype Add-on

Title
projectdoc for Java Developers
projectdoc for Maven Developers

Section

title	Dynamic Value Handling

Although property values must not be dynamic, it seems that users just love to use them. There are use cases where this makes sense, but mostly the information architecture will get in trouble, once the whole set of projectdoc documents needs to be rebuild.

This version provides some tools to check the current state of dynamic values on your server. It also provides some configurations to handle the use of dynamic values in the future.

For more information, please refer to

Static Document Link

document	Dynamic Property Values

Section

title	Calculation Macro

Prior to this version there was only minor support to do some calculations. With this version there is the

Static Document Link

document	Calculation Macro

and the

Static Document Link

document	Calculation Result Macro

. It allows to run calculations on double values and render the results.

Currently there is no support for integer values, therefore use cases that require "full precision" (for instance calculations with currencies) are currently not supported.

Please refer to

Static Document Link

document	Calculation Macro

for more information on how to use calculations in your Confluence instance using the projectdoc Toolbox.

Section

title	Form Identifiers

Due to issues where the form identifiers are not properly encoded, we decided to replace the dots as separators with underscores. Therefore the name/identifier of a form field, for instance projectdoc.doctype.common.name is now specified as projectdoc_doctype_common_name. This is true for all identifiers used in the wizard.

This will reduce the amount of failures when the forms are processed with code that does not properly encode these identifiers.

Code Block

language	text
title	Example: Error Log from the Browser's Console

Uncaught DOMException: Failed to execute 'querySelector' on 'Element': 'label[for=projectdoc.doctype.common.name]' is not a valid selector.

More information on using dots with identifiers can be found in

Static Document Link

document	Identifiers with Dots

.

Due to this change all doctype add-ons are required to be updated for version 6.0 of the projectdoc Toolbox!

Section

title	Breaking Changes

Content Marker

is-empty-text	No issues found

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,description,fixVersions
columns	key,summary,type,priority,description,fixVersions
maximumIssues	1000
jqlQuery	project = 'projectdoc Toolbox' && (fixVersion IN ('6.0.0')) && "Break"!='runtime (fix with reindex)' ORDER BY priority DESC, type DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Result Size for REST API

When fetching documents with the REST API the maximum result set size also applies.

In case client scripts assume that the whole result set is returned, they now need to be adjusted to use the paging.

This also applies to the Web API Extension.

Section

title	Known Issues

Section

title	Installation Instructions

For new users of the projectdoc Toolbox who install this app the first time.

Install the new OBR of the projectdoc Toolbox.
Check if extensions are required to be installed for your use cases
Check if doctype add-ons are required to be installed for your use cases

All extensions and doctype add-ons are free of charge. The doctype add-ons are available with an open source license.

Section

title	Configuration

Section

title	Dynamic Values

For backward compatibility the default mode for Dynamic Value Handling is set to allow. It is recommended to use the value of lenient. The value can be configured in the administration section of the projectdoc Toolbox.

For more information, please refer to

Static Document Link

document	Dynamic Property Values

Section

title	Upgrade 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

title	Installation Order

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

So this is the basic order:

projectdoc Toolbox
extension add-ons (start with Web API Extension)
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.

Section

title	Configuration

Section

title	Page 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

title	Page 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

title	Dynamic 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

document	Dynamic Property Values

Section

hide	true
title	Refresh

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

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,description
columns	key,summary,type,priority,description
maximumIssues	1000
jqlQuery	project = 'projectdoc Toolbox' && (fixVersion IN ('6.0.0')) && "Break" ='runtime (fix with reindex)' ORDER BY priority DESC, type DESC
serverId	79ad43bc-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

document	projectdoc Rebuild Manual

for details on how to refresh projectdoc documents.

Section

title	List of Changes

The following changes are part of version

Display Property

property-name	Version

of the projectdoc Toolbox for Confluence.

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,description
columns	key,summary,type,priority,description
maximumIssues	1000
jqlQuery	project = 'projectdoc Toolbox' && (fixVersion in ('6.0.0')) ORDER BY priority DESC, type ASC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Subordinate Release Notes

Display Table

doctype	release-note
render-no-hits-as-blank	true
render-mode	definition
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

Section

title	Related Releases

This version does not require updates of doctype-add-ons, but we recommend the update of the Web API Extension.

Section

title	Extension Add-ons

Content Marker

hide	true

The following extension are required to be updated for this version of the projectdoc Toolbox.

Content Marker

hide	true
id	doctype-add-ons-overview-copy

Tour

header-translations	Title=Doctype Add-on

Title	Version
Web API Extension	11.0.0 (required)
Bookmarklets Extension	no update available
Information Systems Extension	6.0.0 (required)
Maven Extension	8.0.0 (required)

Section

title	Web API Extension

The following changes are part of the latest Web API Extension.

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDEXWAPI' && (fixVersion in ('11.0.0')) ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

hide	true
title	Bookmarklets Extension

The following changes are part of the latest Bookmarklets Extension.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDEXBML' && (fixVersion = '4.0.2') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Information Systems Extension

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

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDEXINFOSY' && (fixVersion = '6.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Maven Extension

The following changes are part of the latest Maven Extension.

Caution Box
This app is not available for Confluence Data Center.

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDEXMVN' && (fixVersion = '8.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Doctype Add-ons

The following doctype add-ons are required to be updated for the projectdoc Toolbox.

Content Marker

id	doctype-add-ons-overview

Tour

header-translations	Title=Doctype Add-on

Title	Version
Core Doctypes Add-on	18.0.0
Doctypes for Agile Planning	15.0.0
projectdoc Developer Diaries	15.0.0
Doctypes for Project Management	8.0.0
Doctypes for Service Management	6.0.0
Doctypes for Business Strategy	5.0.0
Doctypes for Software Development	14.0.0
projectdoc Add-on for arc42	12.0.0
Doctypes for Teamwork	5.0.0
Doctypes for V-Modell XT	6.0.0

Content Marker

hide	true
id	doctype-add-ons-overview-store

Tour

header-translations	Title=Doctype Add-on

Title	Version
Core Doctypes Add-on	18.0.0
Doctypes for Agile Planning	15.0.0
projectdoc Developer Diaries	15.0.0
Doctypes for Project Management	8.0.0
Doctypes for Service Management	6.0.0
Doctypes for Business Strategy	5.0.0
Doctypes for Software Development	14.0.0
projectdoc Add-on for arc42	12.0.0
Doctypes for Teamwork	5.0.0
Doctypes for V-Modell XT	6.0.0
projectdoc for Java Developers	7.0.0
projectdoc for Maven Developers	6.0.1

All doctype add-ons are optional. In case an add-on is not installed, there is no need to install it for this version of the projectdoc Toolbox.

In case any of the following doctype add-ons are used, they are required to be installed to work with this version of the projectdoc Toolbox.

Section

title	Core Doctypes

The following changes are part of the latest Core Doctypes Add-on.

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDCORED' && (fixVersion = '18.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Doctypes for Agile Planning

The following changes are part of the latest Doctypes for Agile Planning.

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDAGILE' && (fixVersion = '15.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	projectdoc Developer Diaries

The following changes are part of the latest projectdoc Developer Diaries.

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'DEVDIARY' && (fixVersion = '15.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Doctypes for Project Management

The following changes are part of the latest Doctypes for Project Management.

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDPRJMGMT' && (fixVersion = '8.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

hide	true
title	Doctypes for Risk Management

The following changes are part of the latest Doctypes for Risk Management.

This extension is experimental.

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDRISKMGMT' && (fixVersion = '3.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Doctypes for Service Management

The following changes are part of the latest Doctypes for Service Management.

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'SERVICES' && (fixVersion = '6.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Doctypes for Business Strategy

The following changes are part of the latest Doctypes for Business Strategy.

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'STRATEGY' && (fixVersion = '5.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Doctypes for Software Development

The following changes are part of the latest Doctypes for Software Development.

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDSWDEVD' && (fixVersion = '14.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	projectdoc arc42 Template

The following changes are part of the latest projectdoc Add-on for arc42.

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'ARCFOURTWO' && (fixVersion = '12.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Doctypes for Teamwork

The following changes are part of the latest Doctypes for Teamwork.

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDTEAMWORK' && (fixVersion = '5.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

title	Doctypes for V-Modell XT

The following changes are part of the latest Doctypes for V-Modell XT.

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDVMXT' && (fixVersion = '6.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

hide	true
title	Doctypes for Java Developers

The following changes are part of the latest projectdoc for Java Developers.

This extension is experimental.

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDJAVADEV' && (fixVersion = '7.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

hide	true
title	Doctypes for Maven Developers

The following changes are part of the latest projectdoc for Maven Developers.

This extension is experimental.

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDMVNDEV' && (fixVersion = '6.0.1') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

required-permissions	write-access
title	Notes

Section

title	References

Section

title	Resources

Tour

render-as-definition-list	true
replace-title-with-name	true

Title	Short Description
Release Notes
Glossary
FAQs

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 12

New Version 13

Key

About

Keep up-to-date!

Powered by