Skip to content

Commit 945c878

Browse files
committed
Documentation for fk_checks on export
1 parent 8ee57d8 commit 945c878

File tree

4 files changed

+105
-4
lines changed

4 files changed

+105
-4
lines changed
809 KB
Loading
840 KB
Loading
706 KB
Loading

en/admin-guide/interlis-io/index.rst

Lines changed: 105 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The QGEP plugin will propose to install the Modelbaker plugin automatically. If
6262

6363
QGEP Version
6464
-------------
65-
The export only supports up-to-date QGEP datamodel (1.6.1 at the time of writing). Ensure your datamodel is fully updated before trying to import/export.
65+
The export only supports up-to-date QGEP datamodel (1.6.2 at the time of writing). Ensure your datamodel is fully updated before trying to import/export.
6666

6767

6868
Usage (GUI)
@@ -79,10 +79,10 @@ You should now see new `import` and `export` buttons in the QGEP toolbar.
7979

8080
.. figure:: images/toolbar.png
8181

82-
Export
82+
Export to INTERLIS
8383
-------------------------------------------------
8484

85-
To export your QGEP data, click on the `export` button. The following dialog will appear.
85+
To export your QGEP data, click on the `Export to INTERLIS` button. The following dialog will appear.
8686

8787
.. figure:: images/export_dialog_new.png
8888

@@ -115,7 +115,7 @@ Then, confirm the dialog and choose where to save the `.xtf` file.
115115

116116
.. note:: Note that remark fields are truncated to 80 characters on INTERLIS Export, as the INTERLIS definition is like this. If you have remark fields with more text then consider to move this data to documentation with the classes "file" and "data_media" so it can be exported to INTERLIS completely where you can add any document, photo or video to a class.
117117

118-
INTERLIS export starts with two integrity checks:
118+
INTERLIS export starts with three integrity checks:
119119

120120
1. Integrity check Organisation subclasses
121121
For VSA-DSS 2015 Export each organisation needs to be related to one of the seven subclasses of organisation (administrative_office, canton, cooperative, municipality, privat, wastewater_association, wastewater_treatment_plant).
@@ -134,6 +134,107 @@ All export models define the identifier attribute as MANDATORY. Therefore the ex
134134

135135
You will get a list of missing identifiers per class. Please add an identifier. If you do not have a separte identifier scheme for that class just copy the obj_id.
136136

137+
3. Check of missing references to organisation
138+
Release 2015 has MANDATORY constraints for
139+
140+
- wastewater_structure.fk_owner
141+
- wastewater_structure.fk_operator
142+
143+
.. figure:: images/export_check_fk_owner_null.png
144+
145+
So you have to pass this check to be able to export your data. The detailed log in the 'qgep' tab gives you more information:
146+
147+
2024-10-04T15:34:46 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:INTEGRITY CHECK missing MAMDATORY owner references fk_owner...
148+
2024-10-04T15:34:46 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'wastewater_structure' without fk_owner : 1
149+
2024-10-04T15:34:46 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_owner_count : 1
150+
2024-10-04T15:34:46 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:ERROR: Missing mandatory fk_owner in qgep_od: 1
151+
152+
.. figure:: images/export_check_fk_owner_null_details.png
153+
154+
155+
The following references will be needed with release 2020 of VSA-DSS and SIA405 Abwasser. But you only will get hints, that they are missing. But we strongly encourage you to fill in that data, as you will else face problems when doing the INTERLIS - INTERLIS transformation from Release 2015 to 2020.xx with CHECKVSA.
156+
157+
- *.fk_dataowner
158+
- *.fk_provider
159+
160+
.. figure:: images/export_check_fk_provider_null.png
161+
162+
Detailed log:
163+
164+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:INTEGRITY CHECK missing dataowner references fk_dataowner...
165+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'file' without fk_dataowner : 0
166+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 0
167+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'data_media' without fk_dataowner : 0
168+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 0
169+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'maintenance_event' without fk_dataowner : 0
170+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 0
171+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'organisation' without fk_dataowner : 2
172+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 2
173+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'wastewater_structure' without fk_dataowner : 1
174+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
175+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'wastewater_networkelement' without fk_dataowner : 0
176+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
177+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'structure_part' without fk_dataowner : 0
178+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
179+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'reach_point' without fk_dataowner : 0
180+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
181+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'pipe_profile' without fk_dataowner : 0
182+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
183+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'catchment_area' without fk_dataowner : 0
184+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
185+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'connection_object' without fk_dataowner : 0
186+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
187+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'control_center' without fk_dataowner : 0
188+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
189+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'hazard_source' without fk_dataowner : 0
190+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
191+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'hydr_geometry' without fk_dataowner : 0
192+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
193+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'hydraulic_char_data' without fk_dataowner : 0
194+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
195+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'measurement_result' without fk_dataowner : 0
196+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
197+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'measurement_series' without fk_dataowner : 0
198+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
199+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'measuring_device' without fk_dataowner : 0
200+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
201+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'measuring_point' without fk_dataowner : 0
202+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
203+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'mechanical_pretreatment' without fk_dataowner : 0
204+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
205+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'overflow' without fk_dataowner : 0
206+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
207+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'overflow_char' without fk_dataowner : 0
208+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
209+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'retention_body' without fk_dataowner : 0
210+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
211+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'river_bank' without fk_dataowner : 0
212+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
213+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'river_bed' without fk_dataowner : 0
214+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
215+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'sector_water_body' without fk_dataowner : 0
216+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
217+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'substance' without fk_dataowner : 0
218+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
219+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'surface_runoff_parameters' without fk_dataowner : 0
220+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
221+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'surface_water_bodies' without fk_dataowner : 0
222+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
223+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'throttle_shut_off_unit' without fk_dataowner : 0
224+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
225+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'waste_water_treatment' without fk_dataowner : 0
226+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
227+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'water_catchment' without fk_dataowner : 0
228+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
229+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'water_control_structure' without fk_dataowner : 0
230+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
231+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'water_course_segment' without fk_dataowner : 0
232+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
233+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'wwtp_energy_use' without fk_dataowner : 0
234+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
235+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:Number of datasets in class 'zone' without fk_dataowner : 0
236+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:missing_fk_dataowner_count : 3
237+
2024-10-04T15:52:49 qgepplugin.qgepqwat2ili.qgepqwat2ili.utils:ERROR: Missing mandatory fk_dataowner in qgep_od: 3
137238

138239
Exports include a validation step using `ilivalidator`, which will inform you whether the export contains INTERLIS validation error.
139240

0 commit comments

Comments
 (0)