projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 26

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version 27

changes.mady.by.user Robert Reiner

Saved on

Key

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

...

Section
titleNew and Noteworthy

Very quickly the most relevant changes in this release.

Section
titleDatabase Tables

We updated the database tables to store projectdoc data. This is required to cope with the increased load on Confluence when run 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.

Example Box
titlePD5 Tables
  1. AO_63F547_PD5_DOC
  2. AO_63F547_PD5_NAME_REFS
  3. AO_63F547_PD5_PAGE_REFS
  4. AO_63F547_PD5_PG_FRGMNT
  5. AO_63F547_PD5_PROP

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 (not drop) the new PD5 tables with from corrupt content and restart the server. The process can also be started manually via a a

Term Link
abbrev-modeshort-name
fullyQualifiedModefalse
maximumSelectionSize1
supportTaggingtrue
focustrue
pageRepresentational state transfer
multiSelecttrue
service.

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
.


Section
titleEditing Experience

A couple of improvements address the user experience when working with projectdoc documents in the Confluence page editor.

All these features are considered experimental and are currently in an early release status with some limitations (for details please follow the links below).

  1. Static Document Link
    documentSection Expander
    : Macros in the page editor can be collapsed or expanded
  2. Static Document Link
    documentSection Navigation
    The editor can be opened at a specified location
  3. Static Document Link
    documentDynamic Editor Content
    : Provides dynamic content generated by macros when in the page editor


...

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 migration process has completet 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')) && "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.


...

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH