SurvalentONE

DB-405
SCADA REPORT DATABASE
EDITING GUIDE

Version 1.7
 DB-405 Report Database Editing Guide

Copyright, Notices and Trademarks

Copyright © Survalent Technology Corporation. All rights reserved. The
software described in this document is furnished under license and can
only be used or copied in accordance with the terms of such license. The
content of this manual has been carefully checked for accuracy.
However, if you find any errors, please notify the Survalent Technology
Corporation.

Survalent Technology Corporation

7965 Heritage Road
Brampton, Ontario L6Y 5X5

(905) 826 5000

(905) 826 7144

[email protected]

www.survalent.com
FAX (905) 826-7144

The software described in this document is furnished under

license and may only be used or copied in accordance with the
terms of such license.

About This Publication

This manual describes how to configure the SCADA Report database.

It is assumed that you have some background knowledge about SCADA systems.
 DB-405 Report Database Editing Guide

Revisions

Version Description
1.0 Initial version.
Updated figures, added more detail and examples in Generic Reports.
1.2
Added Operation Reports, Outage Reports, and Historical Data Reports.
Updated figures. Added Event reports, Tag reports, Operation Log reports and
1.3 Worldview reports. Added XML and XLS output file formats, and e-mail and FTP
server destinations.
1.4 Added details of data formats available in Generic reports.
Updated document with new screens and functionality.
1.5
Document reviewed by Ilija Mitrov.

1.6 Added new logo and cover.

1.7 Added Historian Dataset.

SCADA Revisions
 DB-405 Report Database Editing Guide

Contents

1 Introduction 1-1

1.1 Other Documentation ...................................................................................................................... 1-2

2 Scheduling Reports 2-1

2.1 Introduction ..................................................................................................................................... 2-1

2.2 Reports Schedule Window .............................................................................................................. 2-2
2.3 Report Scheduler Data Fields—General ......................................................................................... 2-3

3 Generic Reports 3-1

3.1 Introduction ..................................................................................................................................... 3-1

3.2 Generic Report—General Tab ........................................................................................................ 3-3
3.3 Generic Report – Report Layout Tab .............................................................................................. 3-5
3.3.1 Format Windows ......................................................................................................................... 3-6
3.3.2 Commonly Used Database Table and Field Names .................................................................. 3-10
3.4 Generic Report – Selection Criteria Tab ....................................................................................... 3-11
3.5 Order & Group .............................................................................................................................. 3-12
3.6 Previewing a Report ...................................................................................................................... 3-13
3.7 Printing an Ad Hoc Report............................................................................................................ 3-14
3.8 Report Examples ........................................................................................................................... 3-14
3.8.1 Analog Point List....................................................................................................................... 3-14
3.8.2 Report Preview .......................................................................................................................... 3-17

SCADA Contents i
 DB-405 Report Database Editing Guide

4 Operations Reports 4-18

4.1 Introduction ................................................................................................................................... 4-19

4.2 Editing an Operation Report ......................................................................................................... 4-20
4.3 The Operation Report.................................................................................................................... 4-21
4.3.1 Report Breakdown ..................................................................................................................... 4-21
4.3.2 Status ......................................................................................................................................... 4-22

5 Outage Reports 5-1

5.1 Introduction ..................................................................................................................................... 5-2

5.2 Editing an Outage Report ................................................................................................................ 5-3
5.3 The Outage Report .......................................................................................................................... 5-4

6 Historical Data Reports 6-1

6.1 Introduction ..................................................................................................................................... 6-2

6.2 Editing a Historical Data Report ..................................................................................................... 6-3
6.2.1 Historian Dataset ......................................................................................................................... 6-4
6.3 The Historical Data Report ............................................................................................................. 6-5

7 Event Reports 7-1

7.1 Introduction ..................................................................................................................................... 7-2

7.2 Editing an Event Report .................................................................................................................. 7-3
7.3 The Event Report ............................................................................................................................ 7-5

8 Tag Reports 8-1

8.1 Introduction ..................................................................................................................................... 8-2

8.2 Editing a Tag Report ....................................................................................................................... 8-3
8.3 The Tags Report .............................................................................................................................. 8-5

9 Operation Log Reports 9-1

9.1 Introduction ..................................................................................................................................... 9-2

9.2 Editing an Operation Log Report .................................................................................................... 9-3
9.3 The Operation Log Report .............................................................................................................. 9-5

10 Worldview Reports 10-1

10.1 Editing a Worldview Map Report ............................................................................................. 10-2

SCADA Contents ii
 DB-405 Report Database Editing Guide

1 Introduction

This document describes how to configure your Windows SCADA system Report Database to define and
schedule your reports.

Chapter 2 describes the Report Scheduler. This is where you define the times and frequencies for
automatically generating your reports. Scheduled reports can be directed to any properly installed
Windows printer accessible to the SCADA hosts.

Using the STC Explorer, you can define several different basic types of reports:
• Generic Reports
• Operation Reports
• Outage Reports
• Historical Data Reports
• Event Reports
• Tag Reports
• Operation Log Reports
• Worldview Map Reports

SCADA Introduction 1-1

 DB-405 Report Database Editing Guide

Chapter 3 describes generic reports. These reports are tabular reports with user-selected data items and
user-specified layout. They may be used to extract data from any file in the database.

The other types of reports produce specialized information about specific system features. Each has a
limited capability for customization.

Chapter 4 describes the Operation reports.

Chapter 5 describes the Outage Reports. Both of these reports are specific to the Operations and Outage
Accounting program.

NOTE: This program is an option and is not included in the baseline SCADA license. A separate license
is applicable for the Operations and Outage Accounting program.

Chapter 6 describes the Historical Data reports.

Chapter 7 describes Event reports which are built-in specialized reports that are part of the Event Data
Recording feature.

Chapter 8 describes Tag reports which are built-in specialized reports that show currently applied tags.

Chapter 9 describes Operation Log reports which are built-in specialized reports that shows list of
operations made within a specified time period.

1.1 Other Documentation

This editing guide is one of a family of database editing guides. The complete set is listed in Table 1.1-1.
You should refer to the Database Editing Overview for information regarding the STC Explorer, since this
document assumes you already know how to use it.

Table 1.1-1 Database Editing Guides

