Differences

This shows you the differences between two versions of the page.

--- blockdashboardconfigoutputfields [2015/11/21 15:04]
admin [Paramètres]
+++ blockdashboardconfigoutputfields [2024/04/04 15:50] (current)
@@ Line 1: / Line 1: @@
-===== Bloc Dashboard : Element de tableau de bord - Configuration des données de sortie =====
+===== Output configuration =====
+===== Dashboard block =====
-Ce panneau de paramètres détermine les choix des sorties en mode "table de données". Certains paramètres, comme par exemple les paramètres de cache, peuvent affecter d'autres formes de sorties.
+{{ :blocks:dashboard:output_config_en.png?nolink |}}
-La fonction première de ce panneau est de choisir les colonnes de sorties dans le résultat de la requête (colonnes nommées) et d'alimenter un affichage en table de données. Les tables de données peuvent être de trois format :
+====General considerations=====
-   * Pour des enregistements simples, fournissant des données "à plat" vous opterez pour la sortie "Linéaire".
+The output settings for data or graphs will always use the columns aliases to identify the output fields.
-   * Pour des enregistrements présentant une donnée à deux dimensions, vous pouvez choisir la "Table croisée". La table croisée utilise une dimension simple comme colonnes de la table de rendu, mais peut utiliser un enseble de dimensions de sorties pour créer les lignes de la matrice.
-   * Pour des enregsitrements présentant une caractéristique arborescente reconnaissable* alors vous pouvez activer le rendu "hiérarchique".
-==== Paramètres ====
+====Table type====
-> {{Note : Cette documentation est un draft. Les requêtes proposées en exemple ne sont pas encore vérifiées}}
+Three table shape can be choosen for output data. Some table types rely on some available attributes:
-Dans toutes les entrées de type "liste", le séparateur entre champ **DOIT ETRE** le point-virgule. Un certain nonmbre de paramètres secondaires admettent un nombre d'éléments de liste en fonction du nombre d'éléments d'un paramètre primaire. Vous trouverez ci-dessous les informations correspondantes.
+**Raw flat data:** Data are presented as the query output, record by record.
-=== Colonnes de sortie ===
+**Cross table:** Data are shown within a bidimensional array. The configuration will tell:
-Les colonnes de sortie permettent de choisir quelles colonnes de la requête seront utiisées pour l'affichage. Ce choix peut être différent suivant les différents modes de rendus. Certaines colonnes "techniques" n'ont pas à participer à l'affichage.
+  * The output column alias that represents the horizontal dimension (one choice possible only)
+  * The output column aliases that provide the vertical dimensions.
+  * The content of the value cell.
-Les colonnes de sortie doivent être désignées par leur nom d'ALIAS. Par exemple, pour une requête :
+**Tree shaped data:** If the output data provide a hierarchical organization (noticed by id,parent), it may be practical to use a tree representation of the output.
-<code>
+====Output columns====
-SELECT
-   id as id,
-   shortname as sn,
-   fullname as fn
-FROM
-   {course}
-</code>
-vous pourrez ne choisir "que" de ne sortir les colonnes sn et fn :
+This setting lists in order the list of output fields that will be shown in the output. It must use the aliased names of the columns and cannot be SQL expressions. The output list uses semi-column (;) as separator.
-   sn;fn
+//E.g. if the query is://
-** Cas particulier : Colonnes sommatives **
-Vous pouvez avoir besoin, par exemple pour piloter des courbes cumulées, d'extraire une forme "sommative" d'une colonne à résultat numérique. Par exmemple si vous voulez compter le nombre de création de nouveaux cours de manière cumulée par mois sur toute l'année.
+  SELECT
+     YEAR(FROM_UNIXTIME(time)) as year,
+     count(*) as access
+  FROM
+     mdl_log
+  GROUP BY
+  year
-Pour cela vous pouvez utiliser la syntaxe suivante, en lieu et place du simple nom aliasé de colonne :
-Soit la requête :
+//Then the output column list could be://
-<code>
+  year;access
-SELECT
-   DATE_FORMAT('%Y_%m', FROM_UNIXTIME(timecreated)) as month,
-   COUNT(*) as cccount
-FROM
-   {courses}
-GROUP BY
-   month
-</code>
-Vous pouvez invoquer la somme cumulative du nombre de créations par mois comme ceci :
+===Formatting output data===
-   month;S(cccount)
+This setting accepts a data formatting expression on the "sprintf" syntax basis that will post-format the output values. You should provide as may formatters than output columns. The formatters will apply in order of the output description list, and will complete with "ignore format" formatters the missing descriptors. An empty formatter stands also for "ignore format" signal.
-=== Format des données de sortie ===
+In the preceding sample, you would use:
-Chaque colonne de sortie fournit une donnée qui peut être formattée avant affichage. Il est possible de spécifier des chaines de formattage sous le format de la fonction sprintf(). Certaines syntaxes additionnelles ont été ajoutée pour des effets non prévus par ces syntaxes standard.
+  %d;%s
-**Paramètre primaire associé :** Colonnes de sorties
+to format first columns as an integer and the second column as a string.
+Second exampe:
-Exemple :
+for, say, a popularity ratio, you may want to format the output as a float value with one single digit in the decimal part. You would use the following formatter for a result giving the ratio per month:
-Soit la requête :
+  month;ratio
+  ;%.1f
+Note here that the first column (month) has no formatter applied.
+[[http://php.net/manual/fr/function.sprintf.php|Read more about formatting syntax]]
+===Outputing HTML glue with referenced columns===
+Say you may want to show course names having links to browse quickly to the corresponding course. The formatting syntax allows using static HTML glue and reference another column in the output result to produce the cell content.
+E.g the following syntax will show this formatting:
+   <a href="/course/view.php?id=%{cid}">%s</a>
+References to other columns in the output result uses the %{fieldalias} syntax and will be processed befor the "sprintf" applies.
+===Output fields labels====
+As technical fieldnames in DB may not have full sense to the end user of the dashboard, you may here rename the field names to more comprehensible names.
+Again; use semi-columns (;) to separate labels, and give labels in same order of the output field list.
+Example:
+   Category;Subcategory
+===Paging size===
+If given, this will add a LIMIT,OFFSET clause to the query to paginate the output. Use pagination on queries that may potentially output a lot of rows.
+===Cache results===
+when cache results is enabled, the query outputs will be cached to save time when accessing back to the same query output. The database will not have to process again the joins and the aggregators.
+The TTL (Time To Live) delay of the cache can be adjusted.
+The cron task of the dashboard can be used to program caches refresh and provide some fresh results.
+===Clean the table display===
+If this option is used, subsequent rows repeating the same value than the row above will not show the value again. This often leads to a cleaner and more readable view of the data, specially for dimensional context columns that are usually displayed first.
+There is visually a trap to clean values in the last (main payload) columns, as this might be misinterpreted as a lack of data (null) rather than undestanding the data has same value as above. You can fix this asking the cleanup filter no to operate further a given column number.
+===Sortable table===
+If your query has not a structural hardcoded SORT clause in its body, but you may want the end user sort the data as he wants, you may declare the table sortable. the dashboard will add sorting controls and sort SQL clause for you.
+===Subtotal separation column===
+Using summators usually provide a single final summed value of some output fields. In case you need having subtotals in some value output subdomains, you may tell which output field will be used to discriminate subtotals. the dashboard will add an additional subtotal row (for declared summators) summing all rows in a subtotal column single modality.
+Note that subtotals can only be calculated if the global output result is sorted on the subtotal separation column.
+<html><!-- nomoodle --></html>
+-----
+====Credits====
+  * Valéry Frémaux (valery@activeprolearn.com)- Main design and development
+  * Florence Labord (florence@activeprolearn.com) - documentation and testing
+[[:blocks:dashboard:userguide|Return to the configuration guide index]] - [[:Blocks:Dashboard|Return to the component index]] - [[:Blocks:Dashboard:QueryCatalogue|Generic query catalog]] - [[:Plugins|Return to the plugins index]] - [[:start|Home]]
+<html><!-- /nomoodle --></html>
-<code>
-SELECT
-   DATE_FORMAT('%Y_%m', FROM_UNIXTIME(timecreated)) as month,
-   SUM(1) / 12 as meancreation
-FROM
-   {courses}
-</code>
-[[BlockDashboardUse|Revenir à l'index du guide utilisateur]]

Moodle ActiveProLearn Documentation

User Tools

Site Tools

Differences

Page Tools