PI Asset Connector for Emerson DeltaV

Transcription

1 PI Asset Connector for Emerson DeltaV DeltaV versions Version x

2 OSIsoft, LLC 777 Davis St., Suite 250 San Leandro, CA USA Tel: (01) Fax: (01) Web: OSIsoft Australia Perth, Australia OSIsoft Europe GmbH Frankfurt, Germany OSIsoft Asia Pte Ltd. Singapore OSIsoft Canada ULC Montreal & Calgary, Canada OSIsoft, LLC Representative Office 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 OSIsoft France Immeuble Regus Moulineaux, France PI Asset Connector for Emerson DeltaV Copyright: OSIsoft, LLC. 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, LLC. OSIsoft, the OSIsoft logo and logotype, PI Analytics, PI ProcessBook, PI DataLink, ProcessPoint, PI Asset Framework (PI AF), IT Monitor, MCN Health Monitor, PI System, PI ActiveView, PI ACE, PI AlarmView, PI BatchView, PI Coresight, PI Data Services, PI Event Frames, PI Manual Logger, PI ProfileView, PI WebParts, ProTRAQ, RLINK, RtAnalytics, RtBaseline, RtPortal, RtPM, RtReports and RtWebParts are all trademarks of OSIsoft, LLC. All other trademarks or trade names used herein are the property of their respective owners. U.S. GOVERNMENT RIGHTS Use, duplication or disclosure by the U.S. Government is subject to restrictions set forth in the OSIsoft, LLC license agreement and as provided in DFARS , DFARS , FAR , FAR , as applicable. OSIsoft, LLC. Published: 10/2014

3 Table of Contents Terminology... 1 Asset Connector Terms... 1 General Terms... 2 Chapter 1. Introduction... 1 Reference Manuals... 2 Supported Features... 2 System Diagram... 3 Chapter 2. Principles of Operation... 5 Chapter 3. Installation... 7 Checklist... 7 Installation Directory... 7 PIHOME Directory Tree... 7 DeltaV Asset Connector Installation Directory... 7 DeltaV Asset Connector Installation Procedure... 8 DeltaV Asset Connector Installation Choices for DeltaV Named Sets... 8 New and Upgrade Installations... 8 DeltaV Asset Connector Configuration... 9 DeltaV Asset Connector Upgrade from DeltaV Asset Connector Upgrade from Chapter 4. PI Point Configuration Configured Point Attributes Chapter 5. Error Tag.CSV File Chapter 6. Digital State Sets Chapter 7. Start-Up Command File XML Configuration Keys Sample start-up file PI DeltaV Asset Connector.exe.config Chapter 8. AF 2.0 Object Creation and Configuration Chapter 9. Buffering Chapter 10. Site PI System Settings Appendix A. Error and Informational Messages PI Asset Connector for Emerson DeltaV Message Logs iii

4 Table of Contents Messages System Errors and PI Errors Appendix B. Example Tag and Asset Files Appendix C. Technical Support and Resources Before You Call or Write for Help Help Desk and Telephone Support Search Support based Technical Support Online Technical Support Remote Access On-site Service Knowledge Center Upgrades OSIsoft Virtual Campus (vcampus) Appendix D. Revision History iv

5 Terminology To understand this manual, you should be familiar with the terminology used in this document. Asset Connector Terms ACH Advanced Continuous Historian. Fully integrated PI historian into DeltaV as a replacement to the PI legacy historian starting with DeltaV version Download Download refers to the process on the Emerson DeltaV system which causes all configuration changes to be saved and the EntHist.xml file, containing the DeltaV tag configuration information, to be written to the DeltaV Application Station. Enterprise Historian The process of using a licensed PI Data Archive for DeltaV historical data. EntHist.xml File The EntHist.xml file is the Emerson DeltaV tag configuration file which contains all information used to create the corresponding PI points. This file is created during a download of the Emerson DeltaV system. Equipment Hierarchy File The Equipment Hierarchy file is the Emerson DeltaV file which contains all equipment hierarchy information used to create the corresponding hierarchy in PI AF. This file is manually exported by the user on the Emerson DeltaV system. Process History View Process History View (PHV) is the Emerson DeltaV client used to view data from the PI Data Archive. Synchronization Synchronization refers to the process in which DeltaV Asset Connector reads the tag configuration file, EntHist.xml, and creates PI points corresponding to each DeltaV parameter in the tag configuration file. This can also refer to the process in which the DeltaV Asset Connector reads the equipment hierarchy file and creates AF objects corresponding to the exported DeltaV Equipment Hierarchy. PI Asset Connector for Emerson DeltaV 1

6 Terminology 2 General Terms Buffering Buffering refers to an Interface Node s ability to store temporarily the data that interfaces collect and to forward these data to the appropriate PI Data Archives. N-Way Buffering If you have PI Data Archives that are part of a PI Collective, PIBufss supports n-way buffering. N-way buffering refers to the ability of a buffering application to send the same data to each of the PI Data Archives in a PI Collective. (Bufserv also supports n-way buffering to multiple PI Data Archives however it does not guarantee identical archive records since point compressions attibutes could be different between PI Data Archives. With this in mind, OSIsoft recommends that you run PIBufss instead.) ICU ICU refers to the PI Interface Configuration Utility. The ICU is the primary application that you use to configure PI interface programs. You must install the ICU on the same computer on which an interface runs. A single copy of the ICU manages all of the interfaces on a particular computer. You can configure an interface by editing a startup command file. However, OSIsoft discourages this approach. Instead, OSIsoft strongly recommends that you use the ICU for interface management tasks. ICU Control An ICU Control is a plug-in to the ICU. Whereas the ICU handles functionality common to all interfaces, an ICU Control implements interface-specific behavior. Most PI interfaces have an associated ICU Control. Interface Node An Interface Node is a computer on which PI API the PI API and/or PI SDK are installed, and PI Data Archive programs are not installed. The PI API is a library of functions that allow applications to communicate and exchange data with the PI Data Archive. All PI interfaces use the PI API. PI Collective A PI Collective is two or more replicated PI Data Archives that collect data concurrently. Collectives are part of the High Availability environment. When the primary PI Data Archive in a collective becomes unavailable, a secondary collective member node seamlessly continues to collect and provide data access to your PI clients. PIHOME PIHOME refers to the directory that is the common location for PI 32-bit client applications. A typical PIHOME on a 32-bit operating system is C:\Program Files\PIPC.

