SurvalentONE

WS-401
REPLICATOR AND ARCHIVER
USER GUIDE

Version 1.18
 WS-401 Replicator and Archiver User Guide

Copyright, Notices and Trademarks

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

Survalent Technology Corporation

7965 Heritage Road
Brampton, Ontario L6Y 5X5

(905) 826 5000

(905) 826 7144

[email protected]

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

The software described in this document is furnished under

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

About This Publication

This manual describes how to install and maintain the SCADA Replicator and Archiver

It is assumed that you have some background knowledge about SCADA systems.
 WS-401 Replicator and Archiver User Guide

Revisions

Version Description
1.0 Initial version.
1.1 Added support for Oracle.
Added SQL Server 2005.
1.2
Added Archiver.
Added description of fields contained in the archived operations messages table
1.3
(PRTSPL-ARCHIVE).
Added note on extending maximum memory usage during installation of service
1.4
packs for SQL Server 2000
Added comments about installing Microsoft Reporting Services.
Added “I want to use Scada Replicator for:” option.
Added destination database on separate computer (if not using Replicator for
1.5
WebSurv).
Revised page for entering SCADA host names.
Allow user to specify names of archive tables.

Replicator still supports SQL Server 2000. But when used with WebSurv or in
redundant configurations, only SQL Server 2005 and 2008 are supported.
Updated section 3.3, Replicator Manager.
1.6
Added section 4.3, Setup Preferences.
Added chapter 7 on redundant replicators and SSRDS.
Added sections in chapter 8 on redundant historian.

In order to support SQL Server Express, Replicator has been modified to use Broker
Services, which is not available in versions of SQL Server prior to 2005. Replicator
therefore no longer supports SQL Server 2000, and the following sections have
1.7 therefore been removed:
• Setup of Microsoft SQL Server 2000
• Switching to Mixed Authentication in SQL Server 2000
• Configuring SQL Server 2000 Memory
Updated chapter 4, Installation of the Replicator. Replicator now supports non-
1.8
standard ports for connection to the Microsoft SQL Server Database.
1.9 Added section 2.3 and section 2.4.

1.10 Added SCADA Replicator status points

Revisions
 WS-401 Replicator and Archiver User Guide

Version Description
Updated installation options in Replicator.
1.11 Added new Survalent Logo.
Updated the Replicator Editor

1.12 Added section 8.3 Using an Alternate Database Driver.

1.13 Added Installing SQL 2012/2016 Server.

1.14 Removed VMS Scada information.

Updated the Replator Editor with new Connections icon.
1.15
Added SQL Server 2019 installation.
1.16 Updated TOC and made changes to the SQL Server in Chpater 2 and Chapter 6.

1.17 Updated Appendix A with new Replicator Editor.

Updated the installation procedures (removed the Installation Tool Kit) for Replicator,
1.18
SSRDS and Archiver.

Revisions
 WS-401 Replicator and Archiver User Guide

Contents

1 Introduction 1-1

2 SQL Server 2-1

2.1 Setup of Microsoft SQL Server..................................................................................................... 2-2
2.1.1 SQL Server Management Studio .................................................................................................. 2-3

3 Installing the Replicator 3-1

3.1 Installation of the Replicator ......................................................................................................... 3-2
3.2 Configuring an Outgoing Connection to a Replicator ................................................................ 3-10
3.2.1 Configuring Explorer .................................................................................................................. 3-10
3.3 Replicator Manager ..................................................................................................................... 3-12
3.3.1 Starting the Replicator................................................................................................................. 3-13
3.3.2 Standby Replicator ...................................................................................................................... 3-14

4 Replicator Editor 4-15

4.1 Setup Tables and Historical Data Sets ........................................................................................ 4-15
4.2 Replicator Editor ......................................................................................................................... 4-16
4.2.1 Replicator Window Toolbar ........................................................................................................ 4-17
4.3 Setup Preferences ........................................................................................................................ 4-18
4.3.1 Service Preferences ..................................................................................................................... 4-18
4.3.2 Database Preferences .................................................................................................................. 4-19
4.3.3 SQL Server Credentials............................................................................................................... 4-20
4.3.4 List of INI files ............................................................................................................................ 4-21

Contents i
 WS-401 Replicator and Archiver User Guide

5 Historical Datasets 5-1

5.1 Datasets ......................................................................................................................................... 5-1
5.1.1 SCADA ......................................................................................................................................... 5-2

6 SSRDS 6-1
6.1 Redundant Replicators .................................................................................................................. 6-1
6.2 Setup of Microsoft SQL Server..................................................................................................... 6-2
6.3 Purpose of SSRDS ........................................................................................................................ 6-2
6.4 Installation of SSRDS ................................................................................................................... 6-2
6.5 SSRDS Editor ............................................................................................................................... 6-5
6.5.1 Add New Server ............................................................................................................................ 6-6
6.5.1.1 In Service ................................................................................................................................. 6-6
6.5.1.2 Server Name ............................................................................................................................ 6-6
6.5.1.3 Description ............................................................................................................................... 6-7
6.5.1.4 Database Type.......................................................................................................................... 6-7
6.5.1.5 Trust Connection...................................................................................................................... 6-7
6.5.1.6 User Name ............................................................................................................................... 6-7
6.5.1.7 Password .................................................................................................................................. 6-7
6.5.1.8 Sequence # ............................................................................................................................... 6-7
6.5.1.9 Test Connection ....................................................................................................................... 6-8
6.5.1.10 Save.......................................................................................................................................... 6-8
6.5.1.11 Cancel ...................................................................................................................................... 6-8
6.5.2 Edit Server Details ........................................................................................................................ 6-9
6.5.3 Delete Server ................................................................................................................................. 6-9
6.6 SSRDS Info ................................................................................................................................. 6-10

7 The Archiver 7-1

7.1 Introduction ................................................................................................................................... 7-1
7.2 Redundant Historian...................................................................................................................... 7-2
7.3 Installation of the Archiver ........................................................................................................... 7-3
7.3.1 Prerequisite for Installing the Archiver ......................................................................................... 7-3
7.3.2 Installing Archiver ........................................................................................................................ 7-3
7.4 Archive Editor ............................................................................................................................... 7-6
7.5 Archive Editor Menus ................................................................................................................... 7-6
7.5.1 File Menu ...................................................................................................................................... 7-6
7.5.2 Options Menu ................................................................................................................................ 7-7
7.5.3 Editor Menu .................................................................................................................................. 7-8
7.5.4 Help Menu..................................................................................................................................... 7-8
7.6 Change Archiver Redundant Server Names.................................................................................. 7-9
7.6.1 Select Redundant Type ................................................................................................................. 7-9
7.6.2 Please enter the name or address(s) of the Archiver Redundant computer(s) ............................. 7-10
7.6.3 Setup Parameters ......................................................................................................................... 7-10
7.6.4 Start/Stop File Synchronization Service ..................................................................................... 7-10

Contents ii
 WS-401 Replicator and Archiver User Guide

7.6.5 Save ............................................................................................................................................. 7-11

7.6.6 Save and Close ............................................................................................................................ 7-11
7.6.7 Cancel.......................................................................................................................................... 7-11
7.7 Change SCADA System Type .................................................................................................... 7-11
7.8 Change Clean-up Time ............................................................................................................... 7-12
7.9 Start/Stop Archive Service .......................................................................................................... 7-12
7.10 Archives ...................................................................................................................................... 7-13
7.10.1 Add Archive .............................................................................................................................. 7-14
7.10.1.1 Source Database for Redundant Historian ............................................................................. 7-17
7.10.2 Edit Archive .............................................................................................................................. 7-18
7.10.3 Delete Archive ........................................................................................................................... 7-19
7.10.4 Job List ...................................................................................................................................... 7-19
7.10.5 Edit Job ...................................................................................................................................... 7-21
7.10.6 Status Messages ......................................................................................................................... 7-24
7.11 Table and Column Names in the Archive Database ................................................................... 7-26
7.11.1 Table Names .............................................................................................................................. 7-26
7.11.2 Column Names in Historical Data Tables ................................................................................. 7-26
7.11.3 Column Names in the Operations Messages Table ................................................................... 7-27
7.12 Table Adjustment in the Archive Database................................................................................. 7-30
7.12.1 Deleting Points in a Dataset ...................................................................................................... 7-30
7.12.2 Adding Points to a Dataset ........................................................................................................ 7-30
7.12.3 Renaming Points Contained in a Dataset .................................................................................. 7-30
7.13 Archiver Log Files ...................................................................................................................... 7-31
7.14 Installation of the Archiver Web Service (optional) ................................................................... 7-32

8 Replicator Status Points 8-1

9 Appendices 9-1
9.1 Appendix A - Outbound Connections from ADMS to Replicator ................................................ 9-2
9.2 Appendix B Database Server Setup Tips ...................................................................................... 9-4
9.2.1 SQL Server .................................................................................................................................... 9-4
9.3 Using an Alternate Database Driver ............................................................................................. 9-6

Contents iii
 WS-401 Replicator and Archiver User Guide

1 Introduction

This document describes how to set up and maintain the Replicator. The Replicator is a program that
replicates the SCADA/ADMS database to a SQL Server or Oracle database in real-time.

A companion program, called the Archiver, can be used to transfer the historical data in the replicated
database into a set of larger tables for long-term storage.

Note on Survalent Web Applications: The Replicator is a pre-requisite for the following Survalent web
applications – WebSurv/SurvCentral, CSR Call Handler OMS Dashboard and Mobile Crew. These
applications currently only support reading and writing data to SQL databases.

A Replicator editor is provided that gives you full control over what part of the SCADA/ADMS database is
replicated.

Chapter 2 describes some SQL Server database setup.

Chapter 3 describes how to install and set up the Replicator.

Chapter 4 describes how to use the Replicator editor to add more tables and fields to the replication
process.

Chapter 5 describes how to enable historical datasets for replication without using the Replicator Editor.

Chapter 6 describes how to install and use the SSRDS program.

Chapter 7 describes how to install and use the Archiver.

Chapter 8 lists the Replicator Status Point.

Introduction 1-1
 WS-401 Replicator and Archiver User Guide

2 SQL Server

This chapter describes some details in what you need to do for the SQL Server database installation.
The SQL Server database will be populated by SCADA data in real-time by the Replicator. It’s this
replicated database that drives the SCADA Web Server.

