Proficy* Historian OPC C OLLECTOR G UIDE. Version 6.0 June 2015

Transcription

1 Proficy* Historian OPC C OLLECTOR G UIDE Version 6.0 June 2015

2 Disclaimer of Warranties and Liability The information contained in this manual is believed to be accurate and reliable. However, GE Intelligent Platforms, Inc. assumes no responsibilities for any errors, omissions or inaccuracies whatsoever. Without limiting the foregoing, GE Intelligent Platforms, Inc. disclaims any and all warranties, expressed or implied, including the warranty of merchantability and fitness for a particular purpose, with respect to the information contained in this manual and the equipment or software described herein. The entire risk as to the quality and performance of such information, equipment and software, is upon the buyer or user. GE Intelligent Platforms, Inc. shall not be liable for any damages, including special or consequential damages, arising out of the use of such information, equipment and software, even if GE Intelligent Platforms, Inc. has been advised in advance of the possibility of such damages. The use of the information contained in the manual and the software described herein is subject to GE Intelligent Platforms, Inc. standard license agreement, which must be accepted by the buyer or user before the use of such information, equipment or software. Trademark Notices 2015, General Electric Company. All rights reserved. Proficy is a trademark of GE Intelligent Platforms, Inc., a wholly-owned subsidiary of General Electric Company. * Indicates a trademark of General Electric Company and/or its subsidiaries. All other trademarks are the property of their respective owners. All other product names and marks identified throughout this book are trademarks or registered trademarks of their respective companies. They are used throughout this book in editorial fashion only. No such use, or the use of any trade name, is intended to convey endorsement or affiliation. No part of this publication may be reproduced in any form, or stored in a database or retrieval system, or transmitted or distributed in any form by any means, electronic, mechanical photocopying, recording or otherwise, without the prior written permission of GE Intelligent Platforms. Information contained herein is subject to change without notice. We want to hear from you. If you have any comments, questions, or suggestions about our documentation, send them to the following address: doc@ge.com

3 Table of Contents OPC Data Collectors... 1 Installing an OPC Collector... 1 To search for the ProgID of any OPC server:... 3 Modifying and Uninstalling OPC Collectors... 3 Summary of OPC Collector Features... 4 Tag Attributes Available In Browse (OPC Data Collectors)... 6 Selecting Data Types... 7 Configuration Tab for OPC Collectors... 8 Collector-Specific Configuration (OPC)... 9 Configuration of OPC Collector-Specific Fields Hierarchical OPC Browsing To browse for OPC tags in a hierarchy: OPC Group Creation GE Intelligent Platforms v7.x Drivers and Deadbands for the OPC Collector Steps to Change the Source Address for a Specified Item Example: Using Deadbands with the SI7 Driver Troubleshooting an OPC Collector that Fails to Start Tips for Reviewing the OPC Collector Log Messages If There is Not Enough Free Space for Buffer Files If The OPC Collector Tries to Start Before the OPC Server Fully Starts If the OPC Collector Hangs on First Polled Read Validating items before adding to Polled Collection Group Example: Delaying the Startup of the OPC Collector for the CIMPLICITY OPC Server iii

4 OPC Data Collectors The OPC Collector collects data from any OPC 1.0 or OPC 2.0 compliant OPC Server. The OPC Collector automatically determines the capability of the OPC Server to which it is connected and supports appropriate features based on this information. Refer to the following topics for more information: Installing an OPC Collector Modifying and Uninstalling OPC Collectors Summary of OPC Collector Features Tag Attributes Available In Browse (OPC Data Collectors) Selecting Data Types Configuration Tab for OPC Collectors Collector-Specific Configuration (OPC) Configuration of OPC Collector-Specific Fields Hierarchical OPC Browsing OPC Group Creation GE Intelligent Platforms v7.x Drivers and Deadbands for the OPC Collector Troubleshooting an OPC Collector that Fails to Start Installing an OPC Collector During installation of the OPC Collector, you are prompted to select from a list of OPC Server Prog IDs, as shown in the following graphic. Click Next. The Remote OPC Server Details screen appears. 1

