User Tools
blocks:dashboard:userguide
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
blocks:dashboard:userguide [2017/08/11 22:43] admin [Identify dimensions for sorting or filtering] |
blocks:dashboard:userguide [2023/01/31 16:46] (current) |
||
|---|---|---|---|
| Line 14: | Line 14: | ||
| there are 6 main steps in setting up a dashboard query: | there are 6 main steps in setting up a dashboard query: | ||
| - | * Carefully identify in which tables and which fields are the data that represents the query | + | - Carefully identify in which tables and which fields are the data that represents the query |
| - | * Identify the dimensions of sorting and filtering | + | - Identify the dimensions of sorting and filtering |
| - | * Write and test the base query form in a DB client | + | - Write and test the base query form in a DB client |
| - | * Copy the query in the dashboard | + | - Copy the query in the dashboard |
| - | * configure the output (data tables or graphs) | + | - configure the output (data tables or graphs) |
| - | * Setup accessories, (filters, parameters, colorizers, sub-totals, summators, etc). | + | - Setup accessories, (filters, parameters, colorizers, sub-totals, summators, etc). |
| ==== Think about the problem (identify the query) ==== | ==== Think about the problem (identify the query) ==== | ||
| Line 37: | Line 37: | ||
| Filters usually will be defined upon the contextual dimensions, while parameters may usually affect usefull or technical values. | Filters usually will be defined upon the contextual dimensions, while parameters may usually affect usefull or technical values. | ||
| - | ==== Ecrire et tester la requête de base ==== | + | ==== Write and test a base query ==== |
| - | Vous utiliserez pour cela un client standard de votre base de données. Ce test permet de vérifier que la requête de départ fonctionne correctement et qu'elle produit bien des données cohérentes. | + | The best practice is to use your standard DB client software to write and debug the base query. Once you know the base query form outputs the data you expect in the arrangement you expect, it will be easier to copy the base query in the Dashboard block. Note that in general, your DB client software has more query coding useful tools such as syntax debugger or optimization helpers. |
| - | === Les pièges à éviter === | + | === Several traps to avoid === |
| - | * Faire particulièrement attention à la première colonne extraite dans la requête. Il doit s'agit d'une donnée unique valant pour clef. Si tel n'est pas le cas, le résultat apparent semblera avoir perdu des données. | + | * Check carefully the first output field of your query. it MUST be a primary key for your result. This is a special attention to observe when f.e. using GROUP BY clauses or using time range extractions. Think that the query will give result through the standard DB middleware library of moodle, that uses the first column as the results associative table as php output, so it needs being a unique key of your result, or you will loose data. |
| - | * Utiliser des requêtes composées (UNION, INTERSECT) dans lesquelles le placement de certains compléments automatiques de SQL ne peut pas se faire. | + | * Use some UNION or INTERSECT in which the Dashboard SQL post processing will NOT be able to find the clauses it needs rework. |
| - | * Utiliser des requêtes imbriquées complexes mettant en jeu de nombreuses séquences ORDER BY ou GROUP BY. | + | * Use complex subqueries that multiplies the ORDER BY or GROUP BY clauses. |
| - | ==== Mettre en place la requête ==== | + | ==== Enter the query in the Dashboard configuration ==== |
| - | La mise en place de la requête dans le tableau de bord est la première chose à faire réellement dans le tableau de bord. | + | copy the query in the query text area of the dashboard is the effective first thing to do. |
| - | - Passez le cours en mode édition | + | - Switch to the course editing mode |
| - | - Editez les paramètres du bloc Tableau de Bord à configurer | + | - Edit the block's settings |
| - | - Dépliez la rubrique //Paramètres du tableau de bord// | + | - Expand the //Dashboard settings// form section |
| - | - Cliquez sur //Accédez à la définition du tableau de bord// | + | - Click on the //Access to dashboard settings// |
| - | Le premier onglet est là où vous allez poser la requête. | + | The first panel shows the textarea where to put the query. |
| - | ==== Détail des écrans de configuration ==== | + | ==== Dashboard configuration screen details ==== |
| - | * [[:BlockDashboardConfigQuery|Configuration de la requête]] | + | * [[:BlockDashboardConfigQuery|Query]] |
| - | * [[:BlockDashboardConfigUserParams|Configuration des paramètres utilisateur]] | + | * [[:BlockDashboardConfigUserParams|User params]] |
| - | * [[:BlockDashboardConfigOutputFields|Configuration des informations de sortie]] | + | * [[:BlockDashboardConfigOutputFields|Data output]] |
| - | * [[:BlockDashboardConfigOutputTabular|Paramètres supplémentaires des sorties en tables croisées]] | + | * [[:BlockDashboardConfigOutputTabular|Data matrix additional params]] |
| - | * [[:BlockDashboardConfigOutputTreeview|Paramètres supplémentaires des sorties en arbre hiérarchique]] | + | * [[:BlockDashboardConfigOutputTreeview|Data tree view additional params]] (Pro Version) |
| - | * [[:BlockDashboardConfigPlotting|Configuration de l'affichage en graphe]] | + | * [[:BlockDashboardConfigPlotting|Graphic output]] |
| - | * [[:BlockDashboardConfigSummarizers|Configuration des sommateurs]] | + | * [[:BlockDashboardConfigPlotting|Additional GoogleMap parameters]] (Pro Version) |
| - | * [[:BlockDashboardConfigColoring|Configuration de la colorisation de données]] | + | * [[:BlockDashboardConfigPlotting|Additional timeline parameters]] (Pro Version) |
| - | * [[:BlockDashboardConfigScheduling|Configuration du raffraichissement de données]] | + | * [[:BlockDashboardConfigSummarizers|Summators and filters]] |
| - | * [[:BlockDashboardConfigFile|Configuration de la sortie sur fichier]] | + | * [[:BlockDashboardConfigColoring|Data coloring]] (Pro Version) |
| + | * [[:BlockDashboardConfigFile|Data export to files]] | ||
| + | * [[:BlockDashboardConfigScheduling|Data export sheduling]] (Pro Version) | ||
| - | [[:Blocks:Dashboard|Retour à l'index du bloc]] | + | [[:Blocks:Dashboard|Back to the plugin index]] |
blocks/dashboard/userguide.1502484210.txt.gz · Last modified: 2024/04/04 15:50 (external edit)
