Reports in DataPortal¶
The reports module lets you generate, view, and manage reports based on data collected in DataPortal projects. Reports let you analyze variable values over selected time periods, with various aggregation methods and data presentation types.
Accessing the reports module¶
The reports module is available from the main side menu, by clicking the Reports item. Once you go to the module, two main areas are displayed:
- Project tree (left panel) – a hierarchical list of folders and projects the user has access to. Reports are assigned to specific projects and become visible once the corresponding tree node is selected. Selecting a higher-level node (e.g. "All") displays reports from all available projects.
- Report list (main panel) – a table with reports belonging to the selected project or folder.
Tip
Each report is assigned to a single project, but it can present data coming from multiple projects at once.
Report list¶
The report list is displayed in table form. By default, the following columns are visible:
| Column | Description |
|---|---|
| Report name | The name given to the report when it was created. |
| Description | An optional description of the report, e.g. indicating its purpose or data source. |
| Report type | Specifies how the data is presented (e.g. Variables in columns, Variables in rows, Raw data, etc.). |
The user can extend the view with additional columns by clicking the column menu icon (⋮) in the right corner of the table header. Available optional columns include, among others:
| Column | Description |
|---|---|
| Report kind | indicates whether the report is generated on demand or periodically. |
| Project | the name of the project the report is assigned to. |
| Author | the user who created the report. |
| Publication date | the date the report was last generated. |
Reports can be sorted by their column name by clicking the header with that name. An arrow next to the column name indicates the current sort direction.
Previewing a report from the list¶
At the beginning of each row on the list, a report icon is visible. Hovering the cursor over the highlighted icon generates a report preview and displays it in a popup window.
The following options are available in the preview window:
- Full screen – a button on the window's top bar expands the report to a full view.
- Download – the report can be downloaded in PDF or XLS format.
- RANGE – this button opens a popup where you can temporarily change the report's period (from daily to any date range, in the same way as when creating a report) and its sub-periods.
The report is generated using the parameters saved in its configuration. Changes made via the RANGE button are temporary – they are used only to generate a one-off, ad-hoc report and are not saved to the report's settings.
A periodic report can be previewed and downloaded in the same way – the preview is generated on demand, independently of the automatic generation schedule.
Report details¶
Clicking any row in the report list opens the Report details window. The window is divided into three tabs: INFO, VARIABLES, and OPTIONS.
INFO tab¶
The INFO tab presents the report's basic configuration parameters, divided into several sections.
Basic information¶
- Date created – the date and time the report was first saved.
- Author – the user who created the report.
- Project – the project the report is assigned to.
- Report type – how the data is presented (e.g. Variables in columns, periods in rows).
- Aggregation functions – the method used to calculate values (e.g. List of values, Average, Sum, etc.).
Report period¶
- Report kind – On demand: a manually generated report; Periodic: a report generated automatically according to a schedule.
- Report period – the time range covered by the report (e.g. Previous week, Previous month).
- Sub-periods – dividing the report period into smaller intervals (e.g. No division, Daily, Weekly).
- Run every – the generation frequency (e.g. Week – weekly). Applies to periodic reports.
- Generation day – the day of the week or month on which the report is automatically created.
- Generation time – the time of day at which the report is automatically generated.
VARIABLES tab¶
The VARIABLES tab displays a list of variables (tags) selected for the report. For each variable, information identifying its source (project, device) and the tag name is shown. The set of variables determines what data will be included in the generated report.
OPTIONS tab¶
The OPTIONS tab contains additional parameters affecting how the report is generated and formatted:
- Language – the language in which the report is generated (labels, headers).
- Default 24h day length – if enabled, the system assumes a standard 24-hour day (sometimes different lengths of the so-called billing day are used).
- Start of day – the hour from which each day in the report is counted (default 0:00).
- Adjust to time zone – if enabled, the data is adjusted to the user's time zone.
- Device labels – how data sources are described in the report.
- Variable labels – how tags are described in the report.
- Logos – selection of the logo displayed in the header of the generated report.
Actions available in the details window¶
The following buttons are available at the bottom of the report details window:
- DELETE – permanently removes the report from the system (requires confirmation).
- DUPLICATE - creates a copy of the selected report with the same parameters.
- EDIT – opens the report edit form, allowing you to change its configuration.
- PREVIEW – generates and displays a preview of the report with the currently configured parameters.
- ▼ (drop-down menu) – an extended list of actions, allowing you to, among other things, download the report in a selected format (e.g. XLSX, PDF).
- CLOSE – closes the details window without making changes.
Bulk actions¶
The report list supports selecting multiple items at once (using the checkboxes on the left side of each row). Once at least one report is selected, the ACTIONS button becomes active at the top of the list, offering bulk duplication and deletion of the selected reports.