Wyn Enterprise User Guide

Wyn Enterprise: Dashboard Parameters

Dashboard parameters are global parameters that are mainly used to filter the data in a dashboard. They can be added to global filters, scenario filter, dashboard jumps, and scheduled tasks to control the output in the underlying scenario.

Wyn Enterprise provides you a variety of parameters to use in your dashboard like multivalue, hidden, and multiline parameters. All these parameters are described below:

  • MultiValue - When set to 'True', it filters multiple values in the data. Otherwise, it filters only the first value from the data. You can also choose 'Select All' option to select all the items in the list of the available values.

  • Hidden - When set to 'True', it hides the parameters while scheduling the tasks. The user prompt to enter a value is hidden and instead a default value, which you need to set, is passed. Please note that if you hide the parameter and do not provide a default value, the dashboard will not run.

  • Multiline - When set to 'True', it allows multi-line values in a parameter. Note that this property is only available for 'String' data type.

Add a Dashboard Parameter

  1. Click the Document Settings tab on top of the designer and go to the Dashboard Parameters property.

  2. Click Show Items and then select Add Item. You can now add a new dashboard parameter.

    Adding a Dashboard Parameter

  3. In the Parameter Setting dialog, specify the name for the dashboard parameter in the Name property.

    Parameter Settings Dialog

  4. Set the Prompt property to some text that you want to display on the user interface to request an input. By default, this is same as the Name property.

  5. Choose a suitable data type for the parameter from the list, such as String, Integer, Bool, etc. which must match the data type of the attribute that it filters. For example, set the Data Type property to 'String' if you want to apply a filter on a data attribute of type String.

  6. Choose the type for the parameter, that is, MultiValue, Hidden, or Multiline and select the corresponding checkbox to it.

  7. Specify the default value(s) for the dashboard parameter in the Default Values tab of the dialog. You can provide static values, user context values, and organization context values as the default values. This is useful when you are creating a hidden parameter.

    The default value tab of the Parameter Settings dialog

  8. Click the Available Values tab in the dialog, if you want the user to choose from the list of available values. Select From Query to populate a list from the data set from which users can select a value. Alternatively, you can select Non-queried to enter your own values.

    The available values tab of the Parameter Settings dialog

  9. Click OK to save the parameter. The new parameter appears in the Dashboard Parameters in the global settings panel.