Water Distribution - Leakage Backoffice User Manual¶

Configuration area for the Water Distribution Leakage module

Content under validation

This manual describes the Water Distribution - Leakage module and has not yet been validated against the released application. Screens, workflows, and terminology may still change before the final review is complete.

1. Introduction¶

1.1 Application structure¶

The application is organized into two main areas: Leakage and Leakage Backoffice.

Leakage is the operational area where users review network status, time series, alerts, and events. It is documented separately in the Water Distribution - Leakage manual. Leakage Backoffice is the configuration area where administrators set up connectors, time series, map objects, regional areas, and DMA and KPI settings, and it is documented on this page.

1.2 User roles¶

The system contains three main user roles.

System Admin - full administrative access, including all Backoffice functions.
Organization Admin - administrative access within the assigned organization, including Backoffice functions.
Standard User - regular operational access to the user area. Standard Users cannot access Backoffice.

2. Common user interface elements¶

2.1 Top bar overview¶

The upper bar is present across the whole application, on every page and in every area.

It provides navigation between applications, regions, and user profile settings, and it stays visible while the user works in the map, tables, or charts below it.

[Figure 1. Top bar of the application.]

The logo is located in the upper left corner of the top bar.

Clicking the logo takes the user back to the main landing page, regardless of which area or tab is currently open.

2.3 Application selector¶

Next to the logo there is the current application name, which opens the application selector menu when clicked.

This menu lists every application area available to the logged-in user and allows the user to move between them without logging out.

[Figure 2. Application selector menu.]

2.4 Region selector¶

Next to the application selector there is a region selector.

If more than one region is assigned to the user, the active region can be changed here. If only one region is available, the selector is disabled and shown in a greyed-out state.

2.5 Organization name¶

The name of the organization for the currently logged-in user is shown in the upper right area of the top bar.

This label is informational only and cannot be clicked to change the organization.

On the far right there is the user profile button, which opens the user profile menu when clicked.

From this menu the user can open the profile page, enter Leakage Backoffice if access is available, change the interface language, change the theme, or log out.

[Figure 3. User profile menu.]

2.7 User profile page and password change¶

The Profile option opens the user profile page, which shows the account name, email address, organization, and assigned role.

The password change action is opened from this page. The user enters the new password and confirms it before saving.

[Figure 4. User profile page and password change window.]

If the logged-in user has the required rights, an option to enter Leakage Backoffice is visible in the profile menu.

Selecting this option switches the interface from the user-facing area to the configuration area.

2.9 Language selection¶

The Language option opens a list of the interface languages available in the current deployment.

Selecting a language applies it to the interface immediately, without reloading the page.

[Figure 5. Language selection menu.]

2.10 Theme selection¶

The Theme option allows the user to switch between Light, Dark, and System.

The System option follows the operating system theme settings of the device in use.

[Figure 6. Theme selection menu.]

2.11 Logout¶

The Logout option is the last item in the profile menu.

Clicking it ends the current session and signs the user out of the application.

3. Leakage Backoffice overview¶

3.1 Who can work in Leakage Backoffice¶

Leakage Backoffice can be accessed and modified only by Organization Admin and System Admin users. Standard Users do not have access to this area.

Leakage Backoffice navigation is displayed on the left side of the screen.

The available tabs are listed below in the order in which they appear in the sidebar:

Connectors
Time Series Categories
Time Series Groups
Time Series Sources
Map Objects
Regional Areas
DMA and KPI Configuration
Category Details
WMS
Recalculation

[Figure 7. Leakage Backoffice navigation sidebar.]

4. Connectors¶

4.1 Purpose of the Connectors tab¶

The Connectors tab configures the connection to a data source used by the Leakage module.

A connector is either a MIKE Cloud service connection or a connection to a local file system where the application is hosted, and it must exist before a time series source, a GIS layer, or a map object can reference it.

4.2 Connectors table¶

The table lists every configured connector.

Columns are Name, Connector type, and ConnectionString, which shows the connector's Service url or Base path depending on its type.

Name
Connector type
ConnectionString

[Figure 8. Connectors list.]

4.3 Create a connector¶

Clicking Create opens a form with a Name field and a Connector type dropdown.

The available connector types are read from the system and currently include MIKE Cloud and File System.

[Figure 9. Create connector window.]

4.4 Create a MIKE Cloud connector¶

When Connector type is set to MIKE Cloud, the form requires a Service url, which defaults to the standard MIKE Cloud API address, and an API key.

