Rockwell-automation FactoryTalk Historian SE 3.0 UniInt Interface User Manual de usuario

UNIINT INTERFACE USER MANUAL PUBLICATION HSEUNI-UM001A-EN-E–July 2012

Interface Startup Parameters 4 Software\FactoryTalk Historian\PIPC\interfaces" and /path="C:\Program Files\Rockwell Software\FactoryTalk His

UniInt Failover Scheme 94 Primary Stops Updating Heartbeat Point for less than 5 Intervals This situation might occur if the primary interface copy fa

UniInt Interface User Manual 95 ACPoint Values1 2 3 4Time1 Second Intervals6 7 85B1514131211...43210012IF1 StatePrimaryBackupOffPrimaryBackupOff015

UniInt Failover Scheme 96 Interfaces Connect to Data Source at Approximately the Same Time There may be a chance where both copies of the interface co

UniInt Interface User Manual 97 Refer to Figure 7,below which describes the failover action when both interface copies start at the same time and t

UniInt Failover Scheme 98 Time Action T+0 Both interfaces are running with IF1 in the primary role. T+2.1 IF2 reads the ActiveID and IF1‟s heartbeat.

UniInt Interface User Manual 99 Error and Informational Messages Error messages that are written to the message log are prepended by a string NameI

Error and Informational Messages 100 Error Descriptions on Windows On Windows, descriptions of system and PI errors can be obtained with the pidiag ut

UniInt Interface User Manual 101 Index Attribute Point CompDev, 19 CompDevPrecent, 19 CompMax, 19 CompMin, 19 Compressing, 18 DigitalSet, 21 ExcDe

Error and Informational Messages 102 Command-line, 3 Performance point, 26 Performance summary, 27 PI errors, 99 PI point Definition of, 15 Interface

UniInt Interface User Manual 5 Standard Parameters These command-line parameters are used in the every-day running of an interface. This table does

Interface Startup Parameters 6 Parameter Description Point Loading 0x0040 Time Functions 0x0400 Digital State Caching 0x2000 /DisableCounters Option

UniInt Interface User Manual 7 Parameter Description an offset of 5 seconds, and the second scan class has a scanning frequency of 7 seconds with n

Interface Startup Parameters 8 Parameter Description adhere to a wall clock for this particular scan class. Periods of 2, 3, 4, 6, 8, 12, or 24 hours

UniInt Interface User Manual 9 Parameter Description /host=host:port Optional Default = default Historian Server from the pilogin.ini file. The /h

Interface Startup Parameters 10 Parameter Description the /id parameter (such as /in, /ic, etc) to identify the copy of an interface. Consult the inte

UniInt Interface User Manual 11 Parameter Description /PISDK=# Optional Default = 0 The /pisdk parameter can be used to enable or disable the PI S

Interface Startup Parameters 12 Parameter Description /SVCEventsTO=# Optional Default = 500 msec The /SvcEventsTO=x controls the Service Events TimeOu

UniInt Interface User Manual 13 Parameter Description /stopstat=digstate or /stopstat /stopstat only is equivalent to /stopstat="Intf Shut&qu

Contact Rockwell Automation Customer Support Telephone — 1.440.646.3434 Online Support — http://www.rockwellautomation.com/support Copyright Notice ©

Interface Startup Parameters 14 Parameter Description /updateinterval=# Optional Default = 120 seconds This parameter can be used to adjust the interv

UniInt Interface User Manual 15 Historian Point Configuration What are Historian Points? The Historian point is the basic building block for contro

Historian Point Configuration 16 user‘s manual for detailed discriptions of the Historian Point Attributes that are relavant to the interface. The fo

UniInt Interface User Manual 17 PI API Historian Server PI SDK Maximum Length na Below 2.x Disabled 1 Below 1.6 na Disabled 1 na na Enabled 100 Cas

Historian Point Configuration 18 The exception specification attributes are used to define exception-reporting specifications. Exception reporting is

UniInt Interface User Manual 19 CompDev, CompMin, CompMax, CompDevPercent These are the compression specifications. CompDev is the compression devi

Historian Point Configuration 20 or equal to the Zero attribute and less than or equal to the Zero attribute plus the Span attribute. The TypicalValue

UniInt Interface User Manual 21 ExDesc This is the extended descriptor attribute. The extended descriptor is a string attribute. Please refer to th

Historian Point Configuration 22 New API functions Interface Requires SDK /PISDK Startup Parameter Max Tag Name Max Instrument Tag Max Extended Descr

UniInt Interface User Manual 23 timestamp of the previous value. This is different than the trigger mechanism for output points. For output points,

UniInt Interface User Manual iii Table of Contents Introduction ...

Historian Point Configuration 24 example, to write a value to a register in a PLC, one would use an output point. Each interface has its own rules for