7 A typical PIHOME on a 64-bit operating system is C:\Program Files (x86)\pipc. PI 32-bit interfaces reside in a subdirectory of the Interfaces directory under PIHOME. For example, files for the 32-bit Modbus Ethernet Interface are in [PIHOME]\PIPC\Interfaces\ModbusE. This document uses [PIHOME] as an abbreviation for the complete PIHOME or PIHOME64 directory path. For example, ICU files in [PIHOME]\ICU. PIHOME64 PIHOME64 is found only on a 64-bit operating system and refers to the directory that is the common location for PI 64-bit client applications. A typical PIHOME64 is C:\Program Files\PIPC. PI 64-bit interfaces reside in a subdirectory of the Interfaces directory under PIHOME64. For example, files for a 64-bit Modbus Ethernet Interface would be found in C:\Program Files\PIPC\Interfaces\ModbusE. This document uses [PIHOME] as an abbreviation for the complete PIHOME or PIHOME64 directory path. For example, ICU files in [PIHOME]\ICU. PI Message Log The PI message Log is the file to which OSIsoft interfaces based on UniInt x and later writes informational, debug and error message. When a PI interface runs, it writes to the local PI message log. This message file can only be viewed using the PIGetMsg utility. See the UniInt Interface Message Logging.docx file for more information on how to access these messages. PI SDK The PI SDK is a library of functions that allow applications to communicate and exchange data with the PI Data Archive. Some PI interfaces, in addition to using the PI API, require the use of the PI SDK. PI Data Archive Node A PI Data Archive Node is a computer on which PI Data Archive programs are installed. The PI Data Archive runs on the PI Data Archive Node. PI SMT PI SMT refers to PI System Management Tools. PI SMT is the program that you use for configuring PI Data Archives. A single copy of PI SMT manages multiple PI Data Archives. PI SMT runs on either a PI Data Archive Node or a PI Interface Node. Pipc.log The pipc.log file is the file to which OSIsoft applications write informational and error messages. When a PI interface runs, it writes to the pipc.log file. The ICU allows easy access to the pipc.log. PI Asset Connector for Emerson DeltaV 3

8 Terminology Point The PI point is the basic building block for controlling data flow to and from the PI Data Archive. For a given timestamp, a PI point holds a single value. A PI point does not necessarily correspond to a point on the foreign device. For example, a single point on the foreign device can consist of a set point, a process value, an alarm limit, and a discrete value. These four pieces of information require four separate PI points. Service A Service is a Windows program that runs without user interaction. A Service continues to run after you have logged off from Windows. It has the ability to start up when the computer itself starts up. The ICU allows you to configure a PI interface to run as a Service. Tag (Input Tag and Output Tag) The tag attribute of a PI point is the name of the PI point. There is a one-to-one correspondence between the name of a point and the point itself. Because of this relationship, PI System documentation uses the terms tag and point interchangeably. Interfaces read values from a device and write these values to an Input Tag. Interfaces use an Output Tag to write a value to the device. 4

9 Chapter 1. Introduction Starting with the DeltaV v10.3 release, there is a new option for continuous history data collection which allows the use of an Enterprise PI historian to be embedded into the DeltaV system. The embedded Enterprise PI historian is integrated into the DeltaV engineering and operations environments in much the same way as the DeltaV Continuous Historian. Integration of the embedded Enterprise PI historian is accomplished through the use of a the DeltaV interface known as the PI Smart Connector for Emerson DeltaV which includes the PI Asset Connector for Emerson DeltaV. The DeltaV Asset Connector is a tool for synchronizing the DeltaV parameters and equipment hierarchy to the PI System. PI points created by the DeltaV Asset Connector are used by the PI OPC DA interface to retrieve real-time data values from the DeltaV OPC DA Server for the DeltaV parameters configured for history collection and archive these values to the Enterprise PI Data Archive. There are two main tasks of the DeltaV Asset Connector: Automatic Creation of PI Points, which correspond to DeltaV parameters configured for history collection. Automatic Creation of AF Objects, based on the DeltaV equipment hierarchy. Currently, synchronization of the DeltaV equipment hierarchy requires the user to manually generate the EquipHier.xml file on the Emerson DeltaV system. The PI OPC Interface (OPCInt) uses the OPC Data Access interface to communicate with the DeltaV OPC DA Server. The OPC Data Access standard s use of the term Item refers to a point where data values exist in an OPC Server. That is, an OPC Item is conceptually the same as a point in a traditional control system. Each OPC Item is identified by a unique ItemID, which corresponds to the tag or name for a point in DeltaV. The DeltaV Asset Connector starts automatically as a Windows service after the installation and reads from the DeltaV enterprise historian configuration file. A new enterprise historian configuration file is created each time the Continuous Historian subsystem is downloaded on the DeltaV workstation where the embedded Enterprise PI historian is installed. The enterprise historian configuration file contains historian configuration information that allows for the creation of PI points and their associated attributes. The DeltaV Asset Connector synchronization is activated on the change of the enterprise historian configuration file. After the initial synchronization, any changes to the DeltaV history collection configuration will be reflected in the configuration of the corresponding PI tags. The DeltaV Asset Connector will also synchronize the DeltaV equipment hierarchy into the AF database if the EquipHier.xml file exists. Site syncing of the PI Data Archive and site AF database are available starting with version 3.0 of the DeltaV Asset Connector. PI Asset Connector for Emerson DeltaV 1