Document
Document Name
Number
DB-400 Database Editing Overview
DB-401 Point Database Editing Guide
DB-402 Alarm Database Editing Guide
DB-403 Automation Database Editing Guide
DB-404 Historical Database Editing Guide

SCADA Introduction 1-2

 DB-405 Report Database Editing Guide

2 Scheduling Reports

The report Schedule allows you to automatically generate any of the reports you have defined, at specific
times. The reports may be produced on any Windows printer known to your SCADA host.

2.1 Introduction
The Schedule function (found under the Reports branch in the STC Explorer) consists of a list of user-
defined report schedule items. Each item names a defined report and the printer that the report is to be
sent to. It also includes a definition of the scheduled time(s) to produce the report. The report-generating
program in the SCADA system looks at these schedule items, and determines when to generate the
reports.

A particular report can be identified in more than one Report Schedule item. This allows you to produce
different instances of the same report on different schedules. For example, you might produce one
instance of the report at each shift change on the printer in the control room. A second instance of the
same report might also be generated on a printer in another office, but only once each day.

SCADA Scheduling Reports 2-1

 DB-405 Report Database Editing Guide

2.2 Reports Schedule Window

The Report Scheduler is found under the Reports branch in the STC Explorer tree.

Note: Report Schedules do not make use of the Schedules found under the System branch of the STC
Explorer.

Figure 2.2-1 Report Tree Window

Defining a Report Schedule

You can right-click on one of the existing schedule items to edit it, or choose New to create a new one.
You will see a Report Scheduler dialog, as shown in Figure 2.3-1.

SCADA Scheduling Reports 2-2

 DB-405 Report Database Editing Guide

2.3 Report Scheduler Data Fields—General

. The fields in the General tab of the Report Scheduler dialog are described below.

Figure 2.3-2 Report Scheduler Dialog

Table 2.3-1 Report Scheduler Data Fields Descriptions—General

Field/Button Description
This checkbox allows you to enable or disable this schedule. Disabling the
schedule does not disable the report itself (the report can still be requested
Enabled
manually). It also does not disable any other schedules that may be defined
for the same report.
This field contains the name of this specific schedule element. Give it a name
Name
that will remind you of what this scheduled report is for.
This is a text description of this schedule item, to help you identify it. You can
Description
use it, for example, to explain the purpose of this scheduled report.
This field contains the name of the report that this report schedule item is to
produce. Select the report from a drop-down list of the reports you have
Report Name
previously defined. Information on creating the different reports is found in the
chapters that follow.
This menu allow you to select the type of report output. You may choose from
one of the following:
• Printer - the report is to be printed
• File - the report is to be saved as a file
Report Type • E-mail - the report is to be sent by e-mail
• FTP - the report is to be sent to an FTP site

Depending on your choice, the rest of this section of the editor will vary in its
appearance to give you appropriate choices for other destination parameters.
Table 2.3-1 Report Scheduler Data Fields Descriptions—General continued

SCADA Scheduling Reports 2-3

 DB-405 Report Database Editing Guide

Field/Button Description
Destination Printer
For printer destinations, this drop-down list allows you to choose any of the
printers known to the system. These are the same printers that are installed
under Windows on your system. They may be connected directly to the
computer, or accessible via the network.

These are typically not the same printers as the ones that are defined in the
System branch of STC Explorer. Those are event loggers, rather than report
printers. The printers that you want to use for reports are the ones you see in
the Windows Control Panel.

Note: If you are editing on a workstation, you will see the Windows printers
installed on your workstation on the drop-down list. Take care to choose a
printer that is also installed under Windows on the SCADA host (you should
check the Windows Control Panel on the host to make sure). If you select a
printer known only to your workstation, the report will not be able to print when it
is generated by the SCADA host.

e-mail
For e-mail destinations, this drop-down list allows you to choose one of the
SMTP servers defined in the System->Internet->SMTP Servers branch of the
SCADA Explorer. See the SM400 System Manager’s Guide for details on
defining SMTP servers.

FTP
For FTP destinations, this drop-down list allows you to choose one of the FTP
servers defined in the System->Internet->FTP Servers branch of the SCADA
Explorer. See the SM400 System Manager’s Guide for details on defining FTP
servers.
Last Error The status (result) of the most recent printing of this report.
Last Print The time and date of the most recent printing of this report.

SCADA Scheduling Reports 2-4

 DB-405 Report Database Editing Guide

3 Generic Reports

This chapter describes the creation and modification of generic reports using the STC Explorer.

3.1 Introduction
The definition of a generic report describes a set of information you want to extract from the database,
usually for printing. The report is usually automatically printed on a schedule (as discussed in chapter 2).
You may preview your report in a window, or print it manually, as described in sections 3.6 and 3.7.

The content of the report is defined by specifying which table in the database you are interested in, and
which fields you want from that table. You can further qualify which records in the table will appear in the
report, in order to include only the desired items.

SCADA Operations Reports 3-1

 DB-405 Report Database Editing Guide

A generic report can be thought of as a list of records from the database. You can choose which
database table the data will be taken from, whether particular records will be included in the report or
discarded, and what data from the included records will appear on the list.

You can specify a header for each page, and a text caption for each data column in the list. Records
listed in the report can also be sorted or grouped in a variety of ways.

To define a report, navigate to the Reports branch in the STC Explorer and click on Generic. All the
generic reports display in the right window pane.

Figure 3.1-1 Generic Report Window

SCADA Operations Reports 3-2

 DB-405 Report Database Editing Guide

3.2 Generic Report—General Tab

To edit an existing report, right-click on it and select Edit from the drop-down menu. The Generic Report
dialog displays as shown in Figure 3.2-1.

To create a new report, select New from the drop-down menu. A blank Generic Report dialog displays

Note: Do not delete a report that is still referred to by a Report Schedule. Remove the schedule first.

Figure 3.2-1 Generic Report Dialog (General)

The dialog opens on the tab labeled General, whose fields are described below.

Table 3.2-1 Generic Report Data Fields Descriptions—General

Field/Button Description
Give your report a name that will suggest its purpose. Remember that the
Name definition of the report is separate from the schedule it has, so don’t just name it
for the time it is printed.

SCADA Operations Reports 3-3

 DB-405 Report Database Editing Guide

Table 3.2-1 Report Scheduler Data Fields Descriptions—General continued

