China Network IsolatorOSIsoft.doc

China Network IsolatorVersion 2.1.2.xRevision BOSIsoft, LLC 777 Davis St., Suite 250San Leandro, CA 94577 USATel: (01) 510-297-5800Fax: (01) 510-357-8136Web: OSIsoft Australia Perth, AustraliaOSIsoft Europe GmbH Frankfurt, GermanyOSIsoft Asia Pte Ltd. Singapore OSIsoft Canada ULC Montreal & Calgary, CanadaOSIsoft, LLC Representative Office Shanghai, Peoples Republic of ChinaOSIsoft Japan KK Tokyo, JapanOSIsoft Mexico S. De R.L. De C.V. Mexico City, MexicoOSIsoft do Brasil Sistemas Ltda. Sao Paulo, BrazilChina Network IsolatorCopyright: © 2007-2023 OSIsoft, LLC. All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, mechanical, photocopying, recording, or otherwise, without the prior written permission of OSIsoft, LLC.OSIsoft, the OSIsoft logo and logotype, PI Analytics, PI ProcessBook, PI DataLink, ProcessPoint, PI Asset Framework(PI-AF), IT Monitor, MCN Health Monitor, PI System, PI ActiveView, PI ACE, PI AlarmView, PI BatchView, PI Data Services, PI Manual Logger, PI ProfileView, PI WebParts, ProTRAQ, RLINK, RtAnalytics, RtBaseline, RtPortal, RtPM, RtReports and RtWebParts are all trademarks of OSIsoft, LLC. All other trademarks or trade names used herein are the property of their respective owners.U.S. GOVERNMENT RIGHTSUse, duplication or disclosure by the U.S. Government is subject to restrictions set forth in the OSIsoft, LLC license agreement and as provided in DFARS 227.7202, DFARS 252.227-7013, FAR 12.212, FAR 52.227, as applicable. OSIsoft, LLC.Published: 01/0001Table of ContentsTerminologyviiChapter 1.Introduction1Limitations2PI System Administrator Tasks2Reference Manuals3Pre-Requisites3Supported Features4Diagram of Hardware Connection7Chapter 2.Principles of Operation9Network Isolator9Client/Server Communications Model10System Initialization Requirements10PI Point Synchronization10Tag Sync File11Tag Map Table11Shutdown Attribute13Time-series Data Transfer13History Recovery13Real-time Data Collection14Source PI Server14Target PI Server14Update Frequency15PI Server Dependencies15Chapter 3.Installation Checklist17Network Isolator17One-time Initialization of Target PI Server17Target PI Server18Source PI Server18Verification of Data Transfer by the Interface19Re-Initialization of Target PI Server19Chapter 4.Interface Installation21Interface Directories21PIHOME Directory Tree21Interface Installation Kit21Installing Interface as a Windows Service22Installing Interface Service with PI Interface Configuration Utility22Service Configuration23Installing Interface Service Manually26Chapter 5.Connection Tool27Chapter 6.Digital States29Chapter 7.PointSource31Chapter 8.PI Point Configuration33Chapter 9.Performance Point Configuration35Chapter 10.I/O Rate Point Configuration37Chapter 11.Startup Command File39ICU Configuration on the source PI Server39ICU Configuration on the target PI Server41Command-line Parameters42Sample PIChinaNetIso.bat Files45Chapter 12.Interface Node Clock47Chapter 13.Security49Chapter 14.Starting / Stopping the Interface51Starting Interface as a Service51Stopping Interface Running as a Service51Chapter 15.Buffering53Appendix A.Error and Informational Messages55Message Logs55System Errors and PI Errors55Appendix B.Point Synchronization Failures57Messages on the Source PI Server57Messages on the Target PI Server58Corrupt Tag Sync File58Corrupt Tag Map File58Appendix C.Cluster Configuration61Sample Installation61Appendix D.Technical Support and Resources77Before You Call or Write for Help77Help Desk and Telephone Support77Search Support78Email-based Technical Support78Online Technical Support78Remote Access79On-site Service79Knowledge Center79Upgrades79OSIsoft Virtual Campus (vCampus)79Appendix E.Revision History81 TerminologyTo understand this interface manual, you should be familiar with the terminology used in this document.BufferingBuffering refers to an Interface Nodes ability to store temporarily the data that interfaces collect and to forward these data to the appropriate PI Servers.N-Way BufferingIf you have PI Servers that are part of a PI Collective, PIBufss supports n-way buffering. Nway buffering refers to the ability of a buffering application to send the same data to each of the PI Servers in a PI Collective. (Bufserv also supports n-way buffering to multiple PI Servers however it does not guarantee identical archive records since point compressions attributes could be different between PI Servers. With this in mind, OSIsoft recommends that you run PIBufss instead.)ICUICU refers to the PI Interface Configuration Utility. The ICU is the primary application that you use to configure PI interface programs. You must install the ICU on the same computer on which an interface runs. A single copy of the ICU manages all of the interfaces on a particular computer.You can configure an interface by editing a startup command file. However, OSIsoft discourages this approach. Instead, OSIsoft strongly recommends that you use the ICU for interface management tasks.ICU ControlAn ICU Control is a plug-in to the ICU. Whereas the ICU handles functionality common to all interfaces, an ICU Control implements interface-specific behavior. Most PI interfaces have an associated ICU Control.Interface NodeAn Interface Node is a computer on which · the PI API and/or PI SDK are installed, and · PI Server programs are not installed.PI APIThe PI API is a library of functions that allow applications to communicate and exchange data with the PI Server. All PI interfaces use the PI API.PI CollectiveA PI Collective is two or more replicated PI Servers that collect data concurrently. Collectives are part of the High Availability environment. When the primary PI Server in a collective becomes unavailable, a secondary collective member node seamlessly continues to collect and provide data access to your PI clients.PIHOMEPIHOME refers to the directory that is the common location for PI 32-bit client applications. A typical PIHOME on a 32-bit operating system is C:Program FilesPIPC. A typical PIHOME on a 64-bit operating system is C:Program Files (x86)PIPC.PI 32-bit interfaces reside in a subdirectory of the Interfaces directory under PIHOME. For example, files for the 32-bit Modbus Ethernet Interface are in PIHOMEPIPCInterfacesModbusE.This document uses PIHOME as an abbreviation for the complete PIHOME or PIHOME64 directory path. For example, ICU files in PIHOMEICU.PIHOME64PIHOME64 is found only on a 64-bit operating system and refers to the directory that is the common location for PI 64-bit client applications. A typical PIHOME64 is C:Program FilesPIPC. PI 64-bit interfaces reside in a subdirectory of the Interfaces directory under PIHOME64. For example, files for a 64-bit Modbus Ethernet Interface would be found in C:Program FilesPIPCInterfacesModbusE.This document uses PIHOME as an abbreviation for the complete PIHOME or PIHOME64 directory path. For example, ICU files in PIHOMEICU.PI Message LogThe PI message Log is the file to which OSIsoft interfaces based on UniInt 4.5.0.x and later writes informational, debug and error message. When a PI interface runs, it writes to the local PI message log. This message file can only be viewed using the PIGetMsg utility. See the UniInt Interface Message Logging.docx file for more information on how to access these messages.PI SDKThe PI SDK is a library of functions that allow applications to communicate and exchange data with the PI Server. Some PI interfaces, in addition to using the PI API, require the use of the PI SDK.PI Server NodeA PI Server Node is a computer on which PI Server programs are installed. The PI Server runs on the PI Server Node.PI SMTPI SMT refers to PI System Management Tools. PI SMT is the program that you use for configuring PI Servers. A single copy of PI SMT manages multiple PI Servers. PI SMT runs on either a PI Server Node or a PI Interface Node.Pipc.logThe pipc.log file is the file to which OSIsoft applications write informational and error messages. When a PI interface runs, it writes to the pipc.log file. The ICU allows easy access to the pipc.log.PointThe PI point is the basic building block for controlling data flow to and from the PI Server. For a given timestamp, a PI point holds a single value.A PI point does not necessarily correspond to a “point” on the foreign device. For example, a single “point” on the foreign device can consist of a set point, a process value, an alarm limit, and a discrete value. These four pieces of information require four separate PI points.ServiceA Service is a Windows program that runs without user interaction. A Service continues to run after you have logged off from Windows. It has the ability to start up when the computer itself starts up.The ICU allows you to configure a PI interface to run as a Service.Tag (Input Tag and Output Tag)The tag attribute of a PI point is the name of the PI point. There is a one-to-one correspondence between the name of a point and the point itself. Because of this relationship, PI System documentation uses the terms “tag” and “point” interchangeably. Interfaces read values from a device and write these values to an Input Tag. Interfaces use an Output Tag to write a value to the device.Chapter 1. IntroductionOSIsoft's China Network Isolator Interface transfers data between two PI Servers that are separated by a device known as a network isolator. Because of the security policies of the network isolator, the Interface sends data only in a single direction: from a source PI Server to a target PI Server.The source PI Server resides in a highly secure part of a data communications network. This PI Server receives and stores time-series information from interface programs that collect process control data. Client applications such as PI ProcessBook typically cannot access this PI Server because they do not originate from the highly secure side of the network. The China Network Isolator Interface sends data stored in this PI Server to the target PI Server.The target PI Server is located in a less secure part of the data network, where client applications also reside. Consequently, these applications can easily connect to this PI Server and access process control data without compromising the security of the process control network.In addition to transferring time-series data, the China Network Isolator Interface (hereafter known as the ChinaNetIso Interface) synchronizes the point database of the target PI Server with that of the source PI Server. Specifically, if you edit, delete, or add points on the source PI Server, the Interface duplicates these changes on the target PI Server.The ChinaNetIso Interface is different from other PI interfaces. You must always run two copies of this interface. One copy of the Interface runs on the same computer as the source PI Server, and the other copy runs on the same computer as the target PI Server. The copy running on the source PI Server does not send data directly to the target PI Server. Instead, it transfers information to the Interface on the target PI Server. The interface instance on the target PI Server computer actually writes data to the target PI Server.There is a one-to-one correspondence between the two copies of the interface. When running the Interface on the source PI Server, you must specify the IP address of the target PI Server. Similarly, when running the Interface on the target PI Server, you need to indicate the IP address of the source PI Server.Each interface pair is responsible for transferring all the data from a source to a target PI Server. That is, you cannot run more than one copy of the interface on a particular computer.The Interface supports History Recovery. If you enable this option, the copy of the Interface running on the source PI Server retrieves historical data and sends them to the copy running on the target PI Server. The Interface performs history recovery on startup and after error recovery.The Interface requires a network isolator that conforms to the specifications as defined by the government of the People's Republic of China.In summary, the ChinaNetIso Interface performs the following functions within the hardware and software policies imposed by a network isolator:· Transfers real-time data from a source PI Server to a target PI Server;· Retrieves historical data from the source PI Server to the target; and · Synchronizes the point database of the target PI Server with the point database of the source PI ServerNote: The ChinaNetIso Interface has only been tested against the NARI and Zhuhai Network Isolators. If a customer wishes to run the interface against a Network Isolator other than one of these two manufacturers, they must first send their Network Isolator to the OSIsoft Singapore office for testing. In addition, it may be possible that a customer has either a NARI or Zhuhai Network Isolator which has a different firmware version then encountered previously. If this is the case, and problems arise during operation, the customer must also send their Network Isolator to the OSIsoft Singapore office for testing.It has also been observed that the Zhuhai Network Isolator suffers from random resets which results in a disconnection. Version 2.1.1 of the ChinaNetIso Interface has been enhanced to work around these problems.LimitationsThe Interface does NOT provide replication between the source PI Server and the target PI Server. Thus, you need to be aware of the following limitations when editing or creating a point on the source PI Server:· On the target PI Server, do not edit the attributes for any point that corresponds to a point on the source PI Server.· Before creating or renaming a point on the source PI Server, make sure that both copies of the Interface are currently running.· Before creating a digital point on the source PI Server, make sure that on both PI Servers, the point's digital state set exists and contains the same number of states.· If you want to create a large number of points on the source PI Server, perform the point creation in incremental steps.Also, the Interface does not support COM Connector points or points that use a point class other than Base or Classic.PI System Administrator TasksTarget Computer InitializationBefore you install the Interface, you will need to perform a one-time initialization of the target PI Server computer. The Installation Ch