Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
Document Properties Marker
doctyperelease-note
overridefalse
Short DescriptionFinal Data Center Compatibility, Feature release with dynamic value handling and Calculation Macro.
Nameprojectdoc Toolbox 6.0 .0 Release Notes
Short Name
Parent
Parent Property
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
empty-as-nonetrue

Subject
Name List
doctypesubject
propertySubject

Categories
Name List
doctypecategory
propertyCategories

Tags

Tag List
propertyTags


Iteration

Iteration
valueproduction

hide
Type
Name List
doctyperelease-note-type
render-no-hits-as-blanktrue
propertyType

Version6.0.0hide
Productprojectdoc Toolboxhide
Release Date

23 Sep  

hide
Sponsors

Name List
doctypestakeholder
render-no-hits-as-blanktrue
propertySponsors


Sort Key00006.00000.00000030hide
Section
show-titlefalse
titleDescription

Today we released version 

Display Property
property-nameVersion
of the projectdoc Toolbox which is made available on the Atlassian Marketplace on November 1, 2022.

Info Box
titleExtensions and Doctype Add-ons

As of all versions of the apps related to the release 6.0 of the projectdoc Toolbox are  available on the Atlassian Marketplace.

This is release provides new features and a couple of fixes and improvements .and is approved by Atlassian to be compatible with Confluence Data Center. This version still supports Confluence Server.

Panelpanel
borderColordarkgrey
borderWidth2

The projectdoc Toolbox is an add-on for Confluence supporting agile software development teams to collaborate on process, project, system, and product documentation. 

Transclusion
documentHOMESPACE:projectdoc Video Link
idsprojectdoc


Content Marker
hidetrue
Info Box

Download the projectdoc Toolbox or visit the projectdoc Toolbox on the Atlassian Marketplace!

Column
width350px
Panel
titleRelease Notes Overview

Table of Contents
indent15px
excludeRelease Notes|Description|Summary|"References"|Resources
stylenone

...

Section
titleNew and Noteworthy
Section
titleData Center Compatibility

To save resources on a Data Center installation of Confluence, macros are required to limit the number of hits processed in one request.

Since the projectdoc Toolbox is intended be used to design documents to be exported to formats like PDF, paging is not supported by most macros. If the result set generated by a macro is larger than the configured limit, dependent on the macro either a warning or an error is rendered. Users are required to adjust their queries to pass the limit test.

The following macros are also affected by this limitation.

Tour
header-translationsTitle=Macro
replace-title-with-nametrue

The following macros process tables and will render an error message if the underlying macros render a warning message.

Tour
header-translationsTitle=Macro
replace-title-with-nametrue

Administrator configure the page size, which defaults to 100, via the administration screen.

Not that also the Web API is limited by the page size. The Web API supports paging.

For more information, please refer to 

Static Document Link
documentLimitations on Query Results
.

Section
titleData Center Support

The following apps are approved to be used on Confluence Data Center.

Section
titleExtensions

The following extensions are available for Confluence Data Center and Confluence Server.

Tour
header-translationsTitle=Doctype Add-on
Section
titleDoctype Add-ons

The following doctype add-ons are available for Confluence Data Center and Confluence Server.

Tour
header-translationsTitle=Doctype Add-on

The following apps are currently not provided for Confluence Data Center. The Maven Extension will not be supported because it relies on libraries which are not updated regularly and the extension is considered unfit to meet the requirements imposed by a data center installation. It may still be used in some use cases.

Section
titleExtensions

The following extensions are not provided for Confluence Data Center.

Tour
header-translationsTitle=Doctype Add-on
TitleRemarks
Bookmarklets ExtensionMay be available in the future
Maven ExtensionIs only available for Confluence Server
Section
titleDoctype Add-ons

The user base is considered to small to continue the support of these doctype add-ons. The source for these add-ons is still available on Bitbucket.

Tour
header-translationsTitle=Doctype Add-on
Section
titleDynamic Value Handling

Although property values must not be dynamic, it seems that users just love to use them. There are use cases where this makes sense, but mostly the information architecture will get in trouble, once the whole set of projectdoc documents needs to be rebuild.

This version provides some tools to check the current state of dynamic values on your server. It also provides some configurations to handle the use of dynamic values in the future.

In case you need to stick with the old lenient model, set the checking to off. This approach is not recommended. You can use REST services to check which mode is most appropriate to your information architecture.

For more information, please refer to 

projectdoc-static-document-
For more information, please refer to 
projectdoc-static-document-link-macro
documentDynamic Property Values

Section
titleCalculation Macro

Prior to this version there was only minor support to do some calculations. With this version there is the

Static Document Link
documentCalculation Macro
and the 
Static Document Link
documentCalculation Result Macro
. It allows to run calculations on double values and render the results.

Currently there is no support for integer values, therefore use cases that require "full precision" (for instance calculations with currencies) are currently not supported.

Please refer to

Static Document Link
documentCalculation Macro
for more information on how to use calculations in your Confluence instance using the projectdoc Toolbox.

Section
titleForm Identifiers

Due to issues where the form identifiers are not properly encoded, we decided to replace the dots as separators with underscores. Therefore the name/identifier of a form field, for instance projectdoc.doctype.common.name is now specified as projectdoc_doctype_common_name. This is true for all identifiers used in the wizard.