The versions of SQL Server that are supported by the Replicator are express, standard, and enterprise
edition of SQL Server 2017/2019. However, when used with WebSurv or in redundant configurations,
only standard and enterprise of SQL Server 2017/2019 are supported. If WebSurv will be running on its
own dedicated server (or in a DMZ), then SQL Server Express is supported, Default Instance is required.

Note: When moving the SQL database from one server to another, rename the old SQL database to
reflect that it is obsolete. Also, if SQL has been upgraded, the database has moved, or changed, use the
Survalent Replicator Setup program. See section 4.3.2 Database Preferences for details.

SQL Server 2-1

 WS-401 Replicator and Archiver User Guide

2.1 Setup of Microsoft SQL Server

To install SQL Server login with administrative privileges and then insert the SQL Server 2019 installation
media.

The installation defaults to using the SQL connection settings (a Trusted connection authenticated by
Windows, or a name & password authenticated by SQL Server) that the you provide for the installation
process.

If you want to change that, it is done from Replicator Setup program, using this button .

When you are installing the SQL Server:

• In the Feature Selection Screen, select the components of SQL Server which are to be installed:

o Database Engine Services

o Client Tools Connectivity
o Client Tools Backwards Compatibility

• A “Default instance” is recommended

• For best support of Survalent applications including Replicator, sure to enable “Mixed Mode (SQL
Server authentication and Windows authentication)” radio button

SQL Server 2-2

 WS-401 Replicator and Archiver User Guide

• Provide a password for the SQL Server administrator account (this account is not the one
normally used by Replicator)

• Typically, you would add the current user as an administrator of the SQL server. The SQL Server
installer will pick up the user which is currently logged in and add the name to the “Specify SQL
Server administrators” field.

2.1.1 SQL Server Management Studio

If you want to manage SQL Server from this machine you may also install the SQL Server Management
Studio, or other management tool of your choice.

SQL Server 2-3

 WS-401 Replicator and Archiver User Guide

3 Installing the Replicator

This chapter describes how to install the Replicator. The Replicator can be installed on Windows or
Windows Server.

NOTE: If you are a WebSurv user, the Replicator install kit is included with the WebSurv install kit. The
description contained in this chapter is based on installing the Replicator from the WebSurv kit. The
procedure is the same, however, if you are using a separate standalone Replicator install kit.

SCADA Replicator Editor 3-1

 WS-401 Replicator and Archiver User Guide

3.1 Installation of the Replicator

1. Locate the installation files provided and run the ScadaReplicator.exe file.
Result: The following screen displays.

2. Click Next.
Result: The License Agreement screen displays.

SCADA Replicator Editor 3-2

 WS-401 Replicator and Archiver User Guide

3. Accept and click on the Next button.

Result: The User Information screen displays.

4. Accept and click on the Next button.

Result: The Destination Folder screen displays.

5. In the “Select Scada System Type” section click on Windows Scada.

SCADA Replicator Editor 3-3

 WS-401 Replicator and Archiver User Guide

6. In the “I will use Scada Replicator for” section check the box for each product that you intend to
use this Replicator database with.

Note: The Replicator will automatically be configured to include the database tables and fields
needed by the products you selected. In addition, at a later time, you can add more tables and
fields that may be required.

7. In the “Select Database Type” section choose the database server type that you will be
replicating to.

Note: Some of the Products listed above are only supported by Microsoft SQL Server. Please
consult the individual documentation for more information:
• OMS-404 Call Handler User Guide
• OMS-405 Dashboard Lobby Mode User Guide
• OMS-406 Dashboard Mobile Mode User Guide
• WS-400 WebSurv Installation Guide

8. Check the “Set the Replicator Manager as a startup program” box to have the program started
every time the computer starts up.

9. Check “Replicator always waits for a connection from SCADA” if you never want Replicator to
initiate a connection to the SCADA server.

Note: Replicator can initiate a connection to the SCADA server or it can accept a connection from
the SCADA server (which is a more secure configuration). If you select this option, it ensures the
more secure configurated is always used. If you intend to use OMS web applications that want to
submit changes through the replicated database to the SCADA Master, you must use this
“outbound” connections from SCADA for Replicator (RRecv service) and its companion service
ChangeManager. To make SCADA initiate the connection to Replicator you must define the
Replicator connection using STC Explorer. See Appendix A.

10. Click on the Next button.

Result: If the Microsoft SQL Server is button was selected, the Select Microsoft SQL Server
Properties screen displays.

If Oracle was selected, go to step 16.

SCADA Replicator Editor 3-4

 WS-401 Replicator and Archiver User Guide

11. In the SQL Server Host section:

• The destination SQL Server Host Name is the name of the server where Microsoft SQL
Server is installed

• If required by your SQL server, you can specify a non-standard port for the connection to
the destination SQL Server Host. To do this, in the SQL Server Host Name field add the
non-standard port number with a comma separator.

For example, SCADASERVERA,4431where SCADASERVERA is the SQL Server Name and

4431is the non-standard port number

Note: To reinstall the Scada Replicator, when the non-standard port is selected by the SQL
Server Configuration Manager, you have to return non-standard port to 1344 (standard port) by
the same SQL Server Configuration Manager and then the start new installation.

Do not forget to switch your port number back to the non-standard port number.

12. In the Database Destination section

If you select…. Then

the Scada Replicator Instillation will search a Default
SQL Server Instance, then will try to establish
connection with Default SQL Server Instance throw
standard port and finally run a SQL script to create the
Local Computer (SQL Server Default ScadaDB database.
Instance)
Note: If the Default SQL Server Instance does not exist
or a non-standard port is selected for the Default SQL
Server Instance, the Scada Replicator installation will be
failed with an error message.

a script file (CreateScadaDB.sql) will be added in the

[Drive]:\Program Files\Quindar\ScadaReplicator\Scripts
directory on the computer where the Scada Replicator is
being installed.
Local Computer (SQL Server Named
Instance) or Remote Computer Note: Before starting the Replicator (via Replicator
Manager), you must copy this script file to the remote
computer and have Microsoft SQL Server on the remote
computer execute it (to create the SCADADB
database).

SCADA Replicator Editor 3-5

 WS-401 Replicator and Archiver User Guide

13. In the Authorization section

If…. Then….
Replication can use a trusted
Select the Trusted Connection checkbox.
connection to the SQL server
you want Replicator to use a SQL you have to uncheck Trusted Connection and specify the
Server account to connect to the User Name and Password of any existing SQL Server
database account.

Note: The Trusted Connection mode is recommended when the Scada Replicator and Microsoft
SQL Server are installed on the same local computer.

The SQL Server account mode is recommended when the Scada Replicator and Microsoft SQL
Server are installed on different computers.

The SQL Server account must have permission to execute stored procedures inside the
SCADADB.

14. If the Oracle radio button was selected, the Select Oracle Database Properties screen displays.

Enter the following information:

• In the Service Name field, enter the net service name that you defined

• In the User Name and Password fields, enter the username and password that you defined

SCADA Replicator Editor 3-6

 WS-401 Replicator and Archiver User Guide

15. Click on the Next button.

Result: The Select Connection Properties screen displays.

16. Enter the information in the following fields to define a connection to the ADMS server. This may
be used if your SCADA system does not support “outgoing” connections to Replicator (see
Appendix A), and is needed by the Replicator Setup program if you need to define custom ADMS
data that you want to replicate.

The field descriptions are:

• Connection Timeout is the time, in milliseconds, to wait for the ADMS server to respond
before generating an error. The default value is 1000 (milliseconds)

• Connection Retries are the number attempts to receive a response from the ADMS server
before generating an error. The default value is 1

• Timer Send Period is the interval, in milliseconds, at which to execute a stored procedure
that updates a special data table in the replicated database. This table contains the
following information: status of replication, number of updates in the last interval, time of
last update from SCADA. The default value of this interval is 5000 (milliseconds)

• The Redundancy Group ID is an identification number of a group of redundant replicators.

Only one replicator from a redundant group will be connected to SCADA at any given time.
For more information on redundant replicators, see section 6.1, Redundant Replicators. If
you don’t intend to configure redundant replicators, set the group ID to zero. (Note: If your
ADMS server is making connections “outbound” to Replicator, those connections may be
defined for both Replicators in a redundant pair, as discussed in Appendix A)

SCADA Replicator Editor 3-7

 WS-401 Replicator and Archiver User Guide

17. Click on the Next button.

Result: The Select SCADA host name or IP address(s) screen displays.

18. For the SCADA Host section

If you have…. Then….

One SCADA server Select Single master and enter a name(s) for Host A.

Two SCADA servers in a redundant Select Dual Redundant and enter the names for Host
pair A and Host B.
Select Quad Redundant and enter the names for Host
There or four servers in a redundant
A, B and C. Only enter a name is Host D if you have a
configuration
fourth server.

If any of the SCADA host computers have dual network cards, and therefore two host names,
then enter the two host names (or two IP addresses). One address will belong to the LAN A
address collection and other will belong to the LAN B address collection.

19. After filling in the required information, click on the Check button.
Result: The Next button becomes enabled.

SCADA Replicator Editor 3-8

 WS-401 Replicator and Archiver User Guide

20. Click on the Next button.

Result: The Ready to Install the Application screen displays.

21. In the Ready to Install the Application screen, click on the Next button.
Result: The SCADA Replicator is installed and the Finish screen displays.

22. Click on Finish.

Result: You will be left with the original Scada Web Installation Toolkit screen.

SCADA Replicator Editor 3-9

 WS-401 Replicator and Archiver User Guide

3.2 Configuring an Outgoing Connection to a Replicator

Rather than relying on an “incoming” connection from your Replicator to the SCADA Server (which could
require less-secure network settings, such as an open port on the SCADA Server and/or its firewall), you
can configure SCADA Server to initiate an outgoing connection to the Replicator.

Current versions of the Replicator will listen for this connection, and if it does not occur, will then attempt
to establish a connection to the SCADA Server. This allows the Replicator to work with old or current
SCADA Servers, with or without an outgoing connection configured.

To make use of the more secure connection from SCADA Server to the Replicator, you must define the
Replicator connection using STC Explorer. To ensure only this more-secure connection is used, configure
Replicator during installation to always use this connection, as described in step 11 of the installation
procedure in Chapter 4.

3.2.1 Configuring Explorer

1. Navigate to the System branch.

2. Expand the Replication folder and go to the Replicators node.

SCADA Replicator Editor 3-10

 WS-401 Replicator and Archiver User Guide

3. Right-click in the right-hand pane and choose New to open the Replicator editor.

4. Give your replicator connection a name and a meaningful description.

