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

with Wyn Enterprise, you can use MultiValue parameters in your dashboard scenarios. MultiValue parameter allows you to pass one or more input parameters to the report. With MultiValue parameters, you can also pass all the parameters to the report using the Select All option.

In this article, you will find information on the following,

• Add a Dashboard Parameter

• Parameter Setting Dialog Box

• Data Type Options

• Default Value Options

• Binding Options

• Transform Options

• Show in the scheduled tasks Option

• Example Scenario

• Setting a Parameter

Add a Dashboard Parameter

To add parameters to a dashboard, navigate to the dashboard designer page and follow the below instructions,

1. Click the Document Settings tab on top of the designer or click the Inspector panel icon on the right side and go to the Parameters property under General section.

2. Click + Add Item icon. Parameter Setting dialog box will appear on your screen. The attributes of the Parameter Settings dialog box are listed and described in this section.

   
   

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

4. In the Prompt input box, add text 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 Data Type dropdown and ensure that it matches the data type of the attribute it filters. Data type options in the dialog are Boolean, Date, DateTime, Integer, Float, String, and Multi Dimension. For example, set the Data Type property to String if you want to apply a filter on a data attribute of type String. Data type options are listed and explained in this section.

   
   

6. To add multi-value parameters, select the MultiValue checkbox. On checking, a + button will appear next to the Default Value input box. Click the + button to add multiple parameter values.

   
   

7. From the Default Values tab of the dialog, specify the default value(s) for the dashboard parameter. You can select Static Values, User Context Values, Organization Context Values, and dataset values (From Query) as the default values from the dropdown. Default Value options are listed and explained in this section.

   
   

8. From the Binding tab, select the Source Type from the dropdown. You can choose one of the following three options - None, Selected Value, or Slicer. Binding options are listed and described in this section.

   
   

9. In case you select the Date or DateTime data type option from the Data Type dropdown, the Transform tab will appear next to the Binding tab. Select a Transform Rule from the dropdown and set the appropriate settings. You can choose one of the following options from the Transform Rule dropdown - Original Value, Part, Adjust Value, or UTC String. Transform Rule options are listed and described in this section.

   
   

10. Click the Show in the scheduled task checkbox to show the dashboard parameters in scheduled tasks. On clicking the checkbox, the Available Values tab will appear at the bottom of the dialog, now select one of the options from the Value Source. The following two options are available,

    a. In the case of From Query, select a dataset from the From Query dropdown and then select a data field from the Value Field dropdown.

    
    

    b. In the case of Non-queried, enter a value in the Value input box and a label for the value in the Label input box. To add multiple values, use the + icon on the right side. Click the delete icon to remove the value field.

    
    

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

Parameter Setting Dialog Box

The following table lists and describes the attributes of the Parameter Setting dialog box,

Data Types Options

1. Boolean - Stores True or False data values.

2. Date - Stores the calendar date.

3. DateTime - Stores both date and time parts.

4. Integer - Stores whole numbers.

5. Float String - Stores floating point or decimal number.

6. Multi Dimension - Stores one or more independent variables in a hierarchical structure. In Wyn Enterprise, multi-dimensional parameters are supported with Multi-dimensional Slicers and Multi-dimensional Dropdown Slicers. See this example on using multi-dimensional parameters.

Default Values Options

1. Static Value - Static values are used to filter out data using fixed values. Add a constant value in the input box to set the default value of the parameter.

2. User Context - User Context values are used to dynamically filter the data using certain user attributes. To filter data based on user context, select an option from the following - email, family_name, full_name, given_name, name, phone_number, and role.

3. Organization Context - Organization Context is used to set the default value as per the name or path of the organization the user is logged in to the Wyn Enterprise application. To provide an organization context, select an option from the dropdown.

4. From Query - To set a default value from a query, click the input box. From Query dialog box is displayed. Select a dataset from the From Query dropdown list, data field from the Value Field dropdown list, Aggregate Type, Sort By, and Sort Order to set the default value of the parameter.

   
   

   Note: By default, the From Query option is set as None.

   Aggregate Type

   The Aggregate Type dropdown list has the following options:

   
   

• First: If you select this option, then the first value of the selected field will be displayed in the preview.

• Count: If you select this option, then the count of the selected field will be displayed in the preview.

• Distinct Count: If you select this option, then the distinct count of the selected field will be displayed in the preview.

• Max: If you select this option, then the maximum value of the selected field will be displayed in the preview.

• Min: If you select this option, then the minimum value of the selected field will be displayed in the preview.

• Sum: If you select this option, then the sum of the selected field will be displayed in the preview.

• Average: If you select this option, then the average value of the selected field will be displayed in the preview.

  
  

  Sort By and Sort Order: You can sort the data based on the Sort By field and Sort Order. See this example on using the Aggregate Type and Sorting.

Binding Options

1. None - Select None to not bind the parameters to any dataset or slicers.

2. Selected Value - Choose the dataset and fields to bind the parameter.

3. Slicer - Select the slicers to bind the parameter.

Transform Options

Transform Rule

1. Original Value - To keep the original value of the Date or DateTime data type.

   • Transform Formats - The following formats are available in the dropdown - m/d/yyyy, d-mmm-yy, d-mmm, mmm-yy, h:mm AM/PM, h:mm:ss AM/PM, hh:mm, hh:mm:ss, and m/d/yyyy hh:mm.

2. Part - To keep a part of the Date or DateTime data types.

   • Transform Unit - The following options are available for the Date data type - Year, Quarter, Month, Week, and Day. And, the following options are available for the DateTime data type - Year, Quarter, Month, Week, Day, Hour, Minute, and Second.