Field/Button Description
This is a text description of the report. Type in any description, it is only seen in
the STC Explorer.
Description
You can leave this field blank, however, if you decide later to keep the report
definition, come back and add a suitable description.
This field selects one table in the SCADA database from which the report is to get
its data. Choose a table name from the drop-down list.

Since each table in the database is structured differently, this step determines
what you will see on the other pages of this editing dialog. Therefore, once you
make a selection here, and move to one of the other pages, you will not be
Table Name allowed to change the table selection for this report. If you have made an error in
choosing the table, you will have to delete this report, and create a new one.

In Table 3.3.2-1, you will find some examples of database tables that can be
reported, along with some of the data fields that would be of most interest for
reports. Although the list of fields in Table 3.3.2-1 is not complete, the drop-down
list in the report editor shows all fields for each table.
Here you specify the general text you want to see at the top of every page of your
report. You do not need to label each column of data at this point.
Header
Spaces and blank lines anywhere in the header are displayed just as you enter
them.
Select the orientation of the page for printing (portrait, or landscape). You may
choose <Default>, in which case the SCADA system will not set the orientation.
The printer will use its current default setting.
Orientation
Note: The Preview window (see 3.6) uses the settings of your default Windows
printer.
Header Choose the desired horizontal alignment for your header from the drop-down list
Alignment (left, right, or centered). All lines in the header will have the same alignment.
Export This button enables you to put the report out in different forms.
Preview This button allows you to see how the report displays.

SCADA Operations Reports 3-4

 DB-405 Report Database Editing Guide

3.3 Generic Report – Report Layout Tab

In the Report Layout tab, you specify which data items from the designated table (see section 3.2.1) are
to be included in the report.

Figure 3.3-1 Generic Report Dialog (Layout)

Table 3.3-1 Generic Report Data Fields Descriptions—Layout

Field Description
This column displays a list of all the data fields available in the table you
selected on the General tab. In the example, since the table “Tags” was
chosen on the General tab, the fields found in the Tags table appear in the
Source Fields list.
Table Fields
You include a field in the report by adding it to the Report list by dragging it to
the list. A field no longer wanted in the report can be removed from the list by
selecting it, right-clicking and selecting Delete.

SCADA Operations Reports 3-5

 DB-405 Report Database Editing Guide

Table 3.3-1 Generic Report Data Fields Descriptions—Layout continued

Field Description
The Report Columns list shows the desired data fields in the order that they will
be printed in the report (the top item in the list is printed first; therefore it
corresponds to the left-most column of the report when printed). If you want to
change this order, select the item to be moved, and drag up or down with your
Report Columns
mouse.

For each item in the Report Columns list, you will want to specify how it is
formatted. Go to section 3.3.1 Format Windows for more details.

3.3.1 Format Windows

You must define each column you have included in the Report Columns list to determine how it should be
displayed or printed. To access the format window, double-click on any column in the list. The Format
Window displays.

The top of the window displays common format choices and the bottom of the window displays additional
format choices depending on the columns data type.

The following table describes the common format choices on the window.

Table 3.3.1-1 Common Format Field Descriptions

Field Description
You should specify a caption (heading) for each data item. This is text to be
Caption
printed above this column, at the top of each page.

You should also specify the Width of each data item when it is printed. This can
be thought of as the width of the column in which the data will be printed. If the
data is too long for the space you allow, it will wrap around within this column.

This number is not the number of characters, nor the actual physical size. It
Width, inch
should be thought of as a proportion of the total width of the page.

You may need to experiment a little, but start with a small number (say 5) for
your narrowest column, and choose proportionately larger numbers for any wider
columns you may have.

You can check this box, if you would prefer to specify the actual column widths
Fixed Width
you want, in inches.
Lastly, you can select how the data will be justified within the column space.
Alignment Choose to have it aligned on the left or right boundary, or to be centered within
the column.

SCADA Operations Reports 3-6

 DB-405 Report Database Editing Guide

Data Type Formats

The following section describes the specific format choices associated with the data type.

Integer
For some integer values you will want to “decode” the value of the field, in order to display some more
meaningful quantity. For example, any field that contains an ID of a record in another table such as the
ZoneID field. This field refers to a record in the Zone Groups table.

Figure 3.3.1-1 Integer Format Window

Table 3.3.1-2 Integer Formats

Field Description
Display the data as a number. The width of the field, its caption and
Integer
the alignment of the field can be specified.
The data is treated as a point id and if that point exists, its complete
Full Point Name
Station Name, Point Name combination is displayed.
The data is treated as the RTU id, and if that RTU exists in the RTUS
Full RTU Name
table, its name is displayed.
The data is treated as an event type. (This format is only appropriate
Event Type for the event type field (named TYPE) in the event data field of the
EVENTS table.) The text of the specified event type is displayed.
The integer is treated as a status point's value. The field named in the
PID Field parameter is used to look up the status point to determine
Point State
its command/state strings. The value is then displayed using that
string.

SCADA Operations Reports 3-7

 DB-405 Report Database Editing Guide

Table 3.3-1 Integer Formats continued

Field Description
Certain data items that you include in the Report Columns list may refer to
information contained in other tables in the database. In our example, the field
TypeId is one such case. This numeric value refers to the Tag Type, but you
don’t really want to simply print out this number in your report; you would
probably rather print the name of that tag type.

This can be handled by the Table and Field lists. For any desired fields in your
report, you can use the number that would have been printed as a Primary Key,
or “ID number”, to select an item in a different database table (the Reference
Table). Then you can select any field (the Reference Field) from that item, and
display the contents of that field instead.
Reference Table
In our example, this can be used to print the name or description of the tag type,
instead of the ID number. In the Report Column list, double-click (or right-click
and choose edit) TypeId. In the Format list, choose <Ref Table>. Once you
select the TagTypes table, the Field list will display all the fields available in that
table. Choose the Name or the Description field to display that text instead of the
TypeId number. You will also want to format this field appropriately.

Note: The Reference Tables list is not a special list. It contains all the same
database tables as you find in the main Table drop-down list on the General
page.

Double
The field is a double-precision floating point number. The number of decimal digits for numbers less than
1 and greater than 1 can be entered separately, which allows for higher precision for small numbers.

Figure 3.3.1-2 Double Format Window