10 Introduction Starting with DeltaV version , the PI historian can be fully integrated into DeltaV as the DeltaV Advanced Continuous Historian (ACH). This replaces the legacy PI historian that has been allowed to continue since DeltaV version Reference Manuals OSIsoft PI Data Archive manuals PI AF manuals PI OPC DA Interface Manual PI OPC DA Interface Failover Manual Emerson Process Management DeltaV Users Guide v Migrating DeltaV Legacy PI Historian Data to the DeltaV Advanced Continuous Historian - Knowledge Base Article, NK Supported Features Feature Support Part Number PI-AC-EM-DV-NTI * Platforms 32-bit Asset Connector 64-bit Asset Connector Windows 2003 Server 32-bit OS Yes No 64-bit OS No (Emulation Mode) No Windows Vista 32-bit OS Yes No 64-bit OS No (Emulation Mode) No Windows bit OS Yes No Windows 2008 R2 64-bit OS Yes (Emulation Mode) No Windows 7 32-bit OS Yes No 64-bit OS Yes (Emulation Mode) No 64-bit OS Yes (Emulation Mode) No * See paragraphs below for further explanation. 2

11 Platforms The DeltaV Asset Connector is designed to run on the above listed Microsoft Windows operating systems and requires Microsoft.NET 4.5 or later. Because it is dependent on vendor software, newer platforms may not yet be supported. Please contact OSIsoft Technical Support for more information. System Diagram PI Asset Connector for Emerson DeltaV 3

12

13 Chapter 2. Principles of Operation The DeltaV Asset Connector is installed as an automatically starting Windows service on the DeltaV Application Station where the Enterprise is installed. To use the embedded PI historian, the user must select the Use Enterprise Historian option in the Continuous Historian Properties dialog from DeltaV Explorer on the station being configured (see PI DeltaV Smart Connector to the PI System manual). For DeltaV version or later an additional Use Advanced Continuous Historian is available due to the Legacy PI upgrade being obsoleted. DeltaV Asset Connector installation is the same for the Enterprise Historian or Advanced Continuous Historian. The DeltaV Asset Connector installation program prompts the user to specify the location of the PI Data Archive and the OPC Server. The standard installation has the Enterprise PI Data Archive, the PI OPC interfaces and the DeltaV OPC DA server on the same DeltaV Application Station but can optionally have all the components but the DeltaV Asset Connector on separate nodes. Optionally, the user can specify the location of the AF Server node and the name of the AF database if the DeltaV equipment hierarchy will be synchronized with AF. After the DeltaV Asset Connector is fully installed, it locates and reads the enterprise historian configuration file, EntHist.xml, from the set location in the DeltaV directory (DeltaV\DVData\EntHist). On the initial synchronization the DeltaV Asset Connector creates PI tags and their appropriate attributes based on the DeltaV parameters listed in the enterprise historian configuration file. After the tag updates are made, and if the DeltaV equipment hierarchy file exists, then AF objects are created based on the equipment hierarchy in DeltaV. By default, this file is named EquipHier.xml and exists in the \DeltaV\DVData\Import-Export directory. However, the user may select a different name and/or location when exporting this file in DeltaV Explorer. If the name or location is changed then the AssetFile parameter must be changed during the DeltaV Asset Connector installation or manually updated in the PI DeltaV Asset Connector.exe.config file. On subsequent updates of the configuration file, the file is checked for additions, edits and deletions of the DeltaV history collection configuration, and the DeltaV Asset Connector makes the corresponding changes to PI points in the Enterprise PI Data Archive. Deleting or disabling DeltaV parameters causes the scan attribute of the appropriate PI tag to be set to 0 (OFF). Likewise, when the equipment hierarchy file is updated, the DeltaV Asset Connector updates the corresponding AF objects. If changes are made directly to the PI point attributes synchronized by the DeltaV Asset Connector or if PI tags are deleted by the user, then on subsequent synchronizations by the DeltaV Asset Connector, those tags will be updated with the current values in the tag configuration file or re-created. To avoid this situation remove the tags from History Collection in the DeltaV Explorer and download the changes using DeltaV Explorer. The corresponding PI tags will still exist, but will have the scan attribute set to 0. The DeltaV Asset Connector loads all points with the user configured or the default DeltaV pointsource. If the user has created PI points with the designated pointsource but does not want these points to be included in synchronizations, the [UC] flag should be specified in PI Asset Connector for Emerson DeltaV 5

