Product Definitions / Reports

Warning

Report functionality is still under development. Specifically, the following report types have not been implemented:

• point columns
• interval columns
• point rows
• interval rows

Introduction

Clicking on the Product Definitions / Reports menu displays the Reports List page. A new NovaStar system will display an empty Reports List.

NovaStar defines reports as collections of point data and analysis options that are defined and formatted so that specific data sets can be produced conveniently and potentially automatically by the system. NovaStar can create four types of reports:

Report Type	Description	Sample Image
Points in Columns	Displays columns of point data report analyses for multiple rows of fixed time intervals.	See full-size image
Intervals in Columns	Displays rows of point data report analyses for multiple columns of fixed time intervals.	See full-size image
Points in Rows	Displays multiple rows of points. The report columns will display point database information and data report analysis values. The database information, data report analyses, and time intervals are programmable.	See full-size image
Intervals in Rows	Displays columns of point data report analyses for multiple rows of programmable time intervals and time offsets.	See full-size image

Report List

The following image illustrates the Report List page after a report has been selected in the list at the top of the page.

Report List (see full-size image)

Navigation, Adding, Deleting, Modifying, and Copying Reports

The Report List page conforms to a layout similar to many NovaStar data types which includes a list of data items. See List Features and Application Functionality for more information detailing page navigation; adding, copying and deleting reports; and modifying existing reports.

Adding a New Report

Clicking the Add button above the Report List on this page allows users to create a new report by entering, at a minimum, a unique report Number and Name. To complete report creation, click the Apply button to create the new report.

Identification

The following report properties are used to identify the report.

Report Identification (see full-size image)

Data Label	Description
Number	Report number must be unique for each plot. Report numbering does not have to be sequential.After clicking Add, the next available report number will be automatically assigned.
Name	Report name must be unique for each report and should describe the report information displayed, including the data analysis options that have been selected for the report points. Max: 100 characters.
Description	This descriptive field does not display on report data display pages. Use it to describe the report functionality. Max: 1000 characters.
Title	Report the title that will appear at the top of the report. Max: 1000 characters.
Parameter	Append selected display parameter key words to the title text. These key words are replaced by the report display request parameters. Report number: _REPORTNUMBER Report name: _REPORTNAME Ending date: _ENDINGDATE Ending time: _ENDINGTIME Ending time of day: _ENDINGTIMEOFDAY Starting date: _STARTINGDATE Starting time: _STARTINGTIME Starting time of day: _STARTINGTIMEOFDAY Display interval: _DISPLAYINTERVAL Data analysis: _DATAANALYSIS An example with the following title: Antelope-Clover Valley Watershed Rainfall<br>ending _ENDINGTIME will display the following text on the report data display title: Antelope-Clover Valley Watershed Rainfall<br>ending 11/30/2010 08:00:00

Owner

The owner section defines the owner of the report and the display scope: private or public. Private scope only displays this report for the owner, the owner group supervisors, and administrators. Public scope display this report for all group members and administrators.

Owner (see full-size image)

Data Label	Description
User	Owner of the report. Click the user icon to assign the current user.
Scope	Public or private.

User Groups

The User groups table shows the user groups currently assigned to the report. For more information, see the User Groups documentation.

User Groups Assigned (see full-size image)

Options

Several report options are available.

Report Options (see full-size image)

Data Label	Description
Type	Select the report display type: Points in Columns: displays columns of point data report analyses for multiple rows of fixed time intervals. Intervals in Columns: displays rows of point data report analyses for multiple columns of fixed time intervals. Points in Rows: displays multiple rows of points. The report columns display point database information and data report analysis values. The database information, data report analyses, and time intervals are programmable. Intervals in Rows: displays columns of point data report analyses for multiple rows of programmable time intervals and time offsets. Reportgen: displays results of reportgen display program. Hourly Precipitation for Month: displays hourly precipitation for month report. Daily Precipitation for Year: displays daily precipitation for year report.
Report style	Report headings, titles, and data lists are drawn with the default styles for the NovaStar5 server. Select a custom report style from Report style list. The style files are Cascading Style Sheets and are stored in the folder: /tomcat/local/styles.
Report class	Select a class from the report style sheet to define the report data list display style. The default style is reportdata.
Point label	Select type of point information display in column header for points in columns.
Time format	Select format for time displayed in columns or rows. Click Reset for default.
Show totals	Select true to display column totals at bottom of report for points in columns. Default is false.
Show units	Select true to display units in report column headers. Default is false.
Show column header	Select true to display column headers, false for no header, default is true.
Time anchor	Select the data request time to use for computing report intervals: Starting Time or Ending Time.
Sort by	Select column number for sort on first display. Default is none.
Asc	Sort direction: asc for ascending des for descending
Orientation	Multiple panel orientation: horizontal or vertical (Default is vertical).

