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

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).

Credits

Valéry Frémaux (valery@activeprolearn.com)- Main design and development

Florence Labord (florence@activeprolearn.com) - Docmentation and tests

Return to the configuraiton guide index - Return to the component index - Generic query catalog - Return to the plugins index - Home