SRS Dashboard Design Guidance
SRS Dashboard Design Guidance
Version History: The 2019 version is the second release of the document, originally published in
November 2015. This release includes updated component names (Enhanced Security Monitoring was
changed to Physical Security Monitoring and Consequence Management to Water Contamination
Response), an updated version of Figure 1.1 that reflects the component name changes and includes the
Advanced Metering Infrastructure component, an updated version of Figure 3-2 that reflects additional
methods of receiving customer complaints, an updated Glossary, and updated links to external resources.
Questions concerning this document should be addressed to WQ_SRS@[Link] or the following contact:
Steve Allgeier
EPA Water Security Division
26 West Martin Luther King Drive
Mail Code 140
Cincinnati, OH 45268
(513) 569-7131
[Link]@[Link]
i
Acknowledgements
The document was developed by the EPA Water Security Division, with additional support provided
under EPA contract EP-C-15-012.
• Adam Haas, General Dynamics Information Technology
• Raja Kadiyala, Ph.D., Jacobs
• Christopher Macintosh, Jacobs
ii
Table of Contents
LIST OF FIGURES ........................................................................................................................................................ IV
LIST OF TABLES ........................................................................................................................................................... V
ABBREVIATIONS .......................................................................................................................................................... VI
SECTION 1: INTRODUCTION..........................................................................................................................................1
SECTION 2: FEATURES AND FUNCTIONS OF A DASHBOARD ........................................................................................4
2.1 OVERVIEW OF USEFUL FEATURES AND FUNCTIONS .............................................................................................4
2.1.1 Navigation through Different Data Representations...................................................................................4
2.1.2 Geospatial Presentation ..............................................................................................................................8
2.1.3 Alert Management ..................................................................................................................................... 13
2.2 EXAMPLE DASHBOARD USE CASES .................................................................................................................... 14
2.2.1 CCS Alert Investigation............................................................................................................................. 14
2.2.2 PHS Alert Investigation............................................................................................................................. 17
2.2.3 Analyzing Residual Chlorine to Manage Operations ................................................................................ 19
2.3 DASHBOARD CONCEPTUAL ARCHITECTURE ....................................................................................................... 21
2.3.1 Source Data Systems ................................................................................................................................. 22
2.3.2 Analytical Infrastructure ........................................................................................................................... 23
2.3.3 Presentation .............................................................................................................................................. 24
SECTION 3: DASHBOARD REQUIREMENTS ................................................................................................................. 25
3.1 FUNCTIONAL REQUIREMENTS ............................................................................................................................ 26
3.2 TECHNICAL REQUIREMENTS............................................................................................................................... 29
SECTION 4: DASHBOARD SOLUTION SELECTION ....................................................................................................... 31
SECTION 5: DASHBOARD MAINTENANCE................................................................................................................... 32
RESOURCES ................................................................................................................................................................. 35
GLOSSARY ................................................................................................................................................................... 36
iii
List of Figures
FIGURE 1-1. A DASHBOARD AS A CENTRAL ELEMENT OF AN SRS ................................................................................2
FIGURE 2-1. EXAMPLE OF A SINGLE PARAMETER TIME-SERIES PLOT ...........................................................................5
FIGURE 2-2. EXAMPLE OF A GAUGE DISPLAY ................................................................................................................6
FIGURE 2-3. EXAMPLE OF A BOX-AND-WHISKER PLOT .................................................................................................7
FIGURE 2-4. BASEMAP AND TOOLBAR IN A GEOSPATIAL DISPLAY ................................................................................8
FIGURE 2-5. EXAMPLE OF THEMATIC MAPPING........................................................................................................... 10
FIGURE 2-6. MAP LAYER EXAMPLES ........................................................................................................................... 11
FIGURE 2-7. EXAMPLE OF A COMBINED LAYER VIEW ................................................................................................. 12
FIGURE 2-8. EXAMPLE OF A COMPLEX LAYER VIEW WITH ANNOTATIONS .................................................................. 13
FIGURE 2-9. EXAMPLE OF AN ALERT MANAGEMENT TOOLBOX DISPLAY ................................................................... 14
FIGURE 2-10. USING A DASHBOARD TO INVESTIGATE A CCS ALERT .......................................................................... 16
FIGURE 2-11. USING A DASHBOARD TO INVESTIGATE A PHS ALERT .......................................................................... 18
FIGURE 2-12. USING A DASHBOARD TO ANALYZE CHLORINE RESIDUAL DATA .......................................................... 20
FIGURE 2-13. CONCEPTUAL DASHBOARD ARCHITECTURE .......................................................................................... 22
FIGURE 3-1. PROCESS TO DEFINE EXPECTED USES AND DEVELOP FUNCTIONAL REQUIREMENTS FOR A DASHBOARD 26
FIGURE 3-2. EXAMPLE COMPONENT-LEVEL INFORMATION FLOW DIAGRAM FOR CCS ............................................... 27
FIGURE 5-1. EXAMPLE CHANGE MANAGEMENT PROCESS ........................................................................................... 32
iv
List of Tables
TABLE 2-1. SYMBOLOGY USED IN EXAMPLES ............................................................................................................. 10
TABLE 2-2. EXAMPLE SOURCE DATA SYSTEMS........................................................................................................... 23
TABLE 3-1. EXAMPLES OF EXPECTED USES OF A DASHBOARD .................................................................................... 28
TABLE 3-2. EXAMPLES OF DASHBOARD FUNCTIONAL REQUIREMENTS ....................................................................... 29
TABLE 3-3. EXAMPLES OF DASHBOARD TECHNICAL REQUIREMENTS ......................................................................... 29
v
Abbreviations
ADS Anomaly Detection System
AMI Advanced Metering Infrastructure
CCS Customer Complaint Surveillance
Cond Conductivity
DOC Dissolved Organic Carbon
EPA United States Environmental Protection Agency
PSM Physical Security Monitoring
ETL Extract-Transform-Load
GIS Geographic Information System
IT Information Technology
LIMS Laboratory Information Management System
NH 4 Ammonia
NO 3 Nitrate
OWQM Online Water Quality Monitoring
PHS Public Health Surveillance
S&A Sampling and Analysis
SCADA Supervisory Control and Data Acquisition
SCR System Change Request
SRS Water Quality Surveillance and Response System
Temp Temperature
TOC Total Organic Carbon
Turb Turbidity
WCR Water Contamination Response
vi
Dashboard Design Guidance
Section 1: Introduction
A Water Quality Surveillance and Response System (SRS) is a system that employs one or more
surveillance components to monitor and manage distribution system water quality in real time. An
overview of the components of an SRS can be found in the Water Quality Surveillance and Response
System Primer. An SRS utilizes a variety of data analysis techniques to detect water quality anomalies
and generate alerts. The essence of an SRS is the integration of data from disparate sources to generate
new information that provides insight into distribution system water quality to support system operations
and informs the response to validated water quality incidents.
A dashboard is an information management system that supports the access to and visualization of
information created from the data produced by sources including the SRS components. Figure 1-1
illustrates the manner in which a dashboard can serve as a central information resource for an SRS and
support decision-making during response to possible contamination incidents. A dashboard also provides
a comprehensive view of system conditions to support distribution system monitoring and management.
In the context of this document, a dashboard is limited to the functions supporting data access, data
visualization, and alert management. This guidance does not address anomaly detection algorithms.
Because a dashboard is an element of the overall SRS information management system, the development
process discussed here is consistent with the general principles of information management system
development presented in Section 4 of Guidance for Developing Integrated Water Quality Surveillance
and Response Systems (referred to throughout this document as “SRS Integration Guidance”) with
specialized considerations relating to a dashboard. A dashboard differs from other information
management system elements in the following ways:
• A dashboard is required to interface with the other parts of the information management system,
in particular the sources of the datastreams utilized by the dashboard.
• It is likely that a dashboard will require some custom elements to ensure that it meets the
requirements established by a utility; however, significant elements of the system may be off
the shelf.
• The design and configuration of the sophisticated human-machine interface used in many
dashboards requires significant interaction between users and developers to meet the
requirements.
This document was written for utility managers and information technology (IT) personnel who are
engaged in the process of designing a dashboard to support an SRS. The purpose of this document is to
assist the target audience in understanding the benefits of a dashboard and the level of involvement
necessary to achieve the utility’s goals and objectives for the project. As the subsequent dashboard
development effort would generally be undertaken by a dedicated IT development team or consultant, the
understanding gained through this guidance will help the utility to become an informed buyer when
creating bid documents and entering into the required contracts for such a project.
1
Dashboard Design Guidance
2
Dashboard Design Guidance
3
Dashboard Design Guidance
The manner in which data is displayed on a dashboard depends on both functional requirements and the
attributes of the data, which can vary by component. For example, Online Water Quality Monitoring
(OWQM) may produce data at two-minute intervals, providing great detail about multiple parameters at
monitoring locations, while Sampling and Analysis (S&A) may produce data for given locations every
three weeks, and Customer Complaint Surveillance (CCS) produces data for customer complaints that
randomly occur in both time and space.
This section provides examples of how a dashboard can present a variety of data in a form and context
that yields actionable information. Common applications of a dashboard are illustrated through case
studies from real utilities to demonstrate the manner in which a dashboard can enhance the
implementation of utility procedures and processes. Finally, this section provides a description of the
high-level conceptual architecture and data sources that are generally necessary to build a dashboard.
Tabular representation of data is effective for smaller data sets and individual data points such as a list of
alerts or the results of recent grab samples. However, tabular representations become more difficult to
use effectively with larger data sets. For example, it would be difficult for a user to grasp meaningful
trends in time-series data through a tabular view. Thus, graphic representation of data is an important
feature of a dashboard. Three methods that have been found to be useful for viewing SRS data are time-
series plots, gauge displays, and box-and-whisker plots. Examples of each are presented in the following
sections.
4
Dashboard Design Guidance
Time-Series Plots
A time-series plot displays the data values plotted against a time scale, which is useful for understanding
data trends over a wide range of time scales as shown in Figure 2-1. The time scale can be varied to
present the data values over different periods of time. Short time periods can be useful for investigating
dramatic changes in a parameter, while longer time periods (such as days, weeks, or months) can reveal
gradual trends that may be indicative of periodic operational changes or seasonal trends. The time period
displayed is limited only by the number of data points available.
Figure 2-1. Example of a Single Parameter Time-Series Plot Over Different Time Periods
Patterns can be readily identified using a time-series plot, such as the example shown in Figure 2-1 where
chlorine residual values are displayed over a month, week, and day. The plot makes it apparent that
chlorine residual was initially within established control limits, but suddenly increased for a 12-hour
5
Dashboard Design Guidance
period before returning to concentrations within the control limits. Multiple parameters can also be
viewed on the same plot, allowing users to identify the relationships among parameters.
Time-series plots can also be useful as a diagnostic tool for monitoring equipment. For example, in an
OWQM application, constant or flat-lined data could indicate that the sensor electronics or the
communications system is not functioning correctly. If the data is erratic, it might indicate a
malfunctioning sensor or that the sensor has run out of a reagent.
Gauge Displays
While time-series plots are useful for observing trends in data, they are not particularly effective for
viewing current values from multiple datastreams. Figure 2-2 shows a gauge display that is effective for
monitoring current conditions of multiple parameters. This type of display is often presented as the
default display on a control room screen because current conditions are usually of most interest in a
control room.
The example shown in Figure 2-2 uses colored regions to indicate whether the individual parameters are
within normal operating range (green), in warning status (amber), or have exceeded a control limit (red).
Each of the gauges in this plot represents values for a specific parameter at an OWQM location. The
longer pointer (the minute hand) displays the current value, while the shorter pointer (the hour hand)
displays the hourly average for each parameter. This visualization method enables a user to easily
ascertain if the values are changing. If the hour and minute hands are overlapping (as is the case for
DOC, Free NH 4 , NO 3 , and Temp), it indicates that the values have been fairly constant over the last hour.
If the current value is less than the hourly average value (as is the case for Cond, TOC, and Turb), it
indicates that value for the parameter has trended downward over the past hour. If the current value is
more than the hourly average value (as is the case for Chlorine), it indicates that value for the parameter
has trended upward over the past hour.
6
Dashboard Design Guidance
Box-and-Whisker Plots
Another visualization tool is the box-and-whisker plot. This type of plot provides insight into the
statistical characteristics of a dataset by displaying markers for a number of key statistical elements as
show in Figure 2-3. The horizontal line, labelled as item 1, represents the mean. The top and bottom of
the box, labelled as item 2, represents the inter-quartile range (as delineated by the 25th and 75th
percentile). The whiskers, labelled as item 3, represent the lower and upper extent of the statistically
meaningful range. An additional feature shown in Figure 2-3 is the data cloud of values, labelled as
item 4. The red points in this cloud represent an occurrence of specific value, thus the density of the
cloud at a specific value correlates to the frequency at which that value occurred. The data cloud provides
a visualization of the clustering of data. Any data points outside of the whiskers are considered outliers,
labelled as item 5 in the figure.
Figures 2-1, 2-2, and 2-3 are all visualizations of time-series data, but they provide different
representations of the data: a time-series plot is useful for understanding temporal trends in the data, the
gauge display for effectively displaying current values, and box-and-whisker plots for understanding the
statistical characteristics of a dataset. By having all of these data representations available in a dashboard,
the user can select the one best suited to fulfill the current need.
7
Dashboard Design Guidance
As GIS interfaces present information in a geospatial context, they are built using grouped sets of
geospatial data referred to as layers. The common underlying layer is referred to as a basemap, which is
usually a map that contains non-utility features such as streets, highways, and jurisdictional boundaries.
Additional information is displayed in layers overlying the basemap. This additional information may be
static information such as distribution system assets and features (e.g., utility facilities, hydrants,
distribution mains, and pressure zone boundaries) or it may be dynamic information such as time-series
data from the SRS components or the location of incidents such as main breaks and maintenance
activities. This aggregated spatial display of data is a particularly valuable feature of a dashboard as it
provides a spatial context to interpret SRS data and investigate causal relationships among the data points.
An example of a basic geospatial presentation is shown in Figure 2-4.
GIS applications generally have a set of tools that, in this example, are depicted by the row of icons in the
toolbar at the top of Figure 2-4, and defined in the table to the right of the figure. Features may differ
with the particular GIS software implemented, but the following basic functions should be available in
most GIS packages:
8
Dashboard Design Guidance
• Pan and zoom to enable users to scroll across the map and zoom in or out to specific areas
• Layer control to allow users to select the layers to display and to set display attributes, such as
transparency, for each layer (see below for a more detailed description of layers)
• Distance measurement between points or along a path
• The ability to identify or view GIS attribute data of a specific feature on the screen (for example,
street address, parcel ID, work order number, or political boundary)
• The ability to search by GIS attribute data
• The ability to add annotations and sketches as a new layer
• Bookmarking of views to enable them to be retrieved later
• The ability to display detailed data by clicking on the related icon on the display
The value of a geospatial display is its ability to represent complex data in an intuitive, visually oriented
manner. Symbology and thematic mapping are methods commonly used to represent data in a geospatial
display, as discussed in the following section.
GIS layers utilize symbols to convey additional details about the data represented in the layer. A water
distribution layer could include map symbols to denote the location of pipes, meters, valves, and flow
restrictors. A layer can also include symbols or icons that change depending on the status of the element
represented by the icon to convey additional information. Referred to as thematic mapping, this
visualization can be as simple as icons that change depending on the current value of the parameter
represented by the icon. An example of thematic mapping is the use of different colors for an OWQM
station icon that indicate the current status of the station (e.g., blue = normal, yellow = equipment fault,
red = alert, grey = off-line). A more complex example for S&A is use of color gradation of icons to
indicate the value of a parameter at each monitored location (e.g., blue = low values, green = values in
range, and red = high values) with the predefined parameter of interest labelled within the icon. By
plotting color gradation icons from all sampling locations on a map, one can quickly identify areas of the
distribution system where the parameter value is out of range.
9
Dashboard Design Guidance
An example of thematic mapping is shown in Figure 2-5, in which the color of the “Cl” icon indicates the
range in which current chlorine values fall.
10
Dashboard Design Guidance
Map Layers
A fundamental feature of geospatial presentation is layered viewing of data with respect to location. The
layered view allows a user to see the information needed while removing unnecessary layers that can
cause clutter. Figure 2-6 shows common layers that can be included in an SRS dashboard such as utility
GIS data and SRS component information.
11
Dashboard Design Guidance
The combined view that would be presented in the GIS if all the layers in Figure 2-6 were included is
shown in Figure 2-7, which presents customer complaint locations referenced to the utility’s pipes,
hydrants, and OWQM stations. Overlaying different types of information in this manner can help to
identify causal relationships. For example, a spatial clustering of dirty water complaints and elevated
turbidity readings downstream of a pipe break may establish the cause of the complaints.
12
Dashboard Design Guidance
Figure 2-8 is an example of a multi-layered view that could be used to conduct a detailed investigation of
an alert. It shows the street basemap, pressure zones (shown in background colors with partial
transparency), distribution pipes (shown in blue), and CCS calls (telephone handset) layers displayed.
The key functions that a dashboard can provide to support alert management are:
• Access to all available information required to support an alert investigation
• Guidance for the alert investigation process
• Documentation of alert investigation activities and findings
• Information-sharing during the alert investigation
13
Dashboard Design Guidance
the current status of the alert investigation to be displayed. Notes documenting the investigation can be
entered in the “Add Comment” area. Any information entered using this tool would be available to other
dashboard users.
These examples indicate how a dashboard with data visualization, geospatial display, and alert
management capabilities can support:
• Investigation of a CCS alert
• Investigation of a Public Health Surveillance (PHS) alert
• Routine analysis of OWQM data to manage operations
14
Dashboard Design Guidance
• Review recent online and grab water quality data for unusual conditions that could be related to
the complaints.
Note that other activities may be included in the investigation, such as contacting other departments,
though this example focuses solely on use of the dashboard. The manner in which the dashboard is used
to support this investigation process is illustrated in Figure 2-10, which references the numbered items
listed below:
• Item 1: The CCS alert is received as a text or email, or shown on the dashboard display. The
alert indicates multiple “dirty water” complaints in the north pressure zone.
• Item 2: The Alert Management Toolbox is used to display the list of current alerts. A utility user
acknowledges the alert and adds a note indicating that nearby maintenance activity will be
reviewed as a potential cause of the alert.
• Item 3: The CCS layer is activated to display the area related to the CCS calls along with a layer
showing pressure zones. Details of the CCS calls, including house address and complaint type,
are shown in the tabular view at the bottom of the screen. The GIS display shows that all recent
complaints are in a cluster within the same pressure zone.
• Item 4: Additional layers are opened to display pipe breaks, locations of fire hydrants, and other
work orders in the same pressure zone to investigate potential causes of the complaints. There is
an open work order to flush a line in the vicinity of the complaint.
• Item 5: The OWQM layer is opened and a time-series plot is displayed for recent turbidity data
from an OWQM station located in the pressure zone associated with the CCS alert. The time-
series plot from the OWQM station, which is downstream of the complaints, shows two minor
spikes in turbidity, but nothing that would be considered noticeable to a consumer.
• Item 6: The S&A layer is activated to display grab sample data, in this case for the last
12 months. The layer is used to look for nearby sampling locations that were sampled for
turbidity on the day of the CCS alert. While no sample results were available from that day, the
timescale of the plot was extended to investigate seasonal trends in turbidity. No seasonal trends
in turbidity were identified. With no corroborating data from OWQM and S&A to indicate a
more widespread problem, normal investigation procedures were followed to take grab samples at
the impacted residences.
15
Dashboard Design Guidance
16
Dashboard Design Guidance
The primary steps in this PHS alert investigation are the following:
• Use the dashboard to acknowledge the alert and view the details of the alert, including location of
the underlying cases.
• View the dashboard to determine whether the cases are spatially clustered.
• Review OWQM time-series plots and CCS dirty water complaints for the previous week in the
area of the cluster (overlay of time-shifted data).
• Annotate the alert and document the investigation.
The process for using a dashboard in this example is illustrated in Figure 2-11 with example screens
corresponding to the numbered items listed below to demonstrate the information provided through the
dashboard.
• Item 1: The PHS alert is received as a text or email, or displayed on the dashboard. The alert
indicates that there were multiple “rash” cases reported from the same zip code.
• Item 2: The Alert Management Toolbox displays the list of current alerts. Four PHS alerts are
shown as having been received in the previous 30 hours, with two for rash and two for
neurological symptoms (neuro). The utility user acknowledges the alert, and adds a note that
CCS alerts from the previous week will be reviewed. The reason for checking CCS alerts for the
previous week is that water quality issues that cause an illness will typically precede symptoms of
the illness by hours to several days.
• Item 3: The PHS layer is displayed, showing the highlighted zip code containing the cases
associated with the PHS alert. Detailed case counts associated with the alert are shown in the
tabular view at the bottom of the screen.
• Item 4: The OWQM layer is activated, and a time-series plot of turbidity data is displayed from
an OWQM station in the zip code in which the PHS alert was generated. Due to the delay
between a potential water quality anomaly and symptom onset, the investigator views OWQM
data for the two weeks prior to the PHS alert. The time-series plot shows that turbidity has been
low and within acceptable levels for this two week period.
• Item 5: The CCS layer is activated, displaying related dirty water calls for this same area during
the week prior to the PHS alert. There is a cluster of CCS calls within the zip code of the PHS
cases, which could indicate a potential water quality issue related to the PHS alert. Further
investigation will be undertaken to determine whether a water quality incident may have caused
the underlying cases that triggered the PHS alert.
17
Dashboard Design Guidance
18
Dashboard Design Guidance
The process for using a dashboard in this example is illustrated in Figure 2-12. Example screens
correspond to the numbered items listed below to demonstrate the information provided by the dashboard:
• Item 1: Time-series plots are displayed for chlorine levels at each of the OWQM stations, with
one of the time-series plots showing the chlorine level trending upwards.
• Item 2: Time-series plots are displayed for the other parameters at the OWQM station with no
other parameters showing a deviation from the baseline.
• Item 3: OWQM stations upstream and downstream of the station with the high chlorine levels are
located on the map.
• Item 4: Time-series plots for chlorine are displayed for upstream and downstream OWQM
stations showing that chlorine levels are within normal range.
• Item 5: Layers are activated to display distribution system work orders and main breaks in the
area to investigate whether these activities might have caused the elevated chlorine levels at the
one OWQM station. This step of the investigation reveals that there a main break repaired and
disinfected with high levels of chlorine on the same day as the chlorine residuals began to rise.
• Item 6: Both the OWQM layer and the CCS layer are displayed together indicating that the taste
and odor complaints are likely related to the short period of elevated chlorine residual levels
resulting from the repair. Crews were sent out to perform hydrant flushing in the impacted area
and operating procedures were reviewed to evaluate how to avoid this type of incident in the
future.
19
Dashboard Design Guidance
20
Dashboard Design Guidance
The conceptual dashboard architecture illustrated in Figure 2-13 is modeled after a standard architecture
that extracts basic data from multiple source data systems, transforms the source data into a format that
can be more readily displayed and understood, and consolidates the data into a single repository. A
conceptual architecture does not represent all of the physical elements necessary to build the system, but
does identify the major elements of the system. A conceptual SRS dashboard architecture generally
includes the following three tiers: source data systems, analytical infrastructure, and presentation.
Figure 2-13 shows how these tiers relate and the type of source data systems that may be available to
support an SRS dashboard. These tiers are discussed in further detail in the following subsections.
21
Dashboard Design Guidance
22
Dashboard Design Guidance
Identification of the source data systems for the SRS components and ancillary data systems that will be
included in the dashboard is necessary to define the conceptual architecture. The IT design team will
base this decision on the requirements developed for the dashboard as described in Section 3. A
dashboard could be designed to display data from a single component, multiple components, or all
components along with the ancillary data systems. The decision about those source data systems to
include in the dashboard will be informed by insight gained during review of the requirements and an
inventory of existing software and systems.
The analytical infrastructure includes an intermediate repository known as the operational data store,
which provides a short-term repository that stores only recent data that would frequently be displayed on
the dashboard. The operational data store
allows for the data to be extracted once
HELPFUL HINT
from the source data system and then
Other processes may also occur at this level including
transformed into a format that allows for data analysis or anomaly detection that references
efficient display before it is loaded into the multiple source data systems. For example, the CCS
operational data store through a process ADS typically leverages both the GIS and Customer
termed Extract-Transform-Load (ETL). Information System source data systems to generate
and display alerts. The Customer Information System is
used to track the number of water quality complaints,
The ETL converts source data into a more and the ADS determines whether an established
efficient data store for use within the threshold is exceeded. The GIS is used to geolocate the
dashboard. This is achieved by extracting customer calls for display on a map layer and, in
the necessary data from the source data advanced data analysis systems, is used to incorporate
spatial clustering into the detection algorithm.
systems, transforming the data into a format
that is more closely aligned to the intended
display or report structure, and loading the data into the operational data store for use by the dashboard.
The efficiency gained in performing the transformation once during the ETL, as opposed to doing it on-
the-fly for every user interaction, improves the performance of the dashboard. Data validation and data
23
Dashboard Design Guidance
quality checks are also performed during the ETL. The dashboard displays this transformed data within
the presentation tier.
Some data does not require transformation or temporary storage in the operational data store and thus
bypasses this process in the analytical infrastructure tier. In the example architecture shown in
Figure 2-13, both GIS and the security video server data bypass this tier. The data in both of these
systems does not require transformation prior to display in the presentation tier. In the case of GIS, the
map services are designed to provide other systems with GIS data on demand and the dashboard is just
another system that can connect to the GIS resource. In the case of security video, the large video files
are provided to the presentation tier on demand, and software running on the client-side browser allows
the video to play without transformation.
2.3.3 Presentation
The presentation tier provides the interface to the user. The results from the analytical infrastructure are
made available to the presentation tier where they are combined with the GIS map services to provide
geospatial context. This creates the display layers described earlier in this section, which can be
manipulated by the user through an interface. On-screen interactions with the dashboard may include
requests for different data presentations and user input to the alert management toolbox. This tier
includes user access through devices such as work stations and mobile devices.
The dashboard may generate some data for alert management and may require some configuration
information to be stored in a database that can be accessed by the dashboard as needed. This dashboard
database also allows users to access data created through interactions with the dashboard, such as alert
investigation records.
As the presentation tier is the interface with the user, this is where most of the dashboard requirements
identified by end users will be observed. See Section 3 for further discussion of requirements.
24
Dashboard Design Guidance
While the overall process of developing information management requirements for a dashboard is
generally the same as it is for other systems, there are considerations unique to a dashboard:
• A dashboard relies on data and information from a variety of source data systems, many of which
may already exist.
• A dashboard is intended to present information in an intuitive manner to assist users in
monitoring the current status of distribution system water quality and quickly detecting potential
water quality incidents.
• A dashboard must support a variety of needs and applications from different users while
presenting information in a consistent manner for all users.
This section provides guidance on the development of requirements, concentrating on the aspects of this
process that are unique to a dashboard as compared to other information management systems. The
following two categories of requirements need to be developed for an SRS dashboard:
• Functional requirements define key features and attributes of the system that are visible to the
end user. Examples of functional requirements include the manner in which data can be
accessed, types of tables and plots that can be produced through the user interface, the means by
which component alerts are transmitted to investigators, and the ability to generate custom
reports. Functional requirements are primarily developed by the component teams.
• Technical requirements are system attributes and design features that are often not readily
apparent to the end user, but are essential to meeting functional requirements and other design
constraints. Examples include attributes such as system availability, information security and
privacy, backup and recovery, data storage needs, and integration requirements. Technical
requirements are generally developed by IT personnel or derived from IT standards.
Documentation of requirements is important and can be achieved through a variety of methods. The
Information Management Requirements Development Tool can be used to document the functional
requirements for each component and the technical requirements for the system, consolidate
requirements, and rate the relative importance of each. The final set of requirements will be used to
develop design documentation and bid documents as appropriate. The process of developing and
25
Dashboard Design Guidance
documenting functional and technical requirements is described in more detail in the following
subsections.
As part of the development of functional requirements, it is recommended that the IT design team engage
component teams and other stakeholders at the beginning of the process and provide them with relevant
documentation for review. This group should then define expected uses of the dashboard before
developing the requirements. These steps are depicted in Figure 3-1 and elaborated below.
Figure 3-1. Process to Define Expected Uses and Develop Functional Requirements for a
Dashboard
26
Dashboard Design Guidance
CSR
Enter call
data
CSR
into system
Workstation
Customer
Calls Customer call data Mobile
Email/Text Notification
Phone
alerts Water Quality
Manager
Filter
water Alerts and
quality call data
complaints Laptop
Emails, web forms, instant (remote access)
message, text message, CCS Anomaly
social media CCS Information Detection System
Management Alerts and Notification/Investigation
System call data
Legend
Human-Human Interaction
Human-Machine Interaction
Machine-Machine Interaction
CSR Customer Service Representative
Workstation
27
Dashboard Design Guidance
28
Dashboard Design Guidance
29
Dashboard Design Guidance
A clear and complete set of technical and functional requirements is a critical prerequisite to selecting a
dashboard solution. Section 4 provides guidance on selecting a dashboard solution to meet a utility’s
specific requirements.
30
Dashboard Design Guidance
The physical implementation of a dashboard, which includes the actual equipment and physical
interconnections necessary to transmit information between devices, will be more complex than the
conceptual architecture described in Section 2.3. For
example, a source data system may be represented as a
single server in the conceptual architecture, but may HELPFUL HINT
actually consist of several pieces of hardware. The physical Those responsible for maintenance of
system will be influenced by the technical requirements and the system should be engaged early in
the design process as this will facilitate
the existing IT infrastructure with which the dashboard is their understanding of the design and
interfacing. These complexities are important to consider implications for system maintenance
when evaluating alternate dashboard solutions because the requirements.
cost of integrating a dashboard with the existing systems
can have a considerable impact on the total cost.
A dashboard will usually consist of some off-the-shelf software, such as a GIS package, with custom
developed software to integrate data sources and present the data. Thus implementation of a dashboard
will likely involve selection of both custom and off-the-shelf elements. Selection of the final dashboard
solution may involve consideration of many factors, such as functionality, cost, security, and adherence to
IT security policies. The Framework for Comparing Alternatives for Water Quality Surveillance and
Response Systems presents a systematic process for conducting this comparative analysis.
Because an SRS dashboard interfaces with many other elements of a utility’s IT system, it should be
included in the utility’s IT master plan. Section 4.4 of the SRS Integration Guidance provides additional
guidance for incorporating SRS information systems into an IT master plan.
31
Dashboard Design Guidance
Maintenance of a dashboard may involve changes to hardware and software to provide new functionality
or to maintain existing functionality when other parts of the system are modified. Changes are usually
required for the following reasons:
• Major software updates and operating system upgrades
• Recoding to incorporate new datastreams or components
• Recoding of the dashboard presentation tier when other tiers (e.g., source data systems) of the
dashboard architecture are upgraded or replaced
• Recoding to add new functionality identified through additional user requirements
• Changes to algorithms used by the dashboard to improve performance
A backup and recovery plan should be developed to support the maintenance of the dashboard. When
migrating a new software version to the production environment it is important to ensure there is a backup
of the last working version available to allow for a system rollback if issues arise with the new version.
An example change management approach is shown in Figure 5-1 and a description of each step in the
process is provided below.
32
Dashboard Design Guidance
Impact Analysis
The submitted SCR must be reviewed and analyzed to better understand the potential impact on other
systems, tiers, or modules within the dashboard architecture. Consideration should also be given to the
impact of the change on system documentation, training requirements, and user experience. The impact
analysis allows IT personnel to estimate the resources needed (for example, staff, budget, and
infrastructure) to implement the SCR. The benefits of the SCR should also be analyzed to determine if it
justifies the cost. Depending on the complexity of the SCR, additional detail may need to be developed to
assist in the analysis.
Review Change
With the SCR defined and the impact analyzed, the request should be reviewed to determine whether the
change should be implemented and, if so, when it should be implemented. The group reviewing the SCR
would normally have representation by IT personnel as well as users, such as component leads. The
review process may identify the need for additional information or further analysis before making the
final decision whether to implement the change.
Implement Change
Implementation of the SCR includes the following steps:
• Design: creation of documents to define the necessary changes to the system, which may include
requirements, use cases, database schema revisions, or screen mock-ups.
• Development: implementation of changes in software code or system configuration.
• Testing and validation: quality assurance steps to make sure that the changes meet the SCR and
do not impact other functionality.
• Documentation: potential updates to documentation such as architecture diagrams, system
operations and maintenance manuals, user manuals, frequently asked questions, and training
resources.
• Deployment: migration of the tested changes to the production environment.
These steps should closely follow the same steps utilized in designing and developing the original
dashboard. Once the change has been designed and developed, it must be tested. It is recommended that
a test environment, separate from but representative of the production system, be used for this purpose.
This strategy will help to ensure that the altered system operates as intended without introducing
problems to other parts of the system. The test environment may need to include all the tiers in the
architecture and the ancillary systems.
Post-Implementation Review
The post-implementation review provides an opportunity to measure the success of the change and close
out the change management process. Post-implementation review may reveal that modifications are
needed to achieve acceptable performance or that end users require additional training. The post-
implementation review is the final quality assurance checkpoint in the change management process.
To ensure that dashboard maintenance is effective and coordinated with interdependent data management
systems, an IT operations and maintenance plan should be developed and integrated with the utility’s
33
Dashboard Design Guidance
other IT operations and maintenance plans. An example IT operations and maintenance plan can be
found in Appendix B of the SRS Integration Guidance.
Maintenance is an ongoing activity to provide functional and robust system performance throughout the
useful life of the dashboard. Adequate internal or external support for maintenance should be provided to
ensure that the dashboard continues to perform as required. Funding will be required for these
maintenance activities, and it is suggested that utility managers incorporate these costs into the annual
operating budget.
34
Dashboard Design Guidance
Resources
Water Quality Surveillance and Response System Primer
This document provides an overview of Water Quality Surveillance and Response Systems, and
serves as a foundation for the application of technical guidance and products used to implement
an SRS. EPA 817-B-15-002, May 2015.
[Link]
06/documents/water_quality_sureveillance_and_response_system_primer.pdf
Guidance for Developing Integrated Water Quality Surveillance and Response Systems
This document provides guidance for applying system engineering principles to the design and
implementation of an SRS to ensure that the SRS functions as an integrated whole and is
designed to effectively perform its intended function. Section 4 provides guidance on developing
information management system requirements, selecting an information management system, and
IT master planning. Appendix B provides an example outline for an IT operations and
maintenance plan. EPA 817-B-15-006, October 2015.
[Link]
12/documents/guidance_for_developing_integrated_wq_srss_110415.pdf
Summary of Implementation Approaches and Lessons Learned from the Water Security Initiative
Contamination Warning System Pilots
This report summarizes implementation approaches and lessons learned from the five
Contamination Warning System Pilots deployed under EPA’s Water Security Initiative. It
presents information for each of the surveillance and response components, as well as the
integrated system, in a manner useful to those implementing similar systems. EPA 817-R-15-
002, October 2015.
[Link]
12/documents/wsi_pilot_summary_report_102715.pdf
Framework for Comparing Alternatives for Water Quality Surveillance and Response Systems
This document provides guidance for selecting the most appropriate SRS design for a utility from
a set of viable alternatives. It guides the user through an objective, stepwise analysis for ranking
multiple alternatives and describes, in general terms, the types of information necessary to
compare the alternatives. EPA 817-B-15-003, June 2015.
[Link]
07/documents/framework_for_comparing_alternatives_for_water_quality_surveillance_and_resp
onse_systems.pdf
35
Dashboard Design Guidance
Glossary
Advance Metering Infrastructure (AMI). Systems that measure, collect, and analyze water usage, and
communicate with water meters, either on request or on a schedule. These systems include hardware,
software, and communications for data access, visualization, and analysis. An AMI system may include
consumer use displays, customer associated systems, meter data management software, and supplier
business systems. The meters may be coupled with pressure monitors, temperature sensors, other devices,
outside data streams (weather), and alert for tampering and backflow incidents.
alert. An indication from an SRS surveillance component that an anomaly has been detected in a
datastream monitored by that component. Alerts may be visual or audible, and may initiate automatic
notifications such as pager, text, or email messages.
ancillary. A system or data source that is not one of the defined SRS components. Examples may
include work order management systems, GIS sources, or notification systems.
anomaly detection system (ADS). A data analysis tool designed to detect deviations from an established
baseline. An ADS may take a variety of forms, ranging from complex computer algorithms to thresholds.
architecture. Architecture is the fundamental organization of a system embodied in its components, their
relationships to each other and to the environment, and the principles guiding its design and evolution.
The architecture of an information management system is conceptualized as three tiers: source data
systems, analytical infrastructure, and presentation.
component. One of the primary functional areas of an SRS. There are five surveillance components:
Online Water Quality Monitoring, Physical Security Monitoring, Advance Metering Infrastructure,
Customer Complaint Surveillance, and Public Health Surveillance. There are two response components:
Water Contamination Response and Sampling and Analysis.
component team. A designated group of individuals responsible for design and implementation of an
SRS component.
Customer Complaint Surveillance (CCS). One of the surveillance components of an SRS. CCS
monitors water quality complaint data in call or work management systems and identifies abnormally
high volumes or spatial clustering of complaints that may be indicative of a contamination incident.
dashboard. A visually-oriented user interface that integrates data from multiple SRS components to
provide a holistic view of distribution system water quality. The integrated display of information in a
dashboard allows for more efficient and effective management of distribution system water quality and
the timely investigation of water quality incidents.
data analysis. The process of analyzing data to support routine system operation, rapid identification of
water quality anomalies, and generation of alert notifications.
datastream. A time series of values for a unique parameter or set of parameters. Examples of SRS
datastreams include chlorine residual values, water quality complaint counts, and number of emergency
department cases.
36
Dashboard Design Guidance
design goal. The specific benefits to be realized through deployment of an SRS and each of its
components. A fundamental design goal of an SRS is detecting and responding to distribution system
contamination incidents. Additional design goals for an SRS are established by a utility and often include
benefits to routine utility operations.
Extract-Transform-Load (ETL). The process of pulling data out of a source system (extract),
converting the data into a format that is more closely aligned to the end display or use of the data
(transform), and placing the revised data into another data repository (load).
functional requirement. A type of information management requirement that defines key features and
attributes of an information management system that are visible to the end user. Examples of functional
requirements include the manner in which data is accessed, types of tables and plots that can be produced
through the user interface, the manner in which component alerts are transmitted to investigators, and the
ability to generate custom reports.
geographic information system (GIS). Hardware and software used to store, manage, and display
geographically referenced information. Typical information layers used by water utilities include utility
infrastructure, hydrants, service lines, streets, and hydraulic zones. A GIS can also be used to display
information generated by an SRS.
information management system. The combination of hardware, software, tools, and processes that
collectively support an SRS and provides users with information needed to monitor real-time system
conditions. The system allows users to efficiently identify, investigate, and respond to water quality
incidents.
information technology (IT). Hardware, software, and data networks that store, manage, and process
information.
IT design team. Personnel responsible for selecting, designing, and implementing the SRS information
management system.
monitoring station. A configuration of one or more water quality sensors and associated support
systems, such as plumbing, electric, and communications, that is deployed to monitor water quality in real
time at a specific location in a drinking water distribution system.
Online Water Quality Monitoring (OWQM). One of the surveillance components of an SRS. OWQM
utilizes data collected from monitoring stations that are installed at strategic locations in a utility’s source
waters and/or distribution system. Data from the monitoring stations is transferred to a central location
and analyzed for water quality anomalies.
operational data store. An intermediate repository within the analytical infrastructure for short-term
storage of recent data that would be frequently displayed on the dashboard or needed by an anomaly
detection algorithm.
performance objectives. Measurable indicators of how well an SRS or its components meet established
design goals.
Physical Security Monitoring (PSM). One of the surveillance components of an SRS. PSM includes
the equipment and procedures used to detect and respond to security breaches at distribution system
facilities that are vulnerable to contamination.
37
Dashboard Design Guidance
Public Health Surveillance (PHS). One of the surveillance components of an SRS. PHS involves the
analysis of public health datastreams to identify public health incidents and the investigation of such
incidents to determine whether they may be due to drinking water contamination.
real-time. A mode of operation in which data describing the current state of a system is available in
sufficient time for analysis and subsequent use to support assessment, control, and decision functions
related to the monitored system.
Sampling and Analysis (S&A). One of the response components of an SRS. S&A is activated during
Water Contamination Response to help confirm or rule out possible water contamination through field
and laboratory analyses of water samples. In addition to laboratory analyses, S&A includes all the
activities associated with site characterization. S&A continues to be active throughout remediation and
recovery if contamination is confirmed.
system of record. The application or database that houses and manages the source data to provide the
definitive data that will be utilized by the dashboard.
technical requirement. A type of information management requirement that defines system attributes
and design features that are often not readily apparent to the end user but are essential to meeting
functional requirements or other design constraints. Examples include attributes such as system
availability, information security and privacy, back-up and recovery, data storage needs, and integration
requirements.
Water Contamination Response (WCR). One of the response components of an SRS. This component
encompasses actions taken to plan for and respond to possible drinking water contamination incidents to
minimize the response and recovery timeframe, and ultimately minimize consequences to a utility and the
public.
water quality incident. An incident that results in an undesirable change in water quality (e.g., low
residual disinfectant, rusty water, taste and odor, etc.). Contamination incidents are a subset of water
quality incidents.
Water Quality Surveillance and Response System (SRS). A system that employs one or more
surveillance components to monitor and manage distribution system water quality in real time. An SRS
utilizes a variety of data analysis techniques to detect water quality anomalies and generate alerts.
Procedures guide the investigation of alerts and the response to validated water quality incidents that
might impact operations, public health, or utility infrastructure.
38
Spatial clustering analysis is crucial in responding to CCS and PHS alerts because it helps identify patterns and potential sources of contamination by examining geographical concentrations of alerts. In CCS alerts, clustering insights guide utility staff to investigate specific regions for possible causes by reviewing complaints and system operations data . Similarly, for PHS alerts, analyzing clustering can help determine whether there is a connection to water quality issues, facilitating effective responses by identifying and addressing the root cause of health-related issues within specific zip codes .
Involving IT personnel and component teams is crucial for developing a dashboard's functional and technical requirements because they bring expertise in system integration, security, and standard practices that are vital for system stability and performance. IT personnel ensure that technical requirements such as system availability, security, and data integration are met . Meanwhile, component teams contribute to understanding user needs and crafting functional requirements that align the dashboard's capabilities with operational objectives. This collaboration facilitates creating a cohesive platform that is both technically robust and user-friendly, maximizing the dashboard's effectiveness in monitoring and managing water quality .
Investigating a CCS alert involves several key steps: 1) Receiving and acknowledging the alert via email, text, or dashboard display, noting 'dirty water' complaints . 2) Reviewing alerts using the Alert Management Toolbox, adding notes on nearby maintenance activities . 3) Activating CCS layers to display calls and pressure zones for spatial analysis . 4) Overlaying additional data such as pipe breaks and work orders to identify possible causes . 5) Examining OWQM station turbidity data and grab samples for unusual conditions . These steps aim to comprehensively assess and address the alert's underlying causes to ensure water quality and system reliability.
Data visualization in a dashboard aids detection and response to water quality incidents by presenting information in a clear, intuitive format that enhances situational awareness. Through geospatial displays, time-series plots, and customizable alert identifiers, users can quickly identify abnormal conditions, such as turbidity spikes or clustered alerts . This visual representation helps in correlating spatial patterns with operational data, facilitating timely investigations and interventions. Consequently, data visualization enables utilities to respond effectively to potential contamination events, supporting swift decision-making processes and maintaining water quality standards .
Developing dashboard requirements involves understanding utility-specific factors such as personnel, organizational structure, production size, and the SRS's design goals. The process involves using end-user driven methods to develop both functional and technical requirements, which are then documented for design and bidding purposes. Functional requirements focus on user-visible features like data access and alert notifications, while technical requirements involve system attributes like system availability and security . Before starting, utilities should gather information flow diagrams, IT project inventories, policy copies, and note budgetary/schedule constraints . This approach ensures the dashboard addresses a wide variety of user needs and applications consistently .
Dashboards support routine analysis by providing tools to regularly review water quality indicators such as chlorine residual trends. This involves generating weekly time-series plots for each Online Water Quality Monitoring (OWQM) station, checking for deviations outside control limits, and integrating data from other system components and operational data. This continuous monitoring enables utilities to identify issues proactively, ensuring consistent water quality in storage tanks and distributed systems . By displaying information intuitively and enabling rapid access to diagnostic details, dashboards enhance operational management and decision-making efficiency .
User-specific design goals and performance objectives significantly shape the development of dashboard requirements by tailoring the system to meet the specific operational, monitoring, and management needs of different utilities. These factors result in a unique set of requirements that reflect the operational scale, complexity, and user expectations unique to each utility . This customization ensures the dashboard effectively supports users in their roles, with functional and technical requirements developed through collaborative processes involving stakeholders and end users. This alignment ensures the dashboard reliably informs decision-making and operational oversight within the utility's context .
The Alert Management Toolbox enhances dashboard functionality by offering an organized feature to manage alerts. It displays a list of recent alerts, allowing utility staff to acknowledge, document, and investigate alerts systematically. Users can add comments during investigations, which aids in maintaining a consistent record accessible to all dashboard users. This feature supports more efficient management and resolution of alerts by providing relevant details and facilitating the tracking of investigation procedures .
A dashboard serves as a central information resource for a Surveillance and Response System (SRS), supporting decision-making during responses to possible contamination incidents. It provides a comprehensive view of system conditions to aid in monitoring and managing the distribution system . Dashboards are required to interface integrally with other parts of the information management system, particularly with the data stream sources used by the dashboard. They may require customization to meet specific utility requirements while catering to sophisticated human-machine interfaces, demanding substantial interaction between users and developers to tailor these interfaces effectively .
The functional requirements of a utility dashboard include features such as data access, alert notification methods, and the ability to generate various tables, plots, and custom reports . Developing these requirements involves engaging potential users early on, ensuring that the system's design supports their monitoring needs and application purposes. Workshops with users, draft screen mockups, and user feedback are used to develop and refine these requirements, ensuring clarity and alignment with user expectations . This user-centered approach helps ensure the dashboard effectively aids in monitoring distribution system water quality and incident detection .