projectdoc Toolbox 5.0 Release Notes

...

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 Toolbox without a backup plan!

Info Box

title	Upgrading from an alpha Version

Upgrading from a previous alpha version (for example version 5.0.3) to the latest alpha version (for example version 5.0.9) does not require any of these steps. Simply update the app by uploading it manually to replace the 5.0.3 with the new 5.0.9.

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 (only one step):

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

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

Static Document Link

document	projectdoc Rebuild Manual

, especially

Static Document Link

anchor	Upgrade Task
document	projectdoc Rebuild Manual
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.

Caution Box

The migration process only starts when the projectdoc tables of version 5 are empty.

If these tables are not empty and the migration should be startet, please clear all tables of the projectdoc Toolbox with the PD5_ prefix.

It is highly recommended NOT to remove tables with the PD_ prefix until your migration process has completed successfully.

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

Update 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 when starting the JVM -Dde.smartics.projectdoc.upgrade.skip-auto=true
Update projectdoc Toolbox
Update extension add-ons (start with Web API Extension)
Update doctype add-ons (start with Core Doctypes)
Remove the system property added in step 1 ~~-Dde.smartics.projectdoc.upgrade.skip-auto=true~~

Section

title	Rebuild

Due to the following issues a rebuild is 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', '5.0.3', '5.0.4', '5.0.5', '5.0.6', '5.0.7', '5.0.8', '5.0.9', '5.0.10')) && "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	projectdoc Rebuild Manual

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

...

Section

id	#related-releases
title	Related Releases

The projectdoc Toolbox provides an internal API for extension add-ons and doctype add-ons. Therefore these additional app need to updated according to the version of the projectdoc Toolbox.

Section

title	Extension Add-ons

All extensions are optional. If you do not need the features provied provided by an extension, there is no need to install it.

If in use, the following extension are required to be updated for the projectdoc Toolbox to the specified versions.

Content Marker

id	extension-add-ons-overview

Tour

header-translations	Title=Doctype Add-on

Title	Version
Web API Extension	10.0.x0
Bookmarklets Extension	5.0.0
Information Systems Extension	4.0.0
Maven Extension	7.0.0

Section

title	Web API Extension

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

Expand

title	Click here to expand version information ...

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 ('10.0.0','10.1.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.

Expand

title	Click here to expand version information ...

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
columns	key,summary,type,priority,status,resolution,description
maximumIssues	1000
jqlQuery	project = 'PDEXBML' && (fixVersion = '5.0.0') 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.

Expand

title	Click here to expand version information ...

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.

Expand

title	Click here to expand version information ...

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

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	16.0.0
Doctypes for Agile Planning	12.0.x
projectdoc Developer Diaries	13.0.x
Doctypes for Project Management	6.0.1
Doctypes for Service Management	5.0.0
Doctypes for Business Strategy	4.0.1
Doctypes for Software Development	12.0.1
projectdoc Add-on for arc42	10.0.2
Doctypes for Teamwork	4.0.1
Doctypes for V-Modell XT	4.0.1
projectdoc for Java Developers	6.0.1
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.

Expand

title	Click here to expand version information ...

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 = '16.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.

Expand

title	Click here to expand version information ...

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 in ('12.0.0', '12.0.1') 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.

Expand

title	Click here to expand version information ...

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 in ('13.0.0', '13.0.1') 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.

Expand

title	Click here to expand version information ...

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

Section

title	Doctypes for Risk Management

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

This extension is experimental.

Expand

title	Click here to expand version information ...

Jira

server	smartics JIRA
columnIds	issuekey,summary,issuetype,priority,status,resolution,description
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.

Expand

title	Click here to expand version information ...

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

Expand

title	Click here to expand version information ...

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.1') 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.

Expand

title	Click here to expand version information ...

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 = '12.0.1') 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.

Expand

title	Click here to expand version information ...

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.1') 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.

Expand

title	Click here to expand version information ...

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 = '4.0.1') 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.

Expand

title	Click here to expand version information ...

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 in ('10.0.1', '10.0.2') 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.

Expand

title	Click here to expand version information ...

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 = '6.0.1') 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.

Expand

title	Click here to expand version information ...

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

New Version 65

Key

About

Keep up-to-date!

Powered by