Merge branch '1318-documentation-cartads' into 'master'

Resolve "Documentation cartads"

Closes #1318

See merge request Development/vitis-2020/applications/vmap!69

doc/source/administrator/cartads/config_module.md

+# Configuration du module CartAds
+
+## Prérequis
+
+Une fois installé, le module CartAds nécessite quelques étapes de configuration pour fonctionner.
+
+Avant toute chose, il est nécessaire de rendre l'administration du module accessible depuis l'interface de vMap2, mode "Configuration > Configuration des modules".  
+![conf_generale](../../images/administrator/cartads/configuration.png)
+
+Ce mode est disponible : 
+- Lorsque l'utilisateur dispose du privilège cartads_admin
+- Lorsque la valeur de la propriété "enable_module_configuration" du fichier "./src/vitis/vas/src/Module/Vitis/conf/properties.json" est à true
+
+Si le mode "Configuration des modules" n'est pas accessible depuis l'interface réaliser les étapes suivantes : 
+
+* 1 - Editer le fichier "./src/vitis/vas/src/Module/Vitis/conf/properties.json"
+* 2 - Rechercher "enable_module_configuration" et affecter à true la valeur de la propriété.
+* 3 - Enregistrer le fichier et raffraichir l'application pour que le mode "Configuration > Configuration des modules" soit disponible
+
+
+## Configurations générales
+
+![conf_generale](../../images/administrator/cartads/configuration_parameters.png)
+
+Depuis l'interface d'administration de vMap, définir les 3 paramètres suivants :  
+**-** Nom du schema de cartads<br>
+**-** Nom de l'utilisateur du module cartads<br>
+**-** Mot de passe de l'utilisateur du module cartads
+
+
+Le nom d'utilisateur et le mot de passe seront utilisés pour se connecter à la base de données de vMap afin de récupérer les informations d'urbanisme qui intersectent une parcelle en particuplier.
+
+```{Note}
+Il est nécessaire que cet utilisateur ait les droits sur les tables interrogées.
+```
+
+## Configurations "Jointure spatiale"
+
+
+![conf_generale](../../images/administrator/cartads/configuration_parameters_jointures.png)
+
+```{Note}
+Les paramètres "Schema", "Table" et "Code" n'ont pas vocation a être modifiés. La table sig.parcelle_cartads stocke les informations des parcelles dont l'identifiant (id_par_cartads) est stocké au format CartAds.
+```
+
+```{Note}
+- Le champ géométrique doit obligtoirement être nommé "geom".
+```
+
+Explication du format de l'identifiant de parcelle fourni par la documentation (version 1.1) d'Inetum :
+![conf_generale](../../images/administrator/cartads/doc_cartads.png)
+
+
+## Configurations "Intersections"
+
+![conf_generale](../../images/administrator/cartads/configuration_parameters_intersections.png)
+
+La configuration "Intersections" permet de paramétrer dans un format JSON l'ensemble des tables qui seront interrogées par le module CartAds afin de retrouver toutes les données qui intersectent une parcelle (par exemple : un zonage, une prescription...).
+
+La configuration JSON attendue accepte les paramètres suivants :  
+
+| Nom du champ | Type de champ        | Obligatoire ? | Description                                                                                               |
+|--------------|----------------------|---------------|-----------------------------------------------------------------------------------------------------------|
+| schema       | chaîne de caractères | Oui           | Schéma dans lequel se trouve la table à intersecter                                                       |
+| table        | chaîne de caractères | Oui           | Table à intersecter                                                                                       |
+| nom        | chaîne de caractères | Oui           | Champ de la table contenant le "NOM" :<br> Nom de la zone                                                  |
+| cos        | chaîne de caractères | Oui           | Champ de la table contenant le "COS" :<br> Valeur du coefficient d'occupation des sols (champ rempli si disponible dans vos données, uniquement pour les zones de type « Zonage »)                                                   |
+| ces        | chaîne de caractères | Oui           | Champ de la table contenant le "CES" :<br> Valeur du coefficient d'emprise au sol (champ rempli si disponible dans vos données, uniquement pour les zones de type « Zonage »)                                                   |
+| nature        | chaîne de caractères | Oui           | Champ de la table contenant la "NATURE" :<br> Nature de la zone (champ rempli si disponible dans vos données)                                                   |
+| observation        | chaîne de caractères | Oui           | Champ de la table contenant "L'OBSERVATION" :<br> Observation relative à la zone (champ rempli si disponible dans les données)                                                   |
+| type        | objet | Oui           | Type de la zone                                                    |
+
+Objet **type** :  
+
+| Nom du champ | Type de champ        | Obligatoire ? | Description                                                                                               |
+|--------------|----------------------|---------------|-----------------------------------------------------------------------------------------------------------|
+| nom        | chaîne de caractères | Oui           | Champ de la table contenant le nom :<br> Nom du type de zone (valeurs possibles : Zonage, Contrainte annexe, Servitude d'utilité publique, Prescription d'urbanisme, Document annexe)                                                  |
+| code        | chaîne de caractères | Oui           | Champ de la table contenant le code :<br> Code du type de zone (valeurs possibles : Z, C, S, P ou D)                                                  |
+
+
+
+Ci-dessous, un exemple fictif de document JSON pour les intersections :
+
+```js
+[
+  {
+    "schema": "data_demo_vmap",
+    "table": "f_fleuves_l93",
+    "nom": "nom_riviere",
+    "observation": "valeur_observation",
+    "cos": "valeur_cos",
+    "ces": "valeur_ces",
+    "nature": "valeur_nature",
+    "type": {
+      "nom": "valeur_type_nom",
+      "code": "valeur_type_code"
+    }
+  }
+]
+```
+
+## Webservice retournant les intersections
+
+Le webService développé par Veremes et permettant de retourner l'ensemble des contraintes intersectant une parcelle est accessible depuis l'URL suivante :  
+
+
+* https://[nom_de_domaine]/[alias_rest]/v2/cartads/parcelles/contraintes
+
+Avec :
+
+* [nom_de_domaine] correspondant au nom de domaine pour accéder à l'application vMap2
+* [alias_rest] correspondant à l'alias du serveur Apache
\ No newline at end of file