5. To use an outgoing connection from SCADA Server to Replicator, check the option Scada Host
Connects to Replicator.

Note: Leaving this un-checked will mean the SCADA Server will wait for Replicator to initiate the
connection (less secure).

6. Enter the host name or IP address of the computer where Replicator is installed.

Note: If you have installed and configured dual redundant replicators (as discussed in step 18 of
the installation procedure in Chapter 2), enter the name or address of the second computer here
too.

7 Enter the name of an optional Status Point with which to monitor the state of the active replicator.
This will be used in place of one of the SYS$.REPLICATOR_n point that will otherwise be
updated. The Status Point entered (or the default one) may be used to support a SmartVU
display to monitor replicator state in addition to the on-line monitor available in the STC Explorer.
The Status Point may be a 2 state one, to support legacy active/not-active behavior, or will now
support a third state indicating that replication is either in progress or complete.

8 Enter the name of an optional Text Point with which to monitor the name of the active replicator.
This will be used in place of one of the SYS$.REPLICATOR_NAME_n point that will otherwise be
updated. The Text Point entered or the default one may be used to support a SmartVU display to
monitor the active replicator name rather than using the on-line monitor available in the STC
Explorer.

Certain products that make use of a replicated database also provide a means to make modifications to
selected data.

Please refer to the documentation for these products, listed in step 9 of the installation procedure in
Chapter 2.

SCADA Replicator Editor 3-11

 WS-401 Replicator and Archiver User Guide

If you are using any product that submits modifications to the SCADA database from the replicated
database, you must configure the Change Manager software to handle these modifications. To
accomplish this, simply check the option Scada Host Connects to Change Manager for this connection.

When outbound connections are enabled, you can configure the firewall to disable all inbound
connections from Replicator into SCADA. When you install Replicator, you can specify that it is not to
even try to connect, and just wait for connections from SCADA.

Note: For incoming modifications via Change Manager, the SCADA Server always initiates an outgoing
connection to the Replicator/Change Manager computer.

3.3 Replicator Manager

The Replicator Manager window is a window that allows you to monitor and manage the Replicator
program.

To run the Replicator Manager, select Start, point to Programs and click on Replicator Manager.

The icon of the Replicator Manager will be added in the system tray .

Double-clicking on the icon in the system tray brings up the Replicator Manager window if it was closed or
minimized before. Right-clicking on the icon brings up a popup menu containing Stop, Open, Close:

• Stop causes the Replicator to stop

• Open causes the Replicator Manager window to be launched

• Close causes the Replicator Manager window to close

The Replicator Manager window contains:

• Pushbuttons that allow you to start and stop the Replicator service

• An LED-style indicator showing the current status of the Replicator’s connection to the SQL
Server or Oracle database

• An LED-style indicator showing the current status of the Replicator’s connection to the SCADA
system

SCADA Replicator Editor 3-12

 WS-401 Replicator and Archiver User Guide

Note: When the Replicator starts (or reconnects after loss of connection), it first replicates the
entire SCADA database. This is called synchronization. After synchronization is complete, the
Replicator only transcribes changes.

• A display of information or error messages from the Replicator

• A checkbox that specifies whether the Replicator is to automatically start on reboot of the system.
This checkbox is checked for you by default

Note: If you do not reboot after installing the Replicator, you can start the Replicator manually by
using the Replicator Manager windows. See the next section.

3.3.1 Starting the Replicator

To start the Replicator, click on the Start pushbutton in the Replicator Manager window.

If the Replicator successfully connects with the SQL Server or Oracle database and the SCADA system,
the DB and SCADA status indicators change to green. During synchronization, the SCADA status
indicator flashes and the traffic light is yellow.

If no connection is established, the LED status indicators and the traffic light remain red.

When the synchronization process completes, the green SCADA status indicator stops flashing, and the
traffic light turns green.

SCADA Replicator Editor 3-13

 WS-401 Replicator and Archiver User Guide

Note: The DB LED represents the target database. The name of the target database server is displayed
beside this LED. The SCADA LED represents the source (SCADA) database source. The name of the
currently active SCADA server is displayed beside this LED.

3.3.2 Standby Replicator

It is possible to configure groups of redundant replicators. (See section 6.1, Redundant Replicators.) If
two or more replicators belong to the same redundancy group, only one of them will be allowed to
connect to SCADA. The SCADA master will reject connection attempts from the other replicators in the
same group, and they will be set in standby mode. In this case, the SCADA LED flashes red, and the
message Stand By is displayed beside the LED.

If the active replicator is stopped or loses connection to either its database or to SCADA, another
replicator from the same group will become active. If the stopped replicator is restarted, it will go into
standby mode.

Note: The redundancy group ID, if there is one, is displayed in the left top corner of the Replicator
Manager window.

SCADA Replicator Editor 3-14

 WS-401 Replicator and Archiver User Guide

4 Replicator Editor

4.1 Setup Tables and Historical Data Sets

If you have a SCADA system, a Replicator Editor program allows you to specify the SCADA tables and
fields that are to be replicated to the Microsoft SQL Server database.

When you install the Replicator, a default list of tables and fields is automatically created for you that, with
the exception of historical datasets, is sufficient for use by the web server. You really only need to use
the Replicator Editor to:

• Enable the historical datasets that you want replicated (for purposes of trend graphs)

• Enable any other additional tables and fields that you want replicated into the SQL Server
database for other purposes

The Replicator Editor program is included in the Scada Replicator install kit.

To run the Replicator Editor, select Start, point to Programs and click on RRecvSetup.

The list of tables and fields to be replicated is contained in a database file on the SCADA host computers.
You can run the Replicator Editor on any workstation that can access the currently active SCADA host
and where the STC Explorer is installed.

SCADA Replicator Editor 4-15

 WS-401 Replicator and Archiver User Guide

4.2 Replicator Editor

The Replicator Editor window, illustrated below, contains three panels:

• Tables
• Fields
• Historical Data Sets

SCADA Replicator Editor 4-16

 WS-401 Replicator and Archiver User Guide

4.2.1 Replicator Window Toolbar

Table 4-1 Replicator Window Toolbar Description Table

Icon Description
Log In – Click on this icon to login via the Log In dialog.

Logout – Click on this icon to logout.

Connection Preferences – Click on this icon to bring up the Connection Parameters dialog.
From here you to specify the host names of the SCADA host computers (up to four). If any of
the SCADA host computers has dual network cards, and therefore two host names, then enter
the two host names (or two IP addresses).

Application Preferences – Click on this icon to bring up the Replicator Preferences dialog. Go
to section 5.2 for more information.

Selecting a Table
To select a table to be replicated, check the corresponding checkbox in the Tables panel. The Fields
panel will update to show a list of all the fields contained in the selected table. Use the checkboxes in the
Fields panel to select the fields that you want. You can use the Select All and Deselect All pushbuttons to
select or deselect all of the fields respectively.

Historical Data Sets Panel

The Historical Data Sets panel contains a list of all the historical datasets that are in the SCADA system.
You can select which datasets you wish to have replicated by using the checkboxes. You can also
enable dataset replication by using the “Replicate Data set” checkboxes in the Historical Data Set editor
of the STC Explorer. Since the web server is capable of displaying trend graphs in the SmartVU-based
map displays, be sure to enable replication of all datasets whose data is referenced in SmartVU trend
graphs.

Saving Updated Tables

To save your updated list of tables and fields, click on the Save pushbutton. This causes the list to be
saved in the file RRecv_UserSetup.ini in the folder “driver:\Program Files\Quindar\ScadaReplicator”.

Separate User Setup File

Each Scada Replicator has its own user setup file. If you have multiple replicators belonging to the same
redundancy group, you must ensure that each replicator in the group has the same RRecv_UserSetup.ini
file.

For changes to take effect, stop and then restart the Replicator.

SCADA Replicator Editor 4-17

 WS-401 Replicator and Archiver User Guide

4.3 Setup Preferences

The Replicator Editor allows you to set up various categories of preferences. To access the Replicator
Preferences, click on the Application Preferences icon. The Replicator Preferences dialog displays the
following tabs:

• Service Preferences
• Database Preferences
• List of INI files

4.3.1 Service Preferences

The following section describes the Service Preference dialog.

Table 4-2 Replicator Preferences Field Description Table

Field Description
The field allows you to specify the Redundancy Group ID to
Redundancy Group ID
assign two or more replicators to a group.

Do not make changes to the settings on this field without

Number of Sync Records to be batched
assistance from Customer Support.

Do not make changes to the settings on this field without

Size of TCP stack receive buffer
assistance from Customer Support.

Do not make changes to the settings on this field without

Period of cleaning circular tables
assistance from Customer Support.
Do not make changes to the settings on this field without
Allow set Global replication of Datasets
assistance from Customer Support.

SCADA Replicator Editor 4-18

 WS-401 Replicator and Archiver User Guide

4.3.2 Database Preferences

Database Preferences allows you to specify the ADO Provider, the Database Name and the Host
(Server) Name.

Select your preferred Provider from the available choices. Then specify ScadaDB as the database name
(the default required by most Survalent applications) and the name of your database server.

Specify how Replicator will connect to this SQL Server:

