Quindar SCADA
Interface to the PI System
Version 2.0.2.0
Revision C
Quindar SCADA Interface to the PI System 101
How to Contact Us
OSIsoft, Inc.777 Davis St., Suite 250
San Leandro, CA 94577 USA
Telephone
(01) 510-297-5800 (main phone)
(01) 510-357-8136 (fax)
(01) 510-297-5828 (support phone)
Houston, TX
Johnson City, TN
Mayfield Heights, OH
Phoenix, AZ
Savannah, GA
Seattle, WA
Yardley, PA / Worldwide Offices
OSIsoft Australia
Perth, Australia
Auckland, New Zealand
OSI Software GmbH
Altenstadt,Germany
OSI Software Asia Pte Ltd.
Singapore
OSIsoft Canada ULC
Montreal, Canada
OSIsoft, Inc. Representative Office
Shanghai, People’s Republic of China
OSIsoft Japan KK
Tokyo, Japan
OSIsoft Mexico S. De R.L. De C.V.
Mexico City, Mexico
Sales Outlets and Distributors
· Brazil
· Middle East/North Africa
· Republic of South Africa
· Russia/Central Asia / · South America/Caribbean
· Southeast Asia
· South Korea
· Taiwan
WWW.OSISOFT.COM
OSIsoft, Inc. is the owner of the following trademarks and registered trademarks: PI System, PI ProcessBook, Sequencia, Sigmafine, gRecipe, sRecipe, and RLINK. All terms mentioned in this book that are known to be trademarks or service marks have been appropriately capitalized. Any trademark that appears in this book that is not owned by OSIsoft, Inc. is the property of its owner and use herein in no way indicates an endorsement, recommendation, or warranty of such party’s products or any affiliation with such party of any kind.
RESTRICTED RIGHTS LEGEND
Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph I(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013
Unpublished – rights reserved under the copyright laws of the United States.
© 2001-2008 OSIsoft, Inc. PI_Quindar.doc
Quindar SCADA Interface to the PI System 101
Table of Contents
Terminology vii
Introduction 1
Reference Manuals 1
Supported Features 1
Diagram of Hardware Connection 5
QUICS IV and Windows SCADA Differences 5
DLL Names 5
SCADA Station and Tag Names 5
Maximum Point Counts 6
Starting Point Numbers 6
Analog Value Format 6
Principles of Operation 7
Installation Checklist 11
Interface Installation 13
Naming Conventions and Requirements 13
Interface Directories 14
PIHOME Directory Tree 14
Interface Installation Directory. 14
Interface Installation Procedure 14
Installing Interface as a Windows Service 14
Installing Interface Service with PI ICU 15
Installing Interface Service Manually 17
PICheckNda Connection Test Utility 19
Define OMS Record Tags 21
Digital States 23
PointSource 25
PI Point Configuration 27
Point Attributes 27
Tag 27
PointSource 27
PointType 27
Location1 28
Location2 28
Location3 28
Location4 28
Location5 28
InstrumentTag 28
ExDesc 29
Scan 30
Shutdown 31
Output Points 31
Trigger Method 1 (Recommended) 31
Trigger Method 2 32
Performance Point Configuration 33
Configuring Performance Points with PI ICU (Windows) 33
Configuring Performance Points Manually 34
I/O Rate Tag Configuration 37
Monitoring I/O Rates on the Interface Node 37
Configuring I/O Rate Tags with PI ICU (Windows) 37
Configuring I/O Rate Tags Manually 39
Configuring PI Point on the PI Server 39
Configuration on the Interface Node 39
Startup Command File 41
Configuring the Interface with PI ICU 41
General Parameters Tab 43
Quindar Hosts Tab 45
Command-line Parameters 46
Sample PIQuindar.bat File 50
UniInt Failover Configuration 51
Introduction 51
Failover Installation Checklist 51
Startup Command File Configuration 54
Sample Interface Startup Files 56
Data Source Failover Control Point Configuration 56
Active ID 57
Heartbeat 57
Control Point Data Flow 58
Procedure for Configuring Failover Points on SCADA Hosts 58
PI Failover Control Tag Configuration 66
Active ID 67
Heartbeat 67
Interface State Tag 68
Interface State Tag Configuration 69
Digital State Configuration 69
Failover Configuration Using the PI ICU 70
Create the Interface Instance with the ICU 70
Configure the Failover Startup Parameters 70
Create the Failover State Digital State Set 71
Create the Failover Control and Failover State Tags 72
Importing Failover Digital Set to PI via PI SMT 3 73
Messages 75
Informational 75
Errors 76
Interface Node Clock 79
Windows 79
Security 81
Windows 81
Starting / Stopping the Interface on Windows 83
Starting Interface as a Service 83
Stopping Interface Running as a Service 83
Buffering 85
Which Buffering Application to Use 85
How Buffering Works 86
Buffering and PI Server Security 86
Enabling Buffering on an Interface Node with the ICU 87
Choose Buffer Type 87
Buffering Settings 88
Buffered Servers 91
Installing Buffering as a Service 93
Appendix A: Error and Informational Messages 97
Message Logs 97
Messages 97
System Errors and PI Errors 102
Revision History 103
Quindar SCADA Interface to the PI System 101
Terminology
In order to understand this interface manual, you should be familiar with the terminology used in this document.
Buffering
Buffering refers to an Interface Node’s ability to store temporarily the data that interfaces collect and to forward these data to the appropriate PI Servers.
N-Way Buffering
If you have PI Servers that are part of a PI Collective, PIBufss supports n-way buffering. N-way buffering refers to the ability of a buffering application to send the same data to each of the PI Servers in a PI Collective. (Bufserv also supports n-way buffering to multiple PI Server however it does not guarantee identical archive records since point compressions specs could be different between PI Servers. With this in mind, OSIsoft recommends that you run PIBufss instead.)
ICU
ICU refers to the PI Interface Configuration Utility. The ICU is the primary application that you use in order to configure and run PI interface programs. You must install the ICU on the same computer on which an interface runs. A single copy of the ICU manages all of the interfaces on a particular computer.
You can configure and run an interface by editing a startup command file. However, OSIsoft discourages this approach. Instead, OSIsoft strongly recommends that you use the ICU for interface management tasks.
ICU Control
An ICU Control is a plug-in to the ICU. Whereas the ICU handles functionality common to all interfaces, an ICU Control implements interface-specific behavior. Most PI interfaces have an associated ICU Control.
Interface Node
An Interface Node is a computer on which
· the PI API and/or PI SDK are installed, and
· PI Server programs are not installed.
PI API
The PI API is a library of functions that allow applications to communicate and exchange data with the PI Server. All PI interfaces use the PI API.
PI Collective
A PI Collective is two or more replicated PI Servers that collect data concurrently. Collectives are part of the High Availability environment. When the primary PI Server in a collective becomes unavailable, a secondary collective member node seamlessly continues to collect and provide data access to your PI clients.
PIHOME
PIHOME refers to the directory that is the common location for PI client applications. A typical PIHOME is C:\Program Files\PIPC. PI interfaces reside in a subdirectory of the Interfaces directory under PIHOME. For example, files for the Modbus Ethernet Interface are in C:\Program Files\PIPC\Interfaces\ModbusE.
This document uses [PIHOME] as an abbreviation for the complete PIHOME directory. For example, ICU files in [PIHOME]\ICU.
PI SDK
The PI SDK is a library of functions that allow applications to communicate and exchange data with the PI Server. Some PI interfaces, in addition to using the PI API, require the use of the PI SDK.
PI Server Node
A PI Server Node is a computer on which PI Server programs are installed. The PI Server runs on the PI Server Node.
PI SMT
PI SMT refers to PI System Management Tools. PI SMT is the program that you use for configuring PI Servers. A single copy of PI SMT manages multiple PI Servers. PI SMT runs on either a PI Server Node or a PI Interface Node.
Pipc.log
The pipc.log file is the file to which OSIsoft applications write informational and error messages. While a PI interface runs, it writes to the pipc.log file. The ICU allows easy access to the pipc.log.
Point
The PI point is the basic building block for controlling data flow to and from the PI Server. For a given timestamp, a PI point holds a single value.
A PI point does not necessarily correspond to a “point” on the foreign device. For example, a single “point” on the foreign device can consist of a set point, a process value, an alarm limit, and a discrete value. These four pieces of information require four separate PI points.
Service
A Service is a Windows program that runs without user interaction. A Service continues to run after you have logged off from Windows. It has the ability to start up when the computer itself starts up.
The ICU allows you to configure a PI interface to run as a Service.
Tag (Input Tag and Output Tag)
The tag attribute of a PI point is the name of the PI point. There is a one-to-one correspondence between the name of a point and the point itself. Because of this relationship, PI System documentation uses the terms “tag” and “point” interchangeably.
Interfaces read values from a device and write these values to an Input Tag. Interfaces use an Output Tag to write a value to the device.
Quindar SCADA Interface to the PI System 101
Introduction
This document describes OSIsoft’s Quindar Interface to the Plant Information (PI) System (PI Quindar). The PI Quindar Interface provides connectivity to Survalent Technology’s (previously Quindar Products Ltd) SCADA System.
The PI Quindar Interface is distributed in two versions. The first interfaces with the Survalent QUICS IV VMS-based SCADA system and the second interfaces to the Windows-based SCADA Server. The operation of each of these is virtually identical. Differences between the two versions are spelled out in the section titled QUICS IV and Windows SCADA Differences later in the manual. Additionally, any references herein to SCADA System can be assumed to apply to both. The terms VMS SCADA and Windows SCADA will be used herein when something is specific to a particular version of the interface.
The PI Quindar Interface provides bi-directional transfer of Analog Status data between the SCADA System and the PI Server via the Quindar Network Database Access (Nda) API Library. The interface also supports input of Operator Message
Reference Manuals
OSIsoft
· PI Server manuals
· PI API Installation manual
· UniInt Interface User Manual
Vendor
· Network Database Access API User’s Guide
Supported Features
Feature / Support /Part Number / PI-IN-QD-QIV-NT
Platforms / NTI (2000, XP, 2003)
APS Connector / No
Point builder / Yes
ICU Control / Yes
PI Point Types / Float (16, 32 & 64), Discrete, Strings (operator messages only)
Sub-second Timestamps / Yes
Sub-second Scan Classes / Yes
Automatically Incorporates PIPoint Attribute Changes / Yes
Exception Reporting / Yes
Outputs from PI / Yes
Inputs to PI: Scan-based / Unsolicited / Event Tags / Scanned or Unsolicited / Event
Supports Questionable Bit / No
Supports Multi-character PointSource / Yes
Maximum Point Count / 25,000 analog, 25,000 status tags (VMS SCADA)
100,000 analog, 200,000 status tags (Windows SCADA)
* Uses PI SDK / Yes
PINet String Support / n/a
* Source of Timestamps / PI or SCADA
History Recovery / No
* UniInt-Based
* Disconnected Startup
* SetDeviceStatus / Yes
Yes
Yes
* Failover / UniInt Failover (Phase 1)
* Vendor Software Required on PI Interface Node / Yes
* Vendor Software Required on Foreign Device / Yes
Vendor Hardware Required / No
Additional PI Software Included with Interface / No
* Device Point Types / Analog, Status and OMS
See paragraphs below for further explanation.
Platforms
The Interface is designed to run on the above mentioned Microsoft Windows operating systems. Because it is dependent on vendor software, newer platforms may not yet be supported.
Please contact OSIsoft Technical Support for more information.
Uses PI SDK
The PI SDK and the PI API are bundled together and must be installed on each PI Interface node. The Windows SCADA version of the interface is compiled to use the PI SDK. This is done so that the interface can handle the longer SCADA station and tag names available with the Windows SCADA System.
Source of Timestamps
When the interface is running in scan mode, it always uses PI time for the data timestamps.
When the interface runs in exception mode, the interface can use either the timestamps returned from the SCADA System or adjust those timestamps to the current PI time. The default mode of operation is to use the timestamps directly from the SCADA System. If the /at command line parameter is passed in the start up command file, then the SCADA System timestamps will be adjusted to PI time. A detailed discussion of the time adjustment is given in the Principles of Operation section.
UniInt-based
UniInt stands for Universal Interface. UniInt is not a separate product or file; it is an OSIsoft-developed template used by developers, and is integrated into many interfaces, including this interface. The purpose of UniInt is to keep a consistent feature set and behavior across as many of OSIsoft’s interfaces as possible. It also allows for the very rapid development of new interfaces. In any UniInt-based interface, the interface uses some of the UniIntsupplied configuration parameters and some interface-specific parameters. UniInt is constantly being upgraded with new options and features.
The UniInt End User Document is a supplement to this manual.
Disconnected Start-Up
The PI Quindar interface is built with a version of UniInt that supports disconnected start-up. Disconnected start-up is the ability to start the interface without a connection to the PI server. This functionality is enabled by adding /cachemode to the list of start-up parameters or by enabling disconnected startup using the ICU. Refer to the UniInt Interface User Manual for more details on UniInt Disconnect startup.
SetDeviceStatus
The interface supports UniInt device status tags. The device status Health tag has the string “[UI_DEVSTAT]” in the extended descriptor (Exdesc) PI Point Attribute. Please refer to the UniInt Interface User Manual.doc file for more information on how to configure health points. Alternatively, Health tags can be configured with the PI Interface Configuration Utility.