You are reading the documentation for an outdated Corteza release. 2022.9 is the latest stable Corteza release.

Reporting

Corteza Reporter allows you to create beautiful reports using the data stored in your Low Code applications. This section focuses on the most important aspects of the system. If you wish to learn more about a specific topic, refer to the subsections under Low-Code Platform Developer Guide  Reporting.

Creating a New Report

To create a report, navigate to your Corteza instance (for example http://latest.cortezaproject.org/) and click ok tne "Reporter" application.

app selector

A new screen showing you all of the available reports will appear.

From there you can:
  • create new reports by clicking on the New Report button,

  • edit existing reports by clicking on the edit button,

  • open the report builder by clicking on the Report builder button,

  • manage global permissions by clicking on the Permissions button,

  • manage report-specific permissions by clicking on the "Lock" icon next to the report.

report list

When you click on the New report button, a new screen appears asking you to provide the base report parameters.

  • Name provides a user-friendly identifier for the report; for example "Test Report". A name doesn’t define any particular constraints.

  • Handle defines a unique value that may be used instead of the system identifier for easier referencing.

  • Description defines a verbose description of the report to better explain what the report shows.

  • Tags define a series of short text snippets to describe your report.

Handle constraints:
  1. start with a character,

  2. contain at most 64 characters,

  3. contain only characters, numbers, _ (underscore), - (dash) or . (dot),

  4. end with a character or a number.

report create

Report Builder

The report builder is used to define the reports' structure using report blocks and a drag-and-drop interface. Each report has a grid of 12 columns and is not limited on the vertical axis.

report builder base

Click on the + Add block button to add a new report block which can hold additional data sources and display elements.

report builder block base

To access general report block configuration options (the title, description, and layout direction) click on the "edit" icon in the bottom left corner of the report block.

report builder block config

Display elements can be accessed, added, edited, and removed by navigating to the "elements" tab of the general report block configuration modal.

report builder block el

Display elements can quickly be added by clicking on the "add" icon in the bottom left corner of the report block.

report builder elements

To reposition the report block, simply drag-and-drop it to the desired position.

The report block may be placed anywhere on the X axis, but its Y axis must connect with another report block or with the top of the page. If the position is not valid or it overlays with another report block, the report builder may automatically adjust the surrounding report blocks to conform to the constraints.

report builder repos base report builder repos

To resize the report block, simply grab the arrow in the bottom-right corner and resize to fit your needs. The report block may not exceed the maximum width of 12 columns. The height is not limited.

report builder resize base report builder resize

To delete a report block, click on the "trash can" icon in the bottom-left corner of the report block and confirm the action by clicking on the confirmation button.

report builder delete

Data Sources

DevNote reference to more examples.

A data source defines what resource is being accessed, how the data is pre-processed and presented to the reporter. Most data sources may be used as the input to another data source.

A data source must define a name that is unique amongst other data sources defined by the current report and any of it’s blocks.

We can define data sources on two levels: on the entire report and on a specific report block.

When defining data sources on the entire report, any of the blocks and its items should be able to access the data provided by the data source. Such a data source should be used when we wish to define some pre-computed data which we will be using through the entire report. Report-level data sources can be accessed by clicking on the Data sources button in the top right corner of the report builder.

When defining data sources on specific report blocks, only the items inside the given report block are able to access the data provided by the data source. Such a data source should be used when you wish to additionally transform some pre-computed dat provided by report-level data sources. Block-level data sources can be accessed by clicking on the "edit" icon of a certain block and navigating to the "data sources" section.

Load

The load data source allows you to access resources directly from Corteza such as your CRM leads. Resources can be pre-filtered and presorted, which allows you to show data based on a specific characteristic such as a time span.

The source defines which Corteza resource provides data; for example "compose records".

load
Figure 1. The example shows a load data source configuration.
Table 1. Compose record source configuration options:

Namespace

The namespace defines what Low Code namespace is accessed; for example "CRM" or "Case Management".

Module

The module defines what module is accessed; for example "lead" or "contact".

Pre-filter

The pre-filter defines what filtering should be applied to the accessed data before the data source returns the data. Pre-filtering allows you to show data based on the specified characteristic, such as the current quarter or leads with a specific status.

Refer to prefiltering for more details.

Pre-sort order

The pre-sort defines how the resulting data should be sorted before the data source returns it. This allows you to define some initial order, such as newer leads first, or the oldest clients first.

Refer to presorting for more details.

Group

The group data source allows you to aggregate and transform data provided by another data source, such as computing the total cost of lead acquisitions or counting the number of jobs that a client requested.

The source defines what data source is to be aggregated and it must be one of the predefined data sources such as a load or another group.

The example shows a group data source configuration.

group

Table 2. Group data source configuration options:

Group by

The group by section defines the columns that denote groups. To exemplify; defining an expression of AccountSource for the accounts CRM module groups the records based on the account source.

The group column must define a name and an optional label and can be referenced by further data sources.

Refer to the expression reference for more details.

A group must define at least 1 group column.

Aggregate

The aggregate section allows you to define how the computed columns are be evaluated. To exemplify; defining an expression of count() returns the number of rows for each group.

The aggregated column must define a name and an optional label and can be referenced by further data sources.

Refer to the expression reference for more details.

DevNote reference to more examples.

Join

The join data source allows you to join two data sources based on a common value, such as a reference using Record module fields or a common status column.

The current versions do not allow you to use the join data source as an input to other data sources.

Any row from the primary source which does not have a related secondary source is omitted from the result. Anti-joins are not supported.

The example shows a join data source configuration.

join

Table 3. Join data source configuration options:

Primary source

The primary source defines the base data source involved with the joining, such as the account of the account-contact relationship.

Primary column

The primary column defines what column from the primary source should be used when determining whether the two rows are connected.

Secondary source

The secondary source defines the data source which we are want to join to the primary source, such as the contact of the account-contact relationship.

secondary column

The secondary column defines what column from the secondary source should be used when determining whether the two rows are connected.

Display Elements

Display elements allow you to access and display the data provided by a data source. Display elements can only exist inside a block. A single block may define multiple display elements.

You can use a table and a chart side-by-side to show what data was used to generate the visualization.

Most display elements may define additional pre-filtering and pre-sorting.

Text

The text display element allows you to provide arbitrary content which can be used along side other display elements, providing additional context to the data.

The display element supports rich text using a WYSIWYG editor.

The example shows a configured text display element.

text configuration

The example shows a text display element describing the chart display element.

text usage 1

Metric

The metric display element allows you to display a calculated numerical value from the provided data source.

The calculated value is usually an indicator important to your process, such as the total finances in your sales pipeline, or the current number of open accounts.

The example shows a configured metric display element.

metric configuration

Table 4. Metric display element configuration options:

Label

The label column defines what column from the data source is used when displaying the metric. The column must be a numerical value.

Format

Defines the formatting string that is used when displaying the metric. The field supports all of the numeral.js formatting options.

The format is applied before the prefix and suffix.

Prefix

Defines the prefix that is pre-pended to the resulting metric before it is shown in the page block. For example, the prefix of $ and the value of 1000 would result in the label of $1000.

Suffix

Defines the suffix that is appended to the resulting metric before it is shown in the page block. For example, the suffix of USD/h and the value of 1000 would result in the label of 1000USD/h.

Text color

Defines the text color of the displayed label.

Background color

Defines the background color of the displayed label.

Table

The table display element allows you to display the data source inside a table.

If you are working with a joined data source, you have to pick the columns for each joined data source.

The example shows a configured table display element.

table configuration

Table 5. Table display element configuration options:

Columns

Defines what columns from the data source should be used and also defines their order.

Table variant

Defines the variant of the table to use.

The available variants:
  • None

  • Secondary

  • Info

  • Danger

  • Warning

  • Success

  • Light

  • Dark

Head variant

Defines the head variant to use.

The available variants:
  • None

  • Light

  • Dark

Table options

The section allows you to fine-tune how the table should look like; such as using a dark or light theme, removing borders, and being responsive.

Chart

The chart display element allows you to visualize the data source using a chart.

If you are working with a joined data source, you have to pick the columns for each joined data source.

Currently supported chart types:
  • Bar

  • Line

  • Pie

  • Doughnut

  • Funnel

Funnel charts are only supported when showing the group data source.

The example shows a configured chart display element.

chart configuration

Table 6. Chart display element configuration options:

Type

Defines what chart from the supported list of charts should be used.

Color scheme

The color scheme defines what colors your chart should use when visualizing the data.

Keep in mind that each color scheme defines a limited number of colors so your choice needs to be based on the data you’re trying to show.

Bar and line charts use a different colour for each column, while the other charts use a different color for each value.

Label column

The label column defines what values from the data source are used as the label for each data point of the chart (the legend)..

Only text columns may be selected as a label column.

Data column

The data columns define what values from the data source is used as the data points of the chart.

Only numeric columns may be selected as a data column.