Skip to content

Commit

Permalink
add changelog + doc
Browse files Browse the repository at this point in the history
  • Loading branch information
TheoLechemia committed Mar 19, 2024
1 parent 749fefd commit 207352b
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 28 deletions.
15 changes: 6 additions & 9 deletions config/default_config.toml.example
Original file line number Diff line number Diff line change
Expand Up @@ -325,20 +325,17 @@ MEDIA_CLEAN_CRONTAB = "0 1 * * *"
# Nombre max d'observations dans les exports
NB_MAX_OBS_EXPORT = 50000

# Noms des colonnes obligatoires de la vue ``gn_synthese.v_synthese_for_export``
EXPORT_ID_SYNTHESE_COL = "id_synthese"
EXPORT_ID_DATASET_COL = "jdd_id"
EXPORT_ID_DIGITISER_COL = "id_digitiser"
EXPORT_OBSERVERS_COL = "observateurs"
EXPORT_GEOJSON_4326_COL = "geojson_4326"
EXPORT_GEOJSON_LOCAL_COL = "geojson_local"

# Formats d'export disponibles ["csv", "geojson", "shapefile", "gpkg"]
EXPORT_FORMAT = ["csv", "geojson", "shapefile"]

# Vues d'export personnalisées
EXPORT_OBSERVATIONS_CUSTOM_VIEWS = [
{"label" : "export customisé", "view_name"= "gn_synthese.ma_vue_personnalisee"}
{
label = "format personnalisé",
view_name = "schema_name.view_name",
geojson_4326_field = "geojson_4326",
geojson_local_field = "geojson_local"
}
]
# Noms des colonnes obligatoires de la vue ``gn_synthese.v_metadata_for_export``
EXPORT_METADATA_ID_DATASET_COL = "jdd_id"
Expand Down
8 changes: 7 additions & 1 deletion docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@ CHANGELOG

- [Synthèse] Possibilité d'ajouter des champs supplémentaires à la liste de résultats via le paramètre `ADDITIONAL_COLUMNS_FRONTEND`. Ces champs sont masqués par défaut et controlables depuis l'interface (#2946)

- [Synthèse] Possibilité d'ajouter des exports customisés basé sur des vues SQL via le paramètre `EXPORT_OBSERVATIONS_CUSTOM_VIEWS`
- [Synthèse] Possiblité d'ajouter des exports personnalisés basé sur des vues SQL via le paramètre `EXPORT_OBSERVATIONS_CUSTOM_VIEWS` (#2955)

**⚠️ Notes de version**

- Les paramètres de la synthèse permettant de spécifier le nom de certaines colonnes de la vue d'export sont depréciés ( `EXPORT_ID_SYNTHESE_COL, EXPORT_ID_DIGITISER_COL, EXPORT_OBSERVERS_COL, EXPORT_GEOJSON_4326_COL EXPORT_GEOJSON_LOCAL_COL`) . Si vous aviez surcoucher la vue `gn_synthese.v_synthese_for_export`, il est recommandé d'utiliser ce paramètre et de se créer des vues personnalisées.

2.14.0 - Talpa europaea 👓 (2024-02-28)

2.14.0 - Talpa europaea 👓 (2024-02-28)
---------------------------------------
Expand Down
33 changes: 15 additions & 18 deletions docs/admin-manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2194,26 +2194,23 @@ Enlevez la ligne de la colonne que vous souhaitez désactiver. Les noms de colon

L'entête ``[SYNTHESE]`` au dessus ``EXPORT_COLUMNS`` indique simplement que cette variable appartient au bloc de configuration de la synthese. Ne pas rajouter l'entête à chaque paramètre de la synthese mais une seule fois au dessus de toutes les variables de configuration du module.

Il est également possible de personnaliser ses exports en éditant le SQL de la vue ``gn_synthese.v_synthese_for_export`` (niveau SQL et administration GeoNature avancé).
Il est également possible de personnaliser ses exports en créant des vues personnalisée et en remplissant le paramètre suivant :

Attention, certains champs sont cependant obligatoires pour assurer la réalisation des fichiers d'export (csv, geojson et shapefile) et des filtres CRUVED.

La vue doit OBLIGATOIREMENT contenir les champs :

- geojson_4326
- geojson_local
- id_synthese,
- jdd_id (l'ID du jeu de données)
- id_digitiser
- observateurs

Ces champs doivent impérativement être présents dans la vue, mais ne seront pas nécessairement dans le fichier d'export si ils ne figurent pas dans la variable ``EXPORT_COLUMNS``. De manière générale, préférez rajouter des champs plutôt que d'en enlever !

Le nom de ces champs peut cependant être modifié. Dans ce cas, modifiez le fichier ``geonature_config.toml``, section ``SYNTHESE`` parmis les variables suivantes (``EXPORT_ID_SYNTHESE_COL, EXPORT_ID_DATASET_COL, EXPORT_ID_DIGITISER_COL, EXPORT_OBSERVERS_COL, EXPORT_GEOJSON_4326_COL, EXPORT_GEOJSON_LOCAL_COL``).

NB : Lorsqu'on effectue une recherche dans la synthèse, on interroge la vue ``gn_synthese.v_synthese_for_web_app``. L'interface web passe ensuite une liste d'``id_synthese`` à la vue ``gn_synthese.v_synthese_for_export`` correspondant à la recherche précedemment effectuée (ce qui permet à cette seconde vue d'être totalement modifiable).
::

La vue ``gn_synthese.v_synthese_for_web_app`` est taillée pour l'interface web, il ne faut donc PAS la modifier.
[SYNTHESE]
...
EXPORT_OBSERVATIONS_CUSTOM_VIEWS = [
{
label = "format personnalisé",
view_name = "gn_synthese.v_synthese_for_web_app",
geojson_4326_field = "geojson_4326",
geojson_local_field = "geojson_local"
}
]


Ces vues doivent obligatoirement avoir une colonne `id_synthese`, ainsi que deux colonnes transformant la géométrie de l'observation en geojson respectivement dans la projection locale et en geojson 4326 (utiliser la fonction `st_asgeojson` - voir la vue par défaut `gn_synthese.v_synthese_for_export`). Le nom de ces deux dernières colonne est à mettre dans le paramètre `geojson_local_field` et `geojson_4326_field` de l'export personnalisé.

**Export des métadonnées**

Expand Down

0 comments on commit 207352b

Please sign in to comment.