DNA HistoricalServices PDF

OASyS® DNA SCADA Suite
Baseline
Historical Services
Configuration and
Administration Reference
Document Revision 1.1
Telvent Telvent
10333 Southport Rd., S.W. 7000A Hollister Rd.
Calgary, Alberta, Canada, T2W 3X6 Houston, Texas, U.S.A., 77040-5337
Phone: +1 403 253 8848 Phone: +1 713 939 9399

Fax: +1 403 259 2926 Fax: +1 713 939 0393
E-mail: [email protected] E-mail: [email protected]
Historical Services Configuration and Administration

Reference
Document Revision 1.1
© Copyright 2000 - 2004 by Telvent Canada Ltd.
All Rights Reserved
The information contained in this document is confidential and proprietary to Telvent Canada Ltd. It is not to be copied or disclosed for any purpose except as specifically
authorized in writing by Telvent. Although the information contained herein was correct and verified at the time of publication, it is subject to change without notice.
Trademark Acknowledgments
The following is a list of trademarks which may appear in this document:
RealTime Service, XOS, Historical Service, MICRO/1C, PoleCAT, SAGE 2000, SAGE 2100 are all trademarks of Telvent Canada Ltd
AutoCAD is a registered trademark of Autodesk, Inc.
DATEK is a registered trademark of Datek Industries, Ltd.
Ethernet is a registered trademark of Xerox Corporation
MODBUS is a registered trademark of Gould, Inc.
Excel, MS-DOS, WINDOWS, WINDOWS NT are registered trademarks of Microsoft Corporation.
SYBASE, Data Workbench, SQL Server, are registered trademarks of Sybase, Inc.
Document Revision History
Baseline SIG
Date Additions and Changes
Revision Revision
1.0 2003/05/26 For XOS 7.3.1 release (Remote XOS) no document changes made.
1.0 2003/07/23 Historical Service upgrade 7.3.1, no document changes.
1.1 2003/10/31 SPR 30067
SPR 28427
SPR 30081
For details, refer to “Detailed Document Revision History”.
1.1 2004/02/06 Release for OASyS DNA 7.4
Contacts
Lead Writer: Author variable
Project Manager: PM variable
Project Leader: PL variable
Software Version
This document describes the following components of OASyS® DNA:
• Historical 7.4
• XOS 7.4
OASyS® DNA SCADA Suite Baseline Document Revision 1.1

Proprietary and Confidential to Telvent
Table of Contents
Document Revision History

Table of Contents
List of Figures
List of Tables
MODULE 1
Introduction
1.1 HistoricalDB Structure ................................................................................................................... 1-2
1.2 Basic Historical Service Procedures ............................................................................................... 1-3
MODULE 2
Editing Historical Data
2.1 A Note on HistoricalDB Time ........................................................................................................ 2-2
2.2 Editing the timeline Database ....................................................................................................... 2-2
2.2.1 The Timeline Collect Editor.................................................................................................. 2-2
2.2.1.1 The Point Select Dialog Box ........................................................................................ 2-4
2.2.1.2 The Timeline Edit Dialog Box...................................................................................... 2-5
2.2.1.3 Adding New Records to the timeline Database .......................................................... 2-6
2.2.1.4 Modifying timeline Database Records ......................................................................... 2-7
2.2.1.5 Filtering Data Displayed on the Timeline Collect Editor ........................................... 2-7
2.3 Editing the accum Database.......................................................................................................... 2-7
2.3.1 The Accum Hour Editor ........................................................................................................ 2-8
2.3.1.1 The Accum Edit Dialog Box ......................................................................................... 2-9
2.3.1.2 Adding New Records to the accum Database .......................................................... 2-10
2.3.1.3 Modifying accum Database Records ......................................................................... 2-10
2.3.1.4 Filtering Data Displayed on the Accum Hour Editor ............................................... 2-10
2.4 Editing the CommStats Database................................................................................................ 2-11
2.4.1 The Remote Communication Statistics Editor................................................................... 2-11
2.4.1.1 The Communication Statistics Edit Dialog Box ........................................................ 2-13
2.4.1.2 Adding New Records to the CommStats Database .................................................. 2-14
2.4.1.3 Modifying CommStats Database Records ................................................................. 2-14
2.4.1.4 Filtering Data Displayed on the Remote Communication Statistics Editor............ 2-14
2.5 The Connection Statistics Editor................................................................................................. 2-15
2.5.1 The Connection Statistics Edit Dialog Box ........................................................................ 2-17
MODULE 3
Data Collection and Data Summary
3.1 The Collection Entry Dialog Box................................................................................................... 3-1
3.1.1 The Collect Select Dialog Box .............................................................................................. 3-2
3.1.2 Data Collection by Exception............................................................................................... 3-3
3.2 Configuring Collect Points ............................................................................................................ 3-3

Contents - 2 Historical Services Configuration and Administration Reference - Baseline
3.3 Data Summary ............................................................................................................................... 3-4
MODULE 4
Historical Application Installation Tool
4.1 SQL Application Definition ........................................................................................................... 4-2
4.2 Historical Application Definition.................................................................................................. 4-3
4.2.1 Application Sequence Files .................................................................................................. 4-3
4.2.2 Application Suite Files .......................................................................................................... 4-4
4.3 Directory Structure ........................................................................................................................ 4-5
4.4 The Full Historical Installation Option ......................................................................................... 4-5
4.5 Selective Application Installation ................................................................................................. 4-6
4.6 System-Specific Configuration...................................................................................................... 4-7
MODULE 5
Historical Replication
5.1 MS SQL Replication Components and OASyS DNA Mapping ..................................................... 5-1
5.1.1 Replication Types.................................................................................................................. 5-1
5.1.1.1 Snapshot Replication................................................................................................... 5-1
5.1.1.2 Merge Replication ....................................................................................................... 5-1
5.1.1.3 Transactional Replication............................................................................................ 5-2
5.1.2 Globally Unique Identifiers .................................................................................................. 5-2
5.1.3 Publications and Articles ...................................................................................................... 5-2
5.1.4 Publishers .............................................................................................................................. 5-2
5.1.5 Subscriptions ......................................................................................................................... 5-3
5.1.5.1 Push Subscriptions ....................................................................................................... 5-3
5.1.5.2 Pull Subscriptions......................................................................................................... 5-3
5.1.5.3 Anonymous Subscriptions ........................................................................................... 5-3
5.1.5.4 Subscribers as Publishers ............................................................................................. 5-3
5.1.6 Distributor............................................................................................................................. 5-4
5.1.7 Replication Agents ............................................................................................................... 5-4
5.1.7.1 Snapshot Agents.......................................................................................................... 5-4
5.1.7.2 Merge Agents .............................................................................................................. 5-4
5.2 The SQL Server Enterprise Manager............................................................................................. 5-5
5.3 Historical Data Replication Configuration................................................................................... 5-6
5.3.1 Viewing Replication Component Properties....................................................................... 5-8
MODULE 6
Archiving
6.1 The Archive Process ....................................................................................................................... 6-1
6.1.1 xis_archive ............................................................................................................................. 6-2
6.1.2 cmx_archive........................................................................................................................... 6-3
6.2 The Archive/Dearchive Edit Dialog Box........................................................................................ 6-4
6.2.1 The Schedule Summary Window ......................................................................................... 6-4
6.2.1.1 The Schedule Configuration Dialog Box .................................................................... 6-6
6.2.1.2 Archive Cutoff.............................................................................................................. 6-9
6.2.1.3 Archive Intervals .......................................................................................................... 6-9
6.2.2 The Add Device Editor........................................................................................................ 6-12
6.2.3 The Media Initialization Dialog Box.................................................................................. 6-13

Historical Services Configuration and Administration Reference - Baseline Contents - 3
6.2.4 Archive Troubleshooting.................................................................................................... 6-14

6.3 Data Dearchiving......................................................................................................................... 6-14
6.3.1 The Dearchive Window ...................................................................................................... 6-14
6.3.2 The Dearchive Configuration Dialog Box ......................................................................... 6-16
6.4 Data Cleanup ............................................................................................................................... 6-17
6.4.1 xis_cleanup.......................................................................................................................... 6-19
6.4.2 cmx_cleanup ....................................................................................................................... 6-19
6.5 Data Rearchiving ......................................................................................................................... 6-19
6.5.1 Rearchive Troubleshooting ................................................................................................ 6-20
MODULE 7
HistoricalDB Databases
7.1 The timeline Database.................................................................................................................... 7-1
7.1.1 tag Table................................................................................................................................ 7-2
7.1.2 collect Table ........................................................................................................................... 7-2
7.1.3 hour Table.............................................................................................................................. 7-2
7.1.4 day Table ............................................................................................................................... 7-3
7.1.5 month Table........................................................................................................................... 7-3
7.1.6 year Table .............................................................................................................................. 7-3
7.2 The accum Database ...................................................................................................................... 7-3
7.2.1 hour Table.............................................................................................................................. 7-4
7.2.2 day Table ............................................................................................................................... 7-4
7.2.3 month Table........................................................................................................................... 7-4
7.2.4 year Table .............................................................................................................................. 7-4
7.3 The event Database........................................................................................................................ 7-4
7.3.1 summary Table....................................................................................................................... 7-5
7.4 The CommStats Database .............................................................................................................. 7-5
7.4.1 RemPeriodStats Table ............................................................................................................. 7-6
7.4.2 ConnPeriodStats Table ......................................................................................................... 7-6
7.5 The archive Database ..................................................................................................................... 7-7
7.5.1 schedule Table ....................................................................................................................... 7-8
7.5.2 device Table ........................................................................................................................... 7-8
7.5.3 catalog Table.......................................................................................................................... 7-8
7.5.4 dumpSchedule Table .............................................................................................................. 7-9
7.5.5 rearchive Table ....................................................................................................................... 7-9
7.5.6 validDeviceTypes Table ......................................................................................................... 7-10
Index

Contents - 4 Historical Services Configuration and Administration Reference - Baseline

List of Figures
Figure 1-1 HistoricalDB in relation to other services .................................................................................1-1

Figure 1-2 OASyS DNA Network Management Console ...........................................................................1-4
Figure 2-1 HistoricalDB Edit Menu .............................................................................................................2-1
Figure 2-2 HistoricalDB Edit Menu icon .....................................................................................................2-1
Figure 2-3 Timeline Collect Editor ..............................................................................................................2-3
Figure 2-4 Point Select dialog box..............................................................................................................2-5
Figure 2-5 Timeline Edit dialog box ...........................................................................................................2-6
Figure 2-6 Accum Hour Editor ....................................................................................................................2-8
Figure 2-7 Accum Edit dialog box...............................................................................................................2-9
Figure 2-8 Remote Communication Statistics Editor ...............................................................................2-11
Figure 2-9 Communication Statistics Edit dialog box..............................................................................2-13
Figure 2-10 Connection Statistics Editor ....................................................................................................2-15
Figure 2-11 Connection Statistics Edit dialog box .....................................................................................2-18
Figure 3-1 Collection Entry dialog box.......................................................................................................3-1
Figure 3-2 Collect Select dialog box ...........................................................................................................3-3
Figure 4-1 Historical Application Install Tool.............................................................................................4-1
Figure 5-1 SQL Server Enterprise Manager ...............................................................................................5-5
Figure 5-2 Register SQL Server Wizard.......................................................................................................5-6
Figure 5-3 SQL Query Analyzer...................................................................................................................5-7
Figure 5-4 Agent Properties dialog box .....................................................................................................5-8
Figure 5-5 Create and Manage Publications dialog box ...........................................................................5-9
Figure 5-6 Publication Properties dialog box.............................................................................................5-9
Figure 5-7 Publisher and Distributor Properties ......................................................................................5-10
Figure 6-1 Archive/Dearchive Edit dialog box............................................................................................6-4
Figure 6-2 Schedule Summary window .....................................................................................................6-5
Figure 6-3 Schedule Configuration dialog box..........................................................................................6-7
Figure 6-4 Daily Archive example ............................................................................................................6-10
Figure 6-5 Monthly Archive example .......................................................................................................6-11
Figure 6-6 Yearly Archive example...........................................................................................................6-12
Figure 6-7 Add Device Editor ....................................................................................................................6-13
Figure 6-8 Media Initialization dialog box...............................................................................................6-14
Figure 6-9 Dearchive window ...................................................................................................................6-15
Figure 6-10 Dearchive Configuration dialog box ......................................................................................6-16
Figure 6-11 VF_POP_PANEL.........................................................................................................................6-18

Figures - 2 Historical Services Configuration and Administration Reference - Baseline

List of Tables
Table 1-1 HistoricalDB databases, tables, and views................................................................................1-2

Table 2-1 Buttons on the HistoricalDB Edit menu....................................................................................2-1
Table 2-2 Items on the Timeline Collect Editor ........................................................................................2-3
Table 2-3 Data quality status.....................................................................................................................2-4
Table 2-4 Items on the Point Select dialog box........................................................................................2-5
Table 2-5 Fields and buttons on the Timeline Edit dialog box................................................................2-6
Table 2-6 Fields and other items on the Accum Hour Editor ..................................................................2-8
Table 2-7 Fields and buttons on the Accum Edit dialog box...................................................................2-9
Table 2-8 Fields and Buttons on the Remote Communication Statistics Editor ...................................2-11
Table 2-9 Column headings on the Remote Communication Statistics Editor.....................................2-12
Table 2-10 Fields and Buttons on the Connection Statistics Editor.........................................................2-16
Table 2-11 Column headings on the Connection Statistics Editor ..........................................................2-16
Table 3-1 Fields and Other Items on the Collection Entry Dialog Box....................................................3-2
Table 4-1 Items on the Historical Application Install Tool.......................................................................4-2
Table 4-2 Syntax Elements of an Application Sequence File ...................................................................4-3
Table 4-3 Syntax Elements of an Application Suite File...........................................................................4-4
Table 6-1 Archive options ..........................................................................................................................6-2
Table 6-2 Buttons on the Archive/Dearchive Edit dialog box..................................................................6-4
Table 6-3 Items on the Schedule Summary window ................................................................................6-5
Table 6-4 Fields and Buttons on the Schedule Configuration dialog box ..............................................6-7
Table 6-5 Archive Cutoff sample (time-based) .........................................................................................6-9
Table 6-6 Archive Cutoff sample (non time-based) .................................................................................6-9
Table 6-7 Fields and buttons on the Add Device Editor ........................................................................6-13
Table 6-8 Items on the Dearchive window .............................................................................................6-15
Table 6-9 Items on the Dearchive Configuration dialog box ................................................................6-17
Table 6-10 Delete Cutoff sample...............................................................................................................6-18
Table 6-11 Cleanup options.......................................................................................................................6-19
Table 7-1 Telvent data-types .....................................................................................................................7-1
Table 7-2 Fields in the tag table of the timeline database........................................................................7-2
Table 7-3 Fields in the collect table of the timeline database ...................................................................7-2
Table 7-4 Fields in the hour table of the timeline database......................................................................7-2
Table 7-5 Fields in the hour table of the accum database........................................................................7-4
Table 7-6 Fields in the summary table of the event database...................................................................7-5
Table 7-7 Fields in the RemPeriodStats table of the CommStats database ...............................................7-6
Table 7-8 Fields in the ConnPeriodStats table of the CommStats database..............................................7-6
Table 7-9 Fields in the schedule table of the archive database.................................................................7-8
Table 7-10 Fields in the device table of the archive database.....................................................................7-8
Table 7-11 Fields in the catalog table of the archive database ...................................................................7-8
Table 7-12 Fields in the dumpschedule table of the archive database........................................................7-9
Table 7-13 Fields in the rearchive table of the archive database ................................................................7-9
Table 7-14 Fields in the validDevice table of the archive database ...........................................................7-10

Tables - 2 Historical Services Configuration and Administration Reference - Baseline

MODULE 1
Introduction
Long-term or historical data is stored in HistoricalDB for report and accounting purposes. A
full implementation of the MS SQL is used to effectively manage historical data and
administer related historical services.
HistoricalDB is composed of databases that are designed to receive data from RealTimeDB.
HistoricalDB in relation to other services (Figure 1-1) provides an overview of how
HistoricalDB relates to RealTimeDB, XOS, and other offline media.
Figure 1-1 HistoricalDB in relation to other services
The archiving process is configured

XOS through the xis_archive script.
The collection Historical data is available

process is configured for plotting in XOS.
through the point's
Collection Entry form.
HistoricalDB
RealTimeDB
analog
rate
remote archive
.
.
.
status
The archive
table holds data
for configuring
the archive
process.
offline media
The following are transferred from RealTimeDB to HistoricalDB:

