doc: interface admin

nobohan 2021-10-19 10:20:35 +02:00
parent 6fc9a65c64
commit 7bf07b6d1e
3 changed files with 84 additions and 1 deletions

72
Gestion-des-programmes.md Normal file

@ -0,0 +1,72 @@
Dans l'interface d'administration, le troisième onglet, "Enquêtes", permet d'ajouter et de gérer les programmes d'observations de l'application. Cette accès ne permet pas de gérer les données encodées par les utilisateurs ou importées: pour cela, il faut utiliser la connexion avec QGIS ou directement via la base de données.
L'interface d'administration est accessible via l'adresse "/api/admin". L'onglet "Enquêtes" se subdivise en 5 parties qui permettent d'ajouter ou d'éditer un programme:
1) Projets
2) Zones géographiques
3a) Formulaires dynamiques
3b) Types de sites
4) Programmes
Ces onglets doivent être remplis dans cet ordre pour faire un programme car les programmes ont besoin des autres entités (projets, zones géographiques, formulaires, types de sites).
### 1) Projets
Création d'un projet. Un projet peut contenir plusieurs programmes. Il faut au moins un projet pour ajouter des programmes. Tous les programmes peuvent dépendre du même projet: lors du prototype, un seul projet a été créé.
### 2) Zones géographiques
Définition d'une zone géographique pour les programmes. Une zone géographique doit avoir un nom et un fichier geojson ou kml de type Polygon ou MultiPolygon dans le système de coordonnées WGS84 (EPSG:4326). Typiquement, ce fichier géographique est un polygone représentant le territoire d'une commune.
Pour obtenir facilement un fichier d'une zone géographique, on pourra utiliser un découpage administratif (e.g., [découpage des communes en Belgique](https://www.geo.be/catalog/details/591e7f88-c443-4659-b8b7-23601d647ee6?l=fr)) ou bien à partir d'OpenStreetMap via une requête overpass.
Par exemple, voici la requête utilisée pour retrouver la commune de Wasseiges via overpass-turbo.eu: <http://overpass-turbo.eu/s/15qX>. Lorsque la requête est lancée, on peut télécharger le polygone des limites communales en cliquant sur "Exporter".
```
[out:json][timeout:25];
{{geocodeArea:Wasseiges}}->.searchArea;
(
relation["admin_level"="8"](area.searchArea);
);
out body;
>;
out skel qt;
```
### 3a) Formulaires dynamiques
Définition des formulaires utilisés dans les rapports de visites. Ces formulaires sont utilisés dans les programmes pour qualifier les observations à l'aide d'un rapport de visite.
Ils comprennent un nom et le formulaire en tant que tel sous forme d'un schéma json.
Au moment d'écrire ces lignes, il n'y a pas de documentation exhaustive pour construire ces formulaires, mais les exemples fournis permettent de créer de nouveaux formulaires. En bref:
- les "steps" permettent de décomposer le formulaire en différentes étapes dans le rapport de visites, correspondant à différents écrans.
- les "properties" définissent les données qui peuvent être encodées. Ces "properties" ont différents "types": string, integer, ...
- pour chaque "properties", le type de sélecteur puet être défini: "type": "select" avec un tableau de choix ("titleMap"), "type": "textarea", etc.
NB: par défaut, les photos sont intégrées dans chaque rapport de visite, sans qu'il faille les ajouter au formulaire.
### 3b) Types de sites
Définition des types de sites. Chaque programme doit être qualifié par un ou plusieurs type de site. Par exemple, le programme "Bosquets, buissons, friches & lisières" est qualifié par les sites "Lisières", "Friches", "Buissons", "Bosquets".
Lors de l'ajout d'un site dans un programme, il est demandé de définir le type de site (avant l'encodage d'un rapport de visite).
Chaque type de site comporte un nom (sous "Type"), une catégorie ("Category"), un formulaire ("Custom Form") et en option un pictogramme.
### 4) Programmes
Définition des programmes d'observations. C'est l'entité finale qu'il faut définir pour voir apparaitre un programme dans l'application. Nous détaillons ici un programme de type "site":
- module: "sites" ou "observations"
- custom form: formulaire dynamique défini en 3a) pour les rapports de visites
- geometry: zone géographique défini en 2). Le programme ne pourra être utilisé que dans cette zone.
- project: projet défini en 1).
- title: titre du programme, apparaissant dans l'application
- short desc: description courte, apparaissant dans l'application
- long desc: description longue. Celle-ci n'est pas utilisée dans l'application.
- geometry type: type de géométrie que l'on veut éditer. Cette géométrie peut être de 3 types: POINT, LINESTRING (ligne) ou POLYGON. Ce champ détermine le type d'encodage des géométries du programme. Il n'est pas possible de combiner plusieurs types de géométries dans un programme.
- image ou logo: chemin relatif ou absolu vers une image pour définir l'image du programme apparaissant en médaillon (voir Ajouter/changer une image d'un programme). Exemple: ../api/media/lisiere.jpg
- types de site: ajouter un ou plusieurs types de sites

@ -0,0 +1,5 @@
Dans l'interface d'administration, le deuxième onglet, "Utilisateurs", permet de visualiser et de gérer les utilisateurs inscrits sur l'application Biommap.
Cette page liste tous les utilisateurs inscrits. Pour chaque utilisateur, lorsqu'on clique sur l'icône d'édition, on peut changer les caractéristiques de l'utilisateur: nom, prénom, nom d'utilisateur, email, téléphone, organisation, une image d'avatar, et 2 cases à cocher pour 1) activer ou non l'utilisateur et 2) donner les droits d'administrateur.
La création d'un utilisateur se fait via l'application Biommap via échanges d'email (après avoir cliqué sur "Créez votre compte"). Un serveur SMTP doit être branché dans l'application pour cela. A priori, l'interface d'administration des utilisateurs n'est pas utilisée pour ajouter des utilisateurs.

@ -1 +1,7 @@
Il existe un projet QGIS qui permet de lire les données de la base de données.
Il existe un projet QGIS qui permet de lire les données de la base de données.
Procédure avec screenshot pour ajouter les couches
note sur l'accès à distance d'une db
test accès API en geojson