Skip to content

Commit 4b072a1

Browse files
committed
doc pages
1 parent ed58e50 commit 4b072a1

File tree

20 files changed

+375
-21
lines changed

20 files changed

+375
-21
lines changed

docs/pages/audits/table.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,31 @@ description: Documentation de la page /audits/table dans Sesame-Orchestrator
66

77
# Table audits
88

9-
Cette page documente l’écran `table` des audits (route `/audits/table`).
9+
Cette page affiche l’historique global des changements (route `/audits/table`) avec recherche, filtres, et visualisation de diff.
10+
11+
## Contenu de l’interface
12+
13+
- **Barre d’outils** :
14+
- titre “Historique global des changements”
15+
- bouton refresh
16+
- **Filtres** :
17+
- `sesame-core-pan-filters` (recherche simple : collection, auteur, opération, …)
18+
- sélection “Collection” (chargée dynamiquement, clearable)
19+
- **Table** : pagination serveur (page/limit tri), chips pour :
20+
- opération (couleur + label)
21+
- collection
22+
- document (cliquable pour certaines collections)
23+
- aperçu des changements (jusqu’à 4 chips + compteur)
24+
- **Diff** : bouton loupe ouvre un dialog maximisé avec `LazyMonacoDiffEditor` (JSON).
25+
26+
## Données / API
27+
28+
- **Collections** : `GET /core/audits/collections`
29+
- **Liste** : `GET /core/audits` (avec query `page`, `limit`, `search`, `coll`, tri)
30+
- **Détail** : `GET /core/audits/<id>` (via `fetchAuditDetails`)
31+
32+
## Raccourcis
33+
34+
- Si `coll === "Identities"` : lien vers `/identities/table/<documentId>`
35+
- Si `coll === "Agents"` : lien vers `/settings/agents/<documentId>`
1036

docs/pages/identities/export.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,22 @@ description: Documentation de la page /identities/export dans Sesame-Orchestrato
66

77
# Export
88

9-
Cette page documente la section `export` des identités de Sesame-Orchestrator (route `/identities/export`).
9+
Cette page permet d’exporter des identités (route `/identities/export`).
10+
11+
## Contenu de l’interface
12+
13+
- **Bouton** “Exporter” : lance le téléchargement.
14+
- **Sélecteur** de format : `CSV` ou `JSON`.
15+
- **Filtres** : `sesame-core-pan-filters` (mode “complex”).
16+
- **Table** : `q-table` affichant les lignes exportables selon les colonnes calculées.
17+
18+
## Données / API
19+
20+
- **Colonnes disponibles** : `GET /management/identities/validation` (liste des champs schemas → transformée en colonnes de table).
21+
- **Données** : `GET /management/identities?sort[inetOrgPerson.cn]=asc` avec `limit: 9999` + query courante (hors `read`).
22+
23+
## Export
24+
25+
- **CSV** : génération côté client (séparateur `;`, séparateur tableau `,`, fin de ligne `\\r\\n`), téléchargement `sesame-export.csv`.
26+
- **JSON** : téléchargement brut du payload API (avec `total`, `data`, …) en `sesame-export.json`.
1027

docs/pages/identities/fusion.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,32 @@ description: Documentation de la page /identities/fusion dans Sesame-Orchestrato
66

77
# Fusion
88

9-
Cette page documente la section `fusion` des identités de Sesame-Orchestrator (route `/identities/fusion`).
9+
Cette page aide à **détecter et fusionner des identités en double** (route `/identities/fusion`).
10+
11+
## Contenu de l’interface
12+
13+
- **Table** “Détection des identités en double” listant des paires d’identités.
14+
- **Filtre** “Filtrer les fusions ignorées” (`includeIgnored`).
15+
- **Actions sur une paire** :
16+
- éditer identité 1 / identité 2 (ouvre un formulaire)
17+
- fusionner (dans un sens ou dans l’autre)
18+
- supprimer une identité
19+
- ignorer / réactiver l’alerte de fusion (toggle)
20+
21+
## Edition
22+
23+
L’édition se fait dans un **dialog plein écran** avec :
24+
25+
- un rendu `sesame-core-jsonforms-renderer` (schema `inetOrgPerson` + onglets `additionalFields.attributes[...]`)
26+
- un bouton **Enregistrer**.
27+
28+
## Données / API
29+
30+
- **Liste des doublons** : `GET /management/identities/duplicates` (query = `route.query`).
31+
- **Ignorer** : `POST /management/identities/ignore-fusion` (body `{ ids }`).
32+
- **Réactiver** : `POST /management/identities/unignore-fusion` (body `{ ids }`).
33+
- **Fusion** : `POST /management/identities/fusion` (body `{ id1, id2 }`), puis ouverture de l’identité résultante.
34+
- **Chargement identité** (édition) : `GET /management/identities/<id>`.
35+
- **Sauvegarde identité** (édition) : `PATCH /management/identities/<id>`.
36+
- **Suppression** : `POST /core/backends/delete` (payload `[id]`).
1037