SCADA Operations Reports 3-8

 DB-405 Report Database Editing Guide

String
The field is a text string. The width (maximum number of characters displayed) and the alignment of the
text can be selected.

Figure 3.3.1-3 String Format Window

Date Time
The field contains a time and date expressed as hundreds of nanoseconds since Jan 1, 1601 (in UTC
time). The time can be converted to local time, taking the current time zone and daylight savings time into
account. Milliseconds can be included. The time and date format can be selected from several
alternatives.
Figure 3.3.1-4 DateTime Format Window

SCADA Operations Reports 3-9

 DB-405 Report Database Editing Guide

3.3.2 Commonly Used Database Table and Field Names

Table 3.3.2-1 contains the names of a few database tables most commonly used in reports. Think of each
table as one or more “rows” identified by a primary key number (in a field named Pkey). Each table holds
one type of database object, such as status points, or zone groups.

The PKey uniquely identifies each item in the table; it is usually the same ID number that you see in the
corresponding SCADA Explorer edit dialogs. Most files include fields called Name (containing the name
you gave to the item), and Desc (which contains the item’s descriptive text).

Table 3.3.2-1 Typical Database Tables for Reports

Table Name Field Name Description
AnalogPoints All of the analog points in the system
ZoneId Zone group number
UserTypeId User type number
StationPid ID number of station point belongs to
EngUnits Engineering Units (text)
EmgHi Alarm limit, emergency, upper
EmgLo Alarm limit, emergency, lower
PrEmgHi Alarm limit, pre-emergency, upper
PrEmgLo Alarm limit, pre-emergency, lower
UnrsHi Alarm limit, unreasonable, upper
UnrsLo Alarm limit, unreasonable, lower
RtuId ID number of RTU
AddrA Telemetry address A
AddrB Telemetry address B
AddrC Telemetry address C
AddrD Telemetry address D
UnackdAlrm Unacknowledged alarm flag
Value Value in engineering units
ScaleFact Scale factor
Offset Offset

StatusPoints All of the status points in the system

ZoneId Zone group number
UserTypeId User type number
RtuId ID number of RTU
InputA Telemetry address A
InputB Telemetry address B
InputC Telemetry address C
InputD Telemetry address D
AlarmSklID ID number of alarm message format
StationPid ID number of station point belongs to
TransCount Transition count
UnackdAlrm Unacknowledged alarm flag
Value Current value (state): 0, 1, 2, 3
NormState Normal value (state): 0,1
PrefSuffID ID number of Command/State string
FormatID Format Code

SCADA Operations Reports 3-10

 DB-405 Report Database Editing Guide

3.4 Generic Report – Selection Criteria Tab

The next tab in the Report dialog defines the selection criteria. This determines which records from the
specified table will be selected for inclusion in the report. Refer to Figure 3.4-1 for the discussion that
follows.

Figure 3.4-1 Generic Report Dialog (Selection Criteria)

Table 3.4-1 Generic Report Data Fields Descriptions—Selection Criteria

Field Description
Unless otherwise specified, all records in the selected table will be included in the
report output; each record in the table will produce a row of data in the report. But
you may instead only want to include certain records in the report.

To select them, you must add statements to the Where list to define the records you
want. Think of these qualifiers as statements in the form “include all records from
the table, Where fieldname is condition”. For example, you could select all analog
points “Where VALUE = 3.14” or to report all analogs whose present value was
exactly that.

Where You can add as many qualifier statements as you need to get the data you want.
You may treat the individual lines in the Where list as being connected by either an
AND and/or OR operation, by making a choice using the “drop-down menu”
buttons.

For example, if you choose only AND, only records satisfying all of the conditions
will be included in the report. If you choose OR, records matching at least one
condition will appear in the report.

In the example above, only records with an IEDID value of 96 will be included in the
report.
Where in Each line can be written as a simple SQL statement. As an example, both
SQL Format alternatives in Figure 3.4-1 will produce the same result.

SCADA Operations Reports 3-11

 DB-405 Report Database Editing Guide

3.5 Order & Group

You can have the output of the report sorted by the value in your choice of fields, up to 5. Simply select
the fields you want to sort by, in sequence.

Table 3.4-1 Generic Report Data Fields Descriptions—Selection Criteria

Field Description
You can have your list sorted by one or more of the fields in your report. In
Order By the example in above, the records are first sorted by ADDRA, then by ADDRB
and then by ADDRC.
If you have sorted the data, you might also like to have it grouped in your
report. One field can be designated for this grouping, such that all the records
that have the same value for this field will be set apart in a group. The group
can be printed with its own group header, and your captions (see section
3.3.1 Format Windows) will be reprinted under this group header.
Grouping By Field
Enter the name of the field to group by. Each time the data in this field takes
on a new value, a new group will be started. To produce a properly formatted
output, group by the same field as the first one listed under Order By BY.
Click on edit to set up the format of the output, as in section 3.3.1 Format
Windows.
This button enables you to set the format for the “Grouping By Field” field
Settings
according to its data type. See section 3.3.1 Format Windows.
Start Group from Check this box to cause each new group to begin on a new page in the report
new Page output.

SCADA Operations Reports 3-12

 DB-405 Report Database Editing Guide

3.6 Previewing a Report

When you have completed the definition or modification of your report, press OK to store it in the
database. Or, if you do not want to keep your work, press Cancel.

At any time, you can print or preview the report to make sure it looks the way you want. Note that
previewing the report will store the definition in the database, just as if you had pressed OK.

To preview your report, press the button labeled Preview. Figure 3-1 shows a typical report in the preview
window. This report has only a single page, but the viewer will allow you to step through the report page
by page, and to zoom in or out, using the button bar at the top of the window.

Figure 3-1 Viewing a Report

SCADA Operations Reports 3-13

 DB-405 Report Database Editing Guide

3.7 Printing an Ad Hoc Report

Normally, a report is referenced by one or more Report Schedules. These schedules will cause the report
to be printed on a specified printer at a specified time, as described in chapter 2. If you want to see how a
new report will look on paper, or if you just want to print a report “on demand”, call up the viewing window
described in section 3.6, Previewing a Report.

On the toolbar you will find a “Print…” button, as shown in Figure 3-1. Pressing it will bring up the
standard Windows Print dialog, where you can print the report using any printer known to your
workstation.

