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

Transcription

1 Proficy* Historian OSI PI 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 OSI PI Distributor... 1 Summary of the OSI PI Distributor Features... 1 Before You Begin... 2 System Requirements (PI Distributor)... 3 Software Requirements... 3 Hardware Requirements... 3 Configuring the OSI PI Data Archiver for the OSI PI Distributor... 3 Tags Must be Created in OSI PI Before Running the OSI PI Distributor... 3 OSI PI Distributor Installation... 3 To configure multiple OSI PI Distributors:... 3 OSI PI Distributor Configuration... 4 Configuring the OSI PI Distributor... 5 Configuration of OSI PI Distributor-Specific Fields... 5 Example... 6 Tag Attributes Available in Browse (OSI PI Distributor)... 7 Recovery Mode (OSI PI Distributor)... 8 Supported Data Types (OSI PI Distributor)... 8 Notes on the OSI PI Distributor... 9 Data Quality Mapping... 9 Starting and Stopping the OSI PI Distributor... 9 iii

4

5 OSI PI Distributor The Historian OSI PI Distributor gathers data from Historian, and writes it to an OSI PI data server. Data can be written directly to the OSI PI Data Archive v3.2 or greater, via the OSI PI v or greater. Typically, the distributor is installed on the Historian server, distributing data to a remote OSI PI Data archive The OSI PI Distributor uses unsolicited distribution, whereby changes in Historian tags values are detected, and are forwarded to a remote OSI PI data server. The distributor is intended to duplicate data from an Historian archive to an OSI PI data archive. One OSI PI Distributor can distribute data to a single OSI PI data archive. To distribute to multiple OSI PI archives from an Historian archive, you will have to configure multiple OSI PI distributors. You can also configure multiple OSI PI distributors to a single OSI PI data archive. Summary of the OSI PI Distributor Features The following table outlines the features of the OSI PI distributor. Feature Capability Browse Source For Tags Browse Source For Tag Attributes Polled Collection No Minimum Poll Interval N/A Unsolicited Collection 1

6 Proficy Historian Distributor PI Feature Capability Time stamp Resolution milliseconds or seconds Accept Device Time stamps Floating Point Data Integer Data String Data Binary Data No Array Data No Collector Status Outputs Before You Begin Before you begin using the OSI PI Distributor, you should read the following topics: System Requirements (OSI PI Distributor) Configuring the OSI PI Data Archiver for the OSI PI Distributor 2

7 OSI PI Distributor System Requirements (PI Distributor) Software Requirements The following software is required to use the PI Distributor: OSI PI Data Archive v 3.2 or greater OSI PI v or greater Historian 3.0 or greater Hardware Requirements There are no additional hardware requirements for the PI Distributor. Configuring the OSI PI Data Archiver for the OSI PI Distributor In order for the OSI PI Distributor to write data to the OSI PI data archive, some configuration changes must be made to the OSI PI data server. Tags Must be Created in OSI PI Before Running the OSI PI Distributor Before using the OSI PI Distributor, you must create writable tags in the OSI PI data archive. In order for the OSI PI Distributor to write data to a OSI PI data archive, the destination tags must first be given write access in OSI PI. Consult your OSI PI documentation for more details. In addition to making the destination OSI PI data tags writable, you must also ensure that the OSI PI user the OSI PI Distributor is logging into the OSI PI data server with has write access to the OSI PI data archive. Consult your OSI PI documentation for more details. OSI PI Distributor Installation The OSI PI Distributor is automatically added to Historian when you install it, but is not configured for auto discovery of local OSI PI Data Archivers. In order to start distributing data to your OSI PI Data Archiver, the OSI PI Distributor must first be configured to connect to your OSI PI server. Refer to OSI PI Distributor Configuration for more information. If you want to distributo to more than one OSI PI Data Archive from Historian, you will need to install multiple OSI PI Distributors - one per OSI PI data archive. To configure multiple OSI PI Distributors: CAUTION: The following procedure is for advanced Windows users. If you are not familiar with Windows Registry editing, contact your Network Administartor for assistance. 3

8 Proficy Historian Distributor PI 1. From a command prompt, run the Registry Editor (regedit.exe). 2. Navigate to HKEY_LOCAL_MACHINE\SOFTWARE\Intellution, Inc.\iHistorian\Services\PIDistributor 3. Create a new key and give it a unique name. For example, AlbPI Edit the new registry key and add a string value named InterfaceName. 5. In the InterfaceName value, enter a name for the OSI PI Server's interface. The string "OSI PI" is reserved, and should not be used. 6. Add a second string value to the new key named Historian NodeName. 7. In the Historian NodeName value, enter the name of the Historian archive server to which the new distributor will be sending data. 8. Close the Registry Editor. 9. Open a command window. 10. From a command prompt, run the OSI PI Distributor and command it to use the new registry key, with the -multiple and REG= parameters. For example, if you named the registry key AlbPI01, you would use the following command: ihpidistributor.exe -multiple REG=AlbPI Configure the OSI PI Distributor NOTE: On a 64-bit Windows Operating System, all 32-bit components (such as collectors, client tools, and APIs) related registry keys will be located under HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\\Intellution, Inc.\iHistorian\. OSI PI Distributor Configuration For more information about configuring the OSI PI collector, refer to the following topics: Configuring the OSI PI Distributor Configuration of OSI PI Distributor-specific Fields Tag Attributes Available in Browse (OSI PI Distributor) Recovery Mode (OSI PI Distributor) Supported Data Types (OSI PI Distributor) Notes on the OSI PI Distributor Starting and Stopping the OSI PI Distributor 4