• To use Windows Authentication, the Trusted Connection checkbox must be checked. Replicator
will connect using the account credentials it is running under (it is the Windows service named
RRecv, and you can view or change its credentials from the Services control panel, Properties,
under Log On As. But default, this will be LocalSystem, which will be suitable for most SQL
Servers installed locally on this same machine

• If you plan to use a remote SQL server instead, please refer to SQL Server Credentials, below

Alternatively, to use SQL Server Authentication, the Trusted Connection checkbox must be unchecked,
and a SQL username and password must be entered.

SCADA Replicator Editor 4-19

 WS-401 Replicator and Archiver User Guide

Whichever credentials are used, the SQL user must have permission to perform queries and execute
stored procedures inside SCADADB database.

These same credentials specified here for Replicator (the Windows service RRecv) are also used by the
windows service ChangeManager, which is installed at the same time. If you selected Trusted Connection
above, and made a change to the Log On As setting for the RRecv service, please make the
corresponding change to the ChangeManager service as well.

4.3.3 SQL Server Credentials

Advanced installations that require access to a remote SQL Server will require some adjustments.

If you select a SQL username and password above, then that login must be created with suitable
permissions in the SQL Server you are using. It must then have a User mapping to ScadaDB database,
with appropriate permissions. For simplicity and reliability, we recommend assigning this user to the
“db_owner” role in ScadaDB.

If you prefer to use a Trusted connection:

(a) Usually, the SQL server and Replicator server will be members of the same Windows domain, or
trusted domains. In this case, a Windows domain user account should be selected (or a new one
created) to be used by Replicator and ChangeManager services.

(b) This Windows account will require the Log On as a Service right; Windows will add that
automatically when you first configure a windows service to Log On As this account (below).

(c) The SQL server will require a Login to be created, to permit this account to access the database
server. This Login will not require sysadmin or other server-wide access other than the usual Public
role. In ScadaDB there will then need to be a corresponding User mapping, with the appropriate
permissions. The simplest approach, which avoids encountering potential issues with future
software features, is to assign the db_owner database role to this User.

(d) For the RRecv and ChangeManager services, modify their Log On As configurations to use this
account username and password. This can be done from the Services control panel, in the
service’s Properties. (The first time this is done, Windows may report that the account has now
been given the Log On as Service right).

SCADA Replicator Editor 4-20

 WS-401 Replicator and Archiver User Guide

4.3.4 List of INI files

In addition to the table and field selections you may make (which are saved in the file RRecv_User.ini) the
Replicator must also process the tables and fields required by any products you may have selected
during Replicator installation (see step 8 in the installation of Replicator in chapter 4).

This configuration is contained in the INI files which you may see here. Do not make changes to the
settings on this page without assistance from Customer Support.

SCADA Replicator Editor 4-21

 WS-401 Replicator and Archiver User Guide

5 Historical Datasets

This chapter describes how to enable replication of historical datasets without using the Replicator editor.

5.1 Datasets
The historical datasets in the SCADA system are not automatically enabled for replication. It's up to you
to enable replication of all datasets for which you have graphs. Datasets that do not have graphs do not
need to be replicated as far as the web server is concerned, but if you want the data in the SQL Server
database for other purposes, you can have them replicated too.

If, in the web browser, you invoke a graph whose dataset is not being replicated, the graph window will be
empty.

SCADA Historical Datasets 5-1

 WS-401 Replicator and Archiver User Guide

5.1.1 SCADA

If you have a SCADA system, you can enable replication of historical datasets in two ways:

• Check the “Replicate data set” checkbox for each desired dataset in the historical dataset editor
of the STC Explorer

• Check the checkboxes beside the desired datasets in the Historical Datasets pane of the
Replicator Editor. See chapter 4, Replicator Editor

SCADA Historical Datasets 5-2

 WS-401 Replicator and Archiver User Guide

6 SSRDS

This chapter describes how to install and use the SSRDS (Survalent SCADA Search Replicator Database
Service Setup) program. SSRDS stands for Scada Search Replicated Database Server. The purpose of
the SSRDS program is to support redundant replicators.

6.1 Redundant Replicators

It is possible to install and operate one or more groups of redundant replicators. Each member of the
group operates on a separate machine and has its own target replicated database.

In each redundancy group, only one replicator is allowed to connect to SCADA. The SCADA master will
reject connection attempts from the other replicators in the same group, and they will be set in standby
mode. (See section 3.3.2, Standby Replicator.)

If the active replicator of a group stops or loses connection to either its database or to SCADA, another
replicator from the same group will automatically become active. If the stopped replicator is restarted, it
will go into standby mode.

A replicator’s redundancy group assignment is made when you specify the Redundancy Group ID at
installation time (see chapter 2).

SCADA SSRDS 6-1

 WS-401 Replicator and Archiver User Guide

6.2 Setup of Microsoft SQL Server

See Chapter 2 SQL Server for details on the setup of the SQL Server.

6.3 Purpose of SSRDS

The function of the SSRDS program is to find the location of the currently active replicator and identify it
to other applications such as WebSurv and Archiver. When the currently active replicator fails and
another replicator in the group takes over, SSRDS’s action causes the applications that use the replicated
database to automatically switch over to the new replicator. SSRDS is a combination of:

• A Windows service

• An editor

• A system tray information panel

It must be installed on every computer that contains an application that needs access to the replicated
database.

Note: Even if your system is not configured for redundant replicators, you still need to install SSRDS (its
job is trivial in this case but still necessary).

6.4 Installation of SSRDS

SSRDS is mandatory and must be installed even if you don’t operate redundant replicators.
1. Locate the installation files provided and run the SSRDS_InstallKit.exe
Result: The Welcome screen displays.

SCADA SSRDS 6-2

 WS-401 Replicator and Archiver User Guide

2. Click on the Next button.

Result: The License Agreement screen displays.

3. Accept the license agreement and click on the Next button.

Result: The User Information screen displays.

4. Click Next
Result: The Destination Folder screen displays.

SCADA SSRDS 6-3

 WS-401 Replicator and Archiver User Guide

5. Click on the Next button.

Result: The Ready to Install the Application screen displays.

6. Click on the Next button.

Result: The installation begins and during the process, the SSRDS Editor displays.

Note: This is where you define to SSRDS service the locations of all the replicators in the group.
By default, the replicator list contains only one entry, corresponding to the machine where you’re
presently installing SSRDS.

SCADA SSRDS 6-4

 WS-401 Replicator and Archiver User Guide

7. In this step

If you intend to…. Then….

Operate WebSurv and Replicator (in non- Take the default, and close the editor by
redundant mode) on this machine clicking on the Close button
If you intend to operate redundant replicators, Define the replicator list as described in section
or the replicator has been installed on a 6.5, SSRDS Editor. Then close the editor.
different machine

8. When you see the Finish screen, click on the Finish button.

6.5 SSRDS Editor

The SSRDS Editor allows you to create and maintain a list of servers where the replicated databases
may be found. This list is used by the SSRDS windows service to constantly monitor the status of the
replicators.

The SSRDS service starts by checking the status of the first replicator in the server list. If this replicator’s
status is “synchronized”, then SSRDS sets this as the currently active replicator. All applications on this
machine will then connect to that replicator. SSRDS continues to monitor the replicator, and if it fails,
SSRDS will proceed to find another one from the list.

When you right-click in the SSRDS Editor window, a pop-up menu appears containing three items:

• Add Server
• Edit Server
• Delete Server

SCADA SSRDS 6-5

 WS-401 Replicator and Archiver User Guide

6.5.1 Add New Server

This function allows you to add a new replicator server to the list. It opens a Linked Server Details - Add
New Linked Server window, as shown below.

Enter the desired server properties into the fields described below, and then click on Save.

6.5.1.1 In Service
This is a checkbox that specifies whether the server is to be used or not. The default is checked. You can
uncheck it later if you wish to temporarily turn off the server for some reason.

At least one server must have an In-Service status.

6.5.1.2 Server Name

This is the name or IP address of the server. The name or IP address must exist in the network.

For Oracle, the Server name is the net service name that you defined.

SCADA SSRDS 6-6

 WS-401 Replicator and Archiver User Guide

6.5.1.3 Description
This is just a description of the server. It’s optional. You can leave it blank.

6.5.1.4 Database Type

You can select from two types of databases:

• Choose SQLOLEDB for Microsoft SQL Server 2017 or higher

• Choose MSDAORA for Oracle (version 9 or higher)

6.5.1.5 Trust Connection

This checkbox allows you to specify whether SSRDS is to use Windows Authentication to connect to the
database (trusted connection) or SQL Server Authentication (non-trusted connection).

If you choose the trusted connection option:

• SSRDS must be installed on the same computer that contains the database (in this case, the
replicated SCADA database)

• If you choose the trusted connection option, the User Name and Password fields will be disabled

The Oracle provider does not support trusted connections, so if you selected the Oracle provider, the
Trust Connection checkbox will be disabled.

6.5.1.6 User Name

For Microsoft SQL Server, if you did not select Trust Connection, you have to guarantee the following
condition:

• Microsoft SQL Server is installed with Mixed Authentication mode (Windows Authentication and
SQL Server Authentication). After installing SQL Server, you can add a new user account inside
the SQL Server database. You can use this account name and password to define a non- trusted
connection

For Oracle, you can use any existing user account name in the Oracle database.

6.5.1.7 Password
Enter the password for the account whose username you entered above (SQL Server or Oracle).

6.5.1.8 Sequence #
This is a number that specifies the order that you want SSRDS to check the servers. Give the server that
you want checked first the lowest number. By default, the editor assigns a sequence number of 1 to the
first server that you add, and increments by 1 for each new server.

SCADA SSRDS 6-7

 WS-401 Replicator and Archiver User Guide

6.5.1.9 Test Connection

To verify correct definition of your replicated database server connection properties, you can click on the
Test Connection button. If the connections are established without error, the following confirmation
message will be displayed.

If the connections are not established properly, an error message is displayed.

6.5.1.10 Save
To save the server information, click on the Save button and the following confirmation message displays

There is no need to stop and restart the SSRDS service for your changes to take effect.

6.5.1.11 Cancel
To close the edit window without saving your changes, click on Cancel.

SCADA SSRDS 6-8

 WS-401 Replicator and Archiver User Guide

6.5.2 Edit Server Details

To edit the properties of an existing server, select the desired server from the server list, right-click and
then choose Edit Server Details from the pop-up menu that displays.

This brings up the Linked Server Details - Edit Linked Server window that displays the selected server
details, as shown below.

The <<, <, >, >> navigation buttons allow you to navigate through the various server definitions in the list.

6.5.3 Delete Server

To delete a server definition, select the desired server from the server list, right-click and choose the
Delete Server function from the pop-up menu that appears.

This will bring up a Delete Server Confirmation dialog.

SCADA SSRDS 6-9

 WS-401 Replicator and Archiver User Guide

6.6 SSRDS Info

The SSRDS Info window displays information about the current replicated database server.

To run SSRDS Info, double-click on the icon in the system tray.

If you did not reboot the computer after installation of SSRDS, the icon will not yet be in the system tray.
In this case, go to C:\Program Files (x86)\quindar\SSRDS and then double-click on TraySSRDSInfo.exe

The SSRDS Info window will then appear and the icon will be added to the system tray. The SSRDS Info
window contains following information:

Table 6-1 SSRDS Info Window Field Description Table

Field Description
This is the Server name or IP address of the currently active replicated
Replicated Database Server
database. The server description is in brackets.

This is the name of the currently active SCADA host computer, from
Scada Host
which the replicator takes data.
This is the currently active replicator status:

• Synchronized (color is green) - synchronization is completed

• Synchronizing (color is yellow) - synchronization is in process
• Not connected (color is red) - synchronization is failed, or there is
no connection with the Scada host or with the replicated database
server

SCADA Connection

This is the time when the replicator last updated the replicated
Last Update
database.

SCADA SSRDS 6-10

 WS-401 Replicator and Archiver User Guide

7 The Archiver

This chapter describes how to install and use the Archiver program.

7.1 Introduction
The purpose of the Replicator program is to replicate your SCADA database into a relational database
such as SQL Server or Oracle. The historical data (datasets and operations messages) is replicated
exactly. That is, if you have one year’s worth of data in a dataset on the SCADA system, that’s what you
will have in the corresponding table of the replicated database.

The purpose of the Archiver program is to extend the historical data tables beyond the sizes imposed by
the configuration of the SCADA system. The Archiver does this by transferring the data from the
replicated tables into a parallel set of archive tables, and allowing the archive tables to grow to a much
larger size, or even indefinitely. The data records contained in the archive tables are in the same format
as that of the replicated tables.

The Archiver can be installed on multiple computers (including the web server itself), to provide multiple
archiving services, if desired. Each instance of the Archiver can be configured to archive any
combination of historical tables from the replicated database into another database. This configuration is
done on each archive computer via the Archive Editor (described in section 7.4 through to section 7.10,
Archives).

SCADA The Archiver 7-1

 WS-401 Replicator and Archiver User Guide

The Archiver does not have to be installed on the computers that contain the source (replicated) or the
destination (archive) database, although it may be convenient for you to do so. Furthermore, each
instance of the Archiver can be configured (via the Archive Editor) to archive to multiple target databases,
i.e., produce multiple archives, with the same or different set of tables.

The Archiver supports both SQL Server and Oracle, and is capable of archiving from SQL Server into
Oracle and vice versa.

The Archiver can be installed on, Windows Server 2017 or higher. Because the source and destination
database can both be on other computers, the Archiver has been designed to not require either SQL
Server or Oracle on its own computer. The Archiver stores its configuration in a set of XML files.

7.2 Redundant Historian

As mentioned above, one instance of Archiver can archive to multiple databases on different machines.
Or you can, without buying additional licenses, install Archiver on multiple machines.

In addition, Archiver supports a redundancy capability that, together with a redundant replicator, allows
you to create a redundant historian.

The way it works is like this:

• Two or more replicators are operated in a single redundancy group. This requires an additional
license. Each replicator writes to its own target database, so both the replicator program and the
replicated database are redundant

• Only one replicator is active at any given time, however. As mentioned before, this saves on the
SCADA CPU loading. A program called SSRDS monitors all the replicators in the group and tells
applications such as WebSurv and Archiver where the active replicator is. (See section 6.1,
Redundant Replicators, and section 6.3, Purpose of SSRDS)

• Two copies of Archiver are installed, each with its own target archive database. Both Archivers
are active, connected to the same replicator, and archive to their own target databases. When
the replicator’s failover, both Archivers reconnect and continue archiving

• In order for the historians to be truly redundant, it’s necessary that their archive and job lists be
identical. To achieve this without requiring that you maintain parallel job lists on both computers,
each redundant Archiver uses a web service to periodically check for changes that you may have
made on the other Archiver. Any changes that are found on the other Archiver are brought back
to update this Archiver. This means that when you want to edit the archives or job list, it’s not
necessary to make the changes in both Archives

Note: The installation the Archive Web service used for synchronization is described in section
7.14.

The result is two active and fully redundant Archivers with identical archive data. They are fully redundant
in the sense that they derive their data from redundant replicators (both Archivers switch when there is a
replicator failover – using just one replicator means there is a single point of failure). But the load on the
SCADA system is equivalent to just one replicator.

SCADA The Archiver 7-2

 WS-401 Replicator and Archiver User Guide

7.3 Installation of the Archiver

7.3.1 Prerequisite for Installing the Archiver

The Archiver requires that version 4.0 or higher of the Microsoft .NET framework be installed. If this is not
the case, an error message displays when you attempt to install the Archiver. After installing .NET
Framework, you will be able to install the Archiver.

7.3.2 Installing Archiver

The following procedure describes how to install Archiver.

1. Locate the installation files provided and run the on ArchiverSetup.exe.

Result: The Welcome screen displays.

2. Click on the Next button.

Result: The License Agreement screen displays.

SCADA The Archiver 7-3

 WS-401 Replicator and Archiver User Guide

3. Accept the license agreement and click on the Next button.

Result: The User Information screen displays.

4. Next button.
Result: The Destination Folder screen displays.

5. Click on the Next button.

Result: The Select Properties screen displays.

6. In the “Select SCADA System Type” section select Windows Scada.

SCADA The Archiver 7-4

 WS-401 Replicator and Archiver User Guide

7. In the “Select Redundancy Type” section…

If you select…. Then….

Non-redundant Go to step 9.

The fields below are activated and you must specify the:

• Name(s) or IP address(es) of the other instance of Archiver

• Frequency of the job file synchronization between the two

Archivers. The default value for the frequency of job file
synchronization is 1 minute

Redundant

8. Click on the Next button.

Result: The Ready to Install the Application screen displays.

9. Click on the Next button.

10. When you see the Finish screen, click on the Finish button.

SCADA The Archiver 7-5

 WS-401 Replicator and Archiver User Guide

7.4 Archive Editor

The Archive Editor allows you to configure the Archiver and define the archive(s) that it is to produce. To
invoke the Archive Editor, go to click Start>All Programs>Survalent Archive Editor.

A blank screen displays, as illustrated below.

The following sections describe the menus in the Archive Editor and how to use them to define archives.

7.5 Archive Editor Menus

The menu functions that are available in the Archive Editor are summarized below.

7.5.1 File Menu

This menu contains the following function:

• Exit - This menu item closes all forms and causes the Archive Editor to exit

SCADA The Archiver 7-6

 WS-401 Replicator and Archiver User Guide

7.5.2 Options Menu

This menu contains a list of Archiver options as displayed below.

Table 7-1 SSRDS Info Window Options Menu Description Table

Option Description
When you select this option a dialog box displays. Check this checkbox
if you want to archive the OMS tables.

Archive OMS Tables

This menu item allows you change the redundancy option and enter the
Change Archiver Redundant
name(s) or address(s) of the other Archive computer. See section 7.6,
Server Names
Change Archiver Redundant Server Names, for details.

Change SCADA System This menu item allows you to specify the type of SCADA system that
Type you have). See section 7.7, Change SCADA System Type, for details.

