Document toolboxDocument toolbox

Working with Parameters

Parameters are the most important concept to customize reports for specific client groups, products or even indidual client / portfolio. Cinnamon can flexibly handle the configuration of existing parameters or add new parameters when needed.

Hierarchical definitions of parameter values

Parameters can be defined or re-defined on several levels to customise reports:

Order: for client- or portfolio-specific customizations, parameters can be entered on an individual order level.

Profile: set of default parameters for a client group or product(-group) can be stored in a profile to be reused over many portfolios and orders. Profile parameters have a lower priority than order parameters.

Report Type: many parameters have to be mapped from an order/profile level to the individual building blocks parameters. This happens within the definition nodes of a report type (see also https://bmpi.atlassian.net/wiki/spaces/CRDOC/pages/2918809601).

Example: To show the asset allocation of a previous month end, the report type would redefine the parameter reportingDate to a calculated date for this building block.

Building Block:

  • building blocks offer many parameters to customize the individual table’s or chart’s content and visualisation. Many parameters have default values that can be found in the building block’s documentation report.

  • Some building blocks also extend the context to include new (calculated) parameters that can then be used by their children

 

Setting parameter values

 

Json Examples

 

Json Examples

Setting a parameter to a fixed value

Depending on the parameters type, a specific value can be set

Boolean

"hideBenchmark": true

Date

"reportingDate": "2022-03-31"

Array of Segmentations

"mySegmentations": [ "segmentation1", "segmentation2" ]

etc.

Setting a (building block-) parameter to the value of another (order-) parameter

or

 

Using javascript expressions to calculate a parameter value

See the https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Expressions_and_Operators for a reference about the capabilities

Working with dates

Next to some solution specific presets that are available in a typical reporting solution (e.g. masterData.performanceMeasurementStartDate) we can calculate new dates when setting parameter values.

Available functions:

Creating translatable texts

A translatable text is a special object, that is used wherever a translation (or value formatting) has to be applied.

All variants

 

Example: