Citect Interface
Download 0.67 Mb.
|
 Citect Interface
Version 3.0.2.x
Table of Contents Reference Manuals 5 Supported Operating Systems 5 Supported Features 5 Diagram of Hardware Connection 8 Location1 11 Location2 11 Command line Parameter Changes 12 UniInt Failover Changes 12 Input Points 13 Scan-based 13 Event-based 14 Output Points 14 Data Collection Steps 15 1.Confirm that you can use PI SMT to configure the PI Server. You need not run PI SMT on the same computer on which you run this interface. 15 2.If you are running the interface on an interface node, edit the PI Server’s Trust Table to allow the interface to write data. 15 3.Run the installation kit for the PI Interface Configuration Utility (ICU) on the interface node if the ICU will be used to configure the interface. This kit runs the PI SDK installation kit, which installs both the PI API and the PI SDK. 15 4.Run the installation kit for this interface. This kit also runs the PI SDK installation kit which installs both the PI API and the PI SDK if necessary. 15 5.Ensure that the Citect API DLL files are installed on the interface node where PI_Citect.exe is located. Read Installing the Citect API DLL Files for more information. 15 CtApi.dll 15 CtEng32.dll 15 CiDebugHelp.dll 15 CtRes32.dll 15 CtUtil32.dll 15 Ct_ipc.dll 15 6.If the interface is collecting data from version 6.0 of Citect, you may have to download the latest version of Citect (7.x or above) on a test machine and grab these .dll files and copy it in the interface folder. This is a known backward compatibility issues and this is the suggested way of fixing it. 16 7.If the interface is making connection to Citect Client process remotely (/Cihost parameter), make sure the citect.ini file in the ProgramData directory has this [CtAPI] Remote=1 entry. You can find this file in the directory at %ALLUSERSPROFILE% \Citect\CitectSCADA 7.20\Config. The environment variable ALLUSERSPROFILE is set as C:\ProgramData in Windows 7 by default and as C:\Documents and Settings\All Users in Windows XP by default. You can add this text to the top of the file: 16 [CtAPI] 16 Remote=1 16 8.Ensure that there are sufficient Citect API licenses available on the Citect node. 16 9.If you are running the interface on an interface node, check the computer’s time zone properties. An improper time zone configuration can cause the PI Server to reject the data that this interface writes. 16 10.Test the connection between the interface node and the Citect node using the PI_CitectTest.exe connection tester. 16 11.Run the ICU and configure a new instance of this interface. Essential startup parameters for this interface are: 16 12. Define digital states. Cit_Bad_Conn - an indicator of communication problems with the Citect node. 16 13.Build input tags and, if desired, output tags for this interface using the point builder utility PICitect_PointBuilder.exe. Important point attributes and their purposes are: 16 14.Start the interface interactively and confirm its successful connection to the PI Server without buffering. 16 15.Confirm that the interface collects data successfully. 16 16.Stop the interface and configure a buffering application (either Bufserv or PIBufss). When configuring buffering use the ICU menu item Tools Buffering… Buffering Settings to make a change to the default value (32678) for the Primary and Secondary Memory Buffer Size (Bytes) to 2000000. This will optimize the throughput for buffering and is recommended by OSIsoft. 16 17.Start the buffering application and the interface. Confirm that the interface works together with the buffering application by either physically removing the connection between the interface node and the PI Server Node or by stopping the PI Server. 17 18.Configure the interface to run as a Service. Confirm that the interface runs properly as a Service. 17 19.Restart the interface node and confirm that the interface and the buffering application restart. 17 Interface Diagnostics 17 1.Configure Scan Class Performance points. 17 2.Install the PI Performance Monitor Interface (Full Version only) on the interface node. 17 3.Configure Performance Counter points. 17 4.Configure UniInt Health Monitoring points 17 5.Configure the I/O Rate point. 17 6.Install and configure the Interface Status Utility on the PI Server Node. 17 7.Configure the Interface Status point. 17 Advanced Interface Features 17 1.Configure the interface for disconnected startup. Refer to the UniInt Interface User Manual for more details on UniInt disconnected startup. 17 20.Configure UniInt failover; see the UniInt Failover Configuration chapter in this document for details related to configuring the interface for failover. 17 Naming Conventions and Requirements 18 Interface Directories 19 PIHOME Directory Tree 19 Interface Installation Directory 19 Interface Installation Procedure 19 Installing the Citect API DLL files 19 Installing Interface as a Windows Service 20 Installing Interface Service with PI Interface Configuration Utility 20 Service Configuration 20 Installing Interface Service Manually 23
Testing the Connection to Citect 24 Connecting to Citect 24 Reading Points 25 Writing Points 25 Point Attributes 28 Tag 28 PointSource 29 PointType 29 Location1 29 Location2 29 Location3 29 Location4 29 Location5 30 InstrumentTag 30 ExDesc 30 Scan 31 Shutdown 32 Output Points 32 Trigger Method 1 (Recommended) 33 Trigger Method 2 33 Configuring the Interface with PI ICU 34 Citect Interface Page 37 General Tab 38 Debug Tab 39 Command-line Parameters 40 Sample PICitect.bat File 47 Introduction 48 Synchronization through a Shared File (Phase 2) 50 Configuring Synchronization through a Shared File (Phase 2) 51 22.Verify a successful interface start by reviewing the pipc.log file. The log file will contain messages that indicate the failover state of the interface. A successful start with only a single interface copy running will be indicated by an informational message stating “UniInt failover: Interface in the “Primary” state and actively sending data to PI. Backup interface not available.” If the interface has failed to start, an error message will appear in the log file. For details relating to informational and error messages, refer to the Messages section below. 52 23.Verify data on the PI Server using available PI tools. 52 24.Stop the primary interface. 52 25.Start the backup interface interactively without buffering. Notice that this copy will become the primary because the other copy is stopped. 52 26.Repeat steps 2, 3, and 4. 52 27.Stop the backup interface. 52 28.Start buffering. 52 29.Start the primary interface interactively. 52 30.Once the primary interface has successfully started and is collecting data, start the backup interface interactively. 52 31.Verify that both copies of the interface are running in a failover configuration. 52 32.Verify data on the PI Server using available PI tools. 53 33.Test Failover by stopping the primary interface. 53 34.Verify the backup interface has assumed the role of primary by searching the pipc.log file for a message indicating the backup interface has changed to the “UniInt failover: Interface in the “Primary” state and actively sending data to PI. Backup interface not available.” The backup interface is now considered primary and the previous primary interface is now backup. 53 35.Verify no loss of data in PI. There may be an overlap of data due to the queuing of data. However, there must be no data loss. 53 36.Start the backup interface. Once the primary interface detects a backup interface, the primary interface will now change state indicating “UniInt failover: Interface in the “Primary” state and actively sending data to PI. Backup interface available.” In the pipc.log file. 53 37.Verify the backup interface starts and assumes the role of backup. A successful start of the backup interface will be indicated by an informational message stating “UniInt failover: Interface in “Backup state.” Since this is the initial state of the interface, the informational message will be near the beginning of the start sequence of the pipc.log file. 53 38.Test failover with different failure scenarios (e.g. loss of PI connection for a single interface copy). UniInt failover guarantees no data loss with a single point of failure. Verify no data loss by checking the data in PI and on the data source. 53 39.Stop both copies of the interface, start buffering, start each interface as a service. 53 40.Verify data as stated above. 53 41.To designate a specific interface as primary. Set the Active ID point on the Data Source Server of the desired primary interface as defined by the /UFO_ID startup command-line parameter. 53 Configuring UniInt Failover through a Shared File (Phase 2) 54 Start-Up Parameters 54 Failover Control Points 56 PI Tags 57 Detailed Explanation of Synchronization through a Shared File (Phase 2) 61 Steady State Operation 62 Failover Configuration Using PI ICU 64 Create the Interface Instance with PI ICU 64 Configuring the UniInt Failover Startup Parameters with PI ICU 64 Creating the Failover State Digital State Set 65 Using the PI ICU Utility to create Digital State Set 65 Using the PI SMT 3 Utility to create Digital State Set 66
Creating the UniInt Failover Control and Failover State Tags (Phase 2) 69 Windows 71 Starting Interface as a Service 73 Stopping Interface Running as a Service 73 Which Buffering Application to Use 74 How Buffering Works 74 Buffering and PI Server Security 75 Enabling Buffering on an Interface Node with the ICU 76 Choose Buffer Type 76 Buffering Settings 76 Buffered Servers 79 Installing Buffering as a Service 82 Scan Class Performance Points 85 Performance Counters Points 88 Performance Counters 89 Performance Counters for both (_Total) and (Scan Class x) 89 Performance Counters for (_Total) only 90 Performance Counters for (Scan Class x) only 93 Interface Health Monitoring Points 94 1.the number of scan-based input values the interface collects before it performs exception reporting; and 96 48.the number of event-based input values the interface collects before it performs exception reporting; and 96 49.the number of values that the interface writes to output tags that have a SourceTag. 96 I/O Rate Point 99 Interface Status Point 101 Message Logs 103 Fatal Errors 103 Serious Errors 103 Point Errors 104 Warnings 104 System Errors and PI Errors 105 UniInt Failover Specific Error Messages 105 Informational 105 Errors (Phase 1 & 2) 107 Errors (Phase 2) 108 Configuration Tab 110 Digital Sets Tab 113 Point Builder Tab 116 Before You Call or Write for Help 121 Help Desk and Telephone Support 121 Search Support 122 Email-based Technical Support 122 Online Technical Support 122 Remote Access 123 On-site Service 123 Knowledge Center 123 Upgrades 123 OSIsoft Virtual Campus (vCampus) 123
|