14 Principles of Operation the Descriptor field of the PI Point. For example, if the descriptor is set to [UC]Test point, the DeltaV Asset Connector will not synchronize any attributes of this point with user designated pointsource. The DeltaV Asset Connector creates two status tags to report the success or failure of PI Point synchronization and asset synchronization functionality. These are digital state tags which use the DeltaV Asset Connector digital state set which contains the two states SUCCESS or FAIL. The DeltaV Asset Connector sets the value of each health tag appropriately after synchronization. DeltaV Asset Connector _PointSync_HealthTag DeltaV Asset Connector _AssetSync_HealthTag Site PI System Synchronization Starting with version 3.0 the DeltaV Asset Connector supports the synchronization of a site PI System. The DeltaV Asset Connector will create PI tags for the site PI Data Archive and the equipment hierarchy in AF similarly to the local DeltaV Application sync. The PI tag creation is for use with the PItoPI interface and synced based on the local DeltaV App Station tags created by the DeltaV Asset Connector. The DeltaV Asset Connector does not install or manage the PItoPI interface but must be configured to use the DeltaV Asset Connector created tags. The site PI tags require a unique prefix designation to avoid conflicts with other tags in the PI Data Archive. The AF structure is based on the local DeltaV Application Station equipment hierarchy file much like the local AF. 6

15 Chapter 3. Installation Checklist Verify proper licensing for Emerson DeltaV and the Enterprise PI Data Archive. Install the Enterprise PI Data Archive (V or greater) on DeltaV Application station. Run the PI DeltaV Smart Connector installation kit, which installs for the AF Client, PI OPC DA Interface, PI OPC DA ICU Control and the DeltaV Asset Connector. Verify the points are correctly created by the DeltaV Asset Connector and that the PI OPC DA Interface is correctly collecting data. If asset are synced, use the AF client to verify the hierarchy and the data references. Installation Directory PIHOME Directory Tree 32-bit Interfaces The [PIHOME] directory tree is defined by the PIHOME entry in the pipc.ini configuration file. This pipc.ini file is an ASCII text file, which is located in the %windir% directory. For 32-bit operating systems a typical pipc.ini file contains the following lines: [PIPC] PIHOME=C:\Program Files\PIPC For 64-bit operating systems a typical pipc.ini file contains the following lines: [PIPC] PIHOME=C:\Program Files (X86)\PIPC The above lines define the root of the PIHOME directory on the C: drive. The PIHOME directory does not need to be on the C: drive. OSIsoft recommends using the paths shown above as the root PIHOME directory name. DeltaV Asset Connector Installation Directory The DeltaV Asset Connector is installed to the following location: PIHOME\Asset Connectors\DeltaV\ where PIHOME is replaced with the corresponding entry in the pipc.ini file. PI Asset Connector for Emerson DeltaV 7

16 Installation DeltaV Asset Connector Installation Procedure The DeltaV Asset Connector installation uses the services of the Microsoft Windows Installer. Windows Installer is a standard part of Windows 2000 and greater operating systems. To install the DeltaV Asset Connector run the appropriate installation kit. DeltaV_SC_#.#.#.#.exe DeltaV Asset Connector Installation Choices for DeltaV Named Sets In previous versions of the DeltaV Asset Connector, the choice to make the DeltaV Name Set data available for DeltaV Process History View (PHV), by making the PI data type a string was omitted. In this version, choices will need to be selected to complete the installation. New and Upgrade Installations For a new and upgrade installations, a dialog will be presented with the following options for how PI points should be created for DeltaV Named Set parameters ending with.cv : If the primary client for this data is PHV, select either the String or Both option. If the primary client is PI ProcessBook select either the Digital or Both option. Selecting Both creates two PI tags. Whichever tag is chosen to retain the DeltaV parameter tag the other tag will have either a.str or.dig suffix. If a String ONLY tag is chosen the existing digital tag for that DeltaV parameter will change PI type to String. If the PI type is changed the historical data is accessible but with caveats (See PI System Managers Guide Change PI Point Type in the Manage Points section). 8

17 DeltaV Asset Connector Configuration During the installation procedure, the DeltaV Asset Connector set-up program prompts the user to enter configuration information necessary to run the DeltaV Asset Connector. The start-up file for the DeltaV Asset Connector is created by the set-up program containing the specified entries. This allows the DeltaV Asset Connector to automatically start after the installation procedure finishes. The following figure shows the default selections for the PI Data Archive where data is written, and the OPC Server to which the OPC interface connects. The PI Data Archive and OPC Servers are required to be specified by the user. The standard installation has the Enterprise PI Data Archive, the PI OPC interfaces and the DeltaV OPC DA Server on the same DeltaV Application Station. The PointSource for the OPC interfaces can be designated if the default, DeltaV, is not an acceptable designation. The Backup OPC Server field allows the user to enter the name of a secondary OPC Server. This field is optional and should only be specified if the user wishes to configure the PI OPC DA Interface for Server-Level Failover. Please see the PI OPC DA Interface manual for more information on Server-Level Failover. PI Asset Connector for Emerson DeltaV 9

18 Installation Next, the installation program prompts the user to enter the location of the AF Server and AF Database that are used for writing asset configuration data to AF. If the user is not planning to use AF, these fields may be left blank and no asset information will be sent to AF. However, if the AF Server is specified, the AF Database must also be specified, and vice versa. If an AF Database with this name does not exist an AF Database with this name will be created. The AF Data Location is used to specify the asset file folder that contains the DeltaV equipment hierarchy file. The AFRoot field in the PI DeltaV Asset Connector.exe.config file specifies a hierarchy path in AF under which the DeltaV hierarchy described in the EquipHier.xml file will be created. If AFRoot is not specified then the default root is DeltaV Asset Connector. 10