1-2 Historical Services Configuration and Administration Reference - Baseline
• Selected data from analog, remote, status, and accumulator-type rate points
• Event and alarm messages, and related information
• Communication statistics
Data obtained from analog and rate points can be summarized to provide hourly, daily,
monthly, and yearly summaries. These data can be manually edited, plotted, and then
archived to offline storage.
1.1 HistoricalDB Structure

HistoricalDB consists of a number of databases. Data is stored in HistoricalDB as shown in
HistoricalDB databases, tables, and views (Module 1).
Table 1-1 HistoricalDB databases, tables, and views
Database Table View Description

accum hour hourView Hourly data. Flow meter
day dayView Daily data. (i.e. accumu-
lator-type)
month monthView Monthly data. rate data.
year yearView Yearly data.
archive catalog catalogView Archive ID, label file- Configura-
name, and time. tion data for
device deviceView Information about archiving.
devices used for
archiving.
dumpSchedule
rearchive rearchiveView Time range, archive
ID of archived data
schedule scheduleView Names of realtime
databases to archive,
dates for scheduled
archiving and data
deletion, and archive
device names.
validDeviceTypes Valid types of archive
device.
CommStats RemPeriodStats RemStatsView, Communication statistics based on the
editRemPeriod- remote.
ConnPeriodStats View
ConnStatsView, Communication statistics based on the
editConnPeriod- connection.
View
event summary eventView, sum- System-generated alarm and event
maryView messages.

Module 1 - Introduction 1-3
Table 1-1 HistoricalDB databases, tables, and views (Continued)
Database Table View Description

timeline hour Hourly summarized All RealTime
data. numerical
day Daily summarized data except
data. for accumu-
lator-type
month Monthly summarized rate values.
data.
year Yearly summarized
data.
collect Instantaneous tag
data.
tag Tag cross references.
xosapp notepad notepadView XOS applica-
tions
The modules in this component discuss the tools that are provided in configuring and
administering historical services and managing historical data.
1.2 Basic Historical Service Procedures

The procedures that are discussed in this section are performed through the OASyS DNA
Network Management Console or NMC. For more information, refer to the NMC Guide.
Starting, Stopping, or Failing Over Historical Service (Method 1)
1 Double-click the NMC icon to open the OASyS DNA Network Management Console
(Figure 1-2). For more information, refer to the Network Configuration Guide.
Alternatively, you can open the OASyS DNA Network Management Console
(Figure 1-2) by doing the following:
a Click the Start menu.

b Point to Programs > Telvent > OASyS DNA Scada Suite.
c Click Network Management Console.

Figure 1-2 OASyS DNA Network Management Console
2 Expand OASyS DNA.

3 Expand Systems.
4 Locate the name of the system.
5 Expand Services.
6 Right-click Historical.
7 Click Startup, Failover, or Shutdown.
Starting, Stopping, or Failing Over Historical Service (Method 2)
1 Double-click the NMC icon to open the OASyS DNA Network Management Console
(Figure 1-2). For more information, refer to the Network Configuration Guide.
Alternatively, you can open the OASyS DNA Network Management Console
(Figure 1-2) by doing the following:
a Click the Start menu.

b Point to Programs > Telvent > OASyS DNA Scada Suite.
c Click Network Management Console.
2 Expand OASyS DNA.
3 Expand Systems.
4 Locate the name of the system.
5 Expand MACHINES.
6 Locate the Historical machine.
7 Expand Services

Module 1 - Introduction 1-5
8 Right-click Historical.
9 Click Startup, Failover, or Shutdown.


MODULE 2
Editing Historical Data
The HistoricalDB Edit Menu (Figure 2-1) allows you to create or modify a HistoricalDB
record and define its data value at any specified timestamp in history.
Figure 2-1 HistoricalDB Edit Menu
NOTE You cannot edit or display newly created or modified HistoricalDB records in
XOS dialog boxes or windows until the top of the hour has passed.
Opening the HistoricalDB Edit Menu
• Click the HistoricalDB Edit Menu icon (Figure 2-2) on the XOS toolbar.
Figure 2-2 HistoricalDB Edit Menu icon
The following table lists the buttons on the HistoricalDB Edit Menu (Figure 2-1) and the
corresponding action when these are chosen.
Table 2-1 Buttons on the HistoricalDB Edit menu
Button Action
Timeline Data Opens the Timeline Collect Editor (Figure 2-3)
Accumulator Data Opens the Accum Hour Editor (Figure 2-6)

Table 2-1 Buttons on the HistoricalDB Edit menu (Continued)
Button Action
RTU Communication Statistics Opens the Remote Communication Statistics Editor
(Figure 2-8)
Communication Line Statistics Opens the Connection Statistics Editor (Figure 2-10)
Dismiss Closes the HistoricalDB Edit Menu (Figure 2-1).
2.1 A Note on HistoricalDB Time

Whenever historical data is collected, the system records a timestamp in the time field of the
HistoricalDB record. This time is recorded in Greenwich Mean Time (GMT), also known as
Coordinated Universal Time (UTC). The difference between GMT and local time is recorded in
the offset field. (This offset changes when daylight savings time comes into effect or ends.)
The time and offset are taken from the Windows settings on the host.
NOTE In HistoricalDB, time is measured in seconds, offsets in minutes.
If the remote provides the information, the timeline and event tables also record the
milliseconds part of the seconds.This is recorded in the timeline..hour table’s minMilli and
maxMilli fields and in the event..summary table’s msec field.
Summary data is timestamped according to the setting of the TSTAMP_PREFERENCE registry
setting. If this is set to TOP_OF_PERIOD, then data is timestamped with the start of the time
period. If it is set to BOTTOM_OF_PERIOD, then the data is timestamped with the end of the
time period. The variable also determines to which interval the boundary times are
assigned.
2.2 Editing the timeline Database

Records contained in the timeline database can only be edited in batches of one hour, and
only for a single collection point at one time. This means that multiple points cannot be
selected for editing.
2.2.1 The Timeline Collect Editor

The Timeline Collect Editor (Figure 2-3) is used to edit collect records.

Module 2 - Editing Historical Data 2-3
Figure 2-3 Timeline Collect Editor
Opening the Timeline Collect Editor
• Click Timeline Data on the HistoricalDB Edit Menu (Figure 2-1).
The following table lists the column headings, fields, and buttons on the Timeline Collect
Editor (Figure 2-3).
Table 2-2 Items on the Timeline Collect Editor
Field/
Column/
Button Description
Time This column shows the time interval over which the point’s values (as shown in
the Value column) and data quality status (as shown in the Status column) are
valid. Time is further split into one-minute intervals. For more information, refer
to A Note on HistoricalDB Time (Section 2.1).
Value This column shows the point’s value at the start of the hour.

Table 2-2 Items on the Timeline Collect Editor (Continued)
Field/
Column/
Button Description
Status This column shows the point’s data quality status. Data quality status (Table 2-3)
lists the data quality indicators.
Point: This field is for the name of the record. Click the arrow to the right of this field to
open the Point Select dialog box (Figure 2-4). For more information, refer to The
Point Select Dialog Box (Section 2.2.1.1).
Start Time: Acting as a filter, this field specifies the start time of the time interval shown in
the Time column.
End Time: Acting as a filter, this field specifies the end time of the time interval shown in
the Time column.
Add Click this button to add a new record to the timeline database. Refer to The
Timeline Edit Dialog Box (Section 2.2.1.2).
Filter Clicking this button displays data values on the Timeline Collect Editor
(Figure 2-3) that are filtered according to the Point:, Start Time: and End Time:
field entries.
Table 2-3 Data quality status
Status
Indicator What it means
NULL or “ “ Collected data is good
X Status of the database could not be determined
O Point is offscan (i.e. the point has been removed from the nor-
mal polling cycle)
M Point has been placed in manual mode
A Point is in alarm state
2.2.1.1 The Point Select Dialog Box

The Point Select dialog box (Figure 2-4) displays a list of timeline points from which you can
make a selection.

Figure 2-4 Point Select dialog box
Opening the Point Select dialog box
• Click the arrow next to the Point: field on the Timeline Collect Editor (Figure 2-3).
The following table lists the fields and buttons on the Point Select dialog box (Figure 2-4).
Table 2-4 Items on the Point Select dialog box
Button/Field Description
Enable Filters Click this button to filter the timeline points that are displayed on
the Point Select dialog box (Figure 2-4).
Remote: Enter the remote name by which to filter.
Group: Enter the group name by which to filter.
Point Name This column lists the collect points.
Point Description This column lists the collect points’ descriptions.
Point Field Description This column lists the descriptions of the collect point’s fields.
Search Click this button to display the data that correspond to the pro-
vided filters.
Dismiss Click this button to close the dialog box.
2.2.1.2 The Timeline Edit Dialog Box

The Timeline Edit dialog box (Figure 2-5) is used to add or modify record values in the
timeline database.

Figure 2-5 Timeline Edit dialog box
Opening the Timeline Edit dialog box
• Click Add on the Timeline Collect Editor (Figure 2-3).
The following table lists the fields and buttons on the Timeline Edit dialog box (Figure 2-5).
Table 2-5 Fields and buttons on the Timeline Edit dialog box
Field/Button Description
Time: Enter in this field the time in the prescribed format. Form more information,
refer to A Note on HistoricalDB Time (Section 2.1).
Value: Enter in this field the point’s value.
Add or Modify Click this button to add the new data into the timeline database.
Dismiss Click this button to close the Timeline Edit dialog box (Figure 2-5).
2.2.1.3 Adding New Records to the timeline Database

Adding a new record to the timeline database
1 Open the Timeline Collect Editor (Figure 2-3).

2 Type or select the point’s name.
3 Click Add to open the Timeline Edit dialog box (Figure 2-5).
4 Type the time.
5 Type the value.
6 Click Add.
7 Click Dismiss.
NOTE When a new record is added, the letter “M” appears in the Status column on
the Timeline Collect Editor (Figure 2-3) to indicate that the record has been added man-
ually.

2.2.1.4 Modifying timeline Database Records

Modifying a record in the timeline database
Modifications apply to the collect table. The day, month, and year tables are automatically updated
after the revision.
1 Click the row header of the record on the list displayed on the Timeline Collect Editor
(Figure 2-3) to open the Timeline Edit dialog box (Figure 2-5).
2 Type the time.
3 Type the value.
4 Click Modify.
5 Click Dismiss.
2.2.1.5 Filtering Data Displayed on the Timeline Collect

Editor
Filtering the list displayed on the Timeline Collect Editor
1 Open the Timeline Collect Editor (Figure 2-3).

2 Select a point using the Point Select dialog box (Figure 2-4), or type the name of the
point. Refer to The Point Select Dialog Box (Section 2.2.1.1).
3 Type the start time and end time.
4 Click Filter.
2.3 Editing the accum Database

Records contained in the accum database can only be edited in batches of one day and
only for a single collection point. This means that multiple points cannot be selected for
simultaneous editing. Use the Accum Hour Editor (Figure 2-6) to edit the accum database.

2.3.1 The Accum Hour Editor

Figure 2-6 Accum Hour Editor
Opening the Accum Hour Editor
• Click Accumulator Data on the HistoricalDB Edit Menu (Figure 2-1).
The following table lists the column headings, fields, and buttons that appear on the Accum
Hour Editor (Figure 2-6).
Table 2-6 Fields and other items on the Accum Hour Editor
Column Heading/
Time This is the timestamp of the hour. For more information, refer to A Note
on HistoricalDB Time (Section 2.1).
Adj Count This is the adjusted accumulator value.
Volume This is the volume during the hour.
Status This is the data quality status. Refer to Data quality status (Table 2-3).
Point: This field contains the name of the record. Type or select a rate record.
Start Time: Acting as a filter, this field specifies the start time of the time interval
shown in the Time column.

Table 2-6 Fields and other items on the Accum Hour Editor
Column Heading/
End Time: Acting as a filter, this field specifies the end time of the time interval
shown in the Time column.
Add Click this button to add a new record to the accum database. Refer to
The Timeline Edit Dialog Box (Section 2.2.1.2).
Filter Click this button to display the data values on the Accum Hour Editor
(Figure 2-6) filtered according to the Point:, Start Time:, and End
Time: field entries.
2.3.1.1 The Accum Edit Dialog Box

The Accum Edit dialog box (Figure 2-7) is used to add or modify record values in the accum
database.
Figure 2-7 Accum Edit dialog box
Opening the Accum Edit dialog box
• Click Add on the Accum Hour Editor (Figure 2-6).
The following table provides brief descriptions of the fields and buttons on the Accum Edit
dialog box (Figure 2-7).
Table 2-7 Fields and buttons on the Accum Edit dialog box
Time: Enter the time in the prescribed format.
Adjusted Count: Enter the point’s value.
Volume: Enter in this field the volume during the hour.
Add or Modify Click this button to add the new data into the timeline database.
Dismiss Click this button to close the Accum Edit dialog box (Figure 2-7).

2.3.1.2 Adding New Records to the accum Database

Adding a new record to the accum database
1 Open the Accum Hour Editor (Figure 2-6).

2 Type or select the point’s name.
3 Click Add. This opens the Accum Edit dialog box (Figure 2-7). Refer to The Accum Edit
Dialog Box (Section 2.3.1.1).
4 Type the time. This must be a time value for the start of the hour. Refer to the
description of Time in Fields and buttons on the Accum Edit dialog box (Table 2-7).
5 Type the adjusted count and volume.
6 Click Add.
7 Click Dismiss.
NOTE When a new record is added, a status of M is provided to indicate that the record
has been added manually. This status is as shown on the Status field on the Accum
Hour Editor (Figure 2-6).
2.3.1.3 Modifying accum Database Records

Modifying a record in the accum database
Modifications apply to the hour table. The day, month, and year tables are automatically updated
after the revision.
1 Click the row header of the record on the list displayed on the Accum Hour Editor
(Figure 2-6) to open the Accum Edit dialog box (Figure 2-7). Refer to The Accum Hour
Editor (Section 2.3.1).
2 Type the time, adjusted count, and volume.
3 Click Modify.
4 Click Dismiss.
2.3.1.4 Filtering Data Displayed on the Accum Hour Editor

Filtering the list displayed on the Accum Hour Editor
1 Open the Accum Hour Editor (Figure 2-6). Refer to The Accum Hour Editor
(Section 2.3.1).
2 Select a point using the Point Select dialog box (Figure 2-4), or type the name of the
point. Refer to The Point Select Dialog Box (Section 2.2.1.1).
3 Type the start time and end time.
4 Click Filter.

2.4 Editing the CommStats Database

Records contained in the CommStats database can only be edited in batches of one day
and only for a single collection point. This means that multiple points cannot be selected
for simultaneous editing. Use the Remote Communication Statistics Editor (Figure 2-8) to
edit or view records in the CommStats database.
2.4.1 The Remote Communication Statistics Editor

Figure 2-8 Remote Communication Statistics Editor
Opening the Remote Communication Statistics Editor
• Click RTU Communication Statistics on the HistoricalDB Edit Menu (Figure 2-1).
The following table provides descriptions of the fields and buttons on the Remote
Communication Statistics Editor (Figure 2-8).
Table 2-8 Fields and Buttons on the Remote Communication Statistics Editor
Remote: This field contains the name of the remote. Click the arrow to the right of this
field to open a select dialog box, which allows you to select a remote record.
Connection: This field contains the name of the connection. Click the arrow to the right of
this field to open a select dialog box, which allows you to select a connection
record.

Table 2-8 Fields and Buttons on the Remote Communication Statistics Editor
Start Time: Acting as a filter, this field specifies the start time of the time interval shown in
the Time column.
End Time: Acting as a filter, this field specifies the end time of the time interval shown in
the Time column.
Add Click this button to add a new record to the CommStats database. Refer to The
Timeline Edit Dialog Box (Section 2.2.1.2).
Filter Clicking this button displays data values on the Remote Communication Statis-
tics Editor (Figure 2-8) that are filtered according to the Remote: or Connec-
tion: field entries and the Start Time: and End Time: field entries.
The following table describes the column headings that appear on the Remote
Communication Statistics Editor (Figure 2-8).
Table 2-9 Column headings on the Remote Communication Statistics Editor
Column Heading Description

Time Time at which the data was recorded
Remote Name of remote that is using the connection.
Connection Name of connection used by the remote
Success Number of successful communications for the defined time period
Failure Number of unsuccessful, or failed, communications for the defined time
period
Throughput Percentage of communications that were successful for the time period
No Reply Number of messages sent from the host that did not receive replies from
the remote
Checksum Fail Number of communication that failed because of a security error
received at the host
Long Message Number of messages received that were no longer expected
Short Message Number of messages received that were shorter than expected
Wrong Remote Number of communications that failed because they were from the
wrong remote
Offline Number of communications that failed because the remote was offline
SBO Relay Fail Number of communications that were unsuccessful because the SBO
(Select Before Operate) command failed at the relay stage
Config Error Number of communications that failed because there was a configura-
tion error at the host
Off Scan Number of communications that failed because the remote was off scan
Illegal Message Number of communications that failed because an illegal message was
received from the remote (for example, an invalid point address with a
remote or an illegal protocol function code)
SBO Select Fail Number of communications that were unsuccessful because the SBO
(Select Before Operate) command failed at the selection stage
Line Fail Number of communications that were unsuccessful because the line
failed