This menu item allows you to change the clean-up schedule. By default,
clean-up time is 03:00 a.m. and is set up for you by the installation
Change Clean-up Time
procedure. See section 7.8, Change Clean-up Time, for details on what
this means.

The Archiver program that performs the archiving function is designed

as a Windows service. This menu item allows you to start and stop the
Start/Stop Archive Service Archive and File Synchronization (if the redundant type is selected)
services and enable it for automatic startup on reboot. See section 7.9,
Start/Stop Archive Service, for details.

SCADA The Archiver 7-7

 WS-401 Replicator and Archiver User Guide

7.5.3 Editor Menu

This menu contains two functions as displayed below.

Table 7-2 Editor Menu Description Table

Option Description
This menu item allows you to create, update or delete archives and edit
Archives
their job lists. See section 7.10, Archives, for details.
Scada Search Replicated This menu item brings up the SSRDS Editor that allows you to edit the
Database Server Editor list of replicated database servers. See section 6.5 for details.

7.5.4 Help Menu

This menu contains the option About - This menu item opens the About Archiver window.

SCADA The Archiver 7-8

 WS-401 Replicator and Archiver User Guide

7.6 Change Archiver Redundant Server Names

This menu item opens a Change Archiver Redundant Server Names dialog. This dialog contains three
panels:

• Select Redundant Type

• Please enter the name or address(s) of the Archiver Redundant computer(s)

• Setup Parameters

7.6.1 Select Redundant Type

The current redundancy option is displayed in the panel. If you select non-redundant, the two other
panels are disabled.

SCADA The Archiver 7-9

 WS-401 Replicator and Archiver User Guide

7.6.2 Please enter the name or address(s) of the Archiver Redundant computer(s)

If the redundant option is selected, this panel is enabled to specify the name(s) or address(s) of the other
Archiver. This information is used by the Archive Web Service on both Archivers to synchronize each
other’s archive and job lists. See section 7.14.

If the Archive Web Service is installed on both machines, you can test the connection to the other
Archiver’s Archive Web Service by clicking on the Test button. If the connections are established without
error, a confirmation message is displayed.

If the connections are not established properly the following error message displays:

• Connection with WebSurv-Manager is not established

7.6.3 Setup Parameters

The current value of the frequency of file synchronization between Archivers is displayed in this panel.
The default value is 1 minute. You can modify this value.

7.6.4 Start/Stop File Synchronization Service

This pushbutton opens a Start/Stop File Sync Service dialog. This dialog allows you to start and stop the
Archiver File Synchronization services (if the redundant option is selected).

The dialog also contains a checkbox that allows you to specify that the File Sync service is to start
automatically when the operating system starts (i.e., on reboot of the computer).

Note: This is separate from starting and stopping the Archive service (see section 7.9, Start/Stop Archive
Service).

SCADA The Archiver 7-10

 WS-401 Replicator and Archiver User Guide

The current status of the File Synchronization services is displayed in the status panel at the bottom of
the Archive Editor.

7.6.5 Save

Clicking on the Save button will cause your settings to be saved, but not close the Change Archiver
Redundant Server Names dialog.

7.6.6 Save and Close

Clicking on the Save button will cause your settings to be saved, and close the Change Archiver
Redundant Server Names dialog.

7.6.7 Cancel

To close the dialog without saving your changes, click on Cancel.

7.7 Change SCADA System Type

This menu item opens a Change SCADA System Type dialog. The current SCADA system type is
displayed in the dialog.

Choose Windows to connect to Survalent ADMS or SCADA on Windows. Choose VMS for legacy
SCADA on VMS.

You will probably never need to use this function, since you have an opportunity to specify the type of
SCADA system at installation time. This function is included primarily to make testing with both types of
system more convenient for Survalent.

SCADA The Archiver 7-11

 WS-401 Replicator and Archiver User Guide

7.8 Change Clean-up Time

This menu item opens a Change Clean-up Time dialog.

“Clean-up” refers to the clean-up of excess records in archive tables for which you have specified a
maximum size (the Number of Records to Keep field in the Job Editor). If a job has a blank Number of
Records to Keep, no clean-up is performed for that job (i.e., the table grows forever, and it’s your job to
trim it when it becomes too large).

The default clean-up time that is set by the installation procedure is 03:00 a.m. See Job Parameters in
section 7.10.5.

