+ All Categories
Home > Documents > Clients Class Workbook v5.1 CBT

Clients Class Workbook v5.1 CBT

Date post: 25-Nov-2015
Category:
Upload: wira-m-sukoco
View: 60 times
Download: 5 times
Share this document with a friend
Description:
Clients Class Workbook
192
PI ProcessBook, PI DataLink, PI WebParts Version 5.1
Transcript
  • PI ProcessBook, PI DataLink, PI WebParts

    Version 5.1

  • PI ProcessBook, PI DataLink, PI WebParts Course

    How to contact us

    OSIsoft, LLC

    777 Davis St., Suite 250

    San Leandro, CA 94577 USA

    (01) 510-297-5800 (main phone)

    (01) 510-357-8136 (fax)

    (01) 510-297-5828 (support phone)

    [email protected]

    Houston, TX

    Johnson City, TN

    Longview, TX

    Mayfield Heights, OH

    Philadelphia, PA

    Phoenix, AZ

    Savannah, GA

    OSIsoft Australia Pty Ltd.

    Perth, Australia

    New Plymouth, New Zealand

    OSIsoft Europe GmbH

    Frankfurt am Main, Germany

    OSIsoft Asia Pte Ltd.

    Singapore

    OSIsoft Canada ULC

    Montreal, Canada

    OSIsoft, Inc. Representative Office

    Beijing, Shanghai, Peoples 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

    Sales Outlets/Distributors

    Middle East/North Africa

    Republic of South Africa

    Russia/Central Asia

    South America/Caribbean

    Southeast Asia

    South Korea Taiwan

    www.osisoft.com OSIsoft, LLC is the owner of the following trademarks and registered trademarks: PI System, PI

    ProcessBook, Sequencia, gRecipe, sRecipe, and RLINK. All terms mentioned in this book that are known

    to be trademarks or service marks have been appropriately capitalized. Any trademark that appears in this

    book that is not owned by OSIsoft, LLC is the property of its owner and use herein in no way indicates an

    endorsement, recommendation, or warranty of such party's products or any affiliation with such party of

    any kind.

    RESTRICTED RIGHTS LEGEND

    Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph

    (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013

    1994-2010 OSIsoft, LLC. All rights reserved

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page i

    Conventions

    The following conventions are used throughout this book.

    Bulleted List

    Item 1

    Item 2

    Item 3

    This represents different ideas on a topic.

    Numbered lists

    1. Item1 2. Item 2 3. Item 3

    This represents a list of steps with a specific order to respect.

    A bold font is to emphasize user interface element names, including names of buttons, dialog boxes, and

    menu items; it also highlights processes, utilities, system components and modules.

    A Consolas font is used for code or computer input by the user or output to the display, also for

    filenames and path names and formulas.

    A Consolas font with a border like the figure below represents a block of code.

    ' Variables / Objects. Dim myvar as string Myvar =

    A Consolas font with a border like the figure below represents a block of SQL query.

    SELECT FROM TABLE WHERE

    An italic font is used as placeholders for variables or information unknown that will be determined by

    you, the reader.

    An underlined blue font is used to report URL.

    The content you will retrieve in this rectangle is important and requires your attention.

    This image represents:

    A group recap question to verify understanding of the material;

    A directed exercise (green);

    A self-paced exercise (blue).

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page ii

    How to Use this Class Workbook

    1 Most of these references are to user manuals that can be downloaded from

    http://techsupport.osisoft.com > Download Center > Documentation > User Manuals. (Login

    to an OSIsoft technical support account is required.) Use the "Product" drop down list box to

    choose the correct user manual.

    2 You can download solutions to the self-paced exercises at http://training.osisoft.com >

    Downloads > Class Downloads. Click on a class and download the .zip file that contains the

    class workbook and exercise solutions. (Login to an OSIsoft technical support account is

    required.)

    Each chapter contains one or more

    Heading 2 sections.

    Each Heading 2 section contains a list of

    your objectives. In most cases, you will be

    tested on these objectives.

    When a Heading 3 is marked

    "Optional" then it is not a critical

    objective and can be skipped. In

    class we usually skip these.

    The book icon refers to a different

    document. If you want more info on this

    topic, look there.1

    The first Heading 3 states the first objective.

    Every Heading 3 indicates a new objective,

    unless it is marked "Optional."

    The second Heading 3 states the

    second objective. The third Heading

    3 states the third objective etc.

    The Question Mark icon indicates an

    activity designed to reinforce or

    validate a new skill. This could be

    something the class does together as a

    group, a question, or a solo activity.2

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page iii

    Table of Contents

    1. Introduction to the PI System ................................................................................. 1

    1.1 PI Described, PI Architecture, PI Points and Attributes............................. 1

    1.2 How Data Moves through the PI System ..................................................... 5

    1.3 Time and PI ................................................................................................... 10

    2. ProcessBook: Connecting, Navigating, Trends, and Displays ......................... 13

    2.1 Create, Modify Connections to a PI Server ............................................... 13

    2.2 Tag Search and Point Attributes Dialogs .................................................. 15

    2.3 Navigating, Resizing, and Formatting........................................................ 19

    2.4 The Display, Status Report, and Tooltip Statistics ................................... 20

    2.5 Details Docking Window, Browser Toolbar, and Playback Toolbar ....... 22

    2.6 Navigating Within a Trend, Trend Cursor, Show/Hide Trace .................. 24

    2.7 Building a Display, Add Static Elements, the Symbol Library ................ 33

    3. ProcessBook: Dynamic Elements and ProcessBook Workbooks ................... 39

    3.1 Dynamic Elements, Data Favorites ............................................................ 39

    3.2 Build Trends, Linear Regression, the Format Paintbrush, and XY Plots40

    3.3 Bars, Values, Multi-State Objects and Buttons ......................................... 44

    3.4 Creating Workbooks and Organizing Displays ......................................... 51

    3.5 Creating Entries ........................................................................................... 52

    4. ProcessBook: Performance Equation (PE) Syntax ............................................ 59

    4.1 Performance Equations Basics .................................................................. 59

    5. ProcessBook: Calculations .................................................................................. 63

    5.1 PI Calculations in PI ProcessBook and Performance Equation Syntax. 63

    6. DataLink: Current and Archived Data.................................................................. 73

    6.1 Introduction and Installation ....................................................................... 73

    6.2 DataLink Settings and Time Formats......................................................... 73

    6.3 Simple DataLink Queries ............................................................................. 77

    6.4 Multiple Value DataLink Queries ................................................................ 85

    6.5 Arrays in PI DataLink ................................................................................... 88

    7. DataLink: Calculated and Filtered Data ............................................................... 93

    7.1 Graphical Data in DataLink ......................................................................... 93

    7.2 Calculations Within DataLink ..................................................................... 98

    7.3 Expression Data ......................................................................................... 107

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page iv

    7.4 Complex Calculations and Other Functions ........................................... 115

    8. PI WebParts: PI Gauge, PI Values, and PI TimeSeries ..................................... 127

    8.1 Introduction to PI WebParts ...................................................................... 127

    8.2 Using and Configuring PI WebParts ........................................................ 135

    9. PI WebParts: PI Trend, PI TimeRange, PI Graphic, DLES ............................... 147

    9.1 PI Trend and PI TimeRange ...................................................................... 147

    9.2 PI ProcessBook Within PI WebParts ....................................................... 150

    9.3 Requirements and Configuration of DataLink for Excel Services ........ 155

    10. PI ActiveView ....................................................................................................... 159

    10.1 Advanced Web Part Possibilities ............................................................. 159

    11. AF Element Relative Visualizations ................................................................... 163

    11.1 Introduction and Element Relative Displays ........................................... 163

    11.2 The AF Database, PI WebParts, and Web Part Connections ................. 170

    12. Conclusion ........................................................................................................... 179

    12.1 Training ....................................................................................................... 179

    12.2 vCampus ..................................................................................................... 179

    12.3 Tech Support .............................................................................................. 179

    12.4 Further Questions ...................................................................................... 180

    13. Exercise Global Recap Question (optional) ................................................... 181

    14. Group Recap Answers ........................................................................................ 183

    15. Glossary ............................................................................................................... 185

    16. Index ..................................................................................................................... 186

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 1

    1. Introduction to the PI System

    1.1 PI Described, PI Architecture, PI Points and Attributes

    Objectives

    Describe what the PI system is

    Draw a diagram of the architecture of a PI System

    Describe what a point is

    List the basic point attributes and their usage

    List the possible data point types

    1.1.1 The PI System Described

    The PI System collects, stores, and manages data from your plant or process. You connect

    your data sources to one or more PI Interface Nodes. The Interface Nodes get the data from

    your data sources and send it to the PI Server. Users get data from the PI Server and display it

    with client tools (for example, PI ProcessBook, PI DataLink, and PI WebParts).

    There are generally four parts involved in a PI System:

    Interface

    NodePI / AF

    Server

    `

    Client

    PCData

    Source

    Figure 1

    Data is collected from the source by the PI Interface program hosted by the Interface Node.

    The data is sent to the PI Server (Asset data can be contained in the PI AF Server). It is read

    from the PI/AF Servers by the Client tools.

    1.1.2 Architecture of a PI System

    Sometimes the architecture can be very simple. Some customers have as few as one or two

    interfaces feeding data to a PI Server. Everyone reads that PI Server for their data.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 2

    Figure 2

    Figure 1 shows how the PI System architecture can be deployed at the site level and

    integrates your manufacturing and corporate networks.

    Each part of the PI System can be multiplied or connected to another system. Every

    installation is a little unique.

    Figure 2 shows how this architecture can be expanded and built up to provide access across

    your entire enterprise organization and tie together all of your manufacturing and business

    data.

    Figure 2

    10101

    00110

    10011

    DATA SOURCES MANUFACTURING CONTROL NETWORK DMZ CLIENT APPS / CORPORATE LAN

    OTHER DATA

    SOURCES

    ANALYTICAL TOOLS

    CLIENT APPS

    PI INTERFACE

    NODES

    3RD PARTY HISTORIANS

    RELATIONAL DATA

    MANUAL DATA

    PLC / INSTRUMENT SYSTEMS

    SCADA / DCS

    LIMS SYSTEM

    PUMPS

    VALVES

    PRESSURE SENSORS

    ACTUATORS

    MOTORS

    TRANSFORMERS

    PI SERVER

    NODES

    WEB APPS

    CLIENT APPS

    CLIENT APPS

    OTHER

    SYSTEMSOTHER

    SYSTEMS

    WIRELESS

    MOBILE CLIENTS

    MORE CLIENT APPS

    APPLICATION SERVERS

    PORTAL SERVERS

    BUSINESS SYSTEMS

    PI ENTERPRISE

    SERVICES

    ENTERPRISE

    PI COLLECTIVE

    SITE 1

    SITE 2

    SITE 3

    ENTERPRISE DATACENTER BUSINESS NETWORK

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 3

    1.1.3 The PI Point The Basic Unit in the PI System

    What is a PI Tag? It is a unique storage point for data in the PI system. It is simply a single

    point of measurement.

    1.1.4 Directed Exercise Data Types

    You are invited to watch what the instructor is doing or perform the same steps at the

    same time to explore the different concepts presented in this chapter or section.

    Problem Description

    Identify the type of data that might be associated with each of the following:

    Example: a Temperature Sensor ___a floating point value___

    A switch position: _______________________________________

    A Batch ID: _______________________________________

    Operator comments: _______________________________________

    The results of a calculation: _______________________________________

    Memory available on a server: _______________________________________

    Current phase of the reaction: _______________________________________

    Current product count: _______________________________________

    1.1.5 The Possible Data Point Types

    So What Types of Data Can PI Store?

    The answer is pretty much everything. Below are the data types:

    Digital: Discrete value (On/Off, Red/Black/Green)

    Int16: Integer value, 16 bits (0 to 32767, acc: 1/32767)

    Int32: Integer value, 32 bits (-2147450880 to 2147483647)

    Float16: Scaled Floating Point number, 16 bits (1/32767 times range)

    Float32: Floating Point number, 32 bits (single precision)

    Float64: Floating Point number, 64 bits (double precision)

    String: Text value up to 976 characters

    Timestamps: Any Time/Date in the range 1-Jan-1970 to 1-Jan-2038

    And for anything that will not fit cleanly into any of the defined types,

    Blob: Binary large object up to 976 bytes

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 4

    1.1.6 Some Basic Point Attributes and Why They are Important to You

    There are some common tag attributes that are often used in client tools. Most of these

    attributes are used for display or informational purposes.

    Tag Name

    Unique name of the PI point used to search for tags. Most tags are built using a local naming

    convention. Sometimes knowing the naming convention this can be helpful in searching for tags. For

    example, try to determine what the following tag may refer to:

    M03_E1P2_MOTDRV1202_RUNSTAT

    ________________________________________________________

    Descriptor

    This is the human-readable description of the PI Tag. It is often used as a search criterion in place of the

    tag name when the tag name is not intuitive. Very often the tag name is some sort of abbreviation

    convention and the descriptor is used to capture the full name.

    EngUnits

    This field refers to the Engineering Units of the point. Since there is no referential integrity involved

    here, this field can be of very limited use in searching. For example, gallons per minute could be written:

    Gallons/minute, Gallons per Minute, gals/min, gpm, etc.

    PointType

    This is the type of variable stored, sometimes used to help in searching (for example when looking for a

    string tag).

    Zero and Span

    These two tag attributes define the minimum and maximum values for a tag. The minimum is the Zero

    value and the maximum is derived from taking the Zero point and adding the Span. This affects the

    following items:

    Default boundaries of a trend

    Number of visual states in a multistate symbol

    Range of a Bar Graph

    The behavior of the Current State item in the PI Values Web Part

    How much data is compressed (more on this later)

    Note: In most cases, users will not be able to change these attributes.

    PointSource

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 5

    All tags are related to their interfaces that collect the data by an attribute called Point Source. This means

    that in many cases you can find all of the tags associated with a particular device by searching for all tags

    of a certain Point Source. This assumes that the user knows the point sources in use and that will not

    be true in most situations.

    1.2 How Data Moves through the PI System

    Objectives

    Explain why it looks like there are holes in the data.

    Explain how the Interfaces filter noise and define noise.

    Explain how the PI Server applies compression to store only meaningful data and define meaningful.

    Explain default exception and compression values and why they are important to the end user

    1.2.1 Why Does My Data Appear to Have Holes?

    Often you will experience a situation where one of the following conditions will be true:

    You are watching a trend and you can see many values, but when the trend is refreshed most of them disappear.

    Figure 3 Before and After Compression

    You query for historical data in Microsoft Excel. You are sure the device is being scanned every ten seconds, yet you see an uneven recording of data (what appear to

    be gaps in timestamps).

    This is completely normal behavior. It is a result of two filters that are applied.

    1.2.2 Filtering Noise

    At the Interface level, a process called the Exception Test is applied. The Exception Test

    filters all values that are considered noise.

    Noise: Insignificant changes, as defined as those below the instruments accuracy threshold, as set by the person creating PI Points, and identical values, such as a valve that is reading OPEN over and over again.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 6

    Exception reporting uses a simple deadband algorithm to determine whether to send events to

    the PI Server. For each point, you can set exception reporting specifications that create the

    deadband. The interface ignores values that fall inside the deadband.

    How do I know what the deadband measurement is?

    The deadband is created by applying the tag attribute ExDev in both a plus and minus

    direction.

    Tem

    pera

    ture

    Time

    ExMax

    ExDev

    ExDev

    A

    B

    C

    D E

    F

    Figure 4

    In the illustration, which values will be sent to the PI Server?

    Answer: Values _____, _____, and _____.

    Why do we need the previous value?

    We send the previous value for a very basic reason: without the previous value it would not

    be possible to correctly draw the historical trend.

    Consider the series of points below. Draw one trend using just the initial value (Value A) and

    the value that jumps out of the deadband (Value B). Then draw a trend line that includes not

    only those two points but the value previous (Value C).

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 7

    Tem

    pera

    ture

    Time

    A

    B

    C

    Of the two trend lines you just drew, which trend is more accurate?

    But what if my values never go outside the deadband!

    No problem. The ExcMax attribute sets a limit on how long the interface can go without

    reporting a value to PI. After the ExcMax time period, the interface sends the next new value

    to PI, regardless of whether the new value is different from the last reported value.

    Note: Some interfaces do not support exception reporting. See the documentation for your interface to

    determine whether it supports this capability.

    1.2.3 Directed Exercise Exception Testing

    You are invited to watch what the instructor is doing or perform the same steps at the

    same time to explore the different concepts presented in this chapter or section.

    Problem Description

    You want to determine from the raw data which values will pass the exception test and which

    will be filtered out.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 8

    Approach

    Consider the following parameters:

    ExcDevPercent: 2

    Span: 200

    ExcMax: 180

    The current snapshot value and timestamp are:

    70.3 10:00:00

    Which pass the exception test, not including previous values?

    1.2.4 Storing Only Meaningful Data

    The PI Server uses a Compression Algorithm to determine what events need to be saved in

    the PI Archive, or what is meaningful.

    Meaningful: The data required to accurately reproduce the original data from the data source.

    But isnt everything meaningful?

    Not necessarily. For example, consider the following illustration. Which values would you

    require to accurately represent the movement of the value at a later date?

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 9

    Tem

    pera

    ture

    Time

    CompMax

    B

    C

    D

    E

    F

    A

    Comp

    Dev

    Comp

    Dev

    Figure 5

    In the illustration, which values will be sent to the PI Server?

    Answer: Values _____, _____, and _____.

    1.2.5 Default Values for Exception and Compression

    The default values for exception and compression are as follows:

    ExcDevPercent = 1 (% of span);

    ExcMax = 600 seconds (10 minutes);

    CompDevPercent = 2 (% of span);

    CompMax = 28800 seconds (8 hours);

    Zero = 0;

    Span = 100.

    Why are the default values important to me?

    Because a deadband that is too wide will filter too much of your data and a deadband that is

    too narrow may give you a lot of unnecessary data.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 10

    On the other hand, there are instances where you would want to capture everything you

    collect with no filtering. You might be performing a calculation and want to capture every

    result, or you may have regulatory requirements that require you to store every reading.

    Everyones situation is unique. We simply present the options.

    For more information see the PI Server System Management Guide.

    1.3 Time and PI

    Objectives

    Express absolute time in the proper format

    Express relative time in the proper format

    Explain how PI handles DST

    1.3.1 The Absolute Time Format

    Absolute Time (a specific point in time)

    My PI client tools will accept any number of different time formats. You should use the one

    that is easiest for you although you will discover that some will be better than others. To specify a time in PI use one of the following:

    A PI Time Abbreviation

    A time alone

    A date alone

    A date and time combined

    A date or time can be a either the Windows time format (configured in the Regional Setting

    dialog of Microsoft Windows) or the PI Time format (dd-mmm-yy HH:mm:ss.00000)

    Note: If no date is specified the system will assume today. If no time is specified then the system will

    assume midnight.

    What are the Common PI Time Abbreviations?

    * represents NOW

    T represents today at midnight

    Y represents yesterday at midnight

    Monday or Mon represents Monday at midnight (or another specified day or its first three letters)

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 11

    1.3.2 The Relative Time Format

    Relative Time (time is offset from another time)

    + 8h : + 8 hours

    Combined Time (using Absolute and Relative Times together)

    t + 8h : today + 8 hours

    Relative Time Units of Measure:

    Hours (h)

    Minutes (m)

    Seconds (s)

    Weeks (w)

    Days (d)

    Years (y)

    Months (mo)

    Note: There is no default time unit. Hour, Minute and Second intervals can use fractions (for example

    +2.5h or -0.5m).

    1.3.3 How does PI Adjust for DST?

    The short answer is that we dont!

    When we collect data we convert it to UTC (Universal Coordinated Time), or what used to be

    called Greenwich Mean Time (GMT). This means that each day has exactly 24 hours. Any

    adjustments for time, such as time zone or Daylight Saving Time (DST), are made by the

    local machine clock of the user looking at the data.

    So once a year the day will look like it has 23 hours and another 25, but the PI Server never

    knows anything other than 24 hour days.

    Also, because the clients and PI Server know what time zone they are in, the data can be

    viewed in either Server Time or Client Time. This is determined by a setting in the client

    tool.

    1.3.4 Directed Exercise PI Times

    You are invited to watch what the instructor is doing or perform the same steps at the

    same time to explore the different concepts presented in this chapter or section.

    Problem Description

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 12

    Determine the times indicated in the table below:

    Abbreviation Answer

    * - 30m

    y + 8h

    Tuesday 2d

    Express the following times in valid PI time abbreviations:

    Abbreviation Answer

    Today at 6:00 AM

    Monday at 6:30 am

    12 hours ago

    1.3.5 Group Recap Question

    The following questions are intended to reinforce key information presented in this

    chapter or section. The answers can be found at the end of the book.

    Questions

    1. What are the four parts of OSIsofts PI System?

    2. What are the two filtering tests that each event can go through before being archived in the PI Server?

    3. What are the valid relative time units?

    Hours _____________

    Minutes _____________

    Seconds _____________

    Days _____________

    Weeks _____________

    Months _____________

    Years _____________

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 13

    2. ProcessBook: Connecting, Navigating, Trends, and Displays

    2.1 Create, Modify Connections to a PI Server

    Objectives

    Describe the common dialog boxes

    Connect to a PI Server and determine what credentials you are connecting with

    Modify existing connections using a common dialog window

    Cleanup connections in the Known Servers Table

    2.1.1 Introduction and Description

    There are three dialog boxes that are used in one way or another in every PI application that

    you will use. They are common because they address functions that are used regardless of the

    specific application. They involve:

    Connecting to a PI Server or Collective;

    Searching for Tags;

    Query for Tag Attributes / Values.

    Some applications will use different formats, but they all accomplish the same functions. For

    example, the Tag Search function on PI WebParts is based on different web architecture

    and thus looks slightly different.

    2.1.2 Create New Connections to a PI Server

    The PI Connection Manager is invoked from most applications and will control what PI

    Server(s) you can communicate with.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 14

    When the dialog box is invoked it will display all of the PI Servers that have been configured

    from that machine.

    Note: The first time a PI application is installed a default PI Server is selected. This is why even if you

    have never configured a PI Server at least one should appear in your PI Connection Manager.

    In this dialog box you can add and remove connections to PI Servers, add PI Server Aliases,

    change your default server, or change the user you are currently logged in as.

    You will need to know the following when you need to connect to a PI Server:

    IP Address or Host Name;

    Username;

    Password (if any).

    2.1.3 Cleanup Connections in the Known Servers Table

    All PI Server connections are stored in something called the Known Servers Table (KST).

    Each client computer keeps its own serialize list of PI Servers in the registry. Sometimes

    there can be duplicate or bad entries. Use this feature of the About PI-SDK application to

    clean it out.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 15

    2.2 Tag Search and Point Attributes Dialogs

    Objectives

    Search for tags

    Examine point attributes

    2.2.1 Search for Tags

    Tag Search is one of the most common functions that users will perform. There are three

    types of search:

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 16

    Basic

    Advanced

    Alias

    Basic and Advanced do the same thing, just in different ways.

    Basic allows you to search using common criteria through a defined menu

    Advanced allows you to search using a SQL like syntax.

    They both produce the same results.

    Note: Alias Search uses the PI Module Database.

    Most of the tag searches will be filtered in one of three ways:

    Tag Mask

    This can also be called Tag Name. If your organization has a convenient naming convention

    or you are very familiar with the tags in your plant, then you are all set. However, most

    people do not have that luxury. Most of us have to use some other criteria.

    Descriptor

    Descriptor is not a required tag attribute, but it is the one that many people use to find their

    tags. For example, a temperature tag might be TC365674A.pv but the descriptor might be

    read as Reactor 65 Operating Temp. The downside to searching by Descriptor is that it is

    comparing text strings, and so can be fairly intensive on your computer processes.

    Point Source

    Point Source can be extremely helpful, but it does require certain knowledge of the PI System

    and how the interfaces have been set up. Each device interface will be labeled with a specific

    Point Source. So if you know what device you want data from, but you are not sure what the

    tag names are, you can bring up a list of all of the tags that are associated with that device.

    Variations

    Remember that wildcards can be used in any of the above searches.

    Use * to replace any number of characters like in this example:

    flow* = flow_meter1, flow_meter2, flow_meter3

    Use ? to replace one character like in this example:

    tank?_level = tankA_level, tankB_level

    Note 1: Search criteria are not case sensitive, but are case preservative.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 17

    Note 2: Search criteria can be combined like in this example where we look for Tag Mask: =

    flow* and Point Source = o

    2.2.2 Search for Points, Advanced

    Advanced Tag Search allows those who prefer a SQL Query syntax to find the tags they

    need. In certain circumstances it can be more specific than the Basic Search.

    Note: Only the AND operator is supported.

    2.2.3 Directed Exercise Tag Search

    You are invited to watch what the instructor is doing or perform the same

    steps at the same time to explore the different concepts presented in this

    chapter or section.

    Problem Description

    You need to familiarize yourself with the principles of tag searching.

    Approach

    Answer the following questions using tag search:

    How many tags are there that begin with the letters BA:? __________________

    How many tags appear where he Compression Deviation is greater than 1 and the Point Class

    is 'Base' in the Advanced Tag Search?

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 18

    _______________________

    Which Tag Search method do you prefer? ______________________________

    2.2.4 Look at Point Attributes Using a Common Dialog Window

    The way we collect, aggregate, and store data is all determined by a tags configuration called tag attributes. Ever wondered how to actually see the tag attributes?

    Simply open a tag search, find a tag, and click Pt.Attr.

    For more information see PI Point Classes and Attributes (PI Server

    System Management Guide, version 3.4.380, pp. 21).

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 19

    2.2.5 Group Recap Question

    The following questions are intended to reinforce key information presented in this

    chapter or section. The answers can be found at the end of the book.

    Questions

    1. What information needs to be specified when creating a new connection to a PI Server?

    2. What are the two wildcard characters available in a Tag Search?

    3. Which of the following PI Tag Attributes are not default filtering search criteria in a Basic Tag Search?

    a. Point Type b. Tag Name c. Zero d. Point Class e. Point Source f. Typical Value

    2.3 Navigating, Resizing, and Formatting

    Objectives

    Navigate in Run and Build Modes

    Resize and reposition elements on a display

    2.3.1 Navigate in Run and Build Modes

    There are two modes of operation within ProcessBook, Run Mode and Build Mode.

    Run Mode has the following properties:

    Default mode;

    Allows you to browse PI ProcessBook (Workbook) elements;

    Visualize previously created displays;

    Change to Build Mode at any time by selecting Tools > Build or by clicking on the Build icon in the Drawing toolbar.

    Build Mode has the following properties:

    Build or edit PI ProcessBook (Workbook) elements;

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 20

    Add or modify elements within an existing display;

    Change mode by selecting Tools > Run or by clicking on the Run icon in the Drawing toolbar.

    2.3.2 Resizing Elements in Build Mode

    In Build Mode when you select an object (with a single click) you can resize and reposition it

    on the display.

    2.4 The Display, Status Report, and Tooltip Statistics

    Objectives

    Identify invalid elements using the status report

    Show statistics information added to tooltips

    PI ProcessBook displays one or more ProcessBooks, which are collections of display entries.

    For more information, see "What Can You View with PI ProcessBook" in

    PI ProcessBook User Guide, version 3.2, pp. 1-2.

    Here is an example of what a ProcessBook Display can look like:

    2.4.1 The Status Report

    A Status icon (labeled 3 in the figure below) is at the bottom of the display in the Status Bar.

    A green circle indicates all dynamic elements are good. If the circle is red, at least one

    dynamic element is in a Bad Data state. To find out which element(s) is in error, you can

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 21

    double-click on the Status icon to open a pane displaying a list of all dynamic elements and

    their individual states.

    For more information, see "Status Report for Dynamic Symbols" in PI

    ProcessBook User Guide, version 3.2, pp. 161-162.

    2.4.2 Other Status Bar Elements(Optional)

    There is a Status Bar at the bottom of the display window. This Status Bar shows several

    pieces of information about the display(s) that is open. It shows whether the data being

    displayed is using the Time Zone for the PI Server or for the Client Time (1). It shows the

    Layers of displays that are open (2). Finally, there is an icon representing the Default Line,

    Fill, and Background color for an element (4).

    2.4.3 Tooltip Statistics

    Hovering the mouse cursor over a dynamic element presents the Tooltip Statistics, which

    presents the statistics for the longest time range specified by an element in your display.

    These Statistics are the average, minimum, maximum, count, range, and population standard

    deviation.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 22

    If the data source is unavailable, Trends show nothing, Dynamic Values show "No Data",

    Trend Cursors show "No Data", Bar Graphs show diagonal lines, and Multi-state Symbols

    show the user defined Bad Data color.

    2.5 Details Docking Window, Browser Toolbar, and Playback Toolbar

    Objectives

    Use the Details docking window to show data in a table

    Use the Details docking window to show, add or edit annotations

    Use the Details docking window to export data to file

    Navigate using the new Browser toolbar, home, and bookmarks

    Use the playback functionality to change the timerange

    2.5.1 Details Docking Window

    It is possible to view the Details about a dynamic element by going to View>Details or right-

    clicking and selecting Show Details and Annotations. You can choose Data, Statistics, or

    Point Attributes. If you select Data, you can view snapshot and compressed data, and

    annotations from a dynamic element selected on your display.

    2.5.2 Add Annotations

    If you have write privileges to the specified point, it is also possible to write an annotation

    directly from the display. Annotations are stored on the PI Server and so will be available to

    all users and will be stored with your process history.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 23

    By choosing Statistics, you can view the same statistics as the Tooltip Statistics, but without

    having to hover the cursor. And selecting Point Attributes allows you to see the list of

    attributes and values for the selected point.

    2.5.3 Export Data to a File

    Data, Statistics or Point Attributes can be exported to a file or copied to the clipboard. If you

    choose to export to a comma delimited .csv file, you can easily import that into Microsoft

    Excel.

    2.5.4 The Browser Toolbar

    It is also possible to navigate between PI ProcessBook Workbooks and Displays using the

    Navigation Toolbar. This toolbar, shown below, allows you to easily open recently opened

    Workbook and Display files from the drop down menu, use the forward and backward arrows

    to switch between displays rapidly, set a Home Workbook or Display, and to Bookmark

    several of your favorite displays. This toolbar should hopefully be intuitive as it is

    reminiscent of a web browser navigation toolbar.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 24

    2.5.5 The Playback Toolbar

    Below the Navigation Toolbar is the Playback Toolbar, shown below. This lets you easily

    scroll through the time range of your entire display. You can manually change the time range

    included by clicking and dragging the end markers individual, or you can slide the whole

    time range by clicking and dragging from somewhere in the middle of the time range. Finally,

    there are play, stop, and fast-forward buttons that provide control very similar to a DVR or

    other recording device. This allows you to scan the display quickly.

    2.6 Navigating Within a Trend, Trend Cursor, Show/Hide Trace

    Objectives

    Create a Trend in Run Mode

    Expand and reduce a trend in Run mode

    Use the zoom in and out functionality directly on the trend

    Use the Revert button on the time axis

    Use forward and backward arrows on the time axis

    Show timestamp of a value with the Trend Cursor

    Show and hide multiple traces on a Trend

    2.6.1 Create a Trend in Run Mode

    You can quickly produce a trend of any dynamic symbol on an existing display to

    immediately research the history of any symbol on your display.

    In Run mode, there are two ways to create a trend.

    1. In the current window, select one or many values. 2. Then click on the Trend button, and draw a rectangle to display the trend.

    Or:

    1. For a trend in a new window, select one or many values.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 25

    2. Then click on the Trend Display button to create an Ad-Hoc Trend. It is possible to save this new window as a Display using File>Save.

    2.6.2 Expand and Reduce a Trend

    Certain functions can be used in Run mode only. A full screen trend is activated by double-

    clicking on the trend in the display in Run mode. Double-click again to deactivate it and

    return to the full ProcessBook display.

    2.6.3 Zoom In and Out

    You can zoom in and out on a trend by clicking the cursor and drawing a rectangle to

    represent the boundaries of the area over which you would like to zoom in on. This will

    temporarily change the x- and y-axes.

    You can also manually change the vertical axis by selecting the View>Trend Scale or by

    double-clicking on the vertical axis. This will open a pop-up window where you can choose

    one of three options for the vertical scale. The Autorange option scales to the minimum and

    maximum of the tag over the specified time range. The Database option scales to the zero

    and span of the tag. Finally, you can select the Absolute option, which lets you specify the

    exact minimum and maximum you would like displayed. These three options for scaling are

    common within the trends in our client tools, and they will be seen again.

    There are also buttons provided on each trend for zoom options. The magnifying glasses

    either halve or double the time range currently shown. The arrows move forward or backward

    one unit in time as currently shown.

    In the example above, the plus magnifying glass will halve the time range specified, in this

    case taking it from 8 hours to a time range of 4 hours. The minus magnifying glass will

    double the specified time range, in this case going from 8 hours to 16 hours. The forward and

    backward arrows will move the trend forward and backward in time, in this case an amount

    of 8 hours.

    2.6.4 Reverting a Trend

    You can use the Revert button to go back to your original configuration. This is an easy way

    to return to the configured view after you have zoomed in or out on a specific time range.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 26

    2.6.5 Scroll Forward and Backward through Time

    Finally, you can use the menu or toolbar to change the time range of the trend. To change it

    from the toolbar, use the Change Time Range icon. To change the time range from the

    menu, you must select View> Time Range. Either of these will open a pop-up window that

    allows you to specify the start time (the From parameter) and end time (the To parameter) in

    either PI Absolute or Combined time. It is important to note that for your trend to receive

    automatic updates that the end time must be now (*) and that the time range must be 7 days

    or less (24 hours or less for ProcessBook v. 3.0 or earlier).

    2.6.6 Trend Cursors

    Trend cursors are static indicators that display the timestamp and value(s). You can have

    multiple trend cursors per trend, and they can display values for multiple traces (tags). To

    activate a cursor, just click on the edge of the trend and drag to the point of interest on the

    trend. You can also set them manually from the toolbar by clicking on the Trend Cursor

    icon.

    2.6.7 Show/Hide Traces

    Traces can be shown or hidden by clicking on the tag name in the legend or by right-clicking

    on Trend > Trend Traces. Traces can be shown or hidden individually or all at once.

    Changes made in View mode are temporary. To make any changes permanent, you must be

    in Build mode and save the display.

    2.6.8 Exercise PI ProcessBook Basics

    The following exercise is intended to reinforce key information presented in this

    chapter or section. The answer can be found at the end of the exercise.

    Objectives

    Familiarize yourself with the Common Dialog Windows;

    Familiarize yourself with the PI ProcessBook environment;

    Learn how to manipulate a trend display using an existing ProcessBook file;

    Find data, statistics and annotations related to tags.

    Problem Description

    Open the PI ProcessBook application and establish a connection to a PI server. If you do not

    know the name of your PI Server or the username and password you will use, please contact

    your PI system manager.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 27

    The default workbook PIDEMO.PIW opens. Open the Main Column Bottom display and

    familiarize yourself with the different windows, options and functions. Within the four

    different sections below, you will explore all those essential items and will be able to fulfill

    the objectives.

    A. The PI ProcessBook Environment: 1. Open the different top bar menus to have a taste of the different functions available; 2. Observe the different toolbars that contain the same functions you just saw in the menus; 3. Maximize the Main Column Bottom display.

    B. The common dialog windows: 1. Open the Connections window and connect to your PI server (hint: Use the File menu); 2. Open the Tag Search window and find all tags that begin with the letter b, all tags that contain

    the word reactor in their descriptor and all tags that have a value of zero (hint: Use the Tools

    menu).

    C. The Trend display: 1. Maximize the Crude Charge trend; 2. Zoom in and out of the trend; 3. Change the time scale to 1 day; 4. Go backward and forward in time by one or by several time periods; 5. Find when the maximum value was attained for the current time range (Hint: Use the Trend

    Cursor);

    6. Revert back to the original time scale; 7. Highlight the trace of the trend; 8. Hide the trace of the trend and then make it appear again.

    D. The details and annotations: 1. Point the mouse directly on the trend trace and wait until you can observe the ToolTip yellow

    window;

    2. Point other symbols from the display and wait until you can observe the ToolTip yellow window; 3. Right-click on the trend and click Show Details and Annotations; 4. Observe the Data, Statistics and Point Attributes for the trend; 5. Validate the timestamp you just found for the maximum value; 6. Refresh the Data displayed; 7. Save the Statistics to a file; 8. Copy the Point Attributes and paste them in a Microsoft Excel spreadsheet; 9. Add an annotation to the latest value to indicate an out of range value.

    Try to do this exercise on your own before proceeding to the step-by-step solution.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 28

    Step-by-Step Solution

    A. The PI ProcessBook environment 1. Open PI ProcessBook Application. 2. Click on the Refinery tab.

    3. Double-click on the Main Column Bottom display.

    4. Open the top bar menus: File, Edit, View, Insert, Tools, Draw, Arrange, Window and Help. 5. Stop your mouse on some of the different icons of the toolbars to observe those with the same

    functions that are present in the menus you just opened.

    6. Maximize the Main Column Bottom display window by clicking on the ( ) button located on the upper-right corner.

    B. The common dialog windows 1. The Connections window

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 29

    Open the Connections window by selecting File > Connections. Select Server > Add Server to add a PI server. Enter the PI server name in the Network Node field and the user name in the Default User

    Name field.

    Note: Remember that they were specified to you by your trainer

    Leave the Port Number to the 5450 value Click on the OK button to add the specified PI server.

    Check the checkbox beside the PI server you want to connect to. If you are prompted for a password, enter the one that will be specified by the trainer.

    2. The Tag Search window

    Open the Tag Search window by clicking on the ( ) button or by selecting Tools > Tag Search.

    Enter b* in the Tag Mask field and click on the Search button to get all the tags beginning with the letter b.

    Click on the first tag of the result list. Then, press and maintain the Shift key and click on the second tag of the list. The first two (2) tags will be selected. Click on the Pt. Attr button to

    access the attributes of those tags. You can move from one tag to the other with your keyboard

    arrow keys.

    Write * in the Tag Mask field and *reactor* in the Descriptor field, then press on the Search button to find all the tags containing the string reactor for their descriptor attribute.

    Erase the data in the Descriptor field and enter 0 (zero) in the Value field, then click on the Search button to find all the tags with a snapshot value of 0.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 30

    Note: The more criteria you use for your tag search, the more effective you will be in finding exactly the

    tag(s) you need.

    C. The trend display 1. In Run mode, maximize the Crude Charge trend to take the entire display window by double-

    clicking within the trend. To return to the original time scale, double-click within the trend again.

    2. Display a section of the trend display. Click and drag the pointer diagonally to draw a rectangle. This area will be magnified when you release the mouse button. To return to the original time

    scale, use the View > Revert or use this button ( ).

    3. Modify the time range by using the View > Time Range and set it to 1 day to now (*-1d and *).

    4. Use the time forward and backward buttons ( ) to scroll the time range forward or backward on the trend. Try to playback the last week of data by clicking six (6) times on the

    Move backward in time button and then return to the current time by using the Move forward

    in time.

    5. Return to the original time scale (See step 2).

    6. Use a Trend Cursor to find when the maximum value of the last day occurred ( ). 7. Return to the original time scale (See step 2). 8. Alter the Y-axis scale of a trend by double-clicking on the Y-axis. Use the Trend Scale dialog

    box to change the vertical scale for the tag in the trend. You do not have to be in Build ( )

    mode to edit the trend.

    9. Move the mouse cursor over the SINUSOID trace or the SINUSOID tag label in the legend area and click to hide this trace. You can notice that when the mouse cursor is over the trace or the tag

    label are highlighted. Click again to display them again.

    D. The details and annotations

    1. Maximize the Crude Charge trend. 2. Point the mouse directly on the trend

    trace and wait until you can observe the

    ToolTip yellow window.

    3. Minimize the trend. 4. Point the mouse directly on any other

    symbols and wait until you can observe

    the ToolTip yellow window.

    5. Right-click on the trend and click Show Details and Annotations. The Show Details and

    Annotations window will appear on the right. The Data option should be presented to you.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 31

    6. Observe the Data, Statistics and Point Attributes for the selected tag by changing the Option field.

    7. Validate if the maximum value you have found in part C is the same returned by the Statistics window.

    8. Refresh the tags data from Data option by clicking on the Refresh Data button ( ).

    9. Choose the Statistics option and click on the Save to file button ( ). Enter the filename and choose the extension: .TXT or .CSV.

    10. Using the Windows Explorer locate the file you just saved and open it. 11. Open a blank MS Excel spreadsheet.

    12. Choose the Point Attributes option and click on the Copy to clipboard button ( ). Switch to MS Excel application, select the cell which will receive information and select right-click >

    Paste. The Point Attributes information will be copied from the clipboard to MS Excel.

    13. Choose the Data option. Select the last event in the data grid by clicking on it once. The Annotations section will no longer be grayed out.

    14. Click in the Value field of the first row and enter: This value is out of range. 15. Click in the drop-down list of the Value Type field and choose String. Leave the description field

    empty.

    16. Click on the Save all changes button to save the annotation with the event. 17. You can try to visualize the annotation from the trend object. An annotation takes the

    representation of a white sheet above the trace area as shown in the figure below. If you move

    your mouse cursor over and leave it there for a moment you can read the added comment.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 32

    18. Exit PI ProcessBook without saving.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 33

    2.7 Building a Display, Add Static Elements, the Symbol Library

    Objectives

    Create new independent displays

    Create and edit static elements

    Insert Symbol Library images

    2.7.1 Create a Display

    To create a new ProcessBook file use File > New or the New icon. From here, you can create

    new ProcessBook Displays, ProcessBook Workbooks, or ProcessBook Entries. The easiest

    ways to conceive of ProcessBook Displays are that they are individual sheets, similar to

    memos. Workbooks are entire books that are composed of many of these sheets, but to put

    these sheets in the book, we need to create individual Entries. For now, we will focus on

    Independent Displays and return to Workbooks and Entries later.

    A display can contain a wide variety of elements, both static and dynamic. To add any of

    these elements to a display, you must be in Build mode, and then select the desired element.

    Draw it on the display and define its configuration when prompted. For now, we will focus

    on the static elements.

    2.7.2 Add and Edit Static Elements

    The static objects available include shapes, lines, and text boxes. ProcessBook does come

    with its own Symbol Library that includes many familiar process symbols. These include

    things like tanks, values, and heat exchangers.

    The majority of the static elements have options similar or identical to many Paint programs.

    Things like grouping, alignment, stacking, rotation, and attachments. Just like these Paint

    programs, you can do multiple object selection by clicking and dragging, using the Control

    key, or using the Shift key.

    If this Symbol Library (described below) is insufficient, you can also import graphics from

    files. Use Draw > Graphic to insert a graphic file. This provides you greater options for

    customization.

    2.7.3 The Symbol Library

    The symbol library button allows access to a rich library of symbols. To access the symbol

    library, use the Symbol Library icon from the toolbar or Draw> Symbol Library from the

    menu. Similarly, to import an image file into a display, use the Graphic button in the toolbar

    or select Draw > Graphic from the menu.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 34

    2.7.4 Group Recap Questions

    The following questions are intended to reinforce key information presented in this

    chapter or section. The answers can be found after the questions.

    Questions

    4. What two user interface elements allow you to change the start time and end time of a Trend or XY Plot in Run mode?

    5. Which one of these statements is false:

    In Run mode, both the vertical scale and the time scale of a trend element can be changed. After changing the display in Run mode, the modifications will be saved if we do not use the

    Revert function before saving the file.

    The status report will indicate all tags used in the display that are in error and their associated ProcessBook elements.

    6. What type of information can be stored within an annotation?

    2.7.5 Exercise Inserting Static Elements into Displays

    The following exercise is intended to reinforce key information presented in this

    chapter or section. The answer can be found at the end of the exercise.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 35

    Objective

    Learn to add static elements to your displays.

    Problem Description

    The goal is to represent a process as a schematic to make it easy for all personnel to identify

    its components. Drawing tools are available to create schematics. In this exercise, you are to

    create a simple schematic to represent a tank, an agitator and a valve as presented in the

    figure below.

    Approach

    Create a ProcessBook independent display file called Exercise PB2.PDI. To make it easier to

    align items, you can activate the Snap to Grid option by selecting Arrange > Snap to Grid.

    Add the following items to the display:

    One tank from the Symbol Library. You can use any tank you wish.

    One horizontal pipe from the Symbol Library going into the tank and one pipe going out. If you wish you can draw one long pipe and set the tank over it, so it

    appears to pass behind it.

    One text box labeling the tank Stirred Tank. Place this near the tank. You may wish to alter the color and size of the text for visibility.

    One mixer from the Symbol Library. Place this over the tank.

    One valve from the Symbol Library. Place this over the pipe, so it appears that the valve is in line with the pipe flow.

    There are many possible solutions yours does not have to look exactly like this. Feel free to improvise and be creative with your display.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 36

    Try to do this exercise on your own before proceeding to the step-by-step solution.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 37

    Step-by-Step Solution

    1. Create a new PI ProcessBook independent display using the following steps:

    Click on File > New. A new screen appears with three choices:

    ProcessBook (.piw) File; ProcessBook Entry; ProcessBook Display (.pdi) File.

    Select ProcessBook Display (.pdi) File and name it Exercise PB2. Click on the OK button. A new screen will appear with the name Exercise PB2. Save this ProcessBook with the name Exercise PB2.PDI.

    2. It can be easier to arrange and align objects when the grid is activated. Select Arrange > Snap to grid option.

    3. Draw the tank by selecting Draw > Symbol Library. Once this option is selected, use the left button of the mouse to select the area where you want to draw the symbol. Select the tank category, then a

    tank symbol.

    4. Click on Options if you want to change the color or fill pattern of the tank. Note that the color can only be changed if the fill mode is Shaded, Solid or Hollow.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 38

    5. Draw the pipes by selecting Draw > Symbol Library. Once this option is selected, use the left button of the mouse to select the area where you want to draw the symbol. Select the pipes category,

    then a horizontal pipe symbol. Stretch to fit. Repeat if necessary for the second pipe.

    6. Draw the agitator by selecting Draw > Symbol Library. Once this option is selected, use the left mouse button to select the area where you want to draw the symbol. Select the mixers category, then

    a mixer symbol. Click on Options if you want to change the color or fill pattern of the tank.

    7. Add a Text item by selecting Draw > Text. Write in the tank: Stirred Tank. 8. Draw the valve by selecting Draw > Symbol Library. Once this option is selected, use the left

    button of the mouse to select the area where you want to draw the symbol. Select the valves

    category, then a symbol. Click on Options if you want to change the color or fill pattern of the tank.

    9. Save the display and exit the display.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 39

    3. ProcessBook: Dynamic Elements and ProcessBook Workbooks

    3.1 Dynamic Elements, Data Favorites

    Objectives

    Use the Data Favorites docking window to drag and drop items to create dynamic elements

    Import and Export your Data Favorites for consistency

    3.1.1 Introduction to Dynamic Elements (Optional)

    Dynamic Elements are ProcessBook objects that are linked to PI data and that update in real-

    time. The following Dynamic Elements can be added to a display:

    Trend

    XY Plots

    Bar Graphs

    Dynamic Values

    Multi-State Objects

    3.1.2 Drag from Data Favorites to Create a Dynamic Symbol

    Data Favorites is a way to store a persistent list of the tags you reference the most often. It is

    accessed by View> Data Favorites. This allows you to configure dynamic elements by

    dropping a data source from the list onto the display or element. You specify if you would

    like to create a Bar, Trend, Dynamic Value or XY Plot elements when a data reference is

    dropped. Additional traces are added when dropped onto an existing Trend or XY Plot. You

    can also create multiple items at a time.

    The Data Favorites pane consists of two sections, the Search and Favorites sections. The

    Search section is where you can search for tags based on tag mask or use the Tag Search icon

    to open a dialog for increased search options. When the tags are listed, you can drag and drop

    individual tags into your Favorites section, or you can select one or multiple tags, right-click,

    and then select Add to Favorites.

    3.1.3 Import/Export Data Favorites

    The list of Data Favorites is local to the machine only. So to propagate a consistent list of

    Data Favorites across multiple physical machines, it is possible to import and export your list

    of Data Favorites to and from a file. Simply right-click in the Favorites section and choose

    the appropriate action. You can import favorite tags from any applications supporting drag

    and drop like Excel, Word, etc.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 40

    3.2 Build Trends, Linear Regression, the Format Paintbrush, and XY Plots

    Objectives

    Build a Trend

    Add a linear regression trace to a trend

    Use the Format paintbrush

    Build an XY Plot

    3.2.1 Build a Trend

    To build a trend in a display, you must first be in Build mode. There are then three different

    ways to build a trend. You can just drag and drop the Data Favorite with the Trend option

    selected. Alternatively, you can use the menu option by selecting Draw > Trend or use the

    toolbar by clicking on the Trend icon. Then draw a rectangle with the mouse to define the

    size of the trend. A design window with four different tabs allows configuration of the trend:

    General;

    Display Format;

    Trace Format;

    Layout.

    For more information see "Create a Trend" in PI ProcessBook User Guide,

    version 3.2, pp. 81-84.

    In the Display Format tab, Markers indicate PI archived values. When not checked three

    trace markers appear at evenly spaced intervals to help identify individual traces on a

    multiple trace trend.

    3.2.2 Add a Regression Line

    You can also add a regression line in the form y=mx+b, where m is the slope and b is the y-

    intercept. Simply check the box in the Trend Definition configuration pane.

    3.2.3 The Format Paintbrush

    Use the Format paintbrush to copy the formatting properties to another trend. Double-clicking

    the Formatting Paintbrush button allows you to apply formatting to more than one symbol.

    To turn off the formatting paintbrush selection, click the button again or press the ESC key.

    There is a maximum of fifty traces by default, but this setting can be changed. (This change is

    made in Procbook.ini. For more information on this see Trend Definition Section in the PI

    ProcessBook User Guide, version 3.2, p. 215).

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 41

    3.2.4 XY Plots

    XY Plots, also known as Scatter Plots, are used to show relationships between value sets. It is

    a powerful tool to graphically show the correlation between two or more tags.

    Values on the horizontal scale (x-axis) represent the values of a PI point rather than time.

    For more information see "XYPlots" in PI ProcessBook User Guide,

    version 3.2, Ch. 6, pp. 101-119.

    3.2.5 Exercise Building Trends in ProcessBook

    The following exercise is intended to reinforce key information presented in this

    chapter or section. The answer can be found at the end of the exercise.

    Objectives

    Build trends.

    Familiarize yourself with the different trend building options.

    Problem Description

    You are now ready to create a trend with PI tags. You will need a new display in your

    workbook to do this. Make sure you create the display inside your workbook.

    Approach

    Create a ProcessBook independent display file called Exercise PB3.PDI.

    Add a trend containing the SINUSOID tag. Use the trend item from the tool bar. (Hint: Make sure you are in build mode)

    Make the trend show the last 5 days of values;

    Label the trend so the title reads Exercise PB3.

    If the time permits, add a second trend showing all of the tags that begin with the letters BA:.

    Try to do this exercise on your own before proceeding to the step-by-step solution.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 42

    Step-by-Step Solution

    1. Create a new PI ProcessBook independent display using the following steps:

    Click on File > New. A new screen appears with three choices:

    ProcessBook (.piw) File; ProcessBook Entry; ProcessBook Display (.pdi) File.

    Select ProcessBook Display (.pdi) File and name it Exercise PB3. Click on the OK button. A new screen will appear with the name Exercise PB3. Save this ProcessBook with the name Exercise PB3.PDI.

    2. In Build mode, use the Trend tool ( ). Drag diagonally to create a rectangular area to contain the trend. When you release the mouse button, the Trend definition dialog box is displayed.

    3. Enter the following information in the General tab:

    Type the trend name in the plot box: Exercise PB3 - Trend; Use the Tag Search button to locate and select the SINUSOID tag. To facilitate the query, use a

    mask like SIN*;

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 43

    Specify the time range to display the last 5 days in the plot time section by setting the style to Full time stamp, the Start field to *-5 Day and the End field to *;

    Click on the OK button to create the trend. 4. Save the trend object by saving the display using File > Save. 5. Optionally repeat the steps above except in the Tag Search find all tags with a tag mask of BA:*.

    Leave the remainder of the options to their defaults.

    6. Save the trend object by saving the display using File > Save.

  • PI ProcessBook, PI DataLink, PI WebParts Course

    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.

    Copyright 1995-2010 OSIsoft, LLC, 777 Davis St., Suite 250, San Leandro, CA 94577

    Page 44

    3.3 Bars, Values, Multi-State Objects and Buttons

    Objectives

    Build a Bar Graph

    Build a dynamic Value

    Create a Multi-State Object

    Insert a command button

    3.3.1 Bars

    A Bar Graph shows the current value of a tag as compared to a specified range of values.

    For more information see "Bars" in PI ProcessBook User Guide, version

    3.2, pp. 125-127.

    A common mistake is to confuse Fill color with Background color when working with Bars.

    Typically Fill color is the bottom part that indicates the value of a traditional empty/full

    gauge and the Background color is the top part of the gauge.

    3.3.2 Values

    A Value is the reading obtained at a particular moment in time for a tag in the PI database.

    For more information see "Values" in PI ProcessBook User Guide, version

    3.2, pp. 121-123.

    3.3.3 Multi-State Symbols

    A Multi-State symbol is one that changes color to reflect changes in value for a particular

    tag. Any object except a trend, graphic, button, or OLE object can be made a Multi-State

    symbol by assigning a tag to it.

    For more informat


Recommended