9 OSI PI Distributor Configuring the OSI PI Distributor To configure the OSI PI distributor, perform the following: 1. Start the Historian Administrator. 2. Select the Collectors screen. 3. Select the OSI PI Distributor you want to configure. 4. Configure the OSI PI Distributor's General options. Refer to Modifying General Collector Options for more information. a. (Optional) Enter a description for your OSI PI Distributor. b. (Optional) In the Computer Name field, enter the hostname of the computer your distributor is running on - localhost, for example. c. (Optional) If you wish to set limits on memory usage and free disk space, change the values in the Memory Buffer Size and Minimum Free Space fields. 5. Configure the OSI PI Distributor-specific options. Refer to Configuration of OSI PI Distributor-specific fields for more information. a. Click the Configuration tab. b. In the PI Server field, enter the OSI PI server name. For example, localhost. c. In the PI Username field, enter the OSI PI user name. For example, PIAdmin. d. If required, enter the OSI PI password into the PI Password field. This field can be left blank if no password is assigned for the OSI PI user. e. In the Max REcovery Time (hr) field, enter a new Maximum Recovery Time, in hours. By default, the maximum recovery time is 4 hours. 6. Configure the default distribution options. Refer to Tags Tab for more information. a. Click on the Tags tab. b. Enter a prefix to add to OSI PI tags in Historian. For example, PI_ c. Enter a value for the Collection Interval. The default collection interval is 1 second. 7. Configure the distributor's advanced settings. Refer to Advanced Tab (Collectors) for more information. a. To delay distribution when the distributor starts up, enter a value into the Delay Collection at Startup (sec) field. Configuration of OSI PI Distributor-Specific Fields The following table outlines the OSI PI Distributor-specific configuration fields. This field... Indicates... 5

10 Proficy Historian Distributor PI This field... Indicates... OSI PI Server The name of the computer that OSI PI is running on. OSI PI Username The user name required to connect to the OSI PI Data Archive. OSI PI Password The password required to authenticate with the OSI PI Data Archive. If no password is configured for the OSI PI user, this field can be left blank. Passwords are case-sensitive. Max Recovery Time (hr) The Maximum Recovery Time, in hours. See Recovery Mode (OSI PI Distributor) for more details. Example The following figure shows the OSI PI Distributor configured to distribute data to a OSI PI archive on localhost, logging in as the piadmin user. It is also configured for a maximum recovery time of 4 hours. 6

11 OSI PI Distributor Tag Attributes Available in Browse (OSI PI Distributor) You can specify tags for collection in Historian Administrator by browsing the distributor, or by adding tags manually. The following table outlines the tag attributes available when browsing: Historian Tag Browse Attribute OSI PI Tag Browse Source Address Tag DescriptionProperty Descriptor Engineering Unit Description Engunits Hi Engineering Units Zero + span 7

12 Proficy Historian Distributor PI Lo Engineering Units Zero When entering tags manually, it is important to match the Historian tag data type with the data type of the OSI PI tag. Refer to Supported Data Types (OSI PI Distributor) for more information. Regardless of how you add tags to Historian, you should match the time stamp resolution. If your OSI PI tag is using time stamps with milliseconds, then configure your Historian tag to store time stamps with milliseconds resolution as well. The OSI PI distributor reads data from the Historian tag displayed in the Tag Source Address field, and sends it to the OSI PI tag name displayed in the Spare 1 field. To control the source and destination tags, change the Tag Source Address and Spare 1 fields. Recovery Mode (OSI PI Distributor) Recovery logic is activated when the OSI PI Distributor and Historian reestablish a connection after a connection loss, or when the distributor is restarted. The OSI PI Distributor will attempt to recover all data samples between the current time and the last known write time, up to a maximum number of hours configured for the distributor. New distribution resumes only after the previous data has been recovered. The default recovery time available is 4 hours. You can disable recovery mode by setting the Maximum Recovery Time to 0 hours. To configure a maximum recovery time, perform the following: 1. Start the Historian Administrator. 2. Select the Collectors screen. 3. Select the OSI PI Distributor. 4. Click the Configuration tab. 5. In the Max Recovery Time (hr) field, enter a Maximum Recovery Time, in hours. If this field is left blank, the Maximum Recovery Time will be set to 4 hours. Supported Data Types (OSI PI Distributor) The following table maps OSI PI data types to their Historian data type equivalents: OSI OSI PI Tag Types Recommended Historian Data Type INT32 Single Integer, Double Integer 8

13 OSI PI Distributor OSI OSI PI Tag Types Recommended Historian Data Type FLOAT16, FLOAT32 Float DIGITAL, OSI PISTRING Variable String NOTE: The FLOAT64 (Double Float) data type is not supported by the OSI PI Distributor. Notes on the OSI PI Distributor Data Quality Mapping Data quality mapping from Historian to OSI PI Data Archive is restricted to good/bad. OSI PI's subtypes are not currently mapped by Historian. Starting and Stopping the OSI PI Distributor The OSI PI Distributor runs as a Windows service and can be controlled through the Services control panel. You must have Administrator rights to access the Services control panel. To Modify the OSI PI Distributor Service: 1. From the Start Menu, point at Settings, and then choose Control Panel. 2. Double-click the Administrative Tools control panel to open it. 3. Double-click the Services control panel to open it 4. Right-click the Historian PI Distributor service and select Properties.. 5. To have the Historian PI Distributor service start when Windows starts, set the Startup Type to Automatic. To have the Historian PI Distributor service start manually, set the Startup Type to Manual. 6. To start the service, click the Start button. To stop the service, click the Stop button. Other options are available in the Services control panel. For more information, refer to your Windows documentation. 9