Differences

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

--- blockdashboardconfiguserparams [2016/05/17 16:44]
admin [Insertion des paramètres utilisateurs dans la requête]
+++ blockdashboardconfiguserparams [2024/04/04 15:50] (current)
@@ Line 1: / Line 1: @@
-===== Bloc Dashboard (Tableau de bord) : Paramètres dynamiques =====
+===== User dynamic parameters =====
+===== Dashboard block =====
-Les paramètres dynamiques de requête sont un moyen de faire varier au moment de la lecture des résultats un ou pluseurs paramètres externes de la requête. Par exemple, une requête d'extraction statistique peut être valide dans une plage de date particulières. Le paramétrage dynamique permettra à l'utilisateur final de progammer sa date de début de période et de fin de période sans avoir besoin de modifier ou de rééditer la requête.
+Filters only work on real values that already exist in the records. Opositely, user parameters can:
-La mise en place des paramètres dynamiques va faire deux choses :
+   * Offer parametrisation based on an arbitrary set of attribute values
+   * Provide list selectors based on arbitrary value sets
+   * Provide partial filters (type search by pattern)
+   * Provide date or value range filters
-   * Ajouter des interfaces de saisie/configuration sur l'interface du bloc, à destination de l'usager des rapports
+{{ :blocks:dashboard:userparams_en.jpg |}}
-   * Permettre au programmeur de la requête d'utiliser des "marque-places" pour injecter les valeurs de l'utilisateur final dans la requête.
-==== Types de paramètres dynamiques ====
+Up to 5 user parameters can be defined that will add dynamic behaviour to the query. These parameters will add dynamic "WHERE" constraints using those variables, and will turn the dashboard into a dynamic query tool for the end user.
-Les paramètres à saisir peuvent être de plusieurs types :
+==== Defining a user parameter ====
-=== Texte ===
+=== SQL field ===
-Une simple valer de texte
+The (real, unaliased) table SQL field name on wich the constraint will be added.
-==== Insertion des paramètres utilisateurs dans la requête ====
+=== Label ===
-Dans la version actuelle, seul le marsue-place global <%%PARAMS%%> est supporté. Il permet d'ajouter l'effet de la sélection de valeurs de paramètres dans la clause WHERE de la requête.
+The visible label this query control will appear with on the dashboard interface.
-   SELECT
+=== Type ===
-      username as un,
-      firstname as fn,
-      lastname as ln
-   FROM
-      {user}
-   WHERE
- = 1
-      <%%PARAMS%%>
-Dans l'exemple ci-dessus, la clause 1 = 1 permet de s'assurer du fonctionnement correct de la requête même dans le cas d'une valeur vide de <%%PARAMS%%> (absence de sélection).
+The constraint type:
-[[BlockDashboardUse|Revenir à l'index du guide d'utilisation]]
+   * **single Choice**: a small amount of options presented using radio buttons.
+   * **Text**: A text field which value will always be processed in a "LIKE" statement. Search patterns are thus possible, such are "Smi%" to search for names starting with 'Smi'.
+   * **Value list**: Shown as a select, and thus quite similar to a filter, but the value set is independant from query results and can be arbitrary.
+   * **Value range**: shows two textfields in which a min and a max value can be input. The constraint relies on a ">=" and "<=" operator in the query.
+   * **Date**: a date selector.
+   * **Date range**: will show two date selectors for the min date and the max date
+=== Values ===
+For the types 'single choice' and 'list', provides the option values.
+==== Inserting the parameter rules in the query ====
+If user params are used, the placeholder <%%PARAMS%%> will have to be inseted in the query body. This placeholder must be part of a WHERE clause. (or eventually if consistant a ON portion of a partial JOIN statement).
+<html><!-- nomoodle --></html>
+-----
+====Credits====
+  * Valéry Frémaux (valery@activeprolearn.com)- Main design and development
+  * Florence Labord (florence@activeprolearn.com) - Docmentation and tests
+[[:blocks:dashboard:userguide|Return to the configuraiton 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>

Moodle ActiveProLearn Documentation

User Tools

Site Tools

Differences

Page Tools