Introduction

The network is not drawn separately: it is calculated from the assets already on the map. You say what role each layer plays and Maptainer joins the sections to the elements their ends touch. Whenever someone moves, adds or retires an asset of the network, that area is recalculated automatically.

Concept What it is
Network A set of layers that form a connected system: “Irrigation network”, “Street lighting”
Role What each layer does in the network: section, node, source, network end, operable device, barrier or inline branch
Section A line asset (pipe, channel, cable) that joins two points of the network
Junction without an element The point where two sections meet with no asset there: Maptainer creates it
Direction Which way the flow goes in each section: as drawn, or worked out from the sources
Network error Something that stops the network from being properly connected: a loose end, an unconnected element, opposing directions…
Trace A walk through the network from an asset: downstream, upstream or isolation
Outage A saved isolation, with its valves to close, the affected elements and its operation work order

These are the roles a layer can have:

Role What it is for Examples
Section Joins two nodes Pipe, channel, cable
Node Joins sections without stopping the flow Chamber, air valve, main meter
Source Where the flow comes from Canal intake, tank, reservoir, pumping station, control cabinet
Network end The flow arrives and goes no further Hydrant, outlet, drain
Operable device Can be opened or closed Gate valve, switch
Barrier Always stops the flow Cap, isolation joint
Inline branch Hangs from the section without splitting it Light point, service connection

Layers without a role are not part of the network: they stay ordinary assets.

Prerequisites

  • The Network topology module contracted. The Maptainer team enables it for your company.
  • The permissions of the Network topology group in Roles and permissions (Company administration):
Permission What it allows Who has it at the start
View See the networks, their direction and their errors Roles that can view assets
Edit Set up networks, rebuild them and fix errors Roles that can configure layers
Trace Upstream, downstream, isolation and operation work order Roles that can view assets

Note

Moving assets on the map does not need the network Edit permission. Fixing the network does: reversing directions, snapping ends or splitting sections changes how it is connected.

Setting up a network

A network comes out right first time if the mapping follows a few simple rules. If your data come from a well-kept GIS, checking them is enough; if they come from CAD or old plans, plan for a clean-up stage.

What your mapping must meet

  1. One layer per element type. Pipes in one layer, valves in another, hydrants in another. If your file mixes types in a single layer, split them before loading it.
  2. Section ends touch the elements. The end of a pipe must fall on its valve or chamber, not a few metres away. The Connection tolerance (m) forgives small gaps.
  3. Sections are split at every real node. A pipe cannot run over a valve without being split there: the valve would be “in the middle of a section”.
  4. Inline branches do not split. A light point or a service connection hangs from the section without splitting it: its layer has the Inline branch role.
  5. Each section is a single line. Multi-part sections are split.
  6. The sources exist as assets. Tanks, reservoirs or control cabinets can be points or polygons; sections that touch their edge are connected.
  7. The direction is consistent. If the network goes “as drawn”, each section is drawn in the flow direction. If you cannot guarantee it, use From the sources.

The order of work

  1. Load the layers with their assets (Layers and asset types).
  2. Create the network and give each layer its role (Creating a network).
  3. Click Save and recalculate and see how many errors come out.
  4. Review the errors on the map and fix first the ones that can be done in bulk.
  5. Fix what is left one by one.
  6. Structural problems (mixed layers, networks drawn without a rule) are better fixed in your GIS and loaded again.

Tip

If it is your first network, ask the Maptainer team for the prior diagnosis: we analyse your files before loading them and tell you what needs fixing.

Creating a network

Networks are set up in the administration area, under Networks.

The administration list of networks, with the irrigation network, its status and its open errors.
The administration list of networks, with the irrigation network, its status and its open errors.
  1. Open the administration area and go to Networks.
  2. Click New network.
  3. In Network details, enter the Name and the Code. The code cannot be changed later.
  4. In How it is calculated, choose the flow direction, the tolerance and how sections connect (How it is calculated).
  5. In Role of each layer, click Add layer for each layer of the network and choose its role (Role of each layer).
  6. For operable devices, fill in State field, Open values and Normal state.
  7. Click Save and recalculate.