Both fields must be filled before the connector can be saved.

4.5 Create a FileSystem connector¶

When Connector type is set to File System, the form requires a Base path.

If the entered path contains white space, the form shows a helper warning asking the user to confirm the path is correct.

[Figure 10. Create FileSystem connector window.]

4.6 Edit a connector¶

The row menu opens Edit, where Name and Connector type can both be changed, along with the type-specific fields.

A red warning is shown above the form stating that irresponsible editing of the connector may cause problems with all related resources.

[Figure 11. Edit connector window.]

4.7 Delete a connector¶

The row menu also offers Delete, which opens a confirmation asking the user to confirm deletion of the named connector.

Removing a connector can affect any GIS layer, time series source, or map object that still references it.

5. Time Series Categories¶

5.1 Purpose of the Time Series Categories tab¶

The Time Series Categories tab manages named categories that group time series across different time series groups for reporting and filtering purposes.

A category itself does not store data; it only holds a name and a list of the time series assigned to it.

5.2 Categories panel and list¶

The left panel lists every category by name above a Create button, with an information icon that explains how categories are used.

Each category row has a context menu with Edit and Delete, and clicking a row selects it and loads its assigned time series below.

[Figure 12. Categories panel.]

5.3 Time series table for the selected category¶

Selecting a category shows a read-only table of its assigned time series, with Name, Unit, and Type columns.

This table only reflects the current assignment; series are added to or removed from the category through the Edit Time Series action, which opens the Category Details view.

Name
Unit
Type

[Figure 13. Category time series table.]

5.4 Create, edit, and delete a category¶

Clicking Create opens a form with a single required Name field for the new category.

The row context menu's Edit action reopens the same field pre-filled, and Delete opens a confirmation naming the category before it is removed.

[Figure 14. Create category window.]

5.5 Edit time series assignment¶

An Edit Time Series button appears above the table once a category is selected.

Clicking it opens the Category Details view described later in this manual, scoped to the selected category, where series are checked or unchecked and saved.

6. Time Series Groups¶

6.1 Purpose of the Time Series Groups tab¶

The Time Series Groups tab manages named groups that bundle related time series which can originate from different connectors and sources.

After a group is created, one or more sources are added to it, and each time series in the group can be given a custom name, unit, offset, and scale.

6.2 Groups panel¶

The left panel lists all groups by name and shows a Create button.

Each group row has a context menu with Edit and Delete.

[Figure 15. Time Series Groups panel.]

6.3 Time series table for the selected group¶

Selecting a group shows a table of its time series with editable Name, Unit, Offset, and Scale columns.

Offset is entered as a time span and is applied to shift the series in time, and Scale is a numeric multiplier between 0.01 and 1,000,000,000 applied to every value of the series.

Name
Unit
Offset
Scale

[Figure 16. Time Series Groups table.]

6.4 Create or edit sources¶

Once a group is selected, a Create or edit sources button appears above the table.

Clicking it opens the Time Series Sources view scoped to the selected group.

6.5 Save changes to the group¶

A Save button appears once a pending edit exists in the table and is disabled while the change is being submitted.

Saving applies the updated names, units, offsets, and scales to the group.

6.6 Create a time series group¶

Clicking Create opens a form with a single required Name field.

Confirming the form adds the new, empty group to the list.

[Figure 17. Create time series group window.]

6.7 Edit or delete a group¶

Edit opens a form with the Name field pre-filled so it can be renamed.

Delete opens a confirmation naming the group; deleting the currently selected group clears the selection afterward.

7. Time Series Sources¶

7.1 Purpose of the Time Series Sources tab¶

This view is reached from a selected group by clicking Create or edit sources, and it defines the physical data sources that supply that group with time series.

Each source combines a data connector with a connection string, and the time series it exposes can be picked into the parent group.

7.2 Sources panel and table¶

The left panel lists sources by name with a Create button and a context menu offering Edit and Delete for each source.

Selecting a source shows a table of its available time series with a read-only Name, and editable Custom name, Unit, Offset, and Scale columns, a read-only ConnectionString column, and a checkbox on each row to include that series in the group.

Name
Custom name
Unit
Offset
Scale
ConnectionString

[Figure 18. Time Series Sources view.]

7.3 Create a source¶

Clicking Create opens a form requiring a Name, a Data connector selected from the existing connectors, and a Connection string.

The Connection string value depends on the connector type: a folder name for a local connector, or a location identifier for a cloud connector.

[Figure 19. Create source window.]

7.4 Edit a source¶

