Modifications

Sébastien RENOU · f0255192
--- a/manuel/V03/Documentation-Administrateurs/1.-L'administration-de-Sysma-via-l'interface.md
+++ b/manuel/V03/Documentation-Administrateurs/1.-L'administration-de-Sysma-via-l'interface.md
 [[_TOC_]]
 # Dictionnaire de données
 Les administrateurs Sysma peuvent modifier l'ensemble du dictionnaire, depuis l'interface, rubrique /Dictionnaire ![image](uploads/8ee41e9fb472890ce4ae7528b3216d0a/image.png)
 ## Création et modification du dictionnaire
 L'ensemble des éléments constituant le dictionnaire sont modifiables. Ci-dessous quelques explications sur certains champs :
 ### Type d'objet
 * Type objet : intitulé
 * Alias : sans espace ni caractères spéciaux ni majuscules ni trait d'union "-" ni chiffre comme premier caractère. privilégier "_" comme séparateur de mots
 * Description : explication sur le type d'objet.
 * Source définition
 * Sources données : historique de constitution du lot de données de ce type d'objet
 * Support de numérisation : support conseillé pour la saisie cartographique de ce type d'objet
 * Type de géométrie :
 * Style : au format json, cf. ci-dessous
 * Groupe : groupe d'affichage dans le gestionnaire de couches
 * Rechargement lors du zoom (load on span) : pour les couches lourdes, chargement partiel de la couche à chaque déplacement de la carte
 * Niveau de zoom min et max d'affichage (0 pour désactiver) : entre 1 et 20
 * Masquer dans l'export du dictionnaire : ce type d'objet ne sera pas visible dans l'export "print" du dictionnaire
 #### Style
 Utilisez l'assistant création de style (bouton en bas de page) pour paramétrer le style par défaut de ce type d'objet.
 ### Paramètres de types d'objet
 Depuis la fiche dictionnaire d'un type d'objet, utilisez le bouton Créer un nouveau paramètre :
 * Paramètre : intitulé
 * Description, source : même logique que pour types d'objet
 * Type de donnée, quelques précisions :
  * pour liste déroulante et choix multiple, les choix doivent être renseignés après la création du paramètre
  * pour le type lien_objet, le type d'objet lié doit être préciser après création du paramètre
   * pour le type hyperlien, s'il est utilisé pour cibler des fichiers locaux (sur un PC ou un serveur local), ils ne fonctionneront qu'après avoir modifié le paramétrage de votre navigateur web. Cf. https://gitlab.sevre-nantaise.com/eptbsn/sysma-tickets/-/wikis/manuel/V03/Documentation-Administrateurs/5.-Divers
 * Regroupement : permet de régler l'ordre d'affichage des paramètres (format texte, ordre alphabétique)
 * Unité (optionnel)
 * Alias SIG : sans espace ni caractères spéciaux ni majuscules, 10 caractères maximum
 * Obligatoire : indicateur visuel, ne bloque pas l'utilisateur si le paramètre n'est pas renseigné
 * Suivi dans le temps : activer ou non le suivi et donc la précision d'une date de début et fin à chaque saisie de valeur du paramètre
