projectdoc Toolbox 6.0.0 Release Notes

...

Section

hide	true
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 ('56.20.0')) && "Break"!='runtime (fix with reindex)' ORDER BY priority DESC, type DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

...

Section

title	Known Issues

Upgrade Instructions

Section

hide	true
title	Installation Instructions

Install the For new OBR users of the projectdoc Toolbox .

Section

title

who install this app the first time.

Install the new OBR of the projectdoc Toolbox.

Section

hide	true
title	Reindex

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 ('5.2.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.

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

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

Section

hide	true
title	Installation Order

Please install the projectdoc Toolbox first, then the extensions.

So this is the basic order:

projectdoc Toolbox
extension add-ons (start with Web API Extension)

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

hide	true
title	Installation Order	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.

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

true

Section

hide

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	1011.10.1 0 (recommendedrequired)
Bookmarklets Extension	no update available
Information Systems Extension	56.0.0 (required)
Maven Extension	no update required8.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 ('1011.10.10')) 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 = '56.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

true

projectdoc-section

hide

Section

title	Maven Extension

The following changes are part of the latest Maven 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 = 'PDEXMVN' && (fixVersion = '68.0.10') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd-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

Section

title	Doctype Add-ons

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

Content Marker

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

Tour

header-translations	Title=Doctype Add-on

Title	Version
Core Doctypes Add-on	1718.0.10
Doctypes for Agile Planning	1415.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
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 = '1718.0.10') 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 = '1415.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

hide	true
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 = '14.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

hide	true
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 = '7.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

hide	true
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 = '5.0.1') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

hide	true
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 = '4.0.2') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

hide	true
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 = '13.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

hide	true
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 = '4.0.2') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

hide	true
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 = '5.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

hide	true
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 = '11.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

...

Since there is a temporary problem on the Atlassian Marketplace to download the OBRs (projectdoc Toolbox and add-ons), we add the links here.

*.obr, *.jar

Section

required-permissions	write-access
title	Notes

Section

hide	true
title	Download

Attachments

patterns

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 5

New Version 6

Key

About

Keep up-to-date!

Powered by