2.4.1.1 The Communication Statistics Edit Dialog Box

The Communication Statistics Edit dialog box (Figure 2-9) is used to add or modify record
values in the CommStats database.
Figure 2-9 Communication Statistics Edit dialog box
Opening the Communication Statistics Edit dialog box
• Click Add on the Remote Communication Statistics Editor (Figure 2-8).
Refer to Column headings on the Remote Communication Statistics Editor (Table 2-9) for
descriptions of the fields that appear on the Communication Statistics Edit dialog box
(Figure 2-9). Wherever slight variations in the way the fields are named occur, refer to the
following equivalence table:
Field on the Communication Statistics Field on the Remote Communication

Edit dialog box (Figure 2-9) Statistics Editor (Figure 2-8)
#Succeeded: Success
#Failed: Failure
DB Error: Config Error
Line Failure: Line Fail

2.4.1.2 Adding New Records to the CommStats Database

Adding a new record to the CommStats database
1 Open the Remote Communication Statistics Editor (Figure 2-8).

2 Click Add to open the Communication Statistics Edit dialog box (Figure 2-9). Refer to
The Communication Statistics Edit Dialog Box (Section 2.4.1.1).
3 Type or select the remote.
4 Type the time. This value should be the start of an hour; otherwise, an error message
appears.
5 Type or select the connection.
6 Type any appropriate field entries.
7 Click Add.
8 Click Dismiss.
2.4.1.3 Modifying CommStats Database Records

Modifying a record in the CommStats database
1 Click the row header of the record on the list displayed on the Remote Communication
Statistics Editor (Figure 2-8) to open the Communication Statistics Edit dialog box
(Figure 2-9). Refer to The Remote Communication Statistics Editor (Section 2.4.1).
2 Type or select the remote.
3 Change field entries that need to be changed.
4 Click Modify.
5 Click Dismiss.
NOTE When Modify is available, the Remote:, Time:, and Connection: fields are not
available, which indicates that these fields cannot be modified.
2.4.1.4 Filtering Data Displayed on the Remote

Communication Statistics Editor
Filtering the list displayed on the Remote Communication Statistics Editor
1 Open the Remote Communication Statistics Editor (Figure 2-8).

2 If filtering by remote, type or select the remote name. Otherwise, leave it blank.
3 If filtering by connection, type or select the connection name. Otherwise, leave it
blank.
4 If filtering by time, type the start time and end time.

NOTE If only one of these time values is specified, a message box appears stating that
both values are required. If both fields are left blank, the default values are applied. The
default for End Time: is the last time the Remote Communication Statistics Editor
(Figure 2-8) was opened; the default for Start Time: is three hours earlier than the
default end time.
5 Click Filter.
2.5 The Connection Statistics Editor

The Connection Statistics Editor (Figure 2-10) displays relevant connection statistics. The
displayed data is a reflection of the ConnPeriodStats table in the CommStats database.
Figure 2-10 Connection Statistics Editor
Opening the Connection Statistics Editor
• Click Communication Line Statistics on the HistoricalDB Edit Menu (Figure 2-1).
Filtering the data displayed on the Connection Statistics Editor
1 Open the Connection Statistics Editor.

2 Type or select the connection.
3 Type the start date and end date of the statistics to display.

The following table provides a brief description of each of the items that appear on both
the Connection Statistics Editor (Figure 2-10) and the Connection Statistics Edit dialog box
(Figure 2-11).
Table 2-10 Fields and Buttons on the Connection Statistics Editor
Connection: This fields contains the name of the connection
Start Date: Acting as a filter, this field specifies the start date of the time/date interval
shown in the Time column
End Date: Acting as a filter, this field specifies the end date of the time/date interval
shown in the Time column
Add Clicking this button opens the Connection Statistics Edit dialog box
(Figure 2-11).
Filter Clicking this button filters the data displayed on the Connection Statistics Edi-
tor (Figure 2-10) according to the Connection:, Start Date:, and End Date:
entries.
Table 2-11 Column headings on the Connection Statistics Editor
Item Description
Time Time data was collected/recorded
Connection Name of the connection
Good Message Number of remote messages processed successfully
Bad Message Number of remote messages that failed
Throughput percentage of successful connections for the time period
Conn None Number of times that there was no connection
Connected Number of times that a connection was established
Connecting Number of times that a connection was attempted
Conn Fail Number of times that a connection failed
Conn Error Number of connection errors
Conn Retry Number of times connection was retried
Poll Cycle Number of poll cycles
Off Line Number of times that the line was found to be offline when
connection was attempted
DB Error Number of database errors
Modem Unavail Number of times that the modem was unavailable for connec-
tion
Modem Reserve Number of times that a modem reservation request was
granted
Modem Hangup Number of times the modem hung up before a connection was
completed
Tx Error Number of system-level transmission errors
Tx Short Number of times that some of the bytes in a message were not
transmitted
Rx Error Number of system-level reception errors

Table 2-11 Column headings on the Connection Statistics Editor (Continued)
Item Description
Rx Short Number of times that some of the bytes in a message were not
received.
Rx None Number of times that no message was received
Normal Number of good connection sequences
2.5.1 The Connection Statistics Edit Dialog Box

The Connection Statistics Edit dialog box (Figure 2-11) provides a detailed look at a
particular connection. It also allows you to add or update records in the ConnPeriodStats
table in the CommStats database.
NOTE Some of the fields that appear on the Connection Statistics Edit dialog box
(Figure 2-11) also appear as column headings on the Connection Statistics Editor
(Figure 2-10). For a description of each of the fields on the Connection Statistics Edit
dialog box (Figure 2-11), refer to Column headings on the Connection Statistics Editor
(Table 2-11).

Figure 2-11 Connection Statistics Edit dialog box
Opening the Connection Statistics Edit dialog box (to modify)

The Connection Statistics Edit dialog box (Figure 2-11) is opened for a particular connection.
1 Open the Connection Statistics Editor.

2 Click the row header that corresponds to the connection. This opens the Connection
Statistics Edit dialog box (Figure 2-11) with a Modify button.
Opening the Connection Statistics Edit dialog box (to add)
1 Open the Connection Statistics Editor. Refer to The Connection Statistics Editor
(Section 2.5).

2 Click Add. This opens the Connection Statistics Edit dialog box (Figure 2-11) with an
Add button.


MODULE 3
Data Collection and Data

Summary
The collection of some types of data (such as event messages and communication statistics)
and their transfer into HistoricalDB is performed automatically. However, the collection of
data from analog, rate, remote, and status tables can be configured.
3.1 The Collection Entry Dialog Box

Data collection into HistoricalDB is configured through the Collection Entry dialog box
(Figure 3-1). Through this dialog box, you can select the fields (of the point) from which to
collect data. These fields are referred to as “fields on collect.”
Figure 3-1 Collection Entry dialog box
Opening the Collection Entry dialog box
• Click Historical... on the Analog Edit dialog box, Rate Edit dialog box, Remote Edit dia-
log box, or Status Edit dialog box . For information on these dialog boxes, refer to the
RealTime Services Configuration and Administration Reference.

The Collection Entry dialog box (Figure 3-1) displays a list of fields (of a point) from which
data is currently collected. These fields are described in Fields and Other Items on the
Collection Entry Dialog Box (Table 3-1).
Table 3-1 Fields and Other Items on the Collection Entry Dialog Box
Field/Button/
Column Name Description
Description This column lists a description of each of the point’s fields from which data is
collected.
Collect Type This column lists the collection type that is used to collect data from the
point.
Column This column lists the names of the point’s fields from which data is collected.
Name: This contains the name of the point’s field from which to collect data. Click
the arrow beside the Name: field to open the Collect Select dialog box
(Figure 3-2), which allows you to choose the point’s field from which to col-
lect data. Refer to The Collect Select Dialog Box (Section 3.1.1).
Collection Type: The collection type can be one of the following:
• sample (Data is collected at periodic intervals. Choosing this type acti-
vates the fields associated with Collect Every:.)
• offline (Data is not collected. This setting can be used to stop collecting
data temporarily from the point without losing other settings.)
• exception (Data is collected only when there is a significant change.
Choosing this type activates the Deadband: field.)
Collect Every: This field contains the collection interval, if data is collected at set intervals
(i.e. Collection Type: is set to sample). For example, to collect every half
hour, enter 30 and minute. The interval must be between one minute and
60 minutes (inclusive) and must divide the hour evenly (for example: one
minute, five minutes, six minutes, 20 minutes, etcetera). The Collect Every:
fields cannot be set beyond an hour.
Deadband: The deadband indicates the amount by which the acquired value must
change from the previous value before a new value is collected and then sent
to HistoricalDB. This field is available if Collection Type: is set to exception.
Data collection by exception applies to curval, cursta and currate only. There-
fore, the reported data is always in engineering units (EGU). Reporting for
analog and rate points from the remote uses a different deadband, which is
discussed in the RealTime Services Configuration and Administration Refer-
ence. The collection deadband resides in the host and is defined in raw units.
For example, a deadband value of 10 means that only values that are at least
10 raw counts higher or lower than the last value sent to HistoricalDB are
transferred. The deadband must be a positive value.
Enable Summary For each collect point, summarization of data in the timeline and accum data-
bases is enabled by selecting the Enable Summary check box. Refer to Data
Summary (Section 3.3).
Fast Trend only Select this checkbox to collect up to 200 realtime values within a circular
(no data to histo- buffer; it also collects a sample at the top of the hour. This is only supported
rian) for collect-by-exception and summary is not supported.
3.1.1 The Collect Select Dialog Box

The Collect Select dialog box (Table 3-2) allows you to choose the point’s field from which
to collect data.

Module 3 - Data Collection and Data Summary 3-3
Figure 3-2 Collect Select dialog box
NOTE Clicking a row entry on the Collect Select dialog box (Figure 3-2) automatically
loads the Name: field of the Collection Entry dialog box (Figure 3-1).
3.1.2 Data Collection by Exception

