Shows how to render the value of a document property with a display macro. There are actually three variants of this macro that we are discussion in this short article.
Simple Use Case: Display a Property Value
The Display Document Property Macro allows to add a link to a Confluence page and, in case the page is a projectdoc Document, allows to select a property name to render the value for that property.
Render a Property Value
Suppose there is a document for an organization named Green Documentation Organization.
To render the organization's website, use the Display Document Property Macro like this:
The property value is rendered as a link since the value is actually a link pointing to https://greendocs4u.eu/.
Do not click the Add Link checkbox!
The macro will even not allow to override the link address so that the link https://greendocs4u.eu/ does point to https://greendocs4u.eu/.
Render a Property Value with Link
This macro parameter Add Link is useful if there should be a link to the document. For instance if you add a Short Name property to the organization.
In this case do add a link! Note that there is also the short description rendered as a tooltip.
Display Property Value from a referenced Document
The use case for the Display Document Property Ref Macro is a little more complex. It allows you to specify a document where a property references another document which provides a property you want to render. Seems complicated? Well, let's look at an example!
Rendering a Property from a referenced Document
Suppose you add a person document for Gabriella Green. The idea is that every person working for an organization should have the organization's website as default.
So this is the new version of the organization document:
And this is the document for Gabriella Green:
While the email address is for Gabriella personally, the website of the organization is rendered for her website.
Here is the Display Document Property Ref Macro in the macro editor:
Because Documents is empty the macro points to the Organization property in the same document. Following the link to the organization, the macro picks the value of the organization's Website property.
In case the website for the organization changes, the change will be applied automatically to the Website property of Gabriella's document.
Issue with the Documents Parameter
Due to an issue with the Documents parameter, there is no autocomplete. See PDAC-1543 - Getting issue details... STATUS for details
Concatenate Property Values from two different Documents
The use case for the Display Document Property Ref Concat Macro is only one small step further. It allows to fetch two property values from two different documents and render them together. Is there actually a use case for this macro? Here is the example:
Rendering two Property Values from two Documents
For this use case we add a telephone number to get in touch with the Green Documentation Organization.
The Phone Stem property provides the base phone number where employees add their extension number. For Gabriella this looks like this:
The configuration of the Display Document Property Ref Concat Macro in the macro editor looks like this:
The rendered document of Gabriella:
Both properties, Phone and Website, use the Organization reference to fetch information Phone Stem and the Website from the organization.
