SurvalentONE

SQ-402
SCADA ADD-IN
USER GUIDE

Version 1.4
 SQ-402 SCADA Add-In 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 use the SCADA Add-In for Excel.
 SQ-402 SCADA Add-In User Guide

Revisions

Version Description
1.0 Initial version.
1.1 Updated screen shots and document format.
1.2 Updated cover and logo.
1.3 Removed Chapter 6. For information on how to add excel reports to SmartVU please
refer to the Editors Online Help – How to Create a Pushbutton Report.
1.4 Updated all the screens and procedures to the updated SCADA Add-In feature.
 SQ-402 SCADA Add-In User Guide

Contents

1 Introduction 1-1

2 Installation of SCADA Add-In 2-1

2.1 Setup ............................................................................................................................................. 2-1
2.1.1 Disable Survalent Add-In ............................................................................................................ 2-3
2.2 Host IP Addresses ......................................................................................................................... 2-4
2.3 Connecting to the SCADA System ............................................................................................... 2-5
2.3.1 Preferences .................................................................................................................................. 2-6

3 Current Data 3-1

3.1 Current Data Query ....................................................................................................................... 3-1
3.2 Query Timer .................................................................................................................................. 3-5

4 Historical Data 4-1

4.1 Historical Data Query ................................................................................................................... 4-1
4.1.1 External Historian........................................................................................................................ 4-3

5 Other Data 5-1

5.1 Other Data Query .......................................................................................................................... 5-1

SCADA Contents i
 SQ-402 SCADA Add-In User Guide

1 Introduction

This document describes how to use the SCADA add-in for Microsoft Excel.

The SCADA add-in allows PC users on the network to import both current and historical SCADA data
directly into Microsoft Excel. The SCADA add-in uses the TCP/IP network protocol to forward queries to
the SCADA database server and return responses containing data back to the client.

In order to use the SCADA add-in, your PC must be running Windows NT, 2000, 2003, XP or Vista, and
your Microsoft Office package must be Office 2000 or later.

You must install the SCADA add-in on each PC that you intend to use.

Chapter 2 describes the installation procedure. The SCADA database server is already installed on your
SCADA host computers.

Chapter 3 describes how to import current data from the SCADA system.

Chapter 4 describes how to import historical data from the SCADA system.

Chapter 5 describes how to import other data tables from the SCADA system.

SCADA Introduction 1-1

 SQ-402 SCADA Add-In User Guide

2 Installation of SCADA Add-In

This chapter describes how to install the SCADA Add-In on your PC.

2.1 Setup
You can install the SCADA add-in from an install kit downloaded from Survalent’s web site. Depending
on your MS Excel version, you must install the appropriate 32 (x86) or x64-bit version of the software.

You can find the Excel version via File>Account>About Excel.

Click on the About Excel button to view the About Microsoft dialog which will indicate what version of
Excel you are running.

Figure 2-1 Scada Add-In exe

SCADA Installation of SCADA Add-In 2-1

 SQ-402 SCADA Add-In User Guide

Figure 2-2 Welcome Screen

The installation procedure automatically enables the SCADA Add-In for Excel.

After the SCADA Add-In application is installed, you'll see a Survalent menu when you click on the Add-
ins tab.

Figure 2-3 Survalent menu

SCADA Installation of SCADA Add-In 2-2

 SQ-402 SCADA Add-In User Guide

2.1.1 Disable Survalent Add-In

If for some reason, you want to disable it later, you can do so by unchecking the SCADA Add-In check
box in the COM Add-ins dialog.

You can access this dialog by going to File>Options>Add-ins. Select COM Add-ins in the Manage field
(located at the bottom of the window) using the drop-down menu and then click Go.

Figure 2-4 COM Add-ins Dialog

This step unloads the add-in and frees up memory, but does not remove it from your computer.

SCADA Installation of SCADA Add-In 2-3

 SQ-402 SCADA Add-In User Guide

2.2 Host IP Addresses

If your PC has already been networked to the SCADA host computers, you can skip this section.

For the PC to be able to connect to the SCADA host computers via the LAN, you have to define the IP
addresses of the host computers to the PC. You do this by creating and editing a file called HOSTS (no
extension). Windows comes with a HOSTS.SAM sample file that you can use as a model. The
content of the sample file is shown in Figure 2-5.

Figure 2-5 Sample HOSTS File

# Copyright (c) 1994 Microsoft Corp.

