projectdoc Toolbox 5.0 Release Notes

...

Section

Column

Document Properties Marker

doctype	release-note
override	false

Short Description

Improvements heading to data center support.

Name

projectdoc Toolbox 5.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

00005.00000.0002

hide

Section

show-title	false
title	Description

Today we released version

Display Property

property-name	Version

of the projectdoc Toolbox. It includes changes from version 5.0.0 to 5.0.2. This version has been made available on the Atlassian Marketplace.

Since this is a major release, expect breaking changes!

Since This version 4 this version 5 includes a couple of changes required for data center support. Data center support is planned to be supported by the next major version of the projectdoc Toolbox.

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

This version addresses the increased performance requirements for data center.

One of the most relevant news for your upgrade is the new database structure the projectdoc Toolbox. Since the projectdoc tables did not store any information that cannot be derived from the Confluence pages, you simply need to rebuild the table data from scratch. Unfortunately this requires – especially for large installations – quite a lot of time. We recommend to check the upgrade process in a test environment on real data to get an estimation about how long this would take on your Confluence instance.

Pending Box

title	Here are some estimates from our test and production environments

Estimates?

...

Pro projectdoc Dokument ca 0,3 Sekunden. Nicht PD Dokumente sind nicht betroffen.

Beispiele:

1000 Dokumente = 300s = 5 Min

10.000 Dokumente = 3.000s = 50 Min

Preparing the projectdoc Toolbox worked for all integration aspects for data center almost out-of-the-box. The main challenge was to cope with the increased performance requirements under heavy load.

Another important amount of work was required to establish the test environment to meet Atlassian's requirements to accept the projectdoc Toolbox for data center on their Marketplace. Although this is not yet the release to be data center compatible, this is a major step towards starting the audit process.

One of the most relevant for your upgrade is the new database structure the projectdoc Toolbox establishes. Since the projectdoc tables did not store any information that cannot derived from the Confluence pages, you simply need to rebuild the table data from scratch. Unfortunately this requires – especially for large installations – quite a lot of time. We recommend to check the upgrade process in a test environment on real data to get an estimation about how long this would take on your Confluence instance.

Pending Box

title	Here are some estimates from our test and production environments

Estimates?

...

Pro projectdoc Dokument ca 0,3 Sekunden. Nicht PD Dokumente sind nicht betroffen.

Beispiele:

1000 Dokumente = 300s = 5 Min

10.000 Dokumente = 3.000s = 50 Min

100.000 Dokumente = 30.000s = 8:20 Stunden

This release has breaking changes. Therefore it is required to update extensions and doctype add-ons.

Section

title	New and Noteworthy

Very quickly the most relevant changes in this release.

projectdoc-projectdoc-section

title	Database Tables

We updated the database tables to store projectdoc data. This is required to cope with the increased load on Confluence when run under in a data center environment.

The old tables (identified by "PD_" in the table name) will stay untouched and the new structures will be stored in new tables (identified by "PD5_"). Even if the old data will still be available we highly recommend to have access to a current backup of your database.

The upgrade process will only affect projectdoc tables in Active Objects (AO). In case the process cannot complete successfully, because an accidental server downtime, please clear the new PD5 tables with corrupt content and restart the server. The process can also be started manually via a

Term Link

abbrev-mode	short-name
fullyQualifiedMode	false
maximumSelectionSize	1
supportTagging	true
focus	true
page	Representational state transfer
multiSelect	true

service.

For more information on updating information in the projectdoc database tables, please refer to

Static Document Link

document	Rebuild and Reindex

, especially

Static Document Link

anchor	Upgrade Task
document	Rebuild and Reindex
label	Upgrade Task

.

Section

title	Breaking Changes

Content Marker

is-empty-text	No issues found

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

Section

title	Known Issues

Display Table

doctype	section
render-no-hits-as-blank	true
render-mode	definition
restrict-to-immediate-children	true
where	$<Flags>=[Known Issue]

to

Static Document Link

document	Rebuild and Reindex

, especially

Static Document Link

anchor	Upgrade Task
document	Rebuild and Reindex
label	Upgrade Task

.

Section

title	Breaking Changes

Content Marker

is-empty-text	No issues found

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

Section

title	Known Issues

Display Table

doctype	section
render-no-hits-as-blank	true
render-mode	definition
restrict-to-immediate-children	true
where	$<Flags>=[Known Issue]

Section

title	Installation Instructions

Install the new OBR of the projectdoc Toolbox.

Section

title	Installation Order

In case this is the first time the projectdoc Toolbox is installed, please follow these instructions. In case you upgrade from an older version, please continue with

In-Document Link

anchor	Upgrade Instructions

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

So this is the basic order to upgrade:

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

Please install only those add-ons that you need! The add-ons provide additional features to the projectdoc Toolbox. The projectdoc Toolbox works without any further add-ons.

Install the new OBR of the projectdoc Toolbox.

Section

title	Upgrade Instructions

Here is a 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.

Caution Box

title	Backup first, install add-on second!

This upgrade requires an upgrade of the projectdoc tables. This upgrade will be started automatically!

Expect this to be huge. Do not install this version of the projectdoc Toobox without a backup plan!

Section

title	Upgrade Order

Caution Box

title	Please check again!

Make sure you have a recent backup and checked the upgrade in a test environment before you continue with the following steps.

Section

title	projectdoc Toolbox only

In case you are only using the projectdoc Toolbox without any extensions, you may install the projectdoc Toolbox and the automatic upgrade process of the projectdoc tables in your database will start automatically.