The Edit form lets the Name, Data connector, and Connection string be changed, and shows a red warning that changing the source's data connector will delete all time series from the application.

If the data connector is changed and saved, the previously selected series for that source are cleared and the available series list is refreshed from the new connector.

7.5 Delete a source¶

The row menu offers Delete, which opens a confirmation dialog before removing the source.

Deleting a source also removes its series from the parent group.

7.6 Select time series and save¶

Checking rows in the series table marks them for inclusion in the group, and unchecking removes them.

The Back button returns to the Time Series Groups view, and Save commits the current selection to the group.

8. Map Objects¶

8.1 Purpose of the Map Objects tab¶

The Map Objects tab configures the individual points shown on the Leakage Status map, such as flow meters, reservoirs, and valves, together with the GIS layers displayed alongside them.

Each map object can be linked to a status time series and to one or more alarms that watch that time series for threshold breaches.

8.2 Map Objects panel and list¶

The left panel has Create, Batch Upload, and Batch Delete buttons above a Filter field that searches by name.

Below the filter, a Map Points accordion lists every map object with its shape icon and a context menu offering Edit and Delete, and a separate GIS Layers accordion lists the configured map layers with visibility toggles and their own Edit and Delete actions.

[Figure 20. Map Objects panel.]

8.3 Map view¶

The main area shows an interactive map with every map object plotted using an icon for its shape, together with any GIS layers currently made visible from the panel.

Clicking a map object in the list highlights it on the map and opens its details panel, and the same happens in reverse when a marker is clicked on the map.

[Figure 21. Map Objects map view.]

8.4 Create a map object¶

Clicking Create opens a form with an Object type dropdown offering Map object and GIS layer, with Map object selected by default.

For a map object, the form asks for a Name, Lng and Lat fields with a map-pin button that opens a small map popover to pick the coordinates by clicking on the map, a Shape dropdown offering Flow, Reservoir, and Valve, and a Use control checkbox.

[Figure 22. Create map object window.]

8.5 Create a GIS layer¶

When Object type is set to GIS layer, the form instead asks for a Name, a Description, an SRID when the file type is GeoJSON, a Data connector, a Connection string, and a File type dropdown offering GeoJson and Shapefile Zip.

A file picker accepts the matching file for the selected type, and a Download Template link provides a sample file in the expected format.

[Figure 23. Create GIS layer window.]

8.6 Edit a map object¶

The Edit form repeats the Name, Lng and Lat, and Shape fields, and adds Threshold High, Threshold Low, Pre time, Post time, a Status Time Series dropdown, and the Use control checkbox.

Pre time and Post time extend the alert window before and after a threshold breach, and Status Time Series selects which of the object's available time series is monitored on the Status map.

[Figure 24. Edit map object window.]

8.7 Batch upload and batch delete map objects¶

Batch Upload opens a form to select a GeoJSON file, with a Download Template link and a message reporting how many of the objects found in the file are valid; Confirm stays disabled until the file passes validation.

Batch Delete opens a paged table listing every map object by Name with checkbox selection; the confirm action is disabled until at least one row is checked and removes all the checked objects at once.

Name

[Figure 25. Batch upload map objects window.]

8.8 Map object details panel¶

Selecting a map object opens a details panel on the right with Properties, Time Series, and Alerts tabs.

The Properties tab lists the object's own data such as name, coordinates, shape, and thresholds, using the same values entered on the Edit form.

[Figure 26. Map object details panel.]

8.9 Object time series tab¶

The Time Series tab lists the status time series already available to the object, with Name, Unit, and ConnectionString columns, and an Add Time Series button above the table.

Add Time Series opens a picker to add further series from the configured sources to the object's available list.

Name
Unit
ConnectionString

8.10 Object alerts tab and alarm management¶

The Alerts tab shows a table of the object's alarms with Name, Type, Pre time, Post time, Threshold High, Threshold Low, and Is Active columns, plus an Add button above the table.

Creating or editing an alarm asks for a Name, a Time series dropdown grouped by source, a Type dropdown, Pre time and Post time, Threshold High and Threshold Low, an Is Active checkbox, and a Description, and the row menu's Delete action opens a confirmation before removing the alarm.

Name
Type
Pre time
Post time
Threshold High
Threshold Low
Is Active

[Figure 27. Object alerts tab.]

9. Regional Areas¶

9.1 Purpose of the Regional Areas tab¶

The Regional Areas tab organizes the configured DMAs into a hierarchy of areas and zones, used to group them geographically for the Status and Events views.