doc/source/administrator/cartads/index.rst

+Module CartAds
+============================================
+
+--------------
+Cette section concerne la documentation de l'installation et la configuration du module CartAds de vMap. 
+
+============================================
+
+.. toctree::
+   :maxdepth: 2
+
+   installation.md
+   config_module.md

doc/source/administrator/cartads/installation.md

+# Prérequis, téléchargement et installation
+
+## Pré-requis
+
+Le module CartAds nécessite la version 2024.01.00 (minimum) de vMap2 pour fonctionner.
+
+## Téléchargement
+
+Le module Cart@ds est téléchargeable sur le [vStore](https://vstore.veremes.net/vstore/login) de la société Veremes, section vMap.
+
+Une fois connecté, télécharger le setup de cartAds en fonction du système d'exploitation de votre installation vMap2.
+
+![Télechargement de CartAds](../../images/administrator/cartads/telechargement_cartads.png)
+
+## Procédure d'installation
+
+
+Pour installer CartAds, se rendre sur le serveur, dézipper le dossier téléchargé puis éditez le fichier **dependencies_mod.json** afin d'y définir les paramètres suivants :
+
+
+| Variable | Description |
+|--------------|--------------------|
+|POSTGRES_HOST| Serveur de la base de données |
+|POSTGRES_PORT| Port d'accès à la base de données |
+|POSTGRES_DB| Nom de la base de données (la base de données doit être celle de vmap)|
+|POSTGRES_USER| Compte d'un superutilisateur de la base |
+|POSTGRES_PASSWORD| Mot de passe du compte superutilisateur |
+
+L'installeur du module CartAds créé un utilisateur "cartads" dont il est conseillé de modifier le mot de passe. Pour cela, tout en bas du fichier, éditer le paramètre "password" défini dans le tableau **users** de la section **module** :
+
+```js
+{
+  ...
+  "module" : {
+    ...
+    "users": {
+      "cartads": {
+        "grouproles": [
+          "vmap_cadastre_light_user",
+          "vitis_user"
+        ],
+        "login": true,
+        "password": "",
+        "roles": [
+          "LOGIN"
+        ]
+      }
+    }
+  }
+}
+```
+
+Une fois le mot de passe de l'utilisateur "cartads" modifié, lancer l'installateur pour installer le module.
+
+
+L’installateur de CartAds assure les opérations suivantes :
+  * Copie du code du module
+  * Création d'un schéma veremes_cartads dans la base de données PostgreSQL
+  * Création des tables dans la base de données PostgreSQL permettant au module de stocker les dossiers et parcelles ADS.

doc/source/administrator/index.rst

@@ -19,4 +19,5 @@ Il est conseillé aux administrateurs de consulter en premier la `Documentation
    api/api.rst
    journaux.md
    cadastre/index.rst
+   cartads/index.rst
    flux/flux.md