Data is collected by exception (i.e. Collection Type: in the Collection Entry dialog box
(Figure 3-1) is set to exception), only if any of the following is true:
• The value has increased or decreased by an amount greater than or equal to the
value in the Deadband: field (which cannot be a negative number).
• The data’s quality status has changed. Refer to Data quality status (Table 2-3).
• The time is the start of the hour.
Collecting data on an exception basis usually requires less disk space. (Collecting data by
exception from RealTimeDB into HistoricalDB is similar to, but independent of, reporting
data by exception from RTUs into RealTimeDB as discussed in the RealTime Services
Configuration and Administration Reference.
NOTE Regardless of whether data from a point is set to be collected periodically or by

exception, data is collected from the point at least once an hour, at the start of the
hour.
3.2 Configuring Collect Points

Configuring a new collection entry
A collection entry can be configured for an analog, rate, remote, or status record. Refer to Fields
and Other Items on the Collection Entry Dialog Box (Table 3-1) for more information.
1 Open the appropriate Collection Entry dialog box (Figure 3-1).

2 Click the arrow next to the Name: field to open the Collect Select dialog box
(Figure 3-2).

3 Select a field by clicking a row entry. This automatically loads the selected field into the
Name: field on the Collection Entry dialog box (Figure 3-1).
4 Select the collection type.
• Select sample to collect data at periodic intervals.
• Select offline to temporarily stop collecting data.
• Select exception to collect data only when there is a significant change.
5 If Collection Type: is set to sample, type the collection interval in the Collect Every:
field.
6 If Collection Type: is set to exception, type in the Deadband: field the amount by which
the acquired value must change before a new value is collected.
7 Select Enable Summary if required.
8 Click Add.
Configuring an existing collection entry

A collection entry can be configured for an analog, rate, remote, or status record. Refer to Fields and
Other Items on the Collection Entry Dialog Box (Table 3-1) for more information.

2 Select the collection entry by clicking the row header of the field. It should be
displayed on the Collection Entry dialog box (Figure 3-1).
3 Perform the necessary changes.
4 Click Modify.
Deleting a collection entry

A collection entry may exist for an analog, rate, remote, or status record. Refer to Fields and Other
Items on the Collection Entry Dialog Box (Table 3-1) for more information.

2 Select the collection entry by clicking the row header of the field.
3 Click Delete.
Other Tasks
Refer to the Guía de Navegación Estándar e Información de Configuración for more
information on the following tasks:
• Modifying a collection entry

• Abandoning changes made to a collection entry
3.3 Data Summary

Summarization of data is performed in both the timeline and accum databases. Data
summary can be done for each point on collect. For more information, refer to Configuring
Collect Points (Section 3.2) and the RealTime Services Configuration and Administration
Reference.
At the start of each hour, data collected in the RealTimeDB collect table is examined and
the following are determined:
• The current value

• The maximum value that is reached during the hour

Module 3 - Data Collection and Data Summary 3-5
• The minimum value that is reached during the hour

• The average rate for the hour, if the Enable Averages check box is selected on the
Rate Averages & Integration dialog box (refer to the RealTime Services Configura-
tion and Administration Reference).
Timestamps and the data quality status of collected values are also recorded. These are
stored in the hour table of the timeline database. For the average, the data quality status
is the highest-precedence status over the hour. For example, an alarm (A) status is
considered a higher-precedence status than manual (M). Refer to Data quality status
(Table 2-3).
Similarly, at the start of each hour, data in the hour table of the timeline database is
examined and the following are determined:
• The current value

• The maximum value that is reached during the day
• The minimum value that is reached during the day
• The average rate for the day, if the Enable Averages check box is selected on the
Rate Averages & Integration dialog box (refer to the RealTime Services Configura-
tion and Administration Reference).
Timestamps and the data quality status of these values are also recorded. These are then
stored in the day table of the timeline database. A new day record is created as soon as the
day starts. The day record is also updated each hour.
Similarly, at the start of each day, the hour data is examined and the summaries in the
month table of the timeline database are updated. Also, the month data is examined and
the summaries in the year table of timeline database are updated. (As with day records, a
new month and year record are created as soon as the month or year starts. These are also
updated daily.)
Enabling data summary for a collect point

The following procedure enables summarization of data in the timeline database for a collect point.
1 Open the Collection Entry dialog box (Figure 3-1).

2 Type or select the name of the point.
3 Select a field entry from Fields Already on Collect - Select to Modify.
4 Select Enable Summary.
Enabling data summary for a rate collect point

The following procedure enables summarization of data in the accum database for a rate collect
point.
1 Open the Rate Edit dialog box. For more information, refer to the RealTime Services
Configuration and Administration Reference.
2 Type or select the name of the rate record for which data is summarized.
3 Click Averages & Integration... to open the Rate Averages & Integration dialog box
(refer to the RealTime Services Configuration and Administration Reference).
4 Select Enable Integrations.

Once data summary in the accum database is enabled, the hourly, daily, monthly, and
yearly integrated accumulator counts (or volumes) are updated. Updates are done at
the start of each hour.

MODULE 4
Historical Application
Installation Tool
The Historical Application Install Tool (Figure 4-1) is designed to assist the system
integrator or system administrator in installing RDBMS-resident parts of the OASyS DNA
HistoricalDB. It enables the user to install global server settings, which OASyS DNA expects
the Historical server to possess. This tool also aids in installing individual applications or in
upgrading existing applications.
Figure 4-1 Historical Application Install Tool
NOTE There are three phases involved in setting up the Historical component of OASyS
DNA: planning, hardware setup, and software installation. The Historical Application
Install Tool (Figure 4-1) provides assistance during the software installation phase.

Opening the Historical Application Install Tool
1 On your local disk, navigate to Program Files > Telvent > bin.
2 Double-click HDBIntallTool.exe.
The following table lists the fields, buttons, and tabs that appear on the Historical
Application Install Tool (Figure 4-1).
Table 4-1 Items on the Historical Application Install Tool
Item Description
Server: This field contains the name of the active SQL server to which the
application connects. The drop-down list contains the names of
known SQL servers that are visible on the network.
Configuration File: This field specifies the server configuration file. Selecting a configu-
ration file enables the Application, Server Cfg, and Error tabs.
Refer to Application Sequence Files (Section 4.2.1) and Application
Suite Files (Section 4.2.2).
Installation Configuration This displays all the application SQL script files, which describe base-
Directories line application databases. It also displays all the server SQL script
files, which describe MSSQL databases such as model, master,
temp, etcetera. Refer to Directory Structure (Section 4.3).
Set Directories This allows you to select a configuration directory. Refer to Direc-
tory Structure (Section 4.3).
Install All Clicking Install ALL initiates a full Historical installation. The Histor-
ical Application Install Tool (Figure 4-1) ignores individual selections
that are made. Server configuration elements are processed first
followed by application elements under the Application tab. Refer
to The Full Historical Installation Option (Section 4.4).
Application This tab is used to manage selective application upgrades. For more
information, refer to SQL Application Definition (Section 4.1) and
Historical Application Definition (Section 4.2).
Server Cfg This tab is used to manage selective global setting upgrades. Refer
to Selective Application Installation (Section 4.5).
Error This tab contains a copy of the errors that are encountered during
the installation process.
Install Selected Clicking this button installs the selected application and server
upgrades. Refer to Selective Application Installation (Section 4.5).
4.1 SQL Application Definition

In order to understand the behavior of the Historical Application Install Tool (Figure 4-1), it
is necessary to explain how the OASyS DNA environment organizes the RDBMS-resident
application pieces.
In general, application components that reside in the RDBMS are one of the following:
• Schema definition (tables, indexes, etcetera)

• Views and other user visible presentations of the schema
• Stored procedures

Module 4 - Historical Application Installation Tool 4-3
• Raw data that is used to initialize the application tables
For a reasonably complex application, break up these aspects of the application into
individual files. A construct called the applications sequence file (*.seq) is provided to allow
developers to specify the order in which individual files are loaded. This file is an ordered
list of the SQL files that describe the application.
Dependencies may exist between applications. This means that there is an order in which
applications must be loaded into the RDBMS. The application suite file (*.ste) is an ordered
list that specifies the order in which individual applications are installed.
The Historical Application Install Tool (Figure 4-1) reads and uses the applications sequence
and application suite files to construct the tree view that is shown on the Application tab.
4.2 Historical Application Definition

This section describes the files that application developers must use to define their RDBMS-
resident application pieces for the Historical Application Install Tool (Figure 4-1).
There are two levels of application grouping that application you must provide. One of
these is applications sequence, which defines the order of loading of the SQL scripts that
define an application. The other is the application suite, which defines an application with
respect to the other applications on which it depends.
4.2.1 Application Sequence Files

An application consists of various SQL script files. Application sequence files allow you to
specify the order in which these script files are loaded. The application sequence files also
provide a means of organizing the script files into groups that are more intuitively obvious
when examined using the Historical Application Install Tool (Figure 4-1).
Application sequence files always contain the suffix .seq.
Syntax Elements of an Application Sequence File (Table 4-2) describes the elements of
application sequence files.
Table 4-2 Syntax Elements of an Application Sequence File
Element Description
Comment Lines Any line that starts with a #
Group Header A line containing simple text bounded by square brack-
ets [ ]
SQL File Name A line containing a text specification of an SQL Script
file name
Blank lines are allowed but ignored.
The following is an example of an application sequence file.
###################################################################
# archive.seq:
# This is the application sequence file for archive. It specifies
# the order in which the SQL script files of archive should be
# loaded. The SQL script files are organized into different groups t
# that are more intuitively obvious when examined in the Historical

# Application Install Tool browser.

#
###################################################################
[Tables]
archive\tables\XIS_TBL_Archive.sql
[Procedures]
archive\procs\XIS_PRC_Archive.sql
[Data]
archive\data\XIS_DAT_Archive.sql
4.2.2 Application Suite Files

Application suite files specify the order in which application sequence files are processed.
These files always end with the suffix .ste.
NOTE For global server configuration, the file suffix “.svr” denotes that the file con-
tains server configuration information.
Application Suite files consist of the following syntax elements:
Table 4-3 Syntax Elements of an Application Suite File
Element Description
Comment Line • Any line that begins with a #
• Comment lines are ignored when Application Suite files are pro-
cessed.
Application Definition Line The application definition line has the following basic structure:
[<Application Name>] <white space><Application Sequence File Spec>
Where:
• <Application Name> is arbitrary text that is displayed on the tree-
view browser. The [ ] provides boundaries to the name.
• <white space> is any sequence of spaces and tabs.
• <Application Sequence File Spec> provides the name and location
of the sequence file for the application.
Blank lines are allowed, but are ignored.
The following is an example of an application suite file.
###################################################################
# Baseline.ste:
# This is the baseline Historical application suite file. It
# specifies the order in which application sequence files should be # pro-
cessed when installing the baseline applications.
#
###################################################################
[Archive] archive\archive.seq
[Accum] accum\accum.seq
[XOSApp] xosapp\xosapp.seq
[CommStats] commstats\commstats.seq
[Event]event\event.seq
[Timeline] timeline\timeline.seq
[Replication] replication\rep.sql

4.3 Directory Structure

Historical Application Install Tool (Figure 4-1) requires the following directory structure:
• Config\applicationsql\{application}\{subdirs for SQL Scripts}

The application suite file (.ste) should be in the applicationsql folder. All the
sequence files (.seq) listed under the .ste file will be in the specific application
folder.
• Config\serversql\{group}\{subdirs for SQL Scripts}
The global server configuration file (.svr) should reside in this directory. All the
sequence files listed in the .svr file will be under this directory.
A project may have a different configuration directory. For example,
• GMS\Config\application
• GMS\Config\serversql
The Historical Application Install Tool (Figure 4-1) uses the baseline configuration
directory, which is defined in the XIS_CONFIG registry as the default installation
configuration directory. If your project uses a different directory, add the XIS_CONFIG
registry so that it appears under the Installation Configuration Directories list.
4.4 The Full Historical Installation Option

If you choose to perform a full Historical installation, the Historical Application Install Tool
(Figure 4-1) ignores all individual selections that are made using the Application and
Server Cfg tabs. Server configuration elements are processed first, followed by the
installation of application elements under the Application tab.
All errors that are encountered are written to the HistoricalInstall.log under the
directory defined in the XIS_ERRLOG registry. Click the Error tab to review the errors.
Before doing a full Historical Application installation, you must do the following:
• Install the RDBMS server on the target machine.

• Update (or create) the xis_install.cfg file as described in System-Specific Con-
figuration (Section 4.6).
Performing Full Historical Installation
1 Open the Historical Application Install Tool (Figure 4-1).

2 Select the target server from the Server: drop down list.
3 Select the appropriate configuration file. If you know the location of this file, type
this in the Configuration File: field. If you don’t know the precise location of the file,
click the “...” button to open a file browser dialog box that allows you to navigate to
the file.
NOTE The default directory that is displayed when you click the “...” button is Tel-
vent\DNA\Historical\config\.

If your project has a different configuration directory, click Set Directories to select the
directory.
WARNING Make sure that the baseline directory is the first element in the Installation
Configuration Directories list. This is because baseline applications should be installed
first, followed by any project specific applications.
4 Click the Server Cfg tab. The right hand side of the tab should display the contents of
the file entered in the Configuration File: field.
5 Click Install XIS.
6 When the “complete” message box appears, acknowledge it.
7 Select the Error tab to examine any errors that occurred during the installation.
4.5 Selective Application Installation

The Historical Application Install Tool (Figure 4-1) is used either to install a complete
application or to upgrade parts of an application. An entire application may need to be
installed as part of recovery from a catastrophic disk failure. Partial or selective application
installation is more commonly required for upgrading or installation software patches.
Selecting the Application tab reveals a tree view that shows the applications suites and the
constituent applications. Expanding each leaf of the tree exposes more details down to the
lowest available level of the individual SQL script files.
Beside each node of the tree is a checkbox. Selecting a checkbox instructs the installer to
process the corresponding node and all of its children.
CAUTION If you click the Install All button, everything is processed regardless of the
selections made on the Application tab.
CAUTION By selecting individual components, any order of dependency described by

the application definition files is no longer guaranteed. You must determine if the piece
you are installing depends on changes in files that should also be installed.
Performing Selective Application Installation
1 Open the Historical Application Install Tool (Figure 4-1).

2 Select the target server from the Server: drop down list.
3 Select the appropriate configuration file. If you know the location of this file, type this
in the Configuration File: field. If you don’t know the precise location of the file, click
the “...” button to open a file browser dialog box that allows you to navigate to the
file.

If your project has a different configuration directory, click Set Directories to select
the directory.
4 Select the Application tab.

5 Open the application suites and application sub-trees until you find the application or
component to be installed.
6 Select the checkbox that corresponds to the application or component.
7 Repeat steps 5 and 6 until you have selected all of the application components that
need to be installed.
8 Click Install Selected.
9 When the message box appears, acknowledge it.
10 Select the Error tab to examine any errors that occurred during the installation.
4.6 System-Specific Configuration

The server configuration file contains information defining Historical application
databases. This information includes the sizes of the databases and the locations of each
database’s data files and log files.
NOTE Different systems may have different configuration files. These files usually
reside in the config directory. Ensure that you are selecting the right file for the
installation tool.
The server configuration file is a SQL script file that is written using SQL 92 with either
Transact-SQL (Sybase) or T-SQL (Microsoft) extensions applied.
The following is a baseline configuration file example.
==================================================================
-- Historical_install.cfg : Configuration file used for Historical
-- installation. It defines baseline required Historical
-- Databases.
==================================================================
==================================================================
-- accum Database definition.
==================================================================
-- Drop existing database
==================================================================
drop database accum
go
==================================================================
=
-- Create new database
==================================================================
=
create database accum
on primary
(name = accum_Data,
filename = 'C:\XIS DATA\XISDisk1\MSSQL\accum_Data.mdf',
size = 31MB,
maxsize = 31MB,
filegrowth = 0)

log on
(name = accum_Log,
filename = 'C:\XIS DATA\XISDisk2\MSSQL\accum_Log.ldf',
size = 3MB,
maxsize = 3MB,
filegrowth = 0)
go
exec sp_dboption 'accum', 'autoclose', 'false'
go
exec sp_dboption 'accum', 'select into/bulkcopy', 'false'
go
exec sp_dboption 'accum', 'trunc. log on chkpt.', 'true'
go
===================================================================
-- xosapp Database definition.
===================================================================
===================================================================
===================================================================
drop database xosapp
go
===================================================================
===================================================================
create database xosapp
on primary
(name = xosapp_Data,
filename = 'C:\XIS DATA\XISDisk1\MSSQL\xosapp_Data.mdf',
size = 7MB,
maxsize = 7MB,
filegrowth = 0)
log on
(name = xosapp_Log,
filename = 'C:\XIS DATA\XISDisk2\MSSQL\xosapp_Log.ldf',
size = 2MB,
maxsize = 2MB,
filegrowth = 0)
go
exec sp_dboption 'xosapp', 'autoclose', 'false'
go
exec sp_dboption 'xosapp', 'select into/bulkcopy', 'false'
go
exec sp_dboption 'xosapp', 'trunc. log on chkpt.', 'true'
go
==================================================================
-- archive Database definition.
==================================================================
==================================================================
==================================================================
drop database archive
go
==================================================================

==================================================================
create database archive
on primary
(name = archive_Data,
filename = 'C:\XIS DATA\XISDisk1\MSSQL\archive_Data.mdf',
size = 21MB,
maxsize = 21MB,
filegrowth = 0)
log on
(name = archive_Log,
filename = 'C:\XIS DATA\XISDisk2\MSSQL\archive_Log.ldf',
size = 10MB,
maxsize = 10MB,
filegrowth = 0)
go
exec sp_dboption 'archive', 'autoclose', 'false'
go
exec sp_dboption 'archive', 'select into/bulkcopy', 'false'
go
exec sp_dboption 'archive', 'trunc. log on chkpt.', 'true'
go
==================================================================
-- CommStats Database definition.
==================================================================
==================================================================
==================================================================
drop database CommStats
go
==================================================================
==================================================================
create database CommStats
on primary
(name = CommStats_Data,
filename = 'C:\XIS DATA\XISDisk1\MSSQL\CommStats_Data.mdf',
size = 512MB,
maxsize = 512MB,
filegrowth = 0)
log on
(name = CommStats_Log,
filename = 'C:\XIS DATA\XISDisk2\MSSQL\CommStats_Log.ldf',
size = 100MB,
maxsize = 100MB,
filegrowth = 0)
go
exec sp_dboption 'CommStats', 'autoclose', 'false'
go
exec sp_dboption 'CommStats', 'select into/bulkcopy', 'false'
go
exec sp_dboption 'CommStats', 'trunc. log on chkpt.', 'true'
go
==================================================================
=

-- event Database definition.

===================================================================
===================================================================
===================================================================
drop database event
go
===================================================================
===================================================================
create database event
on primary
(name = event_Data,
filename = 'C:\XIS DATA\XISDisk1\MSSQL\event_Data.mdf',
size = 512MB,
maxsize = 512MB,
filegrowth = 0)
log on
(name = event_Log,
filename = 'C:\XIS DATA\XISDisk2\MSSQL\event_Log.ldf',
size = 52MB,
maxsize = 52MB,
filegrowth = 0)
go
exec sp_dboption 'event', 'autoclose', 'false'
go
exec sp_dboption 'event', 'select into/bulkcopy', 'false'
go
exec sp_dboption 'event', 'trunc. log on chkpt.', 'true'
go
===================================================================
-- timeline Database definition.
===================================================================
===================================================================
===================================================================
drop database timeline
go
===================================================================
===================================================================
create database timeline
on primary
(name = timeline_Data1,
filename = 'C:\SQL Data\SQLDisk3\MSSQL\timeline_Data.mdf',
size = 8GB,
maxsize = 8GB,
filegrowth = 0),
(name = timeline_Data2,
filename = 'C:\XIS DATA\XISDisk4\MSSQL\timeline_Data.mdf',
size = 8GB,
maxsize = 8GB,
filegrowth = 0)
log on

(name = timeline_Log,
filename = 'C:\XIS DATA\XISDisk2\MSSQL\timeline_Log.ldf',
size = 2GB,
maxsize = 2GB,
filegrowth = 0)
go
exec sp_dboption 'timeline', 'autoclose', 'false'
go
exec sp_dboption 'timeline', 'select into/bulkcopy', 'false'
go
exec sp_dboption 'timeline', 'trunc. log on chkpt.', 'true'
go
==================================================================


MODULE 5
Historical Replication
This module describes the implementation of Historical Replication for OASyS DNA based
on Microsoft SQL Server 2000. The replication architecture that is described here has been
implemented and verified with respect to baseline requirements. Where project-specific
customizations are at issue, and for full details of specific issues, consult the SQL Server
Books Online supplied and installed with the MS SQL Server product.
While the MS SQL Server allows both data and database objects to be replicated, OASyS
DNA uses MS Replication for data only. Baseline replication is also configured to run
continuously, as opposed to being intermittently synchronized at specific times/intervals.
This is based on the assumption that source and destination will generally be in constant
contact, and that potential outages of either partner are unlikely to exceed the inherent
buffering capabilities of the MS SQL Server.
5.1 MS SQL Replication Components and

OASyS DNA Mapping
Microsoft SQL Server Replication is based on a “publishing industry”, where individual
applications are made available to interested parties in the form of “publications”. Other
systems then “subscribe” to these publications. The components that are involved in the
replication process are briefly discussed in the following sections. For more details, refer to
the SQL Server Books Online.
5.1.1 Replication Types

MS SQL Server supports three types of replication. Of these three, Merge replication is the
type used to replicate OASyS DNA historical data.
5.1.1.1 Snapshot Replication

Snapshot replication requires a coherent copy of selected data at an alternate location. It is
specific with respect to time. It offers no incremental update capability apart from a
complete regeneration of data. This type of replication is most appropriate to situations
where a read-only copy of (limited) data will suffice. However, snapshot replication is
inherent to the other MS replication types; it is used for synchronization initialization of
entities that are replicated between two locations.
5.1.1.2 Merge Replication

Merge replication provides for the bi-directional replication of data that may be created or
updated at either of the two related data sources. It exhibits acceptable throughput and

update lag times. It also provides adequate conflict resolution of incompatible concurrent
updates.
5.1.1.3 Transactional Replication

Available only for MS SQL Server installations on Windows 2000 Server platforms,
Transactional replication is particularly appropriate when transactional consistency is the
main concern. Apart from the overhead of initial snapshot generation, transactional
replication has been found to be extremely efficient and well suited for highly active
database tables. However, it is unidirectional: it replicates only those changes that are
applied at the source. Also, of the three replication types, it is the most sensitive to the
effects of connection interruption.
5.1.2 Globally Unique Identifiers

Merge replication and, under specific circumstances, snapshot and transactional replication
require that a uniqueidentifier field/column exist in all tables to be replicated. This SQL
data type maps directly to the Windows 2000 GUID (Globally Unique IDentifier), and is used
in synchronization and conflict resolution. When required, transactional replication expects
the unique identifier field to be named msrepl_tran_version. The MS SQL Server
arbitrarily adds a suitable field (if not already present) when replication entities are
defined. Consequently, to mitigate the potential confusion of this inevitable schema
modification, OASyS DNA baseline tables include a GUID field/column, making them
replication-ready from the outset. Further, assigning the name msepl_tran_version to all
such fields not only prepares the tables for merge replication, but also for transactional
replication requirements, should the need ever arise.
5.1.3 Publications and Articles

Publication is the term used to describe a logical grouping of data designated for replication.
Publications are further subdivided into units of Articles. HistoricalDB databases are mapped
to publications and associated HistoricalDB tables are mapped as articles of the
publications.
With the exception of the archive database, which is considered highly specific to each
machine, a publication is defined for each HistoricalDB database, and all dependent tables
are defined as articles. HistoricalDB tables are configured to be replicated in their entirety.
5.1.4 Publishers
A Publisher is an MS SQL Server instance that has been designated to serve as the source of
replicated data. Publications and their associated articles are defined in the context of a
publishing server. In fact, the MS SQL Server instance must be formally configured as a
publisher before publications may be defined.
OASyS DNA configures the primary or main Historical server instance as publisher. While
any or all servers may be simultaneously designated as publishers, individual publications
replicated between two specific servers may only be associated with a single publisher.

Module 5 - Historical Replication 5-3
5.1.5 Subscriptions
The association of a publication (representing the replication source) with a destination
(server) is represented by a Subscription. The subscription also designates the method or
type of replication, and frequency/schedule of synchronization.
All baseline HistoricalDB subscriptions are configured as continuous Merge subscriptions,

primarily for flexibility, but also for management consistency. While Snapshot subscriptions
may be suitable for some of the more static tables (such as XOSApp/Notepad), and
Transactional subscriptions a potential choice for others (such as event/summary), the
simplicity inherent in defining and managing a single replication type was preferred after
tests confirmed acceptable performance despite any additional overhead.
5.1.5.1 Push Subscriptions

HistoricalDB replication is configured to use Push subscriptions. With push subscriptions,
the publisher continuously propagates updates at its discretion; an explicit request from
each subscriber is not needed. Also inherent to this subscription type is the fact that the
publisher is configured with a discrete list of defined subscribers. This has the advantage
of centralizing and simplifying performance monitoring and management.
5.1.5.2 Pull Subscriptions

With Pull subscriptions, subscription management is done at the subscriber’s end;
synchronization occurs only at the dictate of the subscriber. Intended for publications that
may have a large number of infrequently connected or mobile subscribers, it has no
immediate application in the current baseline configuration; however, it suggests
advantages that may suit specific project needs.
NOTE Push and pull subscriptions share the requirement that the publisher be aware
of all defined subscribers; collectively, the subscriptions are known as Named Subscrip-
tions.
5.1.5.3 Anonymous Subscriptions

An anonymous subscriber differs from a named subscriber in that it does not need to be
defined to a publisher. (Still, the publisher must explicitly be configured to permit
Anonymous Subscriptions.) The subscriber is responsible for maintaining the necessary
publication and subscription information required to synchronize replication. Anonymous
subscriptions seem to be best suited for applications involving internet access, although it
clearly introduces security concerns. Further investigation of anonymous subscriptions is
necessary before Telvent considers it for baseline use. If Telvent were to implement
anonymous subscriptions, these might best be tied to replicated database copies (i.e.
controlled views). This would ensure that the anonymous subscriptions remain isolated
from source data maintained on the main Historical server.
5.1.5.4 Subscribers as Publishers

A subscriber may simultaneously be designated as publisher serving as “republisher” for
any subscription it maintains. There is also no limitation to the replication type it chooses
when republishing data to other subscribers.

5.1.6 Distributor
An MS SQL Server instance designated as the Distributor oversees replication.
The distributor maintains the replication Distribution database that is appropriate to the
publisher it represents. This distribution database contains the metadata descriptions of all
publications and subscriptions. The distributor also maintains the synchronization history of
its publishers’ publications. In merge replication scenarios, the distributor also serves as the
host for 1) the agent processes that are responsible for ongoing merge activity and for 2)
initial snapshot creation and transfer to designated subscribers. The distributor assumes
more responsibility in the case of transactional replication.
OASyS DNA has configured the main Historical server (an MS SQL Server instance) to serve
both as publisher and distributor. The term “local distributor” is applied to such a model.
MS SQL Server also allows for a publisher that is independent of the distributor (“remote
distributor”), which can be employed in the event that load balancing issues arise.
5.1.7 Replication Agents