UniInt Interface User Manual 25 I/O Rate Points I/O Rate points are used to monitor the data collection rate of an interface. An I/O Rate point can

Historian Point Configuration 26 pipc.ini file, which is located in the %windir% directory. If both are specified, the PIPCSHARE entry takes precedenc

UniInt Interface User Manual 27 specified if there is only one copy of an interface that is associated with a particular point source. 2. Set Loca

Historian Point Configuration 28 For Windows-based interfaces, PI SDK support is available beginning with version 3.2.0 of UniInt. UniInt uses the PI

UniInt Interface User Manual 29 Interface Operation Libraries UniInt 3.1.6 and lower versions use the PI API instead of the PI SDK. The PI API is

Interface Operation 30 be established before the interface will continue. If the interface is started while the Historian Server is down, the interfac

UniInt Interface User Manual 31 Time UniInt 3.x handles time differently depending upon whether or not UniInt is running in extended PI API mode. A

Interface Operation 32 However, the interface specific documentation must be consulted to determine the exact manner in which time is handled. UTC tim

UniInt Interface User Manual 33 Windows Performance Counters Counters are used to provide information as to how well an application, service, or dr

Introduction iv Windows Performance Counters ... 33 Requi

Windows Performance Counters 34 where service_name is the interface executable name without the .exe extension and ServiceID is a service identifier t

UniInt Interface User Manual 35 Viewing Performance Counter Data The values that are written to the performance counters can be viewed with the Win

Windows Performance Counters 36 Counter Name Description IO Rate (events/second) The number of events per second received by the interface. If this co

UniInt Interface User Manual 37 counters will be installed. If performance counters are already installed, then the total number of counters for th

Windows Performance Counters 38 The pictrdll.dll should be installed with version 1.3.4 and greater of the PI API in the PIPC\bin\ directory.

UniInt Interface User Manual 39 Interface Health Points There are several different types of points that may be used to monitor the health of an

Interface Health Points 40 The third type of points used to monitor interfaces is the Interface Information point. This point is different than any of

UniInt Interface User Manual 41 Trigger Rate [UI_TRIGGERRATE] Integer Heartbeat Reporting Period Trigger Bad Value Rate [UI_TRIGGERBVRATE] Integer

Interface Health Points 42 General Interface Health Tags The general interface health tags pertain to the operation of the interface in general. A lis

UniInt Interface User Manual 43 Device Status ExDesc Keyword: [UI_DEVSTAT] Update Interval: On startup, on change, and shutdown. Description: The

UniInt Interface User Manual v Remote Cache Builds ... 65 Mess