3.8 Report Examples

In the examples that follow, you will see some of the reports that can be produced using the Generic
Report capability of the SCADA system. In each case, the important details in the definition of the report
are shown, along with a sample of the report output.

3.8.1 Analog Point List

This is a report that lists all the analog points in a particular station.

3.8.1.1 General Tab

The figure below shows that the database Table Name the data will be taken from is AnalogPoints.

Figure 3.8-1 Report "Analogs"—General

SCADA Operations Reports 3-14

 DB-405 Report Database Editing Guide

3.8.1.2 Layout Tab

The choice of data to be retrieved from each record in this table Report Column section.

The field “PKey” appears first and is formatted using <FullPointName>. The PKey in this table represents
the point’s internal ID number. This format choice will cause the full station and point name (separated by
a comma) to be printed. The other fields in the Report Fields list can use the <Default> format.

No reference table has been specified for any of these Report Columns.

Figure 3.8-2 Report "Analogs"—Layout

SCADA Operations Reports 3-15

 DB-405 Report Database Editing Guide

3.8.1.3 Selection Criteria

To display the points from the desired station, a line has been entered in the Where field, shown in the
figure below.

This is the ID number of the desired station, which you can determine by looking at the stations in STC
Explorer.

Figure 3.8-3 Report "Analogs"—Selection Criteria

3.8.1.4 Additional Information

You can edit this report definition to change the choice of station, or if you like, you can define a separate
report for each station.

No sorting or grouping has been specified in this report definition.

SCADA Operations Reports 3-16

 DB-405 Report Database Editing Guide

3.8.2 Report Preview

The output of the report is shown below.

Figure 3.8-2 Report "Analogs"—Preview

SCADA Operations Reports 3-17

 DB-405 Report Database Editing Guide

4 Operations Reports

Operations reports are a built-in specialized type of report that is part of the optional Operation and
Outage Accounting feature. This type of report provides information about the past operation of the
devices designated for accounting.

SCADA Operations Reports 4-18

 DB-405 Report Database Editing Guide

4.1 Introduction
In order to understand the significance of the contents of this report, you should be familiar with the
Operation and Outage Accounting feature, as described in one of the chapters of the Point Database
Editing Guide.

When this feature is in use, status points are identified that correspond to switches or circuit breakers for
which accounting is to be maintained. The accounting data includes information about operation of these
devices, as well as accumulated outage information based on the time the devices have been open (off).

To define an operations report, navigate to the Reports branch in the STC Explorer and click on
Operations. All the reports display in the right window pane.

Figure 4.1-1 Operations Report Window

SCADA Operations Reports 4-19

 DB-405 Report Database Editing Guide

4.2 Editing an Operation Report

The operation report is designed to list the monitored devices and dis play information about their
operations. To edit an existing report right-click on one of the reports and select Edit from the drop-down
menu. The Operations Report dialog displays as shown in Figure 4.2-1.

Note: To create a new report select New from the drop-down menu.

Figure 4.2-1 Operation Report Dialog

Table 4.2-1 Operations Report Data Fields Descriptions

Field Description
Enter a name that your operation report will be known by. This will only be
Name
seen in STC Explorer.
Enter a description that will become the title of this report. This title will appear
Description
at the top of each page when the report is generated.
Enter an integer number of days. Each device’s operations will be checked
against this limit. If a device has not operated in more than this number of
NO-OP Limit, days
days, it will be flagged as “NO-OP” on the report, to indicate it has not
operated in the specified time.
Enter an integer that represents the percentage of its maximum number of
operations that a device may reach. Any device that exceeds this percentage
Warning
of its maximum operations will be flagged as “WARN” in the report to indicate
it is approaching its operations limit.
Select the All Stations checkbox to include points from all stations. If you want
Station Name only points from one particular station, clear this box and select the desired
station from the Station Name pull-down list.
Select the All Stations checkbox to include all points from the station or
stations you chose above. If you want only a particular point from the
station(s), clear this box and enter the desired point name in the Point Name
field. You may include a wildcard character in the point name, to indicate that
Point Name
you want several points with similar names. The "*" character represents any
number of characters (even zero), while the "?" character can be used to
represent any one character alone. For example, the point name "BRK*"
indicates all points whose names begin with "BRK".

SCADA Operations Reports 4-20

 DB-405 Report Database Editing Guide

4.3 The Operation Report

This display appears when you press the Preview button shown in Figure 4.2-1. You can view the report
at any time using this button, and you can print it immediately by pressing the “Print…” button in the
toolbar at the top of the Preview window.

But normally, the operation report will be scheduled to print, like any other report. Refer to chapter 2 for a
discussion of report scheduling.

Figure 4-2 Operation Report

4.3.1 Report Breakdown

The top of the report includes the title and the settings that were used to generate the report.

The body of the report shows:

• Equipment point name and description
• Date and time of the most recent operation
• Number of days elapsed since last operation
• Number of operations caused by operator control (Manual)
• Number of operations caused by protective relaying (Auto)
• Total number of operations
• Actual number of operations compared to operations limit (expressed as a percentage)

SCADA Operations Reports 4-21

 DB-405 Report Database Editing Guide

4.3.2 Status

The status types are:

• EXCEED - The operation count exceeds the device’s specified limit
• WARN - The count is within the percentage of the limit specified by the Warn field
• NO-OP - The last operation was beyond the specified number of No-Op days
• OK - None of the above conditions are true

In the example, since the elapsed number of days is much greater than the specified “No-Op Days”, the
status of the device is marked “NO-OP”. The operation limit for the example device is evidently 3, since
the count shown (4) is 133.33% of the limit.

The Operations and Outage accounting package on your SCADA system may be optionally configured
not to count operator control actions, or Opens, or Closes.

Your system manager or technical support contact can help you with this. In these cases, the counts you
see in the report will reflect those settings. In particular, if operator controls are not counted, the Manual
field of the report will contain a dash “- “ and the Auto field will be equal to the Total column.

SCADA Operations Reports 4-22

 DB-405 Report Database Editing Guide

5 Outage Reports

Outage reports are a built-in specialized type of report that is part of the optional Operation and Outage
Accounting feature. It reports information about outages in equipment that has been designated for
accounting.

SCADA Outage Reports 5-1

 DB-405 Report Database Editing Guide

