Dashboard Filter Widgets

<< Click to Display Table of Contents >>

EQuIS 7  >>  Enterprise > Widgets >

Dashboard Filter Widgets

The Dashboard Filter widgets allow the user to select a parameter value and filter the report output of reporting widgets (e.g., EZView, Traffic Light, Traffic Light Map, TimeSeriesChart, Map, and DataGrid) on the dashboard.

 

There are two types of Dashboard Filter Widgets:

1.Filter-List Widget – Filters on action level, analyte, analyte group, analytic method, facility, fraction, matrix, location, or task code.

2.Filter-Date Range Widget – Filters on a specific year or on a specified date range.

 

To add these widgets to a dashboard, the user must have editor or greater permissions to the dashboard. Multiple Filter widgets may be added to the same dashboard.

 

Notes:

The filtering functionality is not additive. Multiple Filter-List widgets set to the same parameter will not filter output for all of the parameters selected. For example, if a dashboard contains a Traffic Light widget and three Filter-List widgets set to filter on an analyte, the report output will not be filtered on all three of the analyte selections. Instead, it will be filtered on only the last analyte selected. To avoid user confusion, it is  recommended to not add multiple Filter-List widgets set to the same parameter on a dashboard. Instead use the "Select Multiple" option when configuring the widget.

Some reports have other parameter options that may override date parameter values. Since the Date Range Filter widget only sets START_DATE and END_DATE parameters for a report, these other parameters will also override what is set in the Date Range Filter widget.

 

Limitations:

All filter parameters only have an effect on reports that contain the parameters in question (i.e., the Date Range Filter will only apply on reports that include the parameter @start_date and @end_date). Filter widgets do not have any effect on crosstabs that are published with the option "Prompt for Saved Pick Report".

Filter widgets do not have an effect on reports that do not contain the parameters selected. For example, a filter on analytes will have no effect if the widget’s report does not contain the analyte parameter. An Action Level Exceedance II by User Report or a crosstab published with the option “Prompt for Saved Pick Report” are examples of such reports. In these cases, EarthSoft recommends using an alternative report, such as an Action Level Exceedance II by Parameters or publish the crosstab with the option to choose parameters.

 

 

Filter-List Widget

 

Filter_List_Widget_Sample

 

The Filter-List widget must be configured prior to use. Each widget can only filter on a single type of parameter (e.g., analyte, location). The parameter values available in the widget can be restricted (e.g., display only certain locations). The widget can be configured to allow multiple parameter value selection by the user.

 

Once the Filter-List widget has been configured, a user can select values to filter report output. When configured for single parameter value selection, the widget has a drop-down menu that closes once a selection is made. When configured for multiple parameter value selection, the widget has a scroll window from which to select values. Use CTRL+click to select one value at a time or Shift+click to select a range of values. After the value(s) have been selected, reporting widgets on the dashboard will update to reflect the filter change.

 

Widget Properties

 

To configure the Filter-List widget, open the Widget Editor by selecting the More Options dashboard_chooser icon in the upper right corner of the widget to display the drop-down menu and then select the Edit menu option.

Ent-Filter-List_Widget_Properties

Widget Title – The widget title will automatically update to the parameter selection. The title can be modified.

Widget Color – The color of the widget can be changed using the Change Widget Themecolor_iconicon to the left of the widget title.

Filter On – From the drop-down menu, select the desired parameter upon which to filter. Note that when a filter parameter is selected the Widget Title will automatically update to reflect the parameter selection.

Select Multiple – To allow the dashboard user to select more than one parameter value, check the Select Multiple box.

Populate Filter Values – Choose the values that will populate the Filter-List widget drop-down menu (i.e., the values that the dashboard user will see). At least one value must be added to the filter or the filter will not be operational. When the list of parameter values added to the widget is extensive (e.g., hundreds of analytes), opening the Widget Editor may take a while. To improve performance, it is recommended to restrict the filter parameter values as much as possible to achieve the dashboard objectives.

Selecting the drop-down menu will provide a list of parameter values (e.g., locations). The search box can be used to find desired parameter values. Check the desired parameter values to add to the filter list. The Select All button can be used to populate all parameter values into the filter. Individual parameter values can be removed from the filter by clicking the "x" to the right of the parameter value. Select the Clear button to remove all parameter values from the filter.

Ent-Filter-List_Widget_Properties2

Ent-Filter-List_Widget_Properties3

Cancel – Select the Close without Saving Close_icon button to exit the Widget Editor without saving changes.

Save – Changes will be applied to the widget by clicking on the Save Widget_Save_icon button. The Widget Editor screen will close after the save operation is complete.

 

Note: The Filter-List widget has eight options. The following are the corresponding parameter names overridden for each of the eight options:

Action Level: Overrides @action_level_codes

Analyte: Overrides @cas_rns

Analyte Group: Overrides @analyte_groups

Analytic Method: Overrides @analytic_methods

Fraction: Overrides @fractions

Matrix: Overrides @matrix_codes

Task Code: Overrides @task_codes

Location

 

 

Filter-Date Range Widget

 

Filter_Date_Range_Widget_Sample

 

The Filter-Date Range widget has two display modes:

1.Display as Date Choosers will have a start date and end date input to select a custom date range for the report. In other words, set the START_DATE and END_DATE report parameters, if they exist.

2.Display as Year Drop-down List will have a list of recent years that can be selected. When selecting a year, the start date parameter is set with the first day of that year. The end date parameter is set to the last day of that year.

 

Widget Properties

 

To edit other widget properties, open the Widget Editor by selecting the More Options dashboard_chooser icon in the upper right corner of the widget to display the drop-down menu and then select the Edit menu option.

Widget Title – By default, the widget title is Filter-Date Range. The title can be modified.

Widget Color – The color of the widget can be changed using the Change Widget Themecolor_iconicon to the left of the widget title.

 

By default, the widget will be in the 'Date Choosers' display mode. To set the display mode as Year Drop-down List, click the Display As drop-down menu and choose Year Drop-down List display mode.

 

Filter_Date_Range_Display_As

 

Cancel – Select the Close without Saving Close_icon button to exit the Widget Editor without saving changes.

Save – Changes will be applied to the widget by clicking on the Save Widget_Save_icon button. The Widget Editor screen will close after the save operation is complete.

 

Warning: The Filter-Date Range widget overrides the @start_date and @end_date parameters of the reports on any widget.