5 Proficy Historian OPC Collector If you want to configure a remote OPC server, then follow the instructions given. Else, click Next button. 1. Enter the Remote OPC Server details (Machine name or the IP address of the server). 2. Enter the Prog ID. For example, for remote ifix OPC server, enter Intellution.OPCiFIX.1. 2

6 OPC Data Collectors NOTE: After install, you can change the Prog ID in the Historian Administrator. 3. Click Add Another OPC ProgID to add another remote OPC server. NOTE: Ensure that the remote OPC sever has DCOM configuration enabled. To search for the ProgID of any OPC server: 1. From Registry: or 1. Open regedit: Start -> Run -> RegEdit. 2. Search for CLSID of OPC server under My Computer\HKEY_CLASSES_ROOT\VendorName.OPC.Name.1 3. Using the CLSID value search for the ProgID. 2. Use any OPC client to find the ProgID of the OPC server. Install and operate the OPC Collector in the same way as the ifix Collector, including the Tag Browse and Add Tags functionality. The primary difference between the OPC Collector and the ifix Collector is that the ifix Collector uses EDA calls to get data and tag information, and the OPC Collector uses OPC. The OPC Collector also allows unsolicited collection, while ifix does not. Modifying and Uninstalling OPC 3

7 Proficy Historian OPC Collector Collectors To install an additional OPC Collector after completing the first install: NOTE: The OPC Server must be installed before performing these steps. 1. Run the Historian install program. The install program automatically detects and displays all installed components in the Select Components screen. 2. Ensure that the OPC Collector component is selected. 3. Click Next. As you continue with the install, a screen displays with a list of OPC ProgIDs. 4. Select the check box for each OPC Server ProgID that you want to install. To remove the last installed OPC Collector and add a new collector: 1. Run the Historian install program. The install program automatically detects and displays all installed components in the Select Components screen. Do not clear the check box next to any of the selected components unless you want to uninstall them. 2. Ensure that the OPC Collector component is selected. 3. Click Next. As you continue with the install, a screen displays with a list of OPC ProgIDs. 4. Deselect the check box for each OPC Server ProgID that you want to uninstall. If you installed multiple OPC Collectors and want to remove all of them, when you run the installation program, clear the OPC Collector check box, and proceed through the installation. This removes all installed OPC Collectors. Summary of OPC Collector Features The following table outlines the features of the OPC Collector. Feature Capability Browse Source For Tags (on OPC Servers that support browsing) Browse Source For Tag Attributes 4

8 OPC Data Collectors Feature Capability Polled Collection Minimum Poll Interval 100 ms Unsolicited Collection (OPC 2.0 Only) If you are using an OPC Collector with unsolicited data collection and have collector compression disabled, all new values should produce an exception. When the OPC Collector is doing unsolicited collection, the deadband percentage is determined by the collector deadband percent. You can only configure the collector deadband percent by enabling compression. Timestamp Resolution 1ms Accept Device Timestamps Floating Point Data Integer Data String Data Binary Data 5

9 Proficy Historian OPC Collector Feature Capability Python Expression Tags NOTE: You must set Time Assigned by field to Source if you have unsolicited tags getting data from an OPC Collector. Tag Attributes Available In Browse (OPC Data Collectors) The following table outlines the tag attributes available when browsing. Attribute Capability Tagname Source Address Engineering Unit Description, varies by OPC Server Vendor. Data Type. See Selecting Data Types. Hi Engineering Units, varies by OPC Server Vendor. Lo Engineering Units, varies by OPC Server Vendor. 6

10 OPC Data Collectors Attribute Capability Hi Scale No Lo Scale No Is Array Tag NOTE: While some of these attributes are queried on a browse, they are not shown in the browse interface. These attributes are used when adding a tag, but it is not visible to you if all attributes come from the server or not. Selecting Data Types The following table lists the data types recommended for use with Historian. OPC Data Type Recommended Data Type in Historian I1-16 bit signed integer Single Integer I4-32 bit signed integer Double Integer R4-32 bit float Single Float R8-64 bit double float Double Float UI2-16 bit unsigned single integer Unsigned Single Integer 7