5.1 Introduction
In order to understand the significance of the contents of this report, you should be familiar with the
Operation and Outage Accounting feature, as described in Chapter 5 of DB-403 Windows SCADA
Automation Database Editing Guide. When this feature is in use, status points are selected that
correspond to switches or circuit breakers for which accounting are to be maintained. The accounting
data includes information about operation of these devices, as well as accumulated outage information
based on the time the devices have been open (off).

To define an outage report, navigate to the Reports branch in the STC Explorer and click on Operations.
All the reports display in the right window pane.

Figure 5.1-1 Outages Report Window

SCADA Outage Reports 5-2

 DB-405 Report Database Editing Guide

5.2 Editing an Outage Report

The Outage Report generates information for a specified interval by concatenating the contents of daily
outrage files maintained by the accounting program.

To edit an existing report right-click on one of the reports and select Edit from the drop down menu. The
Outages Report dialog displays as shown in Figure 5.2-1.

Note: To create a new report select New from the drop down menu.

Figure 5-1 Outage Report Dialog

Table 4.2-1 Outages Report Data Fields Descriptions

Field Description
Enter a name that your outage report will be known by. This will only be seen
Name
in STC Explorer.
Enter a description that will become the title of this report. This title will appear
Description
at the top of each page when the report is generated.
Enter an integer number of days to specify how far back in time the outage
Interval Days Back report will extend. The report will include data from that start time, up to the
present.

SCADA Outage Reports 5-3

 DB-405 Report Database Editing Guide

5.3 The Outage Report

Refer to Figure 5.3-2 as an example of an outage report. This display appears when you press the
Preview button. You can view the report at any time using this button, and you can print it immediately by
pressing the “Print…” button in the toolbar at the top of the Preview window.

But normally, the outage report will be scheduled to print, like any other report. Refer to chapter 2 for a
discussion of report scheduling.

Figure 5.3-2 Outage Report

For each outage listed, the report shows:

• Name and description of the device
• Start date and time of the outage
• The duration of the outage (within the reporting interval). Outages that started before the
reporting interval and outages that are still outstanding at the end of the reporting interval are
identified
• The last phase currents prior to the outage

An asterisk preceding the date and time of the outage is used to indicate that the outage began before
the reporting interval.

The status column (STAT) indicates the status of the outage at the end of the reporting interval:
• OK means the outage has cleared
• OUT means the outage is still outstanding

At the end of the report, a summary of total accumulated outage time is provided for all devices for which
outage accounting is specified.

SCADA Outage Reports 5-4

 DB-405 Report Database Editing Guide

6 Historical Data Reports

The built-in historical data report facility provides a means of listing some or all of the content of a
historical data set that you have previously defined.

SCADA Historical Data Reports 6-1

 DB-405 Report Database Editing Guide

6.1 Introduction
A Historical Data Report allows you to extract data from one of your historical datasets and present it in
the form of a list.

An example of a historical data report is shown in Figure 6.3-1. This discussion of the Historical Data
Report assumes you are familiar with historical data, as described in DB-404, Historical Database Editing
Guide.

To define a historical report, navigate to the Reports branch in the STC Explorer and click on Historical.
All the reports display in the right window pane.

Figure 6.1-1 Historical Report Window

SCADA Historical Data Reports 6-2

 DB-405 Report Database Editing Guide

6.2 Editing a Historical Data Report

The historical data report displays a row for each sample found in the historical dataset, during the
interval specified by the report. Each row can include the values from one or more data items from the
dataset, which might be point values or calculated results from the dataset (such as a maximum or
average value). To edit an existing report right-click on one of the reports and select Edit from the drop-
down menu. The Outages Report dialog displays as shown in Figure 6.2-1.

Note: To create a new report select New from the drop-down menu.

Figure 6-1 Historical Data Report Dialog

Table 6.2-1 Historical Report Data Fields Descriptions

Field Description
Enter a name that your report will be known by. This will only be seen in
Name
STC Explorer
Enter a description that will become the title of this report. This title will
Description
appear at the top of each page when the report is generated.
Select the historical dataset you want reported from this list of existing
DataSet datasets. Only data items contained in this dataset can be displayed in
this report.
Sample Time Format Select the format you would like the sample dates and times displayed in.
Samples are normally displayed in ascending order (i.e., oldest first), but
Order
you may choose to display them in descending order instead.
Select this checkbox if you want the condition codes that were stored with
Display Condition
the data samples to be included in the report. Otherwise they will be
Codes
omitted.

SCADA Historical Data Reports 6-3

 DB-405 Report Database Editing Guide

Table 6.2-1 Historical Report Data Fields Descriptions continued

Field Description

Select this checkbox if you want the qualifiers you requested (max, min,
Display Qualifier
average, etc.) to be included in the report. Otherwise they will be omitted.

Choose the time interval that your report will cover. You may do this in one of
two ways, by choosing the appropriate radio button. You may specify an
absolute start and end time (and date) in the From and To fields, or you may
specify a time period prior to the time the report is generated, using the
Time Range Interval fields.

If you choose this second method, the report will automatically cover the
relative time interval specified, each time it is generated. This is a good
choice for reports that will be generated automatically on a schedule.
The All Points list shows all the points available in the current dataset. To
include one or more of these points in your report, drag the point name(s)
Points Lists from All Points into the Selected Points list. You can remove points from the
report by dragging point names from Selected Points back onto the All Points
list.

6.2.1 Historian Dataset

If you have the Historian feature, then all point changes are archived therefore any point may be used for
a historical query.

As displayed below, if you select Historian then two additional fields display on the dialog:

• Sample Interval – Allows you to select the periodic sample interval

• Point Browser – Allows you to select which points you want historical information for using the
Drag-n-Drop Points browser

Figure 6-2 Historical Data Report Dialog

SCADA Historical Data Reports 6-4

 DB-405 Report Database Editing Guide

6.3 The Historical Data Report

Each row of the report corresponds to one sample from the historical dataset. The report covers the
one-hour period just prior to the time it was generated.

The report displays the time stamp of each sample, along with a column for each data item specified in
the report definition. The headings for these columns (except for the timestamp) are taken from the
captions specified in the report definition.

Figure 6.3-1 Example Report