7.9 Start/Stop Archive Service

This menu item opens a Start/Stop Archive Service dialog. This dialog allows you to start and stop the
Archive and File Synchronization (if the redundant type is selected) services. The dialog also contains a
checkbox that allows you to specify that the Archive service is to start automatically when the operating
system starts (i.e., on reboot of the computer).

The current status of the Archive and File Synchronization (if the redundant type is selected) services are
displayed in the status panel at the bottom of the Archive Editor.

SCADA The Archiver 7-12

 WS-401 Replicator and Archiver User Guide

7.10 Archives
This menu item opens an Archives window, as illustrated below. This window displays the list of
archives.

In the Archives list, if you click on a column heading, the archives list becomes sorted by the selected
field.

If you right-click in the Archives window, a pop-up menu appears containing four items:

• Add Archive
• Edit Archive
• Delete Archive
• Job List

These menu functions are described below.

Note: If no archives have been created yet, only the Add Archive menu item displays.

SCADA The Archiver 7-13

 WS-401 Replicator and Archiver User Guide

7.10.1 Add Archive

This function allows you to define a new archive. It opens an Archive Details Add window, as shown
below.

Enter the desired archive properties into the fields described below, and then click on Save.

Table 7-3 Archive Details Add Field Description Table

Section Field Description

This is a checkbox that specifies whether the archive is to be active or
Archive Details Active not. Make sure this checkbox is checked. You can uncheck it later if
you wish to temporarily turn off the archive for some reason.

This is the name of the archive. The name must be unique (on this
computer) and cannot contain any of the following characters:
Name
< > " | \ / * ?

Description This is just a description of the archive. It’s optional.

The fields in the Source Database section define to the Archiver the
Source Database
data source, i.e., the replicated SCADA database.
You can select from two types of providers:

• Choose SQLOLEDB for Microsoft SQL Server (version 2017

Provider or higher)

• Choose MSDAORA for Oracle (version 9 or higher)

SCADA The Archiver 7-14

 WS-401 Replicator and Archiver User Guide

Table 7-3 Archive Details Add Field Description Table continued

Section Field Description

Server name is a computer name. If the provider is Oracle, this field is
Source Database Server
labeled Service Name. In this case, you need to enter the net
continued Name
service name that you defined when you installed Oracle.
Database
Name This is the name of the replicated SCADA database. Enter
SCADADB. The Oracle provider does not make use of a specific
database name (it uses user names), so if you selected Oracle as the
provider, this field will not be shown.
Trust This checkbox allows you to specify whether the Archiver is to use
Connection Windows Authentication to connect to the database (trusted
connection) or SQL Server Authentication (non-trusted connection).

If you choose the trusted connection option, you have to guarantee at

least one of the following conditions:

• The Archiver is installed on the same computer that contains

the database (in this case, the replicated SCADA database),
or

• The Archive service is defined with a “Log on as” option set to

This account, where the specified account has Windows
Authentication permission to access the SQL Server
database.

• The Archive installation procedure sets the “Log on as”

option to Local System account.

If you choose the trusted connection option, the User Name and
Password fields will be disabled. The Oracle provider does not
support trusted connections, so if you selected the Oracle provider,
the Trust Connection checkbox will be disabled.

SCADA The Archiver 7-15

 WS-401 Replicator and Archiver User Guide

Table 7-3 Archive Details Add Field Description Table continued

Section Field Description

Source Database
continued
User Name For Microsoft SQL Server, if you did not select Trust
Connection, you have to guarantee the following condition:

• Microsoft SQL Server is installed with Mixed

Authentication mode (Windows Authentication and SQL
Server Authentication). After installing SQL Server, you
can add a new user account inside the SQL Server
database. (See the SQL Server Login Properties – New
Login screen below.) You can use this account name and
password to define a non- trusted connection.

For Oracle, you can use any existing user account name in the
Oracle database.

Password Enter the password for the account whose username you
entered above (SQL Server or Oracle).

Target Database The fields in the Target Database section define the Archive’s
target database, i.e., the database to which the archive data is
to be written. Other than the fact that they are for the target
database, these fields have the same meaning as the
corresponding fields in the Source Database section.
Options for Target
Database
Schema for
The field allows you to select either the point name or the point
Column Names
ID to be used for the column names in the Archive Database.
I want to save
Time(s) as Local Select this if you want the records to be time stamped with the
Time (Default is local time.
UTC)

SCADA The Archiver 7-16

 WS-401 Replicator and Archiver User Guide

Table 7-3 Archive Details Add Field Description Table continued

Section Field Description

Test Connection To verify correct definition of your source and target database connection
properties, you can click on the Test Connection button.

If the connections are established without error, the following confirmation

messages will be displayed.

If the connections are not established properly, error messages are

displayed.
Save To save the archive definition, click on the Save button. The archive
definitions are stored in a file called ProjectList.xml, located in the
Databases folder.
Cancel To close the edit window without saving your changes, click on Cancel.

If you did make any changes, a confirmation message will be displayed.

7.10.1.1 Source Database for Redundant Historian

In a redundant historian configuration, each of the two Archivers gets data from the same source
(replicated) database. The SSRDS service on each Archiver machine tells the Archiver which is the
currently active replicated database.

In this configuration, you do not need to specify the source database for each redundant historian.
Instead, the source database is automatically filled in for you from the SSDRS data, and these fields are
disabled for editing.

NOTE: You should install and configure SSRDS first. But if you didn’t, you’ll just see blanks in the source
database fields. If you install and configure SSRDS afterwards, and then come back to the Archive
editor, you will see the defined source database definitions.

SCADA The Archiver 7-17

 WS-401 Replicator and Archiver User Guide

7.10.2 Edit Archive

To edit an existing archive, select the desired archive from the archive list, right-click and then choose
Edit Archive from the pop-up menu that appears. This brings up the Archive Details Edit window that
displays the selected archive details, as shown below.

The <<, <, >, >> navigation buttons allow you to navigate through the various archive definitions in the
list.

Note: If you wish to rename an existing archive, you have to first stop the Archive service. You can do
this by clicking on the Start/Stop Archive Service button, which will bring up the Start/Stop Archive Service
dialog (see section 7.9, Start/Stop Archive Service).

If you do not stop the Archive service before renaming the archive, an error message is displayed.

SCADA The Archiver 7-18

 WS-401 Replicator and Archiver User Guide

7.10.3 Delete Archive

To delete an archive definition, select the desired archive from the archive list, right-click and choose the
Delete Archive function from the pop-up menu that appears. This will bring up a Delete Archive
Confirmation dialog.

In order to delete an archive, you have to stop the Archive service. You can do this via the Start/Stop
Archive Service item in the Options menu. If you don’t stop the Archive service before deleting an
archive, an error message is displayed.

7.10.4 Job List

An archive’s job list is the set of tables (historical datasets and operations messages) that the Archiver is
to transfer to the archive database.

To display an archive’s job list, select the desired archive from the archive list, right-click and then choose
Job List from the pop-up menu that appears.

This brings up the Job List window that displays the selected archive’s job list, as shown below.

SCADA The Archiver 7-19

 WS-401 Replicator and Archiver User Guide

Table 7-4 Job List of Archive Description Table

Field Description
Show Active Job List This checkbox allows you to filter the Job List window to show active jobs only.

The Job List window automatically refreshes itself every minute to show you the
Refresh Screen current status of all the jobs. If you want an immediate refresh at any time, you
can click on the Refresh Screen button.
When the Archive service is active, it transfers data according to the schedules
that you have defined for the active jobs.

Run Manually For testing purposes, a pushbutton function is included that makes it possible to
operate the Archiver manually. This button is labeled Run Manually, and can only
be operated on an active archive while the Archive service is stopped (otherwise
the pushbutton is dim). For Survalent use only.
Close To close the job list window, click on the Close button.

You do not have to create the job list. It’s created for you automatically and contains a list of all the
historical datasets that are in the replicated SCADA database (i.e., all the datasets that have the
“Replicate” flag set). For each historical dataset, the displayed job shows the dataset name (which is also
the job name), the dataset description, and the current job status. The list also includes a special job for
operations messages, with a job name of PRTSPL.

When you create a new archive, all of the jobs are initialized to inactive. All you have to do for each job
that you want to activate is to check an “Active” flag and enter some scheduling parameters. This is
described in section 7.10.5.

If you click on a column heading in the Job List, the list of jobs becomes sorted by the selected field.

The job list for an archive is stored in three files, SourceTableList.xml, JobList.xml, and ArchiveList.xml,
located in a subfolder with the same name as the archive. Do not edit these files.

If you right-click in the Job List, a pop-up menu appears. This pop-up menu contains one item, Edit Job,
that allows you to edit the job.

SCADA The Archiver 7-20

 WS-401 Replicator and Archiver User Guide

7.10.5 Edit Job

To edit a job, select the desired job from the job list, right-click and then choose Edit Job from the pop-up
menu that appears. This opens the Edit Job window that displays the selected job details, as shown
below.

The <<, <, >, >> navigation buttons allow you to navigate through the various job records in the list.

The Edit Job window is probably the most important window in the Archive editor. This is where you get to
tell the Archiver how you want each table to be archived.

The various sections of the Edit Job window are described below.

Table 7-5 Job Details Edit Window Description Table

Section Field Description

This section contains static information about the job: ID, Name
and Description. None of these fields is editable. They come
from the replicated database. The ID field contains the dataset
Job Details
number. The Name and Description are the name and
description of the dataset. The information in this section is
stored in the SourceTableList.xml file.

SCADA The Archiver 7-21

 WS-401 Replicator and Archiver User Guide

Table 7-5 Job Details Edit Window Description Table continued

Section Field Description

This section contains the job’s schedule parameters, as listed
Job Parameters below. The information is this section is stored in the JobList.xml
file.
Checking this checkbox enables this job (i.e. causes the data in
the replicated source table to be transferred and accumulated in a
parallel archive table).
Active
When you create a new archive, all jobs are inactive by default.
For the jobs that you want active, you have to make them active
(by checking this checkbox), and define the scheduling
parameters.
By default, the target table name is simply the source table name
with the prefix ARCHIVE_ placed in front of it (e.g. if the source
table name is HISTSAMPLES1, the archive table name is
ARCHIVE_HISTSAMPLES1).

If you want to specify your own archive table names, you may do
so by entering them in the Target Table Name field for each job.