19 The DeltaV Asset Connector requires a user name and password in order to communicate to the AF Server. These credentials must match on each system. For domains, user names must be in the format of DOMAIN\UserName. For a local Administrator such as DeltaVAdmin, the format must be.\deltavadmin. By default, Local System will be the default log on account used if no account information is provided. The DeltaV Asset Connector configuration file settings allow tag name prefixes for tag name consistency. To aid in performance tuning, the user can specify the number of tags in a synchronization group and the pause between tag groups. The tuning parameters are necessary to give system resources enough time to perform other operations. PI Asset Connector for Emerson DeltaV 11

20 Installation Setting the number of instances needs to be based on the number of licensed DeltaV tags and the number to be historicized with 2000 tags per instance being the recommendation. For example with 10k tags you would specify 5 instances of the interface. The default number of interface instances will be 5 and the number of tags per instances is This can be updated based on tag resolution and performance. It is recommended that an additional instance be created for future expansion. Since the OPC interface instance(s) are normally in the on the same node as the DeltaV Asset Connector, the user name and password are required to create the service. OPC Interface Instances allow for the creation of multiple interface services. Note: It is strongly recommended that no other PI OPC DA Interface instances run on this node where PI Points are not synchronized by the DeltaV Asset Connector. Note: By default, the initial synchronization groups PI tags by interface instance and not by scan rate. Tags are assigned to instances in the order that they are read from the DeltaV historian configuration file. If there are a large number of high rate tags, such as 1 second, it is recommended that more interface instances be created to balance out the load across multiple instances. In some cases it may be necessary to reorder tags by interface instance by editing Location1 of the PI tag configuration through the use of PI tag configuration tools such as the PI Tag Configurator add-in for Excel. 12

21 Beginning in DeltaV Asset Connector v3.0 the DeltaV Asset Connector supports syncing of tags from the local DeltaV application station PI System to the designated site PI System using the PItoPI interface that is setup separately from the DeltaV Asset Connector. The following figure shows the default selections for the Site PI Data Archive where data is written, and the PItoPI interface connects. If the site PI Data Archive is used then the Site PI Data Archive Tag Prefix is required to be specified by the user. The Site PointSource for the PItoPI interfaces can be designated if the default, DeltaV, is not acceptable. It is recommended that the site PointSource be designated to avoid any conflicts with other DeltaV App nodes. PI Asset Connector for Emerson DeltaV 13

22 Installation The option of configuring a site AF Server is setup using this dialog. The installation program prompts the user to enter the location of the site AF Server and site AF Database that are used for writing asset configuration data to AF. If the user is not planning to use the site AF, these fields may be left blank and no asset information will be sent to site AF. However, if the site AF Server is specified, the AF Database and the Site AF Root must also be specified, and vice versa. If an AF Database with this name does not exist an AF Database with this name will be created. The AF Data Location is used to specify the asset file folder that contains the DeltaV equipment hierarchy file. The SiteAFRoot field in the PI DeltaV Asset Connector.exe.config file specifies a hierarchy path in AF under which the DeltaV hierarchy described in the EquipHier.xml file will be created. 14

23 The DeltaV Asset Connector install will set the Shutdown attribute based on the selection on this dialog. The attribute will not be modified on successive syncs by the DeltaV Asset Connector. PI Asset Connector for Emerson DeltaV 15

24 Installation DeltaV Asset Connector Upgrade from 1.0 On upgrade from version 1.0 you will be presented with a dialog to set the PI Digital State preferences. Starting with version 1.1 of the DeltaV Asset Connector, PI Digital State sets can be mapped precisely to DeltaV Named Sets (see Digital State Sets for further explanation). 16

25 DeltaV Asset Connector Upgrade from 2.0 On upgrade from version 2.0 you will be presented with a dialog to update the existing OPCInt_SC(x) bat files. This will allow the installation to add the advise scan class scan class one at the beginning of the scan class designations. If you are upgrading from 1.x this will not be necessary. PI Asset Connector for Emerson DeltaV 17

26

27 Chapter 4. PI Point Configuration The PI point is the basic building block for controlling data flow to and from the PI Data Archive. A single point is configured for each measurement value that needs to be archived. Configured Point Attributes The DeltaV Asset Connector automatically creates and configures PI point attributes based on the values in the enterprise historian configuration file, EntHist.xml. The following table lists the PI Point attributes and the source of their property values from the enterprise historian configuration file. PI Point Attribute Tag Name Source of Value <PATH>Tag name </PATH> Scan <ENAB> Enabled </ENAB> (Value of 1 or 0) The Scan attribute of a PI point may also be set to 0 if a tag that was previously in the enterprise historian configuration file is removed from history collection. CompDev / Compressing <CDEV> Compression Deviation </CDEV> For non-digital tags: If CDEV is set to -1, the Compressing PI Point attribute will be set to 0. If CDEV is not set to -1, the Compressing PI Point attribute will be set to 1 and the CompDev PI Point attribute will be set to the value of CDEV. Step InstrumentTag For digital tags: The CompDev PI point attribute will always be set to 0, and the Step PI point attribute will always be set to 1. <STEP> Step </STEP> For non-digital tags: If the DeltaV STEP value is 0, the PI Step attribute will be set to 1. If the DeltaV STEP value is 1, the PI Step attribute will be set to 0. If the DeltaV STEP value is 2 and the Point s type is Integer, the PI Step attribute will be set to 1. If the DeltaV STEP value is 2 and the Point s type is Float, the PI Step attribute will be set to 0. For digital tags: The CompDev PI point attribute will always be set to 0, and the Step PI point attribute will always be set to 1. <PATH> Tag name </PATH> PI Asset Connector for Emerson DeltaV 19