Report Panel List

The Panel List shown on the Report List page shows all the report panel records assigned to the report being edited. Report panels define the report title, and class. When a report is first defined, no report panel records are assigned to the report. At least one report panel must be created.

Report Panel List (see full-size image)

Report List Panel Popup

To add a new panel, click the Add button above the Panel List table. To edit an existing panel, click the pencil icon. Both these actions result in the following popup.

Report List Panel Popup (see full-size image)

The following panel characteristics, which are organized on multiple tabs, can be edited.

Data Label	Description
Panel	Panel number, starting at 1.
Title	Plot panel title. The title is centered at the top of the plot image.
Class	Select a class from the report style sheet to define the report panel text display style. The default style is report.
Parameter	Append selected display parameter key words to the title text. These key words are replaced by the report display request parameters. Report number: _REPORTNUMBER Report name: _REPORTNAME Ending date: _ENDINGDATE Ending time: _ENDINGTIME Ending time of day: _ENDINGTIMEOFDAY Starting date: _STARTINGDATE Starting time: _STARTINGTIME Starting time of day: _STARTINGTIMEOFDAY Display interval: _DISPLAYINTERVAL See the Modified picklist documentation for information on using the built-in parameter selector.

Report Column List

The Column List is shown on the Report List page when the report type is Points in Rows. It shows the report columns currently assigned to the report being edited. Report columns defined the report column labels, type of information, and data analysis. When a report is first defined, no report column records are assigned to the report.

Report Column List (see full-size image)

Report List Column Popup

To add a new column, click the Add button above the Column List table. To edit an existing column, click the pencil icon. Both these actions result in the following popup.

Report List Column Popup (see full-size image)

The following column characteristics, which are organized on multiple tabs, can be edited.

Data Label	Description
Panel	Panel number.
Label	Enter the column header label. Max: 100 characters.
Parameter	Append selected display parameter key words to the title text. These key words are replaced by the report display request parameters. Report number: _REPORTNUMBER Report name: _REPORTNAME Ending date: _ENDINGDATE Ending time: _ENDINGTIME Ending time of day: _ENDINGTIMEOFDAY Starting date: _STARTINGDATE Starting time: _STARTINGTIME Starting time of day: _STARTINGTIMEOFDAY Display interval: _DISPLAYINTERVAL
Type	Select the column type: Point, Data or Text. This selection affects the shown below.
Point type	Select the type of point information shown in the column: Station row Station table row number Station ID: Station numeric ID Station name: Station name Station tag: Station tag name Station type: Station type name Point row: Point table row number Point ID: Point numeric ID Point name: Point name Point tag: Point tag name Point label: Point label from report point list Point type: Point type name Remote ID: Point remote numeric ID
Data type	Select the type of data report information shown in the column: Data value units: Data report value with units Data value: Data report value Data time: Data report time Data flags: Data report flags Data score: Data report nova score Period time: Data report interval time
Text type	Select the type of text information shown in the column: Text: Display test
Analysis	Select the data analysis for the point readout. See the data analysis appendix for a description of the analysis types. Use default analysis will do the report data request analysis selected. Any other analysis type selected will override the report data request analysis.
Analysis Interval	The Storm Rainfall and Rainfall Intensity data analysis require an analysis interval. See the data analysis appendix for a description of the analysis interval use for these analysis types.
Data type	Select the type of data displayed: Scaled: Scaled or analysis value Raw: Raw data value Score: Nova score value Rating1-Rating5: Rating value 1 - 5
Display Interval	Select the time interval for the data analysis. The time interval is used to compute the start time for the data analysis from the end time. Click the button to alternate between interval selection from a pick list or from time interval fields. Use Request Interval and Show Data Reports will use the report data request display interval if selected or 1 day by default.
Time Offset	Select the time offset from the report data request end time for the data analysis period, default if 0.0 seconds. A positive time offset starts in the future (After), a negative time offset starts in the past (Before). Click the Time Offset: button to select from a list of intervals. The time offset direction is selected from the After/Before list. Click the button again to use the time offset fields.
Multiplier	Multiply the data analysis computed value by this constant.
Adder	Add this constant to the data analysis computed value.
Link type	Type of link for column data.
Link help	Link tooltip help.

Report Interval List

The Interval List is shown on the Report List page when the report type is Interval in Rows. It shows all the report rows currently assigned to the report being edited. Report rows defined the report row labels, type of information, and data analysis. When a report is first defined, no report row records are assigned to the report.