-* Champ caché : permet de stocker des données non visibles et non renseignables par l'utilisateur (mais utilisables par des process de calcul par exemple)
+* Champ caché : permet de stocker des données non visibles et non renseignables par l'utilisateur (mais utilisables par des process de calcul par exemple). Ces valeurs de paramètres sont tout de même exportables via un bilan ou un export SIG/PG.
 ### Types d'actions
 #### Gestion des coûts
 Si la gestion des coûts est activée dans Sysma, l'outil proposera à chaque création de fiche action un coût basé sur :
 * un coût unitaire (unique quelque soit le nombre d'objets associés à la fiche travaux)
 * un coût par objet
 * un coût par linéaire, surface ou volume
 #### Paramètres de types de travaux
 Même principe que paramètres de types d'objet.
 ## Suppression des éléments de dictionnaire
 Il est possible de supprimer tout élément du dictionnaire (types d'objet, types d'action, paramètre) depuis leurs pages de modification, bouton "Supprimer".
 **Attention : la suppression d'un élément du dictionnaire entraîne la suppression des données associées dans la base de données Sysma.**
 Par exemple, la suppression du type d'objet "Abreuvoir" dans le dictionnaire entrainera la suppression des tous les objets abreuvoirs, de toutes les valeurs descriptives de ses abreuvoirs (valeurs des paramètres) ainsi que toutes les actions associées.
 **Lors d'une demande de suppression, Sysma précise le nombre d'objet impactés par cette suppression et demande une confirmation. La suppression est définitive.**
 ## Import/Export
 Les éléments du dictionnaire peuvent être importés et exportés depuis la page /dictionnaire. Cette fonctionnalité permet d'échanger des éléments de dictionnaire d'une instance Sysma à une autre très simplement.
 ### Export
 Depuis la rubrique /dictionnaire/export, choisissez le ou les types d'objet à exporter.
 Sysma génère un fichier .tar.gz contenant pour chaque type d'objet sélectionné un fichier au format json comprenant :
 * la description du type d'objet
 * la description des paramètres du type d'objet (et ses listes de choix éventuels)
 * la description des types d'action associés
 * la description des paramètres des types d'actions associés
 * diverses métadonnées
 ### Import
 Depuis la rubrique /dictionnaire/import, sélectionnez un ou plusieurs fichiers dictionnaire (format .tar.gz ou .json).
 L'import entraine la création du (ou des) type d'objet, de ses paramètres et types d'action associés.
 L'import ne sera pas possible si le type d'objet est déjà existant dans le dictionnaire Sysma.
 Toutefois, si vous souhaitez importer un dictionnaire pour type d'objet déjà présent dans votre sysma. Voici une solution :
 1. **Renommer l'alias de l'objet en conflit** : Dans sysma / dictionnaire / modifier l'alias de l'objet (cela permettra de ne pas avoir de conflit entre le dictionnaire que vous souhaitez importer et ceux qui sont présents dans votre sysma).
 1. **Mise à jour des métadonnées dictionnaire de sysma** : Dans sysma / exporter le dictionnaire de cet objet (cette opération permet de mettre à jour certaines métadonnées internes de sysma relatives aux dictionnaires). Note : Le fichier exporté ne vous servira à rien par la suite. 
 1. **Importer** : Exécuter la procédure d'import avec le fichier de dictionnaire qui était précédemment en conflit.
 # Gestion des utilisateurs
 L'administrateur peut déclarer, modifier des comptes utilisateurs et leur accorder des droits sur les types d'objets et d'actions.
 Ces réglages sont disponibles dans la rubrique Admin ![image](uploads/6de14988dd228e152a7c466104a0efcc/image.png)/Comptes et droits des utilisateurs
 ## Comptes et droits des utilisateurs
 _/admin/users_
 ### Création d'un compte
 Utiliser le bouton \[+ Nouvel utilisateur\], puis compléter l'ensemble des champs
 ### Paramétrages complémentaires du compte
 Une fois le compte créé, plusieurs réglalges supplémentaires sont disponibles dans la dans la page du nouvel utilisateur (bouton compte depuis admin/users), en particulier :
 * Le nom du **schéma PostgreSQL** à scanner par Sysma lors de l'import de couches SIG (schéma PostgreSQL sur lequel l'utilisateur pourra envoyer ses couches SIG depuis QGis, et sur lequel Sysma a des droits de lecture)
 * Divers droits :
  * **Administration** (administration complète de Sysma)
  * **Accès aux informations du cadastre** : débloque les fonctionnalités cadastre de Sysma.
    **_Point d'attention_** _: les données du cadastre sont nominatives, et à ce titre doivent faire l'objet d'une attention particulière en lien avec la réglementation RGPD._
 * **A accès aux informations du Référentiel Parcellaire Graphique (RPG) agricole** : cette option, en complément de l'activation du mode RPG dans les variables de l'application, permettent à cet utilisateur de visualiser les parcelles agricoles d'un même exploitant.
  * **Export de fichiers Shape** : l'utilisateur pourra accéder à la rubrique Couches SIG permettant de générer des couches au format shape. Les couches générées respecteront les droits de l'utilisateur sur les objets et actions Sysma (si les droits de l'utilisateur ne lui permettent pas d'afficher un objet dans Sysma, celui-ci sera absent de l'export SIG)
  * **Peut générer des couches PostgreSQL** : l'utilisateur pourra accéder à la rubrique Couches PG permettant de générer des couches "à plat" depuis la base de données Sysma, c'est à dire des couches au format classique SIG (une couche par type d'objet ou d'action, et une colonne par paramètre). Ces couches seront accessibles depuis le schéma sysma_export_layers de la base de données Sysma et facilement utilisable dans QGis.
    **_Point d'attention_** _: ces couches sont complètes, non filtrées selon les droits de l'utilisateur._
 ### Droits des utilisateurs sur les objets et actions
 Il est possible de paramétrer finement pour chaque utilisateur son niveau d'accès aux types d'objets et d'actions.
 Pour un utilisateur (admin/users), utiliser le bouton \[Droits sur les objets et actions\]
 Principes :
 * Plusieurs droits peuvent être définis successivement.
 * A chaque action réalisée par l'utilisateur dans Sysma, l'outil vérifie que l’utilisateur en cours dispose bien des droits suffisants décrits dans un ou l'autre des droits déclarés.
 ![image](uploads/b408a950f38a907402e223a248b017b5/image.png)
 * Niveaux de droits :
  * Lecture : peut lire les informations, mais pas les modifier
  * Contribution : peut créer des objets ou travaux et modifier les objets ou travaux créés (mais pas ceux des autres utilisateurs)
  * Gestion : peut créer et modifier des objets ou travaux créés par n'importe quel utilisateur
 * Types d'objets :
  * Sélectionner les types souhaités (plusieurs possibles en maintenant la touche Control
 * Logique identique pour les statuts, structures et les actions
 ## Suivi des connexions
 La rubrique admin/connexions permet de consulter un bilan de l'utilisation de votre instance Sysma :
 * Les dernières connexions
 * Les dernières objets modifiés
 * Les utilisateurs les plus actifs (en nombre de connexions)
 Il est également possible de consulter un bilan des objets, actions, données objets et données actions renseignés pour chaque utilisateurs depuis la rubrique admin/users/ > Stats
 # Configuration de l'application
 ## Structures
 _/admin/configuration/organisations_
 Les structures sont les potentiels maîtres d'ouvrage listés dans l'application et auxquels peuvent être associés des objets ou des actions (formulaires de création/modification d'objets et d'actions).
 La rubrique Structures de la page d'administration permet de créer, renommer ou supprimer des structures.
 La suppression d'une structure n'est possible que si elle ne concerne aucun objet ou action.
 ## Contrats
 _/admin/configuration/contrats_
 La rubrique Contrats permet de déclarer, modifier ou supprimer un contrat.
 La modification ou suppression d'un contrat entraine une mise à jour de l'ensemble des fiches actions concernées.
 ## Affichage des couches
 ### Filtres
 Rappel du fonctionnement des filtres : <https://gitlab.sevre-nantaise.com/eptbsn/sysma-tickets/-/wikis/manuel/V03/Documentation-Utilisateurs/5.-Consulter-les-donn%C3%A9es-de-Sysma#514-filtrer-les-couches>
 _/admin/configuration/filtres_
 Les filtres sont déclarés par l'administrateur depuis la rubrique Filtres et sont alors accessibles à l'ensemble des utilisateurs. Un filtre correspond à une partie de condition SQL (code SQL situé après le WHERE).
 Exemples de Filtre :
 * o.status = 'existant' -> tous les objets dont le statut est existant
 * left(o.start_date,0,4) in ('2011','2012','2013') -> tous les objets dont la date de début est 2011, 2012 ou 2013
 * 'CT EAU (2021-2026)' = ANY(t.contracts)
 Les conditions SQL s'appliquent aux tables de données stockant les objets et les actions, les champs utilisables sont donc ceux de ces tables :
 Pour les objets (raccourci de table : o)
 * o.sysma_object_id (id unique de l'objet)
 * o.start_date
 * o.end_date
 * o.organisation_id
 * o.created_by
 * o.status
 * o.sysma_object_type_id (id du type d'objet, cf. dictionnaire)
 * o.created_at
 * o.sysma_object (intitulé de l'objet)
 * o.geom
 * o.modified_by
 * o.modified_at
 * track_historytables_id
 Pour les travaux (raccourci de table : t)
 * t.sysma_action_id (id unique de la fiche action)
 * t.sysma_action (intitulé de l'action)
 * t.sysma_action_type_id (id du type d'action, cf dictionnaire)
 * t.start_date
 * t.end_date
 * t.organisation_id
 * t.created_by
 * t.program_year (année de programmation)
 * t.status
 * t.created_at
 * t.modified_by
 * t.modified_at
 * t.track_historytables_id
 * t.contracts
 * t.unit_cost_thesaurus (coût unitaire issu du dictionnaire)
 * t.unit_cost_estimated_user (coût unitaire saisi par l'utilisateur)
 * t.total_cost_estimated_user (coût total saisi par l'utilisateur)
 * t.unit_measure_estimated_user (unité saisie par l'utilisateur)
 * t.total_cost_final_user (coût final saisi par l'utilisateur)
 ### Analyses thématiques
 /admin/configuration/ta
 Les analyses thématiques peuvent être déclarées par l'administrateur depuis la rubrique du même nom et sont alors accessibles à l'ensemble des utilisateurs Sysma depuis l'interface cartographique.
 Les analyses permettent, pour un type d'objet donné, de faire varier la forme des objets sur la carte selon leurs caractéristiques (ex : couleur variable selon une typologie, gradient de couleur selon une valeur numérique...)
 La configuration de l'analyse comprend :
 * Un nom (celui visible par les utilisateurs)
 * Le paramètre faisant l'objet de l'analyse
 * Le type d'analyse
  * classes : applicable à des champs numériques (de 0 à 2, de 2 à 5 etc...)
  * values : selon la valeur d'un champ
  * gradient : applicable à un champ numérique, couleurs automatiques entre une valeur min et max
 * Le style à appliquer : le champ style doit comporter un json valide comprenant les informations utiles à la mise en forme. cf. exemples de json en bas de page dans l'interface sysma.
 Pour trouver le code d'une couleur sous la forme (#123456), vous pouvez utiliser un  sélecteur de couleurs(recherche "selecteur de couleur" dans Google par exemple) :  
 ![image](uploads/90cb2d6394b6913126fc10bf392f44f2/image.png)
 Dans une analyse de type "values", il est possible de masquer certaines classes, par exemple pour masquer tous les éléments qui sont dans la classe "type indéfini" :  
 ```json
 "type indéfini":{
        "style":{"display":"none"}
    }
 ```
 ### Vues
 La rubrique Vues permet pour une vue disponible dans le compte de l'administrateur, une réplication de cette vue vers les utilisateurs de Sysma.
 ## Couches utiles et référentiels
 _/admin/configuration/couches_
 L’administrateur peut déclarer des couches utiles de différents types depuis le rubrique Autres couches. Ces couches ne sont pas modifiables par les utilisateurs Sysma, elles permettent d'ajouter des référentiels à votre instance Sysma.
 Globalement, ces couches peuvent être publiques (visibles pour tous les visiteurs de votre instance Sysma, y compris pour les utilisateurs non identifiés) ou à accès restreint (restricted), c'est à dire visibles uniquement pour les utilisateurs identifiés.
 ### Tile_layer et tile_layer_wms
 Ce sont des couches raster "de fond" affichables depuis le sélecteur de couches de la carte ![image](uploads/33383d618a5411e4cef581958af35d20/image.png).
 **Le lien suivant vous permet d'accéder à une liste de flux intégrables dans Sysma ainsi que leurs options de paramétrages** : <https://sysma.io/doc#other_layers>
 La déclaration de la couche doit notamment comporter l'URL cible (du type <https://services.sandre.eaufrance.fr/geo/topage>)
 Si l'accès au flux nécessite une clé d'API, il est possible d'utiliser le mot clé IGN_API_KEY dans l'url : ex : [https://wxs.ign.fr/_IGN_API_KEY_/wmts?LAYER=GEOGRAPHICALGRIDSYSTEMS.MAPS&EXCEPTIONS=text/xml&FORMAT=image/jpeg&SERVICE=WMTS&VERSION=1.0.0&REQUEST=GetTile&STYLE=normal&TILEMATRIXSET=PM&&TILEMATRIX={z}&TILECOL={x}&TILEROW={y}](https://wxs.ign.fr/_IGN_API_KEY_/wmts?LAYER=GEOGRAPHICALGRIDSYSTEMS.MAPS&EXCEPTIONS=text/xml&FORMAT=image/jpeg&SERVICE=WMTS&VERSION=1.0.0&REQUEST=GetTile&STYLE=normal&TILEMATRIXSET=PM&&TILEMATRIX=%7Bz%7D&TILECOL=%7Bx%7D&TILEROW=%7By%7D)
 La valeur de la clé d'API sera renseignée depuis la page Variables de l'application de l’interface d’administration.
 Ces couches doivent être placée dans les groupes baseLayers pour les couches raster de fond (ex : scan_express), et otherBaseLayers pour les couches raster avec transparence (ex : topage) pouvant être superposées avec une couche de fond.
 Les couches WMTS et de tuiles X/Y/Z doivent être déclarées en tant que tile_layers.
 Les couches WMS doivent être déclarées en tile_layers_wms
 - **Style niveaux de gris :**
 Il est possible d'afficher une couche en niveau  de gris :
 Dans le champ options, ajouter  `className: 'sysma-leaflet-tile-greyscale',`
 - **zoom :**
 Il est possible d'afficher une couche au delà du zoom initialement prévu par le fournisseur. Dans le champ options, utiliser maxNativeZoom et maxZoom pour paramétrer cela, exemple pour les orthophotos de l'iGN : `maxNativeZoom: 19, maxZoom: 22, attribution: '&copy; <a href="https://www.ign.fr/">IGN</a>'`. Les rasters seront pixelisés mais visibles jusqu'au zoom 22.   
 Voici des exemple de code SQL pour reconfigurer vos tiles :
 ``` sql
 -- STEP 01 -  Pas de risque : voir ce que produira le UPDATE (afin de vérifier que le code SQL est bien parametré ):	
 	SELECT  options, 'maxZoom: 22, '|| replace(options ,'maxZoom:','maxNativeZoom:' ) as option_newversion
 	FROM sysma.other_layer
 	WHERE options ilike '%maxZoom%' and options not ilike '%maxNativeZoom%'
 -- STEP 02 : Mise à jour si tout est correct en STEP 01
 UPDATE sysma.other_layer
  SET options= 'maxZoom: 22, '|| replace(options ,'maxZoom:','maxNativeZoom:' )
 WHERE options ilike '%maxZoom%' and options not ilike '%maxNativeZoom%'	
 ```
 ### Simple_pg_layer
 Ce sont des couches vectorielles construites à partir d'une table PG et affichables depuis le sélecteur de couche Sysma, groupe "Couches utiles".
 La déclaration d'un couche simple_pg_layer doit comporter
 * le chemin d'accès à la table dans la base de données PG _schema.table_ . **Ce chemin ne doit pas comporter de majuscules, ni d'espaces, ni d'accent, ni de caractères spéciaux autres que le underscore** (ex : m_etat_ecologique.t_me_prio)
 * le style de la couche au format json, sur le modèle suivant : 
  * style "de base :
 ```json
 {
 "color" : "#9913f8", 
 "fillColor" : "#9913f8", 
 "weight" : 2, 
 "opacity" : 1, 
 "fillOpacity" : 0.2,
 "radius" : 3} 
 ```
 * la correspondance des champs pour permettre à Sysma d'identifier les colonnes comprenant un ID unique, le nom de l'objet et la géométrie de l'objet. Sur le format suivant 
 ```json
 {
 "sysma_object_id":"cdeumassed",
 "sysma_object":"nom_me_court",
 "geo":"geom"
 }
 ```
   * Astuce : il est possible d'afficher le contenu de plusieurs colonnes avec le symbole de concaténation ||, voir même d'afficher un lien dynamique :
 ```json
 {
 "sysma_object_id":"ogc_fid",
 "sysma_object":"lbtypeouvrage||' - '||nomprincipalobstecoul" ,
 "description": "cdobstecoul|| ' <a href=''http://www.sandre.eaufrance.fr/urn.php?urn=urn:sandre:donnees:ObstEcoul:FRA:code:'||cdobstecoul|| ':::::html'' target=''_blank''>Lien fiche sandre</a>'",
 "geo":"geom"
 }
 ```
 * groupe : couches utiles
 ### external_geojson_layer
 A destination des structures qui ont l'observatoire mutualisé : https://gitlab.sevre-nantaise.com/mutualisation-sysma/documentation/-/blob/main/Tutoriels/Observatoire_Dans_Sysma.md
 ### Cas spécifique d'une couche Piwigo (photothèque)
 Sysma peut être connecté à une base de données Piwigo et ainsi afficher une couche de photos géolocalisées.
 Les informations de connexion à la base de données Piwigo doivent être renseignées dans la rubrique Variables de l'application de Sysma Cf. ci-dessous.
 La couche Photo doit être déclarée selon le modèle suivant :
 * Type : piwigo_layer
 * Url : photos
 * Style : {"color" : "#00ffff", "weight" :1, "opacity" : 1, "fillOpacity" : 0.2, "radius" :3} (adaptable)
 # Variables de l'application
 Cette rubrique permet de configurer de nombreuses variables de votre instance Sysma. Notamment :
 * Les données des tables de référence (communes, EPCI, masses d'eau)
 * Positionnement par défaut de la carte
 * Gestion des coûts
 * activation du module offline (cf ci-dessous)
 * etc.
 # Activation/désactivation du module offline
 Ce module peut être géré depuis la page "variables de l'application", via le paramètre Activation du mode Off-line  (SYSMA_OFFLINE_MODE_ENABLED), valeur on ou off.