view | edit

Similar to the DamRiverWeather report but with increased control over station/parameter groupings and which sensors are included in the report.

View

This report displays data from varying stations and parameters organized by user defined groupings.  The data refreshes on a timer, which is displayed in the upper left portion of the web page (TTR).  The timestamp will be displayed in the configured display timezone. 

If the data is overdue for that station-parameter, the parameter value will be highlighted in the corresponding color (yellow).  Likewise, if the data is late, the parameter value will be highlighted in the corresponding color (red). Station-parameters with late or overdue data will additionally be marked with an alert icon (circle with an exclamation mark). Hovering over these icons will show the last timestamp as well as that data's age in days and hours
NOTE - The displayed timestamp is gathered from one of the data values at that station.  While the other data values are likely to have the same timestamp, they are each their own sensor and, in some cases, the timestamp can be different.  To be absolutely sure of the timestamp for any data value, hover over that value and a tooltip will occur with the corresponding timestamp.  This is also the case with the unit value for that timeseries.  It should be consistent with the unit in the header, but each timeseries can technically have its own unit.  If you want to make sure, hover over the link and it will also display the unit for that corresponding value.


The data values on the page change every time the TTR value goes to zero.  Users can interact with these data values by:

  • Hovering: This will display specific data about that exact value such as the path that was used to get the value and the exact timestamp for that value.
  • Clicking: This will display an interactive line graph where you can see the data over a customizable period of time. In this chart view you can also view the data for all underlying sensors.For more information on the interactive graph see Charts


NOTE - If you click the header link for any of the data values, it will open a line graph with all of the corresponding values under that header.  This gives users the ability to compare all of the values in that section in the same graph.


If you see a -- value, this means that there is no data for that sensor at that station.

Edit

To Create/Modify a report, the user must be logged in as either an operator or a controller.


Navigate to the create or edit page. Then under the DamRiverWeather section select either 'new' or 'edit'.


To give the report a title, enter the title into the "Title" text field.


The fully customizable report has three primary components; Sections, Subsections, Columns.



Sections

Sections are the top level grouping unit of this report. A report may have one or more sections.

Sections are logical grouping to help organize the report and may be used similarly to the 'Dams', 'Rivers', 'Weather' groups of the DamRiverWeather reports but completely user configurable and not limited by those concepts.

Each section contains a number of Subsections as well as a set of one or Column definitions.

Adding

To add a new Section to the report click the '+' button in the bottom right of the page. This will append a new section definition to the list of existing sections.

Fields

Subsections have four fields. Title, Subsections, Columns

    • Title - the name of the section, appears at the top of the section in the viewable report
    • Subsections - groupings of station rows
    • Columns - parameters/data-sets to display for each station in the section


Reordering 

Sections can be reordered by dragging and dropping into its new desired position in the list of sections.

Removing

To remove a column click the 'X' button in the top right corner of section widget.

Subsections

Subsections provide additional logical grouping of stations within a larger Section.

Additionally stations added to Subsections define the rows of the viewable report.

Continuing to use the DamRiverWeather report as an example the 'Dams' Section could be broken down into regional subsections 'East', 'West', 'North', 'South'

Each subsection has its own list of stations to include, but shares column definitions with all other Subsections in the Section.

Each subsection has a header and list of stations, which are configured in a draggable widget.

Adding

To add a new subsection to the Section click the '+' button in the 'Subsections' header. This will append a new subsection definition to the list of existing subsections.

Fields

Subsections have two fields. Header and a list of stations.

    • Header - the name of the subsection, appears at the top each subsection
    • Station- a list of one or more stations
      • Each entry in this list is a dragable element that allows reordering selected stations
      • The order of stations in this list is the order that will appear in the viewable report.
      • Adding a station - click the '+' button next to the Header field, this will append a new station entry to the list
      • Selecting a station - each entry in the subsection is a searchable drop-down list of available stations
      • removing - click the 'X' button to the right of the station name

Reordering

Subsections can be reordered by dragging the widget into the desired position in the list of the Section configuration

Removing

To remove click the 'X' button to the right of the Header field.

Columns

Determine which parameters are included in report.

Shared across all related Subsections.

Columns define the data values that are shown in the reports.

Each column in the viewable report is represented here as a configuration widget.

The order of the configuration widgets in the Create/Modify view is the order that those columns will appear in the viewable report.

Adding

To add a new column to the Section click the '+' button under the 'Section Columns' header. This will append a new column definition to the list of existing columns.

Fields

Column definitions have four fields. Title, Unit, Precision,Filter/Order definition.

    • Title - The title of the column. Appears in the header row of the section. Often but not necessarily the parameter name. 
    • Unit - The expected unit of the column parameter, (Ex: ft,m,m/s). Appears in the header row after the title in parenthesis. 
    • Precision - Integer, the maximum number of decimal places to display for this column.
    • Filter/Order - Defines the query to select data for this column.
      • Clicking on the textbox containing JSON will open a dialogue box to assist in defining the filters and orders.
      • NOTE - if you do not click submit in this dialogue box no changes will be saved to the column definition's filter/orders
      • Has two components, Filter and Order. Defined by one or more of each
        • Filter - which patterns of path names can be included in the column data set. Components; Type, Value, Case Sensitive
          • Type - either 'startswith','endswith',or 'contains'.
            • startswith - all included paths must begin with the Value field of this filter
            • endswith - all included paths must end with the Value field of this filter
            • contains - all included paths must contain the Value field of this filter at any point.
          • Value - value used in conjunction with Type to filter paths. Has keywords that can be used to enhance value string.
            • <site_name> - when report is viewed the site name for the row will replace this portion of the filter value
          • Case Sensitive - Binary, is this filter value case sensitive?
        • Order - defines the prioritization of paths as they are used for the 'best' line (paths that meet the first order will be use before paths that meet the second order and so on) . Components; Type, Value, Case Sensitive
          • Type - either 'startswith','endswith',or 'contains'.
            • startswith - all included paths must begin with the Value field of this filter
            • endswith - all included paths must end with the Value field of this filter
            • contains - all included paths must contain the Value field of this filter at any point.
          • Value - value used in conjunction with Type to filter paths. Has keywords that can be used to enhance value string.
            • <site_name> - when report is viewed the site name for the row will replace this portion of the filter value
          • Case Sensitive - Binary, is this filter value case sensitive?
      • Like most elements in the report configuration, Filters and Orders can be resorted by dragging and dropping the item into its new position in the list.

Copying

Any column and its definitions can be duplicated by clicked the 'copy' button in the top right of the column element. This will insert a copied version of that column immediatley after it in the list of columns


Reordering 

Columns within a section can be reordered by dragging and dropping a column into its new desired position in the list.

Removing

To remove a column click the 'X' button in the top right corner of the column's widget. Columns later in the list will be moved forward replace the removed column.