The form of a network with the flow direction, the section connection and the role of each layer.
The form of a network with the flow direction, the section connection and the role of each layer.

Every field, section and counter has a ? button next to it. Click it to open a window that explains what it does.

A large network is recalculated in the background: the message “The network is large: it will be recalculated in the background in a few minutes” says so.

Note

If your company uses a sector template with a network (irrigation or street lighting), the network already exists with its roles when the module is enabled.

How it is calculated

This section decides which way the flow goes and how sections join the elements. If you change anything, the whole network is recalculated when you save.

Field What it does
Flow direction Which way water or current flows along each section. Upstream and downstream depend on it
Connection tolerance (m) Maximum distance at which a section end is considered joined to a node or to another end
Section connection How each section end is matched to a node
Fields with the start and end node code The two section fields holding the code of the node where it starts and ends. Only when connecting by codes
Active An inactive network is not calculated, does not appear in the map's networks menu and cannot be traced

The three Flow direction options:

Option How it is calculated For which networks
As drawn Each section runs from its first vertex to its last, in the order it was drawn. A section drawn backwards has its flow backwards Irrigation and sewerage
From the sources The network is walked from every source and each section is oriented as it is reached. Closed operable devices and barriers are not crossed. Whatever is not reached has no direction Water supply and power networks
No direction Only what is connected to what is calculated. Isolate works; upstream and downstream do not Any, to check connections

The Connection tolerance (m) forgives imprecise drawings. With 0.10 m, a pipe ending 5 cm from a chamber is connected to it; at 20 cm it is left as a loose end. If it is too high, things that are not joined may be connected, such as two parallel pipes very close together.

The two Section connection options:

  • By geometry: only the drawing counts. The end joins the nearest node within the tolerance. A point wins over a polygon: the outlet valve comes before the reservoir. A polygon counts if the end falls inside it or near its edge.
  • By node codes, otherwise by geometry: the Fields with the start and end node code of the section are read first. By default they are nudo_inicio and nudo_fin. The network node with that asset code is looked up, even if the drawing does not touch it. If the code does not exist, the “Node code that does not exist” error appears and geometry is tried.

If two loose ends are close together and there is no node, Maptainer creates a joint without a device between them: a splice without a chamber. An end that reaches nothing is a loose end.

Warning

When connecting by codes, the value of those fields is compared with the asset's Code. If you change the identifying fields of the node layer, its codes change and the sections can no longer find them.

Role of each layer

Each row gives a layer a role in the network. Layers not listed here are not part of the network. The columns are:

Column What it sets
Layer The asset layer. Sections must be a line layer; the rest are usually points or polygons (reservoirs, tanks, pumping stations)
Role What the layer does: section, source, operable device, node, network end, barrier or inline branch (Introduction)
State field Operable devices only. The layer field that says whether each valve is open or closed, for example estado
Open values Operable devices only. The values of that field that mean “open”, separated by commas, for example abierta, 1. Case-insensitive; any other value counts as closed
Normal state Operable devices only. The state used when the layer has no state field or the asset has it empty. Not set (open) takes it as open

As for the flow, sections, nodes and inline branches never cut it. An operable device cuts it only when closed, and a barrier always does.

Note

Opening or closing a valve from its card overrides the state field and the Normal state until you click Back to normal state (Valve state).

Network counters

When you open an existing network, its counters are shown at the top:

Counter What it counts
Sections The sections of the calculated network
Nodes All nodes: sources, operable devices, nodes, network ends, barriers and inline branches, plus joints without a device
Joints without a device The points where sections meet with no asset
Open errors Errors not fixed or ignored (Network errors)
Pending areas Areas with changed assets not yet recalculated. They recalculate on their own within seconds