28 PI Point Configuration PI Point Attribute Pointtype CompMax Zero Location4 (Scan Class) Span Descriptor EngUnits DigitalSet Source of Value <PTYPE> Point type </PTYPE> Source DeltaV Point Type XML File PTYPE Value INT32 1 Int32 UINT32 2 Float64 FLOAT32 3 Float32 NAMED SET 4 Digital UNICODE STRING 5 String Destination PI Point Type Note: If the DeltaV Asset Connector receives an invalid point type value in the point configuration XML file, it log an error and do the following: If the corresponding point does not already exist in PI, an error will be logged and the PI point will not be created. If the corresponding point already exists in PI, the DeltaV Asset Connector will not edit its configuration and will only output an error message to the log file. Additionally, all attributes of a point with an invalid point type listed in the point configuration XML file will be written to the.csv file described in the Error Tag.CSV File section so that the tag configuration(s) may be reviewed and/or corrected at a later time. <MAX> Compression Max </MAX> <EU0> EngUnits 0 </EU0> <RATE> Scan Rate in seconds </RATE> <EU100> EngUnits 100 </EU100> EU100 is the maximum value, so the Span point attribute is set to EU100 - EU0.. <DESC> Module description </DESC> <UNITS> Engineering units </UNITS> <NAMEDSET> Digital State set </NAMEDSET> These following PI attributes are not read from the DeltaV configuration file and are set by the DeltaV Asset Connector on creation of the PI points. These attributes will not be modified by the DeltaV Asset Connector on subsequent syncs. PI Point Attribute PtClassName PointSource PtOwner PtGroup DataOwner DataGroup PtAccess DataAccess DisplayDigits 7 Excdev 0 Location1 1 Location2 0 Location3 0 Source of Value classic DeltaV DeltaVAdmin DeltaV DeltaVAdmin DeltaV o:rw g:rw w:r o:rw g:rw w:r 20

29 PI Point Attribute Location5 0 Shutdown 1 Source of Value Any changes to PI attributes other than those read from the enterprise historian configuration file can be changed manually and will not be overwritten after the initial synchronization. Note: Avoid the manual creation of PI tags with duplicate instrument tag attributes as this can cause updates to be ignored if changes occur in DeltaV for the mapped tag. PI Asset Connector for Emerson DeltaV 21

30

31 Chapter 5. Error Tag.CSV File If any tag included in the enterprise historian configuration file is not able to be created or edited in PI, an error will be logged and the tag information will be written to the PIPointSyncLog_datetime.csv file, which is located in the DeltaV Asset Connector directory. The user may then open this file in Excel and make any necessary changes to the points. The points may then be exported to PI to create or update existing points using PI Tag Configurator in Excel. PI Asset Connector for Emerson DeltaV 23

32

33 Chapter 6. Digital State Sets For more information regarding Digital States, refer to the PI Data Archive documentation. Digital State Sets PI digital states are discrete values represented by strings. These strings are organized in PI as digital state sets. Each digital state set is a user-defined list of strings, enumerated from 0 to n to represent different values of discrete data. For more information about PI digital tags and editing digital state sets, see the PI Data Archive manuals. An interface point that contains discrete data can be stored in PI as a digital tag. A Digital tag associates discrete data with a digital state set, as specified by the user. DeltaV Asset Connector Digital State Sets There are 2 distinct methods of storing DeltaV Names Sets in PI Digital State Sets. Method 1, which was the method used for DeltaV Asset Connector releases 1.0, follows the PI Digital State set standard where states start at offset zero and are in contiguous order. Method 2 which is available in the DeltaV Asset Connector version 1.1 or later will specifically be normalized with DeltaV Named Sets. For each new PI Digital State set built from the EntHist.xml file will be 256 states in size and will mimic the DeltaV Named Sets and may contain states with no value (gaps). For instance the DeltaV Names Set could contain value at indexes 1, 10, 20 and 40, in PI Digital State set the set will begin at 0 and have values only at 1, 10, 20 and 40. All unused states will remain blank and can be updated if the DeltaV Named Set changes after a re-sync. All new installations of version 1.1 or greater will on have method 2 option. The DeltaV Asset Connector uses the information contained in the enterprise historian configuration file, EntHist.xml, to configure Digital State Sets. If a DeltaV parameter configured for history collection is part of a Named Set, the information about the DeltaV Named Set it belongs to is included in the enterprise historian configuration file. This information is used to create or update a Digital State Set in PI. States may be added to an existing Digital State Sets, However, for method 1states will not be removed or re-ordered by the DeltaV Asset Connector. For each new PI Digital State set built for method 2 from the EntHist.xml file will be 256 states in size and will mimic the DeltaV Named Sets and may contain states with no value (gaps). For instance the DeltaV Names Set could contain value at indexes 1, 10, 20 and 40, in PI Digital State set the set will begin at 0 and have values only at 1, 10, 20 and 40. All unused states will remain blank and can be updated if the DeltaV Named Set changes after a re-sync. Note: All new installations of version 1.1 or greater will only have method 2 option available. PI Asset Connector for Emerson DeltaV 25

34 Digital State Sets Named Set information may occasionally be unavailable in the enterprise historian configuration file. However, PI points may not be created in PI without specifying the Digital State Set to which they belong. Therefore, if Named Set information is unavailable in the DeltaV tag configuration file, an error will be logged and the tag information will be put into the file PIPointSyncLog_datetime.csv file described in the Error Tag.CSV File section. System Digital State Set Similar to digital state sets is the system digital state set. This set is used for all tags, regardless of type to indicate the state of a tag at a particular time. For example, if the interface receives bad data from an interface point, it writes the system digital state bad input to PI instead of a value. The system digital state set has many unused states that can be used by the interface and other PI clients. Digital States are reserved for OSIsoft applications. 26

