OPC HDA Interface

Version 1.4.1.x
Revision B
OSIsoft, LLC
777 Davis St., Suite 250
San Leandro, CA 94577 USA
Tel: (01) 510-297-5800
Fax: (01) 510-357-8136
Web: http://www.osisoft.com

OSIsoft Australia • Perth, Australia

OSIsoft Europe GmbH • Frankfurt, Germany
OSIsoft Asia Pte Ltd. • Singapore
OSIsoft Canada ULC • Montreal & Calgary, Canada
OSIsoft, LLC 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
OSIsoft do Brasil Sistemas Ltda. • Sao Paulo, Brazil

OPC HDA Interface

Copyright: © 2005-2/28/2023 OSIsoft, LLC. All rights reserved.
No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, mechanical,
photocopying, recording, or otherwise, without the prior written permission of OSIsoft, LLC.

OSIsoft, the OSIsoft logo and logotype, PI Analytics, PI ProcessBook, PI DataLink, ProcessPoint, Sigmafine, Analysis Framework, IT
Monitor, MCN Health Monitor, PI System, PI ActiveView, PI ACE, PI AlarmView, PI BatchView, PI Data Services, PI Manual Logger, PI
ProfileView, PI WebParts, ProTRAQ, RLINK, RtAnalytics, RtBaseline, RtPortal, RtPM, RtReports and RtWebParts are all trademarks of
OSIsoft, LLC. All other trademarks or trade names used herein are the property of their respective owners.

U.S. GOVERNMENT RIGHTS

Use, duplication or disclosure by the U.S. Government is subject to restrictions set forth in the OSIsoft, LLC license agreement and as
provided in DFARS 227.7202, DFARS 252.227-7013, FAR 12.212, FAR 52.227, as applicable. OSIsoft, LLC.
Published: 11/2010

1
Table of Contents
Terminology vii

Chapter 1. Introduction 1
Reference Manuals 1
Supported Features 2
Diagram of Hardware Connection 6

Chapter 2. Principles of Operation 9

Transformations and Scaling 10

Chapter 3. Installation Checklist 15

Data Collection Steps 15
Interface Diagnostics 16
Advanced Interface Features 17

Chapter 4. Interface Installation 19

Naming Conventions and Requirements 19
Interface Directories 20
PIHOME Directory Tree 20
Interface Installation Directory 20
Interface Installation Procedure 20
Installing Interface as a Windows Service 20
Installing Interface Service with PI Interface Configuration Utility 21
Service Configuration 21
Installing Interface Service Manually 23

Chapter 5. DCOM Configuration 25

OPCEnum Tool 25
General Steps for DCOM Configuration 25
OPC HDA Server Registration 26

Chapter 6. PI_HDATool 27

Chapter 7. Digital States 29

Chapter 8. PointSource 31

Chapter 9. PI Point Configuration 33

Point Attributes 33
Tag 33

OPC HDA Interface 3

Table of Contents

PointSource 34
PointType 34
Location1 34
Location2 34
Location3 34
Location4 35
Location5 35
InstrumentTag 35
ExDesc 36
Scan 39
Shutdown 39
Output Points 40
Trigger Method 1 (Recommended) 40
Trigger Method 2 41
Output Timestamps 41
PI Point Configuration Tool 41
Configuration Tool Command-line Parameters 41

Chapter 10. Startup Command File 43

Configuring the Interface with PI ICU 43
OPCHDAInt Interface page 45
Command-line Parameters 53
Sample PIOPCHDAInt.bat File 60

Chapter 11. UniInt Failover Configuration 61

Introduction 61
Quick Overview 62
Synchronization through a Shared File (Phase 2) 63
Configuring Synchronization through a Shared File (Phase 2) 64
Configuring UniInt Failover through a Shared File (Phase 2) 67
Start-Up Parameters 67
Failover Control Points 69
PI Tags 70
Detailed Explanation of Synchronization through a Shared File (Phase 2) 74
Steady State Operation 75
Failover Configuration Using PI ICU 77
Create the Interface Instance with PI ICU 77
Configuring the UniInt Failover Startup Parameters with PI ICU 78
Creating the Failover State Digital State Set 78
Using the PI ICU Utility to create Digital State Set 79
Using the PI SMT 3 Utility to create Digital State Set 79
Creating the UniInt Failover Control and Failover State Tags (Phase 2) 82

Chapter 12. Interface Node Clock 83

Chapter 13. Security 85

Windows 85

Chapter 14. Starting / Stopping the Interface 87

Starting Interface as a Service 87
Stopping Interface Running as a Service 87

4
 Chapter 15. Buffering 89
Which Buffering Application to Use 89
How Buffering Works 90
Buffering and PI Server Security 90
Enabling Buffering on an Interface Node with the ICU 91
Choose Buffer Type 91
Buffering Settings 92
Buffered Servers 94
Installing Buffering as a Service 97

Chapter 16. Interface Diagnostics Configuration 101

Scan Class Performance Points 101
Performance Counters Points 104
Performance Counters 105
Performance Counters for both (_Total) and (Scan Class x) 105
Performance Counters for (_Total) only 107
Performance Counters for (Scan Class x) only 109
Interface Health Monitoring Points 111
I/O Rate Point 116
Interface Status Point 118

Appendix A. Error and Informational Messages 121

Message Logs 121
Messages 121
System Errors and PI Errors 125
UniInt Failover Specific Error Messages 126
Informational 126
Errors (Phase 1 & 2) 127
Errors (Phase 2) 128

Appendix B. PI SDK Options 129

Appendix C. OPC HDA Server Issues 131

Browsing 131
Disconnecting 131

Appendix D. Debugging 133

Appendix E. Technical Support and Resources 135

Before You Call or Write for Help 135
Help Desk and Telephone Support 135
Search Support 136
Email-based Technical Support 136
Online Technical Support 136
Remote Access 137
On-site Service 137
Knowledge Center 137
Upgrades 137

Appendix F. Revision History 139

OPC HDA Interface 5

Table of Contents

6
Terminology
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 to configure 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 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

OPC HDA Interface 7

Terminology

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 32-bit client applications.
A typical PIHOME on a 32-bit operating system is C:\Program Files\PIPC.
A typical PIHOME on a 64-bit operating system is C:\Program Files (x86)\PIPC.
PI 32-bit interfaces reside in a subdirectory of the Interfaces directory under PIHOME.
For example, files for the 32-bit Modbus Ethernet Interface are in
[PIHOME]\PIPC\Interfaces\ModbusE.
This document uses [PIHOME] as an abbreviation for the complete PIHOME or PIHOME64
directory path. For example, ICU files in [PIHOME]\ICU.

PIHOME64
PIHOME64 is found only on a 64-bit operating system and refers to the directory that is the
common location for PI 64-bit client applications.
A typical PIHOME64 is C:\Program Files\PIPC.
PI 64-bit interfaces reside in a subdirectory of the Interfaces directory under PIHOME64.
For example, files for a 64-bit Modbus Ethernet Interface would be found in
C:\Program Files\PIPC\Interfaces\ModbusE.
This document uses [PIHOME] as an abbreviation for the complete PIHOME or PIHOME64
directory path. For example, ICU files in [PIHOME]\ICU.

PI Message Log
The PI message Log is the file to which OSIsoft interfaces based on UniInt 4.5.0.x and later
writes informational, debug and error message. When a PI interface runs, it writes to the
local PI message log. This message file can only be viewed using the PIGetMsg utility. See
the UniInt Interface Message Logging.docx file for more information on how to access these
messages.

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.

8
 Pipc.log
The pipc.log file is the file to which OSIsoft applications write informational and error
messages. When 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.

OPC HDA Interface 9

Chapter 1. Introduction

The PI OPC HDA Interface is an OPC HDA COM interface for bi-directional data transfer
between an OPC HDA Server and an OSIsoft PI System. The interface accesses data from
the OPC HDA Server. The design of the interface allows running multiple instances of the
interface simultaneously. Each interface is able to connect with only one OPC HDA Server,
which may be on the same or a different machine. More than one interface may be
configured to connect to the same OPC HDA Server. The interface may reside on a PI home
node or a PI Interface node.
This interface is designed only for an Intel platform. It requires both the PI API and the PI
SDK.

Note: The value of [PIHOME] variable for the 32-bit interface will depend on whether the
interface is being installed on a 32-bit operating system (C:\Program Files\PIPC) or
a 64bit operating system (C:\Program Files (x86)\PIPC).
The value of [PIHOME64] variable for a 64-bit interface will be C:\Program Files\PIPC on
the 64-bit Operating system.
In this documentation [PIHOME] will be used to represent the value for either [PIHOME]
or [PIHOME64]. The value of [PIHOME] is the directory which is the common location for
PI client applications.

Note: Throughout this manual there are references to where messages are written
by the interface which is the PIPC.log. This interface has been built against a of
UniInt version (4.5.0.59 and later) which now writes all its messages to the local PI
Message log.

Please note that any place in this manual where it references PIPC.log should now
refer to the local PI message log. Please see the document UniInt Interface
Message Logging.docx in the %PIHOME%\Interfaces\UniInt directory for more
details on how to access these messages.

Reference Manuals
OSIsoft
PI Server manuals
PI API Installation manual
UniInt Interface User Manual

OPC HDA Interface 11

Introduction

Vendor
The OPC standards are available from the OPC Foundation at http://www.opcfoundation.org.
This interface uses the OPC Historical Data Access Specification Version 1.20

Supported Features

Feature Support
Part Number PI-IN-OS-OPCHDA-NT
* Platforms 32-bit Interface 64-bit Interface
Windows XP
32-bit OS Yes No
64-bit OS Yes (Emulation Mode) No
Windows 2003 Server
32-bit OS Yes No
64-bit OS Yes (Emulation Mode) No
Windows Vista
32-bit OS Yes No
64-bit OS Yes (Emulation Mode) No
Windows 2008
32-bit OS Yes No
Windows 2008 R2
64-bit OS Yes (Emulation Mode) No
Windows 7
32-bit OS Yes No
64-bit OS Yes (Emulation Mode) No

Auto Creates PI Points APS Connector

Point Builder Utility Yes
ICU Control Yes
PI Point Types Float16 / Float32 / Float64 / Int16 / Int32 / Digital
/ String
Sub-second Timestamps Yes
Sub-second Scan Classes Yes
Automatically Incorporates PI Point Yes
Attribute Changes
Exception Reporting Done by interface
*Outputs from PI Yes
Inputs to PI: Scan-based / Unsolicited / Scan-based / Unsolicited / Event Tags
Event Tags
Supports Questionable Bit Yes
Supports Multi-character PointSource Yes
Maximum Point Count Unlimited
* Uses PI SDK Yes
PINet String Support No

12
 * Source of Timestamps OPC HDA Server
* History Recovery Yes
* UniInt-based Yes
Disconnected Startup No
* SetDeviceStatus Yes
Failover UniInt Failover (Phase 2 Warm , Cold); Server-
level failover
* Vendor Software Required on PI No
Interface Node / PINet Node
Vendor Software Required on Foreign Yes
Device
Vendor Hardware Required No
Additional PI Software Included with Yes
Interface
Device Point Types See below
Serial-Based Interface No

* See available paragraphs below for further explanation.

Platforms
The Interface is designed to run on the above mentioned Microsoft Windows operating
systems.

Outputs from PI
The OPCHDA Server must have the method: SyncUpdate::InsertReplace implemented for
outputs from PI to work. Not all OPCHDA Servers implement this optional method.
Honeywell Experion OPCHDA Server does not implement this method.

Uses PI SDK
The PI SDK and the PI API are bundled together and must be installed on each PI Interface
node. This Interface does not specifically make PI SDK calls.

Source of Timestamps
The interface uses the timestamps from the OPC HDA Server. The timestamps will be
adjusted to the time difference from the OPC HDA Server and the PI Server.
It is possible to use the /TSU command-line parameter to adjust this behavior of the
interface.
/TSU is an option that must be selected with caution. With this option, the timestamps
received from the OPCHDA Server will be sent to the PI Server directly without any
adjustments. If the OPC Server time is ahead of the PI Server time, this option will result in
the PI Server receiving timestamps that are in the future. Consequently, the data will not be
written to the PI Server. The user should select this option only if the clock settings on both
servers are appropriate (i.e. either the same or the PI Server clock is ahead) and the clocks are
either automatically synchronized or clock checks are made frequently. If the user is getting
error 11049 in the pipc.log file, the clocks on the PI Server and on the interface node must
be checked. This error will occur when the interface has sent a timestamp that is outside of
the range for the PI archives.

History Recovery

OPC HDA Interface 13

Introduction

History recovery is performed at interface startup and when the connection to the OPC HDA
Server has been re-established after a loss of connection. On a per-point basis (for both
scanned and event tags), the interface will use the timestamp of the last good PI Archive
value or the /hi=x command-line parameter, whichever is closer to the current time, to
determine how far back in time to retrieve data. In this context a “good” PI Archive value
means one that is not a system digital state. System digital state values within the history
recovery time period are deleted from PI.

UniInt-based
UniInt stands for Universal Interface. UniInt is not a separate product or file; it is an
OSIsoftdeveloped 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 Interface User Manual is a supplement to this manual.

SetDeviceStatus
The Interface is built with a version of UNIINT that is higher than 4.3.0.x and that supports
interface health points. The health point with the point attribute Exdesc = [UI_DEVSTAT],
is used to represent the status of the source devices.
The following events can be written to the point:
“Good”
The interface is properly communicating and reading data from the devices. If no
data collection points have been defined, this indicates the interface has successfully
started.
“3 | 1 devices(s) in error “
The interface has determined that the listed device(s) are offline. A device is
considered offline when the connection to the HDA Server has failed.
Please refer to the UniInt Interface User Manual for more information on how to configure
interface health points.

Failover
Server-Level Failover
This interface supports server-level failover which allows the interface to continue to
collect data from the currently active OPC HDA server when two servers are running
in unison and the primary server shutdown or an unexpected communication failure
occurs.
UniInt Failover Support
UniInt Phase 2 Failover provides support for cold, warm, or hot failover
configurations. The Phase 2 hot failover results in a no data loss solution for bi-
directional data transfer between the PI Server and the Data Source given a single
point of failure in the system architecture similar to Phase 1. However, in warm and
cold failover configurations, you can expect a small period of data loss during a
single point of failure transition. This failover solution requires that two copies of the

14
 interface be installed on different interface nodes collecting data simultaneously from
a single data source. Phase 2 Failover requires each interface have access to a shared
data file. Failover operation is automatic and operates with no user interaction. Each
interface participating in failover has the ability to monitor and determine liveliness
and failover status. To assist in administering system operations, the ability to
manually trigger failover to a desired interface is also supported by the failover
scheme.
The failover scheme is described in detail in the UniInt Interface User Manual,
which is a supplement to this manual. Details for configuring this Interface to use
failover are described in the UniInt Failover Configuration section of this manual.

Vendor Software Required

The OPC HDA Server may run on the same system as the interface, or it may run on another
system.

Additional PI Software
The PI HDA Tool is an OSIsoft product that ships with the interface to assist in configuring
and troubleshooting of the interface.

Device Point Types

By default, the interface will request the following data types:
PI PointType OPC HDA Server Data Type
Digital 2-byte Integer (VT_I2)
Int16 2-byte Integer (VT_I2)
Int32 4-byte Integer (VT_I4)
Float32 4-byte Float (VT_R4)
Float64 8-byte Float (VT_R8)
String String (VT_BSTR)

Diagram of Hardware Connection

Configuration 1: Preferred Configuration
This configuration is the simplest and allows data buffering on the interface node.

OPC HDA Interface 15

Introduction

Configuration 2: Common Configuration

This configuration allows data buffering on the interface node and it is recommended to have
all machines in the same domain.

16
 Configuration 3: Alternate Configuration
This configuration is possible, but not the preferred configuration. Having the interface and
the PI server compete for resources can impair efficiency.

OPC HDA Interface 17

Introduction

Note: All configurations require DCOM settings, and it is recommended using

buffering even when the interface runs on the PI Server node.

18
Chapter 2. Principles of Operation

The PI OPC HDA Interface is an OPC HDA client that allows the PI System and other
software applications to exchange data across a network. During installation of the interface,
entries are put into the Windows Registry, which then allows the Windows system to locate
the OPC HDA Server whenever the client wants to connect to it. If the PI OPC HDA
Interface and an OPC HDA Server are running on different machines, the OPCEnum tool can
be used to locate those registry entries on the other machine.
At interface startup the PI OPC HDA Interface attempts connection to both the OPC HDA
Server and the PI Server. If OPC HDA server is unavailable, the interface will attempt to
connect every 5 seconds until successful. If the PI Server is unavailable, the interface will
attempt to connect every 60 seconds. After connection to both servers is successfully
established, the interface periodically checks its node clock against that of the OPC HDA
Server and against that of the PI Server, to eliminate any differences due to clock drift.
The interface goes on to identify the PI tags associated with the instance of the interface,
based on the PointSource and Location1 point attributes. The interface will make sure that
each of these PI tags is properly configured so that it knows what data to collect from the
OPC HDA Server. An incorrectly configured tag is rejected and a message is sent to the log
file. Once the properly configured PI tags are identified, the interface will perform history
recovery before entering the data collection mode.
The interface will use the timestamp of the last good PI Archive value or the /hi=x command-
line parameter, whichever is closer to the current time, to determine how far back in time to
retrieve data.
The interface supports the SyncRead::ReadRaw and SyncRead::ReadProcessed method. This
requires setting up scan classes to control how frequently to collect data from the OPC HDA
server.
For Event reads, the PI Server informs the interface when the trigger point has a new event
(not necessarily a change in value), and the interface sends a synchronous Read for the tags
attached to that trigger. All data since the last read will be processed using the
SyncRead::ReadRaw method.
If communication between the interface and the OPC HDA Server is lost, the interface will
periodically try to reestablish the connection. All the historical data for when the connection
was down will be recovered after communication is re-established and then data collection
will resume. If communication between the interface and the PI Server is lost, the interface
will still collect data and the interface will periodically attempt to re-establish
communication. If PI API Buffering is enabled, no data is lost. If buffering is not enabled
data is lost.
During data collection all data stored in the history database since the last scan will be read
during the current scan. For example, if a tag is in a scan class of 1 minute, and data goes

OPC HDA Interface 19

Installation Checklist

into the history database on the OPC HDA Server every 10 seconds, 6 values will be read and
processed for each scan.
SyncUpdate::InsertReplace method is used for outputs from PI to the HDA Server. This
function inserts or replaces values and qualities in the HDA for the timestamp of the
sourcetag. If the item has a value at the specified timestamp, the new value and quality will
replace the old one. If there is no value at that timestamp, the function will insert the new
data. If the soucetag’s value is a system digital state (e.g., io timeout, shutdown,…), the
output will not be done. The quality of the data sent to the HDA will be set to “Good”.
PI tag configurations can be updated – added, edited, or deleted – while the interface is
running and these changes will be picked up by the interface automatically. In general, the
interface will check for tag updates every 2 minutes. However, if it finds that at least 25 tags
have been updated, it will check again in 30 seconds; otherwise it will wait another 2 minutes
before checking again. With some OPC HDA servers, this operation can require more time
and more system resources. Therefore, it is more efficient to stop and restart the interface if a
large number of tags are edited.
The PI OPC HDA Interface is designed to send messages about its operation to the pipc.log
file. This file will contain the following information about the interface:
Informational messages on interface startup and shutdown
The scan rates for each scan class
A count of the Input points in each scan class and the number of Output points
Error messages for rejected PI tags or error messages from the OPC HDA Server
Notification for all connections and disconnections from the OPC HDA server

Note: The PI OPC HDA Interface can be configured to run on the same system as
the OPC HDA Server, PI Server or on another node. The configuration affects the
specific system settings needed for the interface to be installed and perform
correctly. Therefore, it is crucial to know the operational details of the interface
presented in this section before installing and running it.

Transformations and Scaling

While OPC Servers can perform their own transformations and scaling, some users have
found that the desired functions are not filled by their server. In this case, configure the PI
points so that the interface will perform transformations and scaling. Note that
transformation and scaling happens before the value is compared to the exception parameters
for the tag, so the exception parameters are applied to the value that would be sent to PI,
rather than to the raw value. The Transformation and Scaling calculations are the same as the
PIOPC interface.

Scaling
Scaling is fairly complex and is controlled by the TotalCode and SquareRoot properties of
the tag. Since we’re limited in what information we can get about the tag, the Convers
attribute is used to carry the Span of the device, and the ExDesc does further duty to carry the
device Zero (Dzero). The interface can then translate a value from the scale of what the
device can send to the scale of the actual tag.

20
 If TotalCode is zero, the only scaling performed is based on the value of SquareRoot. If
Square Root is a 1, the value read will be squared before sending it to PI, and for an output
value the square root will be taken before writing to the device. If SquareRoot is a 2, the
opposite happens: for values read from the device, the square root of the value read will be
sent to PI, while output values will be squared before sending them to the device.
If TotalCode is non-zero, some other scaling may be performed, either to transform the
value read into another scale of measurement or to apply an offset or conversion factor. Just
as the value stored in the tag ranges from (Zero) to (Zero + Span), so too the values read from
or written to the device can range from (Dzero) to (Dzero + Convers). This allows the value
stored in PI to be a simple transformation from one scale to another. The SquareRoot
attribute can be used to specify that the square or square root of the value should be used
rather than the value itself. In other cases, the Convers value may be added to or subtracted
from the value, or may be used as a multiplier, or applied as a bit mask. Again, the
SquareRoot attribute may specify using the square or square root of the value, rather than
the raw value, as the input to the formula.
Scaling is only supported for numeric tags. A tag may be defined in PI as a number, yet
the OPC Server reads and writes the Item as a string, and those tags would support scaling.
But if the PI tag is defined as a string, any scaling will be ignored.
The table below covers all the scaling formulas currently used. Again, if SquareRoot is a 1
or a 2, the square root or square of the value will be calculated first, and then the formula will
be applied.
Convers TotalCode SquareRoot Dzero Operation

0 0 0 Don’t Value = value

care
0 0 1 Don’t Input tags:
care Value = (Value)2
Output tags:
Value = (Value)0.5
0 0 2 Don’t Input tags:
care Value = (Value)0.5
Output tags:
Value = (Value)2
Not 0 1 0 Defined Input tags:
Value = [ (Value – Dzero) / Convers ]
* Span + Zero
Output tags:
Value = [ (Value – Zero) / Span] *
Convers + Dzero
Not 0 1 1 Defined Input tags:
Value = [ ((Value)2 – Dzero) / Convers
] * Span + Zero
Output tags:
Value = [ ((Value)0.5 – Zero) / Span] *
Convers + Dzero

OPC HDA Interface 21

Installation Checklist

Not 0 1 2 Defined Input tags:

Value = [ ((Value)0.5 – Dzero) /
Convers ] * Span + Zero
Output tags:
Value = [ ((Value)2 – Zero) / Span] *
Convers + Dzero
Not 0 2 0 Don’t Input tags:
care Value = Value * Convers
Output tags:
Value = Value / Convers
Not 0 2 1 Don’t Input tags:
care Value = (Value)2 * Convers
Output tags:
Value = (Value)0.5 / Convers
Not 0 2 2 Don’t Input tags:
care Value = (Value)0.5 * Convers
Output tags:
Value = (Value)2 / Convers
Not 0 3 0 Defined Input tags:
Value = (Value / Convers) – Dzero
Output tags:
Value = (Value + Dzero) * Convers
Not 0 3 1 Defined Input tags:
Value = ((Value)2 / Convers) – Dzero
Output tags:
Value = ((Value)0.5 + Dzero) * Convers
Not 0 3 2 Defined Input tags:
Value = ((Value)0.5 / Convers) – Dzero
Output tags:
Value = ((Value)2 + Dzero) * Convers
Not 0 4 0 Defined Input tags:
Value = (Value – Dzero)/ Convers
Output tags:
Value = (Value * Convers) + Dzero
Not 0 4 1 Defined Input tags:
Value = ((Value)2 – Dzero)/ Convers
Output tags:
Value = ((Value)0.5 * Convers) + Dzero
Not 0 4 2 Defined Input tags:
Value = ((Value)0.5 – Dzero)/ Convers
Output tags:
Value = ((Value)2 * Convers) + Dzero

22
 Not 0 5 0 Don’t Input tags:
care Value = Value + Convers
Output tags:
Value = Value – Convers
Not 0 5 1 Don’t Input tags:
care Value = (Value)2 + Convers
Output tags:
Value = (Value)0.5 – Convers
Not 0 5 2 Don’t Input tags:
care Value = (Value)0.5 + Convers
Output tags:
Value = (Value)2 – Convers
Not 0 6 Don’t care Don’t Input tags:
care Value = Value AND Convers
Output tags:
Value = Value AND Convers
Not 0 7 Don’t care Don’t Input tags:
care Value = Value OR Convers
Output tags:
Value = Value OR Convers
Not 0 8 Don’t care Don’t Input tags:
care Value = Value XOR Convers
Output tags:
Value = Value XOR Convers