At the top of each page, the report header includes the title of the report, the time the report was
generated, the dataset used as a source of data, and the range of times included in the report.

SCADA Historical Data Reports 6-5

 DB-405 Report Database Editing Guide

7 Event Reports

An Event report is a built-in specialized type of report that is part of the Event Data Recording feature. It
reports information about Events in equipment that has been designated for accounting.

SCADA Event Reports 7-1

 DB-405 Report Database Editing Guide

7.1 Introduction
An Event report allows you to extract data from the Event Data Recording table, as described in one of
the chapters of the Point Database Editing Guide. It reports the contents of the Event Data table (called
Events). This will produce a list of the events that have been recorded by the Event Data Recording
program.

To define a historical report, navigate to the Reports branch in the STC Explorer and click on Events. The
reports display in the right window pane.

Figure 7.1-1 Events Report Window

SCADA Event Reports 7-2

 DB-405 Report Database Editing Guide

7.2 Editing an Event Report

To edit an existing report right-click on one of the reports and select Edit from the drop down menu. The
Events Report dialog displays as shown in Figure 7.2-1.

Note: To create a new report select New from the drop down menu
Figure 7.2-1 Event Report Dialog

Table 7.2-1 Events Report Data Fields Descriptions

Field Description
Enter a name that your report will be known by. This will only be seen in STC
Name
Explorer.
Enter a description that will become the title of this report. This title will appear
Description
at the top of each page when the report is generated.
Select the orientation of the page for printing (portrait, or landscape). You
Orientation may choose <Default>, in which case the SCADA system will not set the
orientation. The printer will use its current default setting.
Order Choose whether you want the report in ascending or descending time order.
Print Point Name Check this box to display the Point Name in the report.
Print Point
Check this box to display the point description in the report.
Description
Print Header Check this box to display the report header.

SCADA Event Reports 7-3

 DB-405 Report Database Editing Guide

Table 7.2-1 Event Report Data Fields Descriptions continued

Field Description
Select the debouncing period. When the report generator sees a change of
state for a point, it records the time tag. If there are no further status changes
within the debounce interval, the change reported as a valid change.

However, if, within the debounce interval, the report encounters a change of
state again that brings the point to its original state, the report discards both
changes. This ensures that true events are time tagged at the start of the
event but that the contact bounces are ignored.
Debouncing

Choose the time interval that your report will cover. You may do this in one of
two ways, by choosing the appropriate radio button. You may specify an
absolute start and end time (and date) in the From and To fields or choose
the time of the first and/or last available record using the checkboxes.
Alternatively, you may specify a time period prior to the time the report is
Time Range generated, using the Start … Days/Hours/Minutes Ago, the At (time) and
the For Interval Of fields.

If you choose this second method, the report will automatically cover the
relative time interval specified, each time it is generated. This is a good
choice for reports that will be generated automatically on a schedule.
You choose which points are included in the report by adding them to the
Units list, from the Drag and Drop Point Browser. Press the Point Browser
button to open the point browser window.

You can drag point names on to the list to include only those points in the
report. Or, you can drop one or more entire stations or entire RTUs onto the
Drop Units list, to include all of the points in the station(s) or the RTU(s).

Items may be removed from the Units list by right-clicking on the item and
choosing Delete.

If you want to include all points in the report, leave the Units list empty, and
simply check the All Points checkbox.
You may further filter the records that will be included in your report by their
user-defined Type. If you do not want such filtering, select the All Types
User Types
checkbox. Otherwise, select only the User Type(s) you want to include in the
report.
Choose the types of events that you want included in the report. If you want
Event Types
all types, you can just check the All checkbox.

SCADA Event Reports 7-4

 DB-405 Report Database Editing Guide

7.3 The Event Report

The following figure shows how event information is displayed in a report.

Figure 7.3-1 Event Report Preview

SCADA Event Reports 7-5

 DB-405 Report Database Editing Guide

8 Tag Reports

A Tag report is a built-in specialized type of reports that shows currently applied tags. It reports
information about the types of tags used, along with the time of their creation.

SCADA Tag Reports 8-1

 DB-405 Report Database Editing Guide

8.1 Introduction
In order to understand the significance of the contents of this report, you should be familiar with the Tags
feature, as described in one of the chapters of the Point Database Editing Guide. When a tag is applied,
the system records the type of tag, tag description and its timestamp. With this report, you can list of tags
currently in use.

To define a historical report, navigate to the Reports branch in the STC Explorer and click on Tags. The
reports display in the right window pane.

Figure 8.1-1 Events Report Window

SCADA Tag Reports 8-2

 DB-405 Report Database Editing Guide

8.2 Editing a Tag Report

To edit an existing report right-click on one of the reports and select Edit from the drop down menu. The
Tags Report dialog displays as shown in Figure 8.2-1.

Note: To create a new report select New from the drop down menu

Figure 8.2-1 Tags Report Dialog

Table 8.2-1 Tads Report Data Fields Descriptions

Field Description
Enter a name that your report will be known by. This will only be seen in STC
Name
Explorer
Enter a description that will become the title of this report. This title will appear
Description
at the top of each page when the report is generated.
Select the orientation of the page for printing (portrait, or landscape). You
Orientation may choose <Default>, in which case the SCADA system will not set the
orientation. The printer will use its current default setting.
Order Choose whether you want the report in ascending or descending time order.
Include Temporary Check this box if you want to include the tags that have been placed on
Devices Temporary Devices, in addition to the other Units you can select, below.
Print Header Check this box to display the report header.

SCADA Tag Reports 8-3

 DB-405 Report Database Editing Guide

Table 8.2-1 Tags Report Data Fields Descriptions continued

Field Description

In the report, tags are listed from the newest to the oldest.

In this section, you may specify some additional grouping by the following
criteria:
Group By • None – No additional grouping
• Types – Group by tag type
• Points – Group by point name
• Station – Group by station name
RTU – Group by RTU name
Here you may filter tags in the report according to their time of creation
(timestamp). Choose the time interval that you want the report to cover. You
may do this in one of two ways, by choosing the appropriate radio button.

The first choice consists of specifying a start date and an end date in the
From and To fields. You may check the First Record checkbox to tell the
report to start with the oldest tag. And you can check the Last Record
Time Range checkbox to tell the report to end at the newest tag. Checking both First
Record and Last Record will cause the report to report all tags.