docs/pages/identities/index.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,17 @@ description: Documentation de la page /identities dans Sesame-Orchestrator
66

77
# Identités
88

9-
Cette page documente la section des identités de Sesame-Orchestrator (route `/identities`).
9+
Cette page est une **page de transition** (route `/identities`) qui indique que la section a été déplacée et redirige vers `/identities/table`.
10+
11+
## Contenu de l’interface
12+
13+
- Message : “Page d'identité déplacée”
14+
- Indication : “Ajoutez `/table` dans l'URL…”
15+
- Lien vers le nouveau chemin
16+
- Compte à rebours avant redirection automatique
17+
18+
## Comportement
19+
20+
- **Nouveau chemin** : construit en remplaçant `'/identities'` par `'/identities/table'` sur l’URL courante.
21+
- **Redirection** : automatique après 10 secondes (`router.replace(newPath)`).
1022

docs/pages/identities/outdated.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,16 @@ description: Documentation de la page /identities/outdated dans Sesame-Orchestra
66

77
# Identités obsolètes
88

9-
Cette page documente la section `outdated` des identités (route `/identities/outdated`).
9+
Cette page liste les identités dont **l’invitation n’est plus valide** (route `/identities/outdated`) et permet de **réenvoyer** l’invitation.
10+
11+
## Contenu de l’interface
12+
13+
- **Table** `q-table` (sélection multiple).
14+
- **Action** “Réenvoyer le mail d'invitation” activée uniquement si au moins une ligne est sélectionnée.
15+
16+
## Données / API
17+
18+
- **Liste** : `GET /management/passwd/ioutdated`
19+
- **Ré-envoi invitation** (sélection ou tout) : `POST /management/passwd/initmany` (body `{ ids }`)
20+
- **Colonnes** : construites au `mounted()` via `GET /management/identities/validation` (construction dynamique à partir des schémas).
1021

docs/pages/identities/table.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,41 @@
11
---
22
lang: fr-FR
3-
title: Détail identité
4-
description: Documentation de la page /identities/table/:_id dans Sesame-Orchestrator
3+
title: Table des identités
4+
description: Documentation de la page /identities/table (et écrans de détail associés) dans Sesame-Orchestrator
55
---
66

7-
# Détail identité
7+
# Table des identités
8+
9+
Cette page documente l’écran de liste des identités (route `/identities/table`) et regroupe aussi la documentation des écrans de détail.
10+
11+
## Liste des identités (`/identities/table`)
12+
13+
### Contenu de l’interface
14+
15+
- **Table + panneau** : composant `sesame-core-twopan` (titre “Gestion des identités”).
16+
- **Filtres** : `sesame-core-pan-filters` (mode “complex”), placeholder “Rechercher par nom, prénom, email, …”.
17+
- **Actions de masse** (sur sélection multiple) :
18+
- “Mettre à synchroniser” (`mdi-sync`)
19+
- “Envoyer le mail d'invitation” (`mdi-email-arrow-right`)
20+
- “Supprimer en masse” (`mdi-delete`)
21+
- “Nettoyer la sélection” (`mdi-cancel`)
22+
- **Création** : bouton `+` vers `/identities/table/<NewTargetId>?schema=inetOrgPerson` (soumis à permission `create` sur `/management/identities`).
23+
- **Actions ligne** :
24+
- “Voir” → `/identities/table/<id>`
25+
- menu (tabs) : Fiche identité, Historique des changements, Journaux des tâches, Historique des cycles de vie, Debug (si mode debug)
26+
27+
### Données / API
28+
29+
- **Liste** : `GET /management/identities` (pagination via `usePagination()`).
30+
- **Changement d’état** : `PATCH /management/identities/state` (mise à jour par lot).
31+
- **Initialisation mot de passe (invitation)** : `POST /management/passwd/initmany`.
32+
- **Suppression (backend)** : `POST /core/backends/delete`.
33+
34+
## Détail d’une identité (`/identities/table/:_id`)
35+
36+
- **En-tête** : retour vers la liste + affichage de l’état + nom (`inetOrgPerson.cn`) + type (`inetOrgPerson.employeeType`).
37+
- **Onglets** : l’écran de détail reprend les “tabs” (fiche/audits/jobs/lifecycle/debug) quand l’identité n’est pas “nouvelle” et selon permissions.
38+
- **Chargement** : `GET /management/identities/<id>` (404 si inexistante).
39+
- **Création** : si `:_id === NewTargetId`, l’écran initialise une identité vide (state `TO_CREATE`) et permet la saisie.
840

9-
Cette page documente l’écran de détail d’une identité (route `/identities/table/:_id`).
1041