Plot List Interval Popup

To add a new interval, click the Add button above the Interval List table. To edit an existing interval, click the pencil icon. Both these actions result in the following popup.

Report List Interval Popup (see full-size image)

The following interval characteristics, which are organized on multiple tabs, can be edited.

Data Label	Description
Panel	Panel number.
Time Interval	Select the time interval for the data analysis. The time interval is used to compute the start time for the data analysis from the start or end time based on the report Interval from field. Use Request Interval and Show Data Reports will use the report data request display interval if selected or 1 day by default.
Time Offset	Select the time offset from the report data request end time for the data analysis period, default if 0.0 seconds. A positive time offset starts in the future (After), a negative time offset starts in the past (Before). The time offset direction is selected from the After/Before list.

Report Point List

The Point List displays the Report point records assigned to the Report being edited. Report points define the point data analysis and report display options. When a report is first defined, no report point records are assigned to the report.

Report Point List (see full-size image)

Report List Point Popup

To add a new point, click the Add button above the Point List table.

Report List Point Popup (see full-size image)

To edit an existing point, click the pencil icon.

Report List Point Popup (see full-size image)

The following point characteristics, which are organized on multiple tabs, can be edited.

Data Label	Description
General
Panel	Select panel number.
Point(when adding)	Select points to add to the point list from the pick list. Hold down the [Ctrl] key and click to select multiple points. Hold down the [Shift] key and click to select points from last selected to current selection.
Point(when editing)	Select point to include in the point list from the dropdown list.
Override	Select true to use thisreport definition as a template, allowing points to be selected during the plot request. Select false so all points seelected in the definition are used in the report.
Label	Label displayed on tooltip (leave blank for automatic labeling)
Analysis
Statistic	Select the data analysis for the point readout. See the data analysis appendix for a description of the analysis types. Use default analysis will perform the report data request analysis selected. Any other analysis type selected will override the report data request analysis.
Data type	Select the type of data displayed: Scaled: Scaled or analysis value Raw: Raw data value Score: Nova score value Rating1-Rating5: Rating value 1 - 5
Display Interval	Select the time interval for the data analysis. The time interval is used to compute the start time for the data analysis from the end time. Use Request Interval and Show Data Reports will use the report data request display interval if selected or 1 day by default.
Time Offset	Select the time offset from the report data request end time for the data analysis period, default if 0.0 seconds. A positive time offset starts in the future (After), a negative time offset starts in the past (Before). The time offset direction is selected from the After/Before list.
Multiplier	Multiply the data analysis computed value by this constant.
Adder	Add this constant to the data analysis computed value.
Display
Data class	Select a class from the report style sheet to define the report data list display style. The default style is reportdata.
Indicate novascore	Select true to change the data class displayed for the data analysis score value. The score value (1-5, 0 for missing) is appended to the data class name. For example if the data class name is reportdata then a score of 1 will use the class reportdata1, a score of 2 will use the class reportdata2, and so on. Missing data will use the class reportdata0. This feature is false by default. /* report readout background colors for scores */ td.reportdata0 {color:#888888;background- color:#ffffff;} td.reportdata, td.reportdata1 {background-color:#ffffff;} /* white */ td.reportdata2 {background-color:#ffff44;} /* yellow */ td.reportdata3 {background-color:#ffaa44;} /* orange */ td.reportdata4 {background-color:#ff8866;} /* pink */ td.reportdata5 {background-color:#ff4444;} /* red */
Digit precision	Set the number of decimal digits to display to the right of the decimal point. Select default to use the number of display digits assigned to the point type.

Reportgen File List

Reportgen uses a template, interval list, and point list. These can be defined either in the Novastar database or using a reportgen configuration file. When clicking Apply, these components are saved to the database. However, these lists can be uploaded and imported using this interface.

When the selected report type is reportgen, the template, interval list, and point list are displayed.

If a configuration file exists which defines the reportgen template, interval list, and point list, set Define reportgen report using files to true and select a file from the Reportgen config file dropdown. A file from the local system can be added to this dropdown by clicking the Upload button and selecting the file. Click Import to read the point, time, and template file names from a report file.

Reportgen (see full-size image)

After selecting a configuration file, the files listed will automatically popuplate the dropdowns in the Define reportgen report using files only.

Reportgen files (see full-size image)

The Point file dropdown above the Point list contains files found in the /tomcat/local/rpt/lst directory. Additional files from the client system are added by clicking the Upload button. Once a file is selected, click the Import button to add points to the Point list.