Skip to content

Commit

Permalink
Review doc import.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
@camillemonchicourt
camillemonchicourt authored Nov 25, 2024
1 parent 00d04b4 commit 8fdfbfc
Showing 1 changed file with 26 additions and 29 deletions.
55 changes: 26 additions & 29 deletions docs/utilisateur/import.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Import
------

Depuis le 2.15, GeoNature permet aussi d'importer des données depuis un fichier CSV dans deux modules:
Depuis sa version 2.15, le module Import a été intégré à GeoNature et il permet d'importer des données depuis un fichier CSV dans deux modules :

- Synthèse
- Occhab
Expand All @@ -29,8 +29,8 @@ Pour réaliser un import dans une des destinations de GeoNature, vous devez :
.. image:: images/import/import_steps/01_destination_choice.png

3. Une fois la destination choisie, vous serez redirigé vers une nouvelle page.
Dans ce nouveau formulaire, choisissez le jeu de données qui sera associés aux données importées.
Puis, téléverser le fichier CSV contenant les données que vous souhaitez importer. Une fois, les
Dans ce nouveau formulaire, choisissez le jeu de données qui sera associé aux données importées.
Puis, téléverser le fichier CSV contenant les données que vous souhaitez importer. Une fois les
champs remplis, cliquez sur le bouton "Suivant".

.. image:: images/import/import_steps/02_upload_file.png
Expand All @@ -43,7 +43,7 @@ paramètres seront automatiquement détectés par GeoNature. Une fois, les champ
5. Maintenant que le fichier est téleversé et chargé, il s'agit de faire
correspondre les champs du fichier importé aux champs du modèle des entités (e.g. Station).
Pour vous aider dans la saisie, vous pouvez utiliser un mapping
déjà existant ou en créer un nouveau pour l'utiliser dans de futur import.
déjà existant ou en créer un nouveau pour l'utiliser dans de futurs imports.
Le module contient par défaut un mapping correspondant à un fichier exporté au format par défaut
des modules Synthèse et Occhab. Si vous créez un nouveau mapping, il
sera réutilisable pour les imports suivants. Une fois, la mise en correspondance terminée,
Expand All @@ -58,7 +58,7 @@ paramètres seront automatiquement détectés par GeoNature. Une fois, les champ

