Versions Compared

Old Version 3

changes.mady.by.user Marcus Brändle

Saved on

compared with

New Version Current

changes.mady.by.user Marcus Brändle

Saved on

Key

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

Definition

...

Definition nodes are the elements to define a Report Type. A definition node has the following attributes;

Attribute

Description

Example

id

  • The id of the definition node within it’s report type

  • It is advised to use unique and meaningful id’s (e.g. for easier association of production issues)

ov_PO003_ytd

buildingBlock

  • The type of the building block to be produced

  • Read-only property set when adding the node

PO003

children

A list (array) of children (definition nodes)

parameters

The set of parameters values to be applied when evaluating the building block.

slot

The slot to be produced into

  • the parent node should produce a LayoutBB that selects a layout via the style parameter

  • Word: the slots are defined within the word layout component and referenced by name

  • Online: the number of slots of a style are built-in and the slots are referenced by order

Code Block
languagejson
"slot": "{left}"

enabled

  • A boolean (true/false) or expression that defines if a definition node is evaluated when processing the report

Code Block
languagejson
"enabled": "=params.ShowChapterXY"

iterateOver,
iterateInto

  • iterateOver: the array of values for which this node (and all it’s children) should be produced. No iteration if undefined.

  • iterateInto: the name of the parameter that will be set to the current iteration value.

Code Block
languagejson
"buildingBlock": "SectionBB",
"iterateOver": [ "de", "en", "fr" ],
"iterateInto": "reportLanguage",
"parameters": {
    "mainTitle": {
        "text": "This is produced for reportLanguage {1}",
        "args": [ "=params.reportLanguage" ]
    }
}

Built-in Building Blocks

BuildingBlock

Description

Parameters

Example

*

Common parameters for all building blocks

  • mainTitle

  • subTitle

  • style: sets the style used to visualise (has a dependency on node types and channels)

  • tags: an array of tags. Current tags used by the online channel are

    • SolidChrome, DarkChrome, LightChrome to set the chrome (background)

    • Screen: to define an entity of nodes to be shown together in fullscreen mode

ParagraphBB

Creates a paragraph.

Note

  • Word reports will not show children of a paragraph node

  • mainTitle, subTitle will not be visualised

  • content

  • theme

  • style: names a paragraph style

SectionBB

  • style: names a paragraph

  • theme

  • styleinsertSectionPageBreak: wheter to insert a section break (new page). Only affecting word reports.

NoOpBB

This building block has no effect on the visual output but just produces it’s children. It can be used to set common parameters for a list of blocks

HeaderBB

Like NoOpBB does not produce any output itself but produces it’s children. Word reports will place the output into the header story (of the current section)

FooterBB

Like NoOpBB does not produce any output itself but produces it’s children. Word reports will place the output into the footer story (of the current section)

LayoutBB

This building block produces it’s children and places them in the specified “slots”. Children are expected to have the attribute slotset.

  • style: see examples

for word reporting select a lacout component defined in the template:

Code Block
languagejson
"style": "CS_C_CoverOverview"

for online reports select one of the predefined styles:

Code Block
languagejson
"style": "CS_W_Block2x1"

MetricsBB

  • Online only, for complex arrangements of data

  • For word reports use a specialised LayoutBB instead

ToggleBB

  • A building block that allows a list of children to be toggled through in online reporting.

  • every child is expected to have a toggleTitle set in parameters. This will control the title for the button used to toggle.

InfoWord reports will just place all children in a flow design, Same as NoOpBB would do.