In conjunction with the definition/registration of the various replication components (as
discussed in the previous sections of this module), interdependent Agents are created that
actually perform data replication. The number and types of agents, and the MS SQL Server
instance on which they reside, depend on the components and the replication types
defined.
The agents are assigned attributes associated with the replication component to which they
are bound. These complex objects basically represent a batch of job steps that defines their
dedicated purpose. Once defined, replication management generally involves dealing with
(i.e. starting, stopping, or tweaking) these agent “jobs.”
Given that OASyS DNA employs Continuous Merge Replication using Push Subscriptions,
Snapshot Agents (Section 5.1.7.1) and Merge Agents (Section 5.1.7.2) will likely be the only
agents of concern. SQL Server Books Online should be consulted for descriptions of the agents
involved in Transactional Replication (Log Reader, Queue Reader, and Distribution Agents),
and for information regarding the miscellaneous database cleanup agents provided by
default.
The remaining SQL Server Agent, which hosts and schedules the replication agents, and
controls and monitors operations outside the replication domain, is generally transparent
to normal replication operations. This agent is similar to a Job Server, and is not to be
confused with the SQL Server Agent (NT) Service, whose duty it is to transport replication
and other data between MS SQL Servers.
5.1.7.1 Snapshot Agents

Snapshot Agents manage the generation of database snapshots. Typically created at the
distributor, snapshot agents register synchronization information in the distribution
database. There is a distinct agent for each publication.
5.1.7.2 Merge Agents

A Merge Agent is created for every Merge Publication defined. Once the snapshot agent has
produced a snapshot, the merge agents are responsible for applying these initial snapshot
to the subscriber. Another responsibility of the merge agent is the detection and transfer of
updates between publisher and subscriber. While merge agents generally reside at the

publisher when push subscriptions are employed, they nonetheless connect to both servers
to implement their bi-directional responsibilities.
NOTE Merge Agents may be configured to run in one direction only.
5.2 The SQL Server Enterprise Manager

Replication components and associated agents may be configured manually through the
facilities provided by the SQL Server Enterprise Manager, which is installed with MS SQL
Server. The Replication Monitor utility, which monitors the performance and session details
of all replication agents. For more information, refer to the SQL Server Books Online.
Figure 5-1 SQL Server Enterprise Manager
Opening the SQL Server Enterprise Manager
1 Click the Start menu.

2 Point to Programs > Microsoft SQL Server.
3 Click Enterprise Manager.

5.3 Historical Data Replication Configuration

A large portion of baseline historical data replication is pre-configured using the SQL Server
Enterprise Manager (Figure 5-1) and its replication utilities. In baseline, this pre-configured
part is the ReplicationSetup.sql, which is located in Local Disk\Program
Files\Telvent\DNA\Historical\config\applicationsql\replication.
Replicating Baseline Historical Data

The following procedure prepares, sets up, and starts historical data replication between MAINHS1
and BACKSVR. MAINHS1 is both publisher and distributor; BACKSVR is the subscriber.
1 Start the Historical services on both MAINHS1 and BCKSVR. Refer to Starting, Stopping,
or Failing Over Historical Service (Method 1) in Historical Replication (Module 5).
2 Register both MAINHS1 and BCKSVR using the Register SQL Server Wizard.
a On MAINHS1, open the SQL Server Enterprise Manager (Figure 5-1). Refer to Open-
ing the SQL Server Enterprise Manager.
b Right click SQL Server Group, then select New SQL Server Registration. This opens
the Register SQL Server Wizard (Figure 5-2).
Figure 5-2 Register SQL Server Wizard
c Click Next.
d Select a SQL server from the next dialog box that appears. Choose MAINHS1 and
BCKSVR.
e Click Add, then click Next.
f On the Select an Authentication Mode dialog box that appears, select The Windows
account information I use to log on to my computer [Windows Authentication].
g Click Next.
h On the Select SQL Server Group dialog box that appears, select Add the SQL
Server(s) to an existing SQL Server group.

i Select SQL Server Group for the Group name: field.

j Click Next.
k Click Finish on the next dialog box that appears. This completes the SQL server
registration procedure.
3 Setup baseline replication.
a Expand the SQL Server Group under Microsoft SQL Servers root.
b Right-click MAINHS1, then select Connect....
c Open the SQL Query Analyzer (Figure 5-3) as follows: click Start > Program Files >
Microsoft SQL Server, then select Query Analyzer.
Figure 5-3 SQL Query Analyzer
d On the SQL Query Analyzer (Figure 5-3), click File > Open.
e On the Open Query File dialog box that appears, browse or navigate to Local
Disk\Program Files\Telvent\DNA\Historical\config\applicationsql\replication, then
click ReplicationSetup.sql. This loads the replication setup SQL script into the SQL
Query Analyzer.
f Click the green arrow button on the toolbar of the SQL Query Analyzer
(Figure 5-3) to execute ReplicationSetup.sql. This finishes the replication setup.
4 Start the snapshot agents.
a Navigate to Microsof SQL Servers > SQL Server Group > MainHS1 > Replication
Monitor > Agents > Snapshot Agents. Open the Snapshot Agents folder.
b Right click PUBaccum then select Agent Properties.... This opens the Agent
Properties dialog box (Figure 5-4)

Figure 5-4 Agent Properties dialog box
c In the Owner: field, select distributor_admin.

d Click OK. This closes the Agent Properties dialog box (Figure 5-4).
e Right-click PUBaccum, then click Start Agent.
f Repeat steps b to e for the other publications (Pubcommstats, PUBevent,
PUBtimeline, etcetera).
5 Start the merge agents.
a Navigate to Microsoft SQL Servers > SQL Server Group > MainHS1 > Replication
Monitor > Agents > Merge Agents. Open the Merge Agents folder.
b Right-click PUBaccum, then select Agent Properties.... This opens up the Agent
Properties dialog box (Figure 5-4).
c In the Owner: field, select distributor_admin.
d Click OK. This closes the Agent Properties dialog box (Figure 5-4).
e Right click PUBaccum, then click Start Agent.
f Repeat steps b to e for the other publications (Pubcommstats, PUBevent,
PUBtimeline, etcetera).
5.3.1 Viewing Replication Component Properties

The procedures in this section allow you to examine the properties of components, such as
publications and subscriptions, that are involved in historical data replication. For more
information on dialog boxes that are opened, refer to the SQL Server Books Online.
Viewing Baseline Publication Properties
1 Open the SQL Server Enterprise Manager (Figure 5-1).

2 Click Tools > Replication > Create and Manage Publications.... This opens the Create
and Manage Publications dialog box (Figure 5-5).

Figure 5-5 Create and Manage Publications dialog box
3 Expand the database of interest. You should see the publications that are involved.
4 Select the publication.
5 Click Properties and Subscriptions. This opens the Publication Properties dialog box
(Figure 5-6).
Figure 5-6 Publication Properties dialog box

Viewing Publisher and Distributor Properties
1 Open the SQL Server Enterprise Manager (Figure 5-1).

2 Click Tools > Replication > Configure Publishing, Subscribers, and Distribution.... This
opens the Publisher and Distributor Properties (Figure 5-7).
Figure 5-7 Publisher and Distributor Properties
Viewing Snapshot Agent Properties

This procedure assumes that MAINHS1 is both publisher and distributor.
1 On the SQL Server Enterprise Manager (Figure 5-1), navigate to Microsoft SQL Servers
> SQL Server Group > MainHS1 > Replication Monitor > Agents > Snapshot Agents.
2 Open the Snapshot Agents folder.
3 Right click PUBaccum, then select Agent Properties.... This opens the Agent Properties
Viewing Merge Agent Properties

This procedure assumes that MAINHS1 is both publisher and distributor.
1 On the SQL Server Enterprise Manager (Figure 5-1), navigate to Microsoft SQL Servers
> SQL Server Group > MainHS1 > Replication Monitor > Agents > Merge Agents.
2 Open the Merge Agents folder.
3 Right click PUBaccum, then select Agent Properties.... This opens the Agent Properties



MODULE 6
Archiving
Disk space is gradually used up as data is stored in HistoricalDB. To conserve space,

information should be archived if it is not currently in use. Archive scheduling is the
customer’s responsibility and must be configured according to each customer’s individual
requirements. If required, archived information can be dearchived and restored to
HistoricalDB.
An archive device can be installed on the archive host. The historical databases can then be
configured to be archived on the archive device. For the archiving to function properly,
define and set up the designated archive device entries, and then customize the archive
schedule.
6.1 The Archive Process

Archiving is a multi-step process. When archiving is initiated, the data to be archived is
placed in a temporary table. The temporary table is copied to disk and the new file is
copied to an archive file on the archive device. The archive device is configured in the
archive schedule table. An archive file name takes the following form:
system_service_database_table_date.archive_version
where:
system is the name of the local system.
service is the name of the service that contains the archived data; the default value
is Historical.
database is the name of the database that contains the archived data.
table is the name of the table that contains the archived data.
date is the archive date.
version is the version number of the archive, starting with 0. The version number is
incremented if data is re-archived.
NOTE OASyS DNA Services with SQL Servers may be scheduled for archiving data.
A log of the archive is written into the catalog table and the date of the archive is recorded
in the schedule table.
Data is automatically archived when it becomes older than the date specified by the
archive cutoff date set in the archive schedule table. The Schedule Configuration dialog
box (Figure 6-3) is used to set this value. The format of the archive cutoff: field entry

contained in this form is YY:MM:DD. YY, MM, and DD specify the number of years, months,
and days, respectively, that should elapse before the specified data can be archived.
6.1.1 xis_archive
Archiving can be done manually by executing the xis_archive command on the Historical
machine. The archive process first determines which machine is the Historical archive host
(the default is the Historical service on site), and then runs the xis_archive.pl script on that
machine. The Job Scheduler (JSH) is normally configured to execute xis_archive once per day,
usually at a time when the system is not busy. The syntax for xis_archive is:
xis_archive [-h] [-A archive_host] [-options]
where:
-h displays usage information.
- A specifies a host where archive_host is the host where the archive device is located.
If a host is not specified, the primary Historical Service host for the local system is used.
-options are listed in Archive options (Table 6-1)
Archiving data using xis_archive
1 Open a command prompt window on the Historical machine.

2 Type xis_archive [-A archive_host] [-options].
Replace archive_host with the host where the archive device is located. If no archive
host is specified, the default (the local Historical machine) is used. For a list of options,
refer to Archive options (Table 6-1).
3 Press ENTER.
All other options are passed directly onto the archive executable. The options can be
configured within the xis_archive.pl script.
Table 6-1 Archive options
Archive
Option Description
NOTE Running archive -h from a command prompt displays the options described in this
table.
c This catalogs any archives that are sent to the null device (NULL). If this
option is not set, then archives to the null device are not logged in the
catalog. For more information, refer to the description of the device entry
for the archive schedule table.
d level This sets the level of debug message detail between 0 and 6; 0 gives no
message and 6 gives maximum detail.

Module 6 - Archiving 6-3
Table 6-1 Archive options
Archive
Option Description
i interval This speeds up the archiving of the timeline..collect and the event..sum-
mary tables. This is accomplished by doing a bulk copy (bcp) out of small
chunks of data at a time (less than one day); these chunks of data are
later combined into one large bcp file.
The interval, which defaults to 0 and is specified in minutes, indicates the
the time in between archiving batches of collect data. For example:
archive -i 60
The command in the example creates a temporary table with one hour’s
worth of data. The chunks of data that were bulk copied out hourly are
then combined into one large bcp file.
h This displays the archive options.
s service This is the service that hosts the archive database. Default value for ser-
vice is Historical.
t directory This sets the name of the directory for temporary archive files. Default
directory is C:\DOCUMEN~1\dnaAdmin\LOCAL~1\Temp.
m size This sets the maximum amount of disk device space (in megabytes) to be
reserved for operating system administration (for example, for relocating
bad blocks). The default is 10% of the disk, up to a maximum of 25
Megabytes.
It is important that the directory for temporary archive files has sufficient
disk space (10 to 20 Megabytes is recommended). However, this amount of
disk space may not always be available. If sufficient space is unavailable for
the temporary file, the data is not archived, even though space may be
available on the final destination device. Because of this, it is highly rec-
ommended that an alternative directory be provided when running the
archive program.
6.1.2 cmx_archive
Archiving can also be done by executing cmx_archive on the RealTime machine. Calling
cmx_archive runs the cmx_archive.pl script, which locates the archive host then executes
xis_archive. The syntax for cmx_archive is:
cmx_archive [-h] [-A archive_host] [-options]
where:
-h displays usage information.
- A specifies a host where archive_host is the host where the archive device is located.
If a host is not specified, the primary Historical Service host for the local system is
used.
-options are listed in Archive options (Table 6-1)
Archiving data using cmx_archive
1 Open a command prompt window on the RealTime machine.

