PI AutoPointSync Connector
for the OPC
Interface to the PI System
Version 1.1.0.11
Rev E
How to Contact Us
OSIsoft, Inc.
Worldwide Offices
777 Davis St., Suite 250
San Leandro, CA 94577 USA
OSIsoft Australia
Telephone
(01) 510-297-5800 (main phone)
(01) 510-357-8136 (fax)
(01) 510-297-5828 (support phone)
Perth, Australia
Auckland, New Zealand
OSI Software GmbH
Altenstadt, Germany
OSI Software Asia Pte Ltd.
Singapore
techsupport@osisoft.com
Houston, TX
Johnson City, TN
Mayfield Heights, OH
Phoenix, AZ
Savannah, GA
Seattle, WA
Yardley, PA
OSIsoft Canada ULC
Montreal, Canada
OSIsoft, Inc. Representative Office
Shanghai, People’s Republic of China
OSIsoft Japan KK
Tokyo, Japan
OSIsoft Mexico S. De R.L. De C.V.
Mexico City, Mexico
Sales Outlets and Distributors
Brazil
Middle East/North Africa
Republic of South Africa
Russia/Central Asia
South America/Caribbean
Southeast Asia
South Korea
Taiwan
WWW.OSISOFT.COM
OSIsoft, Inc. is the owner of the following trademarks and registered trademarks: PI System, PI
ProcessBook, Sequencia, Sigmafine, gRecipe, sRecipe, and RLINK. All terms mentioned in this book
that are known to be trademarks or service marks have been appropriately capitalized. Any trademark
that appears in this book that is not owned by OSIsoft, Inc. is the property of its owner and use herein
in no way indicates an endorsement, recommendation, or warranty of such party's products or any
affiliation with such party of any kind.
RESTRICTED RIGHTS LEGEND
Use, duplication, or disclosure by the Government is subject to restrictions as set forth in
subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS
252.227-7013
Unpublished -- rights reserved under the copyright laws of the United States.
© 1997-2006 OSIsoft, Inc.
PI_OPCInt_APS.doc
Table of Contents
Introduction ................................................................................................................... 1
Modules ....................................................................................................................... 1
OPCInt_APS ............................................................................................................... 2
Software Requirements ............................................................................................... 2
Platforms ..................................................................................................................... 2
Reference Manuals ..................................................................................................... 3
Principles of Operation................................................................................................. 5
Features and Assumptions .......................................................................................... 9
Tag Attributes .............................................................................................................. 9
Available Points ......................................................................................................... 10
PointType .............................................................................................................. 10
Scan Class ............................................................................................................ 10
Naming Convention ............................................................................................... 10
Installation Instructions .............................................................................................. 11
Installation Checklist .................................................................................................. 11
Un-installation Procedure .......................................................................................... 16
Configuration Instructions ......................................................................................... 17
Configuration Checklist .............................................................................................. 17
OPC Configuration Control ........................................................................................ 27
Select OPC Data Type .............................................................................................. 27
Tag Name Masks ...................................................................................................... 28
Filtering ..................................................................................................................... 29
OPCInt_APS Connector Updates ............................................................................... 35
Upgrade Checklist ..................................................................................................... 35
Troubleshooting.......................................................................................................... 37
Installation Problems ................................................................................................. 37
Upgrade Problems..................................................................................................... 38
Operational Problems ................................................................................................ 38
Glossary ...................................................................................................................... 43
PI AutoPointSync Connector for the OPC Interface to the PI System
iii
Table of Contents
Available Points ......................................................................................................... 43
Hidden Points ............................................................................................................ 43
Existing Points or Existing PI Points .......................................................................... 43
APS Connector (APS Interface Connector) ............................................................... 43
Appendix A: Resolving Installation Problems .......................................................... 45
Installing .NET Framework 1.1................................................................................... 45
Installing Application Configuration Files ................................................................... 46
Installing Assemblies into the GAC ............................................................................ 46
Registering Assemblies with COM ............................................................................. 47
Appendix B: OPC Server Compatibility ..................................................................... 49
ABB ........................................................................................................................... 49
Beckhoff .................................................................................................................... 49
CimQuest Inc............................................................................................................. 50
Cyberlogic ................................................................................................................. 50
Descartes Systems Sciences, Inc. ............................................................................. 50
Elipse Software Ltda. ................................................................................................. 50
Emerson Process Management................................................................................. 51
Foxboro ..................................................................................................................... 52
Gesytec GmbH .......................................................................................................... 52
Honeywell .................................................................................................................. 53
ICONICS ................................................................................................................... 53
Invensys .................................................................................................................... 54
Kassl GmbH .............................................................................................................. 55
KEPware ................................................................................................................... 55
Krones ....................................................................................................................... 55
KW ............................................................................................................................ 56
Matrikon Inc. .............................................................................................................. 56
Mitsubishi .................................................................................................................. 56
MSI ............................................................................................................................ 56
OMRON .................................................................................................................... 57
Phoenix Contact GmbH & Co. KG ............................................................................. 57
PiiGAB....................................................................................................................... 57
Power Measurement ................................................................................................. 58
Pressco Technology, Inc. .......................................................................................... 58
Progea srl .................................................................................................................. 58
iv
Rockwell Software ..................................................................................................... 58
RoviSys Company ..................................................................................................... 59
Siemens AG .............................................................................................................. 59
SISCO, Inc. ............................................................................................................... 61
Smar.......................................................................................................................... 61
Softing AG ................................................................................................................. 61
Software Toolbox....................................................................................................... 62
Technosoftware AG ................................................................................................... 62
Takebishi Electric ...................................................................................................... 63
Westinghouse............................................................................................................ 64
Wonderware .............................................................................................................. 64
Woodhead ................................................................................................................. 65
Yokogawa.................................................................................................................. 65
Revision History.......................................................................................................... 67
PI AutoPointSync Connector for the OPC Interface to the PI System
v
Introduction
PI AutoPointSync (PI APS) is a Windows-based software product that creates, edits, or
deletes the PI Server points for an interface to match the tags defined in the interface’s
data source. PI APS is based on Windows COM (Component Object Model) technology,
which enables PI APS to dynamically load COM objects called APS Connectors. Each
APS Connector is designed to communicate with a specific data source and configure PI
points for its companion PI interface. This document presents the features of the PI APS
Connector for the OPC (OLE for Process Control) Interface. The APS Connector for the
PI-OPC Interface can synchronize points collected by the Interface to the PI Server. Both
the PI-OPC Interface and its APS Connector use the OPC Data Access interface to
communicate with OPC Servers. The OPC Data Access standards use the term Item to
refer to data values in an OPC Server. That is, an OPC Item is conceptually the same as a
“point” in a traditional control system. Each OPC Item is identified by a unique ItemID,
which corresponds to the “tag” or name for a point in a control system.
PI APS operates in parallel with the interface. Instead of transferring process data,
however, PI APS uses the APS Connector to obtain point attribute information or entire
point definitions. As Items in the OPC Server change or are deleted, PI APS can report
them, automatically modify or automatically delete PI points to match these changes.
PI APS allows configuration on a point-by-point basis which attributes will be
synchronized. PI APS offers several options for handling a PI point whose corresponding
OPC Item has been deleted. Choices include deleting the PI point, changing the PI point’s
Scan attribute to off, and several other options.
In addition, PI APS locates Items in the OPC Server that do not yet have points in the
PI Server and can either report them or automatically create PI points for them.
To allow auditing of automated point changes, PI APS logs all actions and changes for
the PI Server administrator to review. The audit logs, coupled with the versatility of
point-by-point configuration, provide a powerful tool for PI System maintenance.
Modules
Based on Microsoft’s Component Object Model (COM), PI APS is comprised of four
types of modules:
The PI APS Configuration Utility (interactive user interface) provides the means
to configure PI APS for any interfaces that have corresponding PI APS
Connectors.
The PI APS Synchronization Engine (Sync Engine) handles scheduling and point
attribute synchronization for all interfaces that are registered with PI APS. This
module is the workhorse of PI APS and is the only module that is always running
as a Windows service.
The PI APS Connectors are interface-specific modules that communicate with
the data source for a particular interface to determine point attribute updates.
During each synchronization scan, the Sync Engine invokes an interface-specific
PI APS Connector and its attendant routines.
The PI APS Custom OPC Configuration Control is a PI APS Connector-specific
control that provides the user interface for extending the basic configuration
PI AutoPointSync Connector for the OPC Interface to the PI System
1
Introduction
settings. The PI APS Configuration Utility makes it available when the interface
is selected for configuration.
The modularized architecture of PI APS allows a single instance of the PI APS
Configuration Utility and PI APS Sync Engine to support more than one PI APS
Connector module, possibly of different types. Also, new PI APS Connector modules can
be added at any time, allowing for expansion in the capabilities of the application as new
PI APS Connectors are developed. Lastly, the use of COM allows individual components
to be upgraded independently of the other components.
OPCInt_APS
OPCInt_APS is the PI APS Connector that creates and modifies PI points for use with the
PI-OPC Interface. The architecture and technology of this PI APS Connector is described
in the “Principles of Operation” section.
Software Requirements
OPCInt_APS requires these three software packages:
1. The OPCInt_APS is an OPC Data Access client. The OPC Data Access standards
require an OPC Data Access Server to implement a basic set of capabilities. Using
the minimal set of OPC Data Access interfaces, this Connector supports
synchronization of existing OPC Interface points and detection of deleted points. For
this Connector to detect OPC Items for which PI points could be created, the OPC
Data Access Server must implement the optional address space browsing interface.
The OPC Data Access Server must provide the optional address space browsing
interface for PI APS to create new PI points.
2. PI APS is based on PI SDK version 1.1 or newer, which is used to store settings in
the Module Database on a PI Server. PI Server version 3.3.361.43 or greater is
required to support PI APS.
3. Also, the PI Interface Configuration Utility (PI ICU) must be used to register any
interface for which PI APS is to synchronize points. However, the PI ICU need not
run on the same machine as the PI APS modules run.
Platforms
OPCInt_APS runs on a Windows NT 4.0 (SP 6), Windows 200x, or Windows XP
computer. The PI APS Sync Engine and PI APS Configuration Utility run on the same
computer, which may be either a PI Server node or a PI-API node. However, OSIsoft
recommends that the various PI APS modules (Configuration Utility, Sync Engine, and
Connector) run on a PI-API node and not on the PI Server node.
2
Reference Manuals
OSIsoft
OPC Interface to the PI System
PI AutoPointSync for Interfaces and PI COM Connectors User Manual
OPC Foundation
Data Access Automation Interface Standard, Version 2.x or higher
Data Access Custom Interface Standard, Version 2.x or higher
PI AutoPointSync Connector for the OPC Interface to the PI System
3
Principles of Operation
1. The OPC Foundation has issued two complementary Data Access standards: The
PI APS Sync Engine is installed as disabled and must be enabled before registered
interfaces can be enabled. Click on the Tools menu:
If the Enable Sync Engine menu item has a check next to it, then the Sync
Engine is already enabled and does not need to be enabled. If not checked, click on
the Enable Sync Engine menu item to enable the Sync Engine.
PI AutoPointSync Connector for the OPC Interface to the PI System
5
Principles of Operation
2.
and Data Access Automation Interface Standard. Both Data Access interfaces
provide essentially the same functionality. The Custom Interface standard is
primarily intended for use from C++. Since using the Custom Interface from other
languages can be difficult or impossible, the OPC Foundation created the Data
Access Automation Interface Standard to simplify or enable access to OPC servers
from “automation” languages. The Data Access Automation Interface Standard states
that its fundamental design goal is “to work as a ‘wrapper’ for existing OPC Data
Access Custom Interface Servers providing an automation friendly mechanism to
[access] the functionality provided by the custom interface.” As an extension of the
Custom standard, the Automation standard explicitly references the The PI APS Sync
Engine is installed as disabled and must be enabled before registered interfaces can
be enabled. Click on the Tools menu:
If the Enable Sync Engine menu item has a check next to it, then the Sync
Engine is already enabled and does not need to be enabled. If not checked, click on
the Enable Sync Engine menu item to enable the Sync Engine.
for the detailed descriptions of major functions.
The OPCInt_APS is an OPC Data Access Automation client. In contrast, the PI-OPC
Interface is an OPC Data Access Custom Interface client. Since both Data Access
standards apply to an Automation client, this document refers to both standards.
The OPC Data Access Automation Interface can be implemented as a generic “wrapper”
that translates Automation Interface calls into Custom Interface calls to an actual OPC
Server. The wrapper approach has a second benefit when the client is implemented with
.NET technology: the wrapper provides a bridge between the .NET Framework and
COM. The OPCInt_APS is implemented with .NET technology and is bound to the Data
Access Automation wrapper that is distributed by OSIsoft with this Connector and other
OSIsoft products.
OPCInt_APS is implemented as a .NET assembly in a DLL called OPCInt_APS.dll.
The assembly is registered for interoperation with COM during installation, making it
appear to be a COM object.
6
The APS Connector never appears in the Windows Task Manager Process list as an
independent process. The Connector is loaded by a PI APS process called the
Synchronization Engine that appears in the process list as PIAPSEngine.exe. The Sync
Engine calls OPCInt_APS automatically at scheduled synchronization times or when
manually initiated from the PI APS Configuration Utility.
The Sync Engine is a program that is installed as a Windows Service. It implements
scheduling and the generic aspects of synchronization, including all PI SDK calls to
obtain or change PI point information. By itself, the Sync Engine is unable to
communicate with any data source.
PI APS Connectors embody the interface-specific details. Each PI APS Connector is a
wrapper for a specific programming interface – the OPC Data Access Automation
Interface Standard in the case of this Connector. All PI APS Connectors implement a
specific set of functions required by the Sync Engine and are built as COM objects,
which allow them to be dynamically loaded into the Sync Engine. That is, the PI APS
Connectors “plug into” the Sync Engine and the Sync Engine calls functions in the
Connector that actually call the programming interface for the data source. Connectors
cannot execute without the Sync Engine and, except in unusual cases, PI APS Connectors
do not contain any PI API or PI SDK calls.
The PI APS Synchronization Engine uses OPCInt_APS to obtain the information
necessary to synchronize existing OPC Interface points in the PI Server, create new
PI Server points for new OPC Items, and remove PI Server points whose corresponding
OPC Items have been deleted.
For details on how to configure PI APS to create, edit, and delete PI Server points to meet
specific needs, please refer to the PI AutoPointSync for Interfaces and PI COM
Connectors User Manual in addition to this manual.
Note: OSIsoft emphasizes the recommendation that both manuals be read before
beginning to install and configure PI APS.
The following figure shows the main components of PI APS and how they interact with
each other, the PI Server (labeled PI Home Node in the figure), and the data source for
the interface. For this Connector, the data source is an OPC DA Server.
API/SDK Node
APS
Configuration
Utility
APS
Synchronization
Engine
APS
Connector
PI Home Node
PI AutoPointSync Connector for the OPC Interface to the PI System
OPC Server
Node
7
Principles of Operation
The architecture and implementation of PI APS require the PI APS Synchronization
Engine, PI APS Configuration Utility, and the APS Connector(s) to be installed on the
same computer. In general, the APS components shown in the dotted box in the figure,
the PI Server, and the data source can be distributed on three separate computers unless
one of the following restrictions applies:
The APS Connector synchronizes points for a PI COM Connector. In this case,
the PI COM Connector and all PI APS components must be installed on the
PI Server node.
The programming interface for the data source does not permit remote access. In
this case, all PI APS components must be installed on the data source node.
None of these restrictions apply to this Connector. The PI Server, OPC Server, and
PI APS components can be installed on three separate computers. OSIsoft recommends
that PI APS not be installed on the PI Server computer, but this is not prohibited. If the
OPC Server runs on a Windows computer, the PI APS components can be installed on
the same computer as the OPC Server. In this case, OPCInt_APS is local to the OPC
Server, which eliminates the need for DCOM and the complexities of DCOM
configuration.
3. The objective of the OPCInt_APS is to work with any compliant OPC Data Access
Server. Otherwise, specific connectors would have to be developed for each different
OPC Data Access Server. The OPC The PI APS Sync Engine is installed as disabled
and must be enabled before registered interfaces can be enabled. Click on the Tools
menu:
If the Enable Sync Engine menu item has a check next to it, then the Sync
Engine is already enabled and does not need to be enabled. If not checked, click on
the Enable Sync Engine menu item to enable the Sync Engine.
8
4.
defines an “interface [that] can be used by clients to browse the available properties
(also referred to as attributes or parameters) associated with an ITEMID and to read
the current values of these properties.” The OPC The PI APS Sync Engine is installed
as disabled and must be enabled before registered interfaces can be enabled. Click on
the Tools menu:
If the Enable Sync Engine menu item has a check next to it, then the Sync
Engine is already enabled and does not need to be enabled. If not checked, click on
the Enable Sync Engine menu item to enable the Sync Engine.
PI AutoPointSync Connector for the OPC Interface to the PI System
9
Principles of Operation
5.
proceeds to say that the “design of this interface is based upon the assumption is
[sic] that many ITEMIDs are associated with other ITEMIDs which represent related
values such as Engineering units range or Description… As a result, this interface
allows a flexible and convenient way to browse, locate and read this related
information …” That is, OPC item properties correspond to PI point attributes. The
OPC The PI APS Sync Engine is installed as disabled and must be enabled before
registered interfaces can be enabled. Click on the Tools menu:
If the Enable Sync Engine menu item has a check next to it, then the Sync
Engine is already enabled and does not need to be enabled. If not checked, click on
the Enable Sync Engine menu item to enable the Sync Engine.
seems to intend for additional item information to be implemented as properties.
10
6. Because OPC properties are the only generic mechanism available, the PI APS
Connector for the OPC Interface uses the OPC Data Access properties interface to
locate properties that can be used (directly or indirectly) as sources for PI point
attributes. The OPC The PI APS Sync Engine is installed as disabled and must be
enabled before registered interfaces can be enabled. Click on the Tools menu:
If the Enable Sync Engine menu item has a check next to it, then the Sync
Engine is already enabled and does not need to be enabled. If not checked, click on
the Enable Sync Engine menu item to enable the Sync Engine.
only recommends, but does not require, a set of generally applicable properties. If the
OPC Data Access Server provides the recommended set of properties, this APS
Connector can obtain values to synchronize PI point attributes Descriptor,
EngUnits, Zero, and Span. Most OPC Data Access Servers unfortunately have not
implemented a set of generally applicable properties. That is, very few OPC Data Access
Servers actually provide properties that this Connector can use to obtain attribute values
for PI points corresponding to OPC Items. “Appendix B: OPC Server Compatibility”
provides specific information for the OPC Servers that have been surveyed.
Although a particular OPC Data Access Server may not provide properties that are
usable for PI point attributes, the OPC Data Access Server may have Items that appear to
be usable for PI point attributes. Because there is no standardized naming system, the
PI APS Connector for the OPC Interface cannot use these Items without 1) knowing the
specific OPC Data Access Server with which it is communicating, and 2) having
server-specific internal code for the server’s particular naming system and Item
relationship rules.
Note: Current versions of the PI APS Connector for the OPC Interface cannot obtain PI
point attribute values from Items unless they are linked as properties to the Item
configured for the PI point.
PI AutoPointSync Connector for the OPC Interface to the PI System
11
Features and Assumptions
The PI- OPC Interface allows the OPC ItemID to be configured in either the
InstrumentTag attribute (recommended) or in ExDesc.
Note: This APS Connector does not recognize ItemID in the ExDesc attribute.
Tag Attributes
The following table lists the source from the OPC Server for each PI point attribute
supported by OPCInt_APS:
Description
OPC Source
PI Server
Attribute Name
Sync-able
Key
Field
PI Server Tag Name
ItemID
Tag
No
Yes
PI Server
InstrumentTag
ItemID
InstrumentTag
No
Yes
Array Element Number
N/A
UserInt1
No
Yes
Minimum Value in
Engineering Units
Property ID 103
“Low EU”
Zero
Yes
No
Maximum Value in
Engineering Units
Property ID 102
“High EU”
Span,
(High EU–Low EU)
Yes
No
OPC Tag Description
Property ID 101
“Item Description”
Descriptor
Yes
No
OPC Engineering units
Property ID 100
“EU Units”
EngUnits
Yes
No
PI Server PointType
Property ID 1
“Item Canonical
DataType”
PointType
No
Yes
PI Server Point Class
N/A
PtClassName
No
No
PI Server Scan Class
N/A
Location4
No
No
PI Server Location3
N/A
Location3
No
No
PI Server Location2
N/A
Location2
No
No
Digital Set
N/A
DigitalSet
No
No
PI AutoPointSync Connector for the OPC Interface to the PI System
13
Features and Assumptions
7. In the table above, the numeric property IDs in the OPC Source column are built
into OPCInt_APS. The quoted string following each Property ID is the standard
description of the property from the The PI APS Sync Engine is installed as disabled
and must be enabled before registered interfaces can be enabled. Click on the Tools
menu:
If the Enable Sync Engine menu item has a check next to it, then the Sync
Engine is already enabled and does not need to be enabled. If not checked, click on
the Enable Sync Engine menu item to enable the Sync Engine.
..
Many OPC Servers have been surveyed for the properties that they support and other
aspects of their operation that are relevant to OPCInt_APS. The results of these surveys,
which are predictions of expected results, are in “Appendix B: OPC Server
Compatibility”. That is, the results in the Appendix are not verified by actual testing of
this Connector with all of the OPC Servers.
Available Points
Available Points are points that PI AutoPointSync can create for OPC Items that do not
yet have corresponding PI points. The Data Access browse interface is the only way for a
client to enumerate the Items in the OPC Server.
Note: The OPC Server must support the optional browsing interface for Available Points
to be found.
The OPC Data Access Standard recommends that the browse interface should return
actual Items. However, the standard permits an implementation to return a “hint” string
instead of, or in addition to, items. For example, the browse interface in an OPC Server
for a PLC with registers numbered from 0 to 32766 is allowed to return a hint like
“R0-32766” instead of the 32767 actual items “R0”, “R1”, “R2”, etc. The Connector can
detect that such “hints” are not valid items. However, the structure (syntax) of “hint”
strings is not standardized, so the Connector cannot make use of them to generate actual
ItemIDs.
14
Note: If an OPC Server’s browse interface returns only “hint” strings (that is, does not
return individual items), APS Connector will not be able to identify available points.
PointType
In order to create a PI Server point for an OPC Item, a PI PointType must be specified.
This APS Connector uses a map based on the OPC data type of the Item to select the PI
PointType for Available Points. The mapping from OPC data type to PI PointType is
configured using the connector-specific control discussed later in this manual.
Scan Class
All points created by OPCInt_APS will be Advise points in scan class 1. Read the OPC
Interface to the PI System manual for more details on how Advise points are configured.
Naming Convention
The default tag name for the points created in PI is the OPC ItemID. However, the
configuration settings for this Connector provide additional options for constructing the
tag name. More information can be found in “Tag Name Masks.”
PI AutoPointSync Connector for the OPC Interface to the PI System
15
Installation Instructions
As is true for all PI APS Connectors, PI APS must install on the computer where the
PI APS Connector for the OPC Interface is to run.
The OPCInt_APS installation package is a self-extracting executable
OPCInt_APS_x.x.x.x.exe. The installation package installs only the PI APS
Connector for the OPC Interface, not the PI OPC Interface nor PI APS. If the Microsoft
.NET Framework is not already installed on this computer, the installation package also
installs the .NET 1.1 Framework. The following checklist can be used as a guide through
the steps for installing the PI APS Connector for the OPC Interface.
Attention: The default PI APS installation runs the PI APS Synchronization Engine under
the local system account. In two particular situations related to OPC, the local system
account may not be allowed to connect to the OPC Server. In these cases, the account
that runs the PI APS Synchronization Engine must be changed as described in step 4 in
the “Installation Checklist” below.
The local system account may not have adequate privileges to connect to the OPC Server
in the following situations:
The OPC Server is on a remote node. DCOM is used to connect to a remote OPC
Server and the local system account of one computer is typically not permitted
DCOM access to remote computers.
The OPC Server is local, but has its own authentication requirements for local users.
For example, the DeltaV OPC Server has access controls that allow only designated
users to connect and, therefore, may not permit connections from the local system
account.
Installation Checklist
1. Log in as a user with Administrative privileges to the computer where OPCInt_APS
is to be installed.
2. If PI AutoPointSync (PI APS) is not already installed on the computer, install it first.
Detailed instructions for installing PI APS are in the PI AutoPointSync for Interfaces
and PI COM Connectors User Manual.
3. If the OPC Interface is not installed on this computer and the OPC Server is on a
remote node, follow the instructions in the OPC Interface to the PI System manual
for configuring DCOM on this computer as if it were a PI-OPC Interface node.
DCOM settings may also need to be changed on the OPC Server node to permit this
computer to connect. Copy OPCTool from a PI-OPC Interface node to this computer
and use it to verify that this node can connect to the remote OPC Server.
4. If the OPC Server is on a remote node or is a local server that only allows access by
designated users, the PI APS Synchronization Engine service may need to be
reconfigured to run as a user that is permitted to connect to the OPC Server. To
change the account that runs the PI APS Synchronization Engine, click Start ►
Settings ► Control Panel ► Administrative Tools ► Services to
open the Services applet. Scroll through the list of services in the right pane and
locate the PI APS Synchronization Engine service. Right click on the PI APS
PI AutoPointSync Connector for the OPC Interface to the PI System
17
Installation Instructions
Synchronization Engine item and select Properties on the pop-up menu, which
opens the following dialog:
If the Service status: line indicates that the service is “Started” (as shown), click the
Stop button.
18
Click the Log On tab to switch to the following dialog:
When PI APS is installed, the PI APS Synchronization Engine service is configured
to log on as the Local System account. For PI APS to synchronize with a remote OPC
Server, change this service to log on as an account with appropriate DCOM
privileges. Click the This account: radio button. Enter the account (user) name in the
box and the account’s password in the Password: and Confirm password: boxes.
Click the OK button to put these changes into effect. Restarting the PI APS
Synchronization Engine service at this time is optional. The Services applet is no
longer needed and may be closed.
5. Run OPCInt_APS_x.x.x.x.exe to install the PI APS Connector for the OPC
Interface. If the Microsoft .NET Framework is not already installed on this computer,
.NET Framework 1.1 is also installed by this installation kit. The installation kit
installs OPCInt_APS directly into the .NET Global Assembly Cache. Other files, like
a copy of this document and the release notes, are stored in a PIHOME subfolder
named PIHOME\APS\Connectors\OPCInt_APS.
6. OPCInt_APS requires version 1.1 of the .NET Framework. Other versions of the
.NET Framework may be installed side-by-side on the same computer, but this
Connector will not function correctly with versions other than 1.1. To confirm that
.NET Framework 1.1 is installed, click Start ► Settings ► Control Panel.
On the Control Panel, double click on the Add or Remove Programs icon. In
the Add or Remove Programs applet, the list of currently installed programs must
include Microsoft .NET Framework 1.1.
PI AutoPointSync Connector for the OPC Interface to the PI System
19
Installation Instructions
If version 1.1 of the Microsoft .NET Framework is not installed, follow the
instructions in “Installing .NET Framework 1.1” before continuing with the next step.
7. Before closing the Add or Remove Programs applet, check for other versions of
the .NET Framework. If more than one version of the .NET Framework is installed,
the following two files, which configure PI APS to use .NET Framework 1.1, must
exist:
PIPC\APS\PIAPSEngine.exe.config
PIPC\APS\PIAPSConfig.exe.config
If either file does not exist, follow the instructions in “Installing Application
Configuration Files” before continuing with the next step.
20
8. OPCInt_APS depends on several .NET assemblies being in the .NET Global
Assembly Cache (GAC). To verify that the prerequisite assemblies are installed in
the Global Assembly Cache, click Start ► Run, type %systemroot%\assembly
in the Open: box, and click OK. A Windows Explorer view of the Global Assembly
Cache will open:
Examine the list of global assemblies in this dialog for the eight assemblies that are
highlighted in the screen shot above. (The assemblies will not be highlighted in the
Global Assembly Cache window.) Look for the eight assembly names and confirm
that the exact versions shown in the screen shot are present in the Global Assembly
Cache. The .NET Global Assembly Cache is designed to allow multiple versions of
the same assembly to coexist. Other versions of these eight assemblies can be present
with no adverse consequences. That is, the OSIsoft.PIAPSConfig version 1.0.0.0
and version 1.2.0.0 can both be found in the Global Assembly Cache and all would
be well. However, OPCInt_APS will not work if only OSIsoft.PIAPSConfig
version 1.2.0.0 is present in the Global Assembly Cache.
The Global Assembly Cache must also contain assemblies OSIsoft.OPCInt_APS
and OSIsoft.OPCInt_APS_Config. The versions of these two assemblies should
match the version from the installation kit.
PI AutoPointSync Connector for the OPC Interface to the PI System
21
Installation Instructions
If any of the assemblies are not present with the required version, the installation is
incomplete. Follow the instructions in “Installing Assemblies into the GAC” to install
any missing assemblies.
Un-installation Procedure
Before un-installing this APS Connector, use the PI APS Configuration Utility to
unregister any PI-OPC Interface instances from PI APS. Exit from the PI APS
Configuration Utility. Then, use Start ► Settings ► Control Panel ►
Administrative Tools ► Services to stop the PI APS Synchronization Engine
service. Do not restart this service until the remainder of the un-installation procedure is
completed.
Note: Both the PI APS Configuration Utility and the PI APS Synchronization Engine
service must be stopped for un-installation of any APS connector to succeed.
To un-install the PI APS Connector for the OPC Interface, run Start ► Settings ►
Control Panel ► Add or Remove Programs. The following program needs to be
removed:
PI OPC (OPCInt) APS Connector
After the APS Connector has been removed, restart the PI APS Synchronization Engine
service by running the PI APS Configuration Utility or the Windows Services applet.
22
Configuration Instructions
This section explains how to register a PI-OPC Interface instance with PI APS. Repeat
the steps in this section for each instance of the PI-OPC Interface.
PI APS must have access to interface instance configuration settings in order to
synchronize PI points for it. For example, PI APS must know the PointSource and
Location1 attributes assigned to the PI-OPC Interface instance being configured and
connection information for the OPC Server. Rather than duplicate the interface
configuration in PI APS, PI APS obtains interface instance configuration settings from
PI ICU. Therefore, an interface instance must be registered with PI ICU before it can be
registered with PI APS.
Recommendation: The brief discussions of the PI APS Configuration Utility dialogs in
this section are only intended as a guide. Please take the time to read the complete
descriptions of these dialogs in the PI AutoPointSync for Interfaces and PI COM
Connectors User Manual before proceeding.
The screen shots of PI APS Configuration Utility dialogs in this section were taken from
PI APS version 1.2. If an earlier version of PI APS is installed, please upgrade to the
latest PI APS version.
Configuration Checklist
8. If the OI-OPC Interface instance that needs registering with PI APS is not managed
by PI ICU, run PI ICU and configure the instance which has tags to be synchronized.
This step must be performed on the node where the PI-OPC Interface instance runs.
Recommendation: Assign a meaningful name to the interface instead of accepting
the default generic name.
9. If the OPC Server for the interface instance, which is about to be registered, is either
on a remote server or only allows access to designated users (e.g. DeltaV), the
account that runs the PI APS Synchronization Engine service may need to be
changed. If either of these cases applies, please review the “Installation Instructions”
section and step 4 in the “Installation Checklist”.
10. Run the PI AutoPointSync Configuration Utility and either click
bar or select Register New… from the Interface menu.
PI AutoPointSync Connector for the OPC Interface to the PI System
on the tool
23
Configuration Instructions
The Configure Interface or COM Connector for PI APS dialog will be
displayed:
Click the ▼ button in the Select APS Connector: box and select
“OPCInt_APS” from the drop-down list. Click the ▼ button in the Select PI
server host: box and select the PI server where the interface’s points exist or will
be created. Following these two selections, the Select an interface:
drop-down list will be loaded with the PI-OPC Interfaces (on any Interface hosts) that
are configured to use the selected PI Server and not already registered with PI APS.
Select the PI-OPC Interface that requires registration with PI APS and click the Add
button. The Ready message is replaced by other messages that indicate progress of
the registration process. When the message changes to Completed registration
of interface …, appears either select another interface to add or Close this
dialog.
Additional information on this dialog is in the “Configure Interface or COM
Connector Dialog” section of the PI AutoPointSync for Interfaces and PI COM
Connectors User Manual.
24
11. Configure the newly registered interface using the items on the PI APS Configuration
Utility Settings menu:
Review all of the settings on the following dialogs opened by items on the Settings
menu because it is likely that the default settings will need to be changed. The
“PI APS Configuration Utility” section of the PI AutoPointSync for Interfaces and PI
COM Connectors User Manual contains important details about these dialogs and
should be read before attempting to configure the first interface.
Caution: Check the configuration settings before enabling the interface because the
initial per-point synchronization settings for existing points will be assigned during the
first synchronization of the interface, which occurs immediately when an interface
with default scheduling settings is enabled. The per-point synchronization settings
are more difficult to change after they are assigned, so configuring appropriate
defaults before the first synchronization is highly recommended.
PI AutoPointSync Connector for the OPC Interface to the PI System
25
Configuration Instructions
The Rules… menu item opens this dialog:
The settings from this dialog control how the PI APS Sync Engine handles OPC
Items that have no corresponding PI points, differences between existing PI point
attributes and OPC Item properties, and PI points that reference OPC Items that
are not defined in the OPC Server.
If the OPC Server does not support browsing, OPCInt_APS will not be able to
obtain a list of OPC Items to compare with the existing points in PI. In this case,
the Skip search for new points setting should be selected in the
Points Not in PI frame.
26
The Sync Schedule… menu item opens this dialog:
Either set the period between automatically scheduled synchronizations, or select
the option for synchronizing manually.
The User-set Defaults… menu item opens a tabbed dialog. The
Tag Naming and Tag Selection tabs are not enabled because OPCInt_APS
does not support these features.
The Security & Archive Settings tab contains the default values for any
new PI points that are created by PI APS for this interface:
PI AutoPointSync Connector for the OPC Interface to the PI System
27
Configuration Instructions
The Initial Sync Masks tab contains the initial per-point sync settings that
are assigned to existing PI points the first time they are synchronized and the
initial per-point sync settings that are assigned to any PI points created by
PI APS. Note that the settings on this tab are assigned to a PI point only once.
After sync settings have been assigned to a PI point, the settings on this tab will
not change the point’s sync settings on subsequent synchronization scans. Other
PI APS Configuration Utility dialogs and controls can be used to alter the
per-point sync settings after they have been initialized from these settings; for
more information, see the PI AutoPointSync for Interfaces and PI COM
Connectors User Manual.
In both frames, note that the Tag is sync’d by APS radio buttons default to
No and some of the sync-able attributes are not checked. The Tag is sync’d
by APS radio buttons determine the “master” sync setting for each point. When
set to No, synchronization is not performed on the point. For a point to be
synchronized its master synchronization setting must be set to Yes and the
individual sync-able attributes must be enabled.
28
12. The Connector-specific… menu item opens a dialog containing settings specific
to OPCInt_APS.
The section “OPC Configuration Control” describes the settings on this dialog.
Please refer to that section to determine appropriate settings for the interface before
proceeding with the next step in this section.
PI AutoPointSync Connector for the OPC Interface to the PI System
29
Configuration Instructions
13. The PI APS Sync Engine is installed as disabled and must be enabled before
registered interfaces can be enabled. Click on the Tools menu:
If the Enable Sync Engine menu item has a check next to it, then the Sync
Engine is already enabled and does not need to be enabled. If not checked, click on
the Enable Sync Engine menu item to enable the Sync Engine.
14. Enable synchronization for the selected interface with either the
toolbar
button or the Tools ► Enable Connector menu item. All interfaces are initially
disabled after registration so that configuration settings (particularly, default settings)
can be changed before the first synchronization occurs. Interfaces must be enabled
for synchronization to occur. If the toolbar button is grayed out or the menu item has
a check next to it, the interface is already enabled for PI APS and does not need to be
enabled.
Note: If the interface is configured for periodic synchronization, enabling the interface
will implicitly initiate the first synchronization scan for the interface.
If the Sync Engine is idle, it may take several seconds for the first synchronization to
begin. If the Sync Engine is synchronizing another interface, that synchronization
must complete before synchronization will begin for the new interface.
15. The Sync Engine creates a log file for each synchronization scan. Since PI APS is not
an interactive application, various log files are the only source of information on the
health of PI APS.
Note: The log files must be routinely monitored to confirm that PI APS is not
reporting errors.
The individual synchronization scan logs and the PIPC.log file are the main files to
monitor. These files are easily accessible from the Synchronization & Point
Logs dialog in the PI APS Configuration Utility. Select Log Files… on the Tools
menu to open this dialog. This dialog also configures the retention time for the
individual synchronization scan logs.
30
For this Connector, messages from the Connector itself are written to the PI Message
Subsystem. See the PI Server manuals for information on the pigetmsg utility that
displays messages logged to the PI Message Subsystem.
From here it may be useful to continue by reading the “OPCInt_APS Connector Updates”
section.
PI AutoPointSync Connector for the OPC Interface to the PI System
31
OPC Configuration Control
OPCInt_APS has an extra configuration control that configures various aspects of the
Connector’s operation related to creating new PI points:
OPC data type mapping to PI PointType
Construction rules for PI tag names
OPC server filtering options
This configuration control is accessed from the PI APS Configuration Utility. On the
PI APS Configuration Utility main window, select the OPC Interface to configure. Click
the Connector-specific… item on the Settings menu to open this dialog for the selected
interface:
Select OPC Data Type
Items in an OPC Server can have various data types, and each data type that is supported
by OPC can be selected from the Select OPC Data Type: drop down list. Once an
OPC data type has been selected, attribute settings can be specified for PI points that are
created for Items with that OPC data type. For Items of the selected OPC data type that
have array values, the number of PI points corresponding to array elements can also be
specified.
PI AutoPointSync Connector for the OPC Interface to the PI System
33
OPC Configuration Control
The attributes that can be specified are:
PI PointType and, for Digital points, DigitalState
Location2
PI Point Type
The PI Point Type: drop-down list specifies the PI PointType to assign to all PI
points created for Items of the selected OPC data type.
Digital State
If the PI PointType is Digital, the Digital State: list box selects the name of an
existing digital state set to assign to all PI points that are created for Items with the
selected data type. The Digital State: drop-down list is populated from the PI Server
when this dialog is opened. If a suitable digital state set is not available in the list, use
other PI tools to create the desired digital set(s). Then, close and re-open this dialog to
reload the Digital State: drop-down list.
Location2
The Location2: box specifies the value assigned to the Location2 attribute for
created PI points. The PI-OPC Interface uses the Location2 attribute to select various
forms of special handling for the point; consult the OPC Interface to the PI System
manual for information on selecting values for Location2.
Number of Array Elements
The Number of Array Elements: box specifies the total number of PI points that
will be created if the OPC Item has an array value. For example, if in an array-valued
item the Number of Array Elements: box contains 10 for the OPC data type of the
Item, then 10 PI points will be created corresponding to the first 10 elements of the array
value.
Note: The choices inside the frame are independent for each OPC data type. Be sure to
configure these settings for each OPC data type that the specific OPC Server may use
for Items for which PI APS could create PI points.
Tag Name Masks
The tag name masks are templates for constructing the tag name that is used when a new
PI Server point is created for an Item. The tag name can be constructed from the OPC
Item Name, OPC Item Description, OPC ItemID, the OPC Server Name, literal text, or
any combination thereof.
Tag Name Mask
The Tag Name Mask: box contains the basic tag name template that applies to all new
PI points. The string in this box must contain one or more of the following tokens that
represent Item-specific data to be substituted into the tag name:
34
[n]
OPC Item Name
[i]
OPC ItemID
[d]
OPC Item Description
[s]
OPC Server Name
Literal text may be interspersed with these tokens. For example, Tag Name Mask:
might contain [s]:[n]. This string consists of two tokens separated by a literal colon. If
the OPC Server name is “OSI.HDA.1” and the Item name is “sinusoid”, then the
resulting tag name for the Item would be OSI.HDA.1:sinusoid. If the Tag Name
Mask: box is empty, [i] (the ItemID) is the default template.
The ► button following the Tag Mask Name: box pops up a menu of shortcuts for
inserting tokens into the template. Clicking one of the items on the pop-up menu will
insert the corresponding token into the template. If text in the template is selected (that is,
highlighted), the token will replace the selection. Otherwise, the token will be inserted at
the insertion point.
Before substitution of values for tokens, the entire Tag Name Mask: string is converted
to lower case. Therefore, any literal text in this string is converted to lower case. Values
substituted for tokens retain their original case.
Array Extension Mask
The Array Extension Mask: only applies to Items that have array values. For each PI
point created for an array-valued item, the tag name will be constructed by evaluating the
Tag Name Mask: template to create a base tag name and appending the string that
results from evaluating the Array Extension Mask: template for each array element.
Only one token can be used in the Array Extension Mask:
[a]
Array Index
Literal text may also be used for the Array Extension Mask. However, only literal
text preceding the [a] token will actually be used. Any literal text following the token
will be ignored.
The ► button following the Array Extension Mask: box pops up a menu of
shortcuts for inserting tokens into the template.
If padding with zeros is required (for example, 0001 instead of 1), then the minimum
number of digits to pad can be specified by extra “a”s inside the brackets. For example, if
[aaaa] is specified, then 0001 would be used for the first element in the array and 0010
for the tenth. The array index token is always replaced by enough digits to represent the
index. That is, [a] will be replaced by more than one digit if the array index is greater
than 9, [aa] will be replaced by more than two digits if the array index is greater than
99, etc.
If no Array Extension Mask: is specified, .[a] (a period followed by the array
index) is the default template.
Filtering
There are four types of filtering supported by the PI APS Connector for the OPC
Interface. They are:
Tag Access
Data Type
Tag Name
Branch Name
PI AutoPointSync Connector for the OPC Interface to the PI System
35
OPC Configuration Control
For an OPC Item to be accepted as an Available Point by the Connector, the Item must
satisfy all of the filter criteria as described in this section.
The Tag Access: filter refers to filtering by the Read, Write, or Read/Write access
rights of the OPC Item, and the Data Type: filter refers to restricting the selection of
OPC Items by data type. The Connector delegates these two filters to the corresponding
capabilities of the OPC Server’s browsing interface. That is, these two filter settings are
browsing interface parameters that cause the OPC Server to only expose OPC Items that
satisfy the filter criteria.
The Tag Filter: and Branch Filter: options specify filters that allow the selection
of OPC Items to be considered for Available Points to create in PI. Leaving these fields
empty will cause the OPCInt_APS to use all OPC Items that pass the Tag Access: and
Data Type: filters.
The browsing interface returns “short” names that may not be full ItemIDs. The
distinction between the names returned by the browsing interface and actual ItemIDs is
significant because filtering in the OPC Server operates on the short names from the
browsing interface. As will be explained below, filtering of branches is delegated to the
OPC Server and, therefore, operates on short branch names. However, filtering of actual
Items is done by this Connector and operates on the full ItemIDs.
Consider the following OPCTool display of one OPC Server’s address space tree:
Figure 1. Example OPC PLC Browser
OPCTool represents a hierarchical OPC address space as a tree similar to the way
Windows Explorer represents a hierarchy of folders and files. Each line in the tree view is
either a branch or a leaf. The presence of an expand or contract button indicates a
branch. In the tree shown above, Channel_1, Device_1, _System, and _Hints are
branches. The remaining rows indicate leaves. Generally, leaves in the OPC Data Access
address space are Items. However, the browsing interface is permitted to return short
names, as shown in Figure 1. For this particular OPC Server, the actual ItemID for the
Tag_1 leaf is Channel_1.Device_1.Tag_1. The ItemIDs in this server are directly related
to the path from the root to the leaf. However, this is not required by the OPC Data
Access Custom Interface Standard and not all OPC servers follow this pattern.
The OPC address space shown in Figure 1also illustrates that an OPC Server is permitted
to return leaves that are “hints” (that is, not Items). This OPC Server chose to list its hints
under the appropriately named _Hints branch. In general, hints can appear under any
branch in the address space and may be mixed with actual items in a common branch.
The K0.0-K9999.0…K0.15-K9999.15 leaf (and the partially visible leaf below it) is a hint.
This hint indicates that this particular OPC Server supports Items with short names K0.0,
36
K0.1, …, K1.0, K1.1, …, K9999.15 but they are not individually listed by the browsing
interface. As noted in the “Features and Assumptions” section earlier in this manual, the
structure (syntax) of hint strings is not standardized, making it impossible for this
Connector to expand them into a list of actual Item names.
For the purpose of illustrating the variety in OPC Servers, the following OPCTool display
shows the address space tree from a second OPC Server implementation:
Figure 2. Example OPC DCS Browser
Purely from the browsing view of short names, the two OPC Servers appear quite similar.
When the actual ItemIDs for leaves are examined, the differences become apparent. For
example, the actual ItemID for the CV leaf in this OPC Server is
BFO_TEST/AI1/ABNORM_ACTIVE.CV. Unlike the OPC Server in Figure 1, all branches
in the path from root to leaf are not part of the ItemID. Another difference is the
punctuation used between the branch names.
Exploring the OPC Server’s Address Space
The Connector explores the OPC Server’s address space by starting at the topmost branch
(or, root) of the tree. The Connector first asks the OPC Server’s browser interface to
return a list of any sub-branches. The string from the Branch Filter: box is passed to the
browser interface as part of this request. The OPC Server returns only the names of the
branches whose short names satisfy the Branch Filter: string.
The OPC Data Access Custom Interface Standard does not require an OPC Server to
implement filtering or use any specific syntax for the filter string. However, the standard
recommends that OPC Servers provide the * and ? wildcards with their customary
meanings: * matches zero or more characters and ? matches any single character. Since
the interpretation of the Branch Filter: string is defined by each OPC Server
implementation, consult the documentation for the specific OPC Server to determine how
to specify a filter for branches. However, the standard does mandate that an empty
Branch Filter: string causes the browsing interface to return all sub-branches (that is,
no filtering).
Note: The Branch Filter: box only supports a single filter that is uniformly applied at all
levels in the address space tree. Therefore, except in very limited cases, the
Branch Filter: is unusable and should be left empty.
If any sub-branches are returned, they are recursively explored. After each subbranch is
explored, the Connector determines if the subbranch itself is also an OPC Item. If the
subbranch is an Item, the subbranch ItemID must satisfy the Tag Filter: as described
below. Note that the OPC Data Access browsing interface does not apply the
PI AutoPointSync Connector for the OPC Interface to the PI System
37
OPC Configuration Control
Tag Access: or Data Type: filters to branches. Therefore, a branch that is also an Item
becomes a candidate Available Point even though it may not have the specified access
rights or data type.
After all sub-branches have been explored, the Connector asks the OPC Server’s browser
to return a list of all leaves in the branch being explored. The Tag Access: and
Data Type: filters are parameters to this request to the OPC Server. Note that, unlike the
earlier request for sub-branches, the Connector always sends an empty filter string when
requesting leaves in the current branch. That is, the Connector expects the OPC browser
to return all leaves in the current branch that satisfy the Tag Access: and Data Type:
filters. The Connector then implements its own filtering of the leaves.
When the exploration process finds a branch or leaf that is an Item, the Connector obtains
the full ItemID for the Item. The Connector applies the Tag Filter: to the full ItemID
before accepting the Item as an Available Point to create in PI. For the visible leaves in
Figure 1, the tag filter would be applied to “Channel_1.Device_1.Bool_1”,
“Channel_1.Device_1.Tag_1”, “Channel_1.Device_1.Tag_2”, and
“Channel_1.Device_1.Tag_3”. Since the full ItemID is used for tag filtering, branch
names that are part of the full ItemID can be used in Tag Filter: patterns. That is, a
Tag Filter: pattern that matches strings that contain “Device_1” would match all items
under the Device_1 branch.
Recommendation: Use OPCTool to examine and understand the full ItemIDs which the
OPC Server will return to the PI APS Connector for the OPC Interface.
When configuring Tag Filter: patterns, they must be constructed with the understanding
that full ItemIDs from the OPC Server will be matched with the patterns.
Tag Filter Syntax
The syntax of the string in the Tag Filter: box supports more complex pattern matching
than simple wildcards. The Tag Filter: box can be empty, which accepts all candidate
ItemIDs as Available Points. A string in the Tag Filter: box can contain either a single
pattern or a comma-separated list of patterns. The Connector matches each candidate
ItemID with the patterns in this list, from left to right. The first successful match causes
the full ItemID to be accepted as an Available Point. If the ItemID fails to match all of
the patterns, the Item is rejected as an Available Point.
Because a comma is used to separate individual patterns, a comma cannot be used as a
literal character in any of the individual patterns.
The individual Tag Filter: patterns are regular expressions. Regular expressions are
similar to the familiar Windows file name matching patterns composed of literal
characters and the * and ? wildcard operators. However, regular expressions have many
more operators, which make them much more flexible and powerful than simple wildcard
patterns. The following characters are regular expression operators:
. * + ? \ ^ $ { [ ( ) |
The meaning of the commonly used operators will be briefly discussed in this section.
Please be aware of the complete list of operator characters because the operator
characters must be escaped to match the character literally. The escape operator is \
(backslash). Backslash followed by any other operator, including backslash itself, causes
the character following backslash to be taken literally instead of as an operator. For
example, the regular expression abc\+xyz matches any string that contains “abc+xyz”.
Any of these strings would match: “123abc+xyz”, “123abc+xyz456”, “abc+xyzzzzz”,
etc. In contrast, the regular expression abc+xyz would not match any of these strings.
38
The regular expression operators that correspond to the commonly used wildcards are:
.*
matches zero or more characters (like the * wildcard)
.
matches any one character (like the ? wildcard)
\.
matches a literal “.”
.+
matches one or more characters
The * operator matches zero or more of whatever character precedes it (which differs
from the common wildcard interpretation). Similarly, the + operator indicates one or
more of whatever character precedes it. Thus, these operators are always part of a
two-character sequence. For example, the regular expression A.*Z matches any string
that contains an “A”, followed by zero or more characters, followed by “Z”. The regular
expression abc+xyz matches “ab”, followed by one or more “c”s, followed by “xyz”.
Without explicit operators to anchor the regular expression to the beginning and/or end of
the candidate string, a regular expression match succeeds if any substring of the candidate
string matches the regular expression. Recall that the first example regular expression
abc\+xyz matched “123abc+xyz456”. That is, the default interpretation of a regular
expression behaves as if .* were at the beginning and end of the pattern. When used as
the first character in a regular expression, the ^ operator overrides the implicit .* at the
beginning of the pattern. Thus, the pattern is anchored to the beginning of the candidate
string. For example, the regular expression ^ABC matches any string that begins with
“ABC”.
When used as the last character in a regular expression, the $ operator overrides the
implicit .* at the end of the pattern. Thus, the pattern is anchored to the end of the
candidate string. For example, the regular expression XYZ$ matches any string that ends
with “XYZ”.
When a regular expression is matched with a candidate string, the comparison of literal
characters is case sensitive. Lower case characters in the regular expression will not
match the corresponding upper case characters in a candidate string and vice versa. The
case of ItemIDs in an OPC Server is usually known, and regular expressions can be
written with the same case. If a situation is encountered that requires case-insensitive
matching, enclose the regular expression in the following operators:
(?i:regular expression)
For example, the regular expression pattern (?i:abcXYZ) matches any string that
contains “abcxyz”, “ABCXYZ”, “AbCxYz”, or any other permutation of case.
The following table shows the regular expressions that are equivalent to many common
wildcard patterns. The table also provides additional examples.
Equivalent Regular Expressions and Wildcard Patterns
Regular Expression
Wildcard Pattern
Match strings containing
“KLM”
KLM
*KLM*
Match strings beginning with
“ABC”
^ABC
ABC*
Match strings ending with
“XYZ”
XYZ$
*XYZ
PI AutoPointSync Connector for the OPC Interface to the PI System
39
OPC Configuration Control
Equivalent Regular Expressions and Wildcard Patterns
Regular Expression
Wildcard Pattern
Match strings beginning with
“ABC” and ending with
“XYZ”
^ABC.*XYZ$
ABC*XYZ
Match only “A2Z”
^A2Z$
A2Z
Match strings beginning with
“BASE.”, including literal
dot
^BASE\.
BASE.*
Match strings containing
“BASE” followed by zero or
more characters and a literal
dot (not required to be at end
of string)
BASE.*\.
*BASE*.*
Match strings ending with
“.EXT”
\.EXT$
*.EXT
Complete reference information on regular expressions can be found at
http://msdn.microsoft.com by searching for the topic “Regular Expression Language
Elements”.
After completing the steps for configuring the OPC Configuration Control, return to
step 6 in the “Configuration Instructions” section above.
40
OPCInt_APS Connector Updates
For information on the current version of the APS Connector for OPC, please follow the
link to the OPC Interface on the following web page:
http://techsupport.osisoft.com/support_interfaces.aspx?sub=3
The same OPCInt_APS_x.x.x.x.exe installation kit is used for either an initial
installation or upgrading an existing installation of the PI APS Connector for the OPC
Interface.
Upgrade Checklist
1. Log in as a user with Administrative privileges, preferably the same user that
originally installed the PI APS Connector for the OPC Interface.
2. Stop the Sync Engine. The most common ways of stopping the Sync Engine are from
the Services applet or from a command prompt. It may be desirable to keep the
Services applet or command window open to use later to restart the Sync Engine.
The Services applet is opened by clicking Start ► Settings ► Control
Panel ►Administrative Tools ► Services. Scroll to PI APS Synchronization
Engine in the right pane and click on that line to select it. Then, either click the ■
button on the toolbar or Stop on the Actions menu.
To stop the Sync Engine from a command prompt, enter:
net stop piapsengine
3. Run the installation kit.
4. Restart the Sync Engine.
If using the Services applet, either click the ► button on the toolbar or Start on the
Actions menu.
If using a command window, enter:
net start piapsengine
PI AutoPointSync Connector for the OPC Interface to the PI System
41
Troubleshooting
This section discusses several specific errors that may be encounter with the PI APS
Connector for the OPC Interface and general troubleshooting methods for resolving other
problems.
Installation Problems
Symptoms of installation problems are usually noticed when the PI APS Configuration
Utility is being used to register the first OPC Interface instance. Installation problems can
also occur after the PI APS Connector for the OPC Interface is upgraded; the symptoms
of post-upgrade installation problems are messages in various log files (see “Log Files”
below for information on the log files).
The following is a list of symptoms and error messages, their explanations, and steps for
resolving the circumstances that caused them.
OPCInt_APS does not appear as an installed connector in the PI APS
Configuration Utility
The Connector should be visible as OPCInt_APS in the Installed PI APS
Connectors dialog (Tools ► Installed Connectors…) and in the Select APS
Connector: drop-down list on the Configure Interface or COM Connector for PI
APS dialog (Interface ► Register New…). If OPCInt_APS does not appear in these
places, OSIsoft.OPCInt_APS assembly is not registered with COM. See
“Registering Assemblies with COM” on page 47 for instructions on correcting this
problem.
Error when opening the Connector-specific Control
If a dialog similar to the following is displayed when an OPC Interface is selected
and Settings ► Connector-specific… is clicked, the
OSIsoft.OPCInt_APS_Config assembly is not registered with COM.
See “Registering Assemblies with COM” for instructions on correcting this problem.
“Error from CoCreateInstanceEx” messages from the Sync Engine
Messages similar to the following appear in the sync log PIPC log file:
PIAPSEngine.exe>PI-APS> Error from CoCreateInstanceEx.
-2147221164: A specified class is not registered in the
registration database. from call
ptrAPSC.CreateInstance(OPCInt_APS.PIAPSConnector) (for
localhost,Sandbox%opcint1) in LoadAPSRegisteredConnectors will log every 100 errors
PI AutoPointSync Connector for the OPC Interface to the PI System
43
Troubleshooting
PIAPSEngine.exe>PI-APS> Error from CoCreateInstanceEx.
-2146233054: from call
ptrAPSC.CreateInstance(OPCInt_APS.PIAPSConnector) (for
localhost,Sandbox%opcint2) in LoadAPSRegisteredConnectors will log every 100 errors
PIAPSEngine.exe>PI-APS> Error from CoCreateInstanceEx.
-2147024894: from call
ptrAPSC.CreateInstance(OPCInt_APS.PIAPSConnector) (for
localhost,Sandbox%opcint2) in LoadAPSRegisteredConnectors –
will log every 100 errors
Other error numbers are also possible. The significant aspect of these messages is
that the error was returned from a call to
CreateInstance(OPCInt_APS.PIAPSConnector). These messages indicate
that the OSIsoft.OPCInt_APS assembly is not registered. See “Registering
Assemblies with COM” for instructions on correcting this problem.
Upgrade Problems
Following an upgrade, if the logs indicate that the old version of the PI APS Connector
for the OPC Interface is still being used, the Sync Engine needs to be stopped and
restarted. When the Sync Engine starts, it loads copies of the connectors for all registered
interfaces into its virtual memory. Once loaded, the Sync Engine uses the copy in its
virtual memory until the Sync Engine service is stopped. Thus, if a connector is upgraded
while the Sync Engine is running, the new version will not be used. Follow the steps in
the “Upgrade Checklist” to restart the Sync Engine.
Operational Problems
Log Files
When the PI APS Synchronization Engine performs a synchronization scan for an
interface, it creates a log file for that synchronization scan. If errors occur during the
synchronization scan, the Sync Engine writes error details to the PIPC.log file and
usually also writes an error indication into the log file for the synchronization scan. The
log files created by the synchronization scans must be routinely monitored. If indications
of errors are found, additional information may be available in PIPC.log. The PI APS
Configuration Utility provides simple access to these log files. Click Tools ►
Log Files… menu item to open the Synchronization & Point Logs dialog.
In normal operation, the OPCInt_APS rarely logs messages. When it does log a message,
it is written to the PI Message Subsystem. When OPCInt_APS encounters an error that it
cannot handle, it returns an error code and description string to the Sync Engine, which
the Sync Engine usually writes to both the PIPC.log file and the log file for the
synchronization scan.
Enable Debug Logging
OPCInt_APS has additional logging capabilities that can assist in determining the cause
of a problem. By default, the debug logging is disabled because, when enabled, a new
debug log file is created by each synchronization scan. Unlike the Sync Engine’s log
files, which the Sync Engine can be configured to periodically remove, nothing
automatically deletes the debug logs from this Connector.
44
Note: If debug logging for this Connector is enabled, the log files that are produced must
be manually managed (that is, removed).
To enable debug logging in the OPCInt_APS, run the PI APS Configuration Utility.
Select the OPC Interface instance to enable debugging logs. Click Debug… on the
Settings menu to open the following dialog:
In the PI APS Connector Debug Setting frame, enabling either Retrieving updated
attributes (GetUpdatedAttributes) or Retrieving Available points
(GetAvailablePoints) will cause the PI APS Connector for the OPC Interface to write
debugging information, including codes and messages from any errors, to a log file. The
two check boxes independently enable logging during the two phases of synchronization.
The other check boxes in this frame are not used by this Connector, but they are used by
the Sync Engine itself.
The location and name of OPCInt_APS’s debug log files are created in the
PIPC\APS\interfaceHost_shortIFname_PIserver folder. The file names are of
this format: OPCInt_APS_timestamp.log, where timestamp is replaced by the same
timestamp as the Sync Engine used for other log files created during the same
synchronization scan.
Tag Filter Pattern Errors
Using wildcard pattern notation in the Tag Filter: box in the connector-specific
configuration control is a common configuration error. The “Tag Filter syntax” section
discusses the patterns used in the Tag Filter: box, which are regular expressions. The
following message was written to the PIPC.log file when the wildcard pattern
“*.Value*” was mistakenly used as a Tag Filter:
PI AutoPointSync Connector for the OPC Interface to the PI System
45
Troubleshooting
PIAPSEngine.exe>PI-APS> Error -2147024809: parsing "*.Value*"
- Quantifier {x,y} following nothing.
Parameter name: *.Value* from call ptrAPSC>GetAvailablePoints in PerformASynchronization
This specific message is complaining about the leading * operator in “*.Value*” because
the regular expression * operator (which is a quantifier) indicates zero or more of the
preceding character and there is no preceding character. Unfortunately, not all misuses of
wildcards will be detected. For example, the trailing * in “*.Value*” does not result in an
error because “e*” is a valid regular expression meaning zero or more “e”s.
If an error message contains the word “parsing” or any of the pattern strings from the Tag
Filter: box, check for errors in the regular expression. The table in the “Tag Filter
Syntax” section shows the regular expressions that correspond to many common wildcard
patterns.
Other Errors
Error code -2147024894 in sync log
One cause of the following message is missing assemblies in the GAC, particularly
OSIsoft.OSIDAAuto.
OPCInt_APS> Error -2147024894: Unknown Error Code. (ptrAPSC>GetUpdatedAttributes in PerformASynchronization)
Step 7 in the “Installation Instructions” section explains how to check for the required
assemblies in the GAC. If any of the necessary assemblies are missing, “Installing
Assemblies into the GAC” contains instructions for installing them.
Unable to cast object of type ‘OSIDAAuto.OPCServerClass’ error
The following message in the sync log or PIPC.log indicates that the APS
Connector for OPC is operating with an incompatible version of the .NET
Framework.
PIAPSEngine.exe>PI-APS>Error> Error -2147200484: Generic
communication error.
(InitializeOPCServer: OPC.OPCGroups: Unable to cast object of
type 'OSIDAAuto.OPCServerClass' to type
'OSIDAAuto.IOPCGroups'.) (ptrAPSC->GetAvailablePoints
inPerformASynchronization)
“Installing Application Configuration Files” contains instructions for installing
configuration files that force PI APS to use .NET Framework 1.1.
Editing fields in the connector-specific control causes unhandled .NET exception
Connector-specific control is not enabled
Select OPC Data Type box is empty
Fields contain “123”, “abc”, or “Load Incomplete”
These symptoms are other indications that the APS Connector for OPC is operating
with an incompatible version of the .NET Framework. “Installing Application
Configuration Files” contains instructions for installing configuration files that force
PI APS to use .NET Framework 1.1.
Tag Filter is an illegal regular expression error
This message indicates that one of the patterns configured in the Tag Filter is an
illegal regular expression. A common cause of this error is using a wildcard pattern
46
(particularly the * wildcard) instead of a regular expression in the Tag Filter. The
“Tag Filter Syntax” section in this manual describes basic regular expression syntax.
PI AutoPointSync Connector for the OPC Interface to the PI System
47
Glossary
Available Points
Available Points are points that PI AutoPointSync can create for OPC Items that do not
currently have points in the PI Server.
Hidden Points
Hidden Points are points that PI AutoPointSync can create for OPC Items that do not
currently have points in the PI Server (like Available Points) and that have been
designated as being excluded from the set of Available Points.
Existing Points or Existing PI Points
Existing Points or Existing PI Server Points refers to points that already exist in the
PI Server and belong to the current interface.
APS Connector (APS Interface Connector)
The APS Connector or APS Interface Connector is responsible for attribute data
collection from the data source (OPC Data Access Servers for the APS Connector
described in this manual).
PI AutoPointSync Connector for the OPC Interface to the PI System
49
Appendix A:
Resolving Installation Problems
The installation of the PI APS Connector for the OPC Interface should install all the
PI SDK and PI APS .NET assemblies into the Global Assembly Cache (GAC) and
register the Connector with COM. If missing or unregistered assemblies are detected
while performing the “Installation Checklist” or are identified as the likely cause of a
symptom in the “Troubleshooting” section, the step-by-step procedures in this appendix
will resolve the most common problems.
Installing .NET Framework 1.1
The PI APS Connector for the OPC Interface requires .NET Framework 1.1 for correct
operation. Both the Connector and its connector-specific control will attempt to execute
using newer versions of the .NET Framework, but will not operate correctly. The
“Troubleshooting” section describes the common symptoms of operating with an
incompatible version of the .NET Framework (specifically, .NET Framework 2.0).
A copy of the redistributable installation kit for .NET Framework 1.1 is embedded in the
installation kit for this Connector. The installation kit OPCInt_APS_x.x.x.x.exe is a
self-extracting executable. If WinZip is installed, the installation kit can be opened with
WinZip and the file dotnetfx.exe can be extracted, which is the installation kit for the
.NET Framework 1.1. If WinZip is not installed, run OPCInt_APS_x.x.x.x.exe to
extract all of the files that it contains, including dotnetfx.exe. When a dialog similar
to the following appears, change its settings as shown:
Specifically, change the Unzip to folder: box to an empty folder instead of the default
setting. Make a note of the folder path. Uncheck the When done unzipping open: box to
prevent the installation kit from running after the files are extracted. Click Unzip to
extract the files.
Run the dotnetfx.exe that was extracted from OPCInt_APS_x.x.x.x.exe to install
.NET Framework 1.1. If it is necessary to install .NET Framework 1.1 manually,
application configuration files for PI APS probably will be required; see “Installing
Application Configuration Files” in this Appendix.
PI AutoPointSync Connector for the OPC Interface to the PI System
51
Appendix A:
Resolving Installation Problems
Installing Application Configuration Files
To operate correctly, the PI APS Connector for the OPC Interface must be used with
.NET Framework 1.1. If more than one version of .NET Framework is installed on the
APS computer, .NET application configuration files must exist for the PI APS
Configuration Utility and the Sync Engine to ensure that PI APS uses .NET
Framework 1.1 (instead of other versions that may be installed on the same computer).
The paths for the two configuration files are:
PIPC\APS\PIAPSConfig.exe.config
PIPC\APS\PIAPSEngine.exe.config
If either configuration file is not present on the APS computer, the missing file can be
created from the following copies embedded in this document.
To extract these embedded files, first open Windows Explorer and navigate to the
PIPC\APS folder. Right click on one of the file icons above, click Copy on the pop-up
menu, and paste the file into the Windows Explorer open to the PIPC\APS folder. Repeat
this procedure for the second file icon.
Installing Assemblies into the GAC
The PI APS Connector for the OPC Interface requires specific versions of eight
supporting assemblies to be present in the Global Assembly Cache. The specific versions
of these assemblies are shown in step 7 of the “Installation Checklist.” If the required
version of any assembly is missing from the GAC, use the following instructions to
install any missing assemblies.
To install a .NET Assembly into the GAC, drag the assembly from the folder where a
copy is installed and drop it in the %systemroot%\Assembly folder. To open a
Windows Explorer view of the %systemroot%\Assembly folder to use as a drop target,
Start ► Run, type %systemroot%\Assembly in the Open: box, then click OK.
Alternatively open Windows Explorer by any other means and type
%systemroot%\Assembly in the Address box under the tool bar.
The assemblies that need to be dragged and dropped into the GAC for the PI APS
Connector for the OPC Interface are:
52
PIPC\PISDK\OSIsoft.PISDK.dll
PIPC\PISDK\OSIsoft.PISDKCommon.dll
PIPC\Library\OSIsoft.PITimeServer.dll
PIPC\Library\OSIsoft.PISpt.dll
PIPC\Library\OSIsoft.OSIDAAuto.dll
PIPC\APS\OSIsoft.PIAPSConfig.dll
PIPC\APS\OSIsoft.PIAPSCTR.dll
PIPC\APS\OSIsoft.PIAPSEngine.dll
PIPC\APS\Connectors\OPCInt_APS\OSIsoft.OPCInt_APS.dll
PIPC\APS\Connectors\OPCInt_APS\OSIsoft.OPCInt_APS_Config
.dll
The PIPC folder is usually under \Program Files on the boot disc.
Registering Assemblies with COM
In order for the PI APS Connector for the OPC Interface to work with the PI APS
Configuration Utility and Sync Engine, the Connector and its connector-specific
configuration control must be registered with COM. If the Tools ► Installed
Connectors… dialog in the PI APS Configuration Utility does not show OPCInt_APS,
the Connector is not registered with COM. First, confirm that the
OSIsoft.OPCInt_APS assembly is present in the GAC and determine its version
number. The OSIsoft.OPCInt_APS_Config assembly must also be present in the
GAC and have the same version number. Normally, only one version of these two
assemblies is in the GAC. If the GAC contains both assemblies and they have the same
version number, the script in the following embedded file will register the assemblies
with COM.
For Windows 2000, 2003, or XP:
For Windows NT 4.0:
After extracting this script, rename it to
reg_OPCInt_APS.bat.
To extract the embedded script file, first open Windows Explorer and navigate to the
PIPC\APS\Connectors\OPCInt_APS folder. Right click on the file icon above, click
Copy on the pop-up menu, and paste the file into the Windows Explorer open to the
PIPC\APS\Connectors\OPCInt_APS folder.
Open a command window (Start ► Run, type cmd in the Open: box, click OK). Use
the following command to change the working directory:
cd PIPC\APS\Connectors\OPCInt_APS
To register the assemblies for this Connector from the GAC, run the script with the
assembly version number from the GAC as a parameter, for example:
reg_OPCInt_APS 1.1.0.11
Be careful to use the actual version number from the GAC as the parameter to this script.
The script will fail if assemblies with the same version as the script parameter are not in
the GAC.
PI AutoPointSync Connector for the OPC Interface to the PI System
53
Appendix B:
OPC Server Compatibility
This appendix contains a list of OPC servers that have been surveyed for compatibility
with the APS Connector for OPC. The information in this appendix was gathered by
running a tool designed to explore the capabilities of an OPC server to assess its ability to
support the APS Connector for OPC. Based on the results from this tool, this Appendix is
a prediction of how the APS Connector for OPC will behave with the OPC servers that
have been surveyed. In most cases, actual results of using the APS Connector for OPC
with these servers have not been reported. Therefore, the information in this Appendix
cannot be assumed to be completely accurate.
The entries in this appendix are alphabetic by OPC server vendor.
ABB
OPC DA Server for AC 800M
ProgID
ABB.AC800MC_OpcDaServer.3
Version
4.0.0
Vendor Information
ABB Automation Technology Products AB. OPC DA Server for AC
800M.
Sync-able Attributes
none
Notes
GetItemProperties call is slow (average 1 second per call)
Beckhoff
Beckhoff TwinCAT OPC Server4
ProgID
Beckhoff.TwinCATOpcServerDA
Version
4.1.60
Vendor Information
Beckhoff TwinCAT OPC Server4
Sync-able Attributes
Descriptor
EngUnits
Notes
ItemIDs can contain illegal characters for PI tag name.
PI AutoPointSync Connector for the OPC Interface to the PI System
55
Appendix B:
OPC Server Compatibility
CimQuest Inc.
OPC Server for Allen-Bradley Networks
ProgID
CimQuestInc.IGOPCAB
Version
3.0.5
Vendor Information
OPC Server For Allen-Bradley Networks
Sync-able Attributes
Descriptor
Notes
Cyberlogic
ProgID
Cyberlogic.OPCServerDA.6
Version
6.0.10
Vendor Information
Cyberlogic OPC Server
Sync-able Attributes
Descriptor
EngUnits
Notes
Descartes Systems Sciences, Inc.
ProgID
DSSI.OmniServer.2
Version
0.26.0
Vendor Information
Descartes Systems Sciences, Inc.
Sync-able Attributes
none
Notes
Elipse Software Ltda.
Elipse Drivers OPC
56
ProgID
Elipse.OPCDrivers.1
Version
1.1.19
Vendor Information
Elipse Drivers OPC, 1.1.0 Build 19 Copyright © 2004-2005 Elipse
Software Ltda.
Sync-able Attributes
unknown
Notes
Cannot find available points because browsing is not supported.
E3 OPC Server
ProgID
Elipse.OPCSvr.1
Version
1.0.50
Vendor Information
E3 OPC Server, 1.00.022 Build 50 (c) Elipse Software Ltda.
Sync-able Attributes
Descriptor
EngUnits
Zero
Span
Notes
Elipse SCADA
ProgID
ElipseScada.OPCSvr.1
Version
2.27.11
Vendor Information
Elipse SCADA 2.27 (c) Elipse Software Ltda.
Sync-able Attributes
none
Notes
Emerson Process Management
DeltaV
ProgID
opc.deltav.1
Version
7.4.4237
Vendor Information
Fisher-Rosemount Systems Inc. DeltaV OPC Data Server
Sync-able Attributes
none
Notes
ItemIDs can appear more than once in the browse tree resulting in
duplicate available points.
PROVOX
ProgID
OPC.Provox
Version
2.0.642
Vendor Information
Emerson Process Management PROVOX OPC Data Server Version 2.2
Sync-able Attributes
Descriptor
EngUnits
Zero
Span
Notes
OPC datatype of Items does not match native PROVOX datatype for all
items, which can result in unexpected PI pointtype for available points.
Information for EngUnits, Zero, and Span is not present for all Items.
PI AutoPointSync Connector for the OPC Interface to the PI System
57
Appendix B:
OPC Server Compatibility
Westinghouse Ovation
ProgID
WDPF.OPC.4
Version
2.0.1
Vendor Information
WDPF OPC Server from Emerson Process Management
Sync-able Attributes
Descriptor
EngUnits
Zero
Span
Notes
Foxboro
AIM
ProgID
AIM.OPC.1
Version
1.349.34321
Vendor Information
The Foxboro Company
Sync-able Attributes
Descriptor (opchst items only)
EngUnits (opchst items only)
Zero (non-opchst items only)
Span (non-opchst items only)
Notes
ItemIDs contain “\” which is illegal in PI tag names.
ItemIDs can appear more than once in the browse tree resulting in
duplicate available points.
ItemIDs ending with “opchst” appear to be historized items and have
information for Descriptor and EngUnits but not for Zero and Span.
Items not ending with “opchst” appear to be current-value only and have
information for Zero and Span but not Descriptor or EngUnits.
Gesytec GmbH
58
ProgID
Gesytec.ElonOPC2
Version
2.30.22
Vendor Information
OPC Server by Gesytec GmbH
Sync-able Attributes
Descriptor
Notes
ItemIDs can contain square brackets that are illegal in PI tag names.
Honeywell
Total Plant Network
ProgID
hci.tpnserver
Version
212.1.30700
Vendor Information
Honeywell IAC.
Sync-able Attributes
Descriptor
EngUnits
Zero
Span
Notes
OPC Server has throughput limitations.
Some OPC calls are very slow, resulting in synchronization requiring up
to 30 seconds per point.
Extreme care must be taken when using APS for OPC with this server.
Uniformance PHD OPC DA 3.00/HDA 1.2 Server
ProgID
OPC.PHDServerDA.1
Version
210.0.0
Vendor Information
Uniformance PHD OPC DA 3.00/HDA 1.2 Server
Sync-able Attributes
Descriptor
EngUnits
Zero
Span
Notes
ICONICS
DataStore OPC-DA Server and DataStore OPC-AE Server
ProgID
ICONICS.DataStoreOPCDA.3
Version
3.12.0
Vendor Information
ICONICS DataStore OPC-DA Server and DataStore OPC-AE Server
Sync-able Attributes
Descriptor
EngUnits
Notes
PI AutoPointSync Connector for the OPC Interface to the PI System
59
Appendix B:
OPC Server Compatibility
ModbusEthernetDA and ModbusEthernetAE
ProgID
ICONICS.ModbusEthernetDA.2
Version
3.12.0
Vendor Information
ICONICS ModbusEthernetDA and ModbusEthernetAE
Sync-able Attributes
Descriptor
EngUnits
Zero
Span
Notes
Information for Zero and Span is not present for all Items.
ToolWorX OPC Server
ProgID
ICONICS.OPCToolWorXDA.3
Version
3.12.0
Vendor Information
ICONICS OPC ToolWorX OPC Server
Sync-able Attributes
Descriptor
EngUnits
Notes
Invensys
DasABCIP
ProgID
archestrA.DASABCIP.3
Version
3.0.399
Vendor Information
Invensys (DasABCIP0399_MaintBuild_0015)
Sync-able Attributes
none
Notes
DASMBSerial
ProgID
ArchestrA.DASMBSerial.2
Version
198.126.0
Vendor Information
Wonderware
Sync-able Attributes
none
Notes
60
SIDirect
ProgID
archestrA.DASSIDIRECT.1
Version
1.0.132
Vendor Information
Invensys (SIDirect_MasterBuild_v0132)
Sync-able Attributes
none
Notes
Kassl GmbH
ProgID
OPCSample.OpcDa20Server.1.Clone
Version
1.3.59
Vendor Information
(C) 2004 Kassl GmbH (http://www.kassl.de)
Sync-able Attributes
Zero
Span
Notes
Information for Zero and Span is not present for all Items.
Some ItemIDs contain illegal PI tagname characters “[” and “]”.
ProgID
KEPware.KEPServerEx.V4
Version
4.170.325
Vendor Information
KEPware
Sync-able Attributes
Descriptor
EngUnits
Zero
Span
Notes
Scaling must be configured for an item to have properties for EngUnits,
Zero, and Span.
ProgID
Krones.LDSOpcDaServer.1
Version
1.0.3
Vendor Information
KRONES LDS OPC Data Access Server
Sync-able Attributes
Zero
Span
Notes
Information for Zero and Span is not present for all Items.
KEPware
Krones
PI AutoPointSync Connector for the OPC Interface to the PI System
61
Appendix B:
OPC Server Compatibility
KW
ProgID
opc.out.pcos.21
Version
1.11.0
Vendor Information
KW
Sync-able Attributes
none
Notes
Matrikon Inc.
ProgID
Matrikon.OPC.Universal
Version
1.1.307
Vendor Information
Matrikon Inc (780) 448-1010 http://www.matrikonopc.com
Sync-able Attributes
Descriptor
Zero
Span
Notes
Information for Descriptor, Zero, and Span is not present for all Items.
Mitsubishi
For Mitsubishi MELSEC, see Takebishi Electric.
MSI
OPC Data Access Server
ProgID
msi.msiopcserverw
Version
1.0.0
Vendor Information
MSI-OPC Data Access Server
Sync-able Attributes
Descriptor
Zero
Span
Notes
62
OPC Data Access Server (PMA)
ProgID
msi.opcserverPMA
Version
1.0.0
Vendor Information
MSI-OPC Data Access Server (PMA)
Sync-able Attributes
Descriptor
Zero
Span
Notes
OMRON
For OMRON SYSMAC, see Takebishi Electric.
Phoenix Contact GmbH & Co. KG
ProgID
PhoenixContact.Interbus.
Version
2.13.2
Vendor Information
Phoenix Contact GmbH & Co. KG
Sync-able Attributes
none
Notes
PiiGAB
ProgID
PiiGAB.Mbus.2
Version
1.0.1
Vendor Information
PiiGAB
Sync-able Attributes
Zero
Span
Notes
Information for Zero and Span is not present for all Items.
PI AutoPointSync Connector for the OPC Interface to the PI System
63
Appendix B:
OPC Server Compatibility
Power Measurement
ION
ProgID
ION.OpcDaServer
Version
5.5.200
Vendor Information
Power Measurement
Sync-able Attributes
Descriptor
EngUnits
Notes
Pressco Technology, Inc.
ProgID
Pressco.Intellispec.OPC.1.DA
Version
1.0.1
Vendor Information
Pressco Technology, Inc.
Sync-able Attributes
Zero
Span
Notes
Information for Zero and Span is not present for all Items.
Progea srl
ProgID
MovServer
Version
0.0.0
Vendor Information
Progea srl Modena Italy, http://www.progea.com
Sync-able Attributes
none
Notes
Rockwell Software
RnaDa Client Services
64
ProgID
RSOPC Gateway
Version
0.1.0
Vendor Information
Rockwell Software RnaDa Client Services
Sync-able Attributes
none
Notes
ItemIDs contain illegal PI tag name characters “[“ and “]”.
RSLinx OPC Server
ProgID
RSLinx OPC Server
Version
2.42.18
Vendor Information
Rockwell Software RSLinx OPC Server
Sync-able Attributes
none
Notes
ItemIDs contain illegal PI tag name characters “[“ and “]”.
RoviSys Company
ProgID
rovisys.opc90server
Version
4.3.1
Vendor Information
OPC90 Server by The RoviSys Company
Sync-able Attributes
none
Notes
Siemens AG
IndustrialDataBridge
ProgID
OPC.IndustrialDataBridge.1
Version
2.1.221
Vendor Information
Siemens AG
Sync-able Attributes
none
Notes
RMOS3_DA
ProgID
OPC.RMOS3_DA.1
Version
3.4.531
Vendor Information
Siemens AG
Sync-able Attributes
none
Notes
PI AutoPointSync Connector for the OPC Interface to the PI System
65
Appendix B:
OPC Server Compatibility
SIMATIC XML DA Wrapper OPC-Server
ProgID
OPC.Siemens.XML
Version
3.5.10805
Vendor Information
Siemens SIMATIC XML DA Wrapper OPC-Server
Sync-able Attributes
Zero
Span
Notes
ItemIDs may contain illegal PI tag name character “;”.
SIMATIC WinCC flexible RT OPC-Server
ProgID
OPC.SimaticHMI.HmiRTm
Version
2.4.95
Vendor Information
SIMATIC WinCC flexible RT OPC-Server V1.0 (C) Siemens AG
(2003)
Sync-able Attributes
none
Notes
SIMATIC WinCC OPC-Server XML V1.0 - DataAccess V1.0A/2.0/3.0
ProgID
OPCServer.WinCC
Version
3.5.10201
Vendor Information
SIMATIC WinCC OPC-Server XML V1.0 - DataAccess V1.0A/2.0/3.0
(C) Siemens AG (1998)
Sync-able Attributes
none
Notes
ItemIDs can appear more than once in the browse tree resulting in
duplicate available points.
Simatic® S7-200 PC Access© OPC-Server DataAccess-V1.0A/2.05/3.0
ProgID
S7200.OPCServer
Version
3.1.60
Vendor Information
Simatic® S7-200 PC Access© OPC-Server DataAccess-V1.0A/2.05/3.0
Sync-able Attributes
Descriptor
Zero
Span
Notes
66
SISCO, Inc.
ProgID
SISCO.AXS4ICCP.3
Version
3.1.59
Vendor Information
AX-S4 ICCP OPC Server by SISCO, Inc
Sync-able Attributes
none
Notes
Smar
ProgID
Smar.hseoleserver.0
Version
3.8.2
Vendor Information
Smar OPC & Conf Server for HSE
Sync-able Attributes
none
Notes
Softing AG
PROFIBUS OPC Server
ProgID
Softing.OPC_PROFIBUS_DPV1.1
Version
2.7.210
Vendor Information
Softing PROFIBUS OPC Server
Sync-able Attributes
none
Notes
softing.OPC.Bridge
ProgID
softing.OPC.Bridge
Version
1.20.19
Vendor Information
Softing AG
Sync-able Attributes
Zero
Span
Notes
Information for Zero and Span is not present for all Items.
PI AutoPointSync Connector for the OPC Interface to the PI System
67
Appendix B:
OPC Server Compatibility
softing.OPC.Storage
ProgID
softing.OPC.Storage
Version
1.10.14
Vendor Information
Softing AG
Sync-able Attributes
none
Notes
softing.OPC.Tunnel
ProgID
softing.OPC.Tunnel
Version
1.20.19
Vendor Information
Softing AG
Sync-able Attributes
none
Notes
Software Toolbox
ProgID
SWToolbox.TOPServer
Version
4.170.325
Vendor Information
Software Toolbox
Sync-able Attributes
Descriptor
EngUnits
Zero
Span
Notes
Information for attributes is not present for all Items.
Technosoftware AG
opcswift.sample.30
68
ProgID
opcswift.sample.30
Version
3.0.1
Vendor Information
Technosoftware AG
Sync-able Attributes
none
Notes
Some ItemIDs contain illegal PI tagname characters “[” and “]”.
tsopcnet.daserver.1
ProgID
tsopcnet.daserver.1
Version
1.0.0
Vendor Information
OPC Server Framework .NET Sample Data Access Server
Sync-able Attributes
Zero
Span
Notes
Some ItemIDs contain illegal PI tagname characters “[” and “]”.
Information for Zero and Span is not present for all Items.
tsopcsource.datasample.40
ProgID
tsopcsource.datasample.40
Version
4.0.2
Vendor Information
Technosoftware AG
Sync-able Attributes
Zero
Span
Notes
Some ItemIDs contain illegal PI tagname characters “[” and “]”.
Information for Zero and Span is not present for all Items.
Takebishi Electric
Mitsubishi MELSEC
ProgID
Takebishi.Melsec.1
Version
3.10.2
Vendor Information
Mitsubishi MELSEC OPC Server by Takebishi Electric
Sync-able Attributes
Descriptor
EngUnits
Zero
Span
Notes
Information for EngUnits, Zero, and Span is not present for all Items.
PI AutoPointSync Connector for the OPC Interface to the PI System
69
Appendix B:
OPC Server Compatibility
OMRON SYSMAC OPC Server
ProgID
Takebishi.Sysmac.1
Version
3.10.2
Vendor Information
OMRON SYSMAC OPC Server by Takebishi Electric
Sync-able Attributes
Descriptor
EngUnits
Zero
Span
Notes
Information for EngUnits, Zero, and Span is not present for all Items.
TOYOPUC OPC Server
ProgID
Takebishi.Toyopuc.1
Version
3.10.2
Vendor Information
TOYOPUC OPC Server by Takebishi Electric
Sync-able Attributes
Descriptor
EngUnits
Zero
Span
Notes
Information for attributes is not present for all Items.
Yokogawa FA-M3R OPC Server
ProgID
Takebishi.FAM3.1
Version
3.10.2
Vendor Information
Yokogawa FA-M3R OPC Server by Takebishi Electric
Sync-able Attributes
Descriptor
EngUnits
Zero
Span
Notes
Information for attributes is not present for all Items.
Westinghouse
For Ovation, see Emerson Process Management.
Wonderware
For Wonderware, see Invensys.
70
Woodhead
ProgID
Woodhead.DnOpcServer
Version
1.0.3
Vendor Information
Woodhead DeviceNet OPC server v1.0.3
Sync-able Attributes
Zero
Span
Notes
Yokogawa
Exaquantum
ProgID
Yokogawa.ExaopcDAEXQ.1
Version
2.0.1
Vendor Information
Yokogawa Electric Corporation
Sync-able Attributes
Descriptor
EngUnits
Zero
Span
Notes
Information for attributes is not present for all Items.
Yokogawa FA-M3R
For Yokogawa FA-M3R, see Takebishi Electric.
PI AutoPointSync Connector for the OPC Interface to the PI System
71
Revision History
Date
Author
Comments
28-Sep-2002
BYoung
Initial Documentation
25-Nov-2002
BYoung
Added Appendix A
09-Dec-2002
BYoung
Updated Appendix A, added drawing of
configuration.
17-Mar-2003
BYoung
Updated version to 1.1.0.0
25-Mar-2003
BYoung
Version 1.1.0.2. Added Tag Name Masking section.
22-Feb-2005
LDaley
Revised the Installation Instructions and
Configuration Instructions sections. Rewrote the
section on the connector-specific configuration
control.
10-Aug-2005
Chrys
Version 1.1.0.8 – 1.1.0.10: Changed title of
document; fixed TOC; fixed headers and footers;
applied a different template
02-Dec-2005
LDaley
Version 1.1.0.11: Revised discussion of Tag Filter
to describe new behavior of matching on full
ItemID. Expanded the Troubleshooting section with
new symptoms. Revised Appendix A.
21-Dec-05
Janelle
Version 1.1.0.11 Rev B: fixed headers and footers,
formatting.
04-Jan-2006
LDaley
Version 1.1.0.11 Rev C: Added Appendix B.
Added NT-specific version of reg_OPCInt_APS to
Appendix A.
09-Jan-2006
MKelly
Version 1.1.0.11 Rev D: Made several changes.
Changed title of document, copyright page.
12-Jan-2006
Chrys
Version 1.1.0.11 Rev E: Formatting and grammar
changes
PI AutoPointSync Connector for the OPC Interface to the PI System
73
