Merge pull request #277 from urskaufmann/main

Corrections user-guide

docs/en/user-guide/editing/maintenance_events.rst

@@ -12,8 +12,6 @@ General
 * Maintenance events can be connected to one structure or to many.
   Therefore TWW uses a intermediary RE_table to model the n:m relationship (**re_maintenance_event_wastewater_structure**)
 
-* To avoid an error when adding a new Maintenance Event, you have to enable **Buffered Transaction Groups** in menu Project > Transaction mode
-
 
 Adding a new Maintenance Event
 -------------------------------------------------------------
@@ -71,5 +69,4 @@ Editing
 Multi Edit
 -----------------------------------------------------------
 
-There is in the moment no tool to create or to link a maintenance event to a selection of reaches or wastewater structures. If you open the form in multi edit mode, the **Maintenance** tab is empty.
-Multi edit with linked tables is not implemented in QGIS.
+Multi edit with linked tables is implemented in QGIS. It is possible to create or to link a maintenance event to a selection of reaches or wastewater structures im multiedit-mode.

docs/en/user-guide/layerexplanations/layerexplanation.rst

@@ -8,10 +8,10 @@ Main layers
 
 TWW is constructed around two main layers :
 
- * Wastewater structures ``tww_od.vw_tww_wastewater_structure``
- * Reaches ``tww_od.vw_tww_reach``
+ * Wastewater structures ``tww_app.vw_tww_wastewater_structure``
+ * Reaches ``tww_app.vw_tww_reach``
 
-Wastewater structures ``tww_od.vw_tww_wastewater_structure``
+Wastewater structures ``tww_app.vw_tww_wastewater_structure``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Main layer for manholes, special structures, infiltration installations, discharge points (and wastewater treatment plant (wwtp) structure). Creating a new record in this layer always creates a new wastewater structure, a new cover and a new wastewater node. In the edit form, you have access to a lot of the related tables (e.g. structure parts, maintenance events).
@@ -22,7 +22,7 @@ Even if there are several covers or wastewater nodes, there is just one point fo
 
 .. attention:: Do not export this point coordinates as covers. Use the layer vw_cover for this.
 
-Reaches ``tww_od.vw_tww_reach``
+Reaches ``tww_app.vw_tww_reach``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Main layer for line-wastewater structures (channels). Creating a new record in this layer always creates a new reach and a new channel. In the edit form, you have access to a lot of the related tables (e.g. structure parts, maintenance events).
@@ -32,49 +32,38 @@ Main layer for line-wastewater structures (channels). Creating a new record in t
 Wastewater Structures
 ---------------------
 
-Wastewater Structures Details ``tww_od.wastewater_structure``
+Wastewater Structures Details ``tww_app.wastewater_structure``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 This layer shows and enables you to edit the detailed geometries of wastewater structures. You can add a new detailed geometry using the layer `vw_tww_wastewater_structure` action called digitize detailed geometry.
 
 See `digitizing detailed geometries <../digitizing/digitizingdetailedgeometry.html>`_ for more information.
 
-Structure Parts ``tww_od.structure_part``
+Structure Parts ``tww_app.structure_part``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Cover is the only structure part with a point-geometry itself. All other structure parts are just linked to their wastewater structures and should by only edited by the main layers (`vw_tww_wastewater_structure` and `vw_tww_reach`).
 
-Covers ``tww_od.vw_cover``
+Covers ``tww_app.vw_cover``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Use this layer to change the situation of some specific cover (and not the whole wastewater structure) or to add a new cover to an existing wastewater structure. You can add an additional covers in the covers-tab of the `vw_tww_wastewater_structure` too. Additionally, use this layer to show the detailed position of the covers (e.g. in network_plan or pipeline_registry) or to export the cover positions `situation_geometry`.
 
-Channels ``tww_od.vw_channel``
+Channels ``tww_app.vw_channel``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The channel-class has no geometry and is therefore mostly changed in the vw_tww_reach layer.
 
 Organisations ``tww_od.organisation``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-od_organisation contains the organisation that you can select in attributes like fk_dataowner, fk_operator, fk_provider, fk_owner, etc.
+organisation contains the organisation that you can select in attributes like fk_dataowner, fk_operator, fk_provider, fk_owner, etc.
 
  .. figure:: images/od_organisation.jpg
 
 This table is today a little bit hidden in the wastewater_structures group (but it is not only related to wastewater structures).
 
-If you want to export data to the VSA-DSS 2015 model, you have to manually add the relation to the respecitve subclasses of organisation by adding the respective obj_id's in the subclass tables, e.g. municipality, else the export will give an error message. For export to SIA405_Abwasser and VSA-KEK this is not needed.
-
- .. figure:: images/od_organisation_postgres.jpg
-
- .. figure:: images/subclass_entries_organisation_od_municipality_postgres.jpg
-
- .. figure:: images/interlis_export_class_organisation_subclass_checkjpg.jpg
-
- Alternative: You can use vw_organisation instead of od_organisation. vw_organisation has the subclasses integrated and must be loaded manually to the project.
-
-
-Maintenance events ``tww_od.vw_tww_maintenance``
+Maintenance events ``tww_app.vw_tww_maintenance``
 --------------------------------------------------
 
 Maintenance events can be created through the view tww_od.vw_tww_maintenance.