The hierarchy is built and reordered in a file explorer style tree on the left, next to a map that shows the corresponding polygons.

9.2 File explorer tree¶

The left panel shows a toolbar with Create and Save buttons above a tree of areas, zones, and DMAs, each with a checkbox and, for areas and zones, a delete icon shown on hover.

Items are reorganized by dragging them onto another area in the tree; a DMA or zone can only be dropped onto an item of type area.

[Figure 28. Regional Areas file explorer.]

9.3 Create a regional area¶

Clicking Create opens a form with a single required Name field for the new area.

The new area is added at the top level of the tree and can then have zones or DMAs dragged into it.

[Figure 29. Create regional area window.]

9.4 Select multiple DMAs by drawing a polygon¶

The Select Multiple button switches the map into selection mode and shows an on-screen banner explaining that a single click places a point of the selection polygon and a double click completes it.

Every DMA whose location falls inside the completed polygon is added to or removed from the current selection, and the button is used again to leave selection mode.

[Figure 30. Draw selection polygon banner.]

9.5 Map view¶

The main area shows an interactive map with the polygons of the configured regional areas and DMAs, colored to distinguish selected items from the rest.

Hovering an item in the tree highlights the matching polygon on the map, and hovering a polygon highlights the matching row in the tree.

[Figure 31. Regional Areas map view.]

9.6 Save or discard changes¶

The Save button in the toolbar stays disabled until the tree has been changed, for example by creating an area or dragging an item to a new position.

Saving applies the current hierarchy to the server; leaving the tab without saving discards any pending reorganization.

9.7 Delete an area or zone¶

Hovering an area or zone row reveals a delete icon that removes it from the tree.

Deleting an area or zone does not delete the DMAs it contained; they remain available to be placed elsewhere in the hierarchy.

10. DMA and KPI Configuration¶

10.1 Purpose of the DMA and KPI Configuration tab¶

This tab configures the District Metered Areas, DMAs, used throughout the Leakage module, along with the global settings that drive their key performance indicators.

Each DMA combines a geographic polygon, inflow and outflow time series, a set of physical and economic parameters, and its own event detection thresholds.

Above the map and table, a toolbar shows the District Metered Areas title next to Upload, Multipliers, Units and Limits, and Global DMA buttons.

These four buttons open, respectively, the DMA upload form and the Multipliers, Units and Limits, and Global DMA Settings windows described further below.

[Figure 32. DMA and KPI Configuration toolbar.]

10.3 Map and DMA table¶

The upper half of the view shows a map with every DMA polygon, and double-clicking a row in the table below zooms the map to that DMA's extent.

The table lists Visible, Name, Inflow Ts, Outflow Ts, Night Window, Night Consumption Config, Use Seasonality, and Last Updated columns, with a row menu offering Edit and Delete.

Visible
Name
Inflow Ts
Outflow Ts
Night Window
Night Consumption Config
Use Seasonality
Last Updated

[Figure 33. DMA table and map.]

10.4 Upload DMAs¶

The Upload button opens a form with an SRID field, required for GeoJSON files, a GIS file type dropdown offering GeoJson and Shapefile Zip, and a file picker matching the selected type.

Confirming the form imports the DMA polygons found in the file.

[Figure 34. Upload DMA window.]

10.5 Edit a DMA, General and Time Series tabs¶

Edit opens a tabbed form; the General tab holds the Name field and an Is Active checkbox, and the Time Series tab holds an Inflow Time Series field and an Outflow Time Series field, each a multi-select built from the configured time series tree.

Both time series fields accept more than one series so that a DMA's total inflow or outflow can be built from several sources.

[Figure 35. Edit DMA window, General tab.]

10.6 Edit a DMA, DMA Settings tab¶

The DMA Settings tab holds the physical and billing parameters of the DMA: Start and End of night flow, Service connections houses, Total length of main pipe, Total length of service connections, Average pressure, Water production cost, a Night consumption input mode switch, Billed amount, Special user night consumption, Number of special users, Apparent losses, and Unbilled authorized consumption.

When Night consumption input mode is off, a single Night consumption field is required; when it is on, Total zone population and Residential night consumption are required instead, and a Use Seasonality checkbox is also available on this tab.

[Figure 36. Edit DMA window, DMA Settings tab.]

10.7 Edit a DMA, Event Settings tab¶

The Event Settings tab holds Min event, Big event, Min leakage, and Leak check range, which control how the DMA's inflow and leakage values are classified into the event types shown later in the Events tab.

