Traffic Light Widget

<< Click to Display Table of Contents >>

Traffic Light Widget

The Traffic Light widget displays good/bad summary data from a report. This widget shows report data as four states: Alert (Ent-Traffic_Light_Widget_Alert-Icon), Warning (Ent-Traffic_Light_Widget_Warning_Icon), OK (Ent-Traffic_Light_Widget_OK_Icon), and Unknown (Ent-Traffic_Light_Widget_Unknown_Icon). This widget is normally used for analyte exceedances, but can be used for any other type of data by configuring the conditions for each of the breaks.




Widget Properties


The Traffic Light widget is empty when added to a dashboard and must be configured to show report results. The editor for this widget allows the user to select a report, and then configure the widget appearance.


To add data (select a report) or change properties of this widget, open the Widget Editor by selecting the More Options Ent-More_Options-Icon 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 Traffic Light. The title can be modified.

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

Report Chooser This control is used to select the report to be used with this instance of the Traffic Light widget. The name of the currently selected report (if applicable) is displayed by default. To select a different report, click the Choose a Report button or name of the report. The Report Chooser will open and display available reports. Select the desired report.

Report Parameters – The report parameters (e.g., analyte, sample date range, etc.) can be edited by clicking on the Edit button Ent-Report_Edit-icon to open the Report Parameter Editor for the selected report. A user with editor permission on the selected report may update the report.

Display Column – Select the column(s) to be displayed in the widget. The display columns will appear in the order they are selected.

Sort Column – Select which column will be used to sort the results. Please note that this column needs to be selected for the Traffic Light widget to work.

Descending – Allows for sorting results in descending order. Useful for dates.

Display Legend – The display of a legend can be toggled on and off. The legend will contain each icon, as well as all report columns, operators, and manually-inputted values.

Tooltip Template – Sets the template for the tooltip, which is shown when a user hovers over an icon. The template can make use of the report columns in the following way: ${SYS_LOC_CODE}: ${REPORT_RESULT_VALUE}, or ${SYS_LOC_CODE}-${REPORT_RESULT_VALUE}. The column name must be enclosed in { }.


Icon Size – Select the size for the traffic light icons.

State Symbols – For each icon, select a report column, an operator, and a value. The value can be a column of the report or can be typed in manually. The criteria are assessed from top to bottom (green to red) with the bottom parameters taking priority. The blue symbols represent an unknown status and are displayed for any condition that does not meet the criteria set for red, yellow or green symbols. The criteria for the blue symbol may be specified or left unset.


Note: The functionality of the widget may vary depending on the data type of the selected column(s). For example, comparing a numeric value (e.g., REPORT_RESULT_VALUE) to a text value (e.g., ACTION_LEVEL) may not work—particularly in cultures that do not use a period as the decimal separator. To ensure proper operation, select columns of the same data type (e.g., REPORT_RESULT_VALUE and ACTION_LEVEL_VALUE).


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

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

Help – The Help Ent-Help-Icon button connects to the online documentation related to the specific widget.