docs/pages/identities/trash.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,23 @@ description: Documentation de la page /identities/trash dans Sesame-Orchestrator
66

77
# Corbeille
88

9-
Cette page documente la section `trash` des identités (route `/identities/trash`).
9+
Cette page liste les identités supprimées (route `/identities/trash`) et permet de **consulter** ou **restaurer** une identité.
10+
11+
## Contenu de l’interface
12+
13+
- **Table + panneau** : `sesame-core-twopan` avec titre “Suivi des identités supprimées”.
14+
- **Actions ligne** :
15+
- voir la fiche supprimée → `/identities/trash/<id>`
16+
- restaurer (`mdi-restore`) si permission `update` sur `/management/identities`
17+
18+
## Données / API
19+
20+
- **Liste** : `GET /management/identities/getdeleted`
21+
- **Restaurer** : `POST /core/backends/undelete` (payload `[id]`)
22+
23+
## Détail d’une identité supprimée (`/identities/trash/:_id`)
24+
25+
- Barre d’actions : retour vers la liste + bouton restaurer.
26+
- Lecture : chargement via `GET /management/identities/<id>` puis affichage en lecture seule via `sesame-core-jsonforms-renderer`.
27+
- Sauvegarde (bouton “disquette”) : `PATCH /management/identities/<id>` (utile pour corriger/compléter avant restauration).
1028

docs/pages/index.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,20 @@ description: Documentation de la page / dans Sesame-Orchestrator
66

77
# Accueil
88

9-
Cette page documente l’écran d’accueil de Sesame-Orchestrator (route `/`).
9+
Cette page correspond au **dashboard** de Sesame-Orchestrator (route `/`).
10+
11+
## Contenu de l’interface
12+
13+
- **Sections (parts)** : les tuiles sont regroupées par “parties” (titre affiché via une barre `q-bar`).
14+
- **Tuiles de navigation** : chaque tuile est un `q-btn` qui navigue vers `item.path`.
15+
- **Badge optionnel** : une tuile peut afficher un `q-badge` (valeur + couleurs).
16+
- **Menu contextuel** (clic droit) :
17+
- “Ouvrir”
18+
- “Ouvrir dans un nouvel onglet”
19+
- “Debug” (uniquement si le mode debug est actif)
20+
21+
## Comportement / logique
22+
23+
- **Source des entrées** : les menus proviennent de `useMenu(...)` (via le store `useIdentityStateStore()`).
24+
- **Masquage** : une tuile peut être masquée si `hideInDashboard === true`.
1025

docs/pages/jobs/details.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,18 @@ description: Documentation de la page /jobs/details dans Sesame-Orchestrator
66

77
# Détails job
88

9-
Cette page documente l’écran `details` des jobs (route `/jobs/details`).
9+
Cette page affiche les jobs sous forme de **timeline** avec défilement infini (route `/jobs/details`).
10+
11+
## Contenu de l’interface
12+
13+
- **Regroupement** : select “Regrouper par” (Jour / Mois / Année) via `jobsBy`.
14+
- **Timeline** :
15+
- chaque entrée affiche `[jobId]` + nom/prénom (si disponibles)
16+
- sous-titre : action + date/heure
17+
- onglets : “Paramètres d'appel” (params) et “Résultat” (result), affichés via `LazyMonacoEditor`.
18+
- **Défilement infini** : charge 10 jobs par page.
19+
20+
## Données / API
21+
22+
- **Chargement incrémental** : `GET /core/jobs/` avec `limit=10`, `skip=(index-1)*10`, tri `sort[metadata.lastUpdatedAt]=desc` + query courante.
1023

docs/pages/jobs/table.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,23 @@ description: Documentation de la page /jobs/table dans Sesame-Orchestrator
66

77
# Table jobs
88

9-
Cette page documente l’écran `table` des jobs (route `/jobs/table`).
9+
Cette page affiche le **journal des jobs** (route `/jobs/table`) sous forme de table paginée, avec filtre d’état et aperçu du résultat.
10+
11+
## Contenu de l’interface
12+
13+
- **Filtre d’état** : select “Filtrer par état” (valeurs typiques : Ok / En erreur).
14+
- **Table** (pagination serveur) :
15+
- statut
16+
- n° job
17+
- identité concernée (chip cliquable si connue)
18+
- action
19+
- date
20+
- **Résultat** :
21+
- bouton par ligne pour afficher/masquer le résultat (`props.row.result`)
22+
- affichage JSON dans `LazyMonacoEditor`
23+
24+
## Données / API
25+
26+
- **Liste** : `GET /core/jobs` (tri `sort[metadata.lastUpdatedAt]=desc`, pagination via `page/limit/skip`).
27+
- **Filtre d’état** : query `filters[:state]` (ex. `9` = OK, `-1` = erreur).
1028

0 commit comments

Comments
 (0)