Order, when only the projectdoc Toolbox is in use:

projectdoc Toolbox

Section

title	projectdoc Toolbox with additional projectdoc add-ons

The projectdoc Toolbox will check that the versions of the add-ons are correct. If not, the upgrade process will be postponed. The issue will be logged at error level to the log and on each projectdoc document page online. This is the default process.

Alternatively you get full control over the process by setting

Section

title	Installation Instructions

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

Here is a 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.

Caution Box

title	Backup first, install add-on second!

This upgrade requires an upgrade of the projectdoc tables. This upgrade will be started automatically!

Expect this to be huge. Do not install this version of the projectdoc Toobox without a backup plan!

Section

title	Upgrade Order

Caution Box

title	Please check again!

Make sure you have a recent backup and checked the upgrade in a test environment before you continue with the following steps.

In case you are only using the projectdoc Toolbox without any extensions, you may install the projectdoc Toolbox and the automatic upgrade process of the projectdoc tables in your database will start automatically.

In case you have extensions to install, you should consider to set

the Java System system property de.smartics.projectdoc.upgrade.skip-auto to true. This will prevent the upgrade process to start. Install the projectdoc Toolbox then the extensions, unset the system property and restart the server.

So this is the basic order:

Only the projectdoc Toolbox

projectdoc Toolbox

projectdoc Toolbox with extension and doctype add-ons:

set the system property -Dde.smartics.projectdoc.upgrade.skip-auto=true

projectdoc Toolbox

extension add-ons (start with Web API Extension)

doctype add-ons (start with Core Doctypes)

For more information on updating information in the projectdoc database tables, please refer to

Static Document Link

document	Rebuild and Reindex

, especially

Static Document Link

anchor	Upgrade Task
document	Rebuild and Reindex
label	Upgrade Task

.

Please install only those add-ons that are actually used! In case you do not use any of the projectdoc extensions, there is no need

to install it.

For more information on updating information in the projectdoc database tables, please refer to

Static Document Link

document	Rebuild and Reindex

, especially

Static Document Link

anchor	Upgrade Task
document	Rebuild and Reindex
label	Upgrade Task

.

to install it.

Automatic (recommended)- projectdoc Toolbox with extension and doctype add-ons:

projectdoc Toolbox
check logs or open a projectdoc page to see if add-on updates are required
1. update extension add-ons (start with Web API Extension)
2. update doctype add-ons (start with Core Doctypes)

Manual - projectdoc Toolbox with extension and doctype add-ons:

set the system property -Dde.smartics.projectdoc.upgrade.skip-auto=true
projectdoc Toolbox
update extension add-ons (start with Web API Extension)
update doctype add-ons (start with Core Doctypes)
(in case the property has been set in a script) remove the system property -Dde.smartics.projectdoc.upgrade.skip-auto=true

Section

title	Rebuild

Due to the following issues a rebuild is required to update properties.This is detected by an automatic upgrade process. So there is no need to start the rebuildis required to update properties.

Expect this to be huge. Do not upgrade without a backup plan!

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

This is detected by the automatic upgrade process. So there is no need to start the rebuild manually if the automatic upgrade has been selected.

For complex navigation structure between projectdoc documents it may be required to run a refresh on the tables.

Please refer to

Static Document Link

document	Rebuild and Reindex

for details on how to rebuild or refresh the projectdoc tables.

Section

title	List of Changes

The following changes are part of the latest 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 ('5.0.0', '5.0.1', '5.0.2')) ORDER BY priority DESC, type DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

...

Section

hide	true
title	Related Releases

Section

title	Extension Add-ons

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

Content Marker

id	extension-add-ons-overview

Tour

header-translations	Title=Doctype Add-on

Title	Version
Web API Extension	10.0.0
Bookmarklets Extension	5.0.0
Information Systems Extension	4.0.0
Maven Extension

no update required

7.0.0

Section

title	Web API Extension

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

Jira

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

Section

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
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDEXINFOSY' && (fixVersion = '4.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.

Jira

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

Section

hide	true
title	Doctype Add-ons

The following doctype add-ons are recommended 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	15.0.1
Doctypes for Agile Planning	12.0.1
projectdoc Developer Diaries	13.1.0
Doctypes for Project Management	6.0.1
Doctypes for Service Management	4.0.1
Doctypes for Business Strategy	4.0.1
Doctypes for Software Development	12.0.1
projectdoc Add-on for arc42	10.0.1
Doctypes for Teamwork	4.0.1
Doctypes for V-Modell XT	4.0.1
projectdoc for Java Developers	6.0.0
projectdoc for Maven Developers	6.0.0

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.

Section

title	Core Doctypes

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

Jira

server	smartics JIRA
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDCORED' && (fixVersion = '15.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
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDAGILE' && (fixVersion = '12.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
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'DEVDIARY' && (fixVersion = '13.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
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDPRJMGMT' && (fixVersion = '6.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
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'SERVICES' && (fixVersion = '4.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
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'STRATEGY' && (fixVersion = '4.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
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDSWDEVD' && (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
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDTEAMWORK' && (fixVersion = '4.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
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDVMXT' && (fixVersion = '4.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
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'ARCFOURTWO' && (fixVersion = '10.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

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
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDJAVADEV' && (fixVersion = '6.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

Section

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
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDMVNDEV' && (fixVersion = '6.0.0') ORDER BY type DESC, priority DESC
serverId	79ad43bc-d289-364e-bfc7-46c09847bebd

...

Space shortcuts

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 13

New Version 14

Key

About

Keep up-to-date!

Powered by