The second method consists of specifying a time range relative to the present
time (i.e. the time that the report is running). In this case, you specify a
relative start time, and a desired interval going forward from the start time.
This is a good choice for reports that will be generated automatically on a
schedule.
You choose which points are included in the report by adding them to the
Units list, from the Drag and Drop Point Browser. Press the Point Browser
button to open the point browser window. You can drag point names on to the
list to include only those points in the report. Or, you can drop one or more
entire stations or entire RTUs onto the list, to include all of the points in the
station(s) or the RTU(s).
Drop Units
Items may be removed from the Units list by right-clicking on the item and
choosing Delete.

If you want to include all points in the report, leave the Units list empty, and
simply check the All Points checkbox.
To request all points on one or more stations or RTUs click on the box beside
the desired stations or RTUs. If you want all the stations or RTUs, check the
User Types All checkbox. If the number of desired stations or RTUs is more than half the
total, you may find it easier to use the Select All and then uncheck the ones
you don’t want.
Choose the type of tags that you want included in your report. By default,
Tag Types there are four types of tags (as shown in the picture). If you want all the tag
types, check the All checkbox.

SCADA Tag Reports 8-4

 DB-405 Report Database Editing Guide

8.3 The Tags Report

The following figure shows how tag information is displayed in a report.

Figure 8.3-1 Tag Report Preview

SCADA Tag Reports 8-5

 DB-405 Report Database Editing Guide

9 Operation Log Reports

An Operation Log report is a built-in specialized type of report that shows list of operations made within a
specified time period.

SCADA Operation Log Reports 9-1

 DB-405 Report Database Editing Guide

9.1 Introduction
In order to understand the significance of the contents of this report, you should be familiar with the
Operation Logs feature, as described in one of the chapters of the WV 200 - Operators Guide.

The operation log report is designed to report on the logs that the system has kept about device
operations and operator actions. An example of an Operation Log report is shown in Figure 9.3-1.

To define an operations log report, navigate to the Reports branch in the STC Explorer and click on
Operation Log. The reports display in the right window pane.

Figure 9.1-1 Operation Log Report Window

SCADA Operation Log Reports 9-2

 DB-405 Report Database Editing Guide

9.2 Editing an Operation Log Report

To edit an existing report right-click on one of the reports and select Edit from the drop down menu. The
Operation Log Report dialog displays as shown in Figure 9.2-1.

Note: To create a new report select New from the drop-down menu
Figure 9.2-1 Operation Log Report Dialog

Table 9.2-1 Operation Log Report Data Fields Descriptions

Field Description
Enter a name that your report will be known by. This will only be seen in STC
Name
Explorer
Enter a description that will become the title of this report. This title will appear
Description
at the top of each page when the report is generated.
Select the orientation of the page for printing (portrait, or landscape). You
Orientation may choose <Default>, in which case the SCADA system will not set the
orientation. The printer will use its current default setting.
Order Choose whether you want the report in ascending or descending time order.
Check this checkbox if you want the report to include operator made
Print with
annotations. If checked, the report will include two additional columns,
Annotations
Annotation Time and Annotation.

SCADA Operation Log Reports 9-3

 DB-405 Report Database Editing Guide

Table 9.2-1 Event Report Data Fields Descriptions continued

Field Description
When checked, Operator Log report will include only those operations that
Print Only Selected have been selected by the operator via the Operator Log display in
Records WorldView (oprsum). Together with annotations, this feature allows the
operator to use the operations log report as an end-of-shift report.
Print Header Check this box to display the report header.
Here you may filter the logs according to their time of creation (timestamp).
Choose the time interval that you want the report to cover. You may do this in
one of two ways, by choosing the appropriate radio button.

The first choice consists of specifying a start date and an end date in the
From and To fields. You may check the First Record checkbox to tell the
report to start with the oldest record. And you can check the Last Record
Time Range checkbox to tell the report to end at the newest record. Checking both First
Record and Last Record will cause the report to report all records.

The second method consists of specifying a time range relative to the present
time (i.e. the time that the report is running). In this case, you specify a
relative start time, and a desired interval going forward from the start time.
This is a good choice for reports that will be generated automatically on a
schedule.
You choose which points are included in the report by adding them to the
Units list, from the Drag and Drop Point Browser. Press the Point Browser
button to open the point browser window. You can drag point names on to the
list to include only those points in the report. Or, you can drop one or more
entire stations or entire RTUs onto the list, to include all of the points in the
station(s) or the RTU(s).
Drop Units
Items may be removed from the Units list by right-clicking on the item and
choosing Delete.

If you want to include all points in the report, leave the Units list empty, and
simply check the All Points checkbox.
You may further filter the records that will be included in your report by their
user-defined Type. If you do not want such filtering, select the All Types
User Types
checkbox. Otherwise, select only the User Type(s) you want to include in the
report.
Choose the types of events that you want included in the report. If you want
Event Types
all types, you can just check the All checkbox.

SCADA Operation Log Reports 9-4

 DB-405 Report Database Editing Guide

9.3 The Operation Log Report

The following figure shows how operation log information is displayed in a report.

Figure 9.3-1 Operation Log Report Preview

SCADA Operation Log Reports 9-5

 DB-405 Report Database Editing Guide

10 Worldview Reports

A Worldview report is a built-in specialized type of report that prints a specific view from a Worldview map.

To define a WorldView report, navigate to the Reports branch in the STC Explorer and click on Operation
Log. The reports display in the right window pane.

Figure 10.1-1 WorldView Report Window

SCADA 10-1
 DB-405 Report Database Editing Guide

10.1 Editing a Worldview Map Report

To edit an existing report right-click on one of the reports and select Edit from the drop-down menu. The
Wmp Map dialog displays as shown in Figure 9.2-1.

Note: To create a new report select New from the drop-down menu

Figure 10-1 Worldview Map Report

Table 10.2-1 Operation Log Report Data Fields Descriptions

Field Description
Enter a name that your report will be known by. This will only be seen in STC
Name
Explorer
Enter a description that will become the title of this report. This title will appear at
Description
the top of each page when the report is generated.
Map Name Enter the name of the WorldView map file (without the .wmp extension).
View Name Enter the name of the defined view in this map file that you want to print.

SCADA 10-2