update doc (API et UI)

Author: alainabbas

docs/.vuepress/config.js

@@ -57,7 +57,22 @@ theme: defaultTheme({
              'backend_AD',
              'backend_LDAP'
           ]
-        }
+        },
+          {
+              text: "Utilisation de l'API",
+              prefix: '/Api',
+              children: [
+                  'filtres',
+                  'photo'
+              ]
+          },
+          {
+              text: "Personalisation de l'UI",
+              prefix: '/Ui',
+              children: [
+                  'personalisation_tuiles',
+              ]
+          }
 
       ],
     },

docs/Api/filtres.md

@@ -0,0 +1,82 @@
+# Les filtres de recherches pour l'API 
+L'api a une fonctionnalité de recherche (**GET /management/identities**) qui permet de rechercher les identités
+
+Un filtre peut être passé dans l'url de l'api (methode **GET /management/identities**) pour rechercher les identités selon des critère spécifique
+
+## Syntaxe des filtres à passer en paramètre dans l'url 
+La méthode est GET 
+### Syntaxe
+La syntaxe générale du paramètre est :
+* filters[OPERATEUR + CHAMP]=SEARCH
+### Les champs
+| champ     | Description                  |
+|-----------|------------------------------|
+| OPERATEUR | l'opérateur (voir en dessous |
+| CHAMP     | le champ dans l'identité     |
+| SEARCH    | La chaine recherchée         |
+
+### Les opérateurs
+| Filter | Description               |
+|-------|---------------------------|
+| :     | égal                      |
+| #     | nombre égal               |
+| !#    | Nombre non égal           |
+| !:    | Non égal                  |
+| \>    | Nombre plus grand |
+| \>\|  | Nombre plus grand ou égal |
+| \<    | Nombre plus petit         |
+| \<\|  | Nombre plus petit ou égal |
+| \^    | Expression régulière      |
+
+### Exemples 
+Vous pouvez tester votre filtre et confectionner votre requete à l'aide de swagger qui est disponible sur l'orchestrator à L'url : https://monOrchestrator:4443/swagger
+* Rechercher l'uid = "toto"
+```
+filters[:inetOrgPerson.uid]=edurand
+```
+Dans l'interface swagger le filtre se saisit en JSON : 
+```json
+{
+ ":inetOrgPerson.uid" : "edurand"
+}
+```
+![img.png](img.png)
+* Rechercher tous les identités qui ne sont pas "adm"
+```
+filters[!additionalFields.attributes.supannPerson.supannEntiteAffectationPrincipale]=adm
+```
+Dans l'interface swagger le filtre se saisit en JSON :
+```
+{
+ "!additionalFields.attributes.supannPerson.supannEntiteAffectationPrincipale" : "adm"
+}
+```
+![img_1.png](img_1.png)
+
+## Champs struturels 
+Voici la liste des champs structurels disponibles dans une identité
+
+| Champ                  | Description                                                 |
+|------------------------|-------------------------------------------------------------|
+| **state**              | Etat de l'identité                                          |
+|                        | 0 : indeterminé                                             | 
+|                        | 1 : à valider                                               |
+|                        | 2 : à synchroniser    (envoi aux backends                   |
+|                        | 50 : En cours de synchronisation                            |
+|                        | 99 : synchronisée                                           |
+|                        | -2 : à compléter                                            |
+|                        | -99 : ne plus synchroniser (envoi aux backends)             |
+| **initState**          | Statut d'envoi du mail de réinitialisation du mot de passe  |
+|                        | 0 : le mail n'a jamais été envoyé                           | 
+|                        | 1 : Le mail a été envoyé                                    | 
+|                        | 2 : le compte a été activé                                  | 
+| **dataStatus**         | Etat d'activation de l'identité                             |
+|                        | 0 : l'identité est desactivée                               | 
+|                        | 1 : l'identité est active                                   |
+|                        | -1 : l'identité est supprimée et ne doit plus être importée |
+| **metadata.createdBy** | Utilisateur qui a créé l'identité                           |
+| **metadata.createdAt** | Date de création                                            |
+| **metadata.lastUpdatedBy** | Dernier utilisateur qui a modifié l'identité                |
+| **metadata.lastUpdatedAt** | Date de la dernière  modification                           |
+
+

docs/Api/img.png

@@ -0,0 +1,15 @@
+# récupération de la photo d'une identité
+Une entrée de l'api est disponible pour pouvoir télécharger la photo d'une identité
+
+Procedure :
+* Récupérer le champs **inetOrgPerson.employeeNumber** de l'identité
+* Appeler l'api avec ce numéro
+
+Appel : GET /core/filestorage/path
+* Parametres : namespace = "identities"
+* path : TAIGA/*\<EMPLOYEENUMBER\>*/jpegPhoto.jpg
+* mime : photo/jpeg
+
+### Exemple 
+Téléchargement de la photo pour l'identité 185033
+![img_2.png](img_2.png)

docs/Api/img_1.png

@@ -0,0 +1,52 @@
+# Personalisation des tuiles de la page d 'accueil'
+Des tuiles peuvent être ajoutées sur la page d'accueil et certaines modifiées.
+
+![img.png](img.png)
+
+## Fichier de configuration 
+Le fichier de configuration est : ./configs/sesame-app-manager/config/menu.yml
+```yaml
+entries:
+  - icon: mdi-account-off
+    label: Etudiants
+    path: "/identities?sort[metadata.lastUpdatedAt]=desc&skip=0&filters[^additionalFields.attributes.supannPerson.supannTypeEntiteAffectation]=/etd/i"
+    color: primary
+    part: Affectations
+    badgeValue: ETD
+
+  - icon: mdi-account-tie
+    label: Administratifs
+    path: "/identities?sort[metadata.lastUpdatedAt]=desc&skip=0&filters[^additionalFields.attributes.supannPerson.supannTypeEntiteAffectation]=/adm/i"
+    color: primary
+    part: Affectations
+    badgeValue: ADM
+
+  - icon: mdi-account-group
+    label: Enseignants
+    path: "/identities?sort[metadata.lastUpdatedAt]=desc&skip=0&filters[^additionalFields.attributes.supannPerson.supannTypeEntiteAffectation]=/esn/i"
+    color: primary
+    part: Affectations
+    badgeValue: ESN
+
+```
+### Description d'une entrée
+* **icon** : Choix de l'icone (choisir dans https://pictogrammers.com/library/mdi/) (faire précéder le nom par le prefix mdi-)
+* **label** : Le texte affiché dans la tuile
+* **path** : chemin de l'url à appeler 
+* **color** : Nom de la couleur dans la palette du framework Quasar (https://quasar.dev/style/color-palette)
+* **part** : dans quelle section mettre la tuile (Données | Listes | Affectations | Etats | Affectations)
+
+### Exemple 
+Nous voulons une tuile qui affiche les identités désactivées dans la section Listes
+
+Dans le fichier menu.yml on ajoute une entrée:
+```yaml
+  - icon: mdi-account-cancel
+    label: Identitées désactivées
+    path: "/identities?sort[metadata.lastUpdatedAt]=desc&skip=0&filters[:dataStatus]=0"
+    color: red-10
+    part: Listes
+```
+Ce qui donnera dans l'interface : 
+
+![img_1.png](img_1.png)