PI AF 2010 User's Guide

346 Pages·2010·2.76 MB·English

PI AF 2010 User's Guide
Version 2010
OSIsoft, LLC
777 Davis St., Suite 250
San Leandro, CA 94577 USA
Tel: [phone]
Fax: [phone]
Web: http://www.osisoft.com

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

Copyright: © 2004-2010 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, Analysis Framework, IT Monitor,
MCN Health Monitor, PI System, PI ActiveView, PI ACE, PI AlarmView, PI BatchView, PI Data Services, 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 227.7202, DFARS 252.227-7013, FAR 12.212, FAR 52.227, as applicable. OSIsoft, LLC.

Published: 18 May 2010
Table of Contents

Chapter 1 General Concepts 
What is AF?........................................................................................................................1 
What Can You Do with AF?...............................................................................................2 
What Can You Expect in Future Releases?......................................................................2 
Significant new features of this Release............................................................................2 
AF Terminology..................................................................................................................3 
AF Architecture...................................................................................................................3 
AF Client..................................................................................................................4 
AF Server.................................................................................................................4 
AF SQL Database....................................................................................................4 
Basic AF Topology...................................................................................................5 
AF Deployment Scenarios.................................................................................................6 
AF Deployment Without High Availability................................................................8 
AF Configuration with SQL Server Clustering/Mirroring........................................10 
AF High Availability Using an AF Collective.....................................................................14 
AF High Availability Using an AF Collective with SQL Clustering....................................16 
Checking Work In/Out......................................................................................................17 
Persistence.......................................................................................................................18 
Chapter 2 Data Directory 
Defining an Element.........................................................................................................19 
Defining an Element Template.........................................................................................20 
Defining an Element Attribute..........................................................................................21 
Using Tables....................................................................................................................22 
Viewing Element Attribute Values....................................................................................22 
Chapter 3 Modeling 
Defining a Model..............................................................................................................23 
Ports and Connections..........................................................................................23 
SubModels.............................................................................................................23 
Layers....................................................................................................................24 
Analyses and Cases..............................................................................................24 
Modeling Scope................................................................................................................24 
Guidelines for Setting up a Model....................................................................................25 
PI AF 2010 User's Guide iii
Table of Contents
Chapter 4 Analysis 
Introduction.......................................................................................................................27 
Analyses................................................................................................................27 
Cases.....................................................................................................................27 
Choosing an Analysis Tool...............................................................................................28 
Results from Running an Analysis...................................................................................28 
Chapter 5 Units of Measure 
Working with Units of Measure........................................................................................29 
Understanding the UOM Classes.....................................................................................30 
Using the UOM Classes...................................................................................................31 
Chapter 6 Data References 
Introduction to Data References......................................................................................33 
Adding Data References to Attributes..............................................................................34 
Using Substitution Parameters.........................................................................................35 
Configuring the PI Point Data Reference.........................................................................38 
Details about the Tag Creation Option..................................................................41 
Value Retrieval by Relative Time Examples..........................................................42 
Value Retrieval by Time Range.............................................................................42 
Configuring the PI Point Array Data Reference...............................................................43 
Configuring the Table Look-Up Data Reference..............................................................46 
Configuring the Formula Data Reference........................................................................49 
Filling in the Formula Configuration Dialog Box....................................................50 
Filling in the Parameter Configuration Dialog Box.................................................52 
Formula Data Reference Operators......................................................................53 
Formula Data Reference Functions.......................................................................53 
Chapter 7 Guidelines for Structuring AF 
Identification of Problems.................................................................................................55 
Selecting Templates.........................................................................................................56 
Building Hierarchies.........................................................................................................57 
Chapter 8 Example Applications 
Heat Exchanger................................................................................................................63 
Create the Units of Measure (UOMs)....................................................................67 
Create the AF Table..............................................................................................73 
Create the Enumeration Set..................................................................................74 
Create the Element Template................................................................................75 
Create the Element................................................................................................84 
iv
Table of Contents
Chapter 9 Using the PI System Explorer 
Overview of the PI System Explorer................................................................................87 
Identifying Major Components.........................................................................................88 
Menu Bar / Toolbar...........................................................................................................89 
Checking Work In and Out.....................................................................................90 
Importing / Exporting Data.....................................................................................92 
Saving / Loading Libraries.....................................................................................94 
Query Dates and Element Versions......................................................................95 
Copying Objects.....................................................................................................96 
Setting the Appearance of the PI System Explorer...............................................98 
Setting Options for the PI System Explorer...........................................................99 
Browser..........................................................................................................................100 
Viewer............................................................................................................................103 
Control Number of Objects Appearing in the Viewer...........................................104 
Select Multiple Objects for Operations................................................................105 
Palette............................................................................................................................106 
Searching for Objects.....................................................................................................107 
Searching for Objects – Specifying Search Options............................................108 
Searching - Advanced Search for Elements........................................................109 
Searching for Attributes.......................................................................................110 
Searching - Simple Search for Objects...............................................................112 
Using Extended Properties............................................................................................113 
Working with PI Systems...............................................................................................114 
Connecting to a System.......................................................................................114 
Connecting to a Specific Member of a Collective................................................116 
Viewing / Editing System Properties....................................................................117 
Configuring an Active Directory...........................................................................119 
Working with Databases................................................................................................121 
Creating a Database............................................................................................122 
Viewing / Editing Properties of a Database.........................................................124 
Setting the Default Database...............................................................................124 
Renaming a Database.........................................................................................124 
Searching for a Database....................................................................................125 
Refreshing a Database........................................................................................126 
Deleting a Database............................................................................................126 
Setting Security Permissions for a Database......................................................127 
Security Guidelines........................................................................................................129 
Setting Permissions for Objects...........................................................................130 
Setting Permissions for Collections.....................................................................133 
AF Utilities......................................................................................................................136 
Export AF Objects................................................................................................136 
Import AF Objects................................................................................................138 
Register AF Plug-Ins............................................................................................139 
AF Server Configuration......................................................................................141 
PI AF 2010 User's Guide v
Table of Contents
Chapter 10 Working with Elements 
Defining Elements..........................................................................................................146 
Browser Shortcut Options - Elements............................................................................148 
Configuring Elements.....................................................................................................149 
Element Properties - General Tab.......................................................................150 
Element Properties - Child Elements Tab...........................................................151 
Element Properties - Attributes Tab.....................................................................152 
Element Properties - Ports Tab...........................................................................154 
Element Properties - Version Tab........................................................................155 
Configuring Models........................................................................................................156 
Model Properties - General Tab..........................................................................157 
Model Properties - Layers Tab............................................................................158 
Model Properties - Connections Tab...................................................................159 
Model Properties - Remaining Tabs....................................................................159 
Working with Element Versions.....................................................................................160 
Creating a Version...............................................................................................160 
Setting Current Version.......................................................................................161 
Element Hierarchies.......................................................................................................162 
Creating Element References..............................................................................164 
Finding Parents of an Element............................................................................166 
Working with Models......................................................................................................167 
Chapter 11 Working with Library Components 
Creating Categories.......................................................................................................169 
Browser Shortcut Options - Library Categories...................................................170 
Defining Element Templates..........................................................................................171 
Browser Shortcut Options - Library Element Templates.....................................172 
Element Template Properties - General Tab.......................................................174 
Element Template Properties - Attribute Templates Tab....................................175 
Element Template Properties - Ports Tab...........................................................177 
Defining Other Templates..............................................................................................178 
Creating Enumeration Sets............................................................................................179 
Browser Shortcut Options - Library Enumeration Sets........................................181 
Defining Reference Types..............................................................................................182 
Browser Shortcut Options - Library Reference Types.........................................185 
Creating Tables..............................................................................................................186 
Browser Shortcut Options - Library Tables..........................................................187 
Table Properties - General Tab...........................................................................188 
Table Properties - Define Table Tab....................................................................189 
Table Properties - Table Tab...............................................................................190 
Table Properties - Version Tab............................................................................191 
Importing / Linking to External Data...............................................................................192 
Importing or Linking Excel Data...........................................................................193 
Importing or Linking Access Data........................................................................199 
Importing or Linking SQL Server Data.................................................................204 
vi
Table of Contents
Chapter 12 Working with Transfers 
Defining Transfers..........................................................................................................213 
Browser Shortcut Options - Transfers............................................................................214 
Transfer Properties - General Tab.................................................................................215 
Transfer Properties - Attributes Tab...............................................................................216 
Transfer Properties - Ports Tab......................................................................................218 
Searching for a Transfer................................................................................................219 
Chapter 13 Working with Event Frames 
Defining Event Frames...................................................................................................224 
Browser Shortcut Options – Event Frames....................................................................225 
Event Frame Properties – General Tab.........................................................................226 
Event Frame Properties – Child Event Frames Tab......................................................227 
Event Frame Properties – Referenced Elements Tab...................................................228 
Event Frame Properties – Attributes Tab.......................................................................229 
Searching for an Event Frame.......................................................................................230 
Chapter 14 Working with Units of Measure 
Browser Shortcut Options - Unit of Measure.................................................................233 
Creating a new UOM Class............................................................................................235 
UOM Class Properties - General Tab............................................................................236 
UOM Class Properties - Units of Measure Tab..............................................................237 
Appendix A AF Installation 
Planning for an AF Installation.......................................................................................240 
Installation / Uninstallation Guidelines...........................................................................247 
Order of Software Installation..............................................................................247 
AF Installation Prerequisites................................................................................248 
Before You Start..................................................................................................248 
Installing / Upgrading / Uninstalling the AF Client...............................................249 
Uninstalling AF.....................................................................................................249 
Overview of AF Server Security.....................................................................................250 
SQL Server Authentication Modes......................................................................251 
Installing AF Application Service and AF SQL Database to a Single Computer...........252 
Installing AF Application Service and AF SQL Database to Separate Computers........253 
Installing the AF Server and SQL Database on a Microsoft Cluster Server..................254 
Installing the AF SQL Database on a SQL Server Cluster..................................254 
Installing the AF Application Service on a Microsoft Cluster Server...................256 
Installing the AF SQL Database to a Mirrored SQL Server...........................................256 
Manually Creating / Updating the AF SQL Database....................................................260 
Completing the Prerequisite Steps......................................................................260 
Executing SQL Scripts.........................................................................................261 
Enabling Communication between the AF Application Service and the AF SQL
Database..............................................................................................................262 
Upgrading an AF Collective (HA) installation.................................................................263 
Installing the AF Server on a Domain Controller............................................................265 
Installing AF Server if SQL Server has been Uninstalled / Reinstalled.........................266 
PI AF 2010 User's Guide vii
Table of Contents
Silent Installations..........................................................................................................267 
Configuring Dr. Watson for Windows.............................................................................273 
Appendix B AF System Configuration/Maintenance 
Adding a Domain User to the AFServers Local User Group..........................................275 
Manually Separating the AF Server and AF SQL Database..........................................276 
AF Security through a Firewall.......................................................................................277 
Examples of Firewall Usage................................................................................278 
Firewalls and Network Connection Used by AF..................................................281 
Port summary.......................................................................................................287 
Configuring SQL Server.................................................................................................288 
Enabling SQL Server’s Remote Connections......................................................288 
Using SQL Server Security............................................................................................290 
Configuring SQL Server to Use Mixed Mode Authentication..............................290 
Creating and Configuring SQL Server User........................................................291 
Accessing External AF Tables.......................................................................................293 
Modifying the AF Server’s Connect String.....................................................................293 
Specifying SQL Server Security Mode................................................................294 
Specifying a Different Database Server..............................................................295 
Changing the AF Server’s Service Account...................................................................296 
Removing the NetworkService Account’s Access to the PIFD Database...........298 
Working with Untrusted Domains...................................................................................300 
Configuring PI System Explorer and the AF Server to Allow Communications..300 
Configuring the PI AF Server 2.x Service and AF SQL Database to Allow
Communications..................................................................................................302 
Backing Up AF Databases.............................................................................................303 
AF Table Security Considerations for External Tables..................................................304 
Mitigating Factors.................................................................................................304 
Security Recommendations.................................................................................304 
Troubleshooting Connection Problems..........................................................................306 
Appendix C Working with AF Collectives 
AF Collectives Functional Overview...............................................................................309 
How Does an AF Collective Operate?.................................................................310 
AF Collective Administrative Tasks.....................................................................312 
Working with AF Collectives Through the PI System Explorer......................................314 
Creating a New Collective...................................................................................314 
Checking the Status of a Collective.....................................................................318 
Adding a Secondary Server to a Collective.........................................................321 
Configuring the Collective Properties..................................................................324 
Removing a Server from a Collective..................................................................325 
Stopping Replication on a Secondary Server......................................................326 
Stopping Replication on the Primary Server........................................................326 
Starting Replication on a Server..........................................................................326 
Reinitialize a Collective Member..........................................................................327 
Configuring Security on the Replication Data Folder.....................................................327 
Troubleshooting AF Collective Issues............................................................................328 
viii
Table of Contents
Appendix D Technical Support and Resources 
Before You Call or Write for Help........................................................................331 
Help Desk and Telephone Support......................................................................331 
Search Support....................................................................................................332 
E-Mail–Based Technical Support........................................................................332 
Online Technical Support....................................................................................332 
Remote Access....................................................................................................333 
On-Site Service....................................................................................................333 
Knowledge Center...............................................................................................333 
Upgrades.............................................................................................................333 
Index 

PI AF 2010 User's Guide ix