2 Type cmx_archive [-A archive_host]-options.

Replace archive_host with the host where the archive device is located. If no archive
host is specified, the default (the local Historical Service) is used. For a list of options,
refer to Archive options (Table 6-1).
3 Press ENTER.
6.2 The Archive/Dearchive Edit Dialog Box

The Archive/Dearchive Edit dialog box (Figure 6-1) is used to create, modify, and delete
archive schedule entries.
NOTE Creation of an archive device is performed by Telvent personnel during system

configuration.
Figure 6-1 Archive/Dearchive Edit dialog box
Opening the Archive/Dearchive Edit dialog box
• Click Archive/Dearchive on the DMT.
The following table lists the buttons on the Archive/Dearchive Edit dialog box (Figure 6-1)
and the corresponding actions when these are chosen.
Table 6-2 Buttons on the Archive/Dearchive Edit dialog box
Button Action/Reference
Schedules... Opens the Schedule Summary window
(Figure 6-2)
Add Device Opens the Add Device Editor (Figure 6-7)
Dearchive... Opens the Dearchive window (Figure 6-9)
Initialize Media... Opens the Media Initialization dialog box
(Figure 6-8)
Cleanup Initiates data cleanup; refer to Data Cleanup
(Section 6.4)
Dismiss Closes the dialog box
6.2.1 The Schedule Summary Window

The Schedule Summary window (Figure 6-2) displays a list of archive schedules.

Figure 6-2 Schedule Summary window
Opening the Schedule Summary window
• Click Schedules... on the Archive/Dearchive Edit dialog box (Figure 6-1). For more
information, refer to The Archive/Dearchive Edit Dialog Box (Section 6.2).
The following table provides brief descriptions of the buttons, fields, and column headings
that appear on the Schedule Summary window (Figure 6-2).
Table 6-3 Items on the Schedule Summary window
Item Description
Column Headings
ID# Identification number of the archive schedule
Service Service containing the data to be archived
Database Database containing the data to be archived
Table Table containing the data to be archived
Device Device where the data is to be archived
Archive Cutoff Indicates how old the data must be before it is archived
Last Date Archived Date the data was last archived. If empty, archive has not been
performed.
Delete Cutoff Indicates how old the data must be before it is deleted
Enable Indicates whether or not archive is enabled.

Table 6-3 Items on the Schedule Summary window
Item Description
BCP Format Indicates whether or not data is archived in any special format.
Buttons and Fields
Service Click this to specify the service with which to filter the displayed
information.
Database Click this to specify the database with which to filter the displayed
information.
Table Click this to specify the table with which to filter the displayed
information.
Archive Device Click this to specify the archive device with which to filter the dis-
played information.
Enabled Only Click this to specify that only schedules for which archive is
enabled should be displayed.
Search Click this to search using the enabled filters.
Clear Filters Click this to clear all the field filters.
Add Schedule Click this to open the Schedule Configuration dialog box
(Figure 6-3).
Filtering the information displayed on the Schedule Summary window

Data displayed on the Schedule Summary window (Figure 6-2) can be filtered using one or more of
the provided filters.
1 Click:
• Service to filter using the service name
• Database to filter using the database name
• Table to filter using the table name
• Archive Device to filter using the archive device name
2 Type the appropriate filters in the enabled fields.
3 Click Search.
6.2.1.1 The Schedule Configuration Dialog Box

The Schedule Configuration dialog box (Figure 6-3) is used to create or modify a schedule
entry.

Figure 6-3 Schedule Configuration dialog box
Opening the Schedule Configuration dialog box
1 Open the Schedule Summary window (Figure 6-2).

2 Click the row header of a record on the summary window. This opens the Schedule
Configuration dialog box (Figure 6-3) with its field populated by configuration
information of the record.
Or:
• Click Add Schedule on the summary window. This opens a blank Schedule Configura-
tion dialog box (Figure 6-3). Use this to add a new signal configuration.
The following table provides brief descriptions of the buttons, fields, and column headings
that appear on the Schedule Configuration dialog box (Figure 6-3).
Table 6-4 Fields and Buttons on the Schedule Configuration dialog box
Service: The service that contains the data to be archived.
Database: The database that contains the data to be archived.
Table: The table that contains the data to be archived. The table must have a
column called time (of ultimate data type int), which contains the age
of the associated data as the number of seconds since Jan. 1, 1970
GMT.
Archive Device: The device where data is to be archived. An archive device can only be
modified if it was set initially as the null device, which is the default set-
ting.
Archive Cutoff: This indicates how old the data must be before it is archived. The effect
of this field on the archive process depends on whether the table being
archived is time-based or non-time-based. For more information, refer
to Archive Cutoff (Section 6.2.1.2).
Delete Cutoff: This indicates how old the data must be before it is deleted. Refer to
Archive Intervals (Section 6.2.1.3)

Table 6-4 Fields and Buttons on the Schedule Configuration dialog box
BCP: This indicates whether the data is to be archived in a special format.
The options provided are custom and default. When changed to
custom, the name of the bcp format file must be provided.
Enable If this check box is not selected, the schedule entry appears in the
Schedule Summary window (Figure 6-2), but archive is not performed.
Modify This button is available only if modifying an existing schedule entry.
Click this to save the changes made.
Abandon This button is available only if modifying an existing schedule entry.
Click this to discard any changes made.
Delete This is available only if modifying an existing schedule entry. Click this
to delete the schedule entry.
Add This is available only if adding a new schedule entry. Click this to add
the new schedule entry.
Dismiss Click this to close the dialog box.
Adding a new entry in the Schedule Summary window
1 Open the Schedule Summary window (Section Figure 6-2).

2 Click Add Schedule. This opens the Schedule Configuration dialog box (Section Figure
6-3).
3 Type the name of the service containing the data to be archived.
4 Type the name of the database containing the data to be archived.
5 Type the name of the table containing the data to be archived.
6 Type or select the archive device.
7 Type the archive and delete cutoff.
8 Select Enable if archive is to be performed.
9 Click Add.
Modifying a Schedule Summary window entry

2 Click the row header of the entry to be modified. This opens the Schedule
Configuration dialog box (Section Figure 6-3). Only the Archive Device:, Archive
Cutoff:, and Delete Cutoff: fields are available.
3 Type the changes in the appropriate fields.
4 Click Modify.

Deleting a Schedule Summary window entry

2 Click the row header of the entry to be deleted. This opens the Schedule
Configuration dialog box (Section Figure 6-3).
3 Click Delete. A dialog box appears asking for confirmation before deleting the
schedule entry.
6.2.1.2 Archive Cutoff

For time-based tables, the Archive Cutoff: field indicates how old the data must be before
being archived (time-based tables contain a column named time). The format is YY:MM:DD,
where YY is the number of years old that the data must be, MM is the number of months,
and DD is the number of days. For example, if the current time is 05-Feb-96 14:35 when
archive runs, then the conditions that are indicated in Archive Cutoff sample (time-based)
(Table 6-5) apply.
Table 6-5 Archive Cutoff sample (time-based)
Cutoff Specifier Possible archive up to

00:00:00 05-Feb-96 00:00
00:00:01 04-Feb-96 00:00
00:01:00 05-Jan-96 00:00
00:02:00 05-Dec-95 00:00
01:00:00 05-Feb-95 00:00
For non-time-based tables, the cutoff indicates the interval at which the entire table’s data
must be archived. For example, consider the cutoff specifiers and possible archiving
frequencies listed in Archive Cutoff sample (non time-based) (Table 6-6).
Table 6-6 Archive Cutoff sample (non time-based)
Cutoff Specifier Possible archive up to

00:00:01 daily
00:01:00 monthly
01:00:00 yearly
Note that the archive end time is not a guarantee that data is archived up to the end time.
It guarantees only that data younger than the end time is not archived. Refer to Archive
Intervals (Section 6.2.1.3) for more information.
6.2.1.3 Archive Intervals

An archive schedule is performed daily, monthly, or yearly depending on the Archive
Cutoff: field configuration; refer to The Schedule Configuration Dialog Box
(Section 6.2.1.1). A daily archive is performed on data that requests archiving at a cutoff

interval of less than one month. A monthly archive is performed on data that requests
archiving at a cutoff interval of greater than or equal to one month but less than one year.
A yearly archive is performed on data that requests archiving at a cutoff interval of greater
than or equal to one year.
Daily Archive
Daily archives are performed for archive schedules with an Archive Cutoff: field value
ranging from 00:00:00 to 00:00:31.
Figure 6-4 Daily Archive example
Daily Backup Schedule Created Jan 1, 1997
Archive Cutoff: 00:00:03 Delete Cutoff: 00:00:04
Collected Data
Jan 1, 1997 Jan 2 Jan 3 Jan 4 Jan 5 Jan 6 Jan 7 Jan 8
Jan 1 Data Jan 1 Data Archived
Jan 1 Data Cleanup

Jan 2 Data Jan 2 Data Archived
Jan 2 Data Cleanup

Jan 3 Data
Jan 3 Data Archived
Daily Archive example (Figure 6-4) shows a schedule created on January 1, 1997 with an
archive cutoff value of three days and a delete cutoff value of four days. Archiving does not
take place until the start of the day on January 5th since, until then, none of the collected
data is more than three days old. Data that have been archived once are not archived a
second time even if these have not been removed by the cleanup process. Data cleanup
does not take place until the start of the day on January 6th since, until then, none of the
collected data is more than four days old.
Monthly Archive
Monthly archives are performed for archive schedules with an Archive Cutoff: field value
ranging from 00:01:00 to 00:11:00.

Figure 6-5 Monthly Archive example
Monthly Backup Schedule Created Jan 1, 1997
Collected Data
Jan 1, 1997 Feb 1 Mar 1 Apr 1 May 1 Jun 1 Jul 1 Aug 1
January Data Archived

Jan Data
January Data Cleanup
Feb Data February Data Archived

February Data Cleanup
Mar Data March Data Archived

March Data Cleanup
Monthly Archive example (Figure 6-5) shows a schedule created on January 1, 1997 with
an archive cutoff value of two months and a delete cutoff value of two months. Archiving
does not take place until the start of the day, April 1, since until then, none of the
collected data is older than two months. Intervals between two and three months are
considered to be two months for purposes of monthly archiving. Data cleanup does not
take place until the start of the day, April 1, since until then, none of the collected data is
older than two months. The data must be archived before the cleanup process because
unarchived data cannot be deleted. If the execution times for these two scripts were set up
in the wrong order, the first data cleanup would not take place until May 1.
Yearly Archive
Yearly archives are performed for archive schedules with an Archive Cutoff: field value of
01:00:00 or greater.

Figure 6-6 Yearly Archive example
Yearly Backup Schedule Created Jan 1, 1993
Collected Data
Jan 1, 1993 Jan 1, 1994 Jan 1, 1995 Jan 1, 1996 Jan 1, 1997 Jan 1, 1998
1993 Data 1993 Data Archived

1993 Data Cleanup

1994 Data Cleanup

1995 Data Cleanup
Yearly Archive example (Figure 6-6) shows a schedule created on January 1, 1993 with an
archive cutoff value of one year and a delete cutoff value of one year. Archiving does not
take place until the start of the day, January 1, 1995 since, until then, none of the collected
data is older than one year. Intervals between one and two years are considered to be one
year for purposes of yearly archiving. Data cleanup does not take place until the start of the
day, January 1, 1995 since, until then, none of the collected data is older than one year.
Unarchived data cannot be deleted; hence, the data must first be archived before the
cleanup process. If the execution time for these two scripts were set up in the wrong order,
the first data cleanup would not take place until January 1, 1996.
6.2.2 The Add Device Editor

Prior to archiving data into an archive device, the device must first be defined and
initialized. The Add Device Editor (Figure 6-7) is used to define an archive device.

Figure 6-7 Add Device Editor
Opening the Add Device Editor
• Click Add Device on the Archive/Dearchive Edit dialog box (Figure 6-1).
The following table lists the items that appear on the Add Device Editor (Figure 6-7).
Table 6-7 Fields and buttons on the Add Device Editor
Arch Device: This is the name of the device where the data is
to be archived.
Type: There are two options available. Choose
Removable Disk if the archive device is an
optical disk. Choose Fixed Disk if using a
mapped drive.
Physical Device: This specifies the absolute device (for example,
/dev/rsdxxx).
Create Click this button to add the device.
Dismiss Click this button to discard changes.
Defining an archive device

Devices must be defined prior to initializing and archiving to them.
1 Open the Archive/Dearchive Edit dialog box (Figure 6-1).

2 Click Add Device. This opens the Add Device Editor (Figure 6-7).
3 Type the name of the archive device.
4 Select the type.
5 Type the physical device.
6 Click Create.
6.2.3 The Media Initialization Dialog Box

Prior to archiving data into an archive device, the device must first be defined and
initialized. The Media Initialization dialog box (Figure 6-8) is used to initialize an archive
device.

Figure 6-8 Media Initialization dialog box
Opening the Media Initialization dialog box
• Click Initialize Media... on the Archive/Dearchive Edit dialog box (Figure 6-1).
Initializing an archive device

Devices must be initialized prior to archiving to them. The initialization process writes a label on the
media and performs any media formatting. Archive and dearchive programs use the label to
determine if the media volume is correct. For removable media, initialization must take place each
time a new media volume is used. Fixed media only need to be initialized once.

2 Click Initialize Media.... This opens the Media Initialization dialog box (Figure 6-8).
3 Type or select the name of the device to initialize.
4 Click Initialize.
6.2.4 Archive Troubleshooting

This section gives the generic alarm messages that the archive process may generate and
the recommended user response. The actual messages are often variations of the following:
Please mount and initialize media on some_device

Media must be initialized prior to archiving to it. Initialize the device (some_device) in
question. Refer to The Media Initialization Dialog Box (Section 6.2.3).
Please mount archive media with label some_label on device some_device

Either no disk is present in the disk drive or the wrong disk is in the drive. Remove the
existing disk and replace it with the disk having the label (some_label) that is indicated.
some_device media is full

When archiving to a fixed disk, this means that the disk is now full. For removable media,
this means that a new media is needed.
6.3 Data Dearchiving

Data dearchiving is performed using a series of dialog boxes.
6.3.1 The Dearchive Window

The Dearchive window (Figure 6-9) shows a summary of the dearchive schedule.

Figure 6-9 Dearchive window
Opening the Dearchive window
• Click Dearchive... on the Archive/Dearchive Edit dialog box (Figure 6-1).
The following table provides a list of the fields, buttons, and other items that appear on
the Dearchive window (Figure 6-9).
Table 6-8 Items on the Dearchive window
Item Description
Column Headings
Service This is the service that contains the archived data.
Database This is the database that contains the archived data.
Table This is the table that contains the archived data.
Start Time Dearchiving is restricted to data between the Start Time and End Time.
End Time
Label This is the label of the device.
Device This is the device where the data is archived.
Buttons and Fields
Service: Click this to specify the service with which to filter the displayed informa-
tion.
Database: Click this to specify the database with which to filter the displayed informa-
tion.

Table 6-8 Items on the Dearchive window (Continued)
Item Description
Table: Click this to specify the table with which to filter the displayed information.
Start Time: Click this to specify the start time with which to filter the displayed informa-
tion.
End Time: Click this to specify the end time with which to filter the displayed informa-
tion.
Search Click this to search using the enabled filters.
Clear Filters Click this to clear the filters.
Dearchive Data Click this to open the Dearchive Configuration dialog box (Figure 6-10).
6.3.2 The Dearchive Configuration Dialog Box

The Dearchive Configuration dialog box (Figure 6-10) is used to configure data dearchiving.
Figure 6-10 Dearchive Configuration dialog box
Opening the Dearchive Configuration dialog box
1 Open the Dearchive window (Figure 6-9).

2 Click the row header of an entry in the Dearchive window (Figure 6-9).
3 Click Dearchive Data.

The following table lists the fields, buttons, and other items that appear on the Dearchive
Configuration dialog box (Figure 6-10). l
Table 6-9 Items on the Dearchive Configuration dialog box
Field/Button/Check
box Description
Specify alternate Click this to specify an alternate archive host.
archive host
Archive Host: This is the name of the alternate archive host.
Service: This is the service that contains the data to be dearchived.
Database: This is the database that contains the data to be dearchived.
Table: This is the table that contains the data to be dearchived.
Start Date: Dearchiving is restricted to data that lie between the specified start date
End Date: and end date.
Dearchive Click this to save the configuration.

