Report Types Described
VTScada provides a variety of predefined report types, which you can use to analyze the performance of the equipment comprising your physical system. Your application might also have been created with additional, customized report types.
Use the Report Type drop-down list at the top of the Report page to select one of the options listed here. After you choose a report type, the filters in section (2) of the Report page will automatically adjust to display only the type of tags that can be included in the selected report type.
An Analog Summary Report displays the average, minimum, maximum, and total values for a set of selected analog tags within a configured time period.
When using this report to summarize flow data, set the Application Property, AnalogSummaryReportTimeUnits to the time unit used to measure the flow. If flow is measured in units per second, the property must be set to 1. If flow is measured in units per minute, the property must be set to 60.
When this report is selected, the tag list will be filtered to include only Analogs.
The Analog Summary Report includes the following information:
- The station number associated with each tag in the selected set.
- The description configured for each tag in the selected set.
- The I/O address for each tag in the selected set.
- The average of the tag's data within the duration set for the report.
- The minimum tag data reading within the duration set for the report.
- The maximum tag data reading within the duration set for the report.
- The total tag data reading within the duration set for the report.
A daily snapshot report displays a "snapshot" of the value of each included tag, at the time you specify, on the dates you select.
When a daily snapshot report is generated, it contains a report header that identifies the report as a daily snapshot report, and indicates the duration or time period you configured for the report. For example, if at 2:00 pm you select a series of tags, set the time period to Last Week, and run the report, the daily snapshot report will display the value of each tag at 2:00 pm for the last 7 days.
The daily snapshot report will include:
- The date at which the data for each tag was read
- The time at which the data for each tag was read
- The subsequent columns provide a snapshot of the value for the tags you selected for inclusion in this report at the corresponding date and time
For example:
A daily total report displays the sum of the values accumulated for each member of a selected set of tags each day within the time period you specify. The key word is "accumulate". Do not use with analogs that measure fluctuating values such as flow rates or levels. A better choice is a counter that increments whenever an event occurs such as a pump start or rain-gauge tip.
If the count restarts or rolls over each time a maximum value is reached (the bucket is filled and then empties to fill again) the total will be the number of rollovers times the maximum value, plus the difference between the last value recorded and the first value recorded.
The report has no way to specify that maximum or rollover value, therefore it is essential that it be configured correctly in all the tags included in the report. Typically, the report uses the tag's ScaledMax parameter as the rollover value. However, if it is an IO tag, the Display Range Max is used if it is valid, defaulting to ScaledMax otherwise. If it is an Analog Status tag, the High Scale Value is used if it is valid, defaulting to ScaledMax. Note that an IO tag in Calculation mode always has an invalid ScaledMax, so Display Range Max must be set.
The report header identifies this as a daily report and includes the duration or time period of the report. Information included in the report includes:
- The date on which the data for each tag was read
- The time at which the data for each tag was read
- The subsequent columns display the total data accumulated for each tag you selected for inclusion in this report at the corresponding date and time
A Derived Flow Report displays the number of cycles for a driver, along with the inflow, outflow, and total flow for the station.
For this report, the tag selection area will be filtered to include drivers. The report must be run on a Polling Driver or Data Flow RTU, with at least one Pump Status tag. Tied to the Polling Driver, there must be an Analog Status with a description of "Well Volume" measured in gallons, that the well pumps in each cycle. This is usually the volume between the lead and stop float switches. This data must be entered in the manual data field of the Analog Status tag.
- Information in the Derived Flow Report includes:
- The station number associated with each VTScada driver tag.
- The description configured for each VTScada driver tag.
- The number of cycles for each VTScada driver tag.
- The inflow for each station.
- The outflow for each station.
- The total flow for each station.
The Derived Flow report requires a measurement of the volume of the station (i.e. the total volume (in gallons) that the well pumps in each cycle.
A Detail Report shows the values recorded for each selected tag, within the given time period.
For this report, the tag selection area will be filtered for the type, Loggers.
The Detail Report includes the following information:
- A date and time stamp for each tag's data.
- The name of each tag.
- The value of each tag.
- The description of each tag.
A driver communication error detail report shows driver error activity, recorded over a specified time period.
Information included in this report includes:
- The date at which the error was read.
- The time at which the error was read.
- The % quality of data for each driver within the specified time period.
- The delta success for each driver within the specified time period.
- Any error values for each driver within the specified time period.
- Any error messages for each driver within the specified time period.
Note that this report does not allow you to select multiple time periods.
If you select multiple tags, the report for each will be saved to a separate sheet if Excel is used for the output format.
Further information about these values is included elsewhere in this guide,
A driver communication summary report provides a history of driver activity for a specified time period.
For this report, the Types drop-down list filters to display Drivers.
This report includes three groups of information:
- Driver quality information
- The % minimum quality of data for each driver within the specified time period.
- The % maximum quality of data for each driver within the specified time period.
- The % start quality of data for each driver within the specified time period.
- The % end quality of data for each driver within the specified time period.
- The tag name for each driver tag included in the report.
Quality is calculated based on a weighted time interval. Communications closer to the present have more importance than those further in the past. The quality is a running analog value that can be trended on the historical data viewer. Sudden dips in the graph indicate periods where problems occurred. By comparing the % start quality to the % end quality for a given time frame, you can determine whether events that occurred during that time improved or damaged communication quality.
- Communication timing information.
These three values provide an indication of communications lag time and can be used to identify bandwidth issues that may be present.- The average Response time (i.e. the time between successive messages) for each driver within the specified time period.
- The minimum Response time for each driver within the specified time period.
- The maximum Response time for each driver within the specified time period.
- Communication count information.
These four values are actual counts recorded during the time frame. Unlike the quality information, these values ignore communications that occurred before the time frame.- The number of failed data transmissions for each driver within the specified time period.
- The number of failed reattempts at data transmissions for each driver within the specified time period.
- The number of successful attempts at data transmissions for each driver within the specified time period.
- The % success for each driver within the specified time period. This is calculated as: (success counts) / (failed counts + success counts). The counts begin at the start of the given time frame, thus this value can be useful for hour to hour or day to day comparisons.
Note: The Delta time is typically used to determine how fast data is being transferred for drivers that request data at regular intervals.
An hourly snapshot report displays a "snapshot" of the value of each included tag, repeated every 60 minutes within the time period you specify.
Information included in the report is as follows:
- The date at which the data for each tag was read
- The time at which the data for each tag was read
- The subsequent columns indicate a "snapshot" of the value for the tags you selected for inclusion in this report at the corresponding date and time
For example:
An hourly total report displays the sum of the values accumulated for each member of a selected set of tags each hour within the time period you specify. The key word is "accumulate". Do not use with analogs that measure fluctuating values such as flow rates or levels. A better choice is a counter that increments whenever an event occurs such as a pump start or rain-gauge tip.
If the count restarts or rolls over each time a maximum value is reached (the bucket is filled and then empties to fill again) the total will be the number of rollovers times the maximum value, plus the difference between the last value recorded and the first value recorded.
The report has no way to specify that maximum or rollover value, therefore it is essential that it be configured correctly in all the tags included in the report. Typically, the report uses the tag's ScaledMax parameter as the rollover value. However, if it is an IO tag, the Display Range Max is used if it is valid, defaulting to ScaledMax otherwise. If it is an Analog Status tag, the High Scale Value is used if it is valid, defaulting to ScaledMax. Note that an IO tag in Calculation mode always has an invalid ScaledMax, so Display Range Max must be set.
The report header identifies this as an hourly report and includes the duration or time period of the report. Information included in the report includes:
- The date on which the data for each tag was read
- The time at which the data for each tag was read
- The subsequent columns display the total data accumulated for each tag you selected for inclusion in this report at the corresponding date and time
An overall total report displays the sum of the values accumulated for each member of a selected set of tags within the full time period you specify. The key word is "accumulate". Do not use with analogs that measure fluctuating values such as flow rates or levels. A better choice is a counter that increments whenever an event occurs such as a pump start or rain-gauge tip.
If the count restarts or rolls over each time a maximum value is reached (the bucket is filled and then empties to fill again) the total will be the number of rollovers times the maximum value, plus the difference between the last value recorded and the first value recorded.
The report has no way to specify that maximum or rollover value, therefore it is essential that it be configured correctly in all the tags included in the report. Typically, the report uses the tag's ScaledMax parameter as the rollover value. However, if it is an IO tag, the Display Range Max is used if it is valid, defaulting to ScaledMax otherwise. If it is an Analog Status tag, the High Scale Value is used if it is valid, defaulting to ScaledMax. Note that an IO tag in Calculation mode always has an invalid ScaledMax, so Display Range Max must be set.
The report header identifies this as an overall total report and includes the duration or time period of the report. Information included in the report includes:
- The date on which the data for each tag was read
- The time at which the data for each tag was read
- The subsequent columns display the total data accumulated for each tag you selected for inclusion in this report at the corresponding date and time
The Pump Activity Report displays summarized values for the Pump Status tags in your application, enabling you to determine overall pump activity.
When you select Pump Activity Report, the list of tags available will include only the Pump Status tags in your application.
Information included in the Pump Activity Report includes:
The station to which the pump belongs.
- A description of the pump.
- The number of times the pump started for the duration set for the report.
- The average time the pump ran within the duration set for the report.
- The total time the pump ran within the duration set for the report.
The Pump Discrepancy Report is designed to help you spot instances of pumps that should be identical in behavior, but are not. This report shows only the pumps that have a 20% or greater difference in running time or have more than 1 start count difference.
When this report is chosen, the Types drop-down list is filtered to include only Pump Status tags.
Information included in the Pump Discrepancy Report:
- The station to which the pump belongs.
- A description of the pump.
- The number of times the pump started for the duration set for the report.
- The average time the pump ran within the duration set for the report.
- The total time the pump ran within the duration set for the report.
The Rainfall Report provides a per-tag summary of totals within the time period configured for the report, enabling you to determine the total rainfall for selected tags in a given period.
The most common configuration is to use a Data Flow Pulse Input tag where each pulse recorded from the rainfall measuring equipment signifies a predefined depth measurement.
A Rainfall Report includes:
The station number associated with each tag.
The description given each tag.
The total rainfall for each tag.
A standard report shows all the values logged for a tag over a chosen time span.
When using this report, it is important to choose only one tag at a time. The reason has to do with the difference between how the information is stored (a database) and how the report presents it (a spreadsheet format). For example, given two tags, A and B: values will always be logged a few milliseconds apart. The report will include a row for each unique timestamp found. However, it will not leave the column for tag A blank when showing the value logged for tag B and vice-versa. When displaying the value logged for tag A, the last value known for tag B will also be included at that timestamp. When displaying the value logged for tag B, the last value known for tag A will be included at that timestamp. For any given tag, it can be very difficult to separate the actual logged values from the carry-over to the other tag's row.
You avoid this problem by running the standard report for only one tag at a time.
Included information:
- The date on which the value for each tag was read.
- The time at which the value for each tag was read.
- The raw timestamp for when the tag was read.
- The value logged.
Report Formats and Destinations - Output options.