Update the documentation to reflect all changes in the emaj_web clien…

…t UI.
dalibo · Jul 23, 2020 · 7d2c6da · 7d2c6da
1 parent 9fc8611
commit 7d2c6da
Show file tree

Hide file tree

Showing 26 changed files with 25 additions and 38 deletions.
diff --git a/docs/en/images/emajweb_browser.png b/docs/en/images/emajweb_browser.png
diff --git a/docs/en/images/emajweb_emaj.png b/docs/en/images/emajweb_emaj.png
diff --git a/docs/en/images/emajweb_filter.png b/docs/en/images/emajweb_filter.png
diff --git a/docs/en/images/emajweb_groupcontent.png b/docs/en/images/emajweb_groupcontent.png
diff --git a/docs/en/images/emajweb_groupproperties.png b/docs/en/images/emajweb_groupproperties.png
diff --git a/docs/en/images/emajweb_groups.png b/docs/en/images/emajweb_groups.png
diff --git a/docs/en/images/emajweb_groupstat.png b/docs/en/images/emajweb_groupstat.png
diff --git a/docs/en/images/emajweb_rollbackdetails.png b/docs/en/images/emajweb_rollbackdetails.png
diff --git a/docs/en/images/emajweb_rollbacks.png b/docs/en/images/emajweb_rollbacks.png
diff --git a/docs/en/images/emajweb_rollbacksim.png b/docs/en/images/emajweb_rollbacksim.png
diff --git a/docs/en/images/emajweb_schemas.png b/docs/en/images/emajweb_schemas.png
diff --git a/docs/en/images/emajweb_triggers.png b/docs/en/images/emajweb_triggers.png
diff --git a/docs/en/webUsage.rst b/docs/en/webUsage.rst
@@ -17,6 +17,7 @@ On the left, the browser tree shows all the configured instances, that may be sp
 
 	Figure 1 – The browser tree.
 
+Both icons located at the bottom-right allow to adjust the browser width.
 
 Tables groups list
 ------------------
@@ -54,7 +55,7 @@ The page headers contain:
 * 3 links to reach the SQL statements editor, the history of submitted statements and to logout the current connection,
 * a combo box to select the language used by the user interface,
 * a breadcrumb trail,
-* and a button allowing to directly go to the page bottom.
+* and a button to directly go to the page bottom.
 
 The user can navigate in Emaj_web functions using two icon bars: one for the general purpose functions and the other for the functions concerning a single tables group.
 
@@ -81,6 +82,9 @@ On some tables too, an icon located at the left of the header row, let show or h
 
 Some tables allow to perform actions on several objects at once. In this case, the user selects the objects with the checkboxes on the first column of the table and choose the action to perform among the available buttons under the table.
 
+Columns containing comments have a limited size. But the full comment content is visible in tooltip when the mouse goes over the cell.
+
+Cells containing event timestamps or durations show a full data content in tooltip.
 
 Tables group details
 --------------------
@@ -120,8 +124,6 @@ Two types of statistics can be produced:
 * some estimates about the number of updates per table, recorded between two marks or between one mark and the current situation,
 * a precise numbering of updates per tables, per statement type (*INSERT/UPDATE/DELETE/TRUNCATE*) and role.
 
-If the end of the range corresponds to the current situation, a check box allows one to request a rollback simulation to the selected mark in order to quickly get an approximate duration of this operation.
-
 The figure below shows an example of detailed statistics.
 
 .. figure:: images/emajweb_groupstat.png
@@ -133,13 +135,6 @@ The displayed page contains a first line returning global counters.
 
 On each line of the statistics table, the user can click on a “*SQL*” button to easily look at the log tables content. A click on this button opens the SQL editor window and proposes the statement displaying the content of the log table that corresponds to the selection (table, time frame, role, statement type). The user can modify this suggested statement before executing it to better fit his needs.
 
-.. figure:: images/emajweb_rollbacksim.png
-   :align: center
-
-   Figure 8 – Result of the rollback simulation, with the estimated number of updates for each table. 
-
-The displayed page contains a first part indicating the number of tables and sequences concerned by the rollback operation to this mark, and an estimate of the operation duration.
-
 Tables group content
 --------------------
 
@@ -150,7 +145,7 @@ For each table and sequence belonging to the group, the displayed table shows th
 .. figure:: images/emajweb_groupcontent.png
    :align: center
 
-   Figure 9 – A tables group's content.
+   Figure 8 – A tables group's content.
 
 
 Schemas and tables groups configuration
@@ -165,7 +160,7 @@ For both lists, the E-Maj properties and some general properties of each object
 .. figure:: images/emajweb_schemas.png
    :align: center
 
-   Figure 10 – Schema content and tables groups configuration.
+   Figure 9 – Schema content and tables groups configuration.
 
 
 Triggers
