===== Dashboard Block =====
====== User Parameters ======


While filters only take into account data explicitly present in the query results, user parameters make it possible to: 

   * Set certain selection clauses with arbitrary values
   * Offer a list of choices on arbitrary absolute values
   * Create "search"-type filters
   * Create "value range" or "date range" type filters

{{ :blocks:dashboard:userparams_fr.jpg |}}

Up to 5 parameters can be defined. These parameters will inject additional variable constraints into the "WHERE" clause, depending on the choice of the dashboard's end user.

==== User parameter data ====

=== SQL field ===

Designates the database field (its non-aliased name) on which the constraint will be built.

=== Label ===

Designates the name under which the parameter will appear in the dashboard interface, for end users.

=== Type ===

The type of the constraint. This can be: 

   * **A choice**: presented as a radio button
   * **A text**: presented as a text field and always processed according to a "LIKE" constraint. It is therefore possible to use search patterns, for example "Dur%" to look for names beginning with 'Dur'.
   * **A list**: presents a choice of possible values, and is similar to a query filter, except that arbitrary values can be given for the list values.
   * **A value range**: presents two text fields in which a min value and a max value can be entered. The parameter operates exclusively on numbers and includes the bounds.
   * **A date**: presents a date selector
   * **A date range**: combines the principle of range (min,max) and date

=== Values ===

For the 'choice' and 'list' types, lets you supply the list of values offered by the list.

==== Placing the parameters ====

For query parameterisation to work, you must insert the tag <nowiki><%%PARAMS%%></nowiki> in your query text. This tag must absolutely be located in a WHERE clause (or at a pinch in an ON clause of a partial join).

<html><!-- nomoodle --></html>
-----

==== Credits ====

  * Valéry Frémaux (valery@activeprolearn.com)- Development and documentation
  * Florence Labord (florence@activeprolearn.com) - documentation



[[:blocks:dashboard:userguide|Back to the configuration guide index]] - [[:Blocks:Dashboard|Back to the component index]] - [[:Blocks:Dashboard:QueryCatalogue|Go to the generic query catalog]] - [[:Plugins|Back to the plugin index]] - [[:start|Back to the catalog]]

<html><!-- /nomoodle --></html>