3. Adjust Value - To adjust the value of the Date or DateTime data types.

   • Transform Direction - Two options are available, Backward or Forward.

   • Transform Unit - The following options are available - Year, Quarter, Month, Week, Day, Hour, Minute, and Second.

   • Transform Format - The following formats are available in the dropdown - m/d/yyyy, d-mmm-yy, d-mmm, mmm-yy, h:mm AM/PM, h:mm:ss AM/PM, hh:mm, hh:mm:ss, and m/d/yyyy hh:mm.

4. UTC String - To display dateTime as a string according to UTC (Universal Co-ordinated Time).

Show in the scheduled tasks Options

To show the dashboard parameters in scheduled tasks, click the Show in scheduled tasks checkbox. You can add queried or non-queried parameter values as described below,

Value Source - Select the From Query option to add a value from a dataset or Non-queried option to add values manually.

• For the From Query option, select a dataset or data model from the From Query dropdown and select a data field from the Value Field dropdown.

  
  

• For the Non-queried option, click the + button and enter the value and label.

  
  

Example Scenarios

Following examples illustrate the usage of Dashboard Parameters to filter scenarios,

Using Slicer to filter scenarios

In the below example, a column chart and a slicer component is used to filter out the number of tickets for the months of September and October in a dataset of a technology company,

1. The dashboard is bound to the Technology dataset and a column chart, and a label slicer are dropped on the dashboard designer. Then, a parameter (Parameter3) is added to the dashboard scenario by using the + Add button in the Parameters property of the General section.

   
   

2. In the Parameter Setting dialog,

• MultiValue option is selected for the parameter and the default values are set to Sep and Oct.

  
  

• Parameter is bound to the Label Slicer.

  
  

3. In the Interaction section of the Inspector Panel of the dashboard, Parameter3 is selected from the Default Value property dropdown to bind the parameter to the slicer.

   
   

4. When the dashboard is previewed, the label slicer bound to Parameter3 automatically filters the data in the column chart for the default values Oct and Sep.

   
   

   
   

Multi-dimension Parameters

In the below example, a column chart and a multi-dimensional slicer (also known as Tree Slicer) is used to filter out the sum of payout for months in a year in a dataset of an insurance company,

1. Dashboard is bound to the Insurance dataset and a column chart, and a multi-dimensional slicer are dropped on the dashboard designer. Then, a parameter (P1) is added to the dashboard scenario by using the + Add button in the Parameters property of the General section.

   
   

2. In the Parameter Setting dialog,

• Multi Dimension option is selected from the Data Type dropdown and the parameter is bound to the slicer component by selecting Slicer as the Source Type. Multi-dimensional slicer is bound to the parameter from the Slicer Value Settings dialog by clicking the Bind To input box.

  
  

• From the Slicer Value Setting dialog, treeSlicer option is selected from the Choose Slicer dropdown, and all the columns are selected using the checkboxes from the Choose Column section.

  
  

3. From the Interaction section of the Inspector Panel of the dashboard, parameter P1 is selected from the Default Value property dropdown to bind the parameter to the slicer.

   
   

4. When the dashboard is previewed, the multi-dimensional slicer bound to the parameter P1 is used to filter out data for the selected year, month, and dates.

   
   

   
   

   
   

Using From Query to set the default value of the parameter

We will set a default value from a query using Aggregate Type as First and Sort By option.

In this example, we will display the First value of the Year field and sort the data in descending order.

1. Drag and drop a column chart on the dashboard designer and bind it to the dataset.

   
   

   
   

2. To add a dashboard parameter, we have selected the field Year as the Default Value, and Aggregate Type as First.

   
   

   
   

3. Click Ok. The parameter (Parameter1) is added.

4. We will add a filter on the column chart by using the dashboard parameter (Parameter1).

   
   

   
   

5. Since the default value of the parameter setting is the First of Year field, so, only the data for the first value of the Year will be displayed on the preview.

   
   

   
   

6. Now we will sort the data. We have selected Sort By as Year and Sort Order as Descending order for the parameter.

   
   

   
   

   On preview, the data will be displayed sorted by the field Year in descending order.

   
   

Setting a Parameter

In addition to filtering a dashboard by a set parameter, Wyn Dashboards also allows you to change that filter by clicking on a set image. In the example below an image is used to reset the filter on a column chart for the sum of working capital.

1. Dashboard is bound to the Working Capital dataset and a column chart, and an image is dropped on the dashboard designer. See details for customizing an image here. Then, a parameter (Parameter1) is added to the dashboard scenario by clicking the +Add button in the Parameters property of the General section.

   
   

   
   

   
   

2. In the Parameter Setting dialog,

• Select the dropdown menu labeled “Data Type” and select “Integer”, since we are going to be filtering the column chart by year.

• Insert a static value of “2017” since that is the first value by which we will be filtering the column chart.

3. Click the column chart and select the Filter option from the Action Bar to apply a filter on the column chart, to filter the data by the dashboard parameter that we have created above. In the Filter dialog that appears, click the + Add button to specify the filter condition.

4. On the Filter dialog, under the General Tab, click the icon

   
   

   next to the search bar, select the parameter, and click Ok.

5. Click the Image and go to the Inspector tab. Under the Interaction section, select the Click Action as Command, to add a command to the image to change the parameter.

6. Click +Add to add a command to the image.

7. Select the option Set Parameter from the Command dropdown menu. Select the parameter you created, “Parameter1”, and add the value for that parameter. In this example, we have provided the value as 2018. Click Ok.

8. Preview the dashboard and click the image. As we have set the parameter value to 2018 in the Command Setting dialog box, the dashboard will be filtered by the new value of the parameter i.e. 2018.