Note: When you edit an existing job and change the target table
name from the default, the Archive program will automatically
rename the table in the target database and continue to append
archive data to the renamed table. No data is lost.
Target Table
Name If you change the table name again, however, the archiver will not
rename the table again. It will simply create a new table and start
archiving into the new table. The old table will still exist and will
contain old archive data.

If you want to rename a table again without this split, you have to:

• Stop the archiver

• Rename the table in the job editor and rename the table in
the target database

• Restart the archiver

This scheduling parameter specifies when transfer of data begins

Start Time
each day for this job. By default, this is 00:00:00 (midnight).

This scheduling parameter specifies an interval, in minutes, at

which the data transfers are to be executed. There is no default
value for this parameter. The job interval only needs only to be
equal to or greater than the sample interval.
Interval (min)
If you leave it blank, no transfers will take place. For example, if
you enter a Start Time of 00:30:00 and an Interval of 60 minutes,
the transfers will occur every hour on the half-hour.

SCADA The Archiver 7-22

 WS-401 Replicator and Archiver User Guide

Table 7-5 Job Details Edit Window Description Table continued

Section Field Description

This parameter specifies the maximum number of records that the
Archiver is to maintain in the archive table. When the archive
table grows to a size that exceeds this, old records are eliminated
to maintain the specified table size. The time at which such tables
are trimmed to their specified maximum size is defined via the
Max Records To Change Clean-up Time function described in section 7.8, Change
Keep Clean-up Time.

If this parameter is not specified, no clean-up is performed for this

job (table). There is no default value for this parameter.

The Start Time and Interval are displayed in the Job List window.

This section shows information about the most recent transfer

Last Update performed by the Archiver for this job. None of these fields are
editable. This information is stored in the ArchiveList.xml file.

For a historical dataset, this is the timestamp (in local time) of the
Last Sample Time most recent sample record that has been archived. The Archiver
(Local Time) uses this as a placeholder for when it next performs a scheduled
transfer of the dataset table.

Last Sample Time

This field contains the last archived sample time in UTC.
(UTC Time)

For operations messages, this field contains the serial number of

the most recent operations message record that has been
archived. As in the case of the last sample time for a historical
dataset, the Archiver uses this serial number as a placeholder for
Last Serial
when it next performs a scheduled transfer of the operations
Number
messages table.

The Last Sample Time (local time) and Last Serial Number are
displayed in the Job List window.

This section shows information about this job’s current schedule.

Schedule None of these fields are editable. This information is stored in the
ArchiveList.xml file.

Next Schedule This is the time of the next scheduled transfer of data from the
Time source table to the target (archive) table.

This is the time at which the most recent transfer of data was
actually performed.
Last Run Time
Note: The Next Schedule Time and Last Run Time are displayed
in the Job List window.

SCADA The Archiver 7-23

 WS-401 Replicator and Archiver User Guide

Table 7-5 Job Details Edit Window Description Table continued

Section Field Description

This section shows information about this job’s transfer
Transfer operations. None of these fields are editable. This information is
stored in the ArchiveList.xml file.
This is the number of records that are transferred in a single
transaction (i.e., in a single SQL statement). The more records
that can be written in each transaction, the higher will be the
Batch Size efficiency of the overall transfer.

The value of the batch size is calculated by the Archiver, and

varies between 100 and 1, depending on conditions.

Number Records This is the number of records that were transferred at the last
Last Transferred scheduled transfer.
This is the total number of records contained in the target table.
You will see this value grow after every transfer where a non-zero
number of records is transferred.

For jobs with a maximum table size defined, you will see this
Total Records In
value drop to the specified maximum after the scheduled clean-up
Table
operation. See section 7.8, Change Clean-up Time, and Job
Parameters in section 7.10.5.

The number of records last transferred and the total number of

records in the table are displayed in the Job List window.

This section shows the status (result) of the job’s most recent
Last Message transfer operation. These fields are not editable. This information
is stored in the ArchiveList.xml file.
Code This is a numeric status (result) code.
This is a message string that describes the status (result) of the
most recent transfer operation.
Message
See the Status Message table below for a list of all of the possible
status codes and messages.

7.10.6 Status Messages

Table 7-6 contains a list of all of the possible status codes and messages, along with suggested action for
you to take when you see the message.

Table 7-6 Status Message Table

Code Text Message User Action
0 OK: Last transfer successful None required
1 OK: No records to transfer None required
2 OK: Transfer in progress None required
10 OK: Clean-up successful None required

SCADA The Archiver 7-24

 WS-401 Replicator and Archiver User Guide

Code Text Message User Action

Check if the table exists in the source database.
3 ERROR: Source table missing
Open and read the Log file in [Archive Name] folder.
Check the source database connection properties.

ERROR: Failed to open or read Check the network connection.

4
source table
For MS SQL Server, check if Mixed Authentication is
defined.

Check if the SCADA System Type is correct.

ERROR: Failed to create target
5
column list
Open and read the Log file in [Archive Name] folder.
Check if the SCADA System Type is correct.
ERROR: Failed to create target
6
table
Open and read the Log file in [Archive Name] folder.
Check if the SCADA System Type is correct.
ERROR: Failed to add column(s) to
7
target table
Open and read the Log file in [Archive Name] folder.

ERROR: Failed to insert row(s) to

8 Open and read the Log file in [Archive Name] folder.
target table

Check if the SCADA System Type is correct.

9 FATAL: Bad scheduling parameters
Open and read the Log file in [Archive Name] folder.

11 ERROR: Failed to clean-up Open and read the Log file in [Archive Name] folder.
Check the target database connection properties.

Check the network connection.

ERROR: Failed to open or read
13
target table For MS SQL Server, check if Mixed Authentication is
defined.

Open and read the Log file in [Archive Name] folder.

SCADA The Archiver 7-25

 WS-401 Replicator and Archiver User Guide

7.11 Table and Column Names in the Archive Database

7.11.1 Table Names

By default, the table names in the archive database consist of the concatenation of and the string
“ARCHIVE-” and the source table names. For example, for a dataset number 10, you would find in the
replicated database a table named HISTSAMPLES10. In the archive database, you will find a
corresponding table named ARCHIVE-HISTSAMPLES10.

You have the option to assign your own table names in the archive database. See Job Parameters in
section 7.10.5.

Note: Because the archive table names are distinct from the replicated table names, it is possible to
specify the target database to be the same as the replicated database (database name = SCADADB).

We don’t recommend that you do this, however. In fact, we recommend that you place your archive
database on a separate machine altogether, if available, especially if you are operating WebSurv. The
reason for doing so is that this avoids heavy load on the archive (due to activities such as reporting, data
mining and other analyses) from affecting the performance on your web server.

7.11.2 Column Names in Historical Data Tables

For historical datasets, the Archiver converts the relatively obscure point ID-based column names in the
replicated database into easy-to-use point name-based column names in the archive database.

The table below illustrates the conversion of Replicator column names to Archiver column names, where:

• pid = point ID
• Pointname = point name

Table 7-7 Replicator Column Names vs Archiver Column Names

Data Item Replicator Column Archiver Column

Instantaneous value VpidA Pointname-VAL
Maximum VpidB Pointname-MAX
Minimum VpidC Pointname-MIN
Time of maximum VpidD Pointname-TMAX
Time of minimum VpidE Pointname-TMIN
Average VpidF Pointname-AVG
Summation VpidG Pointname-SUM
Maximum of average VpidH Pointname-MAXAVG
Minimum of average VpidI Pointname-MINAVG
Time of maximum of average VpidJ Pointname-TMAXAVG
Time of minimum of average CpidK Pointname-TMINAVG
Quality of Instantaneous value CpidA Pointname-VAL-Q
Quality of Maximum CpidB Pointname-MAX-Q

SCADA The Archiver 7-26

 WS-401 Replicator and Archiver User Guide

Data Item Replicator Column Archiver Column

Quality of Minimum CpidC Pointname-MIN-Q
Quality of Time of maximum CpidD Pointname-TMAX-Q
Quality of Time of minimum CpidE Pointname-TMIN-Q
Quality of Average CpidF Pointname-AVG-Q
Quality of Summation CpidG Pointname-SUM-Q
Quality of Maximum of Average CpidH Pointname-MAXAV-Q G
Quality of Quality of Minimum of Average CpidI Pointname-MINAVG-Q
Quality of Time of maximum of average CpidJ Pointname-TMAXAVG-Q
Quality of Time of minimum of average CpidK Pointname-TMINAVG-Q

7.11.3 Column Names in the Operations Messages Table

For operations messages, the table in the replicated database is named PRTSPL, while that in the
archive database is named PRTSPL-ARCHIVE. Both tables have the same structure. This structure is
shown in Table 7-8.

Table 7-8 Structure of Operations Messages Table

Field Name Data Type (SQL Server) Description

Primary key. This is a record number within the file on

the SCADA system, and is not meaningful in the
archived table. (In the archived table, you will find many
PKEY int
records with the same value of PKEY because the file
on the SCADA system will have wrapped around many
times.)

“Line has been printed” flag. This is used by the

PRINTED tinyint SCADA system to record the fact that the message has
been printed.
Message timestamp. This is the timestamp of the
TIME datetime
operations message.
Message text. This is the text of the message (up to
DESC ntext (520 bytes)
520 bytes).
Zone group ID. This is the numeric ID of the zone group
ZONEID int
associated with the event recorded in this message.
POINTID int Point ID. This is the numeric ID of the point.
Station ID. This is the numeric ID of the station that the
STATIONID int
point is on.
Record type code. See the list of record type codes in
RECORDTYPE int
Table 7-9.
DATAFLAGS int Data flags. See the list of flags in Table 7-10.

SCADA The Archiver 7-27

 WS-401 Replicator and Archiver User Guide

Field Name Data Type (SQL Server) Description

User ID. This is the numeric ID of the user (if there is a

USERID int user) associated with the event recorded in this
message.

Alarm format ID. This is the numeric ID of the alarm

ALARMSKLID int format associated with the alarm recorded by this
message. (Zero if this is not an alarm.)

Point state. If this is an alarm, and it’s for a status point,

this is the value of the point that caused the alarm. If it’s
STATE int
an analog point, it’s a code (called limit state) that
specifies what alarm limit was violated. See Table 7-12.

Alarm flags. See the list of flags in Table 7-11.

ALARMFLAGS tinyint Note: Some of these flags will change value in the
alarm record on the SCADA system after the operations
records has been written.

Alarm priority (0 – 4). If this is an alarm, this is the

PRIORITY tinyint
alarm priority. Zero otherwise.