@@ -178,25 +173,23 @@ A button allows to switch their de-activation mode at E-Maj rollback time.
 .. figure:: images/emajweb_triggers.png
    :align: center
 
-   Figure 11 – Application triggers list.
+   Figure 10 – Application triggers list.
 
 Monitoring rollback operations
 ------------------------------
 
 Using the “*Rollback operations*” tab of the main bar, users can monitor the rollback operations. Three different lists are displayed:
 
 * in progress rollback operations, with the characteristics of the rollback operations and estimates of the percentage of the operation already done and of the remaining duration,
-* the latest completed operations,
+* the completed operations,
 * logged rollback operations that are consolidable.
 
-For completed operations, the user can filter on a more or less deep history.
-
 For each consolidable rollback, a button allows to effectively consolidate the operation.
 
 .. figure:: images/emajweb_rollbacks.png
    :align: center
 
-   Figure 12 – Rollback operations monitoring.
+   Figure 11 – Rollback operations monitoring.
 
 Clicking on a rollback identifier in one of these tables displays a page that shows information details about the selected in progress or completed operation.
 
@@ -212,7 +205,7 @@ More precisely, are displayed:
 .. figure:: images/emajweb_rollbackdetails.png
    :align: center
 
-   Figure 13 – Details of a Rollback operation.
+   Figure 12 – Details of a Rollback operation.
 
 E-Maj environment state
 -----------------------
@@ -235,4 +228,4 @@ Two buttons allow to export and import parameters configurations to or from a lo
 .. figure:: images/emajweb_emaj.png
    :align: center
 
-   Figure 14 – The E-Maj environment state.
+   Figure 13 – The E-Maj environment state.
diff --git a/docs/fr/images/emajweb_browser.png b/docs/fr/images/emajweb_browser.png
diff --git a/docs/fr/images/emajweb_emaj.png b/docs/fr/images/emajweb_emaj.png
diff --git a/docs/fr/images/emajweb_filter.png b/docs/fr/images/emajweb_filter.png
diff --git a/docs/fr/images/emajweb_groupcontent.png b/docs/fr/images/emajweb_groupcontent.png
diff --git a/docs/fr/images/emajweb_groupproperties.png b/docs/fr/images/emajweb_groupproperties.png
diff --git a/docs/fr/images/emajweb_groups.png b/docs/fr/images/emajweb_groups.png
diff --git a/docs/fr/images/emajweb_groupstat.png b/docs/fr/images/emajweb_groupstat.png
diff --git a/docs/fr/images/emajweb_rollbackdetails.png b/docs/fr/images/emajweb_rollbackdetails.png
diff --git a/docs/fr/images/emajweb_rollbacks.png b/docs/fr/images/emajweb_rollbacks.png
diff --git a/docs/fr/images/emajweb_rollbacksim.png b/docs/fr/images/emajweb_rollbacksim.png
diff --git a/docs/fr/images/emajweb_schemas.png b/docs/fr/images/emajweb_schemas.png
diff --git a/docs/fr/images/emajweb_triggers.png b/docs/fr/images/emajweb_triggers.png
diff --git a/docs/fr/webUsage.rst b/docs/fr/webUsage.rst
@@ -17,6 +17,7 @@ Située à gauche, l'arborescence de navigation offre la visibilité de toutes l
 
 	Figure 1 – Arborescence de navigation.
 
+Les deux icônes en bas et à droite permettent d’ajuster la largeur du l’arborescence de navigation.
 
 Liste des groupes de tables
 ---------------------------
@@ -55,7 +56,7 @@ Les entêtes de page contiennent :
 * 3 liens pour accéder à l’éditeur de requête SQL, à l’historique des requêtes exécutées et pour se déconnecter de l’instance courante,
 * une liste déroulante pour choisir la langue utilisée dans l’interface utilisateur,
 * un fil d’ariane permettant de se repérer dans l’arborescence,
-* et un bouton permettant d’aller directement en bas de page.
+* et un bouton pour aller directement en bas de page.
 
 Deux barres d'icônes permettent de naviguer dans les différentes fonctions d'Emaj_web : l'une regroupe les fonctions globales de l'interface, et l'autre les fonctions associées à un groupe de tables particulier.
 
@@ -82,6 +83,10 @@ Sur certains tableaux également, une icône à gauche de la ligne de titre fait
 
 Certains tableaux permettent d’exécuter des actions pour plusieurs objets simultanément. Dans ce cas, l’utilisateur sélectionne les objets à l’aide des cases à cocher dans la première colonne du tableau et choisit l’action à exécuter parmi les boutons accessibles sous le tableau.
 
+Les colonnes contenant des commentaires ont une taille limitée. Mais le contenu complet des commentaires est visible en infobulle lorsque la souris passe au dessus de la cellule.
+
+Les cellules contenant des horodatages d’événement ou des durées affichent en infobulle la valeur complète de la donnée.
+
 
 Détail d'un groupe de tables
 ----------------------------