UniInt Failover
This interface supports UniInt failover. Refer to the UniInt Failover Configuration section of
this document for configuring the interface for failover.

OPC HDA Interface 23

Chapter 3. Installation Checklist

If you are familiar with running PI data collection interface programs, this checklist helps you
get the Interface running. If you are not familiar with PI interfaces, return to this section after
reading the rest of the manual in detail.
This checklist summarizes the steps for installing this Interface. You need not perform a
given task if you have already done so as part of the installation of another interface. For
example, you only have to configure one instance of Buffering for every Interface Node
regardless of how many interfaces run on that node.
The Data Collection Steps below are required. Interface Diagnostics and Advanced Interface
Features are optional.

Data Collection Steps

1. Confirm that you can use PI SMT to configure the PI Server. You need not run PI
SMT on the same computer on which you run this Interface.
2. If you are running the Interface on an Interface Node, edit the PI Server’s Trust Table
to allow the Interface to write data.
3. Run the installation kit for the PI Interface Configuration Utility (ICU) on the
interface node. This kit runs the PI SDK installation kit, which installs both the PI
API and the PI SDK.
4. Run the installation kit for this Interface. .
5. If you are running the Interface on an Interface Node, check the computer’s time
zone properties. An improper time zone configuration can cause the PI Server to
reject the data that this Interface writes.
6. Run the ICU and configure a new instance of this Interface. Essential startup
parameters for this Interface are
Point Source (/PS=x)
Interface ID (/ID=#)
PI Server (/Host=host:port)
Scan Class (/F=##:##:##,offset)
7. Use the Connection Tool to confirm connection between the Interface Node and the
device.
8. If you will use digital points, define the appropriate digital state sets.
9. Build input tags and, if desired, output tags for this Interface. Important point
attributes and their use are:

OPC HDA Interface 25

Installation Checklist

Location1 specifies the Interface instance ID

Location2 specifies whether to store the quality or value. If location2=1, interface
stores point quality rather than point value.
Location3 specifies tag type (either scanned or output). If location3=0, the point is
an input tag; if location3=2, the point is an output tag.
Location4 specifies the scan class.
Location5 specifies treatment of data with uncertain quality:
o If location5=0, interface flags data with uncertain quality as questionable
when sending to PI.
o If locatation5=1, interface sets the digital state of data with uncertain quality
to “Bad Quality.”
o If location5=2, interface treats data with uncertain quality as good quality
and does not flag the data.
ExDesc specifies long ItemID.
InstrumentTag specifies ItemID for the tag (unless specified in ExDesc).
10. Start the Interface interactively and confirm its successful connection to the PI Server
without buffering.
11. Confirm that the Interface collects data successfully.
12. Stop the Interface and configure a buffering application (either Bufserv or PIBufss).
When configuring buffering use the ICU menu item Tools  Buffering… 
Buffering Settings to make a change to the default value (32678) for the Primary and
Secondary Memory Buffer Size (Bytes) to 2000000. This will optimize the
throughput for buffering and is recommended by OSIsoft.
13. Start the buffering application and the Interface. Confirm that the Interface works
together with the buffering application by either physically removing the connection
between the Interface Node and the PI Server Node or by stopping the PI Server.
14. Configure the Interface to run as a Service. Confirm that the Interface runs properly
as a Service.
15. Restart the Interface Node and confirm that the Interface and the buffering
application restart.

Interface Diagnostics
1. Configure Scan Class Performance points.
2. Install the PI Performance Monitor Interface (Full Version only) on the Interface
Node.
3. Configure Performance Counter points.
4. Configure UniInt Health Monitoring points
5. Configure the I/O Rate point.
6. Install and configure the Interface Status Utility on the PI Server Node.
7. Configure the Interface Status point.

26
 Advanced Interface Features
1. Configure UniInt Failover; see that section in this document for details related to
configuring the interface for failover.

OPC HDA Interface 27

Chapter 4. Interface Installation

OSIsoft recommends that interfaces be installed on a PI Interface Nodes instead of directly on

the PI Server node. A PI Interface Node is any node other than the PI Server node where the
PI Application Programming Interface (PI API) has been installed (see the PI API manual).
With this approach, the PI Server need not compete with interfaces for the machine’s
resources. The primary function of the PI Server is to archive data and to service clients that
request data.
After the interface has been installed and tested, Buffering should be enabled on the PI
Interface Node. Buffering refers to either PI API Buffer Server (Bufserv) or the PI Buffer
Subsystem (PIBufss). For more information about Buffering see the Buffering section of this
manual.
In most cases, interfaces on PI Interface Nodes should be installed as automatic services.
Services keep running after the user logs off. Automatic services automatically restart when
the computer is restarted, which is useful in the event of a power failure.
The guidelines are different if an interface is installed on the PI Server node. In this case, the
typical procedure is to install the PI Server as an automatic service and install the interface as
an automatic service that depends on the PI Update Manager and PI Network Manager
services. This typical scenario assumes that Buffering is not enabled on the PI Server node.
Bufserv can be enabled on the PI Server node so that interfaces on the PI Server node do not
need to be started and stopped in conjunction with PI, but it is not standard practice to enable
buffering on the PI Server node. The PI Buffer Subsystem can also be installed on the PI
Server. See the UniInt Interface User Manual for special procedural information.

Naming Conventions and Requirements

In the installation procedure below, it is assumed that the name of the interface executable is
PIOPCHDAInt.exe and that the startup command file is called PIOPCHDAInt.bat.

When Configuring the Interface Manually

It is customary for the user to rename the executable and the startup command file when
multiple copies of the interface are run. For example, PIOPCHDAInt1.exe and
PIOPCHDAInt1.bat would typically be used for interface number 1, PIOPCHDAInt2.exe
and PIOPCHDAInt2.bat for interface number 2, and so on. When an interface is run as a
service, the executable and the command file must have the same root name because the
service looks for its command-line parameters in a file that has the same root name.

Interface Directories

OPC HDA Interface 29

DCOM Configuration

PIHOME Directory Tree

32-bit Interfaces
The [PIHOME] directory tree is defined by the PIHOME entry in the pipc.ini configuration
file. This pipc.ini file is an ASCII text file, which is located in the %windir% directory.
For 32-bit operating systems a typical pipc.ini file contains the following lines:
[PIPC]
PIHOME=C:\Program Files\PIPC
For 64-bit operating systems a typical pipc.ini file contains the following lines:
[PIPC]
PIHOME=C:\Program Files (X86)\PIPC
The above lines define the root of the PIHOME directory on the C: drive. The PIHOME
directory does not need to be on the C: drive. OSIsoft recommends using the paths shown
above as the root PIHOME directory name.

Interface Installation Directory

The interface install kit will automatically install the interface to:
PIHOME\Interfaces\OPCHDAInt
PIHOME is defined in the pipc.ini file.
A new interface installation will create two subdirectories: PI-OPC Tools and PI_HDATool.
Installed in the PIHOME directory, the PI_HDATool directory is a subdirectory of the PI-
OPC Tools directory:
PIHOME\PI-OPC Tools\PI_HDATool

Interface Installation Procedure

The PI OPC HDA Interface setup program uses the services of the Microsoft Windows
Installer. Windows Installer is a standard part of Windows 2000 and greater operating
systems. To install, run the appropriate installation kit.

Installing Interface as a Windows Service

The PI OPC HDA Interface service can be created, preferably, with the
PI Interface Configuration Utility, or can be created manually.

Installing Interface Service with PI Interface Configuration Utility

The PI Interface Configuration Utility provides a user interface for creating, editing, and
deleting the interface service:

30
 Service Configuration

Service name
The Service name box shows the name of the current interface service. This service name is
obtained from the interface executable.

ID
This is the service id used to distinguish multiple instances of the same interface using the
same executable.

Display name
The Display Name text box shows the current Display Name of the interface service. If there
is currently no service for the selected interface, the default Display Name is the service name
with a “PI-” prefix. Users may specify a different Display Name. OSIsoft suggests that the
prefix “PI-” be appended to the beginning of the interface to indicate that the service is part of
the OSIsoft suite of products.

Log on as
The Log on as text box shows the current “Log on as” Windows User Account of the
interface service. If the service is configured to use the Local System account, the Log on as
text box will show “LocalSystem.” Users may specify a different Windows User account for
the service to use.

OPC HDA Interface 31

DCOM Configuration

Password
If a Windows User account is entered in the Log on as text box, then a password must be
provided in the Password text box, unless the account requires no password.

Confirm password
If a password is entered in the Password text box, then it must be confirmed in the Confirm
Password text box.

Dependencies
The Installed services list is a list of the services currently installed on this machine. Services
upon which this interface is dependent should be moved into the Dependencies list using the
button. For example, if API Buffering is running, then “bufserv” should be selected
from the list at the right and added to the list on the left. To remove a service from the list of
dependencies, use the button, and the service name will be removed from the
Dependencies list.
When the interface is started (as a service), the services listed in the dependency list will be
verified as running (or an attempt will be made to start them). If the dependent service(s)
cannot be started for any reason, then the interface service will not run.

Note: Please see the PI Log and Windows Event Logger for messages that may
indicate the cause for any service not running as expected.

- Add Button
To add a dependency from the list of Installed services, select the dependency name, and
click the Add button.

- Remove Button
To remove a selected dependency, highlight the service name in the Dependencies list, and
click the Remove button.
The full name of the service selected in the Installed services list is displayed below the
Installed services list box.

Startup Type
The Startup Type indicates whether the interface service will start automatically or needs to
be started manually on reboot.
If the Auto option is selected, the service will be installed to start automatically when the
machine reboots.
If the Manual option is selected, the interface service will not start on reboot, but will
require someone to manually start the service.
If the Disabled option is selected, the service will not start at all.
Generally, interface services are set to start automatically.

32
 Create
The Create button adds the displayed service with the specified Dependencies and with the
specified Startup Type.

Remove
The Remove button removes the displayed service. If the service is not currently installed, or
if the service is currently running, this button will be grayed out.

Start or Stop Service

The toolbar contains a Start button and a Stop button . If this interface service is not
currently installed, these buttons will remain grayed out until the service is added. If this
interface service is running, the Stop button is available. If this service is not running, the
Start button is available.
The status of the Interface service is indicated in the lower portion of the PI ICU dialog.

Status of Status of the Service

the ICU Interface installed or
Service uninstalled

Installing Interface Service Manually

Help for installing the interface as a service is available at any time with the command:
PIOPCHDAInt.exe –help
Open a Windows command prompt window and change to the directory where the
PIOPCHDAInt1.exe executable is located. Then, consult the following table to determine
the appropriate service installation command.
Windows Service Installation Commands on a PI Interface Node or a PI Server Node with
Bufserv implemented
Manual service PIOPCHDAInt.exe -install -depend "tcpip bufserv"
Automatic service PIOPCHDAIntexe -install -auto -depend "tcpip bufserv"
*Automatic service with PIOPCHDAInt.exe -serviceid X -install -auto -depend "tcpip
service id bufserv"
Windows Service Installation Commands on a PI Interface Node or a PI Server Node
without Bufserv implemented
Manual service PIOPCHDAIntexe -install -depend tcpip
Automatic service PIOPCHDAInt.exe -install -auto -depend tcpip
*Automatic service with PIOPCHDAInt.exe -serviceid X -install -auto -depend tcpip
service id

*When specifying service id, the user must include an id number. It is suggested that this
number correspond to the interface id (/id) parameter found in the interface .bat file.

OPC HDA Interface 33

DCOM Configuration

Check the Microsoft Windows Services control panel to verify that the service was added
successfully. The services control panel can be used at any time to change the interface from
an automatic service to a manual service or vice versa.

34
Chapter 5. DCOM Configuration

All OPC HDA servers and clients are based on Microsoft’s DCOM technology. DCOM is
the network connection protocol that allows communication between machines through the
network. This type of communication requires proper DCOM configuration for all DCOM
applications. Hence both OPC HDA client and server machines must have proper DCOM
settings permitting them to securely access one another remotely
There are two major steps that must be taken to properly configure DCOM permissions:
1. DCOM configuration for OPC HDA Server application on an OPC HDA Server
node;
16. DCOM configuration for default permissions on a PI OPC HDA Interface node.
The general steps for DCOM configuration are similar. However depending on whether the
machines are within the same domain or different domains, or even no domain, the sequence
of steps will be different.

OPCEnum Tool
The OPC Foundation has provided a tool to allow OPC HDA clients to locate servers on
remote nodes, without having information about those servers in the local registry. This tool
is called OPCEnum and is freely distributed by the OPC Foundation. The PI OPC HDA
interface installation installs OPCEnum as well. The primary function of OPCEnum is to
inform or request information from other instances of OPCEnum about existing OPC HDA
Servers on the local system. When OPCEnum is installed, it grants Launch and Access
DCOM permission to Everyone and sets the Authentication level to NONE. This allows
access to any user who can log on to the system. The permissions can be changed using
dcomcnfg.exe.
While the interface, DCOM, and the PI_HDATool only require NT 4.0 with Service Pack 3,
OPCEnum requires at least SP4 and Internet Explorer 4 or higher be installed. See the
PI_HDATool documentation for more information about OPCEnum and how to use it.

General Steps for DCOM Configuration

DCOM configuration can be done with the DCOM Configuration utility (dcomcnfg.exe)
that comes with the Windows OS. In order to be able to use this utility, the user must be
logged in with administrator’s privileges. This utility allows for the configuration of special
security rules for all DCOM objects on the local node. The DCOM Configuration utility may
look slightly different and setting options may differ, depending on the version of the
Windows OS.

OPC HDA Interface 35

DCOM Configuration

For detail information on how to configure DCOM, please refer to the

DCOM Configuration Guide.pdf found in the [PIHOME]\PI-OPC Tools\DCOM Guide\
directory.

OPC HDA Server Registration

If the PI_HDATool does not list the OPC HDA server when running the tool on the same
machine as the OPC HDA Server, register it using the command:
servername.exe -regserver (to unregister use –unregserver)
This command should work for most servers.
Do a search on all hard drives for opcproxy.dll (this comes with the OPC HDA server).
Make sure there is only one version on the machine. More than one copy of the file should
not be a problem if they are all same version. If there are multiple versions, rename all but the
latest one and keep it in the \winnt\system32 directory.
Then register the following DLL’s. Make sure opcproxy.dll and opccomn_ps.dll exist
in the \winnt\system32 directory. Run
C:>regsvr32 opcproxy.dll
The following dialog box should open:

Then run:
C:>regsvr32 opccomn_ps.dll
The following dialog box should open:

Click OK to complete this procedure.

36
Chapter 6. PI_HDATool

The OPC HDA Interface includes the PI_HDATool to help you install and troubleshoot the
PI OPC HDA Interface and OPC HDA Server(s). The tool consists of an executable file,
PI_HDATool.exe, which you can run by double-clicking the file name in Windows
Explorer or My Computer. The interface installs the tool into the PIHOME\PI OPC
Tools\PI_HDATool directory. You can find a manual describing the tool in the same
directory.
The general purpose of PI_HDATool is to verify that a connection from the Interface node
can be made to the OPC HDA Server and data read and optionally written. If the OPC HDA
Server is on a different node than the Interface and PI_HDATool, OPCEnum must be
installed on both machines. If a connection cannot be established using the PI_HDATool,
then the PI OPC HDA Interface will also fail to connect to that OPC HDA Server.
PI_HDATool can also be used to read from and write data to the OPC HDA Server. If
successful in reading data from the OPC HDA Server by using the Synchronous –ReadRaw
button in the PI_HDATool, the PI OPC HDA Interface should also be able to read and write
data.

Note: If able to connect and read/write points from/to an OPC HDA Server with the
PI_HDATool, but not with the Interface, then check the DCOM settings and the
Userid under which the interface is running.

OPC HDA Interface 37

Chapter 7. Digital States

This interface does not require any specific digital states. However, you must create digital
states before creating digital points. For more information regarding digital states, refer to the
PI Server documentation.

Digital State Sets

PI digital states are discrete values represented by strings. These strings are organized in PI as
digital state sets. Each digital state set is a user-defined list of strings, enumerated from 0 to n
to represent different values of discrete data. For more information about PI digital tags and
editing digital state sets, see the PI Server manuals.
An interface point that contains discrete data can be stored in PI as a digital tag. A Digital tag
associates discrete data with a digital state set, as specified by the user.

System Digital State Set

Similar to digital state sets is the system digital state set. This set is used for all tags,
regardless of type to indicate the state of a tag at a particular time. For example, if the
interface receives bad data from an interface point, it writes the system digital state
bad input to PI instead of a value. The system digital state set has many unused states that
can be used by the interface and other PI clients. Digital States 193-320 are reserved for
OSIsoft applications.

OPC HDA Interface 39

Chapter 8. PointSource

The PointSource is a unique, single or multi-character string that is used to identify the PI
point as a point that belongs to a particular interface. For example, the string Boiler1 may be
used to identify points that belong to the MyInt Interface. To implement this, the PointSource
attribute would be set to Boiler1 for every PI Point that is configured for the MyInt
Interface. Then, if /ps=Boiler1 is used on the startup command-line of the MyInt Interface,
the Interface will search the PI Point Database upon startup for every PI point that is
configured with a PointSource of Boiler1. Before an interface loads a point, the interface
usually performs further checks by examining additional PI point attributes to determine
whether a particular point is valid for the interface. For additional information, see the /ps
parameter. If the PI API version being used is prior to 1.6.x or the PI Server version is prior
to 3.4.370.x, the PointSource is limited to a single character unless the SDK is being used.

Case-sensitivity for PointSource Attribute

The PointSource character that is supplied with the /ps command-line parameter is not case
sensitive. That is, /ps=P and /ps=p are equivalent.

Reserved Point Sources

Several subsystems and applications that ship with PI are associated with default PointSource
characters. The Totalizer Subsystem uses the PointSource character T, the Alarm Subsystem
uses G and @, Random uses R, RampSoak uses 9, and the Performance Equations Subsystem
uses C. Do not use these PointSource characters or change the default point source characters
for these applications. Also, if a PointSource character is not explicitly defined when creating
a PI point; the point is assigned a default PointSource character of Lab (PI 3). Therefore, it
would be confusing to use Lab as the PointSource character for an interface.

Note: Do not use a point source character that is already associated with another
interface program. However it is acceptable to use the same point source for multiple
instances of an interface.

OPC HDA Interface 41

Chapter 9. PI Point Configuration

The PI point is the basic building block for controlling data flow to and from the PI Server. A
single point is configured for each measurement value that needs to be archived.

Point Attributes
Use the point attributes below to define the PI point configuration for the Interface, including
specifically what data to transfer.

Tag

The Tag attribute (or tagname) is the name for a point. There is a one-to-one correspondence
between the name of a point and the point itself. Because of this relationship, PI
documentation uses the terms “tag” and “point” interchangeably.
Follow these rules for naming PI points:
The name must be unique on the PI Server.
The first character must be alphanumeric, the underscore (_), or the percent sign (%).
Control characters such as linefeeds or tabs are illegal.
The following characters also are illegal: * ’ ? ; { } [ ] | \ ` ‘ “

Length
Depending on the version of the PI API and the PI Server, this Interface supports tags whose
length is at most 255 or 1023 characters. The following table indicates the maximum length
of this attribute for all the different combinations of PI API and PI Server versions.
PI API PI Server Maximum Length
1.6.0.2 or higher 3.4.370.x or higher 1023
1.6.0.2 or higher Below 3.4.370.x 255
Below 1.6.0.2 3.4.370.x or higher 255
Below 1.6.0.2 Below 3.4.370.x 255

If the PI Server version is earlier than 3.4.370.x or the PI API version is earlier than 1.6.0.2,
and you want to use a maximum tag length of 1023, you need to enable the PI SDK. See
Appendix_B for information.

PointSource

OPC HDA Interface 43

PI Point Configuration

The PointSource is a unique, single or multi-character string that is used to identify the PI
point as a point that belongs to a particular interface. For additional information, see the
/ps command-line parameter and the “PointSource” section.

PointType

Typically, device point types do not need to correspond to PI point types. For example,
integer values from a device can be sent to floating point or digital PI tags. Similarly, a
floating-point value from the device can be sent to integer or digital PI tags, although the
values will be truncated.
The interface supports the Float16, float32, float 64, int16, int32, digital, and string point
types. For more information on the individual PointTypes, see PI Server manuals.
Note that not all OPC HDA Servers will support all these PI point types. Refer to the vendor-
supplied documentation for your specific OPC HDA Server to determine what point types
that server supports. If the point type defined in PI does not match the canonical data type
defined in the OPC HDA Server, the interface will attempt to translate the data. Try using the
PI_HDATool to read the point directly from the OPC HDA Server, this can help determine
whether the PI PointType can be used for the data to be read..

Location1

Location1 indicates to which copy of the Interface the point belongs. The value of this
attribute must match the /id startup parameter.

Location2

For Input tags: Location2 indicates whether the tag stores the data value or the quality of the
data:
0 — Store the data value
1 — Store the quality of the data
For Output tags: Location 2 indicates whether the tag sends the digital string for digital tags
or the ordinal number (0,1,2,…):
0 — Send the ordinal number
1 — Send the digital string

Location3

Location3 indicates whether this tag is an Input or Output tag:

0 or 1 — Input
2 — Output

Location4

Scan-based Inputs

44
 For scan-based data collection, Location4 defines the scan class for the PI point. The scan
class determines the frequency at which input points are scanned for new values. For more
information, see the description of the /f parameter in the Startup Command File section.

Trigger-based Inputs, Unsolicited Inputs, and Output Points

Location 4 should be set to zero for these points.

Location5

Location5 indicates how the point handles data that has the quality of “Uncertain”:
0 — Send “Uncertain” data to PI Server with the questionable bit set.
1 — Store the digital state “Bad Quality” if the quality is “Uncertain.”
2 — Treat “Uncertain” data as good-quality data.
Note that data can have a quality of Good, Uncertain, or Bad. If the quality is “Bad,” then the
digital state “Bad Input” will be sent to PI Server.

Quality Information
The data values from the HDA have a quality value of either “Good,” “Uncertain,” or “Bad.”
Because the PI archive stores either the quality or the value, the interface will translate the
qualities that are “Uncertain” to GOODSTAT, and set the “questionable value” parameter for
the data value. This behavior can be changed on a point-by-point basis with the Location5 PI
point attribute. Setting Location5=1 will cause the interface to store the digital state “Bad
Quality” if the quality is “Uncertain.” If Location5=2, the interface will ignore the
“Uncertain” quality, and treat the value as if it had good quality. Note: if Location 5 is set to
anything other than 0, 1 or 2, the interface will write an error message for that tag and use the
location 5 = 0 setting.
Quality Location5 = 0 Location5 = 1 Location5 = 2
GOOD value value value
Questionable value, parameter digital state value
BAD digital state digital state digital state

You can also store the quality in a separate PI tag, so both the values reported and also the
qualities that came with those values are stored in PI, with no loss of granularity. Setting
Location2=1 for a tag tells the interface to store the quality for the associated OPC HDA
Item, rather than the value. Since OPC HDA qualities are unsigned, 32-bit integers, an Int32
PI tag must receive them. The values are stored in PI without any change, and their status is
always GOOD. To understand what those quality values represent, please go to
http://www.OPCfoundation.org and download the OPC HDA Data Access specifications,
which contain a brief discussion of quality data.

InstrumentTag

InstrumentTag contains the ItemID for the tag. The format of this field depends on your
specific OPC HDA Server. Refer to the documentation for the specific server to determine
the proper format. This field must exactly match the point defined on the OPC HDA Server.
That means punctuation, spaces, uppercase vs. lowercase, and so on.

Length

OPC HDA Interface 45

PI Point Configuration

Depending on the version of the PI API and the PI Server, this Interface supports an
InstrumentTag attribute whose length is at most 32 or 1023 characters. The following table
indicates the maximum length of this attribute for all the different combinations of PI API
and PI Server versions.
PI API PI Server Maximum Length
1.6.0.2 or higher 3.4.370.x or higher 1023
1.6.0.2 or higher Below 3.4.370.x 32
Below 1.6.0.2 3.4.370.x or higher 32
Below 1.6.0.2 Below 3.4.370.x 32

If the PI Server version is earlier than 3.4.370.x or the PI API version is earlier than 1.6.0.2,
and you want to use a maximum InstrumentTag length of 1023, you need to enable the PI
SDK. See Appendix B for information.
To verify an ItemID, use the PI_HDATool. If the server supports browsing, use List
Server’s Tags to see a list of defined ItemIDs. Double-clicking an ItemID in the tree will
result in the full ItemID being displayed in the Item field. This is the ItemID to use in
InstrumentTag.
If the instrument tag for a point is longer than 32 characters and PI API 1.6 or better and PI
3.4.370x PI server are not installed, put the InstrumentTag in the Exended Descriptor
attribute, using the form “instr = whatever.the-OPC HDA/server*needs”. Note that the
InstrumentTag must exactly match the ItemID defined on the OPC HDA Server. If the
InstrumentTag contains a comma, enclose the tagname with double quote characters (“), such
as:
Instr=”whatever.you, or someone*needs*”

ExDesc

You can use the extended descriptor attribute for several purposes, such as indicating a point
is a performance point, associating a trigger point with an input point, and specifying
different ItemIDs for the timestamp and the point value.
When using the field for multiple purposes, insert a comma between each definition.

Length
Depending on the version of the PI API and the PI Server, this Interface supports an
Extended Descriptor attribute whose length is at most 80 or 1023 characters. The
following table indicates the maximum length of this attribute for all the different
combinations of PI API and PI Server versions.
PI API PI Server Maximum Length
1.6.0.2 or higher 3.4.370.x or higher 1023
1.6.0.2 or higher Below 3.4.370.x 80
Below 1.6.0.2 3.4.370.x or higher 80
Below 1.6.0.2 Below 3.4.370.x 80

If the PI Server version is earlier than 3.4.370.x or the PI API version is earlier than 1.6.0.2,
and you want to use a maximum ExDesc length of 1023, you need to enable the PI SDK. See
Appendix B for information.

46
 Performance Points
For UniInt-based interfaces, the extended descriptor is checked for the string
“PERFORMANCE_POINT”. If this character string is found, UniInt treats this point as a
performance point. See the section called Scan Class Performance Points.

Trigger-based Inputs
For trigger-based input points, a separate trigger point must be configured. An input point is
associated with a trigger point by entering a case-insensitive string in the extended descriptor
(ExDesc) PI point attribute of the input point of the form:
keyword=trigger_tag_name
where keyword is replaced by “event” or “trig” and trigger_tag_name is replaced by the
name of the trigger point. There should be no spaces in the string. UniInt automatically
assumes that an input point is trigger-based instead of scan-based when the
keyword=trigger_tag_name string is found in the extended descriptor attribute.
An input is triggered when a new value is sent to the Snapshot of the trigger point. The new
value does not need to be different than the previous Snapshot value to trigger an input, but
the timestamp of the new value must be greater than (more recent than) or equal to the
timestamp of the previous value. This is different than the trigger mechanism for output
points. For output points, the timestamp of the trigger value must be greater than (not greater
than or equal to) the timestamp of the previous value.
Conditions can be placed on trigger events. Event conditions are specified in the extended
descriptor as follows:
Event=‘trigger_tag_name’ event_condition
The trigger tag name must be in single quotes. For example,
Event=‘Sinusoid’ Anychange
will trigger on any event to the PI Tag sinusoid as long as the next event is different than the
last event. The initial event is read from the snapshot.
The keywords in the following table can be used to specify trigger conditions.
Event Description
Condition
Anychange Trigger on any change as long as the value of the current event is different than
the value of the previous event. System digital states also trigger events. For
example, an event will be triggered on a value change from 0 to “Bad Input,” and
an event will be triggered on a value change from “Bad Input” to 0.
Increment Trigger on any increase in value. System digital states do not trigger events.
For example, an event will be triggered on a value change from 0 to 1, but an
event will not be triggered on a value change from “Pt Created” to 0. Likewise,
an event will not be triggered on a value change from 0 to “Bad Input.”
Decrement Trigger on any decrease in value. System digital states do not trigger events.
For example, an event will be triggered on a value change from 1 to 0, but an
event will not be triggered on a value change from “Pt Created” to 0. Likewise,
an event will not be triggered on a value change from 0 to “Bad Input.”
Nonzero Trigger on any non-zero value. Events are not triggered when a system digital
state is written to the trigger tag. For example, an event is triggered on a value
change from “Pt Created” to 1, but an event is not triggered on a value change
from 1 to “Bad Input.”

Sending Timestamp and Output Value to Different ItemIDs

OPC HDA Interface 47

PI Point Configuration

Specify the timestamp ItemID in ExDesc when you want to write the output value to one
ItemID and the corresponding timestamp to a different ItemID. In this case, the ItemID
specified in the InstrumentTag field or in the ExDesc field as instr=ItemId will contain
the value, and the ItemID specified in the ExDesc field will contain the timestamp that goes
with that value. Again, the ItemID string must match exactly the ItemID on the OPC Server.
There are two formats, depending on the data type of the ItemID that receives the timestamp.
Format Description
Tim=ItemID Interface writes the timestamp as a string (VT_BSTR)
formatted according to the /TF setting in the startup file.
In this format, the timestamp matches the PI Server
timestamp, and is not adjusted for differences in time
zone or daylight saving time settings.
Dat=ItemID Interface writes the timestamp as a VT_DATE. In this
format, the timestamp is in universal (UTC) format, and
has no dependency on the time zone or daylight saving
time setting.

The timestamp written to the OPC Server is the same timestamp seen on the PI machine
when looking at the archive timestamp.

Timestamp Strings
You can only specify one format string for an instance of the interface. If you must process
more than one format of timestamp, then you must use more than one copy of the interface.
The interface will make a copy of the format string, and will then replace the tokens with the
actual values, to create a string. To read a string, it will look for numbers that are in the same
position as the tokens, and use those numbers as values.
The tokens that the interface recognizes in the /TF parameter are:
Token Description
cc 2-digit century
yy 2-digit year
mn 2-digit month
mon month as a 3-character abbreviation, one of the
following:
Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
dd 2-digit day
hh 2-digit hour from 0 to 23
hr 2-digit hour from 0 to 12
mm 2-digit minute
ss 2-digit second
0 3-digit milliseconds
XM either AM or PM

You can put the tokens together in any combination, with anything or nothing between them.
What matters to the interface is where in the string the tokens are found. It reads from left to
right, looking for a recognizable token. The following table shows some common format
strings and example timestamps.
Format String Example Timestamp
ccyy/mn/dd hh:mm:ss.000 1998/11/29 15:32:19.391

48
 dd mon, ccyy hr:mm:ss XM 29 Nov, 1998 03:32:19 PM
mn-dd-ccyy hh:mm:ss 11-29-1998 15:32:19
hh:mm:ss.000 15:32:19.482

Dzero for scaled tags

When the device returns values that must be scaled to fit the range of values the tag stores
(such as scaling from device voltage to temperature in degrees Celsius), store the device Zero
in ExDesc. (The Convers attribute is used to specify the device Span.) The format is for the
device Zero is:
Dzero=nnnnn.nnn

Scan

By default, the Scan attribute has a value of 1, which means that scanning is turned on for the
point. Setting the scan attribute to 0 turns scanning off. If the scan attribute is 0 when the
Interface starts, a message is written to the pipc.log and the tag is not loaded by the
Interface. There is one exception to the previous statement.
If any PI point is removed from the Interface while the Interface is running (including setting
the scan attribute to 0), SCAN OFF will be written to the PI point regardless of the value of
the Scan attribute. Two examples of actions that would remove a PI point from an interface
are to change the point source or set the scan attribute to 0. If an interface specific attribute is
changed that causes the tag to be rejected by the Interface, SCAN OFF will be written to the
PI point.

Shutdown

The Shutdown attribute is 1 (true) by default. The default behavior of the PI Shutdown
subsystem is to write the SHUTDOWN digital state to all PI points when PI is started. The
timestamp that is used for the SHUTDOWN events is retrieved from a file that is updated by the
Snapshot Subsystem. The timestamp is usually updated every 15 minutes, which means that
the timestamp for the SHUTDOWN events will be accurate to within 15 minutes in the event of
a power failure. For additional information on shutdown events, refer to PI Server manuals.

Note: The SHUTDOWN events that are written by the PI Shutdown subsystem are
independent of the SHUTDOWN events that are written by the Interface when
the /stopstat=Shutdown command-line parameter is specified.

SHUTDOWN events can be disabled from being written to PI when PI is restarted by setting the
Shutdown attribute to 0 for each point. Alternatively, the default behavior of the PI Shutdown
Subsystem can be changed to write SHUTDOWN events only for PI points that have their
Shutdown attribute set to 0. To change the default behavior, edit the
\PI\dat\Shutdown.dat file, as discussed in PI Server manuals.

Bufserv and PIBufss

It is undesirable to write shutdown events when buffering is being used. Bufserv and PIBufss
are utility programs that provide the capability to store and forward events to a PI Server,
allowing continuous data collection when the Server is down for maintenance, upgrades,
backups, and unexpected failures. That is, when PI is shutdown, Bufserv or PIBufss will

OPC HDA Interface 49

PI Point Configuration

continue to collect data for the Interface, making it undesirable to write SHUTDOWN events to
the PI points for this Interface. Disabling Shutdown is recommended when sending data to a
PI collective to support high availability. Refer to the Bufserv or PIBufss manuals for
additional information.

Output Points
Output points control the flow of data from the PI Server to any destination that is external to
the PI Server, such as a PLC or a third-party database. For example, to write a value to a
register in a PLC, use an output point. Each interface has its own rules for determining
whether a given point is an input point or an output point. There is no de facto PI point
attribute that distinguishes a point as an input point or an output point.
Outputs are triggered for UniInt-based interfaces. That is, outputs are not scheduled to occur
on a periodic basis. There are two mechanisms for triggering an output.
As of UniInt 3.3.4, event conditions can be placed on triggered outputs. The conditions are
specified using the same event condition keywords in the extended descriptor as described
under “Trigger-based Inputs.” The only difference is that the trigger tag is specified with the
SourceTag attribute instead of with the “event” or “trig” keywords. Otherwise, the behavior
of event conditions described under ‘Trigger-Based Inputs” is identical for output points. For
output points, event conditions are specified in the extended descriptor as follows:
event_condition

Trigger Method 1 (Recommended)

For trigger method 1, a separate trigger point must be configured. The output point must have
the same point source as the interface. The trigger point can be associated with any point
source, including the point source of the interface. Also, the point type of the trigger point
does not need to be the same as the point type of the output point.
The output point is associated with the trigger point by setting the SourceTag attribute of the
output point equal to the tag name of the trigger point. An output is triggered when a new
value is sent to the Snapshot of the trigger point. The new value does not need to be different
than the previous value that was sent to the Snapshot to trigger an output, but the timestamp
of the new value must be more recent than the previous value. If no error is indicated, then
the value that was sent to the trigger point is also written to the output point. If the output is
unsuccessful, then an appropriate digital state that is indicative of the failure is usually written
to the output point. If an error is not indicated, the output still may not have succeeded
because the interface may not be able to tell with certainty that an output has failed.

Trigger Method 2

For trigger method 2, a separate trigger point is not configured. To trigger an output, write a
new value to the Snapshot of the output point itself. The new value does not need to be
different than the previous value to trigger an output, but the timestamp of the new value
must be more recent than the previous value.
Trigger method 2 may be easier to configure than trigger method 1, but trigger method 2 has
a significant disadvantage. If the output is unsuccessful, there is no tag to receive a digital
state that is indicative of the failure, which is very important for troubleshooting.

50
 Output Timestamps

If you need to write the timestamp of an output value to one ItemID and the output value
itself to another, you can get the timestamp by specifying the ItemID in the ExDesc field. In
this case, you must specify whether the ItemID is to be written as a VT_DATE or as a
VT_BSTR (string value). To write as a string value, define the /TF parameter in the startup
file, so the interface knows what format to use to create the string. See the sections on
ExDesc and Command-line Parameters for more details on settings.

PI Point Configuration Tool

The OPC HDA Tag Builder Tool is a command-line utility that helps you create PI points
from the OPC HDA Server. When executed, the tool browses the OPC HDA Server and gets
the attributes needed to configure a PI tag.
To get the information required to build PI tags, execute the tool with the following
command:
PIHOME\interfaces\OPCHDAInt\HDATagBuilder.exe /node=turboberry
/server=OSI.HDA.1 /ps=had
The following section lists optional and required arguments.

Configuration Tool Command-line Parameters

Parameter Description
/db (Optional) Logging for internal data translation and is helpful for PI
Tech Support.
/h or /help (Optional) Displays information about the use of command-line
parameters.
/loc1=# (Optional) Specifies the copy of the interface to which the point
belongs. The value of this attribute must match the /id
interface startup parameter.
/loc2=# (Optional) For input tags, this value specifies whether to store the
data value(0) or quality of the data(1).
For output tags, this value is used to indicate whether
this tag is to send the digital string(0) or the ordinal
number(1) (0, 1, 2, …) for digital tags.
/loc3=# (Optional) Specifies whether the tag is an Input(0) or Output(2) tag.
/loc4=# (Optional) For interfaces that support scan-based collection of
data, this value defines the scan class number for the PI
Point.
For Trigger-based Inputs and Output Points, set this
value to zero.
/loc5=# (Optional) Specifies how the point is to use data that has the
quality of “Uncertain”:
0 – “Uncertain” data will be sent to PI with the
questionable bit set.
1 – store the digital state “Bad Quality” if the quality is
“Uncertain”.
2 – “Uncertain” quality will be treated as good quality

OPC HDA Interface 51

PI Point Configuration

/node=nodename Specifies the node where the OPC HDA server is

(Required if interface not loaded on OPC running (optional). This argument is needed only when
HDA server node, otherwise optional) executing the configuration tool on a separate node from
the OPC HDA server.
/ps=Point Source (Required) The PointSource used by the PI Points.
/server=servername (Required) Specifies the name of the server
(i.e. OSI.HDA.1)

For more information on the Point Attributes listed above, please see the “Point Attributes”
section of this manual.
To build PI OPC HDA Interface tags, use the output file, “hdatagbuilder.csv,” from the
configuration tool within PI SMT to export the tags to PI.

52
Chapter 10. Startup Command File

Command-line parameters can begin with a / or with a -. For example, the /ps=M and
-ps=M command-line parameters are equivalent.
For Windows, command file names have a .bat extension. The Windows continuation
character (^) allows for the use of multiple lines for the startup command. The maximum
length of each line is 1024 characters (1 kilobyte). The number of parameters is unlimited,
and the maximum length of each parameter is 1024 characters.
The PI Interface Configuration Utility (PI ICU) provides a tool for configuring the Interface
startup command file.

Configuring the Interface with PI ICU

Note: PI ICU requires PI 3.3 or greater.

The PI Interface Configuration Utility provides a graphical user interface for configuring PI
interfaces. If the Interface is configured by the PI ICU, the batch file of the Interface
(PIOPCHDAInt.bat) will be maintained by the PI ICU and all configuration changes will be
kept in that file and the module database. The procedure below describes the necessary steps
for using PI ICU to configure the PI OPC HDA Interface.
From the PI ICU menu, select Interface, then NewWindows Interface Instance from EXE...,
and then Browse to the PIOPCHDAInt.exe executable file. Then, enter values for Point
Source and Interface ID#. A window such as the following results:

OPC HDA Interface 53

Startup Command File

“Interface name as displayed in the ICU (optional)” will have PI- pre-pended to this name
and it will be the display name in the services menu.
Click on Add.
The following display should appear:

Note that in this example the Host PI System is MKELLYLAPTOP. To configure the
interface to communicate with a remote PI Server, select ‘Interface => Connections…’ item
from PI ICU menu and select the default server. If the remote node is not present in the list of
servers, it can be added.
Once the interface is added to PI ICU, near the top of the main PI ICU screen, the Interface
Type should be opchdaint. If not, use the drop-down box to change the Interface Type to
be opchdaint.
Click on Apply to enable the PI ICU to manage this copy of the PI OPC HDA Interface.

The next step is to make selections in the interface-specific tab (i.e., “opchdaint”) that
allow the user to enter values for the startup parameters that are particular to the PI OPC
HDA Interface.

54
 Since the PI OPC HDA Interface is a UniInt-based interface, in some cases the user will need
to make appropriate selections in the UniInt page. This page allows the user to access UniInt
features through the PI ICU and to make changes to the behavior of the interface.
To set up the interface as a Windows Service, use the Service page. This page allows
configuration of the interface to run as a service as well as to starting and stopping of the
interface. The interface can also be run interactively from the PI ICU. To do that go to menu,
select the Interface item and then Start Interactive.
For more detailed information on how to use the above-mentioned and other PI ICU pages
and selections, please refer to the PI Interface Configuration Utility User Manual. The next
section describes the selections that are available from the opchdaint page. Once selections
have been made on the PI ICU GUI, press the Apply button in order for PI ICU to make these
changes to the interface’s startup file.

OPCHDAInt Interface page

Since the startup file of the PI OPC HDA Interface is maintained automatically by the PI
ICU, use the opchdaint page to configure the startup parameters and do not make changes in
the file manually. The following is the description of interface configuration parameters used
in the PI ICU Control and corresponding manual parameters.

OPCHDAInt

OPC HDA Interface 55

Startup Command File

The OPCHDAIint ICU Control for PI ICU has four tabs. A yellow text box indicates that an
invalid value has been entered, or that a required value has not been entered.

General Parameters

OPCHDA Server Node Name

Host name of the node where the OPCHDA Server is located. If the interface is running on
the computer where the OPCHDA Server is located then the NodeName:: must be omitted in
the command line parameter argument . If the server name has embedded spaces, enclose the
name in double quotes. This is a required field and must be filled in.
(/Server=NodeName::OPCHDAServerName)

Load Available OPCHDA Server Names

Click this button to get a list of available OPCHDA Server names from the OPCHDA Server
Node entered above. It will populate the OPCHDA Server Name drop down box.

OPCHDA Server Name

Lists the OPCHDA Servers available at the node specified in OPCHDA Server Node Name.
Select the server that the interface will access.
(/Server=NodeName::OPCHDAServerName)

Current Active Server Tag

The string tag into which should be written the name of the currently active OPC HDA
Server (/CS=tag).

56
 Optional parameters

History Recovery Only – History time range

Specifies a range of history to recover before exiting. Specify the times using PI time string
formats with a colon separating the date and the time. For example, if you enter 10-dec-
04:10:00:00,10-dec-04:12:00:00, the interface will recover two hours of data from
the OPC HDA Server, send the data to the PI System for all points, and then exit. (/HRONLY=
dd-mmm-yy:hh:mm:ss,dd-mmm-yy:hh:mm:ss)

Use Timestamp String Format

Sets the format for timestamp strings written to the OPCHDA Server. (/TF=format)

Use ReadProcessed Call

Tells the interface to use the OPC HDA ReadProcessed call instead of the ReadRaw call.
The ReadProcessed call will return values at an interval based on the scan time of the point’s
scan class. (/RP=flag where flag=0 — The ReadProcessed call will be made with the
OPCHDA_INTERPOLATIVE flag. This will cause the OPC HDA server to return
interpolated values at the scan interval. Flag=1 — The ReadProcessed will be made with the
OPCHDA_START flag. This will cause the OPC HDA server to return the value and
timestamp at the start time of the interval. Flag=2 — The ReadProcessed will be made with
the OPCHDA_END flag. This will cause the OPC HDA server to return the value and
timestamp at the end time of interval)

History Recovery Maximum Time

OPC HDA Interface 57

Startup Command File

Specifies the maximum amount of time to go back in history at startup. To use, select the
check box, enter a value, and choose a unit of measure. (/HI=#c, where # is a number and c
is a unit, like “D” for days, “H” for hours, “M” for minutes, or “S” for seconds.)

Adjust Timestamp with Offset

Applies an adjustment to the timestamp, to deal with broken servers and broken installations,
where the clock for the OPCHDA Server is set incorrectly (for example, the server requires
the clock to match the wall clock, but the time zone must be GMT, regardless of where the
server is actually located). To use, select the check box, enter a value (which maybe either
positive or negative), and choose a unit of measurement. The interface converts the value
stored in the batch file to the number of seconds corresponding to the chosen unit of
measurement. (/TO=#, where # is either a positive or negative value depending on whether
the time must be adjusted forward or backward.)

Maximum Time Period Per Call

Specifies the maximum amount of time to request data from the OPC HDA per call. Instead
of asking for data from last value to current time, interface calls data in chunks of time using
the passed in max time period. To use, select the check box, enter a value, and choose a unit
of measure. (/MP=#c, where # is a number, and x is a unit like “D” for days, “H” for hours,
“M” for minutes, and “S” for seconds.

Time delay before reading OPC Tags

Specifies the number of seconds to wait after connecting to the OPCHDA Server before
scanning data. This delay provides time for loading points on the OPCHDA Server before
scanning. (/SD=#, where # is a number in seconds.)

MS to pause between History Retrieval

Specifies the number of milliseconds to pause between history recovery of a tag.
(/HRPAUSE=millisecond)

Times Not Adjusted to the PI Server

The OPCHDA Server provides the timestamp, but the interface does not adjust for any offset
between the OPC Server and the PI Server. (/TSU).

Note: Use this option with caution.

Discard Sub-Subsecond Portion of Timestamp

When selected, the interface discards the subsecond portion of the timestamp passed to PI
Server and only sends whole integer seconds. This parameter can improve performance: PI
Server will require less space—and possibly less CPU—to store the same amount of data.
The interface truncates the fractional part of the timestamp. (/IT)

Group Size (# of Tags)

Specifies maximum number of tags to include in a call to the OPCHDA Server. Within each
scan class, the interface calls the OPCHDA server in groups of the specified size, up to the
number of points in the scan class. The start time of each data request matches the end time of
the previous request. If you do not specify this parameter, the interface calls the OPCHDA

58
 Server one tag at a time with the start time set to the timestamp of the last value read from the
OPCHDA Server. (/GS=#)

Start Time Adjust (sec.)

Used with Group Size, sets the start time of the data call to the previous end time minus the
specified seconds. With this parameter, you can provide some overlap in the data call to
ensure that you do not miss data that enters the OPCHDA Server after the interface made the
read call. If the /GS parameter is not passed in, the /sa parameter has no effect. (/SA=#,
where # is a number in seconds.)

End Time Adjust (sec.)

Used with Group Size, sets the end time of the data call to the current time minus the
specified seconds. With this parameter, you can provide some overlap in the data call to
ensure that you do not miss data that enters the OPCHDA Server after the interface made the
read call. If the /GS parameter is not passed in, the /ea parameter has no effect. (/EA=#,
where # is a number in seconds.)

No Timeout
When selected, the interface never writes I/O Timeout, including when the interface loses
connection with the OPCHDA Server. (/NT).

Ignore Server Status

The OPC Server should go to OPCHDA_UP state when it is ready to send data. If it does
not, set the interface to try to talk to it anyway by clicking this checkbox. (/IS)

Enable Mass Tag Adding

Select this check box to set the interface to verify many tags at one time. It is faster to verify
many items at once, instead of one by one. (/MA)

OPC HDA Interface 59

Startup Command File

Backup Parameters
This tab contains parameters that set the server-level failover options of the interface. By
design, the PI OPC HDA interface provides redundancy for the OPC HDA server. For
server-level failover, you can configure the interface to change to another server when the
current server no longer serves data or when the server changes state. To implement, you
must specify the primary and secondary (that is, backup) OPC HDA servers.

OPCHDA Backup Server Node Name and Server Name

The name of the node and server of the OPC HDA server that you are designating as the
backup server. (/backupSERVER=BACKUP Node::BACKUP SERVERNAME).

Switch to Backup Delay (sec)

The number of attempts to connect, before switching to the backup OPC HDA Server
(/FT=#).

Wait for RUNNING State (sec)

The number of seconds to wait for UP status, before switching to the backup OPC HDA
Server (/SW=#).

Debug Parameters

60
 Use the parameters on this tab to do minimal debugging when having difficulty determining
what data you are receiving from the OPC HAD Server.

Internal Testing Only

This is for internal testing only; do not use. (/DB=1)

Log of Startup
Enable startup logging, including InstrumentTag and ExDesc for each tag. (/DB=2)

Log Write Operation

Enable pipc.log file messages for write operations. (/DB=4)

Log Timestamps of Refresh

Log the time that a scan starts and that a scan ends. (/DB=8)

Log Timestamps and Data (All Tags)

Log the timestamp with the data, the adjusted timestamp, the PITime, and the scan class for
each data value that the interface receives. (/DB=32)

Note: This setting produces a lot of data. DO NOT LEAVE THIS SETTING ON FOR
MORE THAN A FEW MINUTES.

Log Timestamps and Data for Tag

OPC HDA Interface 61

Startup Command File

Log the same items as /DB=32, but only for the tag specified as the debug tag
(/DT=tagname). If there is no tag specified, the first tag for which a value is received is set
to the debug tag. (/DB=64)

Log attempts to connect to OPC HDA Server and time it took to finish reading
a scan class
Log when the interface tries to connect to the OPC HDA Server. Also log the start and end
of each scan with the amount of time it took to finish the scan and the number of values sent
to PI. (/DB=128)

Log when a Digital tag is reading a numeric value that is Over Range
Log when a numeric value is read for a digital tag and the number is above the possible
number of digital states. The Over Range system digital state is sent to PI in this case.
(/DB=256)

Set Debug Level Via a Tag

Use to change the value of the debug parameter while the interface is running. Configure an
output tag for the interface, Int32, and set its value to 0. Give the name of this tag with the
/DF parameter. When the value of this PI tag is changed, the interface will capture the new
value and set its debug parameter to that value. Nothing will be written to the OPC HDA
Server. (/DF=tagname)

Note: The UniInt Interface User Manual includes details about other command line
parameters, which may be useful.

Additional Parameters
This section is provided for any additional parameters that the current ICU Control does not
support. Separate command-line parameters by a space, and enclose arguments that have
embedded blanks with double quotes.

Command-line Parameters

Parameter Description
/BACKUPSERVER= Defines the BACKUP OPC HDA Server to be used. Use the following
OPC HDA Server format:
Optional /BACKUPSERVER=FACT2NODE::MODBUSOPC_HDA
Default: none where FACT2NODE is the name of the computer where the OPC HDA
Server runs, and MODBUSOPC_HDA is the name of the OPC HDA
Server as registered on that machine. If the backup server runs on the
same machine as the interface, omit the node name:
/BACKUPSERVER=MODBUSOPC_HDA
If the server name has embedded spaces, enclose the name in double
quotes:
/BACKUPSERVER=”Server name with spaces”

62
 /CS=tagname The string tag where the interface should write the name of the
Optional currently active OPC HDA Server.
Default: none
/DB=x Enables minimal debugging. Useful when you cannot tell what the
Optional server is returning. See “Parameters” on page 51 for more information.
Default: none
/DF=tagname Changes the value of the debug parameter while the interface is
Optional running. Configure an output tag for the interface, Int32, and set its
Default: none value to 0. Give the name of this tag with the /DF parameter. For
example:
/DF=OPCHDA.Debug. Parameter
When the value is changed in the PI tag, the interface will capture the
new value and set its debug parameter to that value. Nothing will be
written to the OPC HDA Server.
/EA=# Adjusts the end time of the data call to the current time minus #
Optional number of seconds. This is used with the /GS (group size) parameter.
Default: none Use this parameter to provide some overlap in the data call to ensure
no data is missed if data goes into the OPCHDA Server after the
interface made the read call.
If the /GS parameter is not passed in, the /EA parameter will have no
effect.
/ec=# The first instance of the /ec parameter on the command-line is used to
Optional specify a counter number, #, for an I/O Rate point. If the # is not
specified, then the default event counter is 1. Also, if the /ec
parameter is not specified at all, there is still a default event counter of
1 associated with the interface. If there is an I/O Rate point that is
associated with an event counter of 1, each copy of the interface that is
running without /ec=#explicitly defined will write to the same I/O Rate
point. This means either explicitly defining an event counter other than
1 for each copy of the interface or not associating any I/O Rate points
with event counter 1. Configuration of I/O Rate points is discussed in
the section called I/O Rate Point.
Subsequent instances of the /ec parameter may be used by specific
interfaces to keep track of various input or output operations.
Subsequent instances of the /ec parameter can be of the form /ec*,
where * is any ASCII character sequence. For example,
/ecinput=10, /ecoutput=11, and /ec=12 are legitimate
choices for the second, third, and fourth event counter strings.
/f=SS.## The /f parameter defines the time period between scans in terms of
or hours (HH), minutes (MM), seconds (SS) and sub-seconds (##). The
/f=SS.##,SS.## scans can be scheduled to occur at discrete moments in time with an
optional time offset specified in terms of hours (hh), minutes (mm),
or
seconds (ss) and sub-seconds (##). If HH and MM are omitted, then
/f=HH:MM:SS.## the time period that is specified is assumed to be in seconds.
or Each instance of the /f parameter on the command-line defines a
/f=HH:MM:SS.##, scan class for the interface. There is no limit to the number of scan
hh:mm:ss.## classes that can be defined. The first occurrence of the /f parameter
on the command-line defines the first scan class of the interface; the
Required for reading second occurrence defines the second scan class, and so on. PI Points
scan-based inputs are associated with a particular scan class via the Location4 PI Point
attribute. For example, all PI Points that have Location4 set to 1 will
receive input values at the frequency defined by the first scan class.
Similarly, all points that have Location4 set to 2 will receive input values
at the frequency specified by the second scan class, and so on.
Two scan classes are defined in the following example:
/f=00:01:00,00:00:05 /f=00:00:07
or, equivalently:

OPC HDA Interface 63

Startup Command File

/f=60,5 /f=7
The first scan class has a scanning frequency of 1 minute with an offset
of 5 seconds, and the second scan class has a scanning frequency of
7 seconds. When an offset is specified, the scans occur at discrete
moments in time according to the formula:
scan times = (reference time) + n(frequency) + offset
where n is an integer and the reference time is midnight on the day that
the interface was started. In the above example, frequency is
60 seconds and offset is 5 seconds for the first scan class. This means
that if the interface was started at 05:06:06, the first scan would be at
05:07:05, the second scan would be at 05:08:05, and so on. Since no
offset is specified for the second scan class, the absolute scan times
are undefined.
The definition of a scan class does not guarantee that the associated
points will be scanned at the given frequency. If the interface is under a
large load, then some scans may occur late or be skipped entirely. See
the section “Performance Summaries” in the UniInt Interface User
Manual.doc for more information on skipped or missed scans.
Sub-second Scan Classes
Sub-second scan classes can be defined on the command-line, such
as
/f=0.5 /f=00:00:00.1
where the scanning frequency associated with the first scan class is
0.5 seconds and the scanning frequency associated with the second
scan class is 0.1 of a second.
Similarly, sub-second scan classes with sub-second offsets can be
defined, such as
/f=0.5,0.2 /f=1,0
Wall Clock Scheduling
Scan classes that strictly adhere to wall clock scheduling are now
possible. This feature is available for interfaces that run on Windows
and/or UNIX. Previously, wall clock scheduling was possible, but not
across daylight saving time. For example,
/f=24:00:00,08:00:00 corresponds to 1 scan a day starting at 8
AM. However, after a Daylight Saving Time change, the scan would
occur either at 7 AM or 9 AM, depending upon the direction of the time
shift. To schedule a scan once a day at 8 AM (even across daylight
saving time), use /f=24:00:00,00:08:00,L. The ,L at the end
of the scan class tells UniInt to use the new wall clock scheduling
algorithm.
/FT=# The number of attempts to connect, before switching to the Backup
Optional OPC HDA Server.
Default: /FT=10
GS=# The call to the OPCHDA Server will be made in groups of # number of
Optional tags. Within each scan class, the call to the OPCHDA Server will be
made in groups of x up to the number of points the scan class.
Dafault: /GS=1
The start time of each data request will be done from the previous end
time.
Without the /GS parameter, the calls to the OPCHDA server will be
done one tag at a time with the start time being the time stamp of the
last value read from the OPCHDA Server.
/HI=x The maximum amount of time to go back in history at startup. For
Optional example: 1d for one day.
Default: 2d Default is 2d.

64
 /host=host:port The /host parameter is used to specify the PI Home node. Host is
Required the IP address of the PI Sever node or the domain name of the PI
Server node. Port is the port number for TCP/IP communication.
The port is always 5450. It is recommended to explicitly define the host
and port on the command-line with the /host parameter.
Nevertheless, if either the host or port is not specified, the interface will
attempt to use defaults.

Examples:

The interface is running on a PI Interface Node, the domain name of

the PI home node is Marvin, and the IP address of Marvin is
206.79.198.30. Valid /host parameters would be:
/host=marvin
/host=marvin:5450
/host=206.79.198.30
/host=206.79.198.30:5450
/hronly= Specify time-range-specific history recovery. Specify times using PI
start,end time string formats with a colon separating the date and the time:
Optional /hronly=10-dec-98:10:00,10-dec-98:12:00
When configured for time-range-specific history recovery, the interface
recovers data then exits.
/hrpause=# Milliseconds to pause between tags during history recovery. Used to
Optional throttle archive data retrieval during history recovery.
Default:
/hrpause=0
/id=x The /id parameter is used to specify the interface identifier.
Highly Recommended The interface identifier is a string that is no longer than 9 characters in
length. UniInt concatenates this string to the header that is used to
identify error messages as belonging to a particular interface. See the
Appendix A Error and Informational Messages for more information.
UniInt always uses the /id parameter in the fashion described above.
This interface also uses the /id parameter to identify a particular
interface copy number that corresponds to an integer value that is
assigned to Location1. For this interface, use only numeric characters
in the identifier. For example,
/id=1
/IS Tells the interface to ignore the server status returned by the OPC HDA
Optional Server. All servers should return
OPCHDA_UP
when they are ready to read values. Use this parameter if your
OPCHDA server does not do this.
/IT Tells the interface to discard the subsecond portion of the timestamps
Optional passed to PI Server and only send whole integer seconds. Use for
performance reasons. With this option, PI Server will require less
space, and possibly less CPU, to store the same amount of data. The
interface simply truncates the fractional part of the second.
/MA Tells the interface to verify up to 500 items at the same time. This can
Optional speed up the startup time. By default, the interface will verify one item
at a time.
Default: none
/MP=#c The maximum amount of time to request data from the OPC HDA per
Optional call. Instead of asking for data from last value to current time, call data
Default: none in chunks of time using the passed in max time period. (/MP=#c,
where # is a number and c is a unit like “D: for days, “H” for hours, “M”
for minutes, and “S” for seconds.

OPC HDA Interface 65

Startup Command File

/NT Tells the interface to never write I/O Timeout, including when interface
Optional loses connection with the OPCHDA Server.
Default: none
/ps=x The /ps parameter specifies the point source for the interface. X is not
Required case sensitive and can be any unique single or multiple character
string. For example, /ps=P and /ps=p are equivalent.
The point source that is assigned with the /ps parameter corresponds
to the PointSource attribute of individual PI Points. The interface will
attempt to load only those PI points with the appropriate point source.
If the PI API version being used is prior to 1.6.x or the PI Server version
is prior to 3.4.370.x, the PointSource is limited to a single
character.
/q Tells the interface to queue snapshots and exceptions before sending
Optional to the PI Server node.
The maximum queue size is close to 4000 bytes. The queue is flushed
between scans if it is not filled.
/RP=# Tells the interface to use the OPC HDA ReadProcessed call instead of
Optional the ReadRaw call.
The ReadProcessed call will return values at an interval based on the
scan time of the point’s scan class. For example: If a point is in a scan
class with a 10-second scan time, the ReadProcessed call will return
values at a 10-second interval instead of all the values in the HDA
server. This will reduce the traffic between the OPCHDA Server and
the interface.
There are three ways to configure this parameter:
/rp=0 — The ReadProcessed call will be made with the
OPCHDA_INTERPOLATIVE flag. This will cause the OPC HDA server
to return interpolated values at the scan interval.
/rp=1 — The ReadProcessed will be made with the
OPCHDA_START flag. This will cause the OPC HDA server to return
the value and timestamp at the start time of the interval
/rp=2 — The ReadProcessed will be made with the OPCHDA_END
flag. This will cause the OPC HDA server to return the value and
timestamp at the end time of interval.
/SA=# Adjusts the start time of the data call to the previous end time minus #
Optional number of seconds. This is used with the /GS (group size) parameter.
Default: none Use this parameter to provide some overlap in the data call to ensure
no data is missed if data goes into the OPCHDA Server after the
interface made the read call.
If the /GS parameter is not passed in, the /SA parameter will have no
effect.
/sd=x The number of seconds to wait after a connection to the OPC HDA
Optional Server and before scanning data. This is to allow time for the points on
the OPC Server to load before scanning.
/SERVER= Defines the OPC HDA Server to be used. Specify with the following
OPCHDAServer format:
Required /SERVER=FACT1NODE::MODBUSOPC_HDA
where FACT1NODE is the name of the computer where the OPC HDA
Server runs, and MODBUSOPC_HDA is the name of the OPC HDA
Server as registered on that machine. If the server runs on the same
machine as the interface, omit the node name:
/SERVER=MODBUSOPC_HDA
If the server name has embedded spaces, enclose the name in double
quotes:
/SERVER=”Server name with spaces”

66
 /sio The /sio parameter stands for “suppress initial outputs.” The
Optional parameter applies only for interfaces that support outputs. If the /sio
parameter is not specified, the interface will behave in the following
manner.
When the interface is started, the interface determines the current
Snapshot value of each output tag. Next, the interface writes this value
to each output tag. In addition, whenever an individual output tag is
edited while the interface is running, the interface will write the current
Snapshot value to the edited output tag.
This behavior is suppressed if the /sio parameter is specified on the
command-line. That is, outputs will not be written when the interface
starts or when an output tag is edited. In other words, when the
/sio parameter is specified, outputs will only be written when they
are explicitly triggered.
/stopstat If the /stopstat parameter is present on the startup command line,
or then the digital state Intf Shut will be written to each PI Point when
/stopstat= the interface is stopped.
digstate If /stopstat=digstate is present on the command line, then the
digital state, digstate, will be written to each PI Point when the
Default:
interface is stopped. For a PI 3 Server, digstate must be in the
/stopstat= system digital state table. UniInt uses the first occurrence in the table.
“Intf Shut” If neither /stopstat nor /stopstat=digstate is specified on
Optional the command line, then no digital states will be written when the
interface is shut down.
Note: The /stopstat parameter is disabled If the interface is
running in a UniInt failover configuration as defined in the UniInt
Failover Configuration section of this manual. Therefore, the digital
state, digstate, will not be written to each PI Point when the
interface is stopped. This prevents the digital state being written to PI
Points while a redundant system is also writing data to the same PI
Points. The /stopstat parameter is disabled even if there is only
one interface active in the failover configuration.
Examples:
/stopstat=shutdown
/stopstat=”Intf Shut”
The entire digstate value should be enclosed within double quotes
when there is a space in digstate.
/SW=# The number of seconds to wait for RUNNING status, before switching
Optional to the Backup OPC HDA Server.
Default: none
/TF=format Sets the format for timestamp strings written to the OPCHDA Server
Optional The interface writes output timestamps using TIM= in the ExDesc field.
See “Sending Timestamp and Output Value to Different ItemIDs“on
page 38 for more information. Valid tokens are:
cc yy mn mon dd hh hr mm ss 000 XM

OPC HDA Interface 67

Startup Command File

/TO=xx Applies an adjustment to the timestamps (a timestamp offset), to deal

Optional with broken servers and broken installations, where the clock for the
OPC HDA Server is set incorrectly (for example, the server requires the
clock to match the wallclock, but the Timezone must be GMT,
regardless of where the server is actually located). Do not use if the
server is working properly. Specify the parameter in seconds; you may
precede by a negative sign.
For example:
Time adjusted ahead by 1 hour
/TO=3600
Time adjusted back by 1 hour
/TO=-3600
Time adjusted ahead by 30 minutes
/TO=1800
/TSU If you need to use the timestamps received from the OPCHDA server
Optional without having them adjusted to the PI Server clock, use:
/TSU
This setting can cause your data to be lost, if your clocks are set
incorrectly. Please see the section on Timestamps before using this
setting.
/uht_id=# The value of this command-line parameter is used when creating UniInt
health points for an interface that uses Non-UniInt interface failover. It
is used for the Location3 point attribute for UniInt health points.
Required if any type of
failover other than
UnInt Interface Level
Failover Phase 1 or 2
is supported.
/UFO_ID=# Failover ID. This value must be different from the Failover ID of the
other interface in the failover pair. It can be any positive, non-zero
integer.
Required for UniInt
Interface Level
Failover Phase 1 or 2
/UFO_Interval=# Failover Update Interval
Specifies the heartbeat Update Interval in milliseconds and must be the
Optional same on both interface computers.
Default: 1000 This is the rate at which UniInt updates the Failover Heartbeat tags as
well as how often UniInt checks on the status of the other copy of the
interface.
Valid values are
5020000.
/UFO_OtherID=# Other Failover ID. This value must be equal to the Failover ID
configured for the other interface in the failover pair.
Required for UniInt
Interface Level
Failover Phase 1 or 2

68
 /UFO_Sync=path/ The Failover File Synchronization Filepath and Optional Filename
[filename] specify the path to the shared file used for failover synchronization and
an optional filename used to specify a user defined filename in lieu of
the default filename.
Required for UniInt
Interface Level
Failover Phase 2 The path to the shared file directory can be a fully qualified machine
synchronization. name and directory, a mapped drive letter, or a local path if the shared
file is on one of the interface nodes. The path must be terminated by a
slash ( / ) or backslash ( \ ) character. If no d terminating slash is
Any valid pathname /
any valid filename found, in the /UFO_Sync parameter, the interface interprets the final
character string as an optional filename.
The default filename is
generated as The optional filename can be any valid filename. If the file does not
executablename_point exist, the first interface to start attempts to create the file.
source_interfaceID.dat Note: If using the optional filename, do not supply a terminating
slash or backslash character.
If there are any spaces in the path or filename, the entire path and
filename must be enclosed in quotes.
Note: If you use the backslash and path separators and enclose the
path in double quotes, the final backslash must be a double backslash
(\\). Otherwise the closing double quote becomes part of the
parameter instead of a parameter separator.
Each node in the failover configuration must specify the same path and
filename and must have read, write, and file creation rights to the
shared directory specified by the path parameter.
The service that the interface runs against must specify a valid logon
user account under the “Log On” tab for the service properties.
/UFO_Type=type The Failover Type indicates which type of failover configuration the
interface will run. The valid types for failover are HOT, WARM, and
COLD configurations.
Required for UniInt
Interface Level If an interface does not supported the requested type of failover, the
Failover Phase 2. interface will shut down and log an error to the pipc.log file stating
the requested failover type is not supported.

Sample PIOPCHDAInt.bat File

The following is an example file:
REM =================================================================
REM PIOPCHDAInt.bat
REM
REM Sample startup file for the OPC HDA Interface
REM =================================================================
REM OSIsoft strongly recommends using PI ICU to modify startup files.
REM =================================================================
REM
REM The ^ marks are continuation characters, they allow
REM a command to be split between multiple lines.
REM There must not be ANYTHING after the ^ on each line.
REM
REM Sample command line
REM
PIOPCHDAInt ^
/ps=OPCHDA ^
/id=1 ^
/SERVER=OSI.HDA.1 ^
/host=XXXXXX:5450 ^
/f=00:01:00 ^

OPC HDA Interface 69

Startup Command File

/f=00:00:30
REM
REM End of PIOPCHDAInt.bat

70
Chapter 11. UniInt Failover Configuration

Introduction
To minimize data loss during a single point of failure within a system, UniInt provides two
failover schemas: (1) synchronization through the data source and (2) synchronization
through a shared file. Synchronization through the data source is Phase 1, and
synchronization through a shared file is Phase 2.
Phase 1 UniInt Failover uses the data source itself to synchronize failover operations and
provides a hot failover, no data loss solution when a single point of failure occurs. For this
option, the data source must be able to communicate with and provide data for two interfaces
simultaneously. Additionally, the failover configuration requires the interface to support
outputs.
Phase 2 UniInt Failover uses a shared file to synchronize failover operations and provides for
hot, warm, or cold failover. The Phase 2 hot failover configuration provides a no data loss
solution for a single point of failure similar to Phase 1. However, in warm and cold failover
configurations, you can expect a small period of data loss during a single point of failure
transition.

Note: This interface supports only Phase 2 failover.

You can also configure the UniInt interface level failover to send data to a PI collective that
supports PI Server high availability (HA). The collective provides redundant PI Servers to
allow for the uninterrupted collection and presentation of PI time series data. In an HA
configuration, PI Servers can be taken down for maintenance or repair. See the High
Availability Administrator Guide for more information about PI collectives.
When configured for UniInt failover, the interface routes all PI data through a state machine.
The state machine determines whether to queue data or send it directly to PI depending on the
current state of the interface. When the interface is in the active state, data sent through the
interface gets routed directly to PI. In the backup state, data from the interface gets queued
for a short period. Queued data in the backup interface ensures a no-data loss failover under
normal circumstances for Phase 1 and for the hot failover configuration of Phase 2. The same
algorithm of queuing events while in backup is used for output data.

OPC HDA Interface 71

UniInt Failover Configuration

Quick Overview
The Quick Overview below may be used to configure this Interface for failover. The failover
configuration requires the two copies of the interface participating in failover be installed on
different nodes. Users should verify non-failover interface operation as discussed in the
Installation Checklist section of this manual prior to configuring the interface for failover
operations. If you are not familiar with UniInt failover configuration, return to this section
after reading the rest of the UniInt Failover Configuration section in detail. If a failure occurs
at any step below, correct the error and start again at the beginning of step 6 Test in the table
below. For the discussion below, the first copy of the interface configured and tested will be
considered the primary interface and the second copy of the interface configured will be the
backup interface.

Configuration
One Data Source
Two Interfaces

Prerequisites
Interface 1 is the Primary interface for collection of PI data from the data source.
Interface 2 is the Backup interface for collection of PI data from the data source.
You must setup a shared file.
Phase 2: The shared file must store data for five failover tags: (1) Active ID,
(2) Heartbeat 1, (3) Heartbeat 2, (4) Device Status 1 and (5) Device Status 2.
Each interface must be configured with two required failover command line parameters:
(1) its FailoverID number (/UFO_ID); (2) the FailoverID number of its Backup
interface (/UFO_OtherID). You must also specify the name of the PI Server host for
exceptions and PI tag updates.
All other configuration parameters for the two interfaces must be identical.

72
 Synchronization through a Shared File (Phase 2)

Data register 0
. DataSource
. DCS/PLC/Data Server
.
Data register n

Process Network

FileSvr
IF-Node1 IF-Node2
.\UFO\Intf_PS_1.dat PI-Interface.exe
PI-Interface.exe
/host=PrimaryPI /host=SecondaryPI
/UFO_ID=1 /UFO_ID=2
/UFO_OTHERID=2 /UFO_OTHERID=1
/UFO_TYPE=HOT /UFO_TYPE=HOT
/UFO_SYNC=\\FileSvr\UFO\Intf_PS_1.dat /UFO_SYNC=\\FileSvr\UFO\Intf_PS_1.dat

Business Network

Client PrimaryPI SecondaryPI

Process Book PI Server PI Server
DataLink Role = 1 Role = 2

Figure 1: Synchronization through a Shared File (Phase 2) Failover Architecture

The Phase 2 failover architecture is shown in Figure 2 which depicts a typical network setup
including the path to the synchronization file located on a File Server (FileSvr). Other
configurations may be supported and this figure is used only as an example for the following
discussion.
For a more detailed explanation of this synchronization method, see Detailed Explanation of
Synchronization through a Shared File (Phase 2)

OPC HDA Interface 73

UniInt Failover Configuration

Configuring Synchronization through a Shared File (Phase 2)

Step Description
1. Verify non-failover interface operation as described in the Installation Checklist section of
this manual
2. Configure the Shared File
Choose a location for the shared file. The file can reside on one of the interface nodes but
OSIsoft strongly recommends that you put the file on a dedicated file server that has no
other role in data collection.
Setup a file share and make sure to assign the permissions so that both Primary and
Backup interfaces have read/write access to the file.
3. Configure the interface parameters
Use the Failover section of the Interface Configuration Utility (ICU) to enable failover and
create two parameters for each interface: (1) a Failover ID number for the interface; and
(2) the Failover ID number for its backup interface.
The Failover ID for each interface must be unique and each interface must know the
Failover ID of its backup interface.
If the interface can perform using either Phase 1 or Phase 2 pick the Phase 2 radio button
in the ICU.
Select the synchronization File Path and File to use for Failover.
Select the type of failover required (Cold, Warm, Hot). The choice depends on what types
of failover the interface supports.
Ensure that the user name assigned in the “Log on as:” parameter in the Service section
of the ICU is a user that has read/write access to the folder where the shared file will
reside.
All other command line parameters for the primary and secondary interfaces must be
identical.
If you use a PI Collective, you must point the primary and secondary interfaces to different
members of the collective by setting the SDK Member under the PI Host Information
section of the ICU.
[Option] Set the update rate for the heartbeat point if you need a value other than the
default of 5000 milliseconds.
4. Configure the PI tags
Configure five PI tags for the interface: the Active ID, Heartbeat 1, Heartbeat2, Device
Status 1 and Device Status 2. You can also configure two state tags for monitoring the
status of the interfaces.
Do not confuse the failover Device status tags with the UniInt Health Device Status tags.
The information in the two tags is similar, but the failover device status tags are integer
values and the health device status tags are string values.
Tag ExDesc digitalset
ActiveID [UFO2_ACTIVEID]
IF1_Heartbeat [UFO2_HEARTBEAT:#]
(IF-Node1)
IF2_Heartbeat [UFO2_HEARTBEAT:#] UniInt does not
(IF-Node2) examine the
IF1_DeviceStatus [UFO2_DEVICESTAT:#] remaining attributes,
(IF-Node1) but the pointsource
and location1 must
IF2_DeviceStatus [UFO2_DEVICESTAT:#] match
(IF-Node2)
IF1_State [UFO2_STATE:#] IF_State
(IF-Node1)
IF2_State [UFO2_STATE:#] IF_State
(IF-Node2)

74
 5. Test the configuration.
After configuring the shared file and the interface and PI tags, the interface should be
ready to run.
See Troubleshooting UniInt Failover for help resolving Failover issues.
1. Start the primary interface interactively without buffering.
2. Verify a successful interface start by reviewing the pipc.log file. The log file
will contain messages that indicate the failover state of the interface. A
successful start with only a single interface copy running will be indicated by
an informational message stating “UniInt failover: Interface in the “Primary”
state and actively sending data to PI. Backup interface not available.” If the
interface has failed to start, an error message will appear in the log file. For
details relating to informational and error messages, refer to the Messages
section below.
3. Verify data on the PI Server using available PI tools.
 The Active ID control tag on the PI Server must be set to the value of
the running copy of the interface as defined by the /UFO_ID startup
command-line parameter.
 The Heartbeat control tag on the PI Server must be changing values at
a rate specified by the /UFO_Interval startup command-line
parameter.
4. Stop the primary interface.
5. Start the backup interface interactively without buffering. Notice that this copy
will become the primary because the other copy is stopped.
6. Repeat steps 2, 3, and 4.
7. Stop the backup interface.
8. Start buffering.
9. Start the primary interface interactively.
10. Once the primary interface has successfully started and is collecting data,
start the backup interface interactively.
11. Verify that both copies of the interface are running in a failover configuration.
 Review the pipc.log file for the copy of the interface that was started
first. The log file will contain messages that indicate the failover state of
the interface. The state of this interface must have changed as
indicated with an informational message stating “UniInt failover:
Interface in the “Primary” state and actively sending
data to PI. Backup interface available.” If the interface
has not changed to this state, browse the log file for error messages.
For details relating to informational and error messages, refer to the
Messages section below.
 Review the pipc.log file for the copy of the interface that was started
last. The log file will contain messages that indicate the failover state of
the interface. A successful start of the interface will be indicated by an
informational message stating “UniInt failover: Interface in
the “Backup” state.” If the interface has failed to start, an error
message will appear in the log file. For details relating to informational
and error messages, refer to the Messages section below.
12. Verify data on the PI Server using available PI tools.
 The Active ID control tag on the PI Server must be set to the value of
the running copy of the interface that was started first as defined by the
/UFO_ID startup command-line parameter.
 The Heartbeat control tags for both copies of the interface on the PI
Server must be changing values at a rate specified by the

OPC HDA Interface 75

UniInt Failover Configuration

/UFO_Interval startup command-line parameter or the scan class

which the points have been built against.
13. Test Failover by stopping the primary interface.
14. Verify the backup interface has assumed the role of primary by searching the
pipc.log file for a message indicating the backup interface has changed to
the “UniInt failover: Interface in the “Primary” state and
actively sending data to PI. Backup interface not
available.” The backup interface is now considered primary and the
previous primary interface is now backup.
15. Verify no loss of data in PI. There may be an overlap of data due to the
queuing of data. However, there must be no data loss.
16. Start the backup interface. Once the primary interface detects a backup
interface, the primary interface will now change state indicating “UniInt
failover: Interface in the “Primary” state and actively
sending data to PI. Backup interface available.” In the
pipc.log file.
17. Verify the backup interface starts and assumes the role of backup. A
successful start of the backup interface will be indicated by an informational
message stating “UniInt failover: Interface in “Backup
state.” Since this is the initial state of the interface, the informational
message will be near the beginning of the start sequence of the pipc.log
file.
18. Test failover with different failure scenarios (e.g. loss of PI connection for a
single interface copy). UniInt failover guarantees no data loss with a single
point of failure. Verify no data loss by checking the data in PI and on the
data source.
19. Stop both copies of the interface, start buffering, start each interface as a
service.
20. Verify data as stated above.
21. To designate a specific interface as primary. Set the Active ID point on the
Data Source Server of the desired primary interface as defined by the
/UFO_ID startup command-line parameter.

76
 Configuring UniInt Failover through a Shared File (Phase 2)

Start-Up Parameters

Note: The /stopstat parameter is disabled If the interface is running in a UniInt

failover configuration. Therefore, the digital state, digstate, will not be written to
each PI Point when the interface is stopped. This prevents the digital state being
written to PI Points while a redundant system is also writing data to the same PI
Points. The /stopstat parameter is disabled even if there is only one interface
active in the failover configuration.

The following table lists the start-up parameters used by UniInt Failover Phase 2. All of the
parameters are required except the /UFO_Interval startup parameter. See the table below
for further explanation.
Parameter Required/ Description Value/Default
Optional
/UFO_ID=# Required Failover ID for IF-Node1 Any positive, non-
This value must be different from zero integer / 1
the failover ID of IFNode2.
Required Failover ID for IF-Node2 Any positive, non-
This value must be different from zero integer / 2
the failover ID of IFNode1.
/UFO_OtherID=# Required Other Failover ID for IF-Node1 Same value as
The value must be equal to the Failover ID for
Failover ID configured for the IFNode2 / 2
interface on IF-Node2.
Required Other Failover ID for IF-Node2 Same value as
The value must be equal to the Failover ID for
Failover ID configured for the IFNode1 / 1
interface on IF-Node1.
/UFO_Sync= Required for The Failover File Synchronization Any valid pathname /
path/[filename] Phase 2 Filepath and Optional Filename any valid filename
synchronization specify the path to the shared file The default filename
used for failover synchronization is generated as
and an optional filename used to executablename_
specify a user defined filename in pointsource_
lieu of the default filename.
interfaceID.dat
The path to the shared file
directory can be a fully qualified
machine name and directory, a
mapped drive letter, or a local path
if the shared file is on one of the
interface nodes. The path must be
terminated by a slash ( / ) or
backslash ( \ ) character. If no
terminating slash is found, in the
/UFO_Sync parameter, the
interface interprets the final
character string as an optional
filename.
The optional filename can be any
valid filename. If the file does not
exist, the first interface to start
attempts to create the file.
Note: If using the optional

OPC HDA Interface 77

UniInt Failover Configuration

filename, do not supply a

terminating slash or backslash
character.
If there are any spaces in the path
or filename, the entire path and
filename must be enclosed in
quotes.
Note: If you use the backslash
and path separators and enclose
the path in double quotes, the final
backslash must be a double
backslash (\\). Otherwise the
closing double quote becomes
part of the parameter instead of a
parameter separator.
Each node in the failover
configuration must specify the
same path and filename and must
have read, write, and file creation
rights to the shared directory
specified by the path parameter.
The service that the interface runs
against must specify a valid logon
user account under the “Log On”
tab for the service properties.
/UFO_Type=type Required The Failover Type indicates which COLD|WARM|HOT /
type of failover configuration the COLD
interface will run. The valid types
for failover are HOT, WARM, and
COLD configurations.
If an interface does not supported
the requested type of failover, the
interface will shutdown and log an
error to the pipc.log file stating
the requested failover type is not
supported.
/UFO_Interval=# Optional Failover Update Interval 50 – 20000 / 1000
Specifies the heartbeat Update
Interval in milliseconds and must
be the same on both interface
computers.
This is the rate at which UniInt
updates the Failover Heartbeat
tags as well as how often UniInt
checks on the status of the other
copy of the interface.

78
 /Host=server Required Host PI Server for Exceptions and For IF-Node1
PI tag updates PrimaryPI / None
The value of the /Host startup For IF-Node2
parameter depends on the SecondaryPI / None
PI Server configuration. If the
PI Server is not part of a collective,
the value of /Host must be
identical on both interface
computers.
If the redundant interfaces are
being configured to send data to a
PI Server collective, the value of
the /Host parameters on the
different interface nodes should
equal to different members of the
collective.
This parameter ensures that
outputs continue to be sent to the
Data Source if one of the
PI Servers becomes unavailable
for any reason.

Failover Control Points

The following table describes the points that are required to manage failover. In Phase 2
Failover, these points are located in a data file shared by the Primary and Backup interfaces.
OSIsoft recommends that you locate the shared file on a dedicated server that has no other
role in data collection. This avoids potential resource contention and processing degradation
if your system monitors a large number of data points at a high frequency.
Point Description Value / Default
ActiveID Monitored by the interfaces to determine which From 0 to the highest
interface is currently sending data to PI. Interface Failover ID
ActiveID must be initialized so that when the number / None)
interfaces read it for the first time, it is not an Updated by the
error. redundant Interfaces
ActiveID can also be used to force failover. For Can be changed
example, if the current Primary is IF-Node 1 and manually to initiate a
ActiveID is 1, you can manually change manual failover
ActiveID to 2. This causes the interface at IF-
Node2 to transition to the primary role and the
interface at IFNode1 to transition to the backup
role.
Heartbeat 1 Updated periodically by the interface on Values range between
IFNode1. The interface on IF-Node2 monitors 0 and 31 / None
this value to determine if the interface on Updated by the
IFNode1 has become unresponsive. Interface on IF-Node1
Heartbeat 2 Updated periodically by the interface on IF- Values range between
Node2. The interface on IF-Node1 monitors this 0 and 31 / None
value to determine if the interface on IF-Node2 Updated by the
has become unresponsive. Interface on IF-Node2

PI Tags

OPC HDA Interface 79

UniInt Failover Configuration

The following tables list the required UniInt Failover Control PI tags, the values they will
receive, and descriptions.

Active_ID Tag Configuration

Attributes ActiveID
Tag <Intf>_ActiveID
ExDesc [UFO2_ActiveID]
Location1 Match # in /id=#
Location5 Optional, Time in min to wait for backup
to collect data before failing over.
Point Source Match x in /ps=x
Point Type Int32
Shutdown 0
Step 1

Heartbeat and Device Status Tag Configuration

Attribute Heartbeat 1 Heartbeat 2 DeviceStatus 1 DeviceStatus 2
Tag <HB1> <HB2> <DS1> <DS2>
[UFO2_Heartbeat:#] [UFO2_Heartbeat:#] [UFO2_DeviceStat:#] [UFO2_DeviceStat:#]
ExDesc Match # in Match # in Match # in Match # in
/UFO_ID=# /UFO_OtherID=# /UFO_ID=# /UFO_OtherID=#
Location1 Match # in /id=# Match # in /id=# Match # in /id=# Match # in /id=#
Location5 Optional, Time in Optional, Time in Optional, Time in Optional, Time in
min to wait for min to wait for min to wait for min to wait for
backup to collect backup to collect backup to collect backup to collect
data before failing data before failing data before failing data before failing
over. over. over. over.
Point
Match x in /ps=x Match x in /ps=x Match x in /ps=x Match x in /ps=x
Source
Point Type int32 int32 int32 int32
Shutdown 0 0 0 0
Step 1 1 1 1

Interface State Tag Configuration

Attribute Primary Backup
Tag <Tagname1> <Tagname2>
DigitalSet UFO_State UFO_State
ExDesc [UFO2_State:#] [UFO2_State:#]
(Match /UFO_ID=# on primary node) (Match /UFO_ID=# on backup node)
Location1 Match # in /id=# Same as for Primary node
PointSource Match x in /ps=x Same as for Primary node
PointType digital digital
Shutdown 0 0
Step 1 1

The following table describes the extended descriptor for the above PI tags in more detail.

80
 PI Tag ExDesc Required / Description Value
Optional
[UFO2_ACTIVEID] Required Active ID tag 0 – highest
The ExDesc must start with the Interface Failover
case sensitive string: ID
[UFO2_ACTIVEID]. Updated by the
The pointsource must match the redundant
interfaces’ point source. Interfaces
Location1 must match the ID for the
interfaces.
Location5 is the COLD failover retry
interval in minutes. This can be
used to specify how long before an
interface retries to connect to the
device in a COLD failover
configuration. (See the description
of COLD failover retry interval for a
detailed explanation.)
[UFO2_HEARTBEAT:#] Required Heartbeat 1 Tag 0 – 31 / None
(IF-Node1) The ExDesc must start with the Updated by the
case sensitive string: Interface on
[UFO2_HEARTBEAT:#] IFNode1
The number following the colon (
must be the Failover ID for the
interface running on IFNode1.
The pointsource must match the
interfaces’ point source.
Location1 must match the ID for the
interfaces.
[UFO2_HEARTBEAT:#] Required Heartbeat 2 Tag 0 – 31 / None
(IF-Node2) The ExDesc must start with the Updated by the
case sensitive string: Interface on
[UFO2_HEARTBEAT:#] IFNode2
The number following the colon (
must be the Failover ID for the
interface running on IFNode2.
The pointsource must match the
interfaces’ point source.
Location1 must match the id for the
interfaces.

OPC HDA Interface 81

UniInt Failover Configuration

[UFO2_DEVICESTAT :#] Required Device Status 1 Tag 0 – 99 / None

(IF-Node1) The ExDesc must start with the Updated by the
case sensitive string: Interface on
[UFO2_HEARTBEAT:#] IFNode1
The value following the colon (
must be the Failover ID for the
interface running on IF-Node1
The pointsource must match the
interfaces’ point source.
Location1 must match the id for the
interfaces.
A lower value is a better status and
the interface with the lower status
will attempt to become the primary
interface.
The failover 1 device status tag is
very similar to the UniInt Health
Device Status tag except the data
written to this tag are integer
values. A value of 0 is good and a
value of 99 is OFF. Any value
between these two extremes may
result in a failover. The interface
client code updates these values
when the health device status tag is
updated.
[UFO2_DEVICESTAT :#] Required Device Status 2 Tag 0 – 99 / None
(IF-Node2) The ExDesc must start with the Updated by the
case sensitive string: Interface on
[UFO2_HEARTBEAT:#] IFNode2
The number following the colon (
must be the Failover ID for the
interface running on IF-Node2
The pointsource must match the
interfaces’ point source.
Location1 must match the ID for the
interfaces.
A lower value is a better status and
the interface with the lower status
will attempt to become the primary
interface.
[UFO2_STATE:#] Optional State 1 Tag 0 – 5 / None
(IF-Node1) The ExDesc must start with the Normally updated
case sensitive string: by the Interface
[UFO2_STATE:#] currently in the
The number following the colon ( primary role.
must be the Failover ID for the
interface running on IFNode1
The failover state tag is
recommended.
The failover state tags are digital
tags assigned to a digital state set
with the following values.
0 = Off: The interface has been
shut down.
1 = Backup No Data Source: The
interface is running but cannot
communicate with the data source.
2 = Backup No PI Connection: The

82
 interface is running and connected
to the data source but has lost its
communication to the PI Server.
3 = Backup: The interface is
running and collecting data
normally and is ready to take over
as primary if the primary interface
shuts down or experiences
problems.
4 = Transition: The interface stays
in this state for only a short period
of time. The transition period
prevents thrashing when more than
one interface attempts to assume
the role of primary interface.
5 = Primary: The interface is
running, collecting data and
sending the data to PI.
[UFO2_STATE:#] Optional State 2 Tag Normally updated
(IF-Node2) The ExDesc must start with the by the Interface
case sensitive string: currently in the
[UFO2_STATE:#] Primary state.
The number following the colon ( Values range
must be the Failover ID for the between 0 and 5.
interface running on IFNode2 See description of
The failover state tag is State 1 tag.
recommended.

OPC HDA Interface 83

UniInt Failover Configuration

Detailed Explanation of Synchronization through a Shared File

(Phase 2)
In a shared file failover configuration, there is no direct failover control information passed
between the data source and the interface. This failover scheme uses five PI tags to control
failover operation, and all failover communication between primary and backup interfaces
passes through a shared data file.
Once the interface is configured and running, the ability to read or write to the PI tags is not
required for the proper operation of failover. This solution does not require a connection to
the PI Server after initial startup because the control point data are set and monitored in the
shared file. However, the PI tag values are sent to the PI Server so that you can monitor them
with standard OSIsoft client tools.
You can force manual failover by changing the ActiveID on the data source to the backup
failover ID.

Data register 0
. DataSource
. DCS/PLC/Data Server
.
Data register n

Process Network

FileSvr
IF-Node1 IF-Node2
.\UFO\Intf_PS_1.dat PI-Interface.exe
PI-Interface.exe
/host=PrimaryPI /host=SecondaryPI
/UFO_ID=1 /UFO_ID=2
/UFO_OTHERID=2 /UFO_OTHERID=1
/UFO_TYPE=HOT /UFO_TYPE=HOT
/UFO_SYNC=\\FileSvr\UFO\Intf_PS_1.dat /UFO_SYNC=\\FileSvr\UFO\Intf_PS_1.dat

Business Network

Client PrimaryPI SecondaryPI

Process Book PI Server PI Server
DataLink Role = 1 Role = 2

The figure above shows a typical network setup in the normal or steady state. The solid
magenta lines show the data path from the interface nodes to the shared file used for failover
synchronization. The shared file can be located anywhere in the network as long as both
interface nodes can read, write, and create the necessary file on the shared file machine.
OSIsoft strongly recommends that you put the file on a dedicated file server that has no other
role in the collection of data.
The major difference between synchronizing the interfaces through the data source (Phase 1)
and synchronizing the interfaces through the shared file (Phase 2) is where the control data is
located. When synchronizing through the data source, the control data is acquired directly
from the data source. We assume that if the primary interface cannot read the failover control

84
 points, then it cannot read any other data. There is no need for a backup communications path
between the control data and the interface.
When synchronizing through a shared file, however, we cannot assume that loss of control
information from the shared file implies that the primary interface is down. We must account
for the possible loss of the path to the shared file itself and provide an alternate control path
to determine the status of the primary interface. For this reason, if the shared file is
unreachable for any reason, the interfaces use the PI Server as an alternate path to pass
control data.
When the backup interface does not receive updates from the shared file, it cannot tell
definitively why the primary is not updating the file, whether the path to the shared file is
down, whether the path to the data source is down, or whether the interface itself is having
problems. To resolve this uncertainty, the backup interface uses the path to the PI Server to
determine the status of the primary interface. If the primary interface is still communicating
with the PI Server, than failover to the backup is not required. However, if the primary
interface is not posting data to the PI Server, then the backup must initiate failover operations.
The primary interface also monitors the connection with the shared file to maintain the
integrity of the failover configuration. If the primary interface can read and write to the
shared file with no errors but the backup control information is not changing, then the backup
is experiencing some error condition. To determine exactly where the problem exists, the
primary interface uses the path to PI to establish the status of the backup interface. For
example, if the backup interface controls indicate that it has been shutdown, it may have been
restarted and is now experiencing errors reading and writing to the shared file. Both primary
and backup interfaces must always check their status through PI to determine if one or the
other is not updating the shared file and why.

Steady State Operation

Steady state operation is considered the normal operating condition. In this state, the primary
interface is actively collecting data and sending its data to PI. The primary interface is also
updating its heartbeat value; monitoring the heartbeat value for the backup interface,
checking the active ID value, and checking the device status for the backup interface every
failover update interval on the shared file. Likewise, the backup interface is updating its
heartbeat value; monitoring the heartbeat value for the primary interface, checking the active
ID value, and checking the device status for the primary interface every failover update
interval on the shared file. As long as the heartbeat value for the primary interface indicates
that it is operating properly, the ActiveID has not changed, and the device status on the
primary interface is good, the backup interface will continue in this mode of operation.
An interface configured for hot failover will have the backup interface actively collecting and
queuing data but not sending that data to PI. An interface for warm failover in the backup role
is not actively collecting data from the data source even though it may be configured with PI
tags and may even have a good connection to the data source. An interface configured for
cold failover in the backup role is not connected to the data source and upon initial startup
will not have configured PI tags.
The interaction between the interface and the shared file is fundamental to failover. The
discussion that follows only refers to the data written to the shared file. However, every value
written to the shared file is echoed to the tags on the PI Server. Updating of the tags on the
PI Server is assumed to take place unless communication with the PI Server is interrupted.
The updates to the PI Server will be buffered by bufserv or BufSS in this case.

OPC HDA Interface 85

UniInt Failover Configuration

In a hot failover configuration, each interface participating in the failover solution will queue
three failover intervals worth of data to prevent any data loss. When a failover occurs, there
may be a period of overlapping data for up to 3 intervals. The exact amount of overlap is
determined by the timing and the cause of the failover and may be different every time. Using
the default update interval of 5 seconds will result in overlapping data between 0 and 15
seconds. The no data loss claim for hot failover is based on a single point of failure. If both
interfaces have trouble collecting data for the same period of time, data will be lost during
that time.
As mentioned above, each interface has its own heartbeat value. In normal operation, the
Heartbeat value on the shared file is incremented by UniInt from 1 – 15 and then wraps
around to a value of 1 again. UniInt increments the heartbeat value on the shared file every
failover update interval. The default failover update interval is 5 seconds. UniInt also reads
the heartbeat value for the other interface copy participating in failover every failover update
interval. If the connection to the PI Server is lost, the value of the heartbeat will be
incremented from 17 – 31 and then wrap around to a value of 17 again. Once the connection
to the PI Server is restored, the heartbeat values will revert back to the 1 – 15 range. During a
normal shutdown process, the heartbeat value will be set to zero.
During steady state, the ActiveID will equal the value of the failover ID of the primary
interface. This value is set by UniInt when the interface enters the primary state and is not
updated again by the primary interface until it shuts down gracefully. During shutdown, the
primary interface will set the ActiveID to zero before shutting down. The backup interface
has the ability to assume control as primary even if the current primary is not experiencing
problems. This can be accomplished by setting the ActiveID tag on the PI Server to the
ActiveID of the desired interface copy.
As previously mentioned, in a hot failover configuration the backup interface actively collects
data but does not send its data to PI. To eliminate any data loss during a failover, the backup
interface queues data in memory for three failover update intervals. The data in the queue is
continuously updated to contain the most recent data. Data older than three update intervals is
discarded if the primary interface is in a good status as determined by the backup. If the
backup interface transitions to the primary, it will have data in its queue to send to PI. This
queued data is sent to PI using the same function calls that would have been used had the
interface been in a primary state when the function call was received from UniInt. If UniInt
receives data without a timestamp, the primary copy uses the current PI time to timestamp
data sent to PI. Likewise, the backup copy timestamps data it receives without a timestamp
with the current PI time before queuing its data. This preserves the accuracy of the
timestamps.

86
 Failover Configuration Using PI ICU
The use of the PI ICU is the recommended and safest method for configuring the Interface for
UniInt failover. With the exception of the notes described in this section, the Interface shall
be configured with the PI ICU as described in the “Configuring the Interface with the PI
ICU” section of this manual.

Note: With the exception of the /UFO_ID and /UFO_OtherID startup command-
line parameters, the UniInt failover scheme requires that both copies of the interface
have identical startup command files. This requirement causes the PI ICU to
produce a message when creating the second copy of the interface stating that the
“PS/ID combo already in use by the interface” as shown in Figure 2 below. Ignore
this message and click the Add button.

Create the Interface Instance with PI ICU

If the interface does not already exist in the ICU it must first be created. The procedure for
doing this is the same as for non-failover interfaces. When configuring the second instance
for UniInt Failover the Point Source and Interface ID will be in yellow and a message will be
displayed saying this is already in use. This should be ignored.

Figure 2: PI ICU configuration screen shows that the “PS/ID combo is already in use by
the interface.” The user must ignore the yellow boxes, which indicate errors, and click the
Add button to configure the interface for failover.

Configuring the UniInt Failover Startup Parameters with PI ICU

There are three interface startup parameters that control UniInt failover: /UFO_ID,
/UFO_OtherID, and /UFO_Interval. The UFO stands for UniInt Failover. The /UFO_ID
and /UFO_OtherID parameters are required for the interface to operate in a failover

OPC HDA Interface 87

UniInt Failover Configuration

configuration, but the /UFO_Interval is optional. Each of these parameters is described in

detail in Configuring UniInt Failover through a Shared File (Phase 2) section and Start-Up
Parameters.

Figure 3: The figure above illustrates the PI ICU failover configuration screen showing
the UniInt failover startup parameters (Phase 2). This copy of the interface defines its
Failover ID as 2 (/UFO_ID=2) and the other interfaces Failover ID as 1
(/UFO_OtherID=1). The other failover interface copy must define its Failover ID as 1
(/UFO_ID=1) and the other interface Failover ID as 2 (/UFO_OtherID=2) in its ICU
failover configuration screen. It also defines the location and name of the
synchronization file as well as the type of failover as COLD.

Creating the Failover State Digital State Set

The UFO_State digital state set is used in conjunction with the failover state digital tag. If
the UFO_State digital state set has not been created yet, it can be using either the Failover
page of the ICU (1.4.1.0 or greater) or the Digital States plug-in in the SMT 3 Utility (3.0.0.7
or greater).

Using the PI ICU Utility to create Digital State Set

To use the UniInt Failover page to create the UFO_State digital state set right click on any of
the failover tags in the tag list and then select the “Create UFO_State Digital Set on Server
XXXXXX…”, where XXXXXX is the PI Server where the points will be or are create on.

88
 This choice will be grayed out if the UFO_State digital state set is already created on the
XXXXXX PI Server.

Using the PI SMT 3 Utility to create Digital State Set

Optionally the “Export UFO_State Digital Set (.csv) can be selected to create a comma
separated file to be imported via the System Manangement Tools (SMT3) (version 3.0.0.7 or
higher) or use the UniInt_Failover_DigitalSet_UFO_State.csv file included in the
installation kit.
The procedure below outlines the steps necessary to create a digital set on a PI Sever using
the “Import from File” function found in the SMT3 application. The procedure assumes the
user has a basic understanding of the SMT3 application.
1. Open the SMT3 application.
17. Select the appropriate PI Server from the PI Servers window. If the desired server is
not listed, add it using the PI Connection Manager. A view of the SMT application is
shown in Figure 4 below.
18. From the System Management Plug-Ins window, select Points then Digital States. A
list of available digital state sets will be displayed in the main window for the
selected PI Server. Refer to Figure 4 below.
19. In the main window, right click on the desired server and select the “Import from
File” option. Refer to Figure 4 below.

OPC HDA Interface 89

UniInt Failover Configuration

Figure 4: PI SMT application configured to import a digital state set file. The PI Servers
window shows the “localhost” PI Server selected along with the System Management
Plug-Ins window showing the Digital States PlugIn as being selected. The digital state
set file can now be imported by selecting the Import from File option for the localhost.
20. Navigate to and select the UniInt_Failover_DigitalSet_UFO_State.csv file
for import using the Browse icon on the display. Select the desired Overwrite
Options. Click on the OK button. Refer to Figure 5 below.

Figure 5: PI SMT application Import Digital Set(s) window. This view shows the
UniInt_Failover_DigitalSet_UFO_State.csv file as being selected for import.
Select the desired Overwrite Options by choosing the appropriate radio button.

90
 21. Navigate to and select the UniInt_Failover_DigitalSet_UFO_State.csv file
for import using the Browse icon on the display. Select the desired Overwrite
Options. Click on the OK button. Refer to Figure 5 above.
22. The UFO_State digital set is created as shown in Figure 6 below.

Figure 6: The PI SMT application showing the UFO_State digital set created on the
“localhost” PI Server.

OPC HDA Interface 91

UniInt Failover Configuration

Creating the UniInt Failover Control and Failover State Tags (Phase 2)
The ICU can be used to create the UniInt Failover Control and State Tags.
To use the ICU Failover page to create these tags simply right click any of the failover tags in
the tag list and select the “Create all points (UFO Phase 2)” menu item.
If this menu choice is grayed out it is because the UFO_State digital state set has not been
created on the Server yet. There is a menu choice “Create UFO_State Digitial Set on Server
xxxxxxx…” which can be used to create that digital state set. Once this has been done then
the “Create all points (UFO Phase2) should be available.

Once the failover control and failover state tags have been created the Failover page of the
ICU should look similar to the illustration below.

92
Chapter 12. Interface Node Clock

Make sure that the time and time zone settings on the computer are correct. To confirm, run
the Date/Time applet located in the Windows Control Panel. If the locale where the Interface
Node resides observes Daylight Saving Time, check the “Automatically adjust clock for
daylight saving changes” box. For example,

In addition, make sure that the TZ environment variable is not defined. All of the currently
defined environment variables can be viewed by opening a Command Prompt window and
typing set. That is,
C:> set
Confirm that TZ is not in the resulting list. If it is, run the System applet of the Control
Panel, click the “Environment Variables” button under the Advanced Tab, and remove TZ
from the list of environment variables.

OPC HDA Interface 93

Chapter 13. Security

Windows
The PI Firewall Database and the PI Proxy Database must be configured so that the interface
is allowed to write data to the PI Server. See “Modifying the Firewall Database” and
“Modifying the Proxy Database” in the PI Server manuals.
Note that the Trust Database, which is maintained by the Base Subsystem, replaces the Proxy
Database used prior to PI version 3.3. The Trust Database maintains all the functionality of
the proxy mechanism while being more secure.
See “Trust Login Security” in the chapter “Managing Security” of the PI Server System
Management Guide.
If the interface cannot write data to the PI Server because it has insufficient privileges, a
10401 error will be reported in the pipc.log file. If the interface cannot send data to a PI2
Serve, it writes a -999 error. See the section Appendix A: Error and Informational Messages
for additional information on error messaging.

PI Server v3.3 and Higher

Security configuration using piconfig

For PI Server v3.3 and higher, the following example demonstrates how to edit the PI Trust
table:
C:\PI\adm> piconfig
@table pitrust
@mode create
@istr Trust,IPAddr,NetMask,PIUser
a_trust_name,192.168.100.11,255.255.255.255,piadmin
@quit
For the above,
Trust: An arbitrary name for the trust table entry; in the above example,
a_trust_name
IPAddr: the IP Address of the computer running the Interface; in the above example,
192.168.100.11
NetMask: the network mask; 255.255.255.255 specifies an exact match with IPAddr
PIUser: the PI user the Interface to be entrusted as; piadmin is usually an appropriate user

Security Configuring using Trust Editor

OPC HDA Interface 95

Security

The Trust Editor plug-in for PI System Management Tools 3.x may also be used to edit the PI
Trust table.
See the PI System Management chapter in the PI Server manual for more details on security
configuration.

PI Server v3.2
For PI Server v3.2, the following example demonstrates how to edit the PI Proxy table:
C:\PI\adm> piconfig
@table pi_gen,piproxy
@mode create
@istr host,proxyaccount
piapimachine,piadmin
@quit
In place of piapimachine, put the name of the PI Interface node as it is seen by PI Server.

96
Chapter 14. Starting / Stopping the Interface

This section describes starting and stopping the Interface once it has been installed as a
service. See the UniInt Interface User Manual to run the Interface interactively.

Starting Interface as a Service

If the Interface was installed as service, it can be started from PI ICU, the Services control
panel or with the command:
PIOPCHDAInt.exe –start

To start the interface service with PI ICU, use the button on the PI ICU toolbar.
A message will inform the user of the status of the interface service. Even if the message
indicates that the service has started successfully, double check through the Services control
panel applet. Services may terminate immediately after startup for a variety of reasons, and
one typical reason is that the service is not able to find the command-line parameters in the
associated .bat file. Verify that the root name of the .bat file and the .exe file are the
same, and that the .bat file and the .exe file are in the same directory. Further
troubleshooting of services might require consulting the pipc.log file, Windows Event
Viewer, or other sources of log messages. See the section Appendix A: Error and
Informational Messages for additional information.

Stopping Interface Running as a Service

If the Interface was installed as service, it can be stopped at any time from PI ICU, the
Services control panel or with the command:
PIOPCHDAInt.exe –stop
The service can be removed by:
PIOPCHDAInt.exe –remove

To stop the interface service with PI ICU, use the button on the PI ICU toolbar.

OPC HDA Interface 97

Chapter 15. Buffering

Buffering refers to an Interface Node’s ability to temporarily store the data that interfaces
collect and to forward these data to the appropriate PI Servers. OSIsoft strongly recommends
that you enable buffering on your Interface Nodes. Otherwise, if the Interface Node stops
communicating with the PI Server, you lose the data that your interfaces collect.
The PI SDK installation kit installs two buffering applications: the PI Buffer Subsystem
(PIBufss) and the PI API Buffer Server (Bufserv). PIBufss and Bufserv are mutually
exclusive; that is, on a particular computer, you can run only one of them at any given time.
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, but OSIsoft
recommends that you run PIBufss instead.)

Which Buffering Application to Use

You should use PIBufss whenever possible because it offers better throughput than Bufserv.
In addition, if the interfaces on an Interface Node are sending data to a PI collective, PIBufss
guarantees identical data in the archive records of all the PI Servers that are part of that
collective.
You can use PIBufss only under the following conditions:
the PI Server version is at least 3.4.375.x; and
all of the interfaces running on the Interface Node send data to the same PI Server or to
the same PI Collective.
If any of the following scenarios apply, you must use Bufserv:
the PI Server version is earlier than 3.4.375.x; or
the Interface node runs multiple interfaces, and these interfaces send data to multiple PI
Servers that are not part of a single PI Collective.
If an Interface Node runs multiple interfaces, and these interfaces send data to two or more PI
collectives, then neither PIBufss nor Bufserv is appropriate. The reason is that PIBufss and
Bufserv can buffer data only to a single collective. If you need to buffer to more than one PI
collective, you need to use two or more Interface Nodes to run your interfaces.
It is technically possible to run Bufserv on the PI Server Node. However, OSIsoft does not
recommend this configuration.

How Buffering Works

OPC HDA Interface 99

Buffering

A complete technical description of PIBufss and Bufserv is beyond the scope of this
document. However, the following paragraphs provide some insights on how buffering
works.
When an Interface Node has Buffering enabled, the buffering application (PIBufss or
Bufserv) connects to the PI Server. It also creates shared memory storage.
When an interface program makes a PI API function call that writes data to the PI Server (for
example, pisn_sendexceptionqx()), the PI API checks whether buffering is enabled. If it
is, these data writing functions do not send the interface data to the PI Server. Instead, they
write the data to the shared memory storage that the buffering application created.
The buffering application (either Bufserv or PIBufss) in turn
reads the data in shared memory, and
if a connection to the PI Server exists, sends the data to the PI Server; or
if there is no connection to the PI Server, continues to store the data in shared memory (if
shared memory storage is available) or writes the data to disk (if shared memory
storage is full).
When the buffering application re-establishes connection to the PI Server, it writes to the PI
Server the interface data contained in both shared memory storage and disk.
(Before sending data to the PI Server, PIBufss performs further tasks such data validation and
data compression, but the description of these tasks is beyond the scope of this document.)
When PIBufss writes interface data to disk, it writes to multiple files. The names of these
buffering files are PIBUFQ_*.DAT.
When Bufserv writes interface data to disk, it writes to a single file. The name of its buffering
file is APIBUF.DAT.
As a previous paragraph indicates, PIBufss and Bufserv create shared memory storage at
startup. These memory buffers must be large enough to accommodate the data that an
interface collects during a single scan. Otherwise, the interface may fail to write all its
collected data to the memory buffers, resulting in data loss. The buffering configuration
section of this chapter provides guidelines for sizing these memory buffers.
When buffering is enabled, it affects the entire Interface Node. That is, you do not have a
scenario whereby the buffering application buffers data for one interface running on an
Interface Node but not for another interface running on the same Interface Node.

Buffering and PI Server Security

After you enable buffering, it is the buffering application—and not the interface
program—that writes data to the PI Server. If the PI Server’s trust table contains a trust entry
that allows all applications on an Interface Node to write data, then the buffering application
is able write data to the PI Server.
However, if the PI Server contains an interface-specific PI Trust entry that allows a particular
interface program to write data, you must have a PI Trust entry specific to buffering. The
following are the appropriate entries for the Application Name field of a PI Trust entry:
Buffering Application Application Name field for PI Trust
PI Buffer Subsystem PIBufss.exe
PI API Buffer Server APIBE (if the PI API is using 4 character process

100
 names)
APIBUF (if the PI API is using 8 character process
names)

To use a process name greater than 4 characters in length for a trust application name, use the
LONGAPPNAME=1 in the PIClient.ini file.

Enabling Buffering on an Interface Node with the ICU

The ICU allows you to select either PIBufss or Bufserv as the buffering application for your
Interface Node. Run the ICU and select Tools > Buffering.

Choose Buffer Type

To select PIBufss as the buffering application, choose Enable buffering with PI Buffer
Subsystem.
To select Bufserv as the buffering application, choose Enable buffering with API Buffer
Server.
If a warning message such as the following appears, click Yes.

Buffering Settings

OPC HDA Interface 101

Buffering

There are a number of settings that affect the operation of PIBufss and Bufserv. The
Buffering Settings section allows you to set these parameters. If you do not enter values for
these parameters, PIBufss and Bufserv use default values.

PIBufss
For PIBufss, the paragraphs below describe the settings that may require user intervention.
Please contact OSIsoft Technical Support for assistance in further optimizing these and all
remaining settings.

Primary and Secondary Memory Buffer Size (Bytes)

This is a key parameter for buffering performance. The sum of these two memory buffer sizes
must be large enough to accommodate the data that an interface collects during a single scan.
A typical event with a Float32 point type requires about 25 bytes. If an interface writes data
to 5,000 points, it can potentially send 125,000 bytes (25 * 5000) of data in one scan. As a
result, the size of each memory buffer should be 62,500 bytes.
The default value of these memory buffers is 32,768 bytes. OSIsoft recommends that these
two memory buffer sizes should be increased to the maximum of 2000000 for the best
buffering performance.

Send rate (milliseconds)

Send rate is the time in milliseconds that PIBufss waits between sending up to the Maximum
transfer objects (described below) to the PI Server. The default value is 100. The valid range
is 0 to 2,000,000.

Maximum transfer objects

Maximum transfer objects is the maximum number of events that PIBufss sends between
each Send rate pause. The default value is 500. The valid range is 1 to 2,000,000.

102
 Event Queue File Size (Mbytes)
This is the size of the event queue files. PIBufss stores the buffered data to these files. The
default value is 32. The range is 8 to 131072 (8 to 128 Gbytes). Please see the section
entitled, “Queue File Sizing” in the pibufss.chm file for details on how to appropriately size
the event queue files.

Event Queue Path

This is the location of the event queue file. The default value is [PIHOME]\DAT.
For optimal performance and reliability, OSIsoft recommends that you place the PIBufss
event queue files on a different drive/controller from the system drive and the drive with the
Windows paging file. (By default, these two drives are the same.)

Bufserv
For Bufserv, the paragraphs below describe the settings that may require user intervention.
Please contact OSIsoft Technical Support for assistance in further optimizing these and all
remaining settings.

Maximum buffer file size (KB)

This is the maximum size of the buffer file ([PIHOME]\DAT\APIBUF.DAT). When Bufserv
cannot communicate with the PI Server, it writes and appends data to this file. When the
buffer file reaches this maximum size, Bufserv discards data.
The default value is 2,000,000 KB, which is about 2 GB. The range is from 1 to 2,000,000.

Primary and Secondary Memory Buffer Size (Bytes)

This is a key parameter for buffering performance. The sum of these two memory buffer sizes
must be large enough to accommodate the data that an interface collects during a single scan.
A typical event with a Float32 point type requires about 25 bytes. If an interface writes data

OPC HDA Interface 103

Buffering

to 5,000 points, it can potentially send 125,000 bytes (25 * 5000) of data in one scan. As a
result, the size of each memory buffer should be 62,500 bytes.
The default value of these memory buffers is 32,768 bytes. OSIsoft recommends that these
two memory buffer sizes should be increased to the maximum of 2000000 for the best
buffering performance.

Send rate (milliseconds)

Send rate is the time in milliseconds that Bufserv waits between sending up to the Maximum
transfer objects (described below) to the PI Server. The default value is 100. The valid range
is 0 to 2,000,000.

Maximum transfer objects

Max transfer objects is the maximum number of events that Bufserv sends between each
Send rate pause. The default value is 500. The valid range is 1 to 2,000,000.

Buffered Servers

The Buffered Servers section allows you to define the PI Servers or PI Collective that the
buffering application writes data.

PIBufss
PIBufss buffers data only to a single PI Server or a PI Collective. Select the PI Server or the
PI Collective from the Buffering to collective/server drop down list box.
The following screen shows that PIBufss is configured to write data to a standalone PI Server
named starlight. Notice that the Replicate data to all collective member nodes check box
is disabled because this PI Server is not part of a collective. (PIBufss automatically detects
whether a PI Server is part of a collective.)

104
 The following screen shows that PIBufss is configured to write data to a PI Collective named
admiral. By default, PIBufss replicates data to all collective members. That is, it provides n-
way buffering.
You can override this option by not checking the Replicate data to all collective member
nodes check box. Then, uncheck (or check) the PI Server collective members as desired.

OPC HDA Interface 105

Buffering

Bufserv
Bufserv buffers data to a standalone PI Server, or to multiple standalone PI Servers. (If you
want to buffer to multiple PI Servers that are part of a PI Collective, you should use PIBufss.)
If the PI Server to which you want Bufserv to buffer data is not in the Server list, enter its
name in the Add a server box and click the Add Server button. This PI Server name must be
identical to the API Hostname entry:

The following screen shows that Bufserv is configured to write to a standalone PI Server
named etamp390. You use this configuration when all the interfaces on the Interface Node
write data to etamp390.

The following screen shows that Bufserv is configured to write to two standalone PI Servers,
one named etamp390 and the other one named starlight. You use this configuration
when some of the interfaces on the Interface Node write data to etamp390 and some write to
starlight.

106
 Installing Buffering as a Service

Both the PIBufss and Bufserv applications run as a Service.

PI Buffer Subsystem Service

Use the PI Buffer Subsystem Service page to configure PIBufss as a Service. This page also
allows you to start and stop the PIBufss service.
PIBufss does not require the logon rights of the local administrator account. It is sufficient to
use the LocalSystem account instead. Although the screen below shows asterisks for the
LocalSystem password, this account does not have a password.

OPC HDA Interface 107

Buffering

API Buffer Server Service

Use the API Buffer Server Service page to configure Bufserv as a Service. This page also
allows you to start and stop the Bufserv Service
Bufserv version 1.6 and later does not require the logon rights of the local administrator
account. It is sufficient to use the LocalSystem account instead. Although the screen below
shows asterisks for the LocalSystem password, this account does not have a password.

108
OPC HDA Interface 109
Chapter 16. Interface Diagnostics Configuration

The Interface Point Configuration chapter provides information on building PI points for
collecting data from the device. This chapter describes the configuration of points related to
interface diagnostics.

Note: The procedure for configuring interface diagnostics is not specific to this
Interface. Thus, for simplicity, the instructions and screenshots that follow refer to an
interface named ModbusE.

Some of the points that follow refer to a “performance summary interval”. This interval is 8
hours by default. You can change this parameter via the Scan performance summary box in
the UniInt – Debug parameter category pane:

Scan Class Performance Points

A Scan Class Performance Point measures the amount of time (in seconds) that this Interface
takes to complete a scan. The Interface writes this scan completion time to millisecond
resolution. Scan completion times close to 0 indicate that the Interface is performing
optimally. Conversely, long scan completion times indicate an increased risk of missed or
skipped scans. To prevent missed or skipped scans, you should distribute the data collection
points among several scan classes.

OPC HDA Interface 111

Interface Diagnostics Configuration

You configure one Scan Class Performance Point for each Scan Class in this Interface. From
the ICU, select this Interface from the Interface drop-down list and click UniIntPerformance
Points in the parameter category pane:

Right click the row for a particular Scan Class # to bring up the context menu:

You need not restart the Interface for it to write values to the Scan Class Performance Points.
To see the current values (snapshots) of the Scan Class Performance Points, right click and
select Refresh Snapshots.

Create / Create ALL

To create a Performance Point, right-click the line belonging to the tag to be created, and
select Create. Click Create All to create all the Scan Class Performance Points.

Delete
To delete a Performance Point, right-click the line belonging to the tag to be deleted, and
select Delete.

112
 Correct / Correct All
If the “Status” of a point is marked “Incorrect”, the point configuration can be automatically
corrected by ICU by right-clicking on the line belonging to the tag to be corrected, and
selecting Correct. The Performance Points are created with the following PI attribute values.
If ICU detects that a Performance Point is not defined with the following, it will be marked
Incorrect: To correct all points click the Correct All menu item.
The Performance Points are created with the following PI attribute values:
Attribute Details
Tag Tag name that appears in the list box
Point Source Point Source for tags for this interface, as specified on the first tab
Compressing Off
Excmax 0
Descriptor Interface name + “ Scan Class # Performance Point”

Rename
Right-click the line belonging to the tag and select “Rename” to rename the Performance
Point.

Column descriptions

Status
The Status column in the Performance Points table indicates whether the Performance Point
exists for the scan class in column 2.
Created – Indicates that the Performance Point does exist
Not Created – Indicates that the Performance Point does not exist
Deleted – Indicates that a Performance Point existed, but was just deleted by the user

Scan Class #
The Scan Class column indicates which scan class the Performance Point in the Tagname
column belongs to. There will be one scan class in the Scan Class column for each scan class
listed in the Scan Classes combo box on the UniInt Parameters tab.

Tagname
The Tagname column holds the Performance Point tag name.

PS
This is the point source used for these performance points and the interface.

Location1
This is the value used by the interface for the /ID=# point attribute.

Exdesc

OPC HDA Interface 113

Interface Diagnostics Configuration

This is the used to tell the interface that these are performance points and the value is used to
corresponds to the /ID=# command line parameter if multiple copies of the same interface
are running on the Interface node.

Snapshot
The Snapshot column holds the snapshot value of each Performance Point that exists in PI.
The Snapshot column is updated when the Performance Points/Counters tab is clicked, and
when the interface is first loaded. You may have to scroll to the right to see the snapshots.

Performance Counters Points

When running as a Service or interactively, this Interface exposes performance data via
Windows Performance Counters. Such data include items like:
the amount of time that the Interface has been running;
the number of points the Interface has added to its point list;
the number of tags that are currently updating among others
There are two types or instances of Performance Counters that can be collected and stored in
PI Points. The first is (_Total) which is a total for the Performance Counter since the
interface instance was started. The other is for individual Scan Classes (Scan Class x) where
x is a particular scan class defined for the interface instance that is being monitored.
OSIsoft’s PI Performance Monitor Interface is capable of reading these performance values
and writing them to PI points. Please see the Performance Monitor Interface for more
information.
If there is no PI Performance Monitor Interface registered with the ICU in the Module
Database for the PI Server the interface is sending its data to, you cannot use the ICU to
create any Interface instance’s Performance Counters Points:

114
 After installing the PI Performance Monitor Interface as a service, select this Interface
instance from the Interface drop-down list, then click Performance Counters in the parameter
categories pane, and right click on the row containing the Performance Counters Point you
wish to create. This will bring up the context menu:

Click Create to create the Performance Counters Point for that particular row. Click Create
All to create all the Performance Counters Points listed which have a status of Not Created.
To see the current values (snapshots) of the created Performance Counters Points, right-click
on any row and select Refresh Snapshots.

Note: The PI Performance Monitor Interface – and not this Interface – is responsible
for updating the values for the Performance Counters Points in PI. So, make sure
that the PI Performance Monitor Interface is running correctly.

Performance Counters

In the following lists of Performance Counters the naming convention used will be:
“PerformanceCounterName” (.PerformanceCountersPoint Suffix)
The tagname created by the ICU for each Performance Counter point is based on the setting
found under the Tools  Options  Naming Conventions  Performance Counter Points.
The default for this is “sy.perf.[machine].[if service] followed by the Performance Counter
Point suffix.

Performance Counters for both (_Total) and (Scan Class x)

“Point Count” (.point_count)

A .point_count Performance Counters Point is available for each Scan Class of this Interface
as well as a Total for the interface instance.

OPC HDA Interface 115

Interface Diagnostics Configuration

The .point_count Performance Counters Point indicates the number of PI Points per Scan
Class or the total number for the interface instance. This point is similar to the Health Point
[UI_SCPOINTCOUNT] for scan classes and [UI_POINTCOUNT] for totals.
The ICU uses a naming convention such that the tag containing “(Scan Class 1)” (for
example, “sy.perf.etamp390.E1(Scan Class 1).point_count” refers to Scan Class
1, “(Scan Class 2)” refers to Scan Class 2, and so on. The tag containing “(_Total)” refers to
the sum of all Scan Classes.

“Scheduled Scans: % Missed” (.sched_scans_%missed)

A .sched_scans_%missed Performance Counters Point is available for each Scan Class of this
Interface as well as a Total for the interface instance.
The .sched_scans_%missed Performance Counters Point indicates the percentage of scans the
Interface missed per Scan Class or the total number missed for all scan classes since startup.
A missed scan occurs if the Interface performs the scan one second later than scheduled.
The ICU uses a naming convention such that the tag containing “(Scan Class 1)” (for
example, “sy.perf.etamp390.E1(Scan Class 1).sched_scans_%missed” refers
to Scan Class 1, “(Scan Class 2)” refers to Scan Class 2, and so on. The tag containing
“(_Total)” refers to the sum of all Scan Classes.

“Scheduled Scans: % Skipped” (.sched_scans_%skipped)

A .sched_scans_%skipped Performance Counters Point is available for each Scan Class of
this Interface as well as a Total for the interface instance.
The .sched_scans_%skipped Performance Counters Point indicates the percentage of scans
the Interface skipped per Scan Class or the total number skipped for all scan classes since
startup. A skipped scan is a scan that occurs at least one scan period after its scheduled time.
This point is similar to the [UI_SCSKIPPED] Health Point.
The ICU uses a naming convention such that the tag containing “(Scan Class 1)” (for
example, “sy.perf.etamp390.E1(Scan Class 1).sched_scans_%skipped” refers
to Scan Class 1, “(Scan Class 2)” refers to Scan Class 2, and so on. The tag containing
“(_Total)” refers to the sum of all Scan Classes.

“Scheduled Scans: Scan count this interval” (.sched_scans_this_interval)

A .sched_scans_this_interval Performance Counters Point is available for each Scan Class of
this Interface as well as a Total for the interface instance.
The .sched_scans_this_interval Performance Counters Point indicates the number of scans
that the Interface performed per performance summary interval for the scan class or the total
number of scans performed for all scan classes during the summary interval. This point is
similar to the [UI_SCSCANCOUNT] Health Point.
The ICU uses a naming convention such that the tag containing “(Scan Class 1)” (for
example, “sy.perf.etamp390.E1(Scan Class 1).sched_scans_this_interval”
refers to Scan Class 1, “(Scan Class 2)” refers to Scan Class 2, and so on. The tag containing
“(_Total)” refers to the sum of all Scan Classes.

Performance Counters for (_Total) only

116
 “Device Actual Connections” (.Device_Actual_Connections)
The .Device_Actual_Connections Performance Counters Point stores the actual number of
foreign devices currently connected and working properly out of the expected number of
foreign device connections to the interface. This value will always be less than or equal to the
Expected Connections.

“Device Expected Connections” (.Device_Expected_Connections)

The .Device_Expected_Connections Performance Counters Point stores the total number of
foreign device connections for the interface. This is the expected number of foreign device
connections configured that should be working properly at runtime. If the interface can only
communicate with 1 foreign device then the value of this counter will always be one. If the
interface can support multiple foreign device connections then this is the total number of
expected working connections configured for this Interface.

“Device Status” (.Device_Status)

The .Device_Status Performance Counters Point stores communication information about the
interface and the connection to the foreign device(s). The value of this counter is based on the
expected connections, actual connections and value of the /PercentUp command line
option. If the device status is good then the value is ‘0’. If the device status is bad then the
value is ‘1’. If the interface only supports connecting to 1 foreign device then the
/PercentUp command line value does not change the results of the calculation. If for
example the Interface can connect to 10 devices and 5 are currently working then the value of
the /PercentUp command line parameter is applied to determine the Device Status. If the
value of the /PercentUp command line parameter is set to 50 and at least 5 devices are
working then the DeviceStatus will remain good (i.e. have a value of zero).

“Failover Status” (.Failover_Status)

The .Failover_Status Performance Counters Point stores the failover state of the interface
when configured for UniInt interface level failover. The value of the counter will be ‘0’ when
the interface is running as the ‘Primary’ interface in the failover configuration. If the interface
is running in backup mode then the value of the counter will be ‘1’.

“Interface up-time (seconds)” (.up_time)

The .up_time Performance Counters Point indicates the amount of time (in seconds) that this
Interface has been running. At startup the value of the counter is zero. The value will
continue to increment until it reaches the maximum value for an unsigned integer. Once it
reaches this value then it will start back over at zero.

“IO Rate (events/second)” (.io_rates)

The .io_rates Performance Counters Point indicates the rate (in event per second) at which
this Interface writes data to its input tags. (As of UniInt 4.5.0.x and later this performance
counters point will no longer be available.)

“Log file message count” (.log_file_msg_count)

OPC HDA Interface 117

Interface Diagnostics Configuration

The .log_file_msg_count Performance Counters Point indicates the number of messages that
the Interface has written to the log file. This point is similar to the [UI_MSGCOUNT]
Health Point.

“PI Status” (PI_Status)

The .PI_Status Performance Counters Point stores communication information about the
interface and the connection to the PI Server. If the interface is properly communicating with
the PI server then the value of the counter is ‘0’. If the communication to the PI Server goes
down for any reason then the value of the counter will be ‘1’. Once the interface is properly
communicating with the PI server again then the value will change back to ‘0’.

“Points added to the interface” (.pts_added_to_interface)

The .pts_added_to_interface Performance Counter Point indicates the number of points the
Interface has added to its point list. This does not include the number of points configured at
startup. This is the number of points added to the interface after the interface has finished a
successful startup.

“Points edited in the interface”(.pts_edited_in_interface)

The .pts_edited_in_interface Performance Counters Point indicates the number of point edits
the Interface has detected. The Interface detects edits for those points whose PointSource
attribute matches the Point Source parameter and whose Location1 attribute matches the
Interface ID parameter of the Interface.

“Points Good” (.Points_Good)

The .Points_Good Performance Counters Point is the number of points that have sent a good
current value to PI. A good value is defined as any value that is not a system digital state
value. A point can either be Good, In Error or Stale. The total of Points Good, Points In Error
and Points State will equal the Point Count. There is one exception to this rule. At startup of
an interface, the Stale timeout must elapse before the point will be added to the Stale Counter.
Therefore the interface must be up and running for at least 10 minutes for all tags to belong to
a particular Counter.

“Points In Error” (.Points_In_Error)

The .Points_In_Error Performance Counters Point indicates the number of points that have
sent a current value to PI that is a system digital state value. Once a point is in the In Error
count it will remain in the In Error count until the point receives a new, good value. Points in
Error do not transition to the Stale Counter. Only good points become stale.

“Points removed from the interface” (.pts_removed_from_interface)

The .pts_removed_from_interface Performance Counters Point indicates the number of points
that have been removed from the Interface configuration. A point can be removed from the
interface when one of the tag properties for the interface is updated and the point is no longer
a part of the interface configuration. For example, changing the point source, location 1, or
scan property can cause the tag to no longer be a part of the interface configuration.

“Points Stale 10(min)” (.Points_Stale_10min)

118
 The .Points_Stale_10min Performance Counters Point indicates the number of good points
that have not received a new value in the last 10 min. If a point is Good, then it will remain in
the good list until the Stale timeout elapses. At this time if the point has not received a new
value within the Stale Period then the point will move from the Good count to the Stale
count. Only points that are Good can become Stale. If the point is in the In Error count then it
will remain in the In Error count until the error clears. As stated above, the total count of
Points Good, Points In Error and Points Stale will match the Point Count for the Interface.

“Points Stale 30(min)” (.Points_Stale_30min)

The .Points_Stale_30min Performance Counters Point indicates the number of points that
have not received a new value in the last 30 min. For a point to be in the Stale 30 minute
count it must also be a part of the Stale 10 minute count.

“Points Stale 60(min)” (.Points_Stale_60min)

The .Points_Stale_30min Performance Counters Point indicates the number of points that
have not received a new value in the last 60 min. For a point to be in the Stale 60 minute
count it must also be a part of the Stale 10 minute and 30 minute count.

“Points Stale 240(min)” (.Points_Stale_240min)

The .Points_Stale_240min Performance Counters Point indicates the number of points that
have not received a new value in the last 240 min. For a point to be in the Stale 240 minute
count it must also be a part of the Stale 10 minute, 30 minute and 60 minute count.

Performance Counters for (Scan Class x) only

“Device Scan Time (milliseconds)” (.Device_Scan_Time)

A .Device_Scan_Time Performance Counter Point is available for each Scan Class of this
Interface.
The .Device_Scan_Time Performance Counters Point indicates the number of milliseconds
the Interface takes to read the data from the foreign device and package the data to send to PI.
This counter does not include the amount of time to send the data to PI. This point is similar
to the [UI_SCINDEVSCANTIME] Health Point.
The ICU uses a naming convention such that the tag containing “(Scan Class 1)” (for
example, “sy.perf.etamp390.E1 (Scan Class 1).device_scan _time” refers to
Scan Class 1, “(Scan Class 2) refers to Scan Class 2, and so on.

“Scan Time (milliseconds)” (.scan_time)

A .scan_time Performance Counter Point is available for each Scan Class of this Interface.
The .scan_time Performance Counter Point indicates the number of milliseconds the Interface
takes to both read the data from the device and send the data to PI. This point is similar to the
[UI_SCINSCANTIME] Health Point.
The ICU uses a naming convention such that the tag containing “(Scan Class 1)” (for
example, “sy.perf.etamp390.E1(Scan Class 1).scan_time” refers to Scan Class 1,
“(Scan Class 2)” refers to Scan Class 2, and so on.

OPC HDA Interface 119

Interface Diagnostics Configuration

Interface Health Monitoring Points

Interface Health Monitoring Points provide information about the health of this Interface. To
use the ICU to configure these points, select this Interface from the Interface dropdown list
and click Health Points from the parameter category pane:

Right-click the row for a particular Health Point to display the context menu:

Click Create to create the Health Point for that particular row. Click Create All to create all
the Health Points.
To see the current values (snapshots) of the Health Points, right click and select Refresh
Snapshots.

120
 For some of the Health Points described subsequently, the Interface updates their values at
each performance summary interval (typically, 8 hours).

[UI_HEARTBEAT]
The [UI_HEARTBEAT] Health Point indicates whether the Interface is currently running.
The value of this point is an integer that increments continuously from 1 to 15. After reaching
15, the value resets to 1.
The fastest scan class frequency determines the frequency at which the Interface updates this
point:
Fastest Scan Frequency Update frequency
Less than 1 second 1 second
Between 1 and 60 Scan frequency
seconds, inclusive
More than 60 seconds 60 seconds

If the value of the [UI_HEARTBEAT] Health Point is not changing, then this Interface is in
an unresponsive state.

[UI_DEVSTAT]
The Interface is built with a version of UNIINT that is higher than 4.3.0.x and that supports
interface health points. The health point with the point attribute Exdesc = [UI_DEVSTAT],
is used to represent the status of the source devices.
The following events can be written to the point:
“Good”
The interface is properly communicating and reading data from the devices. If no
data collection points have been defined, this indicates the interface has successfully
started.
“3 | 1 devices(s) in error “
The interface has determined that the listed device(s) are offline. A device is
considered offline when the connection to the HDA Server has failed.
Please refer to the UniInt Interface User Manual for more information on how to configure
interface health points.

[UI_SCINFO]
The [UI_SCINFO] Health Point provides scan class information. The value of this point is a
string that indicates
the number of scan classes;
the update frequency of the [UI_HEARTBEAT] Health Point; and
the scan class frequencies
An example value for the [UI_SCINFO] Health Point is:
3 | 5 | 5 | 60 | 120
The Interface updates the value of this point at startup and at each performance summary
interval.

OPC HDA Interface 121

Interface Diagnostics Configuration

[UI_IORATE]
The [UI_IORATE] Health Point indicates the sum of
1. the number of scan-based input values the Interface collects before it performs
exception reporting; and
23. the number of event-based input values the Interface collects before it performs
exception reporting; and
24. the number of values that the Interface writes to output tags that have a SourceTag.
The Interface updates this point at the same frequency as the [UI_HEARTBEAT] point. The
value of this [UI_IORATE] Health Point may be zero. A stale timestamp for this point
indicates that this Interface has stopped collecting data.

[UI_MSGCOUNT]
The [UI_MSGCOUNT] Health Point tracks the number of messages that the Interface has
written to the pipc.log file since start-up. In general, a large number for this point indicates
that the Interface is encountering problems. You should investigate the cause of these
problems by looking in pipc.log.
The Interface updates the value of this point every 60 seconds. While the Interface is running,
the value of this point never decreases.

[UI_POINTCOUNT]
The [UI_POINTCOUNT] Health Point counts number of PI tags loaded by the interface. This
count includes all input, output and triggered input tags. This count does NOT include any
Interface Health tags or performance points.
The interface updates the value of this point at startup, on change and at shutdown.

[UI_OUTPUTRATE]
After performing an output to the device, this Interface writes the output value to the output
tag if the tag has a SourceTag. The [UI_OUTPUTRATE] Health Point tracks the number of
these values. If there are no output tags for this Interface, it writes the System Digital State No
Result to this Health Point.
The Interface updates this point at the same frequency as the [UI_HEARTBEAT] point’s.
The Interface resets the value of this point to zero at each performance summary interval.

[UI_OUTPUTBVRATE]
The [UI_OUTPUTBVRATE] Health Point tracks the number of System Digital State values
that the Interface writes to output tags that have a SourceTag. If there are no output tags for
this Interface, it writes the System Digital State No Result to this Health Point.
The Interface updates this point at the same frequency as the [UI_HEARTBEAT] point’s.
The Interface resets the value of this point to zero at each performance summary interval.

[UI_TRIGGERRATE]

122
 The [UI_TRIGGERRATE] Health Point tracks the number of values that the Interface writes
to event-based input tags. If there are no event-based input tags for this Interface, it writes the
System Digital State No Result to this Health Point.
The Interface updates this point at the same frequency as the [UI_HEARTBEAT] point’s.
The Interface resets the value of this point to zero at each performance summary interval.

[UI_TRIGGERBVRATE]
The [UI_TRIGGERRATE] Health Point tracks the number of System Digital State values
that the Interface writes to event-based input tags. If there are no event-based input tags for
this Interface, it writes the System Digital State No Result to this Health Point.
The Interface updates this point at the same frequency as the [UI_HEARTBEAT] point’s.
The Interface resets the value of this point to zero at each performance summary interval.

[UI_SCIORATE]
You can create a [UI_SCIORATE] Health Point for each Scan Class in this Interface. The
ICU uses a tag naming convention such that the suffix “.sc1” (for example,
sy.st.etamp390.E1.Scan Class IO Rate.sc1) refers to Scan Class 1, “.sc2” refers to
Scan Class 2, and so on.
A particular Scan Class’s [UI_SCIORATE] point indicates the number of values that the
Interface has collected. If the current value of this point is between zero and the
corresponding [UI_SCPOINTCOUNT] point, inclusive, then the Interface executed the scan
successfully. If a [UI_SCIORATE] point stops updating, then this condition indicates that an
error has occurred and the tags for the scan class are no longer receiving new data.
The Interface updates the value of a [UI_SCIORATE] point after the completion of the
associated scan.
Although the ICU allows you to create the point with the suffix “.sc0”, this point is not
applicable to this Interface.

[UI_SCBVRATE]
You can create a [UI_SCBVRATE] Health Point for each Scan Class in this Interface. The
ICU uses a tag naming convention such that the suffix “.sc1” (for example,
sy.st.etamp390.E1.Scan Class Bad Value Rate.sc1) refers to Scan Class 1,
“.sc2” refers to Scan Class 2, and so on.
A particular Scan Class’s [UI_SCBVRATE] point indicates the number System Digital State
values that the Interface has collected.
The Interface updates the value of a [UI_SCBVRATE] point after the completion of the
associated scan.
Although the ICU allows you to create the point with the suffix “.sc0”, this point is not
applicable to this Interface.

[UI_SCSCANCOUNT]
You can create a [UI_SCSCANCOUNT] Health Point for each Scan Class in this Interface.
The ICU uses a tag naming convention such that the suffix “.sc1” (for example,

OPC HDA Interface 123

Interface Diagnostics Configuration

sy.st.etamp390.E1.Scan Class Scan Count.sc1) refers to Scan Class 1, “.sc2”

refers to Scan Class 2, and so on.
A particular Scan Class’s [UI_ SCSCANCOUNT] point tracks the number of scans that the
Interface has performed.
The Interface updates the value of this point at the completion of the associated scan. The
Interface resets the value to zero at each performance summary interval.
Although there is no “Scan Class 0”, the ICU allows you to create the point with the suffix
“.sc0”. This point indicates the total number of scans the Interface has performed for all of its
Scan Classes.

[UI_SCSKIPPED]
You can create a [UI_SCSKIPPED] Health Point for each Scan Class in this Interface. The
ICU uses a tag naming convention such that the suffix “.sc1” (for example,
sy.st.etamp390.E1.Scan Class Scans Skipped.sc1) refers to Scan Class 1, “.sc2”
refers to Scan Class 2, and so on.
A particular Scan Class’s [UI_SCSKIPPED] point tracks the number of scans that the
Interface was not able to perform before the scan time elapsed and before the Interface
performed the next scheduled scan.
The Interface updates the value of this point each time it skips a scan. The value represents
the total number of skipped scans since the previous performance summary interval. The
Interface resets the value of this point to zero at each performance summary interval.
Although there is no “Scan Class 0”, the ICU allows you to create the point with the suffix
“.sc0”. This point monitors the total skipped scans for all of the Interface’s Scan Classes.

[UI_SCPOINTCOUNT]
You can create a [UI_SCPOINTCOUNT] Health Point for each Scan Class in this Interface.
The ICU uses a tag naming convention such that the suffix “.sc1” (for example,
sy.st.etamp390.E1.Scan Class Point Count.sc1) refers to Scan Class 1, “.sc2”
refers to Scan Class 2, and so on.
This Health Point monitors the number of tags in a Scan Class.
The Interface updates a [UI_SCPOINTCOUNT] Health Point when it performs the associated
scan.
Although the ICU allows you to create the point with the suffix “.sc0”, this point is not
applicable to this Interface.

[UI_SCINSCANTIME]
You can create a [UI_SCINSCANTIME] Health Point for each Scan Class in this Interface.
The ICU uses a tag naming convention such that the suffix “.sc1” (for example,
sy.st.etamp390.E1.Scan Class Scan Time.sc1) refers to Scan Class 1, “.sc2”
refers to Scan Class 2, and so on.
A particular Scan Class’s [UI_ SCINSCANTIME] point represents the amount of time (in
milliseconds) the Interface takes to read data from the device, fill in the values for the tags,
and send the values to the PI Server.
The Interface updates the value of this point at the completion of the associated scan.

124
 [UI_SCINDEVSCANTIME]
You can create a [UI_SCINDEVSCANTIME] Health Point for each Scan Class in this
Interface. The ICU uses a tag naming convention such that the suffix “.sc1” (for example,
sy.st.etamp390.E1.Scan Class Device Scan Time.sc1) refers to Scan Class 1,
“.sc2” refers to Scan Class 2, and so on.
A particular Scan Class’s [UI_ SCINDEVSCANTIME] point represents the amount of time
(in milliseconds) the Interface takes to read data from the device and fill in the values for the
tags.
The value of a [UI_ SCINDEVSCANTIME] point is a fraction of the corresponding
[UI_SCINSCANTIME] point value. You can use these numbers to determine the percentage
of time the Interface spends communicating with the device compared with the percentage of
time communicating with the PI Server.
If the [UI_SCSKIPPED] value is increasing, the [UI_SCINDEVSCANTIME] points along
with the [UI_SCINSCANTIME] points can help identify where the delay is occurring:
whether the reason is communication with the device, communication with the PI Server, or
elsewhere.
The Interface updates the value of this point at the completion of the associated scan.

I/O Rate Point

An I/O Rate point measures the rate at which the Interface writes data to its input tags. The
value of an I/O Rate point represents a 10-minute average of the total number of values per
minute that the Interface sends to the PI Server.
When the Interface starts, it writes 0 to the I/O Rate point. After running for ten minutes, the
Interface writes the I/O Rate value. The Interface continues to write a value every 10 minutes.
When the Interface stops, it writes 0.
The ICU allows you to create one I/O Rate point for each copy of this Interface. Select this
Interface from the Interface drop-down list, click IO Rate in the parameter category pane, and
check Enable IORates for this Interface.

OPC HDA Interface 125

Interface Diagnostics Configuration

As the preceding picture shows, the ICU suggests an Event Counter number and a Tagname
for the I/O Rate Point. Click the Save button to save the settings and create the I/O Rate point.
Click the Apply button to apply the changes to this copy of the Interface.
You need to restart the Interface in order for it to write a value to the newly created I/O Rate
point. Restart the Interface by clicking the Restart button:

(The reason you need to restart the Interface is that the PointSource attribute of an I/O Rate
point is Lab.)
To confirm that the Interface recognizes the I/O Rate Point, look in the pipc.log for a
message such as:
PI-ModBus 1> IORATE: tag sy.io.etamp390.ModbusE1 configured.
To see the I/O Rate point’s current value (snapshot), click the Refresh snapshot button:

Enable IORates for this Interface

The Enable IORates for this interface check box enables or disables I/O Rates for the current
interface. To disable I/O Rates for the selected interface, uncheck this box. To enable I/O
Rates for the selected interface, check this box.

Event Counter
The Event Counter correlates a tag specified in the iorates.dat file with this copy of the
interface. The command-line equivalent is /ec=x, where x is the same number that is
assigned to a tag name in the iorates.dat file.

Tagname
The tag name listed under the Tagname column is the name of the I/O Rate tag.

Tag Status
The Tag Status column indicates whether the I/O Rate tag exists in PI. The possible states
are:
Created – This status indicates that the tag exist in PI
Not Created – This status indicates that the tag does not yet exist in PI
Deleted – This status indicates that the tag has just been deleted
Unknown – This status indicates that the PI ICU is not able to access the PI Server

126
 In File
The In File column indicates whether the I/O Rate tag listed in the tag name and the event
counter is in the IORates.dat file. The possible states are:
Yes – This status indicates that the tag name and event counter are in the IORates.dat file
No – This status indicates that the tag name and event counter are not in the IORates.dat
file

Snapshot
The Snapshot column holds the snapshot value of the I/O Rate tag, if the I/O Rate tag exists
in PI. The Snapshot column is updated when the IORates/Status Tags tab is clicked, and
when the Interface is first loaded.

Right Mouse Button Menu Options

Create
Create the suggested I/O Rate tag with the tag name indicated in the Tagname column.

Delete
Delete the I/O Rate tag listed in the Tagname column.

Rename
Allow the user to specify a new name for the I/O Rate tag listed in the Tagname column.

Add to File
Add the tag to the IORates.dat file with the event counter listed in the Event Counter Column.

Search
Allow the user to search the PI Server for a previously defined I/O Rate tag.

Interface Status Point

The PI Interface Status Utility (ISU) alerts you when an interface is not currently writing data
to the PI Server. This situation commonly occurs if
the monitored interface is running on an Interface Node, but the Interface Node cannot
communicate with the PI Server; or
the monitored interface is not running, but it failed to write at shutdown a System state
such as Intf Shut.
The ISU works by periodically looking at the timestamp of a Watchdog Tag. The Watchdog
Tag is a tag whose value a monitored interface (such as this Interface) frequently updates.
The Watchdog Tag has its excdev, excmin, and excmax point attributes set to 0. So, a non-
changing timestamp for the Watchdog Tag indicates that the monitored interface is not
writing data.
Please see the Interface Status Interface for complete information on using the ISU. PI
Interface Status runs only on a PI Server Node.

OPC HDA Interface 127

Interface Diagnostics Configuration

If you have used the ICU to configure the PI Interface Status Utility on the PI Server Node,
the ICU allows you to create the appropriate ISU point. Select this Interface from the
Interface drop-down list and click Interface Status in the parameter category pane. Right
click on the ISU tag definition window to bring up the context menu:

Click Create to create the ISU tag.

Use the Tag Search button to select a Watchdog Tag. (Recall that the Watchdog Tag is one of
the points for which this Interface collects data.)
Select a Scan frequency from the drop-down list box. This Scan frequency is the interval at
which the ISU monitors the Watchdog Tag. For optimal performance, choose a Scan
frequency that is less frequent than the majority of the scan rates for this Interface’s points.
For example, if this Interface scans most of its points every 30 seconds, choose a Scan
frequency of 60 seconds. If this Interface scans most of its points every second, choose a Scan
frequency of 10 seconds.
If the Tag Status indicates that the ISU tag is Incorrect, right click to enable the context
menu and select Correct.

Note: The PI Interface Status Utility – and not this Interface – is responsible for
updating the ISU tag. So, make sure that the PI Interface Status Utility is running
correctly.

128
 Appendix A. Error and Informational Messages

A string NameID is pre-pended to error messages written to the message log. Name is a non-
configurable identifier that is no longer than 9 characters. ID is a configurable identifier that
is no longer than 9 characters and is specified using the /id parameter on the startup
command-line.

Message Logs
The location of the message log depends upon the platform on which the Interface is running.
See the UniInt Interface User Manual for more information.
Messages are written to PIHOME\dat\pipc.log at the following times.
When the Interface starts many informational messages are written to the log. These
include the version of the interface, the version of UniInt, the commandline
parameters used, and the number of points.
As the Interface retrieves points, messages are sent to the log if there are any problems
with the configuration of the points.
If the /dbUniInt is used on the command-line, then various informational messages are
written to the log file.

Messages
This section contains a partial list of the error messages you might find in the message log
along with an explanation of the message. Errors will generally either have a hex number
after these phrases (like 0x80007005) or they will have another message after the phrase, if
the OPC HDA Server provided an explanation for the error. Other error messages are
produced by the standard OSI interface routines, or by the API, and those error messages are
not documented here. If any error message has a point number as well as a tag name, always
use the point number to identify the problem tag, because often the tagname field that is used
is one that only has 12 characters, so the tagname printed in the logfile will not be complete.
These error messages may not exactly match the error messages in the version running
locally. This list shows the general part of the message. You can search this document to find
words that appear in the error message.

Out of memory

Unable to add tag

There are several formats for messages that mean the system has run out of resources. Use
the Task Manager to check the resources being used: press the Control, Shift, and Escape

OPC HDA Interface 129

Error and Informational Messages

keys all together to get to the Task Manager, then select the Processes tab. From the menu,
select View\Select Columns, then check the boxes for Memory Usage and Virtual Memory
Size to see who’s eating up all the memory. If it’s PIOPCHDAInt.exe, there may be a
bottleneck between the interface and the PI system – additional messages should appear in
the PIPC.LOG file (see below for “Running low on memory, dropping data”).

Error from CoInitialize

Error from CoInitializeSecurity

COM may not be properly installed on the system. This is a major problem.

CLSIDFromProgID
The Server’s Registry entries are not valid. Check the server installation instructions.

CoCreateInstanceEx
This is almost always a problem with DCOMCNFG. See the section on Configuring DCOM.

IOPC HDAServer
This error indicates that the proxy stub is not registered. The OPCproxy.dll and
OPCcomn_ps.dll files are included in this distribution. To register them, open a Command
Prompt window, change to the directory where the interface was installed, and type the
following commands. The system should pop up a window after each line that says the DLL
was registered.
>regsvr32 OPCproxy.dll
>regsvr32 OPCcomn_ps.dll

AddRef
This means the OPC HDA Server would not let the interface do the simplest function. If the
PI_HDATool is able to read and write tags, but this error occurs, there is almost certainly a
permissions problem. Recheck the DCOM settings, check what user the interface is running
as, try running the interface interactively (see above on how to do this)

No ConnectionPoint for OPC HDAShutdown

Shutdown Advise Failed

There are not fatal errors, it just means that the OPC HDA Server does not implement the
Shutdown interface, or doesn’t implement it properly; if the server goes down, the interface
will only know about it because it stops answering our calls. This will not prevent proper
operation of our interface.

AddItems failed for tag %s

AddItem failed for %s

Write failed

Write error %X for tag

Read: (some string from server here, hopefully)

130
 RemoveItem failed for tag %s

dev_remove_tag: Unable to Dunadvise %s

AddItems failed, server not in RUNNING state, will try later

This is informational. Some servers take a while to fully start. The interface will wait
around, and when the server enters RUNNING mode, the interface will continue. Use the
PI_HDATool to see the state of the server (use the Get Status button). If the server doesn’t
enter the RUNNING mode, investigate the cause.
QueryInterface:IID_IconnectionPointContainer failed

Write unable to get values:

Getsnapshotx error %d
This means the interface tried to read a value from PI to write to the OPC HDA Server, and
was unable to read the value. Make sure PI is running – try using apisnap (in the API
directory). Check the tag configuration to make sure the interface isn’t configured to write a
string value into a numeric output.

No Item name – InstrumentTag and ExDesc both empty

Unable to get point type

Event Point has invalid scan class (!= 0)

Point has invalid scan class (= = 0)

Point has invalid scan class

GetStatus
This means the OPC HDA Server didn’t respond to a status query. It may be down or
disconnected.

Can’t get PI Server time

This is actually a major error, as the interface is actually asking the API for the timestamp. If
this message occurs, call for help, unless the system was just installed. If the system was just
installed, try rebooting, then ensure the machine can connect to PI. Try pinging the PI
machine (>ping machinename); make sure PI is running; try using APIsnap to connect to PI
(look in the API directory for apisnap.exe).

GetStatus: Server has no current time.

This is a really broken server that refuses to even provide the time of day (literally). The
server is supposed to include current time when it sends its status. This one sent trash. The
interface will assume it’s a very stupid server, and try to guess at what correct timestamps
would be, but the user should not assume that the timestamps are highly accurate.

Cleaning up connections

Cleaned up connections

OPC HDA Interface 131

Error and Informational Messages

The interface will print these messages when it’s been told to exit. The first indicates that the
interface is beginning the process of disconnecting from the OPC HDA Server. The second
indicates that the interface disconnected and will be dying shortly.

Interface failed to write some %s states

When the OPC HDA Server shuts down, the interface will send a shutdown status to each
tag, if the interface was configured to do that (using the /STOPSTAT parameter on the
command line). If the interface tried, but could not send some or all of them (because it
cannot talk to the PI Server, and bufserv is not being used), this message will appear.

Server sent shutdown notice

This is printed when the interface receives a shutdown notification from the OPC HDA
Server. It may be followed by a message from the server indicating why it was going down.
The interface will wait forever, trying to reconnect to the server periodically, until it is told to
shutdown or until it is able to reconnect.

OnDataChange: VariantCopy
This is a serious problem, it indicates that the OPC HDA Server sent what looked like data,
but it’s junk. It may be a transmission error, or a server bug. Whatever it was, the interface
dumped the bad data, since it is unusable, and written BADSTAT to the tag (the timestamp
was good, after all).

OnDataChange: Bad Timestamp

The interface received an invalid timestamp from the OPC HDA Server. The interface
grabbed a timestamp when the data came in, and will use that, but check the server.
PI_HDATool will display the timestamps.

Invalid timestamp for tag: %s, %d and %.36f

The interface received an invalid timestamp from the OPC HDA Server. Try using
PI_HDATool to look at the same ItemID. Using Refresh or Advise or AsyncRead will
display a timestamp. This usually indicates a bug in the OPC HDA Server.

Putsnap system error %d, %d

Putsnap no longer in system error %d, %d

The interface has/had a problem sending data to PI. These are system errors.

Putsnap error state changed, was %d, now %d

Putsnap no longer in error %d,tag: %s

The interface has/had a problem sending data for this tag.

Putsnapsx not implemented %d

Getsnapshotx not implemented

Install a more recent version of the API. This one doesn’t handle extended API calls, and the
interface requires those.

Unable to translate string

132
 The interface must speak Unicode to the OPC HDA Server, because it’s required for COM.
The interface tried to translate some string value from a PI tag from its ASCII to Unicode,
and failed. The particular value in that particular tag would be most interesting to look at,
since if it’s valid ASCII printable data, it should be translatable.

Unable to initialize server object

The interface can’t run. It would be a surprise if anything is running on the machine. Or
maybe the interface is configured to run under an account with no privileges at all.

No OPC HDA Server specified

/SERVER=servername is not found in the OPCHDAInt.bat file. Or the interface ran
interactively rather than as a service, but the OPCHDAInt.bat file was not edited to put
everything on one line first.

Can’t connect to OPC HDA Server, going into slow cycle wait
The tried to connect to the server, but couldn’t. It will keep trying. There should be another
message before this one that gives more information about exactly what call failed. Look at
that message, and fix whatever it says is wrong. Otherwise, the interface will sit here forever.

Informational messages
On startup, the interface will print the scan classes with the count of tags in each class, and
the update rate for the class. After the interface is started, if points are edited in PI, the
interface will log the changes in the log file.

System Errors and PI Errors

System errors are associated with positive error numbers. Errors related to PI are associated
with negative error numbers.

Error Descriptions
Descriptions of system and PI errors can be obtained with the pidiag utility:
Windows: \PI\adm\pidiag – e error_number
UNIX: /PI/adm/pidiag –e error_number

UniInt Failover Specific Error Messages

Informational

Message 16-May-06 10:38:00

OPCHDAInt 1> UniInt failover: Interface in the “Backup”
state.

OPC HDA Interface 133

Error and Informational Messages

Meaning Upon system startup, the initial transition is made to this state. While in this state the
interface monitors the status of the other interface participating in failover. When
configured for Hot failover, data received from the data source is queued and not sent
to the PI Server while in this state. The amount of data queued while in this state is
determined by the failover update interval. In any case, there will be typically no more
than two update intervals of data in the queue at any given time. Some transition chains
may cause the queue to hold up to five failover update intervals worth of data.

Message 16-May-06 10:38:05

OPCHDAInt 1> UniInt failover: Interface in the “Primary”
state and actively sending data to PI. Backup interface
not available.
Meaning While in this state, the interface is in its primary role and sends data to the PI Server as
it is received. This message also states that there is not a backup interface participating
in failover.

Message 16-May-06 16:37:21

OPCHDAInt 1> UniInt failover: Interface in the “Primary”
state and actively sending data to PI. Backup interface
available.
Meaning While in this state, the interface sends data to the PI Server as it is received. This
message also states that the other copy of the interface appears to be ready to take
over the role of primary.

134
 Errors (Phase 1 & 2)

Message 16-May-06 17:29:06

OPCHDAInt 1> One of the required Failover Synchronization
points was not loaded.
Error = 0: The Active ID synchronization point was not
loaded.
The input PI tag was not loaded
Cause The Active ID tag is not configured properly.
Resolution Check validity of point attributes. For example, make sure Location1 attribute is valid
for the interface. All failover tags must have the same PointSource and
Location1 attributes. Modify point attributes as necessary and restart the interface.

Message 16-May-06 17:38:06

OPCHDAInt 1> One of the required Failover Synchronization
points was not loaded.
Error = 0: The Heartbeat point for this copy of the
interface was not loaded.
The input PI tag was not loaded
Cause The Heartbeat tag is not configured properly.
Resolution Check validity of point attributes. For example, make sure Location1 attribute is valid
for the interface. All failover tags must have the same PointSource and Location1
attributes. Modify point attributes as necessary and restart the interface.

Message 17-May-06 09:06:03

OPCHDAInt > The Uniint FailOver ID (/UFO_ID) must be a
positive integer.
Cause The UFO_ID parameter has not been assigned a positive integer value.
Resolution Change and verify the parameter to a positive integer and restart the interface.

Message 17-May-06 09:06:03

OPCHDAInt 1> The Failover ID parameter (/UFO_ID) was found
but the ID for the redundant copy was not found
Cause The /UFO_OtherID parameter is not defined or has not been assigned a positive
integer value.
Resolution Change and verify the /UFO_OtherID parameter to a positive integer and restart
the interface.

OPC HDA Interface 135

Error and Informational Messages

Errors (Phase 2)

Unable to open synchronization file

Message 27-Jun-08 17:27:17
PI Eight Track 1 1> Error 5: Unable to create file
‘\\georgiaking\GeorgiaKingStorage\UnIntFailover\\PIEightT
rack_eight_1.dat’
Verify that interface has read/write/create access on
file server machine.
Intializing uniint library failed
Stopping Interface
Cause This message will be seen when the interface is unable to create a new failover
synchronization file at startup. The creation of the file only takes place the first time
either copy of the interface is started and the file does not exist. The error number
most commonly seen is error number 5. Error number 5 is an “access denied” error
and is likely the result of a permissions problem.
Resolution Ensure the account the interface is running under has read and write permissions for
the folder. The “log on as” property of the Windows service may need to be set to an
account that has permissions for the folder.

Error Opening Synchronization File

Message Sun Jun 29 17:18:51 2008
PI Eight Track 1 2> WARNING> Failover Warning: Error = 64
Unable to open Failover Control File
‘\\georgiaking\GeorgiaKingStorage\Eight\PIEightTrack_eigh
t_1.dat’
The interface will not be able to change state if PI is
not available
Cause This message will be seen when the interface is unable to open the failover
synchronization file. The interface failover will continue to operate correctly as long as
communication to the PI Server is not interrupted. If communication to PI is interrupted
while one or both interfaces cannot access the synchronization file, the interfaces will
remain in the state they were in at the time of the second failure, so the primary
interface will remain primary and the backup interface will remain backup.
Resolution Ensure the account the interface is running under has read and write permissions for
the folder and file. The “log on as” property of the Windows service may need to be set
to an account that has permissions for the folder and file.

136
 Appendix B. PI SDK Options

To access the PI SDK settings for this Interface, select this Interface from the Interface drop-
down list and click UniInt – PI SDK in the parameter category pane.

Disable PI SDK
Select Disable PI SDK to tell the Interface not to use the PI SDK. If you want to run the
Interface in Disconnected Startup mode, you must choose this option.
The command line equivalent for this option is /pisdk=0.

Use the Interface’s default setting

This selection has no effect on whether the Interface uses the PI SDK. However, you must
not choose this option if you want to run the Interface in Disconnected Startup mode.

Enable PI SDK
Select Enable PI SDK to tell the Interface to use the PI SDK. Choose this option if the PI
Server version is earlier than 3.4.370.x or the PI API is earlier than 1.6.0.2, and you want to
use extended lengths for the Tag, Descriptor, ExDesc, InstrumentTag, or
PointSource point attributes. The maximum lengths for these attributes are:

Attribute Enable the Interface to use PI Server earlier than 3.4.370.x or PI

the PI SDK API earlier than 1.6.0.2, without the
use of the PI SDK
Tag 1023 255
Descriptor 1023 26
ExDesc 1023 80
InstrumentTag 1023 32
PointSource 1023 1

However, if you want to run the Interface in Disconnected Startup mode, you must not
choose this option.
The command line equivalent for this option is /pisdk=1.

OPC HDA Interface 137

PINet String Tag Support

138
 Appendix C. OPC HDA Server Issues

The OPC HDA specification offers a great deal of flexibility in how OPC HDA Servers are
designed, and in what features they will support. This section describes how the server
design and features might affect use of this interface.

Browsing
Point browsing is a requirement of the OPC HDA specification. If the OPC HDA Server
does not support browsing, the user must have access to a list of the points which it will
accept, or the format of point names it will allow. If browsing is allowed, use PI_HDATool
to see the points which the OPC HDA Server recognizes.

Disconnecting
If the interface disconnects improperly from an OPC HDA Server (such as if the network
connection goes down, or the Windows system crashes), the server may not clean up the
connection on its side. This might result in the interface unable to reconnect with the server.
Use the PI_HDATool to verify that this is occurring. To resolve, check the documentation
that came with the server to see if they address this issue. If not, try shutting down the OPC
HDA Server. Alternatively, if you understand Windows and the programs running on the
machine quite well, use Task Manager to kill the thread, if in doubt, reboot the machine. You
cannot resolve this problem with the interface: Once the connection is broken, the interface
cannot tell the server to clean up the connection.

Appendix D.

OPC HDA Interface 139

 Appendix E. Debugging

Use the debugging parameter if you want to understand problematic or unexplained behavior,
such as duplicate values or invalid timestamps. Limit use of the debugging parameter to
short periods of time, as the parameter can create large files (files larger than 200 Mb would
not be unusual). The parameter itself is actually a bitmask, which means more than one
option can be set at the same time. For example, a value of /DB=5 is the same as /DB=1 and
/DB=4.

/DB=1
This is for internal testing only and is not useful to users.

/DB=2
Logging of startup, including InstrumentTag and ExDesc for each tag.

/DB=4
This setting causes a number of messages to be written to the pipc.log file when write
operations are performed. This parameter causes the OPC HDA Interface to log every time it
sends a write.

/DB=8
This parameter causes the OPC HDA Interface to log every time a scan starts and a scan
ends. This setting causes a number of messages to be written to the pipc.log file.

/DB=32
This setting logs the timestamp with the data, the adjusted timestamp, the PITime, and the
scanclass for each data value that the interface receives. This is a *lot* of data. It all goes
into the PIPC.log file. Do not leave this setting on for more than a few minutes. See the
section below for more information.

/DB=64
This setting logs the same items as /DB=32, but it logs them for only the tag specified as the
debug tag (/DT=tagname). If there is no tag specified, the first input tag that is found at
startup is declared the debug tag.

/DB=128
This setting logs messages when the interface is trying to connect to the OPC HDA Server.
The start and end of each scan will also be logged with the amount of time it took to finish
the scan and the number of values sent to PI

/DB=256

OPC HDA Interface 141

Debugging

This setting logs when a numeric value is being read for a Digital tag and the number is
above the possible number of digital states. The Over Range system digital state is sent to PI
in this case.

142
 Appendix F. Technical Support and Resources

You can read complete information about technical support options, and access all of the
following resources at the OSIsoft Technical Support Web site:
http://techsupport.osisoft.com (http://techsupport.osisoft.com)

Before You Call or Write for Help

When you contact OSIsoft Technical Support, please provide:

Product name, version, and/or build numbers
Computer platform (CPU type, operating system, and version number)
The time that the difficulty started
The log file(s) at that time

Help Desk and Telephone Support

You can contact OSIsoft Technical Support 24 hours a day. Use the numbers in the table
below to find the most appropriate number for your area. Dialing any of these numbers will
route your call into our global support queue to be answered by engineers stationed around
the world.
Office Location Access Number Local Language Options
San Leandro, CA, USA 1 510 297 5828 English
Philadelphia, PA, USA 1 215 606 0705 English
Johnson City, TN, USA 1 423 610 3800 English
Montreal, QC, Canada 1 514 493 0663 English, French
Sao Paulo, Brazil 55 11 3053 5040 English, Portuguese
Frankfurt, Germany 49 6047 989 333 English, German
Manama, Bahrain 973 1758 4429 English, Arabic
Singapore 65 6391 1811 English, Mandarin
86 021 2327 8686 Mandarin
Perth, WA, Australia 61 8 9282 9220 English

OPC HDA Interface 143

Technical Support and Resources

Support may be provided in languages other than English in certain centers (listed above)
based on availability of attendants. If you select a local language option, we will make best
efforts to connect you with an available Technical Support Engineer (TSE) with that language
skill. If no local language TSE is available to assist you, you will be routed to the first
available attendant.
If all available TSEs are busy assisting other customers when you call, you will be prompted
to remain on the line to wait for the next available TSE or else leave a voicemail message. If
you choose to leave a message, you will not lose your place in the queue. Your voicemail
will be treated as a regular phone call and will be directed to the first TSE who becomes
available.
If you are calling about an ongoing case, be sure to reference your case number when you call
so we can connect you to the engineer currently assigned to your case. If that engineer is not
available, another engineer will attempt to assist you.

Search Support

From the OSIsoft Technical Support Web site, click Search Support.
Quickly and easily search the OSIsoft Technical Support Web site’s Support Solutions,
Documentation, and Support Bulletins using the advanced MS SharePoint search engine.

Email-based Technical Support

[email protected]
When contacting OSIsoft Technical Support by email, it is helpful to send the following
information:
Description of issue: Short description of issue, symptoms, informational or error
messages, history of issue
Log files: See the product documentation for information on obtaining logs pertinent to
the situation.

Online Technical Support

From the OSIsoft Technical Support Web site, click Contact us > My Support > My Calls.
Using OSIsoft’s Online Technical Support, you can:
Enter a new call directly into OSIsoft’s database (monitored 24 hours a day)
View or edit existing OSIsoft calls that you entered
View any of the calls entered by your organization or site, if enabled
See your licensed software and dates of your Service Reliance Program agreements

144
 Remote Access

From the OSIsoft Technical Support Web site, click Contact Us > Remote Support Options.
OSIsoft Support Engineers may remotely access your server in order to provide hands-on
troubleshooting and assistance. See the Remote Access page for details on the various
methods you can use.

On-site Service

From the OSIsoft Technical Support Web site, click Contact Us > On-site Field Service Visit.
OSIsoft provides on-site service for a fee. Visit our On-site Field Service Visit page for more
information.

Knowledge Center

From the OSIsoft Technical Support Web site, click Knowledge Center.
The Knowledge Center provides a searchable library of documentation and technical data, as
well as a special collection of resources for system managers. For these options, click
Knowledge Center on the Technical Support Web site.
The Search feature allows you to search Support Solutions, Bulletins, Support Pages,
Known Issues, Enhancements, and Documentation (including user manuals, release
notes, and white papers).
System Manager Resources include tools and instructions that help you manage: Archive
sizing, backup scripts, daily health checks, daylight savings time configuration, PI
Server security, PI System sizing and configuration, PI trusts for Interface Nodes, and
more.

Upgrades

From the OSIsoft Technical Support Web site, click Contact Us > Obtaining Upgrades.
You are eligible to download or order any available version of a product for which you have
an active Service Reliance Program (SRP), formerly known as Tech Support Agreement
(TSA). To verify or change your SRP status, contact your Sales Representative or Technical
Support (http://techsupport.osisoft.com/) for assistance.

OPC HDA Interface 145

 Appendix G. Revision History

Date Author Comments

14-May-2004 MGrace First Draft
28-Dec-2004 Chrys Version 0.0.0.9 Rev B
03-Jan-2005 Chrys Version 0.0.0.9 Rev C: rewrite
28-Jan-2005 MGrace ICU section updated
25-May-2005 MGrace Change name from pi opchda client to pi opchda
interface. Put in comments from L Daley.
01-Jun-2005 MKelly Fixed TOC, headers and footers, replaced section on
configuring the interface with ICU control to reflect
new name. Fixed filename in DCOM section. Fixed
location of PI_HDATool installation. Fixed reference
to Appendix E which does not exist. Replaced
screen shots from ICU for I/O Rates and
Performance points. Made final.
03-Jun-2005 MGrace Took out references to OPCEnum subdirectory and
register.bat
06-Jun-2005 MKelly Fixed ICU Control section to correct /DB parameter.
Took out the 256 and added in the value 128. New
screen shot also. Fixed sample batch file. Updated
TOC.
25-Jul-2005 MGrace Add /it switch
15-Aug-2005 MKelly Added new screen shot for ICU section. Added new
command line parameter description to ICU section.
8-Sep-2005 MGrace Updated the version number to 1.0.2.0
11-Oct-2005 MGrace Updated the version number to 1.0.3.0
13-Oct-2005 MKelly Added 2003 to available platforms in features table.
17-Oct-2005 MGrace Added new features to document:
Hronly (pli#9042OSI8),
HrPause (pli # 9184OSI8
Server level Failover (pli # 9182OSI8)
/db=256 (pli#9545OSI8)
18-Oct-2005 MGrace Add note on what OPC spec is used. /db=256 note in
the debug section
07-Nov-2005 MGrace Add PI POINT Configuration tool
11-Nov-2005 Mkelly Rev D. Fixed headers, footers and TOC. Minor
formatting changes also. Made changes to the
Configuration Tool command-line parameters table.
12-Jan-2006 Chrys Version 1.0.0.0 to 1.1.0.0Rev E: Interface does NOT
support interface-level failover as previously stated.

OPC HDA Interface 147

Revision History

19-Apr-2006 MGrace Version 1.2.0.0 Rev A

Add new /mp startup parameter . new debug setting,
db=128 meaning.
Change the sample.bat description to the basic one
that says to use the ICU to configure the startup .bat
file.
21-Apr-2006 Janelle Version 1.0.0.0 to 1.2.0.0 Rev B: updated manual to
current standards; removed first person references;
removed PI2 references; updated the How to Contact
Us page; changed general references from “NT” to
“Windows”’; updated ICU screen shots.
08-May-2006 MGrace Version 1.0.0.0 to 1.2.0.0 Rev C: Updated SDK and
ICU sections.
07-Jul-2006 Janelle Version 1.0.0.0 to 1.2.0.0 Rev D: updated Hardware
Diagrams
04-Dec-2006 Prowe Version 1.2.00, Rev E: Updated manual to Skeleton
v2.5.3, applied template and spell checked
document.
23-Jan-2008 MGrace Version 1.3.1.0 Added 4 new startup parameters.
Added statement that pibufss should not be used with
this interface. Only bufserv.
27-Feb-2008 Mkelly Version 1.3.1.0 Rev A; Updated all ICU Control
screenshots, fixed copyright date, updated supported
features table, updated installation checklist,
reformatted tables, updated IORates section.
28-Feb-2008 Janelle Version 1.3.1.0 Revision B: updated point source
references to support multiple character strings; fixed
formatting on tables.
08-Aug-2008 MGrace Version 1.3.2.0 Rev A: Added 3 new startup
parameters (/tf, /ma, /tsu). Loc3 can also be 1 for
inputs as well as 0. For outputs to work, the HDA
Server must have SyncUpdate::InsertReplace
method implemented.
Skeleton version 3.0.3
29-Sep-2008 MGrace Updated all sections to the 3.0.3 skeleton. Some
sections were from an older version of the skeleton.
01-Oct-2008 Janelle Version 1.3.2.0 Revision B: added Terminology
section; updated headers; turn off tracking and
accept all changes; removed NT4 as supported
platform; fixed broken hyperlink
19-Nov-2008 MGrace Fix mistake in the /db and /ps description in the
HDATagBuilder. No parameters in /db and /ps is
required.
The principles of operation says connection is retried
every 5 seconds to piserver and hdaserver. It is 60
second retry rate to the piserver.
25-Feb-2009 MGrace Phase 2 failover. Updated to Skeleton Version 3.0.7
27-Feb-2009 Mkelly Version 1.4.0.0 Revision A, Updates several section
and some screenshots. Fixed headers and footers.
Corrected spelling errors. Updated Table of Contents.
Accepted all changes and made Final.
30-Mar-2009 MGrace Correct the output name of the hdatagbuilder to
hdatagbuilder.csv. Add the /ps to the example of the
hdatagbuiler since it is required.
17-Mar-2010 MGrace “History Recovery Only – History time range” heading
was indented so it looked it was part of the /hrpause

148
 section. Fixed the indention.
04-Oct-2010 DONeill Updated to Skeleton Version 3.0.28
03-Nov-2010 MGrace Version 1.4.1.x Update new startup switches. Took
out most of the DCOM sections and added reference
to the DCOM Configuration Guide.
11-Nov-2010 MKelly Version 1.4.1.x Revision A, Added note about the PI
Message Log and PIHOME/PIHOME64. Also
added PI Message Log in the Terminology section.
Fixed ICU Control section. Fixed styles in tables.

OPC HDA Interface 149