FUNCCODE tinyint Function code. Not used.

Sequence number. This is a 32-bit sequence number

SEQUENCE int used by the archiver program to keep track of what it
has archived and what it has not.

Annotation timestamp. This is the timestamp of the

OMATIME datetime annotation that is associated with the operations
message (if there is any).

Annotation text. This is the text of the annotation that is

OMATEXT ntext (520 bytes)
associated with the operations message (if there is any).

SCADA The Archiver 7-28

 WS-401 Replicator and Archiver User Guide

Table 7-9 Operations Message Record Type Codes

Record Type Code Meaning

0 Plain text.
1 Manual Set operation.
2 Remove (Activate) operation.
3 Tag or Untag operation.
4 Alarm Block operation.
5 Alarm Unblock operation.
6 Alarm Acknowledge operation.
7 Change Limits operation.
8 Edit Point operation.
13 Alarm Raise.
14 Alarm Clear.
20 Login or Logout
21 Control operation.
23 Publish line sections operation.
25 Publish WorldView database operation.
50 Switch Orders edit or execute.
51 Guarantee edit or issue/surrender operation.

Table 7-10 Data Flags

Data Flag Value (Hex) Meaning
0x02 Record contains annotation.
0x08 Record is selected for summary report.
0x80 This is an alarm that was suppressed by storm alarm suppression.

Table 7-11 Alarm Flags

Alarm Flag Value (Hex) Meaning
If remote alarm annunciation is required for this record, this flag is set
after the record has been forwarded to the appropriate recipients. This
0x01
flag is set immediately if no remote annunciation is required for this
record.
This alarm record has been delayed by the delayed alarm annunciation
0x02
timer.
0x04 This is a blocked alarm record.
0x08 This is an “all alarms blocked on a point” record.
0x10 This is an unacknowledged alarm.
0x20 This is an active (outstanding) alarm.
0x40 This alarm is on the operating list.
0x80 This alarm has cleared.

SCADA The Archiver 7-29

 WS-401 Replicator and Archiver User Guide

Table 7-12 Analog Point Limit State Codes

Limit State Value Meaning
1 Below lower reasonability limit
2 Below lower emergency limit
3 Below lower pre-emergency limit
4 In normal range
5 Above upper pre-emergency limit
6 Above upper emergency limit
7 Above upper reasonability limit

7.12 Table Adjustment in the Archive Database

This section describes what happens to the archive database when you modify the point list in a historical
dataset.

7.12.1 Deleting Points in a Dataset

If, on the SCADA system, you delete points from an existing dataset, the Replicator automatically adjusts
the replicated table to drop the columns that no longer exist. The Archiver, however, does not delete
such columns from the corresponding archive table. The data that was previously archived from the
deleted points will remain in the archive table. From now on, all new sample records in the archive will
contain nulls for these points.

If you wish to remove these columns, you are free to do so at any time, using SQL Server Management
Studio (after you have extracted the old data that you wish to keep, if any).

7.12.2 Adding Points to a Dataset

If you add points to an existing dataset, the Replicator automatically adjusts the replicated table to add
the new columns. In this case, the Archiver will do the same thing, i.e. add the new columns to the
archive table. The new columns will contain nulls for all rows prior to the time that the columns were
added.

7.12.3 Renaming Points Contained in a Dataset

If you simply modify the name of a point that is contained in a dataset, this does not affect the Replicator
since its column names are point ID-based. The Archiver does not really know the reason for the change,
and therefore does not know whether to just rename the column or to create a new column.

It therefore does the following:

• It leaves the old column as is, but stops archiving into it. New sample records will contain nulls in
this column

• It adds a new column corresponding to the new point name and initializes its contents to that of
the old column. New sample values for this point will go into this new column

SCADA The Archiver 7-30

 WS-401 Replicator and Archiver User Guide

7.13 Archiver Log Files

The Archiver maintains three levels of log files that you may inspect if you suspect a problem. They are:

• Service Log File - This file is called ServiceLogList.log and is located in the [Install Archive
Directory]/Service folder. In this file, the Archiver keeps track of the dates and times that the
Archive service was started and stopped

• Archiver Log File - This file is called ProjectLog.log and is located in the [Install Archive
Directory]/Databases folder. In this file, the Archiver logs actions that you perform using the
Options menu (e.g., Change SCADA System Type and Change Clean-up Time)

• Log File for each Archive - This file is called LogList.log and is located in the [Install Archive
Directory]/Databases/ [Archive Name] folder. Each archive has its own log file. These log files
are used to log errors that occur during data transfers. Events that are logged in this file include
those listed in the table below.

Table 7-13 Error Messages That Are Logged in the Archive Log File

Code Text Message

3 ERROR: Source table missing
4 ERROR: Failed to open or read source table
5 ERROR: Failed to create target column list
6 ERROR: Failed to create target table
7 ERROR: Failed to add column(s) to target table
8 ERROR: Failed to insert row(s) to target table
9 FATAL: Bad scheduling parameters
11 ERROR: Failed to recycle
13 ERROR: Failed to open or read target table

SCADA The Archiver 7-31

 WS-401 Replicator and Archiver User Guide

7.14 Installation of the Archiver Web Service (optional)

The purpose of the Archiver web service is to synchronize the archive and job lists of two Archivers that
are operating as a redundant historian. See section 7.2, Redundant Historian.

Prerequisite: IIS (Internet Information Service) must be installed.

1. Locate the installation files provided and run the ArchiverWebSetup.exe.

Result: The Welcome screen displays.

2. Click on the Next button.

Result: The License Agreement screen displays.

3. Accept the license agreement and click on the Next button.

Result: The User Information screen displays.

4. Click on the Next button.

Result: The Destination Folder screen displays.

5. Click on the Next in the Destination Folder screen.

Result: The Ready to Install the Application screen displays.

6. Click on the Next button.

7. When you see the Finish screen, click on the Finish button.

SCADA The Archiver 7-32

 WS-401 Replicator and Archiver User Guide

8 Replicator Status Points

The state of the replicator can be monitored from the Scada Explorer\ Systems\ Replication.

On startup, the Scada Server replicator code will check for these points and update them as required.

SYS$,REPLICATOR - set to ‘1’ if any replicator is connected, ‘0’ if no replicator connected.

SYS$,REPLICATOR_1
SYS$,REPLICATOR_2
SYS$,REPLICATOR_3
SYS$,REPLICATOR_4

If these points are 2-state then set to ‘1’ (or normal state) if a certain replicator is connected, 0 otherwise.

If these points are 4-state then set to ‘1’ (or normal state) if a certain replicator is connected and is fully
synchronized, 2 if it is connected and still in the process of synchronizing, 0 otherwise.
Note: These are the default status points that are used automatically, if they exist. These may optionally
be overridden by alternative points if configured in the dialog in section 3.2

SCADA Replicator Status Points 8-1

 WS-401 Replicator and Archiver User Guide

9 Appendices

The following sections provide additional configuration information related to your Replicator.

Appendices 9-1
 WS-401 Replicator and Archiver User Guide

9.1 Appendix A - Outbound Connections from ADMS to Replicator

Traditionally, Replicator uses the SCADA connection information you provided during installation to
initiate a connection to the ADMS Server. This approach may not meet your network security objectives,
because it requires access to the SCADA LAN, including an open port in any firewall that you may have
between the Replicator and the ADMS Server.

To avoid this situation, the ADMS Server can be configured to initiate outbound connections to one or
more Replicators. This way, only the firewall on the (less secure) Replicator database server is required
to permit an incoming connection. To accomplish this, use STC Explorer to define the necessary
Replicator connection(s) under System | Replication.

Right-click in the right hand pane and choose New to create a Replicator connetion. The dialog below will
appear, where you can enter the connection details.

You may give the connection a Name and Description that you find helpful.

Appendices 9-2
 WS-401 Replicator and Archiver User Guide

Specify the IP address or host name of the machine where Replicator is installed, in Replicator Host 1. To
configure ADMS Server to initiate outbound connections to this Replicator, select the option Scada Host
Connects To Replicator (leaving this un-checked will mean that the ADMS Server will wait for an incoming
connection from the Replicator, in the traditional way).

If you have installed two Replicators in a redundant configuration (operating on the same SQL or Oracle
database), enter the name or IP address of the backup Replicator in Replicator Host 2. The ADMS Server
will attempt to connect to each Replicator in turn, until one is successful.

To replicate a database for use by other applications, including WebSurv, where no modifications to the
external data are to be transferred back to the ADMS Server, this is all that is required. Press OK to save
the configuration.

Periodically, the ADMS Server will attempt to establish the connection. You can monitor the progress
using the Replication Online Monitor window, or by using the Replicator Manager application on the
machine(s) where Replicator is installed.

However, if you will be using the Replicated database with a Survalent web application that is required to
submit modifications of data to the ADMS Server (such as Call Handler or Mobile Crew, for example), you
must select the option Scada Host Connects To Change Manager as well. This will cause the ADMS
Server to connect out to the “Change Manager” on the Replicator machine in order to retrieve the
modified data. (This connection is always out-bound.)

Appendices 9-3
 WS-401 Replicator and Archiver User Guide

9.2 Appendix B Database Server Setup Tips

9.2.1 SQL Server

See attached screenshots. If these are not set correctly in SSMS then Replicator will fail (installation and
synchronization).

The SQL Server should normally be configured for both Windows and SQL Server authentication. The
Replicator and the Survalent web applications may also require SQL Server authentication.

Appendices 9-4
 WS-401 Replicator and Archiver User Guide

If the Replicator and the web applications connect using the NT AUTHORITY\SYSTEM identity this Login
must be configured with the necessary permissions. (This may already be set up as a default, depending
on your SQL Server installation). If required, select the Sysadmin role.

Appendices 9-5
 WS-401 Replicator and Archiver User Guide

9.3 Using an Alternate Database Driver

By default, Replicator connects to the database server using the SQLOLEDB.1 provider that is typically
included with Windows. You may require a different one in some circumstances, such as:

• You are using an Oracle database

• You are required to use more recent security protocols, such as TLS 1.2

• The SQLOLEDB provider is not available on your server

You may use Windows’ Regedit program to specify the name of the provider to use in this registry key:

• HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Quindar\ScadaWeb\AdoProvider
(the portion in italics is required on 64-bit systems only)

The following provider names are supported (providing you have them installed on your server):

• SQLOLEDB

• MSOLEDBSQL

• SQLNCLI11

• MSDAORA

• .ORACLE

• SCADAPROVIDER

Appendices 9-6