Report settings
Ta treść nie jest jeszcze dostępna w Twoim języku.
A report shows the recorded history of parameters. It saves the parameters it shows, its views, the layout of those views, a default time range, a timezone, the controls shown on the report, and optional CSV export settings. The report editor in Setup → Reports edits these settings; the API field of each one is in the Report API. The page that shows a report is described in Report page.
Access
Section titled “Access”| Role | Setup → Reports |
|---|---|
| View only | No Setup; opens reports by link or from dashboards |
| Operator | No Setup. Can open a Quick report where a dashboard offers one |
| Editor, Admin, Owner | Create, edit, and delete reports. Save on a quick report keeps it as a regular report |
Every workspace member can open reports and read their history.
Editor addresses
Section titled “Editor addresses”The editor opens over the report list at these addresses:
| Address | Purpose |
|---|---|
/workspace/$workspaceId/setup/reports | List reports |
/workspace/$workspaceId/setup/reports/new | Create a report |
/workspace/$workspaceId/setup/reports/$reportId | Edit a report |
Local hmi CLI workspaces use the same addresses. In the list, a report’s title opens the report
itself, and the pencil button (Edit report) opens the editor.
A numeric field with an invalid value, such as Last days below 1, shows an error when you leave the field or save, and the report is not saved until you correct it.
Title and description
Section titled “Title and description”Title and Description are shown in the language of the interface. Editing them in Setup saves plain text in place of the shown value.
Parameters
Section titled “Parameters”Add parameters opens a search over the parameter tree (choosing a parameter). Shift+click expands or collapses a whole branch, a branch checkbox selects every eligible parameter below it, and Select all matches selects every eligible parameter a search finds. Each added parameter is copied into the report with its current name, units, icon, and type:
| Parameter type | Report type |
|---|---|
Numeric (num) | Numeric |
Integer or boolean (int, bool) | Integer |
| String, IP or MAC address, big integer, date-time, geo | String |
Parameters of other types cannot be added. New parameters get colors from a fixed sequence of 16 high-contrast colors, starting with colors not already used in the report.
The report keeps this copy: later changes to the parameter in Setup → Parameters do not change the report, and the report reads only the parameter’s history. Each report parameter has these settings:
| Setting | Applies to | Values |
|---|---|---|
| Label | All | Text |
| Units | All | Text |
| Icon | All | Icon or none |
| Default color | All | One of the report colors |
| Bold | All | On or off |
| Italic | All | On or off |
| Zone colors | Numeric | A color for each Min–Max range |
| Value colors | Integer | A color for each Integer value |
Removing a parameter that a view uses asks for confirmation, then removes it from every view: chart series, table columns, time bars, histograms, and state duration lists drop it; calendar and hourly-matrix slots that used it become empty, matrix day headers that used it are removed, and Sankey links that used it are removed. The views, Sankey nodes, and empty views stay.
Deleted workspace parameters
Section titled “Deleted workspace parameters”Deleting a parameter in Setup → Parameters also removes it from every report that includes it. Deletion is never refused because a report uses the parameter. Before deleting, the confirmation lists the reports that will lose the selected parameters under These reports will lose the deleted parameters:. Views that still mention the removed parameter skip it.
Each view type has its own reference page with every setting and its default:
| Add button | Card title | First key | Reference |
|---|---|---|---|
| Add chart | Chart | chart | Chart |
| Add table | Table | table | Table |
| Add time bars | Time bars | time-buckets | Time bars |
| Add histogram | Histogram | histogram | Histogram |
| Add calendar | Calendar | calendar | Calendar |
| Add hourly matrix | Hourly matrix | hourly-matrix | Hourly matrix |
| Add state duration | State duration | state-duration | State duration |
| Add Sankey | Sankey | sankey | Sankey |
Each add button adds a card with the view type as its title and a key below it. The first view of a
type gets the key in the table; later ones add a number, such as chart2 and chart3. The key
names the view in Layout and in the API (representations.<key>), and it cannot be edited.
Adding a view also appends a full-width row for it to Layout.
Time bars and histograms need numeric report parameters, and state duration needs integer report parameters; without them, the card names the type to add first. A view of a type that this version of the editor cannot edit is shown as a read-only card that can be removed; saving keeps it unchanged. Removing a view that is placed in the layout asks for confirmation and removes its layout cells and any rows left empty.
Layout
Section titled “Layout”Layout arranges views in rows. Add row adds a row and Add cell adds a cell to it. Each cell has a View and a Column width: Full, 1/2, 1/3, or 1/4. Rows and cells can be moved and removed. Widths in a row do not need to add up to a full row; cells wrap as needed. A new report starts with no rows.
Default time range
Section titled “Default time range”Default time range sets the window a report opens with and returns to on Reset:
| Type | Settings |
|---|---|
| Fixed | From, To |
| Current period | Period: Hour, Day, Week, Month, Year |
| Last days | Days (whole number, 1 or more) |
| From a chosen time until now | From |
| First reading until now | None |
New reports use Last days with 7 days. Lock time range keeps viewers on the default range: the report shows From and To read-only, hides Reset and quick ranges, and ignores the range the browser remembered.
Timezone
Section titled “Timezone”Timezone is Browser timezone (each viewer’s own timezone, the default) or Timezone
name, an IANA name such as Europe/Warsaw. The timezone sets displayed times and the boundaries
of local hours and days in every view. With a timezone name, every viewer sees the same day
boundaries.
Local hours and days are correct for timezones whose offset from UTC is a whole number of hours,
including daylight saving time changes (for example Warsaw, Berlin, Kyiv, London). In timezones
with a half-hour or other partial offset, such as Asia/Kolkata, Asia/Tehran, or
Australia/Adelaide, local hour and day boundaries may be wrong.
On the report
Section titled “On the report”These switches show or hide controls on the report page. They are not permissions: the underlying actions still follow each member’s role, and the API does not check them.
| Switch | Effect | Default |
|---|---|---|
| Add comments | Shows Comment to operators, editors, admins, and owners | On |
| Comments summary | Lists comments in the footer; signatures are always listed | On |
| Sign report | Shows Sign to operators, editors, admins, and owners | Off |
| Show snapshot sharing button | Shows Share snapshot to operators, editors, admins, and owners | Off |
| Show edit report button | Shows Edit to editors, admins and owners | On |
| Show CSV export button | Shows CSV to operators, editors, admins, and owners, and opens CSV export settings | Off |
CSV export settings
Section titled “CSV export settings”CSV export settings appear while Show CSV export button is on:
| Setting | Values | Default |
|---|---|---|
| Parameters to export | Report parameters | |
| Time interval | precise (every reading), 1s, 1m, 5m, 15m, 30m, 1h, 4h, 1d | 1h |
| Numeric aggregation | First, Latest, Average, Delta, Sum, Min, Max | Average |
| Integer aggregation | First, Latest | Latest |
| String aggregation | First, Latest | Latest |
Parameters removed from the report are dropped from the export on save. The export itself is described in Export CSV, and shared snapshots in Report snapshots.
Quick reports
Section titled “Quick reports”Quick report in Setup → Parameters, and in dashboards that offer it to operators, opens a temporary report for up to 20 selected parameters. Missing and unsupported parameters are skipped with a notice. A quick report has:
- a chart of every parameter;
- time bars of the numeric parameters, if any, showing hourly averages;
- a table of every parameter, one row per reading;
- the last day as its default range;
- comments, signing, snapshot sharing, and CSV export turned off.
A dashboard can instead ask for daily time bars and table rows over the last 31 days, and for per-interval differences (Delta) instead of averages for counter parameters. The title comes from where the report was opened: Quick report from Setup → Parameters, and the title the dashboard gives it, such as the name of a parameter or group, from a dashboard.
A quick report is not listed in Setup → Reports and is not included in hmi pull. Comments and
signatures cannot be added to it. Save on the report, for editors, admins, and owners, opens
the editor; saving keeps it as a regular report with the same address, listed in Setup and included
in hmi pull. The API behind quick reports is
report.preset.createTemporary.
Sync and deletion
Section titled “Sync and deletion”hmi pull and hmi push carry reports and their comments with the rest of the workspace setup as
report_preset and report_comment entries; see the CLI reference.
Deleting a report also deletes its comments; its shared snapshots stay.