#
# This is a sample HOSTS file used by Microsoft TCP/IP for Chicago
#
# This file contains the mappings of IP addresses to host names. Each
# entry should be kept on an individual line. The IP address should
# be placed in the first column followed by the corresponding host name.
# The IP address and the host name should be separated by at least one
# space.
#
# Additionally, comments (such as these) may be inserted on individual
# lines or following the machine name denoted by a '#' symbol.
#
# For example:
#
# 102.54.94.97 rhino.acme.com # source server
# 38.25.63.10 x.acme.com # x client host

127.0.0.1 localhost

Make a copy of HOSTS.SAM in the same directory and call it just HOSTS (no extension). Edit it and add
the node names and IP addresses of your two SCADA host computers. Just add them to the bottom of
the list, under localhost. For example:

127.0.0.1 localhost
10.0.0.60 HOSTA
10.0.0.61 HOSTB

Note: You will find HOSTS.SAM and HOSTS in C:\Winnt\System32\drivers\etc

SCADA Installation of SCADA Add-In 2-4

 SQ-402 SCADA Add-In User Guide

If your HOSTS file is correct, you should, after rebooting, be able to ping the host computers from a
Command Prompt window, as in:

C:\WINDOWS>PING HOSTA

Pinging HOSTA [10.0.0.60] with 32 bytes of data:

Reply from 10.0.0.60: bytes=32 time=110ms TTL=242

Reply from 10.0.0.60: bytes=32 time=117ms TTL=242
Reply from 10.0.0.60: bytes=32 time=115ms TTL=242
Reply from 10.0.0.60: bytes=32 time=111ms TTL=242

C:\WINDOWS>

2.3 Connecting to the SCADA System

You can connect your application to the SCADA system by clicking on the Connection... item of the
Survalent menu.

In the Connection Properties dialog that appears, enter the TCP/IP host names and a SCADA account.

The connection data need only be entered once for each spreadsheet (it's saved when you save the
spreadsheet).

Figure 2-6 Connection Properties Dialog

You can now perform queries on the SCADA system. This is described in the following chapters.

SCADA Installation of SCADA Add-In 2-5

 SQ-402 SCADA Add-In User Guide

2.3.1 Preferences

This dialog allows you to set your preferences for a connection to the SCADA host(s).

Figure 2-7 Preferences Dialog

2.3.1.1 Language
Allows switching between Default English and Spanish for the entire Scada Add-in dialogs. An Application
restart is required to complete the language change.

2.3.1.2 Use local connection settings

When active, hosts names are stored in the Excel Workbook instead of Windows Registry, when SCADA
Add-in connects it uses the settings from the local file instead.

This is especially useful for customers having multiple SCADA systems. If this feature is not used, they
need to reconfigure the connection every time they need to query a different SCADA System.

2.3.1.3 Timeouts
• Connection – This is the wait time for a connection with SCADA Server to get established. The
default is 5 seconds

• Command - Not currently used, do not change.

SCADA Installation of SCADA Add-In 2-6

 SQ-402 SCADA Add-In User Guide

3 Current Data

This chapter describes how to use the SCADA add-in to import current data.

3.1 Current Data Query

From the Survalent menu, click on the Point Data... item. This brings up a Point Data dialog that shows a
list of queries that retrieve point data from the SCADA system.

Note: When a Point Data query is Added, it will be listed in the Queries window.

To add a point data query, click on the Add... pushbutton.

Figure 3-1 Point Data Dialog

SCADA Current Data 3-1

 SQ-402 SCADA Add-In User Guide

A PointData Edit/Add dialog appears.

Figure 3-2 Point Data Edit/Add Dialog

The following steps describe how to populate the Point Data Edit dialog.

1. Type in a query name.

2. Select the desired point table from the Table drop-down menu.
Note: Your choices of tables consist of AnalogPoints, StatusPoints and TextPoints.

3. In order to save the query, you have to specify the destination of the returned data (what location
of which worksheet). You can browse for the desired worksheet from the Name field under
Destination Worksheet.

4. To specify which points, you want considered for the query, either:

• Check the “All Points” checkbox to specify all points or

• Leave the “All Points” checkbox unchecked and use the Browse… pushbutton to browse
for the desired points.

5. Check the “Query On Open” checkbox if you want the query to be automatically executed when
the spreadsheet is opened.

6. Check the Column Heading checkbox if you want column headings to be displayed in your report.

SCADA Current Data 3-2

 SQ-402 SCADA Add-In User Guide

7. Click on the Fields... button to select data fields.

Result: The Fields table displays.

Figure 3-3 Fields Dialog

8. Select the data fields that you want from the All Fields list by double-clicking on your selection.

9. For each data field, you can enter a caption in the Caption field to be used as the column
heading. (If you don’t enter a caption, the data field name will be used as the column heading.)
For example, the Value field will display as Status as shown in Figure 3-3.