@@ -120,8 +125,6 @@ Deux types de statistiques peuvent être obtenues :
 * des estimations du nombre de mises à jour par table, enregistrées entre 2 marques ou entre une marque et la situation présente,
 * un dénombrement précis du nombre de mises à jour par table, type de requête (*INSERT/UPDATE/DELETE/TRUNCATE*) et rôle.
 
-Si la borne de fin correspond à la situation courante, une case à cocher permet de demander en même temps une simulation de rollback à la première marque sélectionnée afin d'obtenir rapidement une durée approximative d'exécution de cet éventuel rollback.
-
 La figure suivante montre un exemple de statistiques détaillées.
 
 .. figure:: images/emajweb_groupstat.png
@@ -133,13 +136,6 @@ La page restituée contient une première ligne contenant des compteurs globaux.
 
 Sur chacune des lignes du tableau de statistiques, un bouton « *SQL* » permet à l'utilisateur de visualiser facilement le contenu des mises à jour enregistrées dans les tables de log. Un clic sur ce bouton ouvre l'éditeur de requêtes SQL et propose la requête visualisant le contenu de la table de log correspondant à la sélection (table, tranche de temps, rôle, type de requête). L'utilisateur peut la modifier à sa convenance avant de l'exécuter, afin, par exemple, de cibler davantage les lignes qui l'intéressent.
 
-.. figure:: images/emajweb_rollbacksim.png
-   :align: center
-
-   Figure 8 – Résultat de la simulation d'un rollback avec estimation du nombre de mises à jour par table.
-
-La page restituée contient une première partie indiquant le nombre de tables et de mises à jour concernées par un éventuel rollback à cette marque et une estimation du temps nécessaire à ce rollback.
-
 Contenu d'un groupe de tables
 -----------------------------
 
@@ -150,7 +146,7 @@ Le tableau affiché reprend, pour chaque table et séquence du groupe, les carac
 .. figure:: images/emajweb_groupcontent.png
    :align: center
 
-   Figure 9 – Contenu d'un groupe de tables.
+   Figure 8 – Contenu d'un groupe de tables.
 
 
 Schémas et configuration des groupes de tables
@@ -165,7 +161,7 @@ Pour chaque liste, on trouve les propriétés E-Maj et quelques caractéristique
 .. figure:: images/emajweb_schemas.png
    :align: center
 
-   Figure 10 – Contenu des schémas et configuration des groupes de tables.
+   Figure 9 – Contenu des schémas et configuration des groupes de tables.
 
 Triggers
 --------
@@ -177,7 +173,7 @@ Un bouton permet de changer le mode de désactivation lors des rollbacks E-Maj.
 .. figure:: images/emajweb_triggers.png
    :align: center
 
-   Figure 11 – Liste des triggers applicatifs
+   Figure 10 – Liste des triggers applicatifs
 
 
 Suivi des opérations de rollback
@@ -186,17 +182,15 @@ Suivi des opérations de rollback
 Une page, accessible par l'icône « *Rollbacks* » de la barre globale, permet de suivre les opérations de rollback. Trois listes distinctes sont affichées :
 
 * les opérations de rollback en cours, avec le rappel des caractéristiques de l'opération et une estimation de la part de l'opération déjà effectuée et de la durée restante,
-* les dernières opérations de rollback terminées,
+* les opérations de rollback terminées,
 * les opérations de rollback tracés susceptibles d’être consolidées.
 
-L'utilisateur peut filtrer la liste des rollbacks terminés sur une profondeur d'historique plus ou moins grande.
-
 Pour chaque rollback tracé consolidable listé, un bouton permet d’exécuter la consolidation.
 
 .. figure:: images/emajweb_rollbacks.png
    :align: center
 
-   Figure 12 – Suivi des opérations de rollback.
+   Figure 11 – Suivi des opérations de rollback.
 
 En cliquant sur un identifiant de rollback dans l’un de ces tableaux, on accède à une page présentant des informations détaillées sur le déroulement en cours ou passé de l’opération sélectionnée.
 
@@ -212,7 +206,7 @@ On y trouve plus précisément des données concernant :
 .. figure:: images/emajweb_rollbackdetails.png
    :align: center
 
-   Figure 13 – Détails d’une opération de rollback.
+   Figure 12 – Détails d’une opération de rollback.
 
 État de l'environnement E-Maj
 -----------------------------
@@ -235,4 +229,4 @@ Deux boutons en bas de page permettent d’exporter ou d’importer une configur
 .. figure:: images/emajweb_emaj.png
    :align: center
 
-   Figure 14 – État de l'environnement E-Maj 
+   Figure 13 – État de l'environnement E-Maj