@@ -91,24 +80,24 @@ These value lists are defined in the VSA-datamodel. Do not change.
 Hydraulic
 ---------
 
-Wastewater nodes ``tww_od.vw_wastewater_node``
+Wastewater nodes ``tww_app.vw_wastewater_node``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Use this layer to change the situation of one selected wastewater node (and not the whole wastewater structure) or if you want to add a new wastewater node to an existing wastewater structure. You can add additional wastewater nodes in the wastewater nodes-tab of the `vw_tww_wastewater_structure` too.
 
-Overflow tables ``tww_od.vw_tww_overflow``
+Overflow tables ``tww_app.vw_tww_overflow``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 These tables are connected to wastewater nodes. In the project-file template (Version 8.0, 4.6.2020) are no relations defined for these tables.
 
 Topology
 --------
 
-Nodes ``tww_network.node`` and segments ``tww_network.segment``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Nodes ``tww_app.vw_network_node`` and segments ``tww_app.vw_network_segment``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 These two layers are used by the tww-extension for the profile and the network-following functionalities.
-Use the tww_network.segment layer to show the flow direction, if you use a markerline (filled_arrowhead) as symbol.
+Use the tww_app.vw_network_segment layer to show the flow direction, if you use a markerline (filled_arrowhead) as symbol.
 
 See `connect wastewater network elements <../editing/connect_wastewater_network_elements.html>`_ for more information on how to create and maintain a good Topology.
 

docs/en/user-guide/layerexplanations/namingconventions.rst

@@ -3,34 +3,35 @@ Naming conventions
 
 Schemas in the TWW-Database
 ----------------------------
-The TWW-Database has six tww-schemas:
+Schema in TEKSI-Databases will follow all the same rules. To destinguish, every infrastructre has his own shortcut (3 letters). TWW (TEKSI wastewater) is the shortcut for module wastewater network management.
+The TWW-Database has five tww-schemas:
 
-* tww_od: in this schema you find the tables, that correspond to the VSA-DSS-datamodel (cover, wastewaternode, channel, etc.) These are the tables you normally work with.
+* tww_od: in this schema you find the tables, that correspond to the VSA-DSS-datamodel (cover, wastewater_node, channel, etc.) Also for sequences of these tables. Because of the new update-management, the views are no more in the *_od-schema, but in the *_app-schema.
 
 * tww_vl: is the schema for value lists. There is a table for every value list of the VSA-DSS. As a TWW-user you can not edit these tables.
 
-* tww_network: schema for the tables that are necessary to use the network-topology with the tww-tools. You can rebuild these tables from the TWW-tools.
+* tww_app: schema for all module-specific views, materialized views, functions, triggers, etc. Also for views and function of additional plugins (SWMM, QField). In case of an update of the database, this schema will overwriten.
 
 * tww_sys: special tables for administration of the database. As a TWW-User you can not edit these tables.
 
-* tww_import and tww_swmm: schema for additional plugins/functions (QField and working with SWMM)
+* tww_cfg: to do: good explanantion
+
+If INTERLIS-import or -export is used, then there will be additional schema like "pg2ili_abwasser". The are recreated with every import or export. Do not add these schema to the tww-project.
 
 
 Layer names
 -----------
 
-* Layer names have often a prefix like od_ or vl_.
+* Layer names without prefix
 
-This shows you, in which schema to look for the table. od_organisation is the table organisation in the tww_od-schema.
+This shows you, that you find the table in the tww_od-schema or (if the are in the layer-group "Value Lists", you find them in schema tww_vl).
+If you are not sure in which schema to look for the table: place the mouse over the layer and look in the yellow popup-box for 'table="tww_*'.
 
 * Layer Names that begin with vw_
 
 Two or more VSA-DSS tables are joined in a view (vw). The layer has the name of the main-table. Example: vw_tww_reach: the main layer is the table reach (not the table channel).
-It is important to know the main-table to be sure, that you use the correct attributes.
-
-* Layer vw_network_
+It is important to know the main-table to be sure , that you use the correct attributes.
 
-These are views in the schema tww_network
 
 Attribute names
 ---------------
@@ -49,4 +50,4 @@ fk_ is not a shortcut for a special table. It stands for foreign key.
 * _ fields
 
 Attributes that start with _ (underscore) are calculated fields. You can not find them in the schemas. Examples: _slope_per_mill in vw_tww_reach.
-_channel_usage_current in vw_qgwp_wastewater_structure is calculated from the field usage_current of the channel, that is connected with the foreign keys of the wastewater_networkelement as outlet to a manhole or special structure.
+_channel_usage_current in vw_qgwp_wastewater_structure is calculated from the field usage_current of the channel, that is connected with the foreign key of the wastewater_networkelement as outlet to a manhole or special structure.

docs/en/user-guide/layerexplanations/overview.rst

