- Created by Robert Reiner, last modified on 05. Oct 2021
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 13 Next »
projectdoc Toolbox
Improvements heading to data center support.
Today we released version 5.0 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 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.
The projectdoc Toolbox is an add-on for Confluence supporting agile software development teams to collaborate on process, project, system, and product documentation.
If you want to learn more about the projectdoc Toolbox and how it helps to create good project documentation, please refer to the introduction video!
The following image is a link to a video on YouTube. When you click the link your browser will serve a page from youtube.com
.
Very interesting, but way too fast?
Step through at your own pace with with our Prezi Presentation (external link to prezi.com
)!
In the Online Manual you’ll find additional video material that introduces you in the concepts of the projectdoc Toolbox.
Refer to use cases and show cases for information on how to use the projectdoc Toolbox.
Summary
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.
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
New and Noteworthy
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 data center.
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
For more information on updating information in the projectdoc database tables, please refer to Rebuild and Reindex, especially Upgrade Task.
Installation Instructions
Install the new OBR of the projectdoc Toolbox.
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.
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.
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!
Upgrade Order
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)
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 Rebuild and Reindex, especially Upgrade Task.
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 rebuild
Expect this to be huge. Do not upgrade without a backup plan!
Please refer to Rebuild and Reindex for details on how to rebuild the projectdoc tables.
Resources
- Release Notes
- Information on all released versions of the projectdoc Toolbox for Confluence.
- Glossary
- Terms used in and defined for projectdoc.
- FAQs
- Questions and answers related to the projectdoc Toolbox and Confluence.
- No labels