<p>DeltaV Smart Connector to the PI System</p><p>DeltaV versions 10.3. or greater</p><p>Version 1.0.1.x Revision A</p><p>Copyright © 2008-2009 OSIsoft, Inc. OSIsoft, Inc. OSIsoft Australia 777 Davis St., Suite 250 Perth, Australia San Leandro, CA 94577 USA Auckland, New Zealand (01) 510-297-5800 (main phone) (01) 510-357-8136 (fax) OSI Software GmbH (01) 510-297-5828 (support phone) Altenstadt, Germany http://techsupport.osisoft.com OSIsoft Asia Pte Ltd. [email protected] Singapore Houston, TX Johnson City, TN OSIsoft Canada ULC Longview, TX Montreal, Canada Mayfield Heights, OH Philadelphia, PA Calgary, Canada Phoenix, AZ Savannah, GA OSIsoft, Inc. Representative Office Yardley, PA Shanghai, People’s Republic of China OSIsoft Japan KK Tokyo, Japan OSIsoft Mexico S. De R.L. De C.V. Mexico City, Mexico OSIsoft do Brasil Sistemas Ltda. Sao Paulo, Brazil </p><p>Sales Outlets/Distributors Middle East/North Africa South America/Caribbean Republic of South Africa Southeast Asia Russia/Central Asia South Korea Taiwan </p><p> www.osisoft.com</p><p>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, Inc. </p><p>OSIsoft, the OSIsoft logo and logotype, PI Analytics, PI ProcessBook, PI DataLink, ProcessPoint, Sigmafine, Analysis Framework, PI Datalink, IT Monitor, MCN Health Monitor, PI System, PI ActiveView, PI ACE, PI AlarmView, PI BatchView, PI ManualLogger, PI ProfileView, ProTRAQ, RLINK, RtAnalytics, RtBaseline, RtPortal, RtPM, RtReports and RtWebParts are all trademarks of OSIsoft, Inc. All other trademarks or trade names used herein are the property of their respective owners.</p><p>RESTRICTED RIGHTS LEGEND</p><p>Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph I(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 Table of Contents</p><p>Introduction...... 1 Reference Manuals...... 1 Supported Features...... 1 Diagram of Hardware Connection...... 4</p><p>Overview of a Smart Connector...... 5 Installation...... 5 Principles of Operation...... 5 DeltaV Configuration Data...... 5 AF 2.0 Object Creation and Configuration...... 7</p><p>Installation Checklist...... 9</p><p>Smart Connector Installation...... 11</p><p>Buffering...... 13</p><p>Appendix A: Error and Informational Messages...... 15 Message Logs...... 15 System Errors and PI Errors...... 15</p><p>Revision History...... 17</p><p>DeltaV Smart Connector to the PI System iii Introduction</p><p>The DeltaV Smart Connector for the Emerson DeltaV system is a term used to relate all the components needed to allow the new “embedded” option of an Enterprise PI Server and DeltaV Smart Connector on a DeltaV v10.3 Application Station. The Enterprise PI Server is installed separately and integrated into the DeltaV engineering and operations environments much like the DeltaV Continuous Historian. Integration of the embedded Enterprise PI historian is accomplished through the use of a new DeltaV interface known as the DeltaV Smart Connector which includes the: PI AF Client, PI OPC Data Access (DA) interface and the DeltaV Asset Connector. There are three main tasks of the DeltaV Smart Connector:  Create PI Points automatically.  Collect time-series data and send it to the PI System through the PI OPC DA Interface.  Create AF Objects automatically. Reference Manuals</p><p>OSIsoft  DeltaV Asset Connector to the PI System manual  PI Server manuals  AF manuals  PI API Installation manual  UniInt Interface User  PI OPC DA Interface Manual  PI OPC DA Interface Failover Manual Supported Features</p><p>Feature Support Part Number PI-SC-EM-DV-NTI * Platforms Windows XP, Server 2003, Vista, Server 2008 * Automatic Creation of PI Points Yes * Automatic Creation of AF Objects Yes APS Connector No ICU Control Yes PI Point Types Int16 / Int32 / Float16 / Float3 / Digital/ String</p><p>DeltaV Smart Connector to the PI System 1 Introduction</p><p>Feature Support Sub-second Timestamps Yes Sub-second Scan Classes No Automatically Incorporates PI Point Yes Attribute Changes Exception Reporting Yes Outputs from PI No Inputs to PI: Scan-based / Unsolicited / Unsolicited Event Tags Supports Questionable Bit Yes Supports Multi-character PointSource Yes Maximum Point Count Unlimited * Uses PI SDK Yes PINet String Support No * Source of Timestamps DeltaV / PI History Recovery No * UniInt-based Yes * Failover Server-level Failover; Interface-Level Failover Using UniInt Phase 1; Interface-Level Failover Using Microsoft Clustering Vendor Software Required on PI Smart Yes Connector Node * Vendor Software Required on Foreign Yes Device * Vendor Hardware Required Yes Additional PI Software Included with No Smart Connector * Device Point Types Int16, int32, float16, float32, String, Digital Serial Based No * See paragraphs below for further explanation.</p><p>Platforms The DeltaV Smart Connector is designed to run on the above listed Microsoft Windows operating systems. The DeltaV Smart Connector also requires Microsoft .NET 3.0. Because it is dependent on vendor software, newer platforms may not yet be supported. Please contact OSIsoft Technical Support for more information.</p><p>2 Automatic Creation of PI Points The DeltaV Smart Connector creates and configures all PI Points needed for collection of time-series data. PI Points are created if the enterprise historian configuration file, (Enthist.xml) is present on startup and each time the file is updated.</p><p>Automatic Creation of AF Objects The DeltaV Smart Connector creates AF objects such as Element Templates, Attribute Templates, Elements, and Attributes based on the asset information received from the DeltaV system contained in the DeltaV equipment hierarchy file (equiphier.xml). The DeltaV equipment hierarchy file is exported manually from the DeltaV Explorer. Assets are initially created after the initial creation of PI points.</p><p>Uses PI SDK The PI SDK and the PI API are bundled together and will be installed on each PI Smart Connector node. This Smart Connector specifically makes PI SDK calls to create and edit PI Points. </p><p>Source of Timestamps Timestamps are received from the foreign system or the PI Server depending the how the OPC interface is configured.</p><p>UniInt-based UniInt stands for Universal Interface. UniInt is not a separate product or file; it is an OSIsoft-developed template used by developers and is integrated into many interfaces and Smart Connectors, including this Smart Connector. The purpose of UniInt is to keep a consistent feature set and behavior across as many of OSIsoft’s interfaces and Smart Connectors as possible. It also allows for the very rapid development of new interfaces and Smart Connectors. In any UniInt-based Smart Connector, the Smart Connector uses some of the UniInt-supplied configuration parameters and some Smart Connector -specific parameters. UniInt is constantly being upgraded with new options and features. The UniInt Interface User Manual is a supplement to this manual.</p><p>Failover  Server-Level Failover The interface supports server-level failover that allows collecting data from either primary or backup OPC Servers. This feature is built into the interface and does not require any additional hardware or software. See OPC DA Interface Failover Manual for more details  Interface-Level Failover using UniInt This interface supports Interface-Level Failover using UniInt, as well as Interface-Level Failover using Microsoft Clustering. UniInt provides support for a hot failover configuration which results in a no data loss solution for bi-directional data transfer between the PI Server and the Data Source given a single point of failure in the system architecture. This failover solution requires that two copies of the interface be installed on different interface nodes collecting data simultaneously from a single data source. Failover operation is automatic and operates with no user interaction. Each </p><p>DeltaV Smart Connector to the PI System 3 Introduction</p><p> 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. This type of failover does not require a special type of hardware or software (e.g. a Microsoft Cluster). The failover scheme is described in detail in the UniInt Interface User Manual, which is a supplement to this manual. Details for configuring this Interface to use failover are described in the “UniInt Failover Configuration” section of the OPC DA Interface Failover Manual.  Interface-Level Failover using Microsoft Clustering This type of failover allows two copies of the interface to run on two clustered machines, with only one copy actually collecting data at any given time. This failover option can be combined with the Server-Level Failover, so that the user can have redundancy for both the OPC server and the interface. Details of configuring the failover are documented in the OPC DA Interface Failover Manual.</p><p>Vendor Software Required on Foreign Device DeltaV version 10.3 or later</p><p>Vendor Hardware Required DeltaV Application Station.</p><p>Device Point Types Int16, Int32, Float16, Float32, String, and Digital device point types are supported in the DeltaV System.</p><p>4 Diagram of Hardware Connection</p><p>DeltaV Smart Connector to the PI System 5 Overview of a Smart Connector</p><p>The DeltaV Smart Connector handles all actions necessary to connect to and mine data from the DeltaV 10.3 system in order to populate and send data to both a PI Server and an AF 2.x Server. The DeltaV Smart Connector automatically creates and configures PI Points, stores time-series data in PI through the PI OPC DA Interface, and creates AF objects. Installation</p><p>The standard installation has the Enterprise PI Server, the PI OPC DA Interfaces and the DeltaV OPC DA server on the same DeltaV Application Station. During the DeltaV_ACtr set-up program, the user is prompted to enter configuration information regarding the location of the DeltaV OPC DA server, PI Server, and AF Server. Defaults are provided for each selection, but the user may change these settings during the installation procedure. The Smart Connector creates and starts the DeltaV Asset Connector as a Windows service. See the Smart Connector Installation section of this manual for more information. For more information see the DeltaV Asset Connector to the PI System. Principles of Operation</p><p>The DeltaV Smart Connector provides the following functionality:  Stores DeltaV data in a PI System.  Automatically creates and configures PI Points based on DeltaV historicized parameters.  Automatically creates and configures AF objects based on DeltaV equipment hierarchy after a manual export operation. DeltaV Configuration Data</p><p>DeltaV history collection configuration data is retrieved from the enterprise historian configuration XML file that is generated by a download of the Continuous Historian subsystem on the Application Station where the DeltaV Asset Connector is installed. On the initial download PI tags will be created for each DeltaV parameter in the file, and with each additional download, the file timestamp changes, causing the Asset Connector to check the file for updates and reflect those updates in PI. The “Use embedded Enterprise Historian” option must be chosen in the DeltaV Continuous Historian Properties before the DeltaV Smart Connector can be used.</p><p>DeltaV Smart Connector to the PI System 6</p><p>To choose the embedded Enterprise PI Historian option, follow these steps: 1. Open DeltaV Explorer. 2. Right click the Continuous Historian subsystem on the proper Application Station and choose Properties. 3. Click the Enabled checkbox and choose the Use embedded Enterprise Historian option. </p><p>Note: The PI Enterprise Server should be version 3.4.375.80 or greater. It is recommended the latest released version of PI Enterprise Server be used.</p><p>DeltaV Smart Connector to the PI System 7 AF 2.0 Object Creation and Configuration</p><p>The DeltaV Asset Connector automatically creates and configures AF objects when the DeltaV equipment hierarchy export is executed and the equipment hierarchy file, equiphier.xml, exists in the directory specified during the installation of the asset connector. During installation, the user is prompted to enter the AF node name and the AF Database name. If this AF Database already exists, it is updated with the information received from the DeltaV system. If this AF Database does not exist, a new AF Database with the specified name is created.</p><p>To export the equipment hierarchy XML file for the asset connector follow these steps. 1. Open DeltaV Explorer 2. Click, File  Export  Equipment Hierarchy,</p><p>AF Categories The DeltaV Asset Connector creates a ‘DeltaV’ AF Element Category in AF 2.x and assigns all AF Element Templates and AF Elements created by the DeltaV Asset Connector to this category. The AF Category represents a user-defined value used to group objects in AF. Objects may be grouped by categories for generation of reports or to run queries.</p><p>AF Element Templates One AF Element Template is created for each type of DeltaV object contained in the exported DeltaV equipment hierarchy file. DeltaV object types may include Control Modules, Units, Process Cells, Areas, etc. The AF Element Template name is set to the type name, and the Element Template is assigned to the ‘DeltaV’ Element Category described above. </p><p>DeltaV Smart Connector to the PI System 8 AF Elements The DeltaV Asset Connector creates one ‘root’ AF Element in order to group all AF Elements that it creates. The default name for this AF Element is “DeltaV_ACtr” but a different root name may be chosen during installation of the DeltaV Asset Connector. Once the initial synchronization is completed, and this root element exists in AF, it is recommended that the name not be changed in PI System Explorer. If it is necessary to change the name, the AFRoot argument in the PIDeltaV_ACtr.exe.config file must also be changed to match the new name, and the DeltaV Asset Connector must then be restarted. One AF Element is created for each unique DeltaV object in the exported DeltaV equipment hierarchy file. The object position in the equipment hierarchy file is used to determine the appropriate position in the PI AF hierarchy. The AF Element is created under the ‘root’ element and is assigned to the ‘DeltaV’ AF Element Category described above. The AF Element Template corresponding to the DeltaV object type describing this object is used when the AF Element is created.</p><p>AF Attributes When an AF Element is created, the DeltaV Asset Connector searches for all PI Points matching the AF Element’s name. A new AF Attribute is created for each PI Point configured for history collection that is found. The AF Attribute has the same name as its corresponding PI point and its ValueType is set according to the pointtype of the PI point associated with it. A PI Point Data Reference is configured in order to tie the AF Attribute to its corresponding PI Point. When the AF Attribute value is requested, the data reference returns the value of the associated PI Point.</p><p>DeltaV Smart Connector to the PI System 9 Installation Checklist</p><p>For those users who are familiar with running PI data collection interface and Smart Connector programs, this checklist helps get the Smart Connector running. If not familiar with PI Smart Connector, return to this section after reading the rest of the manual in detail. 1. Verify proper licensing for Emerson DeltaV and the Enterprise PI Server. 2. Install the Enterprise PI Server (v3.4.375.80 or later) on DeltaV Application station. 3. Install PI AF Server on PI AF node (optional). 4. Configure DCOM for PI OPC DA interface connection to the DeltaV OPC Server (see the PI OPC DA Interface manual for help in configuring DCOM) 5. Run the PI DeltaV Smart Connector installation that will install the AF Client, PI OPC DA Interface, PI OPC DA Interface ICU Control and the DeltaV Asset Connector. 6. Verify that PI points are correctly configured and that data collection is correct.</p><p>DeltaV Smart Connector to the PI System 10 Smart Connector Installation </p><p>The DeltaV Smart Connector installation includes the DeltaV Asset Connector and the PI OPC DA Interface. Each of these components will be installed as an automatically starting windows service on the DeltaV Application Station where the embedded PI Server is installed. There are several dialog boxes that prompt the user for information. Some entries are required while other information may be optional, based on the requirements of the project. The installation program for the DeltaV Asset Connector sets up the PI OPC DA Interface bat files automatically. (Please see the DeltaV Asset Connector to the PI Server manual for comprehensive instructions).</p><p>Note: The PI OPC DA Interface service is not removed when the DeltaV Asset Connector is uninstalled. The removal of the service must be done manually before the OPC interface is uninstalled. To remove the service run: OPCint_SCx –remove for each OPC interface service installed.</p><p>DeltaV Smart Connector to the PI System 11 Buffering</p><p>PI Buffering is not recommended on the DeltaV Application Station.</p><p>DeltaV Smart Connector to the PI System 12 Appendix A: Error and Informational Messages</p><p>A string DV_ACtr is pre-pended to error messages written to the pipc log. Please see the DeltaV Asset Connector to the PI System manual for a comprehensive list of errors. PI OPC DA Interface error messages will be pre-pended with the string OPCpi. For more information see the PI OPC DA Interface manual. Message Logs</p><p>The location of the message log depends upon the platform on which the Smart Connector is running. See the UniInt Interface User Manual for more information. Messages are written to PIHOME\dat\pipc.log at the following times.  When the Smart Connector starts many informational messages are written to the log. These include the version of the Smart Connector, the version of UniInt, the command-line parameters used, and the number of points.  As the Smart Connector retrieves points, messages are sent to the log if there are any problems with the configuration of the points.</p><p> If the /db is used on the command-line, then various informational messages are written to the log file. System Errors and PI Errors</p><p>System errors are associated with positive error numbers. Errors related to PI are associated with negative error numbers. </p><p>Error Descriptions on Windows On Windows, descriptions of system and PI errors can be obtained with the pidiag utility: \PI\adm\pidiag –e error_number</p><p>DeltaV Smart Connector to the PI System 13 Revision History</p><p>Date Author Comments 16-Jul-2008 BPayne Initial Version 17-Jul-2008 BPayne Updates after MM review. 31-Jul-2008 BPayne Update from MKelly’s review 4-Aug-2008 BPayne Update from MKelly’s 2nd review 6-Aug-2008 BPayne Update from Sandy Branscomb review 09-Oct-2008 MMoore Updates from Emerson review; updated screenshots 10-Nov-2008 MKelly Version 1.0.0.0, Revision A, removed track changes, modified all references to OPC interface to PI OPC DA Interface, added OPCInt ICU Control to installation checklist, fixed headers. 03-Dec-2008 BPayne Version 1.0.0.0, Revision B, Added a Buffering section 5-Dec-2008 BPayne Added a note about OPC interface service removal 19-May-2009 MKelly Version 1.0.1.x, Revision A; Changed title and contact page. Updated copyright date and version number. Fixed headers and footer and section breaks. Removed comments from file properties.</p><p>DeltaV Smart Connector to the PI System 14</p>