blockdashboardconfiguserparams

This is an old revision of the document!


User dynamic parameters

Dashboard block

Filters only work on real values that already exist in the records. Opositely, user parameters can:

  • 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

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.

Defining a user parameter

SQL field

The (real, unaliased) table SQL field name on wich the constraint will be added.

Label

The visible label this query control will appear with on the dashboard interface.

Type

The constraint type:

  • single Choice : présenté sous forme de bouton radio
  • Text : présenté sous forme d'un champ de texte et toujours traité selon une contrainte “LIKE”. Il sera donc possible d'utiliser des schémas de recherche, par exemple “Dur%” pour chercher des noms commençant par 'Dur'.
  • Value list : présente un choix de valeur possibles, et est similaire à un filtre de requête, excepté que des valeurs arbitraires peuvent être données pour les valeurs de liste.
  • Value range : présente deux champs de texte dans lesquel une valeur min et une valeur max peuvent être entrés. Le fonctionnement du paramètre est exclusivement numérique et inclut les bornes.
  • Date : présente un sélecteur de date
  • Date range : combine le principe de plage (min,max) et de date

Values

For the types'single choice' and 'list', provides the option values.

Inserting the parameter rules in the query

Pour que le paramétrage d'une requête fonctionne, vous devez insérer le tag <PARAMS> dans votre texte de requête. Ce tag doit impérativement se trouver dans une clause WHERE (ou à la rigueur dans une clause ON d'une jointure partielle).


Credits

  • Valéry Frémaux (valery@activeprolearn.com)- Main design and development
  • Florence Labord (florence@activeprolearn.com) - Docmentation and tests

Revenir à l'index du guide de configuration - Retour à l'index du composant - Aller au catalogue de requêtes génériques - Revenir à l'index des plugins - Revenir au catalogue

blockdashboardconfiguserparams.1503176203.txt.gz · Last modified: 2024/04/04 15:50 (external edit)