11 Proficy Historian OPC Collector OPC Data Type Recommended Data Type in Historian UI4-32 bit unsigned double integer Unsigned Double Integer UI8-64 bit unsigned quad integer Unsigned Quad Integer I8-64 bit quad integer Quad Integer BSTR Variable String BOOL Boolean I1-8 bit single integer Byte NOTE: The OPC Collector requests data from the OPC server in the native data type. Then the OPC collector converts the received value to a Historian Data Type before sending it to the data archiver. Configuration Tab for OPC Collectors To display the Configuration Tab for an OPC Collector, select an OPC Collector from the list on the left and click the Configuration Tab. The screen shown in the following figure appears. 8

12 OPC Data Collectors Configuration Tab for OPC Collector Collector-Specific Configuration (OPC) The Configuration tab displays the following information. This Field... Indicates... OPC Server Prog ID The Program ID for the OPC Server that you want this collector to connect to. Read Mode Cache or Device, indicating the type of OPC reads the collector should perform. To change the mode, select the other option from the drop-down menu. Refer to your OPC Server documentation for more information. 9

13 Proficy Historian OPC Collector This Field... Indicates... First Browse Criteria Top-level search criteria for browsing tags from the data source. Top-level and second-level criteria are ANDed together for the browse. The final browse criteria, therefore, consists of a combination of first-level and second-level criteria ANDed together. Second Browse Criteria Second-level search criteria for browsing tags from the data source. Toplevel and second-level criteria are ANDed together for the browse. Threading Model The type of threading model selected for this collector. The model selected must match the threading model of the OPC Server. The default setting is multithreaded. Refer to your OPC Server documentation for more information. It is recommended that you configure your OPC Collector to use the default Multi threading model. Some OPC Servers do not work well with Multi threading. If you experience problems running your OPC Collector with Multi threading, change the threading model setting to the Apartment model. 10

14 OPC Data Collectors This Field... Indicates... Configuration Changes Whether your OPC Collector configuration changes are processed in real time or after shutting down and restarting the collector. Select the Made On-Line option to process any configuration changes immediately (after 30 seconds) when you click the Update button. Select the Made After Collector Restart option to hold all configuration changes until you manually stop and restart the OPC Collector. NOTE: To allow configuration changes, you also must enable the On- Line Tag Configuration Changes option on the Advanced tab of the Collector Maintenance screen. To manually restart the OPC Collector, stop and start the collector through the Services dialog box if you are running your OPC Collector as a service. For more information, refer to the Configuring an Historian Data Collector for Automatic Startup section of the Historian Data Collectors manual. If you are not running the collector as a service, open the OPC Collector's console window, type s, and press enter to shut down the collector. For more information, refer to Running Collectors as Console Applications section of the Historian Data Collectors manual. Starting and stopping the collector in the General Tab of the Collector Maintenance screen does not constitute a manual restart. You must either start and stop the collector from the Services dialog box or the Console application. NOTE: Certain OPC Servers cannot handle processing configuration changes online. If you experience any instability with changes made online, it is recommended that you set the Configuration Changes field on the Configuration tab of the OPC Collector to Made After Collector Restart. Configuration of OPC Collector- Specific Fields Enter values for the OPC Collector-specific field parameters through the OPC Collector Maintenance - Configuration Tab of the Historian Administrator. Descriptions for collector-specific fields are listed in the following table: 11

15 Proficy Historian OPC Collector This Field... Indicates... OPC Server Prog ID OPC Prog ID of the locally installed OPC Server. Read Mode Read Source (DEVICE or CACHE). See the OPC Specification on the OPC Foundation website. First Browse Criteria A comma separated list of criteria used as Filter 1 in a browse for tags. Second Browse Criteria A comma separated list of criteria used as Filter 2 in a browse for tags. Threading Model Multithreaded or Apartment. Use apartment threaded for best compatibility. Use multithreaded for better performance if your server is also multithreaded. Configuration Changes Certain OPC Servers cannot handle processing configuration changes online. This field allows you to select whether your OPC Collector configuration changes are processed in real time or after shutting down and restarting the collector. Select the Made On-Line option to process any configuration changes immediately when you click the Update button. Select the Made After Collector Restart option to hold all configuration changes until you manually stop and restart the OPC Collector. Starting and stopping the collector in the General Tab of the Collector Maintenance screen does not constitute a manual restart. You must either start and stop the collector from the Services dialog box or the Console window. For more information, refer to the Configuring the Data Collector for Automatic Startup and the Running Collectors as Console Applications sections of the Historian Data Collectors manual. Normally, changes are applied approximately 30 seconds after the last change. Note that the Tag Filters in First Browse Criteria and Second Browse Criteria are used to filter the tags 12