Interface Health Points 44 Update Interval: Based on heartbeat tag update. Description: Counts number of all values (inputs, outputs, triggered inputs

UniInt Interface User Manual 45 Counts number of output tag events that are sent to Historian before exception processing whose status is anything

Interface Health Points 46 tags configured to monitor a particular scan class, the Historian tag attribute Location4 must be set to a valid scan class

UniInt Interface User Manual 47 Description: The Scan Class Bad Value Rate Tag is used to calculate all the bad values being sent to Historian befo

Interface Health Points 48 Scan Class Scan Time ExDesc Keyword: [UI_SCINSCANTIME] Update Interval: At the completion of associated scan class. Descri

UniInt Interface User Manual 49 Interface Disconnected Startup Interfaces built with UniInt version 4.3.0.x or later include functionality to take

Interface Disconnected Startup 50 Interface  The interface must be built against UniInt version 4.3.0.x or later.  The interface node must have PI

UniInt Interface User Manual 51 Point Synchronization and Historian Server Connections An interfaces using the disconnected startup configuration h

Interface Disconnected Startup 52 enabled. Once satisfied with interface operation and data collection, enable disconnected startup as described in th

UniInt Interface User Manual 53 As a general rule, disconnected startup will not be supported if the Historian SDK is needed for the interface to s

Introduction vi Error and Informational Messages... 99 Mess

Interface Disconnected Startup 54 Startup Command File Configuration Note: The disconnected startup feature can not be used if the interface is using

UniInt Interface User Manual 55 Sample Interface Startup Files The following is an example of an interface configured for Disconnected Startup. In

Interface Disconnected Startup 56 Figure 1: ICU configuration screen showing the UniInt Disconnected Startup parameters. Configuring for Disconnec

UniInt Interface User Manual 57 Figure 2: ICU configuration screen displaying a message that the time slice entered for the “Cache synchronizatio

Interface Disconnected Startup 58 Figure 3: ICU configuration screen with the “Enable PI SDK” radio button selected. In this configuration, the “UniI

UniInt Interface User Manual 59 Figure 4: ICU configuration screen with UniInt version 4.0.0.0. The UniInt version must be 4.3.0.x or later in ord

Interface Disconnected Startup 60 Operation To configure the interface for disconnected startup operation, the required /CacheMode parameter must be

UniInt Interface User Manual 61 Creation CAUTION: The interface will create a point cache file and digital set cache file necessary for the disconn

Interface Disconnected Startup 62 Validation CAUTION: Users must not modify the caching files created by the interface. User modification of either of

UniInt Interface User Manual 63 The point cache file is constructed in a similar fashion to the digital cache file. During interface startup, the i

UniInt Interface User Manual 1 Introduction UniInt is an abbreviation for Universal Interface. UniInt is a framework for interfaces to the Historia

Interface Disconnected Startup 64  Retrieve event counter point configuration.  Retrieve system digital state set if requested.  Retrieve point

UniInt Interface User Manual 65 Server becomes disconnected for any reason, point synchronization will be restarted upon reconnection to the Histor

Interface Disconnected Startup 66 Messages The following are examples of typical informational and error messages that can be found in the pipc.log fi

UniInt Interface User Manual 67 21-Nov-06 16:57:51 WriteSeconds.exe>Historian-API> Successfully created cache file: c:/pipc/interfaces/tes

Interface Disconnected Startup 68 cache file, but the file has not been constructed with point record and attributes information. This message also in

UniInt Interface User Manual 69 29-Nov-06 15:45:08 Historian-WriteSeconds 1> Disconnected Startup is not available with PI API prior to Version

Interface Disconnected Startup 70 Troubleshooting Interface Operation Problem: On restart, the interface is not loading all Historian Points with a f

UniInt Interface User Manual 71 3. Delete the cache files. 4. Restart the interface to generate new cache files.

UniInt Interface User Manual 73 UniInt Failover Scheme Introduction The UniInt failover scheme provides for a hot failover, no data loss solution g

Introduction 2 Document Description Release notes for UniInt (UniIntReleaseNotes. doc) Release notes contain specific information about a particular

UniInt Failover Scheme 74 Business Network Proce

UniInt Interface User Manual 75 Configuring UniInt Failover Start-Up Parameters The following table lists the start-up parameters used by UniInt F

UniInt Failover Scheme 76 Parameter Value Description Host Historian Server for Exceptions and Historian tag updates Computer: IF-Node2 /Host=Secondar

UniInt Interface User Manual 77 Historian Tags The following table lists the required UniInt Failover Control Historian tags, the values they will

UniInt Failover Scheme 78 Historian Tag Value Description Heartbeat 2 Input Tag Exdesc: [UFO_HEARTBEAT:2] Updated by the Interface on IF-Node2 Values

UniInt Interface User Manual 79 Historian Tag Value Description State 2 Tag Exdesc: [UFO_STATE:2] Normally updated by the Interface on IF-Node2. Ma

UniInt Failover Scheme 80 only the control points on the data source are monitored. However, values are echoed to the Historian Server for the user to

UniInt Interface User Manual 81 Steady State Operation Steady state operation is considered the normal operating condition. In this state, the prim

UniInt Failover Scheme 82 interface is in a good status as determined by the backup. If the backup interface transitions to the primary, it will have

UniInt Interface User Manual 83 Failover ID In a failover interface installation, each copy of the interface has its own unique positive integer id

UniInt Interface User Manual 3 Interface Startup Parameters Startup parameters determine the behavior of an interface. This chapter documents the a

UniInt Failover Scheme 84 Input Data The term input data refers to data that originates on the data source and is collected by the interface and then

UniInt Interface User Manual 85 Primary Interface When an interface is installed in a failover configuration, only one copy will be actively sendin

UniInt Failover Scheme 86  The primary interface is stopped.  On exit, the primary interface writes a value of 0 to its heartbeat point and to the

UniInt Interface User Manual 87 1514131211...43210Active_ID012IF1 StatePrimaryBackupOffPrimaryBackupOff1 2 3 4TimeBA0Point Values1 Second Intervals

UniInt Failover Scheme 88 Primary Interface Stops Updating Heartbeat Point There are a number of situations that can cause an interface to stop updati

UniInt Interface User Manual 89 1 2 3 4 5 6 7 8TimeBDDAC0Point Values1 Second Intervals1514131211...43210012IF1 StatePrimaryBackupOffPrimaryBackupO

UniInt Failover Scheme 90 Manual Failover Initiating a manual failover requires that the backup interface be in a state equal to or better than the cu

UniInt Interface User Manual 91 1 2 3 4TimeBAPoint Values1 Second IntervalsC1514131211...43210012IF1 StatePrimaryBackupOffPrimaryBackupOff015141312

UniInt Failover Scheme 92 Primary Interface Loses Connection to Historian Server Users may have criteria dependent upon continuous data flow to Histor

UniInt Interface User Manual 93 BACPoint ValuesB1 2 3 4Time1 Second Intervals313029…1817-1413...10012IF1 StatePrimaryBackupOffPrimaryBackupOff01514