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 have been described below:

  • MultiValue - It is used to filter multiple values in the data. To do this, you need to set the MultiValue property to 'True', or else it will filter only the first value from the data. It also provides you a Select All option to select all the items in the list of available values.

  • Hidden - It is used to hide the parameters while scheduling the tasks and will not prompt the user to enter any value instead uses the default value. To do this, you need to set the Hidden property to 'True' and set the default value for it. Please note that if you hide the parameter and do not provide a default value, the dashboard will not run.

  • Multiline - It is used to allow multi line values in a parameter. To do this, you need to set the Multiline property to 'True'. 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 you want to to see on the user interface to request information from the user. By default, this is the 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. Click the Available Values tab in the dialog, if you want the user to choose an item 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. Or click the Default Values tab to provide default values to use if the user does not select a value. This is useful when you are creating a hidden parameter.

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