Recalculating or deleting

  • Rebuild the whole network deletes the calculation and redoes it from the assets. Use it after a large load. Errors you marked as ignored and manual links are kept.
  • Delete network deletes the calculation (nodes, sections, errors and traces). The assets are kept.

Seeing the network on the map

  1. On the map, click the Networks: flow direction button.
  2. Choose the network. If you are too far away you will see “Zoom in to see the network”.

Arrows with the direction of each section appear over the layers, together with the junctions without an element, the closed valves and the errors. The map legend explains each symbol.

In the networks menu, each network with open errors has an orange counter, for example ⚠ 12. Click the name to turn the network on or off. Click the counter to open the Network errors panel; if the network was off, it is turned on as well.

The irrigation network on the map, with the flow direction arrows and the errors panel open.
The irrigation network on the map, with the flow direction arrows and the errors panel open.
On the map What it is
Arrow on the section The flow direction
Grey dashed section No direction: not reached from any source
Small grey dot Junction between sections without an element
Red dot Loose end
Large red ring Closed valve or switch
Orange ring Network error

The card of each network asset has a Network section with its role, the upstream and downstream sections, its errors and the trace buttons (Assets).

Network errors

Every time the network is calculated, Maptainer checks its connections and records the errors. A fixed error disappears on its own at the next calculation.

Error What it means
Loose end A section end touches nothing
Unconnected element A network element touches no section
Element in the middle of a section A valve or node sits on a section that is not split there
T-junction without a node A section ends on another one without the second being split
Opposing directions Two sections that meet carry the flow in opposite directions
Section with no source The section is not reached from any source
Node code that does not exist The start or end code of the section matches no element
Duplicate section Two sections take up the same place
Duplicate element Two elements of the same layer are in the same place
Multi-part section A section has separate parts: the network only uses the longest

Fixing an error

  1. In the map's networks menu, click the network's ⚠ counter. The Network errors panel opens.
  2. Filter by type if you like.
  3. Click an error: the map goes to it and marks it with a ring.
  4. Read the Recommended fix. Maptainer picks it by looking at what is around the error and explains why.
  5. Click the fix button or one of the Other options.
A network error with its recommended fix and the other options.
A network error with its recommended fix and the other options.
Fix What it does
Snap the end Moves the section end to the given node
Snap the sections of the junction Moves to an element all the sections that met where it used to be
Split the section here Cuts the section in two. Asks for confirmation with the metres of each part
Reverse the flow direction Turns the section round and, if the network uses codes, its codes too
Flip the drawing (the flow does not change) For a section drawn the wrong way round compared with its node codes
Write the node codes Corrects the start and end codes of the section
Split into one section per part Each part becomes a section
Keep one and deactivate the other For duplicates: the one with more work orders, issues or history is kept
Ignore: not an error For a false error, such as a real network end. Asks for the reason

When a section is split, the upstream part is still the same asset, with its work orders and history; the other is a new asset with the same data. When a duplicate is resolved, the other one is deactivated, not deleted, and its child elements move to the one that stays.

Bulk fix

For many errors of the same type, apply the recommended fix to all of them at once, with a preview.

  1. In the errors panel, click Bulk fix.
  2. Choose the Rule: snap loose ends, keep one of each pair of duplicates, fix opposing directions, use the node code or split multi-part sections.
  3. Adjust its options, such as the Maximum distance to the node (m) or Only pairs with the same code. With Only what is visible on the map it is limited to the current view.
  4. Click Preview. You will see how many errors of each type would be left, the list of fixes and, on the map, each section before (grey) and after (green).
  5. Click Apply N fixes (with the number of fixes in the preview).
The preview of a bulk fix with the errors before and after and the list of fixes.
The preview of a bulk fix with the errors before and after and the list of fixes.

Cases that do not fit the rule are left “to review by hand”. Splitting sections is never done in bulk: always one at a time and with confirmation.

