Skip to content

Overview

This section of documentation describes the new idea on how to define, configure and build the reports. From the lack of the better name it will be referred to as Report V3

Definitions

Report

Combines data source that provides report data, report output that knows how to create output files and sections that defines how to create a part of document.

Report Section

Defines a logic that produces a part of report called section. Each section should represent a standalone part of the report document. Ideally it should be reusable.

Report Variant

Variant of a report that relies on the same collection of sections and data source but might differ in the section order and configuration. e.g. Expert vs Instant.

Report Variant Definition

Pydantic model that describes a report variant.

Report Settings

Report wide collection of settings. e.g. Path to default Report Variant Definition file

Section Settings

Section wide settings. E.g. Main Title for Title Section, List of KPI IDs for KPI Trends Section.

Architecture of the solution

  • Reports are built of sections
  • Section adds content to the report output using data source objects (e.g. Asset)
  • Sections have configuration with defaults
  • Full report variant definition can be provided as input on report object initialization

Report V3 structure