35 Chapter 7. Start-Up Command File The DeltaV Asset Connector differs from other OSIsoft interfaces by not using a batch file with command line parameters. Instead, it uses an XML configuration file, PI DeltaV Asset Connector.exe.config. This file is initially configured by the DeltaV Asset Connector set-up package, based on information entered during installation. If changes are required after the install has completed, the user must change a value parameter in the XML file in order to change a particular argument. For example, to change the PIServer to DVINSTPRO set the value= to DVINSTPRO as shown below: <add key="piserver" value="dvinstpro"/> Note: Subsequent changes to this file are not automatically detected by the DeltaV Asset Connector.. If the startup-up command file is changed, the DeltaV Asset Connector service must be restarted before changes to the start-up command file take effect. Note that each time the DeltaV Asset Connector starts, it performs synchronization. XML Configuration Keys Parameter AFDB value=<string> Optional AFNode value=<string> Optional AssetFile value=<string> Optional Description The AFDB parameter is used to specify the name of the AF Database if asset information is to be written to AF. If the AFNode and AssetFile parameters are both specified, but AFDB is not specified, a default name of DeltaV will be given to the AF Database. The AFNode parameter is used to specify the name of the AF Server if asset information is to be written to AF. If the AFNode parameter is specified, the AssetFile parameter must also be specified. If only one is specified, an error message will be written and asset information will not be written to AF. The AssetFile parameter is used to specify the location of the exported DeltaV equipment hierarchy file. The information in the equipment hierarchy file will be used to write asset information to AF. If the AFNode parameter is specified, the AssetFile parameter must also be specified. If only one is specified, an error message will be written and asset information will not be written to AF. PI Asset Connector for Emerson DeltaV 27

36 Start-Up Command File Parameter AFRoot value=<string> Optional DB value=# Optional Group value=# Optional Default=100 Pause value=# Optional Default=100 PIServer value=<string> Required PIServer_AF value=<string> Optional PointSource value=<string> Optional Prefix value=<string> Optional Description The AFRoot setting allows the user to specify a root path under which all assets contained in the equipment hierarchy file will be created. This path will prefix the DeltaV hierarchy. The DB parameter is used to specify the debug level used when writing messages to the pipc.log file. The possible debug levels are listed below: Default No debug 1 Print start-up information 2 Print information for point synchronization 4 Print information for asset synchronization 8 Print debug information for parsing of XML file 16 Print the time it takes to synchronize an updated file Debug parameters can be combined by adding the values together. For example if debug levels 2, 4 and 8 are combined then /db=14. The Group parameter is used to specify the number of PI Points to edit at a time. This parameter is used in conjunction with the Pause parameter in order to throttle the Asset Connector to achieve optimal performance. If this parameter is not specified, tags will not be grouped for throttling purposes. The Pause parameter is used to specify the number of milliseconds the DeltaV Asset Connector should sleep between processing groups of PI Points. This parameter is used in conjunction with the Group parameter in order to throttle the DeltaV Asset Connector to achieve optimal performance. If this parameter is not specified, no sleeps will be done between tags for throttling purposes. The PIServer parameter is used to specify the name of the node where the PI Data Archive exists. The PIServer_AF parameter is used to specify the name of the node where the PI Data Archive exists in order to map AF Attribute Data References to PI points. If this parameter is not specified, the DeltaV Asset Connector will use the value specified by the PIServer parameter to configure AF Attribute PI Point Data References. The PointSource parameter is used to replace the default value DeltaV for the PointSource attribute of the OPC interface tags The Prefix parameter is used to specify the prefix used for all PI point names. This prefix could be useful in organizing PI points based on DeltaV AppStation name or another unique characteristic. Note: If the prefix is changed after the initial synchronization the DeltaV Asset Connector creates duplicate tags. To avoid this, manually rename the tags first. 28

37 Parameter OPCServer value=<string> Required SyncReport=<string> ( true or false ) Optional TI value=x Optional SitePIServer value=<string> Optional SitePointSource value=<string> Optional SitePrefix value=<string> Optional SitePIServer_AF value=<string> Optional SiteAFNode value=<string> Optional Description The OPCServer parameter is used to specify the name of the node where the DeltaV OPC DA Server exists. If the SyncReport parameter is set to true, a.csv File will be written during each point synchronization scan which will list all points which differed between DeltaV and PI. The information will be written to the AllSynchronizedPIPoints_datetime.csv file, which is located in the DeltaV Asset Connector directory. This list is helpful in quickly determining which points were modified during the point synchronization scan. Please note that setting the optional SyncReport parameter to true will cause the PI Point Synchronization to operate more slowly due to write operations to disk. Therefore, in order to generate a synchronization report, the user must manually enter the SyncReport configuration parameter with a value of true in the PI DeltaV Asset Connector.exe.config file and restart the DeltaV Asset Connector before the change will take effect. The TI parameter is used to specify the maximum number of tags that each OPC DA interface instance will contain. During tag creation, tags will be portioned by this parameter for each interface instance. If this parameter is left blank then all tags will be assigned to a single instance of the interface. The site PIServer parameter is used to specify the name of the node where the site PI Data Archive exists. The PointSource parameter is used to replace the default value DeltaV for the PointSource attribute of the OPC interface tags. It is recommended that the default DeltaV not be used for the site PointSource. The Prefix parameter is used to specify the prefix used for all PI point names. This prefix could be useful in organizing PI points based on DeltaV AppStation name or another unique characteristic. Note: If the prefix is changed after the initial synchronization the DeltaV Asset Connector creates duplicate tags. To avoid this, manually rename the tags first. The SitePIServer_AF parameter is used to specify the name of the node where the PI Data Archive exists in order to map AF Attribute Data References to PI points. If this parameter is not specified, the DeltaV Asset Connector will use the value specified by the SitePIServer parameter to configure AF Attribute PI Point Data References. The SiteAFNode parameter is used to specify the name of the site AF Server if asset information is to be written to the site AF. If the SiteAFNode parameter is specified, the AssetFile parameter must also be specified. If only one is specified, an error message will be written and asset information will not be written to the site AF Server. PI Asset Connector for Emerson DeltaV 29

