First setup: step by step
This section is an end-to-end example for someone who has never defined a counter: from the flow of a well we will derive the daily and monthly water consumption, then the water consumption per ton of product, and get its report. Each step says what to enter and what you will see at the end. Page: Plugins → Counters & Metrics in the left menu.
A counter derives period consumption from the value of a tag (how many m³ today, how many kWh this month).
A metric is an indicator computed from counters with a formula (m³/ton, kWh/m³, loss %).
The category says what a counter measures, the group where it is; metrics and water reports select counters collectively with these two.
Step 1 · Build the structure (groups)
- Press the Categories and groups button above the counter list and switch to the Groups tab.
- New group → name Plant 1 → Add.
- With the Sub-group button in the Plant 1 row add the sub-groups Water supply, Production, Wastewater.
This step is not mandatory (a group can also be created while adding a counter), but building the structure up front prevents names from being written inconsistently.
Step 2 · Add the first counter
- Press Add counter.
- Select the Type (see the table below). If you measure an instantaneous flow or power, choose the entry that matches your input unit from the Preset list (e.g. m³/h → m³, L/s → m³); multiplier, divisor, time base and unit are filled in automatically.
- Fill in the fields:
| Name | Kuyu 1 (Well 1). This name is shown in the list and in reports. |
| Code | Generated automatically from the name (Kuyu1). The counter's output tag becomes _Counters.Kuyu1; it is used under this name on screens, in alarms and externally (OPC UA, REST, MQTT). |
| Type | Select according to what the tag provides: instantaneous flow or power → Rate; the device's own total index → Device totalizer; an increasing pulse count → Accumulate deltas; "running" information → On / off; no measurement → Manual. |
| Category | water production (water production / supply). The water reports find the wells by this category. |
| Group | Plant 1 › Water supply from the list. |
| Input tag | Type the tag path into the box or select it from the tag tree with the button next to it (e.g. Saha.Kuyu1.Debi). |
| Transform | Filled in by the Preset. If you enter it by hand: if the input is m³/h, time base = 3600; if L/s, 1 and multiplier ÷ divisor = 1 ÷ 1000 (litre → m³). |
- Press Save. The counter appears in the list; within a few seconds the Today column starts to increase.
Step 3 · Enter the unmetered item by hand
- Add counter → type Manual, name Mains water (invoice), category water production, group Plant 1 › Water supply → Save.
- Click the counter → Enter period value → select the month and enter the m³ value on the invoice.
Step 4 · Add the first indicator (metric)
- Switch to the Metrics tab → Add from formula library.
- Select a formula from the list; in this example Specific water consumption (per unit of product).
- Bind the inputs of the formula: for the water quantity you can select a single counter, or have several counters summed by giving a category + group (category water production, group Plant 1). If the production quantity is not measured it is bound to a manual input.
- Press Try: the result for the period you select and every value that goes into the formula are shown separately. If the result makes sense, Save.
- On the Manual inputs tab click the production input and enter the month's production quantity; the metric is computed for that month.
Step 5 · Get the report
| Quick look | Counters & Metrics → Period report tab: consumption day by day / month by month, CSV. |
| Your own table | Excel reports tab: rows are periods, columns are the counters and metrics you select. |
| With chart and PDF | Plugins → Reports: start with the ready-made example Daily consumption: counters side by side (with chart). |
Counters
A counter turns a tag value into period consumption: this hour, today, this week, this month, this year and the previous ones. In the left menu: Plugins → Counters & Metrics.
| Rate | An instantaneous flow or power is integrated over time (m³/h → m³, kW → kWh). |
| Runtime | The time the input is "running" is accumulated. |
| Delta | Successive differences of an increasing raw counter (pulse counter) are accumulated. |
| Totalizer | The device's own index is followed; resets and rollovers are compensated. |
| Rollup | The sum of the counters in the same series. |
| Manual | Unmetered items: the period value is entered by hand (invoice, estimate, laboratory). |
Data reliability
| Data gap | If communication is lost the consumption in between is estimated and kept separately as the estimated share; reports mark it with a warning icon. |
| Reset / rollover | If the device index drops or wraps at its capacity, consumption is not lost; the event is logged. Optionally the counter stops and waits for an operator decision. |
| Spike | Increases that are physically impossible (maximum rate limit) are filtered out. |
| Manual correction | A period value can be corrected; the correction is stored apart from the measured value, with who made it and when. |
| Meter replacement | When the device is replaced, the old final index and the new initial index are entered; the total continues without a break. |
List view. The counter list opens as Simple: the counter's name, below it what it measures and where its value comes from, today / yesterday / this month. The Detailed view also shows the tag name, the type, the input tag and the cumulative total. The "How to read this list" box below the list explains the marks.
Searching and collapsing groups. On all three of the Counters, Metrics and Manual inputs tabs there is a search box above the list and two small buttons next to it.
| What you want to do | How |
|---|---|
| Find a record | Type part of its name, code, group, unit or (for a counter) input tag into the search box. Upper / lower case and Turkish letters do not matter: typing ozgul finds Özgül enerji. If you type several words, the records that contain all of them remain (fabrika 1 atıksu). The list is filtered as you type; above it you read "Showing 2 of 46 metrics." |
| Clear the search | Empty the box (the cross on the right of the box). |
| Close or open a group | Click the group header row (the row with a folder icon that reads "Plant 1 · 18 counters"). The records of a closed group are hidden; the number in its header stays. When a parent group is closed its sub-groups are hidden too. With the keyboard: move to the header with the Tab key, then Enter or Space. |
| Close / open all at once | The Collapse all groups and Expand all groups buttons next to the search box (hover over them to see their names). After collapsing only the top groups remain; click one to go inside. |
Category. The built-in categories (water production, water consumption, wastewater, electricity…) are used in the water reports. You can also add your own category: select Add a new category in the category list and type its name (compressed air, steam, chemical…), or add it from the Categories and groups window above the counter list. A custom category can be selected in metrics as "the sum of the counters in this category". The same window is used to rename, move, merge and delete categories and groups; when a name changes, the counters, metrics and water profiles that use it are updated together.
The new counter window shows only what is needed: name, type, category, input tag and preset. The Code is generated automatically from the name (change it if you wish). Series, gate tag, filters, reset and rollover settings are under the Advanced settings button; for most counters there is no need to touch them.
Categories and groups
Every counter has two labels: the category (what it measures: water supply, wastewater, electricity, compressed air…) and the group (where it is: Plant 1 and, under it, Treatment). Metrics, Excel reports and water profiles do not select counters one by one but collectively with these two labels ("the sum of the water supply counters in the Plant 1 group"). That is why consistent names matter.
Names are managed in one place: Plugins → Counters & Metrics, the Categories and groups button above the counter list. The window has two tabs.
Categories tab
| built-in badge | The categories that come with the application (water production / supply, water consumption, wastewater / discharge, electricity consumption…). Water Footprint, Water Efficiency and Water Flow Diagram find counters by these categories; that is why their names cannot be changed and they cannot be deleted. |
| custom badge | The categories you added. They can be renamed, deleted and merged into another category. |
| Counters column | The number of counters in that category. |
| Used to select counters by | The places that use the category as a selector: metric operands, water profiles, Excel report columns. Hover over it to see the full list. |
- Adding: New category → type its name (e.g. Compressed air) → Add. The name appears in the Category list of the counter window; it stays in the list even if no counter uses it.
- Renaming: Rename in the row → type the new name → Continue. The window shows what will change ("Records that will be updated together: 4 counters, 2 metrics, 1 Excel report"; one by one with Which records?). Nothing has changed yet. When you press Apply they are all updated together.
- Merging: while renaming, type the name of another existing category. The two categories are gathered under a single name; the window reports this with a warning. A merge cannot be undone.
- Deleting: Delete → choose what happens to the counters: leave without a category or move to this category. The counters are not deleted; only the category name is removed.
Groups tab
Groups are shown as a tree: the parent group with its sub-groups indented below it. Each row shows the number of counters, metrics and manual inputs in that group and the places that select the group; "(+6 below)" shows the counters, metrics and manual inputs in the sub-groups.
Collapsing the tree. A group that has sub-groups has a small arrow in front of it. Clicking the arrow or the group name hides its sub-groups and the row reads "8 sub-groups hidden"; the numbers stay in the upper row as "(+18 below)". Expand all and Collapse all above the table open the whole tree at once or leave only the top groups. If you add a new group under a closed group or move a group there, that group opens automatically. Which groups are closed is remembered in this browser.
- Adding: New group → type its name and, if you wish, select the group it will be under → Add. Or the Sub-group button in a row adds directly under that group. An empty group can be added: build the structure first, then place the counters.
- Changing its name: Rename / move → type the name → Continue → Apply. Its sub-groups and the counters, metrics and manual inputs in it move together; the metrics and water profiles that select that group also use the new name.
- Giving it a colour: click the colour box in the Colour column of the group row and pick the colour; it is saved immediately. The group's colour is kept in one place: the group header in reports (Excel reports) uses this colour. A sub-group without a colour inherits it from its parent; if no colour has been given at all, reports use a colour from the built-in palette (from parent or default is written next to the box). The back arrow next to the box removes the group's own colour. When a group is renamed or moved its colour goes with it.
- Moving it under another group: in the same window select the new parent in the Parent group box (top level to move it to the top).
- Deleting: Delete → choose where the content will be moved (default: the parent group). No counter or metric is deleted; only the group is removed.
What do the warnings mean?
| "… the counters this selector counts will change (3 counters → 5 counters)" | After this operation the named metric or water profile will sum different counters, i.e. its result will change. Example: if you move the Plant 1 / Pumps group under Plant 2, the "Plant 1 total" metric no longer counts those pumps. If that is what you want, apply; if not, cancel. |
| "… already exists: … will be merged with it" | The target name is in use; the two names will become one. Which record came from which name is not kept. |
| "… places use this category / group to select counters" | The operation was rejected. Deleting without choosing a place to move to would leave that metric's selector empty and the metric would start counting all counters. Choose a target category or group before deleting. |
| "… there are N metrics generated by water profiles; they stay in place" | The metrics generated by Water Efficiency and Water Flow Diagram are grouped under the profile's name (Water efficiency / Profile name). The names of these groups do not change from here; change the profile's name on its own page. |
| "… N manually changed metrics were not updated automatically" | You later edited by hand a metric generated by a water profile; the application did not overwrite it. Open the profile on its own page and save it with the "write anyway" option. |
Rules and limits
| Category name | At most 60 characters; it cannot contain "/". Case is not distinguished (buhar and Buhar are the same category). |
| Group | The name of each level is at most 60 characters, at most 8 levels deep. "/" is not written in a group name; a sub-group is built with the "Sub-group" button or the "Parent group" box. |
| Sub-group matching | A metric that selects a group also counts its sub-groups: if Plant 1 is selected, Plant 1 / Treatment is included; Plant 10 is not. |
| Permission | Three conditions are checked together (3.10.1; in the previous version the window in practice worked only for Root): (1) the Counters and Metrics: Manage permission; (2) the "Categories and groups" action inside this permission must not be turned off (taxonomy.manage; when it is off the Categories and groups button does not appear); (3) the user must have access to all connectivity (All Connectivity (every channel + device) in resource access; from their own record or from their group). A user who can access only certain channels cannot use the window (and cannot read the list either): the operation also changes records they cannot see. Root can always use it. |
| Record | Adding, renaming and deleting are written to the audit log (who, when, from which name to which name). The preview made with "Continue" is not written. |
| Migration | Category and group names go into the project package and the configuration version history. |
Metrics
A metric is an indicator (KPI) computed from counter and tag values: specific consumption, efficiency, ratio, per-capita use… The formula uses the hub expression language; operands are referenced as {Name}.
{Water} / {Production} → m³ / ton
({In} - {Out}) / {In} * 100 → loss %
| Tag | The current value of a tag. |
| Tag set | The sum, average, minimum, maximum or count of the current values of several tags. The tags are chosen with the multi-selector and / or given by a pattern (Kuyular.*.Debi). Details: Tag set. |
| Counter (cumulative / period) | A single counter, or several chosen by a selector (category, group, series); sum, average, minimum, maximum. |
| Metric | The value of another metric for the same period (chains are allowed; cycles are rejected). |
| Manual input | A value entered per period: production quantity, headcount, laboratory result, rainfall. |
| Constant | A fixed number (a limit, a conversion factor). |
| Period share | The period's share of the year (the part elapsed so far): for indicators divided by time. |
An instant metric is computed from current values, a period metric from the data of the chosen period (hour, day, week, month, year). Every result carries a quality:
| good | All operands were measured. |
| estimated | Contains an estimated share or a data gap. |
| partial | Some counters have no data for that period (an optional operand was counted as 0), or some tags in the tag set give no value right now. |
| none | Could not be computed; the reason is shown next to it. |
Ready-made formulas
The Add from formula library button opens the formula library: pump efficiency, hydraulic power, pumping head, pipe velocity, Hazen-Williams head loss, water loss ratio, specific energy (kWh/m³), per-capita consumption, capacity utilisation, change against the previous period, average rate, logarithm, power, compound growth… Select the formula; bind only its inputs (counter, tag or number), see the result with Try, and save. The saved metric can be changed later in the advanced editor.
| Derivative | The derivative of a quantity with respect to time is the period quantity divided by the elapsed time ("Average rate": volume ÷ hours = average flow). The change between periods is built with the "Change against the previous period" formulas. |
| Integral | The sum of a measurement (flow, power) over time is a counter: add a counter of the "Rate" type (m³/h → m³, kW → kWh). |
| Advanced functions | The function palette below the formula in the advanced editor: LN, LOG, EXP, POW, SQRT, POLY, MAP, IF, trigonometry… Clicking one inserts it into the formula. |
Breakdown: what makes up this number?
Click a row in a metric's period series, a number in the water footprint table or a water efficiency indicator: the formula, the values that went into the formula and the contribution of each counter open. For an instant metric click the metric and press What makes up this value?: the current value of each input is listed and, for a tag set, the contribution of each tag. Counters that have no record for that period appear as "no data"; this is the reason for the "partial" mark next to the number.
Excel reports
For the table that shows counters group by group, with coloured band headers and a last index + difference column pair for each counter, see Counter tracking list (grouped report).
On the Excel reports tab you design your own report: rows are periods (hour, day, week, month, year; range "this month", "last 30 days", a date range…), and you select the columns (a counter, the sum of a category / group, a metric, a manual input). Add the counters of the group turns all counters of a group into columns with one click. The report is stored; every time it is opened it fills with current values and is downloaded as Excel or CSV. The downloads on the period report, water footprint, water efficiency and flow diagram pages are Excel too (multi-sheet, with headers and number formats).
Counter tracking list (grouped report), templates and external systems
The counter tracking list is a period table that shows counters side by side, group by group: coloured group headers at the top (e.g. PRODUCTION, CONSUMPTION, RECOVERY), sub-groups below them (PROCESS, NON-PROCESS), Closing index and Difference columns under each counter, a total column at the end of each top group, and a TOTAL row at the bottom. Rows are periods (hour, day, week, month, year). The table is dynamic: the columns are regenerated from the counter groups at every run; when you add a new counter to a group it enters the report automatically.
Location: it has two entry points and both show the same list: the Plugins → Reports → Counter tracking lists tab and the Plugins → Counters & Metrics → Excel reports tab. Seeing the list, running and downloading a report need Reports: View; building, editing and deleting need Reports: Manage. The counter and group tree of the editor is filled with the Counters and Metrics: View permission.
Setting up: step by step
- First make sure the group of your counters is correct (e.g. Fabrika/ÜRETİM, Fabrika/TÜKETİM/PROSES). The group tree is the header structure of the report; see Categories and groups.
- On the Excel reports tab press the New report button. The editor opens with the top group that has the most counters (Plant) selected and all groups ticked; the preview is drawn below at once.
- Enter the Report name (e.g. Meter tracking list).
- In the Groups and counters in the report tree on the left untick the group or counter you do not want. The small arrow in a group row opens / closes the group; next to it is the number of counters in the report ("3 / 5 counters"). The Include all and Leave all out buttons tick or clear the whole tree.
- Change the order with the up / down arrows on the right of the row: a group or counter higher in the tree is further left in the table.
- Click a group: Header colour opens in the Selected group / counter box on the right. Pick the colour from the colour box: this is the colour of the group; it is saved the moment you pick it, it is the same in every report, and it can also be changed in the Colour column of the Categories and groups window. The group's header takes that colour and the counter headers below it a light tone of the same colour. The Remove colour button deletes the group's own colour (the parent group's colour is used, or the built-in palette if there is none). The coloured stripe on the left of the row shows the colour that will be used in the report.
- Select the columns in the Values shown for every counter box on the right: Closing index, Difference (period consumption), Group total column, Column totals in the last row. If both are ticked each counter becomes two columns; if only Difference is ticked the counter name becomes the column header.
- In the When the report opens (default) box select the period the report shows when first opened (Each row is one: Hour, Day, Week, Month, Year) and the Range. This is only the opening selection; you change the period as you like while the report is open.
- The Preview refreshes automatically as you change something. When you are happy with it press Save; the report appears in the list and opens below.
While the report is open: period, date and groups
Clicking a report in the list opens it below. You do not need a separate report for each period: you select it in the bar above the table and the table is recalculated instantly.
| Each row (Hour, Day, Week, Month, Year) | The period size of the rows. |
| Range | This month, Last month, This year, Last year, Last … periods (the number of periods is entered next to it), Date range. |
| Two date boxes | They show the first and last day displayed by the table. When you change one, the range automatically becomes "Date range". |
| Left / right arrow | Shifts the range to the previous / next range: month by month if a full month is selected, year by year if a full year is selected, otherwise by the number of days selected. |
| Groups | A group or counter you untick in the drop-down list is removed from the table and from the downloaded file; Select all brings them all back. This selection does not change the report. |
| Make this the report default | Writes the period and range you selected to the report (from now on the report opens this way). Back to default returns to the saved selection. |
| Download Excel, CSV | Downloads the table you see on screen: with the selected period, range and groups. |
| Edit report | Opens the editor to change the groups, the order and the colours. |
Reading the table
| Closing index | The counter's index at the end of that period (cumulative value). It is not summed; it stays empty in the TOTAL row. |
| Difference | The consumption in that period (period end − period start; manual adjustment included). It is summed in the TOTAL row. |
| Group total (e.g. PRODUCTION TOTAL) | The sum of the differences of all counters under that top group; written in bold. It appears if the top group has at least two counters. |
| Manual counter | Because it has no index, only the Difference column appears. |
| Dash (—) | No record for that period. |
| Warning and half-circle icons | The value contains an estimated share or a data gap / some of the selected counters have no data for that period. Hover over it for the explanation. |
The table is wide: browse it with the horizontal scroll bar; the period column and the header rows stay in place.
Extra columns and fine tuning
You can add columns in addition to the counters in the tree: in the editor click the Extra columns: metric, manual input, sum or individually picked counter (optional) heading. Each row of the table is a column and is added to the right of the columns coming from the tree (e.g. a metric column at the very end).
| Kind and Source | Counter, Sum of counters (category / group), Metric (indicator), Manual input. |
| Value | What is shown in a counter column: Difference (period consumption), Closing index, Opening index, Measured, Estimated share, Manual adjustment, Data gap (hours). |
| Header | The column's own header; if empty, the name of the source. |
| Band | The path of the headers above the column, separated by /: GÖSTERGELER/Enerji. Adjacent columns whose paths start the same are merged in a common header cell. At most 5 levels. The colour of these headers is selected in the Band colours of the extra columns box in the same section. |
The Move the tree columns into this list button moves the columns coming from the tree into this table: you can type their headers and bands one by one and delete columns. After this the report is no longer dynamic (a new counter added to a group does not enter automatically) and the ticks in the tree are cleared; to make it dynamic again tick the groups in the tree and delete the rows in this list.
Excel and CSV
Download Excel writes the table as on screen: merged, coloured band headers; numbers as numbers (summable); totals in the last row. In CSV the header is a single row and carries the full path: ÜRETİM › Kuyu 1 › Son endeks (m³).
Template: reuse, export and import
| Download as template | The file with an arrow icon in the report row. It downloads the definition as a .json file. In the file counters are written by code, not by id; a report generated from groups contains only group names, order and colours. That is why a template can be carried to another system or another plant. |
| From template | The button at the top of the tab. When you select the file the editor opens filled in; nothing is saved until you press Save. If a report with the same name exists, "(copy)" is appended to the name. |
| Applying to another plant | After opening the template select that plant's top group in the Plant box of the editor; if the sub-group names are the same (ÜRETİM, TÜKETİM/PROSES…) the colours apply as they are. |
| Source not found | If a counter, metric or input code in the template does not exist on this system it is listed at the bottom of the editor; reselect the source in that column or delete the column. |
| Project package | Reports also go into the full project bundle; when moving the whole system you do not need to download templates separately. |
Transfer to external systems (ERP, BI, other software)
To have MergenHub send the report itself at set times instead of the external system coming to read it: Sending a report to an external system (report agent).
The plug icon in the report row opens the reading from external systems (REST) window. The report is calculated with current values at every request and returns JSON; the external software calls the address at regular intervals. The report is opened to the outside only with an access key; no user name and password are given to the external system.
Access key: step by step
- In the New key section of the window, type into the Name box which system will use the key (e.g. ERP nightly transfer).
- Scope: This report only (recommended) or All reports. Valid for: 30 days, 90 days, 1 year or No expiry.
- Press Create key. The key is shown once: copy it immediately. The server does not store the key itself (only its hash), so it cannot be shown later; if it is lost, delete it and create a new one.
- The external system sends this header with every request:
Authorization: Bearer mhkey_…. The window also has a ready Try it (command line) line. - The Keys that can read this report list shows each key's scope, last use time and address, and expiry date. The trash can icon followed by Yes, delete invalidates the key instantly.
| What the key can do | It only reads: GET /config/v1/meteringreports/{id}/run (and the report list if its scope is "All reports"). It cannot reach any other address, setting or write operation; it cannot change or delete the report. |
| HTTPS | The key is always required. A request coming from the internet is accepted only over HTTPS; the server rejects an unencrypted request (the key could be read on the way). A request coming from the local network (the server's own computer and private network addresses such as 10.x, 172.16-31.x, 192.168.x) is also read over unencrypted HTTP. If HTTPS is off the window says so. To turn it on: Enable HTTPS in the HTTPS / Public section of the Settings page. If the server is behind a reverse proxy, the proxy's external connection must be HTTPS. |
| User name and password | Report addresses are not read from external systems with a user name / password (HTTP Basic); the request is rejected and you are asked to use a key. |
| Who creates it | A user with the Server settings permission. The key reads the reports that the user who created it can see; if that user is deleted or loses the Reports: View permission the key stops working too (403). |
| Failed attempts | An address that sends a wrong key repeatedly is locked out for a while (the same protection as on the login screen). |
Addresses and formats
GET /config/v1/meteringreports/{id}/run | Table format: columns (header, unit, bands, colours, key) and rows (period start / end, values, quality) with totals. |
…/run?shape=records | Flat record format: each row is { start, end, startIso, values: { anahtar: değer } }. This format is the easiest to process in an ERP. |
grain, range, count, from, to | The period and range are changed for this request (the saved report does not change). grain: Hour, Day, Week, Month, Year. range: ThisMonth, PreviousMonth, ThisYear, PreviousYear, LastN (+ count), Custom (+ from, to: yyyy-MM-dd or epoch ms). |
| Column keys | They are stable (they stay the same as long as the counter code does not change): counter:<SayaçKodu>:EndIndex (closing index), counter:<SayaçKodu>:Total (difference), sum:<grup>:Total (group total), metric:<MetrikKodu>, input:<GirdiKodu>. |
| Authentication | Access key: the Authorization: Bearer mhkey_… header (see above). A user signed in in the browser can also open the same addresses with their own session. |
GET /config/v1/meteringreports/<rapor kimliği>/run?shape=records&grain=Day&range=Custom&from=2026-01-01&to=2026-01-31
→ { "grain":"Day", "rows":[ { "startIso":"2026-01-01T00:00:00+03:00",
"values": { "counter:Kuyu1:EndIndex": …, "counter:Kuyu1:Total": …, "sum:Fabrika/ÜRETİM:Total": … } }, … ] }
Individual values are also published as tags and can be sent with agents: _Counters.<Kod> (index), _Counters.<Kod>.Day / .Month (period consumption), _Metrics.<Kod>. These tags are pushed to external systems with Data Bridge agents (MQTT, REST client), read from OPC UA clients, and bound to alarms and data logging; see Output tags.
AI assistant and MCP
The assistant lists these reports with list_counter_reports and runs them with run_counter_report; it can change the period and range according to the question. Things you can ask: "How much did Deep well-1 draw in January?", "Compare the production and consumption totals month by month this year", "Which three counters consumed the most water last month?". The tools are in the Counters / Metrics / Water management scope and only read. They are closed to users with restricted resource access (the report also sums counters they cannot see).
Limits and permissions
| Columns and rows | At most 160 columns, 800 periods (rows). If the column count is exceeded untick some groups in the tree or turn off the Closing index columns. |
| Sum counters | Counters of the "Sum of counters" type do not enter the columns generated from groups (to avoid double counting). |
| Disabled counter | A counter that is not enabled does not enter the columns generated from groups. |
| Permission | A user with restricted resource access cannot see or build a report generated from groups or one with sum / metric columns; they can only add columns by hand from the counters they can see. |
Tag set: live sum / average of several tags
A tag set is the way to bind several tags to a metric as a single input: the sum of the flow of 35 wells, the average pressure of all lines, the number of running pumps, the lowest tank level. The current values of the tags in the set are reduced to a single number in the way you choose (sum, average, minimum, maximum, count). The result is an instant metric: it is recalculated once a second, published as the _Metrics.<Kod> tag and shown in the live card on a report page.
Setting up with a ready-made formula: step by step
- In the left menu Plugins → Counters & Metrics, Metrics tab, Add from formula library.
- Select one from the Live aggregate values (several tags) group at the top of the list:
Live sum The sum of the tags: total well flow, total power drawn; the sum of "running" bits = the number of running pumps. Live average Average pressure, average level, average efficiency. Only the tags that give a value are counted. Live maximum value, Live minimum value The highest pressure, the lowest tank level. Number of points with data How many of the tags in the set give a valid value right now (the number of communicating devices). If none gives a value the result is 0; this way an alarm "number of communicating wells less than 1" can be set up. Live ratio (quotient of two sums) The ratio of the sums of two sets: total power ÷ total flow = live specific energy (kWh/m³). - Press Pick tags. In the Select Tag (Browse) window tick the boxes of the tags; the box of a channel, device or group selects all the tags under it. The search box at the top searches by name and address. When you press Select your selections appear as chips in the set box; the × on a chip removes that tag, Clear removes all.
- Or (instead of selecting one by one, or in addition to it) type a pattern into the box below:
Kuyular.*.Debi. The pattern rules are below. - Press Test the set: it writes "The set has 8 tags; 8 give a value right now. Sum: 328.5." and lists the first tags with their values. If more or fewer tags came out than you expected, correct the pattern.
- Enter the Name, the Unit (e.g. m³/h) and, if you wish, the Group; the Code is generated from the name (it is the name of the output tag). Try computes the result without saving; Save adds the metric.
Pattern rules
Kuyular.*.Debi | The Debi tag of every device in the Kuyular channel. The star stands for one path part between dots. |
Kuyular.K0*.Debi | The star can also be inside a part: devices whose name starts with K0. |
Kuyular.*.Pompa.Calisiyor | If the tag is inside a tag group the group name is written too (or a star is put in its place: Kuyular.*.*.Calisiyor). The number of parts must be the same as in the tag path. |
| First part | The channel name is written in full; there can be no star in the first part. To sum the tags of two channels add the tags of the second channel with Pick tags, or build a formula with two set inputs. |
| A device added later | A new tag that matches the pattern enters the set automatically (within 15 seconds at the latest); the metric does not need to be saved again. Tags selected one by one are in the set as long as they stay in the list. |
| Letter case | Not distinguished; still, write the names as they are in the tree. |
How does missing data appear?
| Some give no value | The result is computed only from those that give a value and is marked partial (so that a disconnected well does not silently reduce the total). The list and the card read "from 7 of 8 points"; the card shows the PARTIAL badge. |
| None gives a value | For sum, average, minimum and maximum: no data (not 0). For Count the result is 0. |
| The pattern matches no tag | No data. Test the set says "No tag matches the set". |
To see how much each tag contributes, click the metric and press What makes up this value? in the window that opens: every tag in the set is listed with its current value and (for a sum) its percentage share; those that give no value appear as "no value". In the Metrics list, hovering over the number in the Now column shows from how many points it was computed.
Tag set in the advanced editor
In the editor opened with Empty metric (or in the Edit definition window of a saved metric) select Tag set: several tags (sum, average…) in the From list of an input; set the aggregation (Sum, Average, Minimum, Maximum, Count) in the list next to it. The set is referenced in the formula as {Name} like the other inputs; several sets, single tags, constants and counters can be used together in the same formula:
{Guc} / {Debi} → total power ÷ total flow (kWh/m³)
{Calisan} / {Toplam} * 100 → percentage of running pumps (sum ÷ count)
{Debi} * 24 → daily volume at this flow (m³/day)
Limits and permissions
| Set size | At most 2000 tags are aggregated in a set; if the pattern matches more, Test the set warns (narrow the pattern). At most 500 tags can be selected one by one; use a pattern for more. |
| Metric outputs | Tags that start with _Metrics. cannot be taken into a set (so that a metric does not refer to itself or indirectly to another metric). To use another metric select Metric as the input kind. Counter outputs (_Counters.…) can be taken into a set. |
| Permission | A user with restricted resource access cannot see a metric if they cannot access one of the tags in its set (a sum leaks data too). Test the set shows only the tags they can access. |
| History | An instant metric is not stored. For its history add the _Metrics.<Kod> tag to the Historian; for a period total bind counters to the flow tags. |
Debi, Guc, Basinc, Pompa. (1) Live sum, pattern Kuyular.*.Debi, unit m³/h → "Well production flow". (2) Live sum, pattern Kuyular.*.Pompa, unit count → "Number of running pumps". (3) Live ratio, A = Kuyular.*.Guc, B = Kuyular.*.Debi, unit kWh/m³ → "Live specific energy". (4) Live average, pattern Kuyular.*.Basinc, unit bar. When a ninth well is added all four metrics take it into account automatically.Kuyular.*.*, flow, power and pressure are added to each other; write the last part (the tag name) in full. (2) The average of averages: the plain average of pump efficiencies is not the flow-weighted average; for a weighted result use the ratio of two sums (Live ratio). (3) Taking a live sum for consumption: m³/h is a rate; a counter is needed for m³.Report pages (visual report editor)
The first tab of the Plugins → Reports page in the left menu is Report pages. A report page gathers several visuals on one screen: charts, tables, single numbers, gauges and explanatory texts. You drag and resize the visuals (panels) with the mouse and select the data of each by dropping fields into the field boxes; the result is drawn as you edit. The page is stored, fills with current data every time it is opened, refreshes automatically if you wish, and is downloaded as PDF or Excel.
The second tab is Table reports: reports that consist of a single table, used for long listings and Excel / CSV output (the next two sections). In short: a report page for a summary to glance at, a table report for a row-by-row listing. The third tab is Counter tracking lists: the period table that shows counters group by group (see Counter tracking list).
Next to each tab title the number of records in that tab is written in parentheses (example: Report pages (1), Table reports (0), Counter tracking lists (1)). The page always opens on the first tab; here you see, without opening the tabs one by one, which tab holds a report that someone else added or that came with a project package.
What is on the tab?
| My report pages | The cards of the saved pages: name, description, the icons of the panel types in it, the panel count, the time range and (if on) the refresh interval. Clicking a card opens the page. |
| Pencil, copy, trash can on the card | Edit, make a copy (the quickest way to a similar page), delete. Deleting removes only the page definition; it does not touch the stored data. |
| New report page | Opens the editor with an empty page. |
| Start from a ready-made page | Consumption summary (counters), Alarm summary, System and user activity. The example opens filled in in the editor; you change it to suit your own data and save. If you leave without saving nothing is created. The consumption example is filtered by the unit used by the most counters (e.g. m³ only) so that counters with different units are not summed. |
Viewing a page
| Pages | Returns to the page list. |
| Range | The common time range of the page: today, yesterday, last N hours, last N days, this week, last week, this month, last month, this year, last year or between two dates. The selection you make here is not saved; it only changes the page you are looking at right now (e.g. to check "how was last month?"). The × button that appears next to it returns to the page's saved range. |
| Refresh | Automatic refresh while the page is open: off, 10 s, 30 s, 1 min, 5 min, 15 min. Refreshing waits while the browser tab is in the background. The arrow icon next to it refreshes at once. |
| Full screen | Wall display mode: the page covers the whole window and the menus are hidden; return with Esc or Exit. Details: Live board and wall display. |
| Downloads the whole page as landscape A4: the panels are drawn in their on-screen layout (side by side and one below the other); table and text panels are full width and continue on the following pages if needed. The range and the creation time are written below the title. | |
| Excel | Writes the data of each panel to a separate worksheet (charts are not added; numbers stay numbers). |
| The table icon at the top right of a panel | Appears when you hover over the panel. It opens the panel's data as a table; Download Excel at the bottom of the window downloads only that panel. Use it to read the numbers in a chart exactly. |
| Hovering over a chart | All series of that category are shown with their values in a small box. |
| Edit | Opens the editor (requires the Reports: Manage permission). |
On a narrow screen (phone, narrow window) the panels collapse into a single column, one below the other. Use a wide screen for editing.
Building a new page: step by step
- Press New report page. Type the page name into the box at the top (required; two pages cannot have the same name).
- In the top bar select the page's Range (e.g. This month) and, if you wish, the Refresh interval. This range is saved with the page and applied to all panels.
- In the right pane click a visual under Add a panel. The panel is added to the first empty place on the page and selected (a coloured frame around it).
- In the right pane type the Panel title and select the Data source (the sources are the same as for table reports; see the list in the "Table report" section). As soon as you select the source the panel fills with a starting point that suits its type: time on the axis for a time chart, a single calculation for a single number, and so on.
- Make the source's own selections (e.g. Period size and Counters for counters, log group and tags for the data log, at least one metric for metrics). If a required selection is missing the panel says what is needed.
- Arrange the Field boxes (table below). Half a second after each change the panel is redrawn; there is no separate "preview" button.
- Move the panel into place and resize it ("Layout" below). To add another panel click an empty place or release the selection with the × at the top of the right pane; the Add a panel section comes back.
- Press Save. If something is missing or wrong, a red box at the top says what must be corrected in which panel. Cancel leaves without saving (it asks first if there are changes).
Visual types
| Line, Area | Change over time (daily consumption, hourly average). Area is the line with a light fill below it. |
| Column | Compares values side by side (count by day, total by month). |
| Stacked column | The parts are stacked; the height of the column is the total (daily alarm count, split by area). |
| Horizontal bar | Long names and rankings (counter ranking, operations per user). For lists such as "top 10", in the Format section set the sorting to by value: largest first and Maximum categories to 10. |
| Share | A bar of a single value divided into percentages. The 5 largest shares are shown separately, the rest as one part. |
| Table | A record list or a summary table. A table panel on a page takes at most 2000 rows and shows the first 300 rows on screen (all of them are in the PDF and Excel output); for longer listings use a table report. |
| Single number | The summary of the range in a single number, in large type (total consumption, alarm count). Below it the range and, if a target was entered, the target and the percentage achieved. |
| Gauge | The position of a single number within the Minimum – Maximum range: a half ring fills up to the value, and the Target is marked with a thin line. The maximum value is required. |
| Live card | The current value of a metric, from how many points it was computed and a trend line; it refreshes every 2 seconds and is independent of the page's time range. It has no data source or field boxes; only the Metric is selected. Details: Live board and wall display. |
| Text | A heading or an explanation. Plain text; line breaks are kept. A line starting with # is written as a heading. It has no data. |
You can change the type of the selected panel at any time in the Visual type gallery in the right pane; your data selection is adapted to the new type (e.g. switching from line to single number removes the axis, switching to share turns the series breakdown into the category).
Field boxes
In the Fields row all fields of the source are shown as small chips; the icon shows the type (clock: time, #: number, Aa: text, list: option). Drag and drop a field into a box or click it (a clicked field goes to the most suitable box for its type: number → Values, time / text → Axis, or Series breakdown if the axis is filled). The + add … list below each box does the same without dragging; the × on the right of a row in a box removes the field.
| Axis (Category for a horizontal bar, Slices for a share) | The horizontal axis of the chart: every distinct value becomes a category. For a time field the unit is selected in the list next to it: by hour, by day, by week, by month, by year or as is. In the counter and metric sources time is already at the period size you selected; leave it "as is". |
| Values (Value for a single number, gauge and share) | The calculations to draw. In each row a calculation (Count, Sum, Average, Minimum, Maximum, First value, Last value, Number of distinct values) and a field are selected; in the box below it you can type a display name (shown in the chart legend and the table header). "Count (number of rows)" needs no field. Sum and Average exist only for number fields. |
| Series breakdown | Every distinct value of this field becomes its own series (a separate coloured line or column part). Example: axis Period, value Sum: Value, series breakdown Counter → each counter is a separate line. With a breakdown there can be at most 4 calculations; a single calculation gives the most readable result. |
| List / Summary in a table | List: each record is a row; in the Columns box you set the visible fields, their order with the arrows and (by typing into the box) their headers. Summary: Rows are the grouping fields, Values the calculations, Spread into columns the field to be spread into side-by-side columns. |
Filter, format and time range
| Filter | Field + condition + value (e.g. Event equals Raised, Unit equals m³, Value is greater than 100). With several filters all of them must hold together. You can also add a field by dragging it into the filter box. |
| Format (chart) | Sorting: axis (time) order, or by value largest first / smallest first. Maximum categories: the upper limit of the number of categories drawn. With a series breakdown the sorting is in axis order. |
| Format (table) | Sort by and Direction, Maximum rows, Show a totals row. |
| Format (single number, gauge) | Target, Unit (if empty, the unit of the field), Decimals; for a gauge also Minimum and Maximum. These fields are applied instantly without fetching the data again. |
| Time range | While Use the time range of the page is ticked the panel fills with the common range at the top of the page; when the viewer changes the range the panel changes too. If you untick it you give the panel its own range (e.g. while the page is this month one panel shows the this year total). Sources that give a current state (live values, active alarms) have no range. |
Layout: moving and resizing
| Moving | Drag the panel by its header (the dotted handle on the left). A dashed frame shows where it will land when dropped. |
| Size | Drag the small corner mark at the bottom right corner of the panel. The page has 12 columns; the width can be 1–12 columns, the height 1–30 rows. |
| Automatic compaction | Panels compact upwards; no empty row is left in between. If you drag a panel onto the top edge of another one they swap places; a panel you enlarge pushes those below it down. |
| Keyboard | Select the panel (click it or reach it with Tab): the arrow keys move it, Shift + arrow resizes it, Delete deletes it, Esc releases the selection. |
| Duplicating, deleting | The copy and trash can buttons at the top of the right pane duplicate or delete the selected panel. |
Adding a saved table report as a panel
While no panel is selected the Add from a saved table report list is shown in the right pane. The report you select is added as a chart panel if it has a chart, otherwise as a table panel, and keeps its own time range (tick Use the time range of the page if you wish). The panel is a copy of the report's definition at that moment: changing the table report later does not change the panel.
Report pages with the AI assistant and MCP
The AI assistant and external MCP clients can build, read and change report pages for you. The same rules apply: the assistant uses only the data sources your permissions allow, and if your resource access is restricted it sees only the data of the devices and counters you can access.
| Tool | What it does | Permission |
|---|---|---|
list_report_pages | Lists the pages and their panels (type, data source, place in the grid); gives the grid rules and visual types. | read |
get_report_page | Reads the full definition of a page (before changing it). | read |
run_report_page | Runs the page with current data and gives the data of each panel: the value for a single number and gauge, the rows for a chart and table. It can change the range for that question ("how was this page last month"), ask for a single panel, or try a definition before saving. | read |
save_report_page | Builds a new page or changes an existing one. If it does not give the place of the panels they are laid out in order at the size of their types; if it does, overlapping ones slide down and gaps are closed. | change |
delete_report_page | Deletes the page with all its panels. | change, approval every time |
What you can ask: "Build a wall display that shows the live total flow of the wells and the number of running pumps", "Build a board that shows this month's withdrawal of the wells: the total at the top, a daily chart below, the distribution by well next to it", "Add a gauge with a monthly target of 25,000 m³ to the water summary page", "What was on the alarm summary page last week", "Delete the unused trial page".
- Reading needs no extra setting: the assistant lists the pages, runs them and summarises the result in text. The assistant does not draw the chart; the drawing is on this page.
- For building, changing and deleting the administrator must have turned on the Assistant may make changes setting and you must have the Reports: Manage permission. Depending on the approval mode the assistant shows what it will do before each change and asks for your approval; deleting needs approval in every mode.
- The assistant is guided to work in this order: it looks at the data sources, writes the plan for you, tries the page before saving and tells you the values it found, saves, then opens the page in the main window. The page also appears in the Report pages list; if the list is already open click the Report pages tab once more (the list is refreshed).
- If the assistant wants to open a page while you have unsaved work in the editor, your work stays in place; the page is not opened.
- You can open a page the assistant built in the editor and correct it by hand; conversely, you can ask the assistant to change a page you built by hand.
Limits and permissions
| Panel count | At most 40 panels on a page. |
| Chart | At most 8 series are drawn; the rest are gathered into a single series or stay in the table (written below the chart). All series are on a single vertical axis. |
| Permission | Opening, running and downloading a page require Reports: View, editing and deleting it Reports: Manage. Each panel also requires the View permission of its own data source (alarm history → Alarms, data log → Data Logs, audit log → Audit log): a panel your permissions do not cover says "no permission" and the rest of the page fills. You cannot save a panel that uses a source you have no permission for. A user with restricted resource access sees only the data of the devices and counters they can access. |
| PDF font | Latin letters (Turkish included) are written in the PDF; scripts such as Arabic come out as "?", use Excel for those. |
Live board and wall display (live card)
A Live card is a panel on a report page that shows the current value of a metric in large type: below it how it is computed ("SUM · from 35 points"), behind it the trend line of the last two hours. The card refreshes every 2 seconds and is independent of the page's time range. By arranging several cards on a page and switching to Full screen you build a live board for a control room or a plant wall display.
Building a live board: step by step
- The values to be shown must be metrics. For the sum / average of several tags first build a metric with a tag set (Counters & Metrics → Metrics → Add from formula library → Live sum). To show a single tag, a metric that reads that tag is enough too.
- Plugins → Reports → Report pages → New report page; give the page a name (e.g. "Live board").
- In the right pane click Live card under Add a panel. The card is added 3 columns wide; four cards fit in a row.
- In the right pane select the metric from the Metric list (the list has the form group › name (unit) · instant / period; instant metrics are at the top). The card fills at once. If you leave Panel title empty the title shows the metric's name.
- To group cards put a Text panel between them and type a heading such as # Kuyular.
- If you enlarge a card from its bottom right corner the type grows too (on a wall display keeping the most important value at double width reads well). Press Save.
- Open the page and press Full screen in the top bar.
What does the card show?
| Large number and unit | The current value of the metric, with the decimal places and unit defined in the metric. |
| Bottom line | The calculation and the number of points: SUM · from 35 points, AVERAGE · from 8 points, MINIMUM, MAXIMUM, COUNT. If part of the set gives no value, from 34 of 35 points. For a formula with several inputs (e.g. the ratio of two sums) only the number of points is written. For a period metric the period comes first: Today · … |
| Top left | The metric's category (if any). |
| Badge (top right) | PARTIAL: some points in the set give no value; the result uses only those that do. ESTIMATED: the result contains an estimated share or a data gap (period metric). NO DATA: the metric cannot be computed right now (the card shows —). NOT FOUND: the metric has been deleted or you have no access to it. Hover over the badge for the reason. |
| Trend line | For an instant metric, the last two hours (one sample every 10 seconds). A break in the line shows there was no value at that time. The trend is in the server's memory: when the server restarts it accumulates from zero. For a permanent history add the _Metrics.<Kod> tag to the Historian and put a line chart panel next to it. |
Showing a period metric in the card
A period metric can also be selected in the card (e.g. total water supply). In that case a Period list appears in the right pane: This hour, Today, This week, This month, This year. The card shows the value so far of the current period (it grows during the day); the line behind it is the previous periods (last 48 hours, 30 days, 26 weeks, 24 months or 10 years).
Wall display (Full screen)
| Full screen | The page covers the whole window: the left menu, the top bar and the buttons are hidden; only the page name, the last refresh time of the live cards and the Exit button remain. If the browser allows it, real full screen is entered too. |
| Leaving | Esc or Exit at the top right. |
| Refresh | Live cards refresh by themselves every 2 seconds; the Refresh setting in the top bar concerns only the other panels (chart, table, single number, gauge). If the board also has panels such as a daily chart, set Refresh to 1 min or 5 min. |
| If the connection is lost | The last value in the cards stays on screen and the clock at the top right does not advance; when the connection returns it continues by itself. |
| Tab in the background | Refreshing waits while the browser tab is not visible. |
PDF, Excel and AI
| The card's value at that moment, its unit, bottom line and (if any) warning are written; the trend line is not drawn (it is a snapshot). | |
| Excel | Live cards are collected on a separate sheet named Live values: card, metric tag, value, unit, calculation, status and read time. |
| Assistant / MCP | You can ask the assistant for a live board: "Build a wall display that shows the live total flow, the total power and the number of running pumps of the wells". The assistant is guided to work in this order: it searches for the tags, builds the metrics with tag sets (create_metric_from_formula: LIVE_SUM, LIVE_AVG…), saves the page with save_report_page and opens it. For building, the Assistant may make changes setting must be on. run_report_page reads the current value of the cards and from how many points it was computed. |
Table report (build your own report)
The Table reports tab of the Plugins → Reports page in the left menu lets you build single-table reports from the records in the system (to see several charts, single numbers and tables on the same screen use the Report pages tab in the previous section). You build a report once; it is stored, fills with current data every time it is opened and is downloaded as Excel, PDF or CSV. If you wish you add a chart to the report and spread the values into side-by-side columns (details in the next section).
What is on the page?
| My table reports | The list of saved reports: name, data source, time range and type (List / Summary / Summary (pivot); a small chart icon for a report with a chart). Clicking a row opens the report below; clicking again closes it. |
| Excel, PDF buttons | Download the report with the data of that moment, without opening it. |
| Pencil, copy, trash can | Edit, make a copy (the quickest way to a similar report), delete. Deleting removes only the report definition; it does not touch the stored data. |
| Start from an example | Ready-made definitions of frequently requested reports. Clicking one opens the editor filled in; you change the name and the details to suit yourself and save. |
| The buttons above an open report | Refresh (fetches the data again), Download Excel, PDF, CSV, Edit. |
| The Period bar in an open report | You change the time range the report shows while the report is open: Last … hours, Last … days (a number is entered next to it), Today, Yesterday, This week, Last week, This month, Last month, This year, Last year, Date range. The two date boxes show the real start and end displayed by the table; when you change one the range automatically becomes Date range. The selection does not change the report and is also applied to the Excel / PDF / CSV output; you do not need a separate report for each period. Back to default returns to the saved period; Make this the report default writes the selection to the report. |
Data sources
| Live values | The current value, quality and read time of the tags you select (or of all tags of a device). There is no time range; the report is a snapshot of the moment it is opened. |
| Data log history | The values recorded by a log group. First you select the log group and, if you wish, tags from that group. With a summary table you get the hourly / daily average, minimum and maximum. |
| Alarm history, Active alarms | Alarms raised, cleared and acknowledged; those active right now. |
| Event log | System events: connection losses, driver warnings, errors. |
| Audit log | Who added, changed, deleted or wrote what, and when. |
| Counter period values | The hourly, daily, weekly, monthly or yearly consumption of counters. You select the Period size and, if you wish, the counters (if you select none, all are taken). |
| Metric (indicator) values | The values of metrics period by period (water footprint and water efficiency metrics included). At least one metric is selected. |
Opening, running and downloading reports need Reports: View; building, editing and deleting need Reports: Manage. To see a source you also need the View permission of that source (alarm history → Alarms, data log → Data Logs, audit log → Audit log, counters and metrics → Counters and Metrics). A source your permissions do not cover does not appear in the list. A user with restricted resource access sees only the records of the devices they can access.
Building a report: six steps
- Press New report (or select a ready-made example). Type the report name at the top; the name is shown in the list and in the downloaded file.
- 1 · Which data? Click one of the source boxes.
- 2 · Scope. The selections specific to the source (log group, tags, counters, period size) and the time range: today, yesterday, last N hours, last N days, this week, last week, this month, last month, this year, last year or between two dates. Ranges such as "this month" are recalculated according to the month of the day each time you open the report.
- 3 · Layout. There are two types:
List: each record is a row. You tick the columns to show, change their order with the arrows and, if you wish, retype their headers.
Summary table: groups the records and calculates. In the Group by section a field is selected (for a time field by hour, by day, by week, by month, by year); in the Calculate for each group section a calculation is selected: count, sum, average, minimum, maximum, first value, last value, number of distinct values. If you wish you spread a field into columns (next section). - 4 · Filter (optional): field + condition + value. Example: Event equals Raised, Value is greater than 100, Name contains pump. Text search ignores upper / lower case and the Turkish i / ı distinction. With several filters all of them must hold together.
- 5 · Chart (optional): explained in the next section.
- 6 · Sorting and output: the column to sort by and the direction, maximum rows, totals in the last row, landscape PDF.
- The Preview button runs the definition with current data without saving and shows the first 25 rows (and the chart, if any). If the result is as you expected press Save. If something is missing a red box says what must be corrected.
Downloading
| Excel | Numbers are written as numbers (they can be summed and charted in Excel); the title and range information are at the top. The chart is not added to the Excel file: in Excel you can select the table and draw it with Insert → Chart. |
| The chart, if any, is on the first page above the table. Headers are repeated on every page, long texts wrap within the row, and there are page numbers. A report with more than seven columns automatically becomes landscape. A table with too many columns to fit the page is split into column sections: the first column(s) are repeated in each section and the top of the page says which columns are shown, e.g. "Columns 2–14 / 40". | |
| CSV | A plain-text table; for transfer to other programs. |
Latin letters (Turkish included) are written in the PDF; scripts such as Arabic come out as "?", use Excel for those.
Limits and warnings
A report shows at most 50,000 rows and reads at most 200,000 records from the source in one run; if this is exceeded the report gives the warning "the result may be incomplete". For ranges with many records use a summary table or narrow the range. The totals row is not affected by the row limit: it counts the whole result.
list_reports, run_report) and, if the change permission is on, save and delete them (save_report, delete_report; deleting needs approval every time). The assistant returns the table; the chart and the file (Excel, PDF, CSV) are obtained from this page.Table report: side-by-side columns and chart
When a summary table is grouped by two fields (e.g. day and tag) every combination becomes a separate row and the list grows long. Spread into columns takes one of these fields out of the rows and moves it to the columns: each day becomes one row, each tag a column side by side. In a chart these columns are drawn as separate lines or column parts.
Spreading into columns (step by step)
- Edit the report and in the 3 · Layout step select Summary table.
- Group by: leave the field you want to see in the rows (usually Time).
- Calculate for each group: select the calculation to be written in the cells (e.g. Sum: Value or Count). A report spread into columns can have at most 4 calculations; a single calculation gives the most readable result.
- In the Spread into columns box select the field that will become columns (e.g. Counter, Name, Area, Level). If you select a time field its unit (by day, by month…) appears next to it.
- If you wish, tick A total column at the end of each row (it exists only for Count and Sum calculations; it is not shown for averages because a sum of averages would be misleading).
- Look at it with Preview.
| A missing combination | If that value has no record at all in that row the cell is empty; in a Count calculation it reads 0. |
| Column order | The spread values are sorted by name (from old to new if it is time). |
| Too many values | At most 120 columns are opened. If there are more distinct values the first 120 become columns and the report gives a warning; narrow it with a filter or move that field to the rows. The row total counts all values in any case. |
| Sorting | A report spread into columns can be sorted by the grouping columns and by the row total (e.g. row total, descending, for "the biggest consumer at the top"). |
Adding a chart
In the 5 · Chart step select a type. The chart is drawn above the report and goes into the PDF; the table below it carries the same numbers.
| Column | Compares values side by side (consumption by day, alarm count by area). |
| Stacked column | The parts are stacked; the height of the column is the total (daily alarm count, split by level). |
| Horizontal bar | Categories with long names and rankings (counter ranking, operations per user). With a single series the value is written at the end of the bar. |
| Line, Area | Change over time. On a time axis the points are placed according to real time; a period without data appears as a gap. |
| Share | A bar of a single value divided into percentages (e.g. the share of events by level). The 5 largest shares are shown separately, the rest as one part. |
- The horizontal axis is the grouping fields in a summary table (in the list type it is selected from the box).
- Values to draw: each calculation (or number column) you tick becomes a series. If you tick none, all are drawn; in a report spread into columns the first calculation is drawn and every spread column is a separate series.
- If you wish, type a chart title (it is good to put the unit in the title: "Daily consumption (m³)").
| At most 8 series | If there are more series: for calculations that can be summed (Count, Sum) the 7 largest series are drawn and the rest are gathered into a single series; for other calculations the first 8 series are drawn. This is written below the chart; all series remain in the table. |
| Single axis | All series are on the same vertical axis. Do not select values with different units (m³ and kWh, count and average) in the same chart; build a separate report. |
| Reading a value | When you hover over the chart all series of that category are shown in a box. The same numbers are also in the table below the chart. |
| Many categories | A column chart draws as many categories as fit the width, a horizontal bar about 20–30; for more a note appears below the chart. Enlarge the time unit (by day instead of by hour) or add a filter. |
Water Footprint
Plugins → Water Footprint. Saving a site profile generates the required metrics and manual inputs automatically; the page reads them.
| Blue water | Water withdrawn from sources (optionally withdrawn − discharged). |
| Green water | Rainfall (mm) ÷ 1000 × area (m²) × share used. |
| Grey water | The water needed to dilute the discharged pollution to the receiving-body limit. Per criterion: concentration × discharge ÷ (limit − natural concentration); the largest criterion is taken. |
| Total | The sum of the enabled components; with a production input, the footprint per unit of product. |
Period selection
The period is selected while the report is open; no separate profile or report is needed for each period. The Period bar at the top of the page has four options:
| Year | A calendar year, by month (each row is a month). Select the year from the list. |
| Month | A calendar month, by day (each row is a day). Select the month and the year from the lists. |
| Day | A day, by hour (each row is an hour). Select the day in the date box. |
| Custom range | Between two dates: the First day and Last day boxes. A Breakdown list appears next to them. |
- Press the Year, Month, Day or Custom range button in the Period bar.
- Select the period in the list / date box next to it. The left and right arrow buttons go to the previous and the next period (Previous year / Next year, Previous month / Next month, Previous day / Next day, Previous range / Next range).
- The This year / This month / Today button returns to the current period (in a custom range the range ends today with the same length).
- The cards show the total of the selected period; the chart and the table show the rows of the period (hour, day, month or year). The card heading states the selection: "2026 — by month", "March 2026 — by day", "12.11.2026 — by hour", "01.03.2026 – 15.04.2026 — by day".
- The four tabs (Summary, Blue water, Green water, Grey water) and the Report, Excel and CSV outputs follow the selection: what you see on screen is what is downloaded.
The breakdown in a custom range is chosen automatically: at most 2 days → hourly; up to 92 days → daily; up to 3 years → monthly; longer → yearly. You can change it among the suitable ones in the Breakdown list (Automatic, Hourly, Daily, Monthly, Yearly). At most 400 periods are shown in a report; if the breakdown you select exceeds this, the next larger breakdown is used and this is written next to the bar ("The selected range is too long for the hourly breakdown (at most 400 periods); switched to daily."). With a monthly or yearly breakdown the range is widened to whole months / whole years ("With a monthly breakdown the range is widened to whole months."); a half month is not shown.
The selection is shared by the Water Footprint, Water Efficiency and Water Flow Diagram pages and remembered in the browser: when you select March 2026 on one page and switch to another, the same period opens. Day and month boundaries follow the server's local time.
Which value is shown at which breakdown
Water measured by a counter is shown at every breakdown. A component that depends on a value entered monthly is not computed in daily and hourly rows and stays empty (—): the value is not spread over days or hours and not prorated. Hovering over the empty cell gives the reason; the information box at the top of the page names which components stay empty because of which input.
| Blue water (supply, discharge) | At every breakdown. A manual counter value entered monthly (an invoice) does not appear in daily and hourly rows; it is in the month's total and the information box says that "… m³ of the supply in the total could not be assigned to daily periods". |
| Green water | Rainfall is entered as a monthly total: it is computed for each month in the Year view and in the total of the Month view (cards, total row); it is empty in daily and hourly rows and in the total of the Day view. |
| Grey water | The analysis result (concentration) is entered monthly: the same rule as green water. A monthly concentration is not multiplied by a daily discharge. |
| Total water footprint | If green or grey water is enabled, the same as those: empty in daily and hourly rows (a total is not shown with a missing component). If only blue water is enabled it fills at every breakdown. |
| Per unit of product (m³ / unit) | If the production input is monthly it is empty in daily and hourly rows. If production is a manual input entered daily it is computed in the daily row. It is not shown in the total of a custom range (a ratio is not summed); it is shown when a single year or month is selected. |
Total row: while Year, Month or Day is selected it is the own value of that period (not the sum of the rows; it includes the rainfall, analysis and invoice values entered monthly). In a custom range it is the sum of the rows; if a row has no data the total is marked partial (◐). The estimated share and missing data marks are carried as they are at every breakdown.
Tabs: summary, blue, green, grey. Laboratory values, rainfall and area are entered in the boxes on the page. Report gives a printable output, Excel a multi-sheet workbook (summary, blue, green, grey), CSV a flat table. Clicking a number in the summary table opens what it is made of.
Water Efficiency
Plugins → Water Efficiency. Produces the tables and indicators required for water efficiency certification.
| Water sources | Mains, well, surface water, rainwater, recovered water, treated wastewater, sea water… Each row is bound to a counter or a counter selector. |
| Water uses | Core production, auxiliary operations, other; domestic use and water entering the product are flagged. |
| Wastewater | Points of origin, treatment outlet and discharge. |
| Indicators | Specific water consumption and use, specific wastewater, domestic water per capita, non-conventional source ratio (target ≥ 10%), recovery ratio (target ≥ 20%). |
Period selection
The Period bar at the top of the page is the same as in Water Footprint and the selection is shared: Year (by month), Month (by day), Day (by hour), Custom range (two dates + Breakdown). The arrow buttons go to the previous / next period; This year / This month / Today returns to the current period. If no period has been selected yet the page opens with the previous calendar year (the Ministry declaration is yearly); if that year is empty and the current year has data, the current year is shown.
- Select the period in the Period bar. The Indicators, Water sources, Water uses and Wastewater tabs show the whole of the selected period; the table heading states the period ("March 2026 — water sources").
- The last tab shows the rows of the period and its name tells the breakdown: Monthly, Daily, Hourly or Yearly.
- Report, Excel and CSV follow the selection; the monitoring table is added to the Excel file as a separate sheet.
| Water quantities (supply, use, wastewater, recovery) | In every period and at every breakdown, as measured. |
| Indicators divided by production (specific water consumption, specific water use, specific wastewater) | Production is entered monthly: they are computed when Year or Month is selected. When Day is selected and in daily / hourly monitoring rows they stay empty (—); production is not spread over days. The reason is written on the card and in the information box at the top of the page. |
| Ratios and domestic per-capita values | Because they are computed only from measured water they are shown when Year, Month or Day is selected. |
| Custom range | The tables are the sum of the selected periods. Ratio and specific indicators cannot be summed and are not computed ("Ratio and specific indicators cannot be summed: they are computed when a single year, month or day is selected."). |
| Certificate criteria, site target | The declaration is yearly: the met / not met assessment is made only in the Year view. In the other views the card reads "The target / certificate criterion is evaluated in the yearly view." |
| Production and personnel entry, yearly manual counter value (✎) | Only in the Year view. In the other views you read "Production (monthly) and personnel (yearly) are entered in the Year view: select Year in the period bar." |
If a row has no data the total is still computed but marked partial, and the empty rows are listed in a warning. The same counter cannot be used in two rows of one table (double counting).
Water Flow Diagram
Plugins → Water Flow Diagram. The site's water map: places (source, distribution, use, treatment, outlet) and the flows between them. Line thickness is proportional to the amount.
Setup takes three steps. (1) On the Counters page give your water counters their category: water production (production / supply), water consumption, wastewater (wastewater / discharge). (2) The Draft from my counters button creates the draft: production counters become sources, consumption counters uses, discharge counters outlets; the unmetered part is added as a computed flow and the assumptions made are listed in the window. (3) After saving, click a place or a flow on the diagram to change its name and counter, add new places and flows or delete them. The whole diagram is available as a table in Settings.
Place kinds
Every place has a kind. The five kinds are fixed: they are the same for every site and none can be added; you give the place any name you like. The kind determines only two things: in which column the place stands on the diagram (left to right) and the flow rule.
| 1. Source | Where water enters the site: mains, well, rainwater. It has outflows only; no flow can be connected into it. |
| 2. Distribution | Where water is collected or distributed: reservoir, tank, header, main line. Inflow and outflow are compared (balance). |
| 3. Use | Where water is used: process, cooling tower, boiler, housing, irrigation. If its outflow is not defined, all the water entering is treated as consumed. |
| 4. Treatment | Where wastewater is treated or recovered. A flow returning from here to distribution is drawn as a green arc on the diagram. |
| 5. Outlet | Where water leaves the site: discharge, evaporation, water in product, loss. It has inflows only; no flow can leave from here. |
The same guide is also at the top of the Places (the rectangles on the diagram) section of the Set up flow diagram window; in each row the description of the kind you selected is written below the kind. If you are not sure select Use; the kind can be changed later.
Flows and balance
| Measured flow | Bound to a counter or a counter selector. |
| Computed flow | Derived from the balance of a place (inflow − measured outflows): evaporation, loss, unmetered use. Drawn faint in the diagram. |
| Balance | At a place whose flows are all measured, inflow and outflow are compared; if the difference exceeds the tolerance (5% by default) that place gets a red frame and a warning is given. |
Period selection
The diagram shows the balance of a single period. In the Period bar at the top of the page select the period kind: Year, Month, Week, Day or Hour; select the period in the list / date box next to it (for Week a day within the week, for Hour the day and the hour). The arrow buttons go to the previous / next period; This year / This month / This week / Today / This hour returns to the current period. The period the diagram shows is written in the top line.
The selection is shared with the Water Footprint and Water Efficiency pages. Because the diagram shows a single period there is no Custom range here: if a custom range is selected on another page the diagram shows the month at the start of the range.
The Live button refreshes the current period every 15 seconds. In live mode the bar shows "now" (your saved selection does not change); when you go to another period with the arrows or the date box, live mode turns itself off. Changing the period kind and the shortcut button do not turn live mode off.
The tiles above the diagram are the summary of the period: water entering the site, recovered water, water consumed and leaving, and the difference between the two. Click a place or a band to see what goes in and out and which counter each number comes from (or how it is computed).
Water: adding a meter / point later
When a new well, mains connection, use, discharge or electricity meter comes to a site after setup, you do not have to create the counter by hand and wire it into the diagram and tables one by one: the Add meter / point wizard uses the same rules as the first setup.
Where to open it. Add point on the Water Flow Diagram and Water Efficiency pages; Add water point on the Counters and Metrics page; Add meter / point in Settings → Feature groups → Water Management.
- What are you adding? Water source, Use, Discharge or Electricity meter. With several sites, pick the one in Site.
- Point. Type the name (reports and the diagram use it). For a source pick its type (well, municipal mains…). How is it measured?: instantaneous flow / power, meter index, pulses or "not measured: I will enter it". If measured, Browse for the tag and choose its unit (m³/h, L/s, m³, kWh…); for pulses type the litres per pulse. For washrooms, showers or a canteen turn on Domestic use.
- Where to add it. Add to the water flow diagram: a source feeds the distribution, a use is fed from it, a discharge leaves the treatment. Add to the water efficiency profile: a row in the matching ministry table. The water footprint includes it automatically. Set up the missing indicator: kWh/m³ or the water loss ratio is created if the site lacks it. Electricity meters are not drawn on the diagram nor listed in the tables.
- Preview. On every change the server lists what will be created, what it will be added to and what uses it automatically; problems and warnings come first. The preview saves nothing.
- Add. The button is enabled only when the preview has no problem. The result lists what was done; then Open the water flow diagram or Add another point.
Connecting a meter to an empty place on the diagram
If you drew a place that has no counter yet (its flow selects an empty group; the diagram warns "no counter selected"), click that place or flow and press Connect a meter (wizard). The wizard opens with "Connect to the flow on the diagram" and the place's name; after Add no new place is created and that flow takes its value from the new counter. A flow that already reads a counter is never rebound.
| Same name | If the site already has a counter with that name the wizard refuses; choose another name or edit the existing counter. The same name in another site only warns. |
| Existing records | Existing places, flows and rows are neither removed nor changed. One exception: a water efficiency profile may have only one discharge row, so a discharge row bound to a single counter of the same group becomes that group's total when a second discharge is added. |
| Summing rows | If a diagram flow or profile row already sums the site's counters by category + group, the new counter joins it automatically and no separate flow is created (water is not counted twice). |
| Cannot add to the diagram | If the diagram has no distribution or treatment place the preview says so; turn off Add to the water flow diagram, add the point, and connect it on the diagram later. |
water.setup). If one is missing the wizard says which.Output Tags, OPC UA, AI and Portability
Every counter and metric also exposes its value as a tag. These tags are used like any other tag in alarm definitions, Historian groups, SCADA screens, Data Bridge agents and REST reads.
_Counters.<Kod> | Cumulative value. |
_Counters.<Kod>.Hour / .Day / .Week / .Month / .Year | Consumption of the current period. |
_Counters.<Kod>.PrevHour … .PrevYear | Consumption of the previous period. |
_Metrics.<Kod> | The current value of an instant metric; today's value of a period metric. |
_Metrics.<Kod>.Hour … .Year, .PrevHour … .PrevYear | The period metric's value for that period. |
OPC UA
The same outputs are published on the OPC UA server under the _Counters and _Metrics folders (the NodeId equals the tag path, data type Double). A new counter or metric appears within a few seconds; no restart is needed. An output without a value is published as NaN. Restricted OPC users see these folders only if granted.
AI assistant and MCP
Setting up and entering values. If the administrator has turned on the "Assistant may make changes" setting, the assistant can set up this module: setup_water_management (setup wizard; turns the feature group on if it is off), set_feature_group, create_counter, list_metric_formulas and create_metric_from_formula (an indicator from the formula library), set_counter_period_value, set_metric_input_value. Examples: "I have three wells, these are their tags; set up water tracking", "Add a pump efficiency indicator for Well 1", "The October mains invoice is 1,250 m³". Every write goes to the audit log. Deleting and changing an existing definition are done from the interface.
The assistant and external MCP clients use these read-only tools through the Counters / Metrics / Water management scope: list_counters, get_counter_periods, list_metrics, get_metric_series, list_water_reports, get_water_footprint, get_water_efficiency, get_water_flow. Example questions: "how much water was drawn from the well last month", "where is the recovery ratio against its target", "which node does not balance".
Backup and portability
Counter, metric and manual input definitions and the water profiles are included in the project bundle and in the configuration version history. Measurement history and manually entered values are not in the bundle (carrying another system's records would mislead); they are kept in the full backup. When you return to an earlier version, a deleted counter definition is reunited with its retained history.
MergenHub