6. La correspondance entre le fichier source et le modèle effectué, il faut maintenant faire
correspondre des valeurs des colonnes contenant des données de nomenclatures (e.g. Etat Biologique de l'observation)
avec les nomenclatures disponibles dans la base. Une fois, la correspondance terminée,
avec les nomenclatures disponibles dans la base. Une fois la correspondance terminée,
cliquez sur le bouton "Suivant".

.. image:: images/import/import_steps/05_mapping_value.png
Expand All @@ -71,11 +71,11 @@ sur le bouton "Lancer la vérification".

.. image:: images/import/import_steps/06_01_control_data.png

8. Une fois la vérification des données effectuée, un aperçu des données valides ainsi que leur emprise spatiale (*bounding box*) sont affichés. Si des erreurs sont présentes dans les données, un bouton "Rapport d'import/erreurs/avertissement" permet d'afficher les erreurs et d'ajuster votre fichier source ou paramètre de l'import. Si l'aperçu des données qui seront importées vous convient, cliquez sur le bouton "Importer les n entités valides".
8. Une fois la vérification des données effectuée, un aperçu des données valides ainsi que leur emprise spatiale (*bounding box*) sont affichés. Si des erreurs sont présentes dans les données, un bouton "Rapport d'import/erreurs/avertissement" permet d'afficher les erreurs et d'ajuster votre fichier source ou les paramètres de l'import. Si l'aperçu des données qui seront importées vous convient, cliquez sur le bouton "Importer les n entités valides".

.. image:: images/import/import_steps/06_02_import_part1.png

9. Une fois l'import terminée, un rapport récapitulatif est affiché avec les différents paramètres
9. Une fois l'import terminé, un rapport récapitulatif est affiché avec les différents paramètres
de l'import mais aussi plusieurs indicateurs statistiques sous forme de tableau et de graphique(s).
Il est aussi possible d'exporter une version PDF de ce rapport.

Expand All @@ -89,36 +89,33 @@ Pour modifier un import, rendez-vous dans la "Liste des imports", cliquez sur l'
:red:`!! Attention !! La modification d'un import terminé provoquera la suppression des
données importées dans la table temporaire et dans la destination.`


Supprimer un import
"""""""""""""""""""

Pour supprimer un import, il suffit de cliquer sur l'icone en forme de poubelle dans la colonne "Actions".

:red:`!! Attention !! La suppression d'un import terminé implique la suppression des données dans la destination.`


:red:`!! Attention !! La suppression d'un import terminé entrainera la suppression des données dans la destination.`

Exemple de fichier CSV pour l'import Occhab
"""""""""""""""""""""""""""""""""""""""""""

Ci-dessous un exemple de fichier CSV avec les colonnes et le contenu attendu dans l'import de données vers Occhab.

+------------+--------------+------------------+----------+--------+---------------------------------------------------------------------------------------------------------------------+
| id_origine | UUID_station | geometry_station | UUID_hab | cd_hab | STATUTS |
+============+==============+==================+==========+========+=====================================================================================================================+
| 5 | | POINT (30 10) | | 27 | Ajout d’une station auquel on associe un habitat (UUIDs seront généré) |
| 5 | | POINT (30 10) | | 32 | Ajout d’un habitat dans une station (l’UUID habitat sera généré) |
| | AAA | POINT (15 10) | | 18 | Ajout d’une station auquel on associe un habitat (génération de l’UUID de l’habitat) |
| | CCC | POINT (9 5) | | 11 | Ajout d’une station auquel on associe un habitat (génération de l’UUID de l’habitat) |
| | CCC | | | 15 | Ajout d’un habitat dans une station (répéter les informations d’une station déclarée dans le fichier est optionnel) |
| | XXX | | | 22 | Ajout d’un habitat dans une station existante (identifié par l’UUID XXX) dans la base de données |
| 6 | | POINT (9 4) | | | Ajout d’une station |
| 6 | | POINT (9 4) | | | Ligne ignorée car doublon de la ligne 8 |
| | BBB | POINT (9 4) | | 55 | Provoque une erreur car il y a une incohérence dans les données d’une station sur différentes lignes |
| | BBB | POINT (20 3) | | 58 | Provoque une erreur car il y a une incohérence dans les données d’une station sur différentes lignes |
+------------+--------------+------------------+----------+--------+---------------------------------------------------------------------------------------------------------------------+



Plus d'exemple sont disponibles dans le fichier ``valid_file.csv`` dans le dossier ``backend/geonature/tests/imports/files/occhab/valid_file.csv``.
L'import se fait dans un fichier tableur à plat mais permet d'importer des stations comprenant plusieurs habitats chacunes, mais aussi d'importer des habitats à associer à des stations existantes dans la BDD.

+------------+--------------+------------------+----------+--------+-----------------------------------------------------------------------------------------------------------------------+
| id_origine | UUID_station | geometry_station | UUID_hab | cd_hab | STATUTS |
+============+==============+==================+==========+========+=======================================================================================================================+
| 5 | | POINT (30 10) | | 27 | Ajout d’une station à laquelle on associe un habitat (leurs UUIDs seront générés) |
| 5 | | POINT (30 10) | | 32 | Ajout d’un second habitat dans la station précédemment créée (l’UUID habitat sera généré) |
| | AAA | POINT (15 10) | | 18 | Ajout d’une station à l'aquelle on associe un habitat (génération de l’UUID de l’habitat) |
| | CCC | POINT (9 5) | | 11 | Ajout d’une station à laquelle on associe un habitat (génération de l’UUID de l’habitat uniquement) |
| | CCC | | | 15 | Ajout d’un habitat dans cette station (répéter les informations d’une station déclarée dans le fichier est optionnel) |
| | XXX | | | 22 | Ajout d’un habitat dans une station existante dans la BDD (identifié par l’UUID XXX) |
| 6 | | POINT (9 4) | | | Ajout d’une station uniquement |
| 6 | | POINT (9 4) | | | Ligne ignorée car doublon de la ligne 8 |
| | BBB | POINT (9 4) | | 55 | Provoque une erreur car il y a une incohérence dans les données d’une station sur différentes lignes |
| | BBB | POINT (20 3) | | 58 | Provoque une erreur car il y a une incohérence dans les données d’une station sur différentes lignes |
+------------+--------------+------------------+----------+--------+-----------------------------------------------------------------------------------------------------------------------+

Plus d'exemples sont disponibles dans le fichier ``valid_file.csv`` dans le dossier ``backend/geonature/tests/imports/files/occhab/valid_file.csv``.

0 comments on commit 8fdfbfc

Please sign in to comment.