Calculation Macro

...

Document Properties Marker

doctype	app-macro
override	false

Short Description Run calculations on a set of result documents and renders the results.

Name Calculation Macro hide

Short Name hide

Parent

Parent Property

property-name	Name

hide

Audience

Name List

doctype	role
render-no-hits-as-blank	true
property-restrict-value-range	true
property	Audience
empty-as-none	true

Subject

Name List

doctype	subject
property	Subject

Tags

Tag List


names	Calculation
property	Tags

hide

Flags hide

Iteration

value	production

hide

Identifier projectdoc-calculation-macro

Type

Name List

doctype	app-macro-type
render-no-hits-as-blank	true
property-restrict-value-range	true
property	Type

Suite

Name List

doctype	app, app-extension, product-space
render-no-hits-as-blank	true
property-restrict-value-range	true
defaults-to	ancestor
property	Suite

hide

App Tool

Name List

doctype	app-tool
render-no-hits-as-blank	true
property-restrict-value-range	true
defaults-to	ancestor
property	App Tool

Since 5.2

Deprecated

Removed

Defined Parameters

Name List

doctype	app-parameter
render-no-hits-as-blank	true
render-list-as-comma-separated-values	true
no-create-links	true
property-restrict-value-range	false
property	Defined Parameters

hide

Sort Key hide

Section

show-title	false
title	Description

Provide a query to select a set of documents and use formulas to calculate a couple of values. One of these values is rendered, the rest can be accessed by additional macros.

The advantage is mainly that calculating a couple of values is calculated with a higher performance.

...

Section

title	Parameters
intro-text	The macro is configured by the following parameters.

Section

title	Doctype(s)

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Doctype(s)

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Space Keys

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Where

Section

title	Sort By

Transclusion

taget-heading-level	*
document	Sort By Property
ids	Sort By

Section

title	Identifier

Unique identifier of the rendered content.

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Exclude Self

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Restrict to immediate Children

Section

title	Render individual Results

If checked there is a data attribute added to the rendered element for each line result.

If not checked only the data attributes provided by default are added.

Data Attribute		Description
`data-projectdoc-result-count`	Provided by Default	The size of the result set. Note that the count of formulas may be smaller than this number if documents in that set do not provide all values required for the Line Formula.
`data-projectdoc-result-...-N`	Requires value of true	The infix for this attribute name (...) is derived from the name of the formula that created it. The 1-based index of the document that provided the values for it.
`data-projectdoc-finalresult-...`	Provided by Default	The final result of the formula with a derived name of the formula is used as a suffix.

Section

title	CSS Classes

List of HTML class names to be added to the rendered HTML element.

Section

title	Render

Controls the rendering of the calculated value.

The following values for this parameter are valid.

Parameter Value Description

first The value calculated by the first formula is rendered (default).

none

Nothing is rendered as text, but the element with the data elements still is.

Choose this option if all calculated values are rendered at different locations down the document.

last

The value calculated by the last formula is rendered.

Choose this option if your formula requires the result of prior defined formulas

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	Render no hits as blank

Transclusion

taget-heading-level	*
document	Display Table Macro
ids	No Hits Text

Section Index

select	Name, Short Description, Data Type\|, Since\|
render-counter-column	true

Section Compiler by Reference

ref	Defined Parameters
render-classes	parameters-sections, section-compiler-by-reference, parameters
force-show	true
ids	-Description, Details
extract-short-desc	true

...

Section

title	Macro Body

The body contains the set of formula specifications to calculate values. Each specification of a formula contain a Name, the Aggregate Formula, the Format, and the Line Formula.

Code Block
Name Aggregate_Formula #Format: Line_Formula

Section

title	Name

Identifies the formula and the calculated result.

Section

title	Aggregate Formula

The formula to aggregate the single values extracted by the Line Formula.

The formula may contain placeholders to values of the document that contains the macro.

The formula may use the placeholders ${SUM} and ${COUNT}. Formulas may use values calculated by formulas defined in a line before it.

Placeholder	Description
`${SUM}`	The sum of values calculated by the Line Formula.
`${COUNT}`	The count of documents that provided a value for the Line Formula. For instance if a document does not apply properties for all values of the Line Formula, it does neither contribute to the sum nor to the count.
`${`NAME_OF_FORMULA`}`	Where NAME_OF_FORMULA stands for the name of a formula that has been define above the formula that wants to use it.
`${`NAME_OF_FORMULA`$}`	The sum value calculated by the formula named NAME_OF_FORMULA.
`${`NAME_OF_FORMULA§`}`	The count value calculated by the formula named NAME_OF_FORMULA.

Example Box

Code Block
story-points-avg ${SUM}/${COUNT}: ${Story Points} * ${Story Weight} team-size-days ${SUM}: ${Team Size}

Section

title	Format

The format used to translate the calculated value, both of the Aggregate Formula and the Line Formula.

The value is a valid number format in Java and defaults to decimal.

Valid values are integer, decimal, currency, and anything that can be parsed by DecimalFormat.

Section

title	Line Formula

The formula applied to calculate from each document in the result set.

Use placeholders, like ${Document_Propery_Name} to select values from the documents in the result set.

...

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 5

New Version 6

Key

About

Keep up-to-date!

Powered by