@@ -7,11 +7,11 @@ Introduction and Overview
 
 .. note:: The Data Structure for urban drainage systems of the Swiss Waste Water Association (in German Verband Schweizer Abwasser- und Gewässerschutzfachleute (VSA)), referenced to usually as VSA-DSS was published 1999 and is since then the valid standard for data covering General Water Drainage Planning (in German Generelle Entwässerungsplanung (GEP). When applying VSA-DSS you also comply to SIA405 Abwasser, the subset for sewer networks as described in `Norm SIA405 (Merkblatt 2015 / 2016) <http://www.sia.ch/de/dienstleistungen/sia-norm/geodaten/>`_. More information about datamanagement in urban drainage you can find on the homepage of the `VSA https://vsa.ch/fachbereiche-cc/siedlungsentwaesserung/generelle-entwaesserungsplanung/datenmanagement/`_
 
-.. note:: The current database implementation in PostgreSQL is for the Version 2015 of the VSA-DSS datamodel, including the extension for sewer TV inspections called VSA-KEK (2019).
+.. note:: The current database implementation in PostgreSQL is for the Version 2020.1 of the VSA-DSS datamodel, including the extension for sewer TV inspections called VSA-KEK (2020).
 
-.. note:: We recommend you to get an access licence for the VSA-Wiki by purchasing it in the `VSA Shop <https://vsashop.ch/de/A~21_1100~1/Datenstruktur-Siedlungsentw%C3%A4sserung-VSA-DSS-Lizenz/Mitglied>`_. You will get answers and access to all model related questions, like the datamodel in INTERLIS, object catalogues and additional description and introduction and transfer datasets, the Wegleitung GEP-Daten and information about changes and updates as well as the right to test and convert unlimited INTERLIS dataset for one year with the `VSA Checker <https://vsa.ch/fachbereiche-cc/siedlungsentwaesserung/generelle-entwaesserungsplanung/datenmanagement/#GEP-Datachecker>`_. Some cantons offer this access for free for engineering companies and communities - please check with your Environmental office.
+.. note:: We recommend you to get an access licence for the VSA-Wiki by purchasing it in the `VSA Shop <https://vsashop.ch/de/A~21_1100~1/Datenstruktur-Siedlungsentw%C3%A4sserung-VSA-DSS-Lizenz/Mitglied>`_. You will get answers and access to all model related questions, like the datamodel in INTERLIS, object catalogues and additional description and introduction and transfer datasets, the Wegleitung Daten der Siedlungsentwässerung and information about changes and updates as well as the right to test and convert unlimited INTERLIS dataset for one year with the `VSA Checker <https://vsa.ch/fachbereiche-cc/siedlungsentwaesserung/generelle-entwaesserungsplanung/datenmanagement/#GEP-Datachecker>`_. Some cantons offer this access for free for engineering companies and communities - please check with your Environmental office.
 
-To work with TWW-tools, it is important to know also the following norm: **Wegleitung GEP-Daten** which is a practitioners guide to modelling reality into GIS and hydraulic datamodel of the VSA and there specially the annex "**Erfassungsgrundsätze**" (data acquisition policy). The VSA offers it as a full package on the `VSA-Wiki <https://vsa.ch/Mediathek/gep-datachecker-jahresgebuehr/>`_ which also includes acces to the VSA-Checker (a tool to check INTERLIS files)
+To work with TWW-tools, it is important to know also the following norm: **Wegleitung Daten der Siedlungsentwässerung** which is a practitioners guide to modelling reality into GIS and hydraulic datamodel of the VSA and there specially the annex "**Erfassungsrichtlinien**" (data acquisition policy) and "**Erfassungsbeispiele**". The VSA offers it as a full package on the `VSA-Wiki <https://vsa.ch/Mediathek/gep-datachecker-jahresgebuehr/>`_ which also includes acces to the VSA-Checker (a tool to check INTERLIS files)
 
 This is important because with VSA-DSS you do not only describe the manholes and channels (wastewater structures as constructive part), but with the nodes and reaches you do create the hydraulic model of the sewer network (network elements) also.
 
@@ -21,6 +21,8 @@ Reaches are always created in flow-direction (flow direction in case of normal-f
 To support the digitizing, TWW uses two main-views: **vw_tww_wastewater_structure** and **vw_tww_reach**. To edit these main views, there is a special wizard and the preconfigured feature attribute windows of these views.
 The idea is, to support with the wizard the digitizing, so that 95% of the manholes and channels can be collected on the general-tab of the feature attribute-window, that means with as few mouse clicks as possible.
 
+Before starting with digitizing, think about the obj_id of the records you will create. A VSA-DSS record must have a OID composed of prefix and postfix. The postfix is created by TWW-database. The prefix has to be defined in tww_sys.oid_prefixes before starting digitizing (look chapter 'Setup workstation' in 'TWW Installation Guide').
+
 **TWW wizard**
 
 To use the wizard (:ref:`digitizing-wastewater-structures`) is recommended for digitizing reaches because it supports snapping and connecting to the nodes preferred to the reaches. If you use the QGIS - Add line feature - tool you can not select and pick the nodes as easy.