Property Supplier for Documents, Search Function, and many more new features, improvements, and bug fixes.
Today we released version 3.2 of the projectdoc Toolbox on the Atlassian Marketplace!
This release provides new features, improvements, and bugfixes.
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.
- New and Noteworthy
- Upgrade Instructions
- List of Changes
- Related Releases
- Core Doctypes
- Doctypes for Agile Planning
- projectdoc Developer Diaries
- Doctypes for Project Management
- Doctypes for Risk Management
- Doctypes for Service Management
- Doctypes for Business Strategy
- Doctypes for Software Development
- Doctypes for Teamwork
- Doctypes for V-Modell XT
- projectdoc arc42 Template
- Web API Extension
New and Noteworthy
Property Supplier for Documents
Authors can define properties for projectdoc document with the Document Properties Marker Macro, the Document Properties Supplier Macro, and the Document Properties Supplier Attachment Macro. No properties can also be supplied by other projectdoc documents by the use of the new Document Properties Supplier From Documents Macro.
The properties are ready for import once they have the supply control set.
For more information see Supply Documents.
Search Function Support
Where clauses of macros provided by the projectdoc Toolbox may take advantage of search functions such as now() to specify queries.
The syntax for using search functions is:
$<PROPERTY NAME>=${function-name(argument-list)}
Functions can be used for a value in a Where clause parameter of a projectdoc macro.
Functions cannot be used for a property name or outside the Where clause.
Here are some usage examples:
$<Start Date§>=${now()}
$<Login Name>=${currentUser()}
$<Attendee>=${currentUser("fn")}
The following functions are supported:
currentUser()
now()
startOfDay()
endOfDay()
startOfWeek()
endOfWeek()
startOfMonth()
endOfMonth()
startOfYear()
endOfYear()
Upgrade Instructions
Install the new OBR of the projectdoc Toolbox.
Update doctype and extensions listed under Related Releases.
List of Changes
The following changes are part of the latest projectdoc Toolbox for Confluence.
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDAC-1065 | Support script Tags as non-empty |
|
|
Done | Fixed |
Add-ons may render div elements with JavaScript within script tags that are considered empty by the projectdoc Toolbox. If there is a script tag, even with no content inside, the content should be considered non-empty. |
PDAC-1064 | Support Remote Control by List Macros |
|
|
Done | Fixed |
We need to support Remote Control for the Display List Macro and the Display List Template Macro. |
PDAC-1059 | Search Function Support |
|
|
Done | Fixed |
Support search functions like now() or startOfWeek() for query macros. |
PDAC-971 | Property Supplier for Documents |
|
|
Done | Fixed |
We need a way to easily add additional properties to a document from another document. |
PDAC-1082 | Count Function for Display Table Select |
|
![]() |
Done | Fixed |
If the '#' character is appended to the name of a property in the Select Clause of a Display Table Macro, then the contents of the cell is applied to the Count Function. The count function counts the number of table rows, number of list items, or number of definition terms (whichever of these three is encountered first). Otherwise the count function returns zero. |
PDAC-1081 | Count Macro |
|
![]() |
Done | Fixed |
The Count macro renders the count of table rows, list items, or definition terms instead of the table or list in its body. |
PDAC-1080 | Provide REST Service to fetch single Doctype Info |
|
![]() |
Done | Fixed |
In order to make it easier for users to fetch information on a single doctype by its doctype identifer, we need a new REST service on /doctypes/{doctype}. |
PDAC-1086 | Child Documents Macro |
|
|
Done | Fixed |
Provide a macro that renders references to child documents that match certain criteria. Requires only to work on projectdoc documents and needs to render without Lucene search so that the macro can be used as a property value. |
PDAC-1084 | Access Doctypes in ids-only mode |
|
![]() |
Done | Fixed |
The REST service providing access to doctype information should make it easy to retrieve just the list of doctype IDs. |
PDAC-1067 | Support Empty Content-by-Label Macro as empty |
|
![]() |
Done | Fixed |
In case a Content-by-Label macro is part of a marker macro or a section macro and no further text is available, then consider the body of this macro to be empty. |
PDAC-1061 | Generate Artificial Properties for Date Properties |
|
![]() |
Done | Fixed |
For a referencing property to a date, the artificial properties must also be generated. |
PDAC-1085 | Stricter Doctype Test |
|
|
Done | Fixed | |
PDAC-1079 | REST API Document without Null Values |
|
|
Done | Fixed |
When returning domain objects with JSON, properties with null values should be omitted. 'null' is not a natural value for an API. Therefore a property that is not set should be not returned at all. |
PDAC-1077 | Remove of Deprecated WebResourceManager |
|
|
Done | Fixed |
WebResourceManager is deprecated replace with: pageBuilderService.assembler().resources() |
PDAC-1074 | Add Context Control To Text Transclusion, List, and Template List Macro |
|
|
Done | Fixed |
The context control parameter should also be available for the Text Transclusion Macro (which has already been in the documentation by error). Also add the parameter to the Display List Macro and the Display Template List Macro. |
PDAC-1073 | Remote and Context Control by Identifier Class |
|
|
Done | Fixed |
Allow to group macros by an identifier class and address them as a group with Context Control and Remote Control. |
PDAC-1062 | Backend Service: Allow Display Property Macros Multiple References |
|
|
Done | Fixed |
Allow Display Document Property Macros to have more than one document referenced. Note: The UI still restricts the selection to one document. A new control to select multiple documents will follow. |
PDAC-1060 | Decrease Deployment Time of OBR |
|
|
Done | Fixed |
By referencing all required services we prevent the scanner to figure that out and reduce the deployment time of the OBR. |
PDAC-1078 | Label for Name List Macro |
|
![]() |
Done | Fixed |
If the Name List Macro is used in a section body to reference a document, e.g. a glossary item, then the label being rendered may be different from the name or any other property of the document. In these use cases, where there is only one name, the label will be rendered instead of the property. This is similar to Confluence links, where per default the title of the referenced document is renders, but the label of the link may be an arbitrary sting. |
PDAC-1075 | Reference Update fails for Artificial Reference Properties |
|
![]() |
Done | Fixed |
Fails to construct DocumentPropertyRefs in every use case. |
PDAC-1072 | Term Search with terms shorter than two Characters |
|
![]() |
Done | Fixed |
For name queries we need to support terms with zero or only one character. Currently those queries have no hits. |
PDAC-1071 | Fragments Cache fails to find Document |
|
![]() |
Done | Fixed |
The fragment cache listener logs as error onPageCreated Cannot replace refs since document for page with id {pagid} cannot be found. This is because the events may be processed in wrong order. The listener interface must be removed and the services need to be called from the persistence listener. |
PDAC-1069 | Partition Short Description |
|
![]() |
Done | Fixed |
Allow to render short descriptions in the context of space partition generation. Currently the space description is used despite only a partition is generated. |
PDAC-1068 | Fix Removing empty Elements |
|
![]() |
Done | Fixed |
Removing empty elements is broken in case expand macro or content by label macro is involved. JSoup API is used wrongly. |
PDAC-1066 | Duplicate Recursion Detection for is-single-value |
|
![]() |
Done | Fixed |
In case a property is controlled by is-single-value the recursion detection is run twice hitting a false positive. |
PDAC-1083 | Description for Display Property As Image Macro is missing |
|
|
Done | Fixed | |
PDAC-1076 | Wrong Starting Color for Display Table Macro |
|
|
Done | Fixed |
Starting Color for Display Table Makro With projectdoc-counter-column CSS is grey instead of white. |
PDAC-1070 | No Antitokenizing for empty Value |
|
|
Done | Fixed |
The Toolbox logs an Error if it encounters an empty value and checks it if it is already antirokenized. The message in the logs is: [atlassian.confluence.query.WhereConstraint] addExactMatchPropertyValue needs to be anti-tokenized. The value should not be considered to be used for the query and secondly not be antitokenized. |
PDAC-1063 | Tour by Property Fails on Short Description |
|
|
Done | Fixed |
In case the Short Description contains a comma (','), the parser of the Tour-by-Property Macro fails to parse the references. This is due a wrong resolution of the property value and the parsing of the extracted list of links. |
Related Releases
Core Doctypes
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDCORED-216 | Supports Section for Organizations |
|
![]() |
Done | Fixed |
Organizations may be used as stakeholders directly. Therefore participants also refer to documents of type 'organization'. In addition to list documents where an organization is a participant, there should also be a section where an organization is a sponsor. |
PDCORED-215 | More Information for Stakeholder Management |
|
![]() |
Done | Fixed |
Add more information for stakeholder management, including relations to other stakeholders, risks, open issues, and more. |
PDCORED-224 | Make Stakeholder more compact |
|
|
Done | Fixed |
Resolve Anlysis sections to top-level and remove the Analysis section. Add section for involvement that contains the text previously stored in Analysis. Hide information imported from the person document. Move the analysis ratings below the stakeholder picture. |
PDCORED-217 | Reorder Stakeholder Sections for Management |
|
![]() |
Done | Fixed |
Arrange the fields in a way that the sections where text is added are moved to the front. Then show the information that is relevant for stakeholder management, then information about participations. |
PDCORED-226 | List Iteration instead of Doctype for Events on Tags and Categories |
|
|
Done | Fixed |
Instead of listing the doctype, which would be event or todo in the standard configuration, list the iteration. This shows which event has been closed, which is more valuable information than the doctype. |
PDCORED-223 | Add Department to Stakeholder |
|
|
Done | Fixed |
Display the Department property from the referenced stakeholder. |
PDCORED-218 | Add Job Title to Stakeholder |
|
|
Done | Fixed |
Show the job title from the person template also on the stakeholder template. |
PDCORED-225 | Filter Events from Category Documents |
|
![]() |
Done | Fixed |
On a category document the events are also listed under documents, but should not. |
PDCORED-221 | Partition Short Description |
|
![]() |
Done | Fixed | |
PDCORED-220 | Doctype Reference to Role on Stakeholder |
|
![]() |
Done | Fixed |
Add a reference to the role doctype so that roles can be found for the role property on the stakeholder template. |
PDCORED-219 | Meeting heading in Stakeholder |
|
![]() |
Done | Fixed |
The heading with meetings should read 'Meetings". Change DE Partizipation" in "Beteiligter". |
PDCORED-227 | Typo in Section Heading of Relation (DE) |
|
|
Done | Fixed |
The label shows "Begriff" where it should read "Begriffe". |
Doctypes for Agile Planning
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDAGILE-72 | Fix App Name |
|
|
Done | Fixed |
"projectdoc Models for Agile Planning" should be renamed to "projectdoc for Agile Planning". This makes the name in line with the outer apps. |
PDAGILE-73 | Partition Short Description |
|
![]() |
Done | Fixed |
projectdoc Developer Diaries
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
DEVDIARY-105 | Add Date Property to Event |
|
![]() |
Done | Fixed |
To make it easier to check a date of an event (which is typically stored in the parent document of type day), there should be a reference in the event document. Please note that this is related to |
DEVDIARY-106 | Partition Short Description |
|
![]() |
Done | Fixed | |
DEVDIARY-108 | Month Template missing Author |
|
|
Done | Fixed |
The Month Template does not populate the Author Property. This way it does not list the events that took place in the given month. |
Doctypes for Project Management
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDPRJMGMT-50 | Fix projectdoc.doctype.open-issue.reference.placeholder |
|
|
Done | Fixed |
Provide placeholder text for key projectdoc.doctype.open-issue.reference.placeholder as part of the open issue template. |
PDPRJMGMT-56 | Add reference to last Report |
|
![]() |
Done | Fixed |
In case of recurring reports we need a property to link to the last report. This makes it easier to compare planned actions of the last report to actions documented in the current report. |
PDPRJMGMT-55 | Add Handling to Open Issue |
|
![]() |
Done | Fixed |
Provide a section to add information on how this issue is handled, to add information found, to provide information at which point this issue is probably solved. |
PDPRJMGMT-54 | Replace the Term 'Kümmerer' |
|
![]() |
Done | Fixed |
Replace the term 'Kümmerer' with the more appropriate term 'Beteiligte' for the German locale. This takes effect on the doctype open issue. |
PDPRJMGMT-52 | Add Identifier to Open Issue |
|
![]() |
Done | Fixed |
The identifier allows to communicate about the open issue per ID. |
PDPRJMGMT-51 | Add Assignee to Open Issue |
|
![]() |
Done | Fixed |
To keep track on open issues make them assignable to a stakeholder. |
PDPRJMGMT-53 | Remove Stakeholder Name List from Driver |
|
|
Done | Fixed |
Since drivers are not necessarily stakeholders, we should keep the value for the "Drivers" property free format. |
PDPRJMGMT-57 | Partition Short Description |
|
![]() |
Done | Fixed |
Doctypes for Risk Management
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDRISKMGMT-3 | Add Status for Risk and Risk Action |
|
![]() |
Done | Fixed |
To better organize and track risks and risk actions we need an additional status property for both doctypes. |
PDRISKMGMT-4 | Replace the Term 'Kümmerer' |
|
![]() |
Done | Fixed |
Replace the term 'Kümmerer' with the more appropriate term 'Beteiligte' for the German locale. This takes effect on the doctypes opportunity, problem, and risk. |
PDRISKMGMT-5 | Partition Short Description |
|
![]() |
Done | Fixed |
Doctypes for Service Management
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
SERVICES-4 | Partition Short Description |
|
![]() |
Done | Fixed |
Doctypes for Business Strategy
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
STRATEGY-4 | Fix App Name |
|
|
Done | Fixed |
"Business Strategy" should be renamed to "projectdoc for Business Strategy". This makes the name in line with the outer apps. |
STRATEGY-5 | Partition Short Description |
|
![]() |
Done | Fixed |
Doctypes for Software Development
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDSWDEVD-120 | Add Sponsors to Doctypes |
|
![]() |
Done | Fixed |
To allow to associate an aspect of software development with stakeholders, organizations, or persons taking interest. Add or update the Sponsor Property for the following doctypes:
|
PDSWDEVD-125 | Whitebox Reference in Blackbox Document |
|
![]() |
Done | Fixed |
Move the button to create a whitebox document inside a section and set this section below the diagram of the blackbox. Also list the link to the whitebox in a table (although there is typically only one link) with its short description. |
PDSWDEVD-122 | Fix App Name |
|
|
Done | Fixed | |
PDSWDEVD-126 | Show Blackbox Create Buttons |
|
![]() |
Done | Fixed |
The Whitebox and Blackbox doctypes do not provide their own homepage since they are always added as subdocuments. Therefore these doctypes are not promoted. Users may choose these doctypes from the wizard, but need to click the "Show more" button to have access to the doctype's blueprint wizard. Having these doctype not promoted is correct, but the templates with the Create Buttons for Whitebox and Blackbox documents should be shown by default. |
PDSWDEVD-123 | Partition Short Description |
|
![]() |
Done | Fixed | |
PDSWDEVD-121 | Fix DE Label for Quality Scenario |
|
![]() |
Done | Fixed |
The German translation for quality scenario is Projektrahmenbedingung but should be Qualitätsszenario. |
Doctypes for Teamwork
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDTEAMWORK-11 | Doctype of Space should be governance-space |
|
|
Done | Fixed |
Currently the doctype is "glossary-space", but it should read "governance-space". |
PDTEAMWORK-12 | Partition Short Description |
|
![]() |
Done | Fixed |
Doctypes for V-Modell XT
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDVMXT-14 | Add reference to last Report |
|
![]() |
Done | Fixed |
In case of recurring reports we need a property to link to the last report. This makes it easier to compare planned actions of the last report to actions documented in the current report. |
PDVMXT-15 | Partition Short Description |
|
![]() |
Done | Fixed |
projectdoc arc42 Template
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
ARCFOURTWO-64 | Type I18N Keys |
|
|
Done | Fixed |
Web API Extension
Key | Summary | T | P | Status | Resolution | Description |
---|---|---|---|---|---|---|
PDEXWAPI-29 | CONFSERVER-57887 Workaround |
|
|
Done | Fixed |
Due to https://jira.atlassian.com/browse/CONFSERVER-57887 we decided to apply the workaround so that the REST API can be used with the REST API Browser App on Confluence. An ugly side effect is that the documentation is no longer rendered. This will work again, once the Confluence issue is fixed or if there is another workaround. |
PDEXWAPI-30 | Replace CSV Lib |
|
![]() |
Done | Fixed |
To streamline our code we replaced the CSV library commons-csv from Apache. |
Resources
- Release Notes for the projectdoc Toolbox
- Relevant information on changes to the projectdoc Toolbox for Confluence introduces by new versions of this app.
- Glossary
- Terms used in and defined for projectdoc.
- FAQs
- Questions and answers related to the projectdoc Toolbox and Confluence.