This will reduce the amount of failures when the forms are processed with code that does not properly encode these identifiers.

Code Block
languagetext
titleExample: Error Log from the Browser's Console
Uncaught DOMException: Failed to execute 'querySelector' on 'Element': 'label[for=projectdoc.doctype.common.name]' is not a valid selector.

More information on using dots with identifiers can be found in 

Static Document Link
documentIdentifiers with Dots
.

Due to this change all doctype add-ons are required to be updated for version 6.0 of the projectdoc Toolbox!




...

Section
titleUpgrade Instructions

Please follow this short guide to update your existing installation to this new version of the projectdoc Toolbox. For detailed information on dependencies, please consult the documentation of the add-ons.

Section
titleInstallation Order

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

So this is the basic order:

  1. projectdoc Toolbox
  2. extension add-ons (start with Web API Extension)
  3. 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. (smile)

Section
titleConfiguration
Section
titlePage Size

Due to requirements of Confluence Data Center, the result set returned on queries is now limited to the page size configured in the administration section.

The default value is 100. Therefore there is a warning or error message if there are more than 100 hits in the result.

You may want to alter this value according to the resources provided for Confluence and the use cases to support with the projectdoc Toolbox.

Note Box
titlePage Size is Max Size for Macros

The name page size may be misleading as this is currently implemented as the maximum size of the result set for macros. It is the page size for paging when using the REST API.

Since the projectdoc Toolbox is used to create documentation to be exported to PDF, there is no use of paging in the macros. Therefore no macro currently supports paging. Users are required to adjust their queries so that the rendered content in HTML can be exported to PDF and both versions show the same result.

Section
titleDynamic Values

The use of dynamic values may impose problems. Users may expect that a query as a property value will be updated on every change of any page of Confluence. This is actually not the case. Therefore the use of dynamic properties (properties whose value are not fixed after the page has been saved) is limited to some very specific use cases. With other words: typically dynamic values for properties must not be used.

This version provides tools to help users to prevent making mistakes by making false assumptions. The handling of dynamic values is now controlled via the administration screen, where a mode can be configured. Per default it is set to allow. It is recommended to use a value of lenient (if users know exactly what to do and still need dynamic property values to implement their use cases) or strict (to prevent to force dynamic values where they do not belong). If the default mode does not work for your use cases, off will deactivate the checks completely.

For more information, please refer to 

Static Document Link
documentDynamic Property Values

Section
hidetrue
titleRefresh

Due to the following issues a refresh is required to update properties of projectdoc documents in the database.

Jira
serversmartics JIRA
columnIdsissuekey,summary,issuetype,priority,description
columnskey,summary,type,priority,description
maximumIssues1000
jqlQueryproject = 'projectdoc Toolbox' && (fixVersion IN ('6.0.0')) && "Break" ='runtime (fix with reindex)' ORDER BY priority DESC, type DESC
serverId79ad43bc-d289-364e-bfc7-46c09847bebd

In case you do not use any of these features, there is no need for a refresh.

Please refer to 
Static Document Link
documentprojectdoc Rebuild Manual
for details on how to refresh projectdoc documents.

serverId79ad43bc-d289-364e-bfc7-46c09847bebd

In case you do not use any of these features, there is no need for a refresh.

Please refer to 

Static Document Link
documentprojectdoc Rebuild Manual
for details on how to refresh projectdoc documents.

Section
hidetrue
titleDownload

Due to some issues on the Atlassian Marketplace regarding the extensions and doctype add-ons, we make them available here for download until these issues are resolved.

There is only one artifact for deployment on Server and Data Center versions of Confluence.

Section
titleExtensions

The following extensions work with the projectdoc Toolbox 6.0. They do not work with prior versions.

  1. smartics-projectdoc-infosys-extension-6.0.0.obr
  2. smartics-projectdoc-webapi-extension-11.0.0.obr
Section
titleDoctype Add-ons

The following doctype add-ons work with the projectdoc Toolbox 6.0. They do not work with prior versions.

  1. smartics-doctype-addon-strategy-5.0.0.jar
  2. smartics-doctype-addon-vmodellxt-6.0.0.jar
  3. smartics-projectdoc-confluence-arc42-12.0.0.obr
  4. smartics-projectdoc-confluence-space-agileplanning-15.0.0.jar
  5. smartics-projectdoc-confluence-space-core-18.0.0.obr
  6. smartics-projectdoc-confluence-space-devdiary-15.0.0.obr
  7. smartics-projectdoc-confluence-space-prjmgmt-8.0.0.jar
  8. smartics-projectdoc-confluence-space-swdev-14.0.0.obr
  9. smartics-projectdoc-confluence-space-teamwork-5.0.0.jar
  10. smartics-doctype-addon-services-6.0.0.jar
Section
titleList of Changes

The following changes are part of version

Display Property
property-nameVersion
of the projectdoc Toolbox for Confluence

Jira
serversmartics JIRA
columnIdsissuekey,summary,issuetype,priority,description
columnskey,summary,type,priority,description
maximumIssues1000
jqlQueryproject = 'projectdoc Toolbox' && (fixVersion in ('6.0.0')) ORDER BY priority DESC, type ASC
serverId79ad43bc-d289-364e-bfc7-46c09847bebd

...

Section
titleResources
Tour
render-as-definition-listtrue
replace-title-with-nametrue