Save applies both the DMA record and its event settings together; the form's Save button stays disabled until all required fields are valid.

10.8 Delete a DMA¶

The table row menu offers Delete, which opens a confirmation showing the DMA's name before it is removed.

10.9 Multipliers window¶

The Multipliers button opens a tabbed window with Months, Week Days, and Special tabs, each showing a Type and Multiplier table.

The Months and Week Days tabs hold one editable multiplier per month or weekday, and the Special tab lets the user add rows with a date picker and a multiplier, and delete existing rows; Save is disabled while any two special days share the same date.

Type
Multiplier

[Figure 37. Multipliers window.]

10.10 Units and Limits window¶

The Units and Limits button opens a window with a KPI table, a color settings table, and an economy section.

The KPI table has Visible, KPI name, Unit, Limit 1 Warning, and Limit 2 Critical columns for each KPI type, the color settings table assigns a color to each threshold level, and the economy section holds a Currency dropdown and a Production cost per m3 field expressed in the selected currency.

Visible
KPI name
Unit
Limit 1 Warning
Limit 2 Critical

[Figure 38. Units and Limits window.]

10.11 Global DMA settings¶

The Global DMA button opens a form with the same fields as the DMA Settings and Event Settings tabs of the Edit DMA form, used to define the default values applied when a new DMA does not yet have its own configuration.

Saving updates the shared defaults used across all DMAs that have not overridden them.

[Figure 39. Global DMA settings window.]

11. Category Details¶

11.1 Purpose of the Category Details view¶

This view is reached from Time Series Categories by selecting a category and clicking Edit Time Series, and it is used to choose which time series belong to that category.

A category can gather series from any time series group, so its members do not have to come from the same group or source.

The left panel is labelled Categories / Groups and lists every configured time series group by name.

Selecting a group loads its time series into the table on the right without leaving the current category.

[Figure 40. Categories / Groups sidebar.]

11.3 Time series table for the selected group¶

Once a group is selected, a table lists its time series with checkbox selection, showing Name, Unit, Offset, and Scale.

Checking a row adds that series to the category being edited, and unchecking it removes the series from the category.

Name
Unit
Offset
Scale

[Figure 41. Time series table for category assignment.]

11.4 Save and back¶

Back returns to the Time Series Categories tab without saving any change made in this view.

Save submits the current set of checked series as the members of the category and returns to the Time Series Categories tab.

12. WMS¶

12.1 Purpose of the WMS tab¶

The WMS tab configures external Web Map Service sources whose layers can be displayed on the Leakage Status map alongside DMAs and map objects.

Each source points to a WMS service url and holds the specific layers selected from that service's capabilities.

12.2 WMS sources table¶

The table lists every configured source with Name and Url columns, a Selected Source Layers column showing the number of layers chosen from that source, and a row action menu with Edit and Delete.

Hovering the layer count shows a tooltip listing the title of every selected layer, or a message that no layers are assigned.

Name
Url
Selected Source Layers

[Figure 42. WMS sources table.]

12.3 Create a WMS source¶

Clicking Create opens a two-step wizard; the first step asks for a Name and a Url for the WMS service.

The second step reads the service's capabilities and lists its available layers as a checklist with title and description; at least one layer must be selected before the source can be saved.

[Figure 43. Create WMS source window.]

12.4 Edit a WMS source¶

Edit reopens the same two-step form with the Name, Url, and previously selected layers pre-filled.

Changing the Url refreshes the list of available layers read from the new service.

12.5 Delete a WMS source¶

The row menu's Delete action opens a confirmation before removing the source and its layer selection.

13. Recalculation¶

13.1 Purpose of the Recalculation tab¶

The Recalculation tab lets an administrator trigger a manual recalculation of KPI values for one or more DMAs over a chosen period.

This is used after configuration changes, such as edited DMA settings or corrected time series, to bring stored KPI values up to date without waiting for the next scheduled run.

13.2 Recalculation form¶

The form holds a Start time and an End time date field, a mode choice between Single DMA and All DMAs, and, when Single DMA is selected, a DMA multi-select listing the configured and active DMAs.

The Calculate KPIs for a Period button starts the recalculation and stays disabled while a run is already in progress or, in Single DMA mode, until at least one DMA is chosen.

[Figure 44. Recalculation form.]

13.3 Recalculation log¶

Below the form, a log panel streams status messages for the running recalculation as they arrive.

The log is cleared automatically when a new recalculation is started.