38 Start-Up Command File Parameter SiteAFDb value=<string> Optional SiteAFRoot value=<string> Required Description The SiteAFDB parameter is used to specify the name of the site AF Database if asset information is to be written to the site AF. If the SiteAFNode and AssetFile parameters are both specified, but AFDB is not specified, a default name of DeltaV will be given to the site AF Database. The SiteAFRoot setting allows the user to specify a root path under which all assets contained in the equipment hierarchy file will be created. This path will prefix the DeltaV hierarchy. This parameter is required when specifying the site AF to avoid conflicts Sample start-up file PI DeltaV Asset Connector.exe.config <?xml version="1.0" encoding="windows-1252"?> <configuration> <appsettings> <add key="piserver" value="dvinstpro2"/> <add key="opcserver" value="dvinstpro2"/> <add key="pointsource" value="dvinst2"/> <add key="prefix" value=""/> <add key="group" value="100"/> <add key="pause" value="100"/> <add key="ti" value="50"/> <add key="afnode" value="afserver3"/> <add key="afdb" value="afdb_08_01_08"/> <add key="assetfile" value="d:\deltav\dvdata\import-export\equiphier.xml\"/> <add key="afroot" value=""/> <add key="sitepiserver" value="sitepidataarchive"/> <add key="sitepiprefix" value="dvinst2"/> <add key="sitepointsource" value="dv2"/> <add key="siteafnode" value="siteafnode"/> <add key="siteafdb" value="siteafdb"/> <add key="siteafroot" value="dvinstpro2"/> </appsettings> </configuration> 30

39 Chapter 8. AF 2.0 Object Creation and Configuration AF 2.0 objects are automatically created and configured by the DeltaV Asset Connector after the DeltaV equipment hierarchy file, EquipHier.xml, is generated manually by the user in DeltaV Explorer when the user manually exports the equipment hierarchy from the DeltaV Explorer as shown below. During installation, the user is prompted to enter the AF node name, AF Database name and an optional AFRoot path. If the specified AF Database already exists, it is updated with the information received from the DeltaV Asset Connector. If this AF Database does not exist, a new AF Database with the specified name is created and then updated with the information received from the DeltaV Asset Connector. Use the AFRoot setting to specify a root path under which all assets contained in the equipment hierarchy file will be created. This path prefixes the DeltaV hierarchy. For example if the AFRoot path is \\Site\Building\ProductionLine1 and the equipment hierarchy file contains asset information for AreaA, the following structure will be created in AF: \\Site\Building\ProductionLine1\AreaA\ProcessCell\Unit\ControlUnit1 AF Categories The DeltaV Asset Connector creates a DeltaV AF Element Category in AF 2.x and assigns this Category to all AF Element Templates and AF Elements created by the DeltaV Asset PI Asset Connector for Emerson DeltaV 31

40 AF 2.0 Object Creation and Configuration Connector. The AF Category represents a user-defined value used to categorize objects within the AFSDK. Objects may be groups by categories to aid in generating reports or running queries in AF. 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 AF Element Template is assigned to the DeltaV Element Category described above. AF Elements One root AF Element is created by the DeltaV Asset Connector in order to group all AF Elements that it creates. This AF Element is named by default DeltaV Asset Connector or the specified AFRoot. Note: It is recommended that the AF Root element not be renamed in PI System Explorer after it is created by the DeltaV Asset Connector. If it is necessary to rename the AF Root element in PI System Explorer, then rename the AFRoot argument in the PI DeltaV Asset Connector.exe.config file to match and then restart the DeltaV Asset Connector. One AF Element is created for each unique DeltaV object in the exported DeltaV equipment hierarchy XML file. The object position in the equipment hierarchy file is used to determine the appropriate position in the 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 will be used when creating the AF Element. AF Attributes When an AF Element is created, the DeltaV Asset Connector will search for all PI Points matching the AF Element s name. A new AF Attribute is created for each PI Point that is found and that has been configured for history collection. The AF Attribute has the same name as its corresponding PI point and its ValueType is set according to the point type of the PI point associated with it. A PI Point Data Reference is configured in order to tie it to its corresponding PI Point. When the AF Attribute value is requested, the value of the associated PI Point will be returned. By default, the DeltaV Asset Connector will search for PI points corresponding to AF Attribute names on the PI Data Archive where points are created from the DeltaV tag configuration file. The user may instead choose to search for PI Points from a centralized site PI Data Archive for configuring PI Point Data References using the PIServer_AF configuration parameter in the DeltaV Asset Connector startup file. In this case, the PI Points and their associated data must be transferred to the centralized site PI Data Archive using an alternate method other than the DeltaV Asset Connector. Note: Deleting a PI tag does not delete the reference to that tag in AF. However, it is not recommended to ever delete a PI tag. It is a better option to rename the PI point or set the scan attribute to zero. 32