Note: You can rearrange the order of the data fields by using the Up and Down buttons.

10. Click Ok to return to the Point Data Edit dialog.

11. Click on the Criteria... button to specify selection criteria based on field values.

In the example of Figure 3-4, we selected the TransCount field name, the > operator, typed in a
value of 10, and then clicked on Add.

Figure 3-4 Criteria Dialog

You can add multiple AND and OR clauses by using the Logical combo box.

12. After saving the query select the Get Data item from the Survalent menu.

SCADA Current Data 3-3

 SQ-402 SCADA Add-In User Guide

When you save the spreadsheet and invoke it later, the queries contained in all of the sheets of the
spreadsheet are automatically executed (if you checked the “Query On Open” checkboxes).

Query results may be of variable length. Therefore, if you use the “Query On Open” option, the
spreadsheet should be saved with the contents cleared.

Figure 3-5 Transition Counts Query

SCADA Current Data 3-4

 SQ-402 SCADA Add-In User Guide

3.2 Query Timer

Once the spreadsheet is invoked, the Start Timer... function allows you to enable automatic update of the
query at any interval.

Figure 3-6 Timer Settings Dialog

SCADA Current Data 3-5

 SQ-402 SCADA Add-In User Guide

4 Historical Data

This chapter describes how to use the SCADA add-in to import historical data.

4.1 Historical Data Query

The Historical Data... item of the Survalent menu brings up the list of queries in the spreadsheet that
retrieve historical data from the SCADA system.

To create a new historical data query, click on the Historical Data... item of the Survalent menu. A
Historical Data dialog displays.

Figure 4-1 Historical Data Dialog

SCADA Historical Data 4-1

 SQ-402 SCADA Add-In User Guide

Click on Add to bring up the Historical Data Edit dialog where you can select the dataset, the points within
that dataset, and the time range of interest (either absolute or relative).

You can ask for either an absolute time range or a relative time range. In the example of Figure 4-2, we
are asking for the last hour's worth of samples.

A Condition Codes check box allows you to specify whether or not you want condition codes with the
sample values.

Figure 4-2 Creating a Historical Data Query

When you are done click on Ok, and then click on the Save button in the Historical Data dialog shown in
figure 4-1.

To generate the spreadsheet, select Get Data from the Survalent drop-down menu.

SCADA Historical Data 4-2

 SQ-402 SCADA Add-In User Guide

4.1.1 External Historian

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

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

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

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

Figure 4-3 Example of Additional Fields for External Historian Data Set

SCADA Historical Data 4-3

 SQ-402 SCADA Add-In User Guide

An example of the results of a historical data query, with condition codes, is shown in Figure 4-4 below.
The column headings of the sample columns consist of the point names (and qualifiers, if any). If you ask
for condition codes, they are returned in columns immediately beside the corresponding sample columns,
with the same point name column headings.

Figure 4-4 Historical Data Query

SCADA Historical Data 4-4

 SQ-402 SCADA Add-In User Guide

5 Other Data

This chapter describes how to use the SCADA add-in to import data tables other than those that contain
current or historical point data.

5.1 Other Data Query

The Other Data... item of the SCADA brings up the list of queries in the spreadsheet that retrieve other
data from the SCADA system. To create a new other data query, click on the Other Data... item of the
Survalent menu. The Other Data dialog displays.

Figure 5-1 Other Data Dialog

SCADA Other Data 5-1

 SQ-402 SCADA Add-In User Guide

To generate a spreadsheet for other data follow the procedure below.

1. Click on the Add button.

Result: The Other Data Edit dialog appears.

2. Select a table.
Result: The fields become activated

3. Click on the Fields button.

Result: The Fields dialog appears allowing you to select the fields within that table to be
displayed in the spreadsheet.

4. Select the data fields that you want from the All Fields list by double-clicking on your selection.

5. For each data field, you can enter a caption in the Caption field to be used as the column
heading. (If you don’t enter a caption, the data field name will be used as the column heading.)

Note: You can rearrange the order of the data fields by using the Up and Down buttons.

6. Click on OK to go back to the Other Data dialog.

13. Click on the Criteria... button to specify selection criteria based on field values.
Note: You can add multiple AND/OR clauses by using the Logical combo box.

14. After saving the query select the Get Data item from the Survalent menu.

SCADA Other Data 5-2

 SQ-402 SCADA Add-In User Guide

Figure 5-2 shows an example of a query that imports the Alarm Format table.

Figure 5-2 Alarm Formats Query Definition

The resulting imported data is illustrated in Figure 5-3.

Figure 5-3 Alarm Formats Query

SCADA Other Data 5-3