16 OPC Data Collectors returned on a browse. You can add multiple strings to each filter, separated by commas. If a filter is supplied, a tag must have one of the identified strings in the tagname in order to be returned. Consider the tags within a filter to be OR'ed and Filters 1 and 2 to be AND'ed. For example, USGB014 in Filter 1 and F_CV, B_CUALM in Filter 2 translates to: Give me all the tags that contain USGB014 AND contain F_CV OR B_CUALM. Hierarchical OPC Browsing If your OPC server supports hierarchical organization of your tags in a tree structure, Historian will use the server's hierarchy when browsing an OPC collector in the Non-Web Administrator. To browse for OPC tags in a hierarchy: 1. Browse your OPC data source for new tags 2. From the Collector list, select the OPC collector you wish to browse. A hierarchical tree appears in the Browse Results window. 3. To limit the displayed tags to only those that are not collected, from the Show Only list select Source Tags Not Collected. 13

17 Proficy Historian OPC Collector NOTES 4. To limit the displayed tags to match a tag name or tag description, enter the value to match in the Source Tag Name or Description text boxes. 5. Navigate to the node in the tree you want to browse, and then click Browse. The tags within the selected portion of the OPC tag hierarchy will be displayed. a. To browse automatically, select the AutoBrowse checkbox. The available tags will be displayed in the Browse Results window whenever a node is selected in the tree. b. To show all child elements within a hierarchy, enable the Show All Children checkbox. All tags at, or below the hierarchical level of the selected node in the tree will be displayed in the Browse Results window. 6. Select the tag or tags you want to add to Historian, and click Add Selected Tags. Collected tags will appear in black in the tag list. The Browse option for the OPC Collector will not return all items that reside in the Server configuration. Items that may not get returned include, but are not limited to, unsupported data types and user-defined items in some Simulation Servers. Occasionally, items that do not appear in the browse can still be added manually using the Add Tag Manually option. If you are browsing and adding tags with the OPC Collector, note that some OPC Collectors do not support data blocks with a length greater than 1. These OPC Servers can choose to show the first item in an array in the browse rather than show them all. For example, an OPC Server may contain 3000 analog values datablock:1 to datablock:3000, but would only show datablock:1. If you want to archive data from poll records of a length greater than 1, it is recommended that you use the Excel Add-In to configure a large block of tags - including the missing items - and add the tags. If you are unable to browse items on your OPC server containing forward slashes ( / ), you may have to change the default separator in your OPC Collector configuration. To do so, you will need to open the Windows Registry Editor and edit the HKEY_LOCAL_MACHINE\SOFTWARE\Intellution, Inc\iHistorian\Services\OPCCollector\[Collector Name]\OPCBrowseTreeSep key (where [Collector Name] is the name of your OPC collector) and change the string value to a character not present among your OPC Server item IDs. Typical values include,!, or &. Create this key if it does not already exist. If you are unable to browse readable items in your OPC server with the OPC collector, you may need to change the browse access mask used by the collector. To do so, you will need to open the Windows Registry Editor and edit the [HKEY_LOCAL_MACHINE\SOFTWARE\Intellution, Inc.\iHistorian\Services\OPCCollector\[Collector Name] (where [Collector Name] is the name of your OPC collector) and add DWORD key "OPCBrowseAccessRightsMask"=dword: Valid values are 0, 1, 2, 3 with 1 being the default. Use 0 or 3 if you are unable to browse readable items. Creating or changing the value takes effect on the next browse attempt and does not require a collector restart. 14

18 OPC Data Collectors OPC Group Creation It is recommended that you limit the number of OPC groups created by the Historian system to increase performance. To limit the number of OPC groups created on the OPC Server, consider grouping Historian tags (collected by the OPC Collector) using the least amount of collection intervals possible. GE Intelligent Platforms v7.x Drivers and Deadbands for the OPC Collector If you want to add items of different data types to Historian using the OPC Collector to a GE Intelligent Platforms v7.x driver/opc Server, and you are using deadbands, you must manually modify the Source Address for each item you add to specify the EGU range for that item. For other third party (non-ge Intelligent Platforms ) OPC Servers, refer to your OPC Server documentation for information on how the deadband works. Steps to Change the Source Address for a Specified Item To change the value of the Source Address field for each item that you add, follow these steps: 1. Select the item in Tag Maintenance screen. 2. Click the Collection tab. 3. Add the following fields to each tag's Source Address field: SIGNALCONDITIONING,LOWEGU,HIGHEGU,HARDWAREOPTIONS where SIGNALCONDITIONING, LOWEGU, HIGHEGU, and HARDWAREOPTIONS are the actual values that you want to use with the particular item. For example, you would change an item with a Source Address of Device0:M1015 to Device0:M1015 NONE,0,255,NONE. The 0 and 255 values correspond to the LOWEGU and HIGHEGU span of the item. Example: Using Deadbands with the SI7 Driver When you use the SI7 driver, it sets the global default values for engineering unit (EGU) limits used for deadband calculations to the following values: Lo EGU = 0 Hi EGU = EGU Span = Hi EGU LO EGU = You may want change the default values for this driver if the items that you add use data types other 15

19 Proficy Historian OPC Collector than Integers, such as Floats. If you want all items to use the same data type, you could change the settings for the HiEGU and LoEGU for the driver in the Registry Editor under the following key: \\HKEY_LOCAL_MACHINE\SOFTWARE\Intellution\Drivers\SI7\OPC\ItemDefaults. These values apply to all items not specified by the Source Address after you restart the driver. However, if all items do not use the same data type, as described previously in this section, you must manually modify the Source Address for each item you add in the Historian Administrator so that it includes the SIGNALCONDITIONING,LOWEGU,HIGHEGU,HARDWAREOPTIONS options. Troubleshooting an OPC Collector that Fails to Start If an OPC Collector fails to start when you restart your computer, it could be because: There is not enough free space for the collector to create its buffer files on startup. Historian is trying to run the OPC Collector before the OPC Server fully starts. To isolate the cause of the restart issue, review the OPC Collector log file in the C:\Proficy Historian Data\LogFiles folder, or the most recent log messages in the Windows Event Viewer. Once you determine what may be causing the issue, you can attempt to fix it by adding a new DWORD setting, MinimumDiskFreeBufferSize, in the Windows Registry for the OPC Collector. Tips for Reviewing the OPC Collector Log Messages When reviewing the OPC Collector log file, or the log messages from the Event Viewer, keep in mind: If you notice a message that states that Historian could not create the buffer files, then the issue is most likely that you do not have enough free space available for the buffer files. If you notice the OPC Collector connection attempt, a COM initialization attempt, and then a shutdown, the cause of the error is most likely that the OPC Collector is trying to start before the OPC Server fully starts. If you look at the log files and you do not see anything special, aside from a startup attempt and a shutdown message, then begin by assuming the OPC Server is not fully starting. If the workaround for that issue does not appear to work, try adjusting the buffer size. If There is Not Enough Free Space for Buffer Files... If it appears that there is not enough free space for the buffer files, either free up disk space, or change the buffer size in the Windows Registry by adding a new DWORD value, MinimumDiskFreeBufferSize, for the OPC Collector. As a recommendation, try using 10 or 20 MB as your buffer size value. If the problem still exists and then try slightly decreasing the value until you find one that works. 16

20 OPC Data Collectors To edit the buffer size from the Windows Registry: 1. Select Run from the Start Menu. The Run dialog box appears. 2. Type Regedit and press Enter. The Registry Editor appears. 3. Locate the ComputerName_OPC1_CollectorName key, where ComputerName is the name of your computer, OPC1 is an assigned value, and CollectorName is the name of your collector. You can find this key here: HKEY_LOCAL_MACHINE\SOFTWARE\Intellution, Inc.\iHistorian\Services\OPCCollector\ComputerName_OPC1_CollectorName 4. Add a new DWORD value. Enter the name MinimumDiskFreeBufferSize, select the decimal option, and set the value to a small number such as 10 or 20. The value that you enter represents the number of MB. 5. Close the Windows Registry and restart your computer. 6. If the Collector does not connect to the Historian Server, check the log file in the Logfiles folder on the collector computer again. If the log still states that Historian "could not create buffer files," then repeat steps 1-6, this time using a smaller number. Once the OPC Collector connects to the Historian Server, the collector should also appear in the Historian Administrator. Then, you can readjust the buffer file size on the bottom of the collector's General tab. If The OPC Collector Tries to Start Before the OPC Server Fully Starts... If it appears that the OPC Collector is starting before the OPC Server starts, you need to specify a time delay for the OPC Collector startup. To specify this time delay, you add a new DWORD value, MachineUpTimeDelay, in the Windows Registry for the OPC Collector. You can set the value of this DWORD to the number of seconds that you want the OPC Collector to delay it's startup. As a recommendation, try 120 seconds first. If the problem still exists and then try slightly increasing the value until you find one that works. If the OPC Collector Hangs on First Polled Read... If polled reads take more than a few seconds to start when the OPC collector is polling from your OPC server, you may need to change the First Read Mode used by the OPC collector. Specify the mode by using REGEDIT to create the DWORD value OPCFirstReadMode under the OPC collector. An exact REG file cannot be provided, since it is different for different OPC servers but here is an example: Windows Registry Editor Version 5.00 [HKEY_LOCAL_MACHINE\SOFTWARE\Intellution, Inc.\iHistorian\Services\OPCCollector\T20_OPC_Matrikon_OPC_Simulation] "OPCFirstReadMode"=dword: Valid values are 1 and 2, with 2 being the default. 17

21 Proficy Historian OPC Collector Use 1 to cause the collector to do a faster OPC_DS_CACHE read on first poll instead of the slower OPC_DS_DEVICE read. NOTE: Creating or changing the value requires a collector restart. Validating items before adding to Polled Collection Group To validate the items before adding them to the polled collection groups from the OPC collector, you may need to use OPCValidateBeforeAdd. Specify the mode by using REGEDIT to create the DWORD value OPCValidateBeforeAdd under the OPC collector. An exact REG file cannot be provided, since it is different for different OPC servers but here is an example: [HKEY_LOCAL_MACHINE\SOFTWARE\Intellution, Inc.\iHistorian\Services\OPCCollector\MYPC_OPC_Matrikon_OPC_Simulation] "OPCValidateBeforeAdd"=dword: Set the value to 1 if you want the OPC collector to validate the items before adding them to the polled collection. Example: Delaying the Startup of the OPC Collector for the CIMPLICITY OPC Server To add a startup delay for the OPC Collector for the CIMPLICITY OPC Server, follow these steps: 1. Select Run from the Start Menu. The Run dialog box appears. 2. Type Regedit and press Enter. The Registry Editor appears. 3. Locate the ComputerName_OPC1_CollectorName key, where ComputerName is the name of your computer, OPC1 is an assigned value, and CollectorName is the name of your CIMPLICITY collector. You can find this key here: HKEY_LOCAL_MACHINE\SOFTWARE\Intellution, Inc.\iHistorian\Services\OPCCollector\ComputerName_OPC1_CollectorName 4. Add a new DWORD value. Enter the name MachineUpTimeDelay, select the decimal option, and set the value to a small number such as 120. The value that you enter represents the number of seconds. 5. Close the Windows Registry and restart your computer. 6. If the OPC Collector still does not appear to start, check the log file in the Logfiles folder on the collector computer again. If the log states the same messages, then repeat steps 1-5 again, but this time increase the MachineUpTimeDelay value. 18