To undo a batch, click Applied batches and Undo on the batch. Each asset goes back to how it was; anything someone changed afterwards is left alone, and you are told which ones.

Warning

If someone edits the network between the preview and applying it, you will see “The network has changed since the preview: preview again”. Preview again before applying.

Editing network assets

When you draw or move network assets on the map, the pointer snaps to nearby nodes so that the ends are joined exactly (Assets).

If you move an element that has connected sections, Maptainer asks “This element has connected sections”:

  • Yes, move them: the ends of its sections follow it.
  • No, only the element: the sections stay where they were and will show up as loose ends.

Traces

A trace walks the network from an asset and marks what it finds on the map. It is run from the Network section of the asset card, or by right-clicking the asset with the network switched on.

Trace What it shows
Downstream Everything that receives flow through the asset
Upstream Everything that feeds it, up to the sources
Isolate The valves to close to cut the flow at the point, and what is left without service

A closed valve or a barrier stops the walk.

Isolating a point

  1. With the network switched on, right-click the section or the element and choose Isolate this point.
  2. The panel shows the Route (the area that is isolated), what is To operate, the Affected elements and the boundaries that were already closed, with the metres of section and the affected customers.
  3. If a valve cannot be operated (it is seized or buried), untick it in Close to isolate: the next one is searched for.
The result of isolating a section: the isolated area in blue, the valves to close in red and the affected elements in orange.
The result of isolating a section: the isolated area in blue, the valves to close in red and the affected elements in orange.

The affected elements are everything that today receives flow from some source and stops receiving it with those valves closed. They can be more than what is downstream of the point: if the isolated area includes a junction, the other branches that leave it are left without service too.

Click Save trace to keep it.

Outage with an operation work order

  1. In the result of an isolation, click Create operation work order.
  2. The outage is saved and the work order form opens with the point and the valves to close already filled in. Complete it like any other order (Work orders).
  3. Once it is saved, the outage is planned.

The outage follows its order:

The order becomes… The outage The valves
In progress In progress Are closed
Paused Still in progress Stay closed
Completed, validated, closed or cancelled Finished Go back to their normal state

If someone closed one of those valves themselves in the meantime, it stays as they left it when the outage ends.

Valve state

Each operable device has a normal state, taken from its state field, and a current state. In the Network section of its card you will see Status with Open or Closed and, if it is not the normal one, which one is normal.

  1. Open the valve card.
  2. Click Close or Open.
  3. To return it to its normal state, click Back to normal state.
The Network section of a valve card with its state and the trace buttons.
The Network section of a valve card with its state and the trace buttons.

Each change is recorded with who made it and when. Closed valves are shown on the map with a red ring and stop traces.

Follow-up

Under Lists there are two network lists (Dashboard and lists):

  • Network errors: the open and ignored errors of all networks, with the reason for the ignored ones.
  • Network outages: the saved traces with their status, the valves to operate, the affected elements, the customers and their operation work order.

If your company connects Maptainer to another system, outages and valve operations can be notified by webhook and the network can be read through the API (ERP integration).

Common problems

Symptom Likely cause Solution
I cannot see the networks button on the map The module is not contracted or your role lacks View in Network topology Ask the administrator for the module or the permission
The network does not appear when switched on You are too far away Zoom in until “Zoom in to see the network” disappears
Hundreds of loose ends come out The tolerance is too small for your data or the ends do not touch the elements Raise the Connection tolerance (m) a little and use Bulk fix
A valve shows as “in the middle of a section” The pipe runs over the valve without being split Apply Split the section here
All sections come out without direction The network is calculated from the sources and there are no sources, or they are disconnected Add the sources or connect them
Isolating gives many affected elements The isolated area includes a junction that other branches leave from That is correct; check whether a valve is missing from the mapping
A fixed error is still on the list The network has not been recalculated in that area yet Wait a minute or click Rebuild the whole network

Last updated: