Home

PI to PI Interface User Guide

1. Install PI Interface Configuration Utility ICU on the interface node Install the interface Verify that the system time and time zone on the interface node are set correctly Hn un FF W Run the ICU and configure a new instance of this interface specifying the point sources for all the interfaces for which you want to duplicate point data 7 Ifthe interface maintains digital points ensure that the digital state sets on the source and target servers are identical 8 Start the interface interactively and confirm its successful connection to the PI Data Archive without buffering 9 Confirm that the interface collects data successfully 10 Stop the interface and configure buffering To optimize buffering throughput choose the Tools gt Buffering gt Buffering Settings ICU menu item and set the Primary and Secondary Memory Buffer Size Bytes to 2000000 11 Start the buffering application and the interface Confirm that the interface works together with the buffering application by either physically removing the connection between the interface node and the PI Data Archive node or by stopping the PI Data Archive 12 Configure the interface to run as an automatic Windows service Confirm that the service starts properly 13 Restart the interface node and confirm that the interface and the buffering application restart PI to Pl Interface User guide 27 Installation checklist for the PI to PI Interface Con
2. PI to PI Interface User guide 1 Introduction to the PI to PI Interface 2 Machine 1 Receiving PI Data Archive Machine 2 Source PI Data Archive PI to PI Interface Interface running on the source PI Data Archive pushing data to the target PI Data Archive Machine 1 Receiving PI Data Archive PI to PI Interface Machine 2 Source PI Data Archive Interface running on the target PI Data Archive pulling data from the source PI Data Archive PI to PI Interface User guide Introduction to the PI to PI Interface Machine 1 Receiving PI Data Archive Machine 3 PI to PI Interface Machine 2 Source PI Data Archive Interface running on a separate node Topics in this section e Related manuals e Supported operating systems e Interface limitations Related manuals e PI Server manuals e PI API Installation Manual e PI Interface Configuration Utility User Manual e Unilnt Interface User s Guide e PI Buffering User s Guide Supported operating systems Platforms 32 bit or 64 bit in emulation mode e Windows 2003 Server e Windows Vista e Windows 2008 and Windows 2008 R2 Server e Windows 7 PI to Pl Interface User guide 3 Introduction to the PI to PI Interface Windows 8 Windows 2012 Server No 64 bit builds of the interface are available Interface limitations Before deploying the interface be sure it is suitable for your intended pur
3. History recovery enables you to recover archive data for time periods when the interface was not running or otherwise unable to collect data During history recovery the interface updates target PI points with values from the source archive according to the settings you configure The interface performs history recovery after the following events PI to Pl Interface User guide 5 How the PI to PI Interface works e During interface startup before starting real time data collection e After restoring a lost PI Data Archive connection e Update queue overflow error recovery e For each new target point added to the interface You can specify the recovery period time increments within the total recovery period a pause time between increments and the maximum number of archive events returned per data request These parameters enable you to manage the performance impact on the source and target PI Data Archives by throttling the data collection rate Time range history recovery is configured through the interface startup configuration file which you edit using PI ICU When time range recovery is enabled the interface starts up recovers archive data for the specified start and end time then exits Specify the recovery start and end times in the time zone where the interface runs even if the source PI Data Archive is in a different time zone than the machine where the interface runs Ensure that the target archive has enough space for the da
4. PI to PI Interface User Guide OSIsoft LLC 777 Davis St Suite 250 San Leandro CA 94577 USA Tel 01 510 297 5800 Fax 01 510 357 8136 Web http www osisoft com PI to PI Interface User guide 1997 2014 by OSlIsoft 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 Coresight PI Data Services PI Event Frames PI Manual Logger PI ProfileView PI WebParts ProTRAQ RLINK RtAnalytics RtBaseline RtPortal RtPM RtReports and RtWebParts are all trademarks of OSIsoft LLC All other trademarks or trade names used herein are the property of their respective owners U S GOVERNMENT RIGHTS Use duplication or disclosure by the U S Government is subject to restrictions set forth in the OSIsoft LLC license agreement and as provided in DFARS 227 7202 DFARS 252 227 7013 FAR 12 212 FAR 52 227 as applicable OSIsoft LLC Version 3 8 9 x Published 11 April 2014 Contents Introduction to the PI to Pl Interface cccceesseeeeeeeeeeeeeeeeeeeseeeeeeeeeeeeeeseeaueeeeeeeeeeeaueeees 1 Relat dimman
5. src_host XXXXXX 545 ps PItoPI id 1 f 10 REM End of PItoPI bat File PI to Pl interface User guide 43 Command line parameters for the PI to PI Interface Sample PItoPI configuration file Purpose x interface id y oe Se Ge Ge Us be Us Usus u a PItoPI 1 3 EventCounter 1 MaxArcTimespan 24 i PItoPI 1 1 5 SourceHost XXXXXX 5450 HistRecovery 48 3 PItoPI 1 2 5 SourceHOost XXXXXX 5450 3 HistRecovery 72 Ei 3 5 List of possible parameters 3 53 SourceHOsSt XXXXXX 5450 a Data Archive 2 x 3 TargetHost XXXXXX 5450 Ei Data Archive 2 x 3 SsecurityFile securityfile security file 3 3 SourceLogin userid 3 SourcePassword password s EventCounter 3 HistRecovery 3 MaxArcTimespan ei ei HistPause 3 3 HistOnly Ps DebugFlags 3 ri 3 end of sample PItoPI ini 44 Plto Pl Interface User guide This file is used in conjunction with PItoPI bat It is only required to collect data from multiple source servers using a single copy of the interface the headings read PItoPI x y where scan class if specified Name of source PI Data Archive port 545 for PI Data Archive 3 x and 545 for PI Name of the target PI Data Archive port 545 for PI Data Archive 3 x and 545 for PI Required if PI Data Archive 2 x lt name gt part of PItoPI lt name gt SEC PI Data Archive 2 x PI user name PI Data Archive 2 x PI user password Num
6. 30 minutes or less is considered clock drift Adjusting for clock drift means the time offset is added to the source time stamp adjusting it to target PI Data Archive time Time stamp adjustment for individual points is configured using the Location2 point attribute Interface nodes and the source and target PI Data Archives must have the correct system time for their time zone History recovery History recovery enables you to recover archive data for time periods when the interface was not running or otherwise unable to collect data History recovery is performed on startup after restoring a lost PI Data Archive connection and after a disruption in exception data collection In addition when a new point is added to the interface history recovery is performed on that point The history recovery period is configurable The default is to recover data for the previous 8 hours To disable history recovery set the time period to 0 You can also recover data for a specified time period If you specify a start and end time the interface recovers data for the specified period then exits Unilnt based Unilnt stands for Universal Interface the framework on which this interface is based The framework speeds interface development and provides a common set of basic features The Unilnt Interface User Manual is a supplement to this manual 24 PIto PI Interface User guide Features supported by the PI to PI Interface Disconnected startup The
7. Performance considerations e Data type conversion e Error handling e Failover for the PI to PI Interface e Tracking interface status Interface startup On startup the interface reads site specific operating parameters such as source and target PI Data Archive data update rates and history recovery settings from its configuration file Next the interface connects to the source and target PI Data Archives Each connection to a PI Data Archive is associated with a specific PI user On the source server this user must have permission to read PI point attributes and data On the target server the user must have read access for point attributes and read and write data access for its points Next the interface builds a list of target PI points grouping points internally by scan class Each target point must have a source point If an invalid point configuration is detected the point is either rejected or added to the point list and marked as erroneous and the interface logs the error After the interface builds its point lists it calculates the time offset between PI Data Archives Each participating node must be configured with the correct system time for its time zone During operation the offset is checked every two minutes The offset is used for data time stamp adjustments if enabled and to time stamp interface status events Finally the server performs history recovery and begins real time data collection History recovery
8. Sample PItoPl Batchitilesed scvesoties sata d ihc Phd Rte a RN kd Riad EN le liad 43 Sample PItoPl configuration file ceecceeeeeeeeeeeceeeeeeeeeeeeeeeeeeceeeeneeeeeeceeeeeeeseaeseeeseaeeeeeseeeseeeseaeseeeseaeeneeens 44 Technical support and other reSOUrces ccececeeeeeeeeeeeeeeeeeeeeeeee sense eeeeeneeseneesenseneeeeeees 45 iv PI to Pl Interface User guide Introduction to the PI to PI Interface The PI to PI Interface copies PI point data from one PI Data Archive to another Data is moved in one direction meaning data is copied from the source to the target PI Data Archive Typical applications for the interface include the following e Isolate users from the source PI Data Archive for security load distribution or to resolve remote access issues e Maintain a copy of archive data on a secondary PI Data Archive perhaps as a backup e Create a test copy of a production PI Data Archive e Aggregate data from many PI Data Archives to a single PI Data Archive Note You can also use the interface for data replication in PI collectives as an alternative to fanning data using buffering Use this method only if it is required for your system configuration or security needs For details about high availability strategies refer to the High Availability Administration Guide Interface PI points are created on the target PI Data Archive Each interface point is configured to receive data for a unique source point PI point
9. calculate the minimum queue size required use the following formula Minimum Limit Interface Point Count Scan Rate Sec For example if the interface is maintaining 10 000 target points with a scan rate of 10 seconds set the pending update limit and global update limit to at least 100 000 You can also manage the workload by careful configuration of scan rates for target points Choose a small initial scan rate for example 10 seconds then use a performance point to determine the average time required to complete the exception data scan and adjust the scan rate accordingly Data type conversion If the data types of the source and target PI points differ the interface can convert source data to compatible target data types as follows Source point data type Compatible target point data type Float 16 32 64 Int16 32 Digital Int16 32 Float Digital Digital Int16 32 String Digital Error handling When the interface encounters an error it logs a message to the log file If an error is not PI point specific the interface determines whether it is still connected to the PI Data Archive If the error is PI point specific the point is then marked by the interface as erroneous and is removed from the update list The interface attempts to read erroneous points every ten minutes If an attempt succeeds the point is restored to active data collection Failover for the PI to PI Interface Source PI Data Archi
10. can increase data throughput for archive data retrieval ns Optional Start history recovery beginning with the first value prior to the start time By default recovery begins with the first value after the start time rh Optional INI File Setting HistRecovery Default rh 8 Hours of history recovery to perform No maximum is enforced but be sure you have sufficient disk space for the archive files on the target server computer For information on backfilling data see the PI Server System Management Guide 40 PIto PI Interface User guide Command line parameters for the PI to PI Interface Parameter rh_inc Optional INI File Setting MaxArcTimespan Default rh_inc 24 Description Time increments within the total rh recovery period For example if rh 48 and rh_inc 24 the interface cycles through the point list twice On the first cycle the first 24 hour period is recovered On the second cycle the second 24 hour period is recovered rh_qcheck Optional Default rh_qcheck 5 For exception data scan classes specify how often to clear the exception queue on the source PI Data Archive during history recovery To prevent queue overflow the interface periodically collects exceptions from the source PI Data Archive during history recovery You can adjust this time interval to tune history recovery performance Exception data collection p
11. data if event at time stamp exists ARCREPLACE Archive and snapshot events Add archive or snapshot event replace if event at same time InstrumentTag source point name In target PI points the InstrumentTag attribute specifies the name of the source point Alternately the source point can be specified using the ExDesc or UserInt1 attributes If you do not configure a source point the source and target point names must be identical To configure the mapping method used by the interface using PI ICU go to the PItoPI gt Optional tab select the Source tag definition attribute and enable the desired option Userlnt1 source point ID As an alternative to mapping PI point names you can specify the unique PointID of the source point in this attribute of the target point The advantage of this approach is that the mapping remains valid if the source point is renamed Due to a limitation of the PI API if the source point name is long than 80 characters you must use this approach to mapping Scan This attribute enables or disables data collection for the PI point By default data collection is enabled Scan is set to 1 To disable data collection set Scan to If the Scan attribute is when the interface starts the interface does not load or update the point If you enable scanning while the interface is running the time required for data collection to start depends on how many points you enable because they are pr
12. particular point ID Location2 time stamp adjustment The source PI Data Archive supplies a time stamp for each data event You can configure the interface to adjust these time stamps to account for time differences between PI Data Archives Each PI Data Archive must be configured with the correct system time for its configured time zone Valid settings are as follows 16 PI to PI Interface User guide Configuring PI points for the PI to PI Interface Location2 Value Adjust for Time Zone Differences Do Not Adjust for Time Zone Differences Pl2 servers only Adjust for Clock Drift Truncate Sub second Time stamps NYPD oO BP wl n r o Target PI Data Archive is the time master Time stamps are adjusted to target PI Data Archive time An offset of 30 minutes or less is considered clock drift Truncating sub second time stamps can lead to data loss during history recovery and archive data scanning if multiple events are stored within the same second Use with caution Location3 interface status events Location3 configures which interface status events are to be written to a point If a PI point is configured for archive data collection this attribute also specifies whether the snapshot value is included with each scan update Note that IO Timeout events result in a data gap for periods when the interface is disconnected from the source PI Data Arc
13. specific settings go to the PItoPI page as shown in the following figure ku Pl Interface Configuration Utility PitoP 1 Interface Tools Help Dex gro HR Ble PitoPt PitoPi TOPAP bsp PtP exe version 380 0 Urdrtvesmm4440 PitoPl TCPAP Irtetace Specilic Parameters 3 6 2 0 Settings for fa Scan Casses Disconnected Startup Recurea History Recovery Debug Location Optional Opt Cont Source Pi Server Fatiover Debug Required Parameters Fakes Performance Ports Source host PkoPlorc P3 Server Performance Counters Irhetace Status PitoPl Not Installed The following sections describe the interface settings noting the corresponding command line parameter to help you read the resulting batch startup file for debugging purposes For details about settings that are common to all interfaces consult the Unilnt Interface User Manual Topics in this section e Required tab e History Recovery tab e Debug tab e Location tab e Optional tab e Opt Cont tab e Source PI Server Failover tab PI to PI Interface User guide 29 PI ICU reference for the PI to PI Interface 30 Required tab Source host The name of the PI Server from which this interface instance reads data SRC_HOST hostname Select the server type PI3 or PI2 from the drop down list For PI2 servers specify security settings as required For details about PI2 security refer to the PI2 Server documentation Eve
14. time zone For individual points you can configure time stamp adjustment by setting the Location2 point attribute Target point definitions can be modified while the interface is running The interface checks with the target PI Data Archive for point configuration updates by default every two minutes These updates include adding editing and removing points Processing point updates is alow priority for the interface To prevent update processing from delaying data collection the interface processes a maximum of 25 point updates at a time If there are more than 25 point updates the interface checks every 30 seconds until all updates have been processed If a large number of point edits are made consider stopping and restarting the interface to force it to process all edits by rebuilding its point list Performance considerations Minimize network latency To minimize the effect of network latency on data throughput run the PI to PI Interface on the source PI Data Archive computer with buffering enabled Maximize archive cache reads PI Data Archives version 3 4 and higher cache a small amount of recent archive data in memory by default four events The size of this server cache is configurable and you can adjust the frequency of scan classes so that scans occur frequently enough to maximize the reading of archive data from the cache rather than from disk Reading archive data versus exception data You can configure the interfac
15. to the target server Topics in this section e PI point attributes e Mapping source points to target points e Preventing data mismatches PI point attributes To define PI points PI tags you configure at a minimum the following information e PI point name e Point source e Data type e Interface instance e Point data type e Scan class Depending on the type of point you are creating a few other settings might be required The following sections describe basic point settings in more detail Note For information about other point attributes that are relevant to data collection and archiving see the Unilnt Interface User Manual and PI Server documentation Tag PI point name When assigning names to PI points follow these rules e The point name must be unique e The first character must be alphanumeric underscore _ or percent sign e Control characters such as linefeeds or tabs are illegal as are the following characters oe PEILEN e The following table indicates the maximum length of the length attribute which depends on the combination of PI API and PI Server that you have installed 1 6 0 2 or higher 3 4 370 x or higher 1023 1 6 0 2 or higher Below 3 4 370 x 255 Below 1 6 0 2 3 4 370 x or higher 255 PI to PI Interface User guide 15 Configuring PI points for the PI to PI Interface Below 1 6 0 2 Below 3 4 370 x 255 If your PI Server is earlier than version 3 4 3
16. 70 x or the PI API version is earlier than 1 6 0 2 and you want to create points with names that exceed 255 characters you must enable the PI SDK Note If the source point name length exceeds 80 characters you must use the UserInt1 attribute for source point mapping due to a limitation of the PI API PointSource point source PointSource is an identifier that associates a PI point with a PI interface instance enabling the interface to query the PI Server for the points that it updates This field is not case sensitive In the interface batch startup file the point source is specified using the PS command line parameter The following point sources are reserved Do not configure them for interface instances Point Source Reserved By T Totalizer Subsystem Gand Alarm subsystem R Random interface 9 RampSoak interface C Performance equations subsystem PointType data type The interface supports all PI point data types To prevent data corruption due to type mismatches ensure that the data types of source and target points are compatible ideally identical For details about point data types see the PI System Management Guide Locationz interface instance Location specifies the instance of the interface to which the PI point belongs The value of this attribute must match the ID configured for the interface instance This setting plus PointSource identify the interface instance that writes to a
17. I Interface Status Utility point on the source server that tracks the status of the primary server Used by failover to determine whether the server is up and running SSU1 tagname e Secondary Source Server Node Name The port number of 5450 is appended to the name when PI ICU saves the setting in the batch file SEC_SRC nodename 545 e Secondary Source Int Status Utility Tag Specifies the PI Interface Status Utility point on the secondary source server that tracks the status of the server Used by failover to determine whether the server is up and running SSU2 tagname e Number of connection attempts to source server Configures the number of connection retries that the interface attempts before failing over to the secondary source server Default is 1 NT x e Enable failover status logging Enable failover status logging If you enable this setting you must configure the failover status point on target server FST tagname PI to Pl Interface User guide 33 PI ICU reference for the PI to PI Interface 34 PItoPI Interface User guide Error and informational messages from the PI to PI Interface Messages are written to 7PIHOME dat pipc log during interface startup and during data collection Additional messages are logged if you enable debugging To display details about an error number issue the following command PI adm pidiag e error_number For detailed information about interface logging see the fo
18. PI APS and the PI to PI APS Connector Preventing data mismatches Unlike interfaces that receive unprocessed data the data that is read by the PI to PI Interface has already passed exception handling and compression To prevent mismatches between the data in source and target PI points disable interface exception filtering for the points on the target server To ensure that no values read from the source server are filtered out by the target configure target points as follows 20 PI to Pl Interface User guide Configuring PI points for the PI to PI Interface Point Attribute Value CompDevPercent Source Tag Value CompMax 32767 CompMin 2 ExcDev 2 ExcDevPercent 2 ExcMax 32767 or higher ExcMin 2 Note If a point configured for archive data updates has its Location3 attribute set so that it receives snapshot updates data compression must be enabled to prevent data mismatches between PI Data Archives The Zero and Span point attributes must be identical in the source and target points For Float16 points the Zero and Span attributes must be set because they affect how the data is stored in the archive For digital PI points do not set the Zero and Span attributes because they are set by the PI Data Archive when a digital point is created PI to PI Interface User guide 21 Configuring PI points for the PI to PI Interface 22 PlItoPl Interface User guide Features supported by the PI
19. PI to PI interface is built with a version of UniInt that supports disconnected start up Disconnected start up is the ability to start the interface without a connection to the PI Data Archive This functionality is enabled by adding cachemode to the list of start up parameters or by enabling disconnected startup using the ICU Refer to the Unilnt Interface User Manual for more details on UnilInt disconnected startup The PI to PI Interface supports disconnected start up for both source and target PI Data Archives SetDeviceStatus The health point with the point attribute ExDesc UI_DEVSTAT represents the status of the source device The following events can be written into this point e 1 Starting The interface is starting e Good The interface is properly communicating and reading data from the server The following events indicate a failure to communicate with the server e 3 1 device s in error Network communication error to source PI server e 3 1 device s in error Unable to get archive data from source PI server e 3 1 device s in error Unable to get snapshot data from source PI server e 3 1 device s in error Unable to write data to target PI server e 3 1 device s in error Unable to obtain current data with source PI server failover enabled e 4 Intf Shutdown The interface is stopped Refer to the UniInt Interface User Manual for more information on how to configure health points Source PI Da
20. See ete ee oe eats eNte es ete ee ce dated 30 History RECOVERY tab i285 ots 1ah igh a th aot es Dats ah ab as neh eed NE ah BGs 2 Bas NS Bae a he 30 Debug tab eects ee Rett elated och a elle ect well y osha de Eames 31 Rotario S EAE TEE E AE A ge CC eee 31 Optional aeo E E E T 31 OpweCont T o A E EAEE EE A EE AAT 32 Source PI Server Failover tab cccccececceeeeeeeeeeeeeeeeeaeeeeseeceececsaeeseaeeeeaeeseaeeeseaeeseaeeseaeeecaeeeseeessneeeseieeeseeeeees 33 Error and informational messages from the PI to PI Interface cceeeeeeeeeeeeeeeeneeeeeeees 35 Command line parameters for the PI to PI Interface cccceeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee 37 General interface operation parameterS s se snsneieie1s1ntiteistrntatatensinntateinnnnatnnninnnnentanninnnntnnennennnen tennent 37 History recovery and archive data collection parameterS esessessseisssrererreiertererrerererisrnrrernnnerernsrernrrernene 39 Exception data collection parameters 2 acszevanet ivan tuned iad svagecae tevaiad wag leapeceb iad wegunay Mtevalad wag laabiedi let wees 41 Point attribute override parameters ae a a E aE A A A A E A EE A aAA E AEA ES AA ETEEN 41 Source Data Archive level failover pararmeters cccecceeseeseeeneseeeeseeeeeeeeeeeeeeeseceaeeeaeeeaeeeeeeeeeeeeeeeeeseeeeeaeeeetens 42 Sample startup and configuration files eee cece cece eee eee e eee tee teeta eeae taste sees sae saeseeseeeeaesaeseeseeetaeeeseaey 43
21. aaea aa Ea AEE EERE 18 Instrument ag source POINT NAME aaa aa tee Ee E E E E EESE EES aene 19 Userinti Source PointID ssrin a eE E E EAEE ETERO 19 E EE EE E T A E nd ce AEE EAE A E A E EATA 19 SOTA OWI D EEEE E A A E EEE A EE EE 19 Mapping source points to target points iruri EE T SE E AAEE EE EE ER 20 Preventing data mismatches sssssesessesssrereresrersriererrsrerterertsiernrerntternttsratteratnreraternnternnternnnrannrennreren 20 Features supported by the PI to PI Interface cccecceeeeeeeeeeeeeeeeeeeeeeeeaeeseaeeeeeneeeeeees 23 Additional details on interface features ccccccececceeeceeeeceeeceeeeeaeeceaeeceaeeesaeeeeaeessaeeseeesseeeeseaeeseaeesseeeeeeeeeess 23 Installation checklist for the PI to PI Interface ccccceeeeeeeeeeeeeeeeeeeeeeeeaeeesaeeeeneeeeeeees 27 Configure data Collection ec eceee eee cee cece ee eeee cee eeeeeaeeeeceeeseesaesaeseeesassaesaeseeesagsaesaessegassaesoesseseaeseeseeeeenas 27 Configure interface diaqQnostics ecee ee cee ee ee cee eee eeee eee eeeeeeeeee cae eeeeeeeaeseesseesaesaesoesseesaesaeseeesegeasseenenaee 28 Configure advanced interface features e cece ce eee eee eee cee eeeecee cee eeeeeaeeaeseeeeeeaesaeseeseaeeaeseeseeseaseaeseeseeesaae 28 PI to PI Interface User guide iii Contents PI ICU reference for the PI to PI Interface 0ccceeeeeceeeeeeeeeeeeeeeeeeeeesaeeesaaeeseeeeeeeeeeeees 29 Nt Ta iTia Te riel e AEREE TTET Bua
22. arameters Parameter me Optional Default me 5000 sn Optional Description Sets the maximum number of exception events retrieved per data request A large count reduces the number of calls required to read exception updates A small count reduces the time to complete each request for troubleshooting network timeout issues Disable exception filtering for data collected from the source PI Data Archive This data has already passed exception for the source tag Additional data filtering can lead to data mismatches between PI Data Archives Point attribute override parameters Parameter Description c1 Location1 point attribute override Optional Load all points configured for the specified point source regardless of Location and interface ID values c2 Location2 point attribute override Optional Ignore Locationz2 for each point and use the specified value Valid values are 0 7 c3 Location3 point attribute override Optional Ignore Location3 for each point and use the specified value Valid values are 0 15 PI to Pl Interface User guide 41 Command line parameters for the PI to PI Interface Parameter c4 Optional Description Location4 point attribute override Ignore Location4 for each point and use the specified value Valid values are 1 exception data collection or 2 archive data collection c5 Optional Location5 point attrib
23. ates with no user interaction Each interface participating in failover has the ability to monitor and determine liveliness and failover status To assist in administering system operations the ability to manually trigger failover to a desired interface is also supported by the failover scheme The failover scheme is described in detail in the Unilnt Interface User Manual which is a supplement to this manual Tracking interface status To track interface status you can create the following digital PI points on the target PI Data Archive e Internal state PI point Indicates whether the interface is in startup performing history recovery scanning for data experiencing network communication errors denied data or point access security permissions or performing shutdown operations To enable this point using PI ICU go to the PItoPI gt Debug tab check Interface Status Tag on Receiving PI Server and specify the name of the PI point e Failover status PI point If you enable source server level failover you can configure a PI point that tracks failover status To configure the point using PI ICU go to the PItoPI gt Source PI Server Failover tab check Enable failover status logging and specify the name of the PI point PI to PI Interface User guide 9 How the PI to PI Interface works 10 PI to PI Interface User guide Installing and configuring the PI to PI Interface Installing the PI to PI Interface This section p
24. ber of event counter defined in dat iorates dat file total hours of history recovery default 8hrs history recovery increment divided into total hours of history recovery HistRecovery default 24hrs pause between history recovery increments in milliseconds flag to disable exception data collection off 1 on Generates additional messages for troubleshooting comma separated list 1 2 3 4 5 6 7 Technical support and other resources For technical assistance contact OSIsoft Technical Support at 1 510 297 5828 or through the OSIsoft Tech Support website https techsupport osisoft com The website offers additional contact options for customers outside of the United States When you contact OSIsoft Technical Support be prepared to provide this information e Product name version and build numbers e Details about your computer platform CPU type operating system and version number e Time that the difficulty started e Log files at that time e Details of any environment changes prior to the start of the issue e Summary of the issue including any relevant log files during the time the issue occurred The OSIsoft Virtual Campus vCampus website http vcampus osisoft com has subscription based resources to help you with the programming and integration of OSIsoft products PI to Pl Interface User guide 45 Technical support and other resources 46 Pi to Pl Interface User guide
25. ce is not running If written to target points the preceding events create a data gap that cannot be filled using history recovery Location scan class Location4 is used to configure the scan class for the PI point The scan class determines the frequency at which input points are scanned for new values Location4 must be a positive number or for triggered and event based points Specify scan frequency and optional offset using the following format HH MM SS HH MM SS Examples 00 01 00 00 00 05 or equivalently 60 5 If you omit HH and MM the scan period is assumed to be in seconds Subsecond scans are specified as hundredths of a second 01 to 99 To configure a time of day at which a single scan is performed specify the time using a 24 hour clock and append an L following the time as follows HH MM SS offset L For example 12 00 00 0 L Locations write mode Specifies the write mode for sending archive data to the target PI Data Archive The following table lists the supported modes 18 PI to PI Interface User guide Configuring PI points for the PI to PI Interface Locations Write Mode Description ARCAPPEND Archive and snapshot events Add archive event regardless of existing events Default snapshot behavior is to append data if event at time stamp exists ARCREPLACE Archive events only Add archive event replace if event at same time Default snapshot behavior is to append
26. cedure 1 Click Service 2 To ensure that buffering is running when the interface starts click bufsrv for PI Data Archive PI Server before 3 4 or pibufss for PI Data Archive PI Server 3 4 and later in the Installed services list then click the left arrow button to add it to the Dependencies list If prompted update service dependencies 3 Set Startup Type to Auto 4 Click Create 5 To start the service click gt After you finish To verify that the service is created and is running use the Windows Services control panel Enable buffering Procedure 1 In ICU choose Tools gt Buffering The Buffering window appears 2 Click Enable buffering with PI Buffer Subsystem 3 To start the buffering service click PI Buffer Subsystem Service then click gt After you finish To verify that buffering starts successfully check the message log for messages indicating that the buffering application connected to the PI Server To verify that the configuration is working as intended reboot the interface node and confirm that the interface service and the buffering application restart 14 PlIto PI Interface User guide Configuring PI points for the PI to PI Interface The PI point also called a PI tag is a time stamped record of a single set of measurements for example the temperature of tank 100 every five minutes If you mis configure tags the interface cannot correctly transmit the data from the source server
27. e enable buffering There are two buffering applications the PI Buffer Subsystem PIBufss and the PI API Buffer Server BufServ PIBufss and BufServ are mutually exclusive that is on a particular computer you can run only one at a time For details about configuring buffering refer to the PI Buffering User Guide To install the interface download its setup kit from the OSIsoft downloads web page and run the kit By default the interface is installed in the following location APIHOME Interfaces PItoP1 Note The PIHOME directory which is the root directory under which OSIsoft products are installed is defined by the PIHOME entry in the pipc ini configuration file in the windir directory To override the default locations edit the pipc ini configuration file Reserve the C drive for the operating system and install the interface on another drive PI to Pl Interface User guide 11 Installing and configuring the PI to PI Interface 12 Configuring the PI to PI Interface Use the information in this section to perform the necessary tasks to configure the interface Procedure Create trusts on the source and target PI Data Archives Create and configure the interface instance 1 2 3 Configure the Windows service 4 Enable buffering Create trusts on the source and target PI Data Archives When creating trusts you have many options Following is a simple and secure approach creating a trust
28. e data collection the interface reads events from the source PI Data Archive and sends them to the target server There are two options for determining where the source data comes from e Archive data This data has passed exception testing by whatever interface accepted the data and has passed compression testing on the source server However reading data from the PI Data Archive increases the workload on the source server because the data is read from disk e Exception data This data has passed exception testing by the interface that accepted it but has not passed compression testing by the source server Reading exception data imposes less workload on 6 PI to PI Interface User guide How the PI to PI Interface works the source server because the data resides in memory To ensure the closest correspondence between values on the source and target servers configure identical compression settings on the source and target servers To configure a PI point for exception data collection assign it to scan class 1 Note If you need to perform both archive and exception data collection configure separate instances of the interface for each purpose to ensure optimal performance The source PI Data Archive provides a time stamp for each data event The interface might adjust time stamps to account for time zone differences and clock drift between PI Data Archives Each PI Data Archive must be configured with the correct time for its
29. e to collect data from the source server s archive or from its snapshots exception data Reading snapshots is faster because data is read from memory rather than disk However exception data has not been compressed To read a point s exception data assign the point to scan class 1 Managing memory consumption The PI Data Archive maintains update manager queues that store events in memory for client applications such as PI Interfaces The server creates separate queues for each client application that requests updates The queues grow between scans as exceptions accumulate on the source PI Data Archive To control the amount of server memory consumed by update queues you can configure a maximum size for individual queues and a maximum for the total amount of memory consumed by all update queues If a queue reaches its maximum size the PI to PI Interface User guide 7 How the PI to PI Interface works server stops queuing updates for the interface which causes the interface to delete its point list log errors and enter history recovery to reinitialize data collection To configure these limits set MaxUpdateQueue and TotalUpdateQueue using PI System Management Tools or the piconfig utility Default maximums for queue size are as follows specified as exception events per client application e PI Data Archive 3 4 375 38 PR1 and later 50000 e PI Data Archive 3 3 to PI Data Archive 3 4 370 4096 e PI Data Archive 3 2 2000 To
30. ebugFlags db 3 PI Data Archive connections db 4 PI Data Archive 2 x security validation obsolete db 5 PI point additions edits deletions db 6 Data read amp writes db 7 Failover Example db 2 4 5 delayr Millisecond time delay between reconnection attempts to the target PI Data Archive Units are in Optional milliseconds Valid values are between and Default delayr 0 28800000ms 8 hours delays Millisecond time delay between re connection attempts to the source PI Data Archive Valid Optional values are between and 28800000ms 8 hours Default delays 0 ist tagname Name of interface status point Optional ist lt tagname gt tagname is a digital point on the target PI Data Archive oc Number of seconds between calculating time offset between the interface and PI Data Archive nodes Optional Default oc 30 PI to PI Interface User guide 37 Command line parameters for the PI to PI Interface BAT ps x Required Description The ps parameter specifies the point source for the interface X is not case sensitive and can be any single or multiple character string For example ps P and ps p are equivalent The point source that is assigned with the ps parameter corresponds to the PointSource attribute of individual PI points The interface will attempt to load only those PI points with the appropriate point source If the PI API version b
31. eing used is prior to 1 6 x or the PI Data Archive version is prior to 3 4 370 x the PointSource is limited to a single character unless the SDK is being used pw password Obsolete Required for PI 2 source Optional INI File Setting SourcePassword Login password of PI user on PI Data Archive 2 node Required when source server is PI Data Archive 2 x sf name Obsolete Required for PI 2 source INI File Setting SecurityFile src_host name 5450 Required INI File Setting SourceHost Used for locating the security file on a PI Data Archive 2 x source server This switch specifies the name part of the file name Note that the complete file name must have this format PItoPIname SEC where name is the portion specified by sf Name or IP address of source PI Data Archive src_host node_name tcpip_port The port number is always 5450 38 PI to Pl Interface User guide Command line parameters for the PI to PI Interface stopstat digstate or stopstat stopstat only is equivalent to stopstat Intf Shut Optional Default no digital state written at shutdown Description If stopstat digstate is present on the command line then the digital state digstate will be written to each PI point when the interface is stopped For a PI Data Archive 3 x server digstate must be in the system digital state table Unilnt will use the first occurrence of digstate found in the table I
32. f the stopstat parameter is present on the startup command line without a digital state then the digital state Int Shut will be written to each PI point when the interface is stopped If neither stopstat nor stopstat digstate is specified on the command line then no digital state will be written when the interface is shut down The stopstat parameter is disabled if the interface is running in a UnilInt failover configuration The digital state digstate is not written to each PI point when the interface is stopped to prevent the digital state being written to PI points while a redundant system is also writing data to the same PI points The stopstat parameter is disabled even if there is only one interface active in the failover configuration Examples stopstat shutdown stopstat Intf Shut The entire digstate value must be enclosed within double quotes when there is a space in digstate ts Optional Suppress IO Timeout events when reconnecting to source PI server These events are configured through the Location3 attribute If this switch is not set the event written at reconnection will prevent history from being recovered for the period of the disconnection History recovery and archive data collection parameters Parameter dc Optional Description Apply data compression to history recovery and archive scan updates The default behavior is for this data to bypass compress
33. figure interface diagnostics Procedure 1 2 3 4 5 6 7 Configure scan class performance points Install the full version of the PI Performance Monitor interface on the interface node Configure Performance Counter points Configure Unilnt Health Monitoring points Configure the I O Rate point On the PI Data Archive node install and configure the Interface Status Utility ISU Configure the Interface Status point Configure advanced interface features Procedure 1 Configure the interface for disconnected startup Refer to the Unilnt Interface User Manual for more details on Unilnt disconnected startup Configure Unilnt failover see Features supported by the PI to PI Interface in this document for details related to configuring the interface for failover To ensure uninterrupted data collection configure a secondary source PI Data Archive Using PI ICU enable source server failover 28 Pi to Pl Interface User guide PI ICU reference for the PI to PI Interface The PI Interface Configuration Utility PI ICU provides a graphical user interface for configuring PI Interfaces The interface is launched using a Windows batch bat file which invokes the interface executable specifying run time options as command line parameters To ensure a correctly formatted startup batch file use PI ICU to configure the interface rather than manually editing the batch file To configure the interface
34. for the following applications e PI to PI Interface define on both the source and target servers e PI Interface Configuration Utility ICU e Buffering To create these trusts using PI System Management Tools connect to the PI Data Archive and perform the following steps Procedure 1 Click Security and choose Mappings amp Trusts 2 On the Trusts tab right click and choose New Trust The Add Trust wizard appears 3 Specify a meaningful name and description 4 Configure settings as follows Trust Type Application Name Network Path PI User PI to PI Interface PI API application PIToE Name of the PI points data interface node or owner IP address plus netmask 255 255 255 255 PI ICU PI API application PI ICU exe Name of the Dedicated PI interface node or identity with the IP address plus precise netmask permissions 255 255 255 255 required database read access read ptsecurity and read write permission for OPC points PI to PI Interface User guide Installing and configuring the PI to PI Interface Trust Buffering Type PI API application Application Name BufServ APIBE PIBufss Network Path Name of the interface node or PI User PI points data owner Pibufss exe IP address plus netmask 255 255 255 255 Create and configure the interface instance To create an instance of the interface launch PI ICU and pe
35. hive Interface status events are configured on a point by point basis through the Location3 point attribute Interface shutdown events are enabled through the interface startup script By default shutdown events are not written by the interface Location3 Value Write I 0 Write Access Include Snapshot Point level Timeout Denied Debugging 1 Yes 2 Yes 3 4 Yes Yes Yes 5 Yes Yes 6 Yes Yes 7 Yes 8 Yes Yes Yes 9 Yes Yes Yes Yes Yes Yes Yes 13 Yes Yes Yes 14 Yes Yes Yes PI to PI Interface User guide 17 Configuring PI points for the PI to PI Interface Location3 Value Write I O Write Access Include Snapshot Point level Timeout Denied Debugging 15 Yes Yes Note Set Location3 to ensure that the following status events are not enabled e I O Timeout status events are triggered when the interface loses a PI Data Archive connection This status indicates that data is not being collected An event is written to indicate the time of disconnection and another event is written to indicate the time of re connection e Access Denied status events are written whenever the interface is denied access to a point s data or attribute information e Intf Shut status events are enabled through stopstat startup parameter When enabled an event is written when the interface is stopped and again on startup These events indicate that no data is being collected because the interfa
36. ion This switch must be specified to prevent data mismatches if points are configured to include snapshot value with archive scan updates PI to Pl Interface User guide 39 Command line parameters for the PI to PI Interface Parameter hronly lt start end gt Optional INI File Setting HistOnly Description Specifies the time range to be recovered The interface recovers data for the specified period then exits To disable exception data collection omit time period Specify the times using PI time string formats with a colon or underscore separating the date and the time hronly dd mmm yy hh mm ss dd mmm yy hh mm ss or hronly dd mmm yy_hh mm ss dd mmm yy_hh mm ss For example hronly 10 dec 98 10 00 10 dec 98 12 00 or hronly 10 dec 98 10 00 10 dec 98_ 12 00 If the source and target PI Data Archives are in different time zones time stamps are local to the node runs hrpause Optional INI File Setting HistPause Default hrpause Milliseconds to pause between points during history recovery Used to throttle archive data retrieval during history recovery mh x Optional Default mh 1000 Supported for target PI Data Archive version 3 3 or later Sets the maximum number of archive events retrieved per data request If more than the maximum exist the interface makes multiple calls until all events are retrieved for the time period Increasing the maximum
37. lectives The interface cannot be configured to communicate with a PI collective only with one of the PI Data Archives in the collective History recovery can be compromised when the interface is configured for n way buffering to a collective If the last value for each target point is not the same in all PI Data Archives in the collective data gaps or overlaps can result To avoid this problem initialize all PI Data Archives in the target collective with the history for the interface point list prior to implementing the PI to PI Interface Buffering The PI Buffer Subsystem v3 4 375 38 supports writing to the archive only in NO REPLACE mode which prevents the interface from honoring any archive write options configured in the LocationS5 attribute of target points which can lead to data loss To avoid this issue use a later version of PI Buffer Subsystem or PI Bufserv 4 PlItoPl Interface User guide How the PI to PI Interface works You can configure the interface to copy exception snapshot or archive data For best performance configure a separate instance of the interface for each source PI Data Archive If you intend to copy both archive and exception data configure separate instances of the interface for each type of data Be advised that data throughput events per second can be limited by network quality or system resources Topics in this section e Interface startup e History recovery e Real time data collection e
38. llowing OSIsoft Knowledge Base topic http techsupport osisoft com techsupport nontemplates KB article aspx id KB00401 http techsupport osisoft com techsupport nontemplates KB article aspx id KB00401 The following tables list interface specific messages For details about the messages logged by the Unilnt framework refer to the Unilnt Interface User Guide Message 16 May 06 17 29 06 PItoPI 1 gt Error 77 returned from pisn_evmexceptions call to source PI server Cause Update manager queue limit has been reached on the source PI Data Archive Resolution Increase PI Update Manager queue size limits on source PI Data Archive PI to PI Interface User guide 35 Error and informational messages from the PI to PI Interface 36 PI to PI Interface User guide Command line parameters for the PI to PI Interface In addition to the interface specific parameters the interface supports standard UnilInt command line parameters For details refer to the Unilnt Interface User Guide Topics in this section e General interface operation parameters e History recovery and archive data collection parameters e Exception data collection parameters e Point attribute override parameters e Source Data Archive level failover parameters e Sample startup and configuration files General interface operation parameters Description db db 1 Max debug Optional db 2 Startup processing INI File Setting D
39. maximum 28800 seconds which is eight hours The time is converted to milliseconds before being saved in the batch file DELAYS x default seconds Target Host reconnection delay Specifies the amount of time that the interface waits before attempting to reconnect to the target PI Data Archive after being inadvertently disconnected by network problems By default the interface does not wait before trying to reconnect Specify time in seconds PI to PI Interface User guide PI ICU reference for the PI to PI Interface minimum one second maximum 28800 seconds which is eight hours The time is converted to milliseconds before being saved in the batch file DELAYR x e Suppress writing I O Timeout to tags upon reestablishment of a lost connection to the source PI Server When setting Location3 to write I O Timeout for any tags enable this setting to suppress the I O Timeout state that is normally written to tags when the interface reconnects to the PI Data Archive If this parameter is not set the 1 O Timeout state that is written at re connection prevents history from being recovered for the period of disconnection TS Source PI Server Failover tab The settings on this tab enable you to configure failover for source PI Data Archives so that if one source server fails the interface can collect data from the other e Enable PItoPI Failover Check to enable server failover e Source Server Interface Status Utility Tag The P
40. nt counter The event counter is a unique value used to correlate an I O rate point specified in the IORates dat file with this copy of the interface EC x I O rate points are used to track interface performance This field is enabled when a scan class is selected in the Settings for field For detailed information about event counters refer to the Unilnt Interface User s Guide Additional Parameters This field enables you to specify any settings for the interface that are not supported by PI ICU Additional Parameters a History Recovery tab The following settings configure how much history is recovered and enables you to tune performance of recovery Maximum hours of history to recover Number of hours to recover history for all points Setting the value to disables history recovery for all points RH Hours of history to recover per cycle For load balancing this setting enables you to configure the number of hours of history and therefore the size of the chunk that the interface recovers each time it cycles through its point list RH_INC To recover all history in a single chunk specify a value greater than the value configured for Maximum hours of history to recover If this field is set to zero the default is 24 hours If this field is greater than RH it is set to RH and the interface retrieves the whole history range in one chunk Millisecond pause between history calls Specifies the numbe
41. ocessed in batches For efficiency if you need to enable scanning for a large number of points stop and restart the interface If a point that is loaded by the interface is subsequently edited so that the point is no longer valid the point is removed from the interface and SCAN OFF is written to the point Shutdown By default the PI Shutdown subsystem writes the SHUTDOWN digital state to all PI points when PI Server is started The time stamp that is used for the SHUTDOWN events is retrieved from a file that is updated by the snapshot subsystem The time stamp is usually updated every 15 minutes which means that the time stamp for the SHUTDOWN events is accurate to within 15 PI to Pl Interface User guide 19 Configuring PI points for the PI to PI Interface minutes in the event of a power failure For additional information on shutdown events refer to PI Server manuals Note The SHUTDOWN events that are written by the PI shutdown subsystem are independent of the SHUTDOWN events that are written by the interface To prevent SHUTDOWN events from being written when PI Server is restarted set the Shutdown attribute to To configure the PI shutdown subsystem to write SHUTDOWN events only for PI points that have their Shutdown attribute set to 1 edit the PI dat Shutdown dat file as described in PI buffering documentation Mapping source points to target points To load the target server with points from the source server yo
42. pose Note the following Not a true data replication tool The interface does not synchronize PI Data Archive data or validate data It simply copies data from one PI Data Archive to another in an incremental time forward manner The interface does not guarantee that the data in the source and target PI Data Archives matches exactly If the goal is replication use n way buffering which is supported with PI API v1 6 x and later For details see the PI API installation manual Potential data gaps The PI Archive Subsystem might temporarily queue data in memory prior to committing it to disk This approach can lead to data gaps when using the interface for real time data collection with history recovery enabled To avoid data gaps run the interface in history recovery mode without snapshot updates Current real time data from the source PI Data Archive will not be available on the target PI Data Archive No support for annotations or batch data The interface is a PI API based application It does not currently support PI point annotations which require the PI SDK For this reason it cannot be used to copy batch database data between PI Data Archives Performance dependencies The interface is a single threaded process Its performance depends on the responsiveness of the source and target PI Data Archives and network quality To monitor performance use OSIsoft s PI Interface for Performance Monitor and PI Interface for Ping PI col
43. r of milliseconds to pause between history recovery calls to reduce workload on the PI Data Archive HRPAUSE milliseconds PI to PI Interface User guide PIICU reference for the PI to PI Interface e Use history recovery only no snapshot data collection If this check box is selected the interface does not read the source server snapshot HRONLY For each scan class history is recovered from the last snapshot value to the current time This box must be checked if you want to specify a history time range e Time Range History Recovery If Use history recovery only is enabled specifies the time range of history to recover before exiting HRONLY dd mmm yy hh mm ss dd mmm yy hh mm ss The times must be specified using PI time string formats The following example recovers two hours of data and then exits 10 dec 98 10 00 00 10 dec 98 12 00 00 If the source server resides in another time zone specify the corresponding time in the interface node s time zone This setting overrides the normal check for the most recent snapshot in the target database so out of order data might result When time range history recovery is enabled any value specified for the Maximum hours of history to recover setting is ignored e Start history recovery beginning with the first value prior to the start time Retrieve history for all points starting from the value immediately prior to the specified history recovery start time By default reco
44. rererrsrererrernrrersrnerernnrernrernnernnn 12 Create and configure the interface instance eee ee cece eee tee tree eee tee teeta sees tae tee seeseae tae seeseeesaesaeeesaee 13 Configure the Windows ServiCe e ceceesees cee eeeeee eee e eee eeee eae eaeseeeseeeae sae seeesasaesaeseeseaeeaeseeseessaeseeseeseeneaae 13 Enable PUEN tc aa rra aa testi sialet A a aE teats iets eben 14 Configuring PI points for the PI to PI Interface ccccecceeeseeeeeeeeeeeeeeeaeeeeeeeneeseeneeeeeees 15 Pl point attribute Soinen enia e A E EE a E AEE EE E 15 Tag Pipo NaM E r s a e a e E E EE 15 POINESOURCE POINESOUFCE ui tsecterseses arean ra neoa ss tie ccchy addi sjasaiines En tisiassstanenaduti EAEE REEE 16 PointT ype data type c ees ellie lee gece ellen eel ade bn ete peed eee een se 16 Locationa interface INStANCe cccceesssccceceeceessssceeeceececeesseeeeceeeecessnsueeeeeeeeceessauseececeecessnsaseeeeeeecenstnsaeess 16 Location2 time stamp adjustment eee eee ete ee tee cree eee tee tee ceee cee tae see eeee sae soeseeseae sae seeseeesaesaeseeeegaas 16 Location3 interface status CVENtS cccccceeceeeeeeeeeeeeeeeceeeeeeeeaeeseaeeseaeeseaeeseaeeeeaaeeseaeeseaeeseeesseeeeseeeseseeeaes 17 LOCAtIONG SCAN ClASS cccccsscccecessecccesssececsseeccesseecessssecccssececesseeccesssseccessseecccsseecesseeesessseeceseseeeeesaeeess 18 Locations write mode aire 5 5 i2 c6ahecesele bed ieiei edocs a dad sds a a a E E ea e a
45. rform the following steps Procedure 1 Choose Interface gt New from BAT file 2 Browse to the directory where the interface is installed default is PIPC Interfaces PItoPI select PItoPI bat_new and click Open The Select PI Host Server window appears 3 Specify the target PI Data Archive and click OK ICU displays the settings of the new instance of the interface 4 Click on the General tab and edit the settings as follows a Point source Configure the point sources for the source interfaces that you want to duplicate b Interface ID Enter 1 or a numeric ID not already in use c Scan class Set to desired scan frequencies Scan class 1 is reserved for exception data collection Note that when defining scan classes you can spread the server workload using offsets d Click Apply 5 Click on the PItoPI tab a Configure the source PI Data Archive the server from which the interface is to read point data b Click Apply 6 Use the message log to verify the configuration a To display the message log launch PI SMT and choose Operation gt Message Logs b Using PI ICU start the interface interactively by choosing Interface gt Start Interactive or type Ctrl T c Watch the message log for messages that indicate success or errors Configure the Windows service Launch PI ICU and perform the following steps PI to PI Interface User guide 13 Installing and configuring the PI to PI Interface Pro
46. rovides detailed instructions for installing and configuring the interface A minimum functional configuration is described which you can adjust according to your requirements For details about features that are common to all Unilnt interfaces refer to the Unilnt Interface User Manual Before installing and configuring ensure that the following prerequisites are met e Verify that the source and target PI Data Archives are up and running e Verify that the interface node time zone is set correctly e On the interface node install the following OSIsoft Prerequisites PI Interface Configuration Utility PI ICU PJ API version 1 6 1 5 or greater which is installed with the interface For optimal security run the interface on the same computer as the most sensitive source PI Data Archive This configuration does not require you to create an opening in the firewall that protects the source server PI points on the target PI Data Archive must be configured to permit the interface to read and write data and attributes Points on the source PI Data Archive must be configured to permit the interface to read data and attributes The DataAccess and PtAccess point attributes control access to the point data and attributes Buffering is temporary storage of the data that the interface collects and forwards to the target PI Data Archive To ensure that you do not lose any data if the interface loses its connection with the target PI Data Archiv
47. s automatic and operates with no user interaction Each interface participating in failover has the ability to monitor and determine liveliness and failover status To assist in administering system operations the ability to manually trigger failover to a desired interface is also supported by the failover scheme The failover scheme is described in detail in the Unilnt Interface User Manual which is a supplement to this manual 26 PItoPI Interface User guide Installation checklist for the PI to PI Interface If you are not familiar with PI Interfaces refer to the detailed installation procedure in this guide If you are familiar with installing and configuring PI Interfaces this checklist covers the basic steps required to get the interface running Configure data collection is required Configure interface diagnostics and Configure advanced interface features are optional Topics in this section e Configure data collection e Configure interface diagnostics e Configure advanced interface features Configure data collection Procedure 1 Confirm that you can connect to the target PI Data Archive using PI System Management Tools SMT You do not need to run PI SMT on the same computer as this interface 2 Ifyou are running the interface on an dedicated node use PI SMT to define a trust that permits the interface to write data to the target PI Data Archive and a trust that permits the interface to read data from the source server
48. s receive archive or exception data from the source point Exception data is data that has not yet been subjected to compression By default all points belonging to the scan class 1 receive exception data PI points assigned to any other scan Class receive archive data The interface supports history recovery which recovers data for time periods when the interface was not running or unable to collect data The history recovery period is configurable and the default is eight hours Both source PI Data Archive level failover and Unilnt phase 2 interface level failover are supported When running in source PI Data Archive level failover mode the interface obtains data from one of two available source PI Data Archives To ensure that the interface obtains the same data regardless of which source server is active the source PI Data Archives must have identical point definitions and data streams for all interface source points In UniInt failover mode two copies of the interface are connected to the source PI Data Archive at the same time If the primary interface stops collecting data the backup interface assumes the primary role and continues data collection Failover maximizes interface data availability on the target PI Data Archive s Source PI Data Archive level failover and Unilnt Phase 2 interface level failover modes can be run simultaneously The following diagrams illustrate three basic hardware configurations for configuring the interface
49. ser guide 23 Features supported by the PI to PI Interface Note The PI to PI APS Connector contains a separate implementation of the procedure to identify the source point for an interface point If an interface instance is registered with APS consult the PI to PI APS Connector manual to confirm that the PI to PI APS Connector version implements the same procedure as the interface which is required to ensure that the PI to PI APS Connector synchronizes with the same source point as the interface Supports questionable bit The interface copies questionable bit data for a give source point from one PI Data Archive to another Uses PI SDK The PI SDK and the PI API are bundled together and must be installed on each PI Interface node This interface does not require the PI SDK Maximum point count The interface does not enforce any hard coded maximum for the number of points it can maintain but it is a single threaded process and its performance is affected by hardware network conditions and workload For details about monitoring interface performance refer to the Unilnt Interface User Manual Source of time stamps The source PI Data Archive provides a time stamp for each data event Time stamps are automatically adjusted to account for time zone differences The interface can also adjust time stamps for clock drift which is the time offset between PI Data Archives after accounting for time zone differences An offset of
50. ta Archive level failover support Source PI Data Archive level failover maximizes interface data availability on the target PI Data Archive s It enables the interface to obtain data from one of two source PI Data Archives Each source server must have identical point definitions and data streams for interface source points The interface initiates failover if the active source data becomes stale or is not available due to network issues The PI Interface Status Utility is required to monitor data quality for each source PI Data Archive The interface uses the utility status point output to verify that source data has not become stale Unilnt interface failover support Unilnt Phase 2 Failover provides support for cold warm or hot failover configurations Phase 2 hot failover results in a no data loss solution for bi directional data transfer between the PI Data Archive and the data source given a single point of failure in the system architecture similar to Phase 1 However in warm and cold failover configurations you can expect a small period of data loss during a single point of failure transition This failover solution requires two copies of the interface to be installed on different interface nodes collecting data PI to Pl interface User guide 25 Features supported by the PI to PI Interface simultaneously from a single data source Phase 2 Failover requires each interface to have access to a shared data file Failover operation i
51. ta to be recovered The starting point for history recovery is determined on a point by point basis If the current value for a point is more recent than the starting point of the recovery period history recovery begins at the point s current value to prevent data overlap streamline data retrieval and prevent out of order data For newly created points with no archive data the interface performs history recovery for the total recovery period History recovery is performed independently for each scan class Source data is written to the target archive in one of three modes append replace or no replace This setting is configured on a point by point basis The interface logs the progress of recovery By default during history recovery the interface also collects real time exception data every five seconds To configure this time interval using PI ICU go to the Optional tab and select the check box Set time interval between clearing exception queue during history recovery As it nears the end of its point list more points are in the update list and the time to collect exception updates increases This extra overhead can significantly increase the time required to complete history recovery By default history recovery bypasses compression testing on the target server when its version is PI Data Archive 3 3 or later Target PI Data Archives that are pre 3 3 always compression test incoming data Real time data collection During real tim
52. talS os rosee aerea aa aea castes 8 aa aa aae aea ip eqtegs E Osaa 3 Supported operating SySteMs ceccccceseeeeeeeseescesseecseeseeesesaeseceeseesaesaeeeceesaesaeseceeseesaeseseesesaesaseeseeseeeaesaseesats 3 fnt erface limitations cilss E E AE ees ei Sieg ee igi dishes elites 4 How the PI to PI Interface WOrkS ccccceeeeeeeeeeeeeeeee neces ee eesaaeeseaee eee eseeeessaaeeeaaeeeeeeees 5 Interface start pescst ce ith a a E A eh E earls eee 5 History FECOVEN i a a a E a a a a a a E a a E a a E EEO E EEEE 5 Real time data Collection ececccescecceeee cee eeeeeeeeee cee eeeeeaeeaeceeeeeesaesaesaessaasaesaesaeeassaeseeseensassaesaessessaeseeseeeeansas 6 Performance considerations cc 2sses e ra cette a aicli seb dealt edellaas 7 Data TYPeiCONVELSION sg ici ike s essccesoecueg ietivescasudecscaccsuaseecedvasescuecesatgetendssscaessvsctcrsesdecavassdcuduatsacesvasuocervescaierensen 8 Error handling isinne aa aa jigs AEE A tees es ida ladhotens inst Ea 8 Failover tor thelPlto Plilntertace sirinin eaea des AN eae et ees teed 8 Tracking inteitace Status sinanoba ai eed eA aA aana Aani 9 Installing and configuring the PI to PI Interface ccccceseeeeeeeeeeeeeeeeeeeeeeeeeeeeaueeeeeeeeeees 11 Installing the Pirito Pllintertace siirteen ees deta eee ee pt een deel pen aioe E ena 11 Configuring the Pl to Plilnterface aerisire a Ea a a aaa aaia 12 Create trusts on the source and target PI Data ArchiveS essssesesssssssrers
53. ted for source PI Data Archive failover 42 Plto Pl Interface User guide Command line parameters for the PI to PI Interface Parameter Description ssu1 tagname PI Interface Status Utility point name for the src_host source PI Data Archive Required ssul lt tagname gt Required for monitoring source data quality current or stale data ssu2 tagname PI Interface Status Utility point name for the sec_src source PI Data Archive Required ssu2 lt tagname gt Required for monitoring source data quality current or stale data Sample startup and configuration files The startup files for the interface reside in the directory 7PIHOME Interfaces PItoPI P IHOME is defined in 4WINDIR pipc ini by the installation program By default P IHOME is c pipc The startup files are e PItoPI bat Invokes the interface specifying run time settings are command line parameters e PItoPI ini Stores settings required for collecting data from multiple sources Do not edit these files manually Use PI ICU to configure the interface Topics in this section e Sample PItoPI batch file e Sample PItoPI configuration file Sample PItoPI batch file REM REM PItoPI bat REM REM Sample startup file for the PI to PI Interface REM REM REM OSIsoft strongly recommends using PI ICU to modify startup files REM REM Sample command line REM PItoPI exe host XXXXXX 5450
54. to PI Interface The following table shows the features that the interface supports Feature Auto creates PI points Support APS Connector Point Builder utility No ICU Control Yes PI point types All data types are supported Sub second time stamps Yes Sub second scan classes Yes Automatically incorporates PI point attribute Yes changes Exception reporting Yes Outputs from PI Data Archive No Inputs to PI Data Archive Scan based Unsolicited Event Tags Scan based only Supports questionable bit No Supports multi character PointSource Yes Maximum point count Unlimited Uses PI SDK No PINet string support No Source of time stamps Source PI Data Archive History recovery Yes Disconnected Startup Yes SetDeviceStatus Yes Failover Source PI Data Archive Level Unilnt Phase 2 Interface Level Warm Vendor Software Required on PI Interface Node No PINet Node Vendor Software Required on Foreign Device No Vendor Hardware Required No Additional PI Software Included with Interface No Device Point Types Real Integer and Digital Serial based Interface No APS Connector Additional details on interface features AutoPointSync is an OSIsoft product that keeps the point configuration of PI Data Archives in sync with each other The PI to PI APS Connector is required to use APS with this interface PI to Pl Interface U
55. u can use OSIsoft s Tag Configurator plug in for Microsoft Excel to import the points from the source PI Data Archive make any changes you need then export them to the target PI Data Archive When the interface loads a target point it must identify the source point from which data is to be collected If the name of the source and target points are identical no explicit mapping is required If the names differ you must explicitly map the source points to the target points There are three options for mapping source points to target points e Set the target point s InstrumentTag attribute to the name of the source point e Specify the name of the source point in the target point s ExDesc attribute using the STAG flag e Set the target point s UserInt1 attribute to the source point s PointID the unique numeric identifier of the source point displayed on the System tab of PI SMT s Point Builder tool This approach ensures that the mapping remains valid if the source point is renamed To configure the method that the interface uses to map points using PI ICU go to the PItoPI gt Optional tab select the Source tag definition attribute check box and choose the desired method Note Points in the source server might be added changed or deleted To replicate such changes to the target server automatically you can use OSIsoft s PI AutoPointSync APS with the PI to PI APS Connector For details consult the user manuals for
56. uning the optimal value is one that retrieves as much history as possible without consuming excessive memory MH x default 1000 Specify maximum number of exception events retrieved per data request The maximum number of exception events retrieved per data request A large count reduces the number of calls required for acquiring exception updates A small count reduces the time to complete each request for troubleshooting network timeout issues ME default 5000 Set time interval between clearing exception queue during history recovery Sets the time interval between clearing the exception queue on the source PI Data Archive for exception data scan classes By default the interface collects exceptions from the source PI Data Archive every five seconds during history recovery to prevent overflowing the queue To tune history recovery performance adjust this time interval RH_QCKECK default 5 Specify the freq that the interface calculates time offset between PI Servers Sets the frequency in seconds at which the interface calculates time offsets between PI Data Archives By default the interface calculates time offsets every 30 seconds OC default 30 Opt Cont tab e Source Host reconnection delay Specifies the amount of time that the interface waits before attempting to reconnect to the source PI Data Archive after being inadvertently disconnected by network problems Specify time in seconds minimum one second
57. ute override Ignore Location for each point and use the specified value Valid values are 0 3 ptid Optional Point ID of source PI point is specified in UserInt1 attribute Ignore InstrumentTag ExDesc and Tag PI point name attributes Note This switch is not compatible with source PI Data Archive failover because point IDs will not necessarily match between source PI Data Archives If the source PI Data Archives are part of a PI collective use tn instead tn Optional Source point name is same as interface point name Ignore InstrumentTag ExDesc and UserInt1 attributes tnex Optional Source point name is located in the ExDesc or Tag attribute and the InstrumentTag and UserInt1 attributes are ignored for identifying source point Source Data Archive level failover parameters Parameter Description fst tagname Name of failover status point Optional fst lt tagname gt where tagname is a digital point on the target PI Data Archive nt Number of re connection attempts to source PI server before initiating a failover Valid values are Optional Default nt 1 0 and greater Prevents failover flip flop when experiencing intermittent network updates sec_src node 5458 Required Name or IP address of the secondary source PI Data Archive sec_src node_name 545 The port number is 5450 for PI Data Archive 3 x PI Data Archive 2 x is not suppor
58. ve level failover support Source PI Data Archive level failover maximizes interface data availability on the target PI Data Archive s It enables the interface to obtain data from one of two source PI Data Archives Each source server must have identical PI point definitions and data streams for interface source points 8 Pi to PI Interface User guide How the PI to PI Interface works The interface initiates failover if the active source data becomes stale or is not available due to network issues The PI Interface Status utility is required to monitor data quality for each source PI Data Archive The interface uses the utility status point output to verify that source data has not become stale Unilnt interface failover support Unilnt Phase 2 Failover provides support for cold warm or hot failover configurations Phase 2 hot failover results in a no data loss solution for bi directional data transfer between the PI Data Archive and the data source given a single point of failure in the system architecture similar to Phase 1 However in warm and cold failover configurations you can expect a small period of data loss during a single point of failure transition This failover solution requires two copies of the interface to be installed on different interface nodes collecting data simultaneously from a single data source Phase 2 Failover requires each interface to have access to a shared data file Failover operation is automatic and oper
59. very begins with the first value after start time Requires Use history recovery only to be enabled Debug tab e Debug Parameters Check the types of debug messages that you want logged DB e Interface Status Tag on Target PI Server Specify the name of an interface status point that is configured on the target PI Data Archive server IST tagname Location tab The settings on this tab enable you to apply specific settings to the location codes of target PI points overriding the value they contain in the source server Ca through C5 Optional tab PI to Pl Interface User guide 31 PI ICU reference for the PI to PI Interface 32 Apply tag s compression specifications to data retrieved during history recovery Use compression specifications in point configurations to send data retrieved during history recovery with compression Usually data is retrieved from source server and sent to target server without compression during history recovery DC Source tag definition attribute Specifies how the interface determines the source to target point mapping By default the interface seeks a target point with the same name Tag attribute as the source point Specify maximum events to retrieve for a single point in each call to get history For target servers that are version 3 3 or higher sets the maximum number of events to retrieve for a single point with each attempt to retrieve history For performance t

PI to PI Interface User Guide

Contents

Download Pdf Manuals

Related Search

Related Contents