Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleUpgrade 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
titleBackup 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
titleUpgrade Order


Caution Box
titlePlease 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
titleprojectdoc 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):

  1. Update projectdoc Toolbox


Section
titleprojectdoc 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
documentRebuild and Reindex
, especially
Static Document Link
anchorUpgrade Task
documentRebuild and Reindex
labelUpgrade 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. (smile)

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 to not remove tables with the PD_ prefix until the your migration process has completed successfully.


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

  1. Update projectdoc Toolbox
  2. 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:

  1. Set the system property when starting the JVM -Dde.smartics.projectdoc.upgrade.skip-auto=true
  2. Update projectdoc Toolbox
  3. Update extension add-ons (start with Web API Extension)
  4. Update doctype add-ons (start with Core Doctypes)
  5. Remove the system property added in step 1 -Dde.smartics.projectdoc.upgrade.skip-auto=true



Section
titleRebuild

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
serversmartics JIRA
columnIdsissuekey,summary,issuetype,priority,description
columnskey,summary,type,priority,description
maximumIssues1000
jqlQueryproject = 'projectdoc Toolbox' && (fixVersion IN ('5.0.0', '5.0.1', '5.0.2', '5.0.3')) && "Break" ='runtime (fix with reindex)' ORDER BY priority DESC, type DESC
serverId79ad43bc-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
documentRebuild and Reindex
for details on how to rebuild or refresh the projectdoc tables.


...