projectdoc Toolbox

Space shortcuts

Page tree

Versions Compared

Old Version 6

changes.mady.by.user Robert Reiner

Saved on

compared with

New Version 7

changes.mady.by.user Robert Reiner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. ,
  2. the Input Mapping, and
  3. the Output Mapping.

The elements of the specification are provided in any order within the cells of a table.

Section
titleMacro Body

The body contains the set of formula specifications to calculate values. Each specification of a formula contain a

  1. Name,
  2. the Aggregate Formula,
  3. the Format,
and
  2. the Line Formula
.
Code Block
NameFormatLine FormulaAggregate FormulaInput MappingOutput Mapping


















..................
Name Aggregate_Formula #Format: Line_Formula


Section
titleName

Identifies the formula and the calculated result.


Section
titleAggregate 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.

PlaceholderDescription
 ${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
titleExamples for Aggregate Formula


Code Block
languagetext
titleUse the sum
${SUM}


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




Section
titleFormat

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
titleLine 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.

Example Box
titleExamples for Line Formula


Code Block
languagetext
titleCalculating story points
${Story Points} * ${Story Weight}


Code Block
languagetext
titleAdd up the team sizes
${Team Size}




Section
titleInput Mapping


Pending Box
titleNot yet implemented

A table to map an input to be applied to a value read from the documents.

This allows to translate text to double values.



Section
titleOutput Mapping

A table to map a double result value to a textual value, such as the Status Macro.



Section
titleDetails


Section
titleRelated Macros
Display Table
doctypeapp-macro
render-no-hits-as-blanktrue
render-modedefinition
selectName, Short Description
render-classesrelated-macros-table, display-table, related-macros
where$<Tags>~(${Tags})

...

About

This site is maintained by smartics.

Imprint / Impressum

Data Privacy / Datenschutz 

End User License Agreement (EULA)


To get in touch please send us an e-mail!

smartics email

Keep up-to-date!

Read our

smartics Blog

Follow us on

Twitter YouTube Prezi

Find us on

Bitbucket GitHub Atlassian Marketplace

Powered by




© 2001-2023 smartics - Kronseder & Reiner GmbH