Dismiss Click this to close the dialog box.
Dearchiving data
The most recent version of the archive file is the file that is dearchived. Do not initiate the dearchive
process close to the time when the daily archive occurs; this may interfere with the archive process.

2 Click Dearchive.... This opens the Dearchive window (Figure 6-9).
NOTE You may use the filters to find the archived file to dearchive.
3 (Optional) Click the row header that corresponds to the file to dearchive.
4 Click Dearchive Data. This opens the Dearchive Configuration dialog box
(Figure 6-10).
5 (Optional) If specifying an alternate archive host:
a Select the Specify alternate archive host check box.
b Type or select the name of the alternate archive host.
6 If you skipped step 3, do the following:
a Type or select the service, database, and table.
b Type the start date and end date.
7 Click Dearchive.
6.4 Data Cleanup

After the historical data has been archived, it is eligible for cleanup. The cleanup process
deletes all data that has been archived and is older than the cleanup cutoff time specified
in the archive schedule table. The date of the most recent deletion is also recorded in the
schedule table.

In order to delete data, it must be archived. Therefore, when using JSH to schedule
archiving and cleanup, the former must be performed first. If you do not wish to save the
data to an archive device, then archive to the null device (i.e. NUL).
The Delete Cutoff: field entry in the Schedule Configuration dialog box (Figure 6-3)
specifies how old data must be before it is deleted. Each entry follows the YY:MM:DD
format, where YY specifies how many years must elapse, MM specifies how many months
must elapse, and DD specifies how many days must elapse before deletion. The deletion
time is calculated with respect to the start of the current day.
To illustrate, if the current time is 05-Feb-96 14:35 when the cleanup process runs, the cutoff
specifier causes the archived data to be deleted as shown in Delete Cutoff sample
(Table 6-10).
Table 6-10 Delete Cutoff sample
Cutoff Specifier
(Delete Cutoff: field on the
Schedule Configuration dialog
box (Figure 6-3) Delete archived data up to
00:00:00 05-Feb-96 00:00
00:00:01 04-Feb-96 00:00
00:01:00 05-Jan-96 00:00
00:02:00 05-Dec-95 00:00
01:00:00 05-Feb-95 00:00
Previously deleted data that is subsequently dearchived is not cleaned up automatically by

the system.
NOTE Delete dearchived data as soon as it is no longer needed; otherwise, it fills up the
database and leaves no room for the data that is currently being collected.
Cleaning up dearchived data (Method 1)

In this method, cleanup is run locally.

2 Click Cleanup. VF_POP_PANEL (Figure 6-11) appears to confirm the operation.
Figure 6-11 VF_POP_PANEL
3 Click Yes.

6.4.1 xis_cleanup
A manual data cleanup can also be done using xis_cleanup. The process is normally
started by executing xis_cleanup on the Historical machine. The syntax is:
xis_cleanup [-h] [-option]
The following table lists the options provided for xis_cleanup.
Table 6-11 Cleanup options
Option Description
c This option checks and reports if there is any dearchived data that requires
deletion. To delete dearchived data, the -f flag must be specified.
f This forces a full deletion, including manually dearchived data.
v This is used to display informational messages while executing.
NOTE This option applies to cmx_cleanup only.

h This is used to display cleanup options described in this table.
p max_pages This sets the maximum number of pages to delete with one SQL command.
The default setting is 150.
s service This option sets the name of the service which hosts the database; default
value for service is Historical..
d level This sets the level of debug message detail to between 0 and 3, where a level
of 0 allows no message and 3 gives maximum detail.
Cleaning up dearchived data (Method 2)

In this method, dearchived data is cleaned up by executing the following on the RealTime or
Historical machine.
1 Open a command prompt window on the Historical machine.

2 Type cleanup -f. The -f flag specifies a full delete. For more information, refer to
Cleanup options (Table 6-11).
3 Press ENTER.
6.4.2 cmx_cleanup
Manual data cleanup can also be done using cmx_cleanup. The process is started by
executing cmx_cleanup on the RealTime machine. This locates the Historical service host
and launches launches the xis_cleanup.pl script on that host. The syntax is:
cmx_cleanup [-h] [-v] [-option]
Refer to Cleanup options (Table 6-11) for the options provided for cmx_cleanup.
The Job Scheduler (JSH) is normally configured to run cmx_cleanup once per day after
cmx_archive has already run.
6.5 Data Rearchiving

If historical data that has already been archived is edited, it is automatically scheduled for
rearchiving. Rearchive is triggered after each regular archive is performed by xis_archive.pl.

The archive program checks the rearchive table. If there are any entries in the table, the
archive program collects information from the schedule and catalog tables as required for
rearchiving (for example, rearchive format and device). After the information is collected,
the rearchive is performed.
The archive file name for rearchived data is identical to the original file name, except that
the version number suffix is incremented each time the data is required. Therefore, the file
name with the highest version number reflects the most current state of the data.
6.5.1 Rearchive Troubleshooting

If rearchiving cannot be scheduled in the rearchive table after data is modified or inserted,
the reason may be one of the following:
• The data being modified or inserted has not been previously archived.
• The database and table in which the data was modified or inserted are not scheduled
for archive in the schedule table.
• The archive function is disabled in the RealTimeDB’s JSH table.
• The data being modified or inserted corresponds to the same period defined by the
start and end times of an entry already in the rearchive table, which was created previously
due to modification or insertion of the data in the same time interval in the same data-
base and table.

MODULE 7
HistoricalDB Databases
This module lays out the inner structure of HistoricalDB tables.
The following table provides information on Telvent-defined data-types that are used in
HistoricalDB tables.
Table 7-1 Telvent data-types
Data Type Definition Length in Bytes

GMToffset smallint 2
GMTtime int 4
byteType tinyint 1
doubleType float 8
nameType varchar 15
statusType char 1
pathType varchar 80
realType real 4
cutoffType char 8
devnameType varchar 40
boolType bit 1
IDType smallint 2
systemName varchar 30
labelType varchar 8
fileNameType varchar 80
tagIDType int 4
unitsType varchar 7
7.1 The timeline Database

Except for accumulator-type rate data, all RealTime numerical data are sent to the
HistoricalDB timeline database for storage.
Data is summarized according to the procedures described in Data Summary (Section 3.3).
This data is used when plotting historical data. For details on plotting or trending historical
data, refer to the Referencia de Operación y Control.
All of the timeline tables carry a tag identifier number (in the tagId field), which is used to
obtain access to a specific record within a table. This is similar to a RealTime record
number.

7.1.1 tag Table
Table 7-2 Fields in the tag table of the timeline database
Internal Field Data Type Description

tagName pathType Name of collect point
tagId tagIDType ID of collect point
7.1.2 collect Table
Table 7-3 Fields in the collect table of the timeline database

startTime GMTtime Minimum time of any data value in this record
startOffset GMToffset Offset to local time zone that was in effect when start-
Time occurred
time GMTtime Maximum time of any data value in this record
endOffset GMToffset Offset to local time zone that was in effect when time
occurred
tagId tagIDtype ID of the collect point
data image The Binary Large Object (BLOB) of the collect data
7.1.3 hour Table
Table 7-4 Fields in the hour table of the timeline database

tagId tagIDType ID of collect point
time GMTtime Time of data summary (GMT).
offset GMToffset Offset to local time zone that was in effect when the
value was collected
value realType Value at the start of the hour
status statusType Data quality status of value
minTime GMTtime Timestamp for minimum (GMT)
minOffset GMToffset Offset to local time zone that was in effect when mini-
mum was collected
minimum realType Minimum data value over the hour, day, month, or
year
minStatus statusType Data quality status of minimum
minMilli smallint Millisecond part of time minimum
maxTime GMTtime Timestamp for maximum value (GMT)

Module 7 - HistoricalDB Databases 7-3
Table 7-4 Fields in the hour table of the timeline database

maxOffset GMToffset Offset to local time zone that was in effect when max-
imum was collected
maximum realType Maximum value for the hour
maxStatus statusType Data quality status of maximum
maxMilli smallint Millisecond part of time of maximum
average realType Average value for the hour
avgStatus statusType Data status of average
7.1.4 day Table

The day table of the timeline database has the same field names as timeline database’s hour
table. Refer to Fields in the hour table of the timeline database (Table 7-4).
7.1.5 month Table

The month table of the timeline database has the same field names as timeline database’s
hour table. Refer to Fields in the hour table of the timeline database (Table 7-4).
7.1.6 year Table

The year table of the timeline database has the same field names as timeline database’s hour
table. Refer to Fields in the hour table of the timeline database (Table 7-4).
7.2 The accum Database

The accum database holds accumulator counts for accumulator-type rate points.
Every hour, the following is done:
• Volume flow data from the rate database in RealTimeDB is retrieved.

• Data is written to the accum database in HistoricalDB.
• Integration block of the rate database is reset.
The data collected from RealTimeDB includes:
• The raw accumulator count

• The adjusted accumulator value (i.e. the accumulator count converted to engineering
units, such as barrels/hour)
• The data quality status
• The calculated volume (in engineering units, such as barrels) for that hour
Data is summarized according to the procedures described in Data Summary (Section 3.3).

7.2.1 hour Table
Table 7-5 Fields in the hour table of the accum database

tagName nameType Meter name (i.e. rate point name)
rawcount doubleType Collected accumulator value
adjcount doubleType Adjusted accumulator value
countStatus statusType Data status of rawcount
volume doubleType Volume during the hour
time GMTtime Timestamp of the hour
offset GMToffset Offset to local time zone that was in effect when time
occurred
7.2.2 day Table

The day table of the accum database has the same field names as accum database’s hour
table. Refer to Fields in the hour table of the accum database (Table 7-5).
7.2.3 month Table

The month table of the accum database has the same field names as accum database’s hour
7.2.4 year Table

The year table of the accum database has the same field names as accum database’s hour
7.3 The event Database

All events and alarms are automatically collected from RealTimeDB and placed in the
HistoricalDB’s event database. This database consists of only one table, the summary table.
A record is generated within this table each time an event is transferred to HistoricalDB.
Data in this table can be viewed through the Event Summary and Alarm Summary windows
in XOS (refer to the Referencia de Operación y Control).

7.3.1 summary Table
Table 7-6 Fields in the summary table of the event database

time GMTtime Time of the event (GMT)
msec int Millisecond part of time (msec is nonzero only if the RTU
provides millisecond timestamp resolution. This field is
used to determine sequence-of-events.)
occurred
type nameType Type of event; type is one of (a) control, which results
from an action of the user, (b) alarm, which results from
an alarm, or (c) event, which results from neither control
nor alarm
host nameType Name of originating host
process nameType Name of originating application or process
dbName nameType Name of originating database
ptName nameType Name of originating point
description descType Description of originating point
rtuName nameType Name of originating remote
groupName nameType Name of group to which rtuName belongs (Some events
are not associated with a group. Those that are generated
as part of the computer processing structure, such as
those due to a CPU failure, are identified by the computer
name in the host field. Those that are generated as part of
a computer application, such as those generated by the
execution of a C routine, are identified by the process or
application name in the process field.)
message msgType Message text
fgInt tinyint message color
severity tinyint Message severity (taken from the associated RealTimeDB
message table)
key1 int For previous version archive compatibility (not used)
key2 int For previous version archive compatibility (not used)
spooler tinyint Spooler number that is associated with groupName
7.4 The CommStats Database

The communication between the RTU and the host computer often results in minor errors
or problems. These are recorded in RealTimeDB’s remote database and transferred to
HistoricalDB’s CommStats database every hour.
Data in this table can be viewed through the Connection Summary window in XOS. For
more information, refer to the Referencia de Operación y Control.

7.4.1 RemPeriodStats Table
Table 7-7 Fields in the RemPeriodStats table of the CommStats database

remote nameType Name of associated remote RealTimeDB record
connection nameType Name of the connection that is used to communicate
with the remote
time GMTtime Time of data collection (GMT)
occurred
succeedQuery intType Number of successful poll queries
failedQuery intType Number of failed poll queries
throughput doubleType Calculated value of the overall percent throughput
no_reply intType Number of no-replies received from the RTU
security_error intType Number of security errors received
long_message intType Number of communication messages that were longer
than expected
short_message intType Number of communication messages that were shorter
than expected
wrong_remote intType Number of times the wrong remote indicated in the
message
off_line intType Number of times the remote was found to be offline
sbo_rly_fail intType Number of times the select-before-operate
operation command failed
db_error intType Number of times a database error was detected
off_scan intType number of times the remote was detected to be off-scan
illegal_message intType Number of times an illegal message was detected
sbo_sel_fail intType Number of times the select-before-operate
selection command failed
line_fail intType Number of times the line failed
7.4.2 ConnPeriodStats Table
Table 7-8 Fields in the ConnPeriodStats table of the CommStats database

connection nameType Connection associated with RealTimeDB record
time GMTtime Time of data collection (GMT)
offset GMToffset Offset to local time zone that was in effect when the time
occurred
msg_good intType Number of successful messages
msg_bad intType Number of failed messages

Table 7-8 Fields in the ConnPeriodStats table of the CommStats database (Continued)

throughput doubleType Calculated value of the overall percent throughput
conn_none intType Number of times an operation was attempted and failed
due to loss of connection
connected intType Number of times an operation was established
connecting intType Number of times modem dialing was attempted
conn_fail intType Number of times a connection could not be established
within the maximum time allowed
conn_error intType Number of bad modem connections or failed network
socket connections
conn_retry intType Number of connection retries that were attempted while
establishing a connection
poll_cycle intType Number of completed poll cycles
off_line intType Number of times the remote was found to be offline when
communication was attempted
db_error intType Number of times a database error was detected
modem_unavail intType Number of times a modem was unavailable and a reserva-
tion request couldn’t be posted
modem_reserve intType Number of times the connection had to wait for a modem,
but a reservation request was successful
modem_hangup intType Number of times a modem was successfully hung up
tx_error intType Number of times a system error occurred while attempting
to transmit bytes
tx_short intType Number of times that some of the bytes in a message were
not transmitted
rx_error intType Number of times a system error occurred while attempting
to receive bytes
rx_short intType Number of times that some of the bytes in a message were
not received
rx_none intType Number of times no bytes of a message were received
normal intType Number of times messages were transmitted or received
correctly
7.5 The archive Database

The archive database is composed of tables that are only accessible to the System Manager.
The following sections list the tables in the archive database.

7.5.1 schedule Table
Table 7-9 Fields in the schedule table of the archive database

archId IDType unique archive identifier (ID)
archEnable boolType enable/disable archiving
svrName sysName name of SQL server
dbName sysName name of database to archive
tableName sysName name of table to archive
archiveDevice devnameType destination archive device
archiveCutoff cutoffType archive cutoff specifier (YY:MM:DD)
archTime GMTtime time of last archive cutoff (GMT)
archOffset GMTtime offset to local time zone that was in effect when
archTime occurred
delCutoff cutoffType delete cutoff time specifier (YY:MM:DD)
delTime GMTtime time of last delete cutoff (GMT)
delOffset GMToffset offset to local time zone that was in effect when del-
Time occurred
bcpFormat text bulk copy format specification
7.5.2 device Table
Table 7-10 Fields in the device table of the archive database

archiveDevice devnameType name of archive device
type deviceType type of archive device
physicalDevice devnameType underlying physical device
currentLabel labelType label of current archive media
mediaState varchar(10) state of media
7.5.3 catalog Table
Table 7-11 Fields in the catalog table of the archive database

archiveID IDType Archive table identifier
dbName systemName Name of database
tableName systemName Name of table
archLabel labelType Label of archive media for this archive

Table 7-11 Fields in the catalog table of the archive database (Continued)

archDevice devnameType Archive device name
archFile fileNameType Name of archived data file
archTime GMTtime Time the archive was created (GMT)
archOffset GMToffset Offset to local time zone that was in effect when arch-
Time was created.
startTime GMTtime Start of data archive
endTime GMTtime End of data archive
dataOffset GMToffset Offset for start and end of data times
verNum IDType Version number of archive
currentVer boolType Indicates whether archive is the most current version
7.5.4 dumpSchedule Table
Table 7-12 Fields in the dumpschedule table of the archive database

dbName systemName Name of database to backup using Sybase procedures
whenChanged tinyint Indicates whether backup is needed whenever change is
detected in the database
numBackups tinyint Maximum number of backups to retain before writing over
xactid binary ID of the newest transaction within the database
7.5.5 rearchive Table
Table 7-13 Fields in the rearchive table of the archive database

archId IDType Unique archive identifier (ID)
svrName sysName Name of SQL server
dbName sysName Name of database to archive
tableName sysName Name of table to archive
startTime GMTtime Start time of archive data
endTime GMTtime End time of archive data
archFile fileNameType Archive file name
verNum IDType Version number of archive

7.5.6 validDeviceTypes Table
Table 7-14 Fields in the validDevice table of the archive database

devType deviceType Valid type of device

Index
Symbols archive database ....................................................1-2
Archive Intervals ....................................................6-9
*.seq .......................................................................4-3 Archive options ......................................................6-2
*.ste ........................................................................4-3 Archive Process.......................................................6-1
Archive Troubleshooting.....................................6-14
A Archive/Dearchive Edit dialog box........................6-4
buttons on the ....................................................6-4
accum opening the ........................................................6-4
day table .............................................................7-4 Archiving data using cmx_archive
hour table ...........................................................7-4 archiving
month table ........................................................7-4 using cmx_archive ...........................................6-3
accum Database .....................................................7-3 Archiving data using xis_archive...........................6-2
accum database arhiving
adding a new record in the .............................2-10 using xis_archive .................................................6-2
modifying a record in the ................................2-10
accum database .....................................................1-2
Accum Edit dialog box ..........................................2-9 B
fields/buttons......................................................2-9 Baseline Publication Properties
opening the ........................................................2-9 viewing................................................................5-8
Accum Hour Editor ................................................2-8 BOTTOM_OF_PERIOD ............................................2-2
Adj Count............................................................2-8
End Time .............................................................2-9
Filter ....................................................................2-9 C
filtering display list...........................................2-10
opening the ........................................................2-8 catalog table ..........................................................1-2
Point ....................................................................2-8 Checksum Fail.......................................................2-12
Start Time............................................................2-8 Cleaning up dearchived data .................... 6-18, 6-19
Status...................................................................2-8 cleanup
Time.....................................................................2-8 process...............................................................6-17
Volume................................................................2-8 Cleanup options...................................................6-19
Add Device Editor ................................................6-13 cmx_archive............................................................6-3
fields/buttons....................................................6-13 cmx_cleanup.........................................................6-19
opening the ......................................................6-13 Collect Every...........................................................3-2
Adding a new entry in the Schedule Summary win- collect point
dow ..................................................................6-8 configuring existing collection entry ................3-4
Adding a new record to the accum database....2-10 configuring new collection entry ......................3-3
Adding a new record to the CommStats database... deleting a collection entry .................................3-4
2-14 Collect Select dialog box .......................................3-3
Adding a new record to the timeline database...2-6 collect table............................................................1-3
Adj Count ...............................................................2-8 Collection Entry Dialog Box
Anonymous Subscriptions .....................................5-3 fields/buttons/column names.............................3-2
Application.............................................................4-2 Collection Entry dialog box...................................3-1
Application Sequence File opening the ........................................................3-1
Syntax elements..................................................4-3 Collection Type ......................................................3-2
Application Sequence Files ...................................4-3 CommStats
Application Suite File ConnPeriodStats table........................................7-6
Syntax elements..................................................4-4 RemPeriodStats table .........................................7-6
Application Suite Files ...........................................4-4 CommStats Database.............................................7-5
archive CommStats database
catalog table .......................................................7-8 adding a new record to the .............................2-14
device table.........................................................7-8 editing the ........................................................2-11
dumpSchedule table ..........................................7-9 modifying a record in the ................................2-14
interval ................................................................6-9 CommStats database ..................................... 1-2, 2-2
rearchive table ....................................................7-9 commstats Database..............................................7-5
schedule table.....................................................7-8 Communication Statistics Edit dialog box..........2-13
schedules opening the ......................................................2-13
daily................................................................6-10 Config Error..........................................................2-12
monthly..........................................................6-10 Configuration File..................................................4-2
yearly..............................................................6-11 Configuring a new collection entry......................3-3
validDeviceTypes table .....................................7-10 Configuring an existing collection entry..............3-4
Archive Cutoff........................................................6-9 Connection Statistics Edit dialog box .................2-18
archive Database ...................................................7-7 opening the ......................................................2-18

Index - 2 Historical Services Configuration and Administration Reference - Baseline
Connection Statistics Editor ................................2-15 Filtering the information displayed on the Schedule
column headings ..............................................2-16 Summary window
fields/buttons....................................................2-16 Schedule Summary window
filtering display list...........................................2-15 filtering display information ..........................6-6
opening the ......................................................2-15 Filtering the list displayed on the Accum Hour Editor
ConnPeriodStats table ...........................................1-2 2-10
Filtering the list displayed on the Remote Communi-
cation Statistics Editor...................................2-14
D Filtering the list displayed on the Timeline Collect
Data Cleanup .......................................................6-17 Editor ...............................................................2-7
Data Collection by Exception ................................3-3
Data Dearchiving .................................................6-14
Data Rearchiving .................................................6-19 G
Data summary ........................................................3-4 Globally Unique Identifiers ...................................5-2
data summary GMTtime.................................................................2-2
enabling ..............................................................3-5 Greenwich Mean Time (GMT)
rate collect point ................................................3-5 See GMTtime
data types...............................................................7-1 Group......................................................................2-5
databases GUID .......................................................................5-2
accum ..................................................................1-2
archive.................................................................1-2
CommStats .................................................. 1-2, 2-2 H
event ...................................................................1-2 Historical Application Definition ..........................4-3
timeline ...............................................................1-3 Historical Application Install Tool.........................4-1
xosapp .................................................................1-3 Application..........................................................4-2
day table ........................................................ 1-2, 1-3 Configuration File...............................................4-2
daylight savings time.............................................2-2 Error ....................................................................4-2
Deadband full Historical installation ...................................4-5
.............................................................................3-2 Install All .............................................................4-2
Dearchive Configuration dialog box ..................6-16 Install Selected ....................................................4-2
fields/buttons/checkboxes................................6-17 Installation Configuration Directories...............4-2
opening the ......................................................6-16 items on the ........................................................4-2
Dearchive window ...............................................6-15 opening the ........................................................4-2
items on the......................................................6-15 Server Cfg............................................................4-2
opening the ......................................................6-15 Service .................................................................4-2
dearchiving ..........................................................6-14 Set Directories.....................................................4-2
Dearchiving data .................................................6-17 Historical Install Tool
Defining an archive device..................................6-13 partial/selective application installation ...........4-6
Delete Cutoff .......................................................6-18 HistoricalDB............................................................1-1
Deleting a collection entry....................................3-4 HistoricalDB Edit Menu .........................................2-1
Deleting a Schedule Summary window entry......6-9 opening the ........................................................2-1
device table ............................................................1-2 HistoricalDB in relation to other services .............1-1
Directory Structure ................................................4-5 HistoricalDB Structure ...........................................1-2
Distributor ..............................................................5-4 hour table....................................................... 1-2, 1-3
dumpSchedule table..............................................1-2
I
E Illegal Message.....................................................2-12
Enable Filters..........................................................2-5 Initializing an archive device...............................6-14
Enable Summary ....................................................3-2 Install All......................................................... 4-2, 4-6
Enabling data summary for a collect point..........3-5 Install Selected .......................................................4-2
Enabling data summary for a rate collect point ..3-5 Installation Configuration Directories..................4-2
End Time ........................................................ 2-4, 2-9
Error........................................................................4-2
event L
summary table ....................................................7-5 Line Fail ................................................................2-12
event Database ......................................................7-4 Long Message ......................................................2-12
event database ......................................................1-2
F M
Media Initialization dialog box...........................6-14
Fast Trend only ......................................................3-2 opening the ......................................................6-14
Filter ............................................................... 2-4, 2-9 Merge Agent Properties
Filtering the data displayed on the Connection Sta- viewing..............................................................5-10
tistics Editor ...................................................2-15

Historical Services Configuration and Administration Reference - Baseline Index - 3
Merge Agents ........................................................5-4 Publishers ...............................................................5-2

Merge Replication .................................................5-1 Pull Subscriptions ...................................................5-3
Microsoft SQL Server 2000 ....................................5-1 Push Subscriptions .................................................5-3
Modifying a record in the accum database .......2-10
Modifying a record in the CommStats database2-14
Modifying a record in the timeline database ......2-7 R
Modifying a Schedule Summary window entry...6-8 raw units.................................................................3-2
month table ................................................... 1-2, 1-3 RealTimeDB ............................................................1-1
rearchive
troubleshooting................................................6-20
N rearchive table .......................................................1-2
Named Subscriptions .............................................5-3 Remote ...................................................................2-5
No Reply ...............................................................2-12 Remote Communication Statistics
notepad table ........................................................1-3 opening the ......................................................2-11
Remote Communication Statistics Editor ...........2-11
column headings ..............................................2-12
O fields/buttons ....................................................2-11
OASyS Network Management Console ................1-4 filtering display list ...........................................2-14
Off Scan ................................................................2-12 RemPeriodStats table ............................................1-2
Offline ..................................................................2-12 Replicating Baseline Historical Data .....................5-6
Opening the Accum Edit dialog box ....................2-9 Replication Agents.................................................5-4
Opening the Accum Hour Editor ..........................2-8 Replication Types ...................................................5-1
Opening the Add Device Editor..........................6-13
Opening the Archive/Dearchive Edit dialog box .6-4
Opening the Collection Entry dialog box.............3-1 S
Opening the Communication Statistics Edit dialog SBO Relay Fail.......................................................2-12
box .................................................................2-13 SBO Select Fail......................................................2-12
Opening the Connection Statistics Edit dialog box .. Schedule Configuration dialog box......................6-7
2-18 fields/buttons ......................................................6-7
Opening the Connection Statistics Editor ..........2-15 opening the ........................................................6-7
Opening the Dearchive Configuration dialog box ... Schedule Summary form .......................................6-5
6-16 Schedule Summary window ..................................6-5
Opening the Dearchive window.........................6-15 add a new entry..................................................6-8
Opening the Historical Application Install Tool...4-2 delete an entry ...................................................6-9
Opening the HistoricalDB Edit Menu ...................2-1 items on the ........................................................6-5
Opening the Media Initialization dialog box ....6-14 modify an entry ..................................................6-8
Opening the Point Select dialog box....................2-5 opening the ........................................................6-5
Opening the Remote Communication Statistics Edi- schedule table ........................................................1-2
tor...................................................................2-11 Selective Application Installation .........................4-6
Opening the Schedule Configuration dialog box6-7 Server......................................................................4-2
Opening the Schedule Summary window............6-5 Server Cfg ...............................................................4-2
Opening the SQL Server Enterprise Manager ......5-5 Set Directories ........................................................4-2
Opening the Timeline Collect Editor ....................2-3 Short Message......................................................2-12
Opening the Timeline Edit dialog box .................2-6 Snapshot Agent Properties
viewing..............................................................5-10
Snapshot Agents ....................................................5-4
P Snapshot Replication .............................................5-1
Performing Full Historical Installation..................4-5 SQL Application Definition ...................................4-2
Performing Selective Application Installation .....4-6 SQL Query Analyzer...............................................5-7
Point .......................................................................2-8 SQL Server Books Online .......................................5-1
.............................................................................2-4 SQL Server Enterprise Manager ............................5-5
Point Description ...................................................2-5 opening the ........................................................5-5
Point Field Description ..........................................2-5 Start Time ....................................................... 2-4, 2-8
Point Name ............................................................2-5 Starting /Stopping/Failing Over Historical Service1-4
Point Select dialog box..........................................2-5 Starting/Stopping/Failing Over Historical Service 1-3
Enable Filters ......................................................2-5 Status .............................................................. 2-4, 2-8
Group ..................................................................2-5 Subscribers as Publishers .......................................5-3
opening the ........................................................2-5 Subscriptions ..........................................................5-3
Point Description ................................................2-5 summary table ............................................... 1-2, 7-4
Point Field Description .......................................2-5 System-Specific Configuration ..............................4-7
Point Name .........................................................2-5
Remote................................................................2-5
Publications and Articles .......................................5-2 T
Publisher and Distributor Properties tables
viewing..............................................................5-10 catalog.................................................................1-2

Index - 4 Historical Services Configuration and Administration Reference - Baseline
collect ..................................................................1-3 Volume ...................................................................2-8

ConnPeriodStats .................................................1-2
day............................................................... 1-2, 1-3
device ..................................................................1-2 W
dumpSchedule ....................................................1-2 Wrong Remote.....................................................2-12
hour............................................................. 1-2, 1-3
month.......................................................... 1-2, 1-3
notepad...............................................................1-3 X
rearchive .............................................................1-2 xis_archive ..............................................................6-2
RemPeriodStats...................................................1-2 xis_cleanup ...........................................................6-19
schedule ..............................................................1-2 cleanup options ................................................6-19
summary...................................................... 1-2, 7-4 xosapp database ....................................................1-3
tag .......................................................................1-3
validDeviceTypes ................................................1-2
year.............................................................. 1-2, 1-3 Y
tag identifier number............................................7-1
tagId field...............................................................7-1 year table ....................................................... 1-2, 1-3
Throughput ..........................................................2-12
Time ......................................................... 2-3, 2-6, 2-8
time field ................................................................2-2
timeline
collect Table........................................................7-2
day table .............................................................7-3
hour table ...........................................................7-2
month table ........................................................7-3
tag table..............................................................7-2
year table ............................................................7-3
Timeline Collect Editor ..........................................2-3
End Time .............................................................2-4
Filter ....................................................................2-4
Filtering display list ............................................2-7
opening the ........................................................2-3
Point ....................................................................2-4
Start Time............................................................2-4
Status...................................................................2-4
Time.....................................................................2-3
Value ...................................................................2-3
timeline Database..................................................7-1
timeline database
modifying a record.............................................2-7
timeline database ..................................................1-3
timeline database record
adding a new record ..........................................2-6
Timeline Edit dialog box .......................................2-6
opening the ........................................................2-6
Time.....................................................................2-6
Value ...................................................................2-6
timestamps .............................................................2-2
TOP_OF_PERIOD ....................................................2-2
Transactional Replication ......................................5-2
TSTAMP_PREFERENCE ...........................................2-2
U
units
raw ......................................................................3-2
V
validDeviceTypes table ..........................................1-2
Value .............................................................. 2-3, 2-6
Viewing Baseline Publication Properties..............5-8
Viewing Merge Agent Properties .......................5-10
Viewing Publisher and Distributor Properties ...5-10
Viewing Snapshot Agent Properties...................5-10


DNA HistoricalServices PDF

Uploaded by

Copyright:

Available Formats

DNA HistoricalServices PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

DNA HistoricalServices PDF

Uploaded by

Copyright:

Available Formats

OASyS® DNA SCADA Suite

Phone: +1 403 253 8848 Phone: +1 713 939 9399

Historical Services Configuration and Administration

© Copyright 2000 - 2004 by Telvent Canada Ltd.

All Rights Reserved

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

Document Revision History

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

3.3 Data Summary ............................................................................................................................... 3-4

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

6.2.4 Archive Troubleshooting.................................................................................................... 6-14

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

Figure 1-1 HistoricalDB in relation to other services .................................................................................1-1

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

Table 1-1 HistoricalDB databases, tables, and views................................................................................1-2

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

Figure 1-1 HistoricalDB in relation to other services

The archiving process is configured

The collection Historical data is available

The following are transferred from RealTimeDB to HistoricalDB:

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

1.1 HistoricalDB Structure

Table 1-1 HistoricalDB databases, tables, and views

Database Table View Description

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

Table 1-1 HistoricalDB databases, tables, and views (Continued)

Database Table View Description

1.2 Basic Historical Service Procedures

Starting, Stopping, or Failing Over Historical Service (Method 1)

a Click the Start menu.

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

Figure 1-2 OASyS DNA Network Management Console

2 Expand OASyS DNA.

Starting, Stopping, or Failing Over Historical Service (Method 2)

a Click the Start menu.

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

Editing Historical Data

Figure 2-1 HistoricalDB Edit Menu

Opening the HistoricalDB Edit Menu

Figure 2-2 HistoricalDB Edit Menu icon

Table 2-1 Buttons on the HistoricalDB Edit menu

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

Table 2-1 Buttons on the HistoricalDB Edit menu (Continued)

2.1 A Note on HistoricalDB Time

NOTE In HistoricalDB, time is measured in seconds, offsets in minutes.

2.2 Editing the timeline Database

2.2.1 The Timeline Collect Editor

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

Figure 2-3 Timeline Collect Editor

Opening the Timeline Collect Editor

• Click Timeline Data on the HistoricalDB Edit Menu (Figure 2-1).

Table 2-2 Items on the Timeline Collect Editor

OASyS® DNA SCADA Suite Baseline Document Revision 1.1

Table 2-2 Items on the Timeline Collect Editor (Continued)