pi training course modificado

271
Copyright © 2007 OSIsoft, Inc. PI TR-011 IT Monitor Server and Interfaces Version 2.1 PI Training Course

Upload: david-barba-naranjo

Post on 07-Sep-2015

7 views

Category:

Documents


0 download

DESCRIPTION

Curso en donde se describe las funcionalidades del software PI (Osisoft) para gestión de históricos.

TRANSCRIPT

PI Training courseVersion 2.1
*
Introduction to PI and IT Monitor
PI Architecture and Data Flow
PI Server Installation and Management
Managing Archives
PI Backup
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
What is IT Monitor?
IT Monitor Demonstration
Examples of what you can do with IT Monitor
Overview of what students will be able to do after the class
2.0 PI Architecture and Data Flow
2.1 PI Architecture
2.2 Data Flow
2.3 PI Points
4.0 Managing Archives
PI Archiving System
PI Archive Shifting
PI Archive Maintenance
5.0 PI Backup
Exception/Compression Settings
Zero/Span Attributes
7.1 PI Time Format
7.2 Common Dialog Windows
Copyright © 2007 OSIsoft, Inc.
PI ProcessBook
PI DataLink
*
IT Monitor Interfaces Overview
*
IT Monitor
Reliability Category
Performance Category
Security Category
PI Interfaces Data Flow
PI Performance Monitor Interface
PI Related Counters and other examples
Copyright © 2007 OSIsoft, Inc.
PI Windows Event Log Interface
PI SNMP Interface
Organizing Monitored Devices
PI SNMPTrap Interface
PI SysLog Interface
*
What are Windows Event Logs?
PI Windows Event Log Interface
Description
19.0 PI SNMPTrap Interface
PI SNMPTrap Interface
PI Security
Distributed Interfaces
Global Recap exercise
*
22.2 PI Database Security
PI IP Flow Interface
26.3 OSIsoft Developers Network
27.0 IT Monitoring Suggestions
Copyright © 2007 OSIsoft, Inc.
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
What is IT Monitor?
IT Monitor Examples
Objectives:
Be able to explain what the PI system is
Be able to explain what the RtPM platform is
Be able to explain what the IT Monitor and MCN-HM products are
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Collects real-time information regarding the performance of various elements composing an IT infrastructure
Printers
*
What is IT Monitor?
Data on the current status of an information technology (IT) infrastructure is readily available. There are many tools available that can obtain values for the CPU load of a server or the bandwidth utilization on a network. However, these tools typically store data only for a short period of time. Thus, many issues concerning the long-term health and behavior of an IT infrastructure go unresolved, simply because of the lack of historical information.
OSIsoft’s PI IT Monitor product collects real-time information regarding the performance of various elements that compose an IT infrastructure. In addition to collecting real-time values, PI IT Monitor archives such data and makes it available for use in reporting, analysis, troubleshooting, and decision making.
Copyright © 2007 OSIsoft, Inc.
MCN-HM (Manufacturing Control Network – Health Monitor)
4 additional data collection agents (PI Interfaces) to a regular PI System
IT Monitor
Several IT-purposed PI Interfaces
*
What is the PI System?
Software suite that creates an advanced information management system to acquire data from your process.
Includes sophisticated processing tools to transform that data into intelligence to help personnel make timely decisions.
Configurable, interactive displays and reports deliver information whenever and wherever needed.
PI stores a nearly infinite amount of data, at its original resolution, virtually forever.
Part of OSIsoft’s Real-time Performance Management (RtPM) platform.
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
The PI System
OSIsoft’s PI System turns volume operations data into a powerful, focused corporate asset. This advanced information management system acquires data from your plant or process, usually from automated control systems or other sources. Sophisticated processing tools transform that data into relevant intelligence that people can rely on to make timely decisions. Configurable, interactive displays deliver information wherever it's needed. And PI stores a nearly infinite amount of data—at original resolution—virtually forever.
The PI System offers real-time process insight throughout the enterprise, saving costs, boosting productivity, averting mistakes, and supporting business decisions. PI is primarily used in process industries, but its flexibility, versatility and fast, economical deployment make it a valuable asset in any organization. More than 10,000 enterprises across a broad range of industries have now benefited from OSIsoft’s PI system.
Now OSIsoft takes enterprise information management to the next level with Real-time Performance Management (RtPM), the industry’s most sophisticated platform. RtPM’s event-driven, scalable management of the total business decision cycle drives informed decisions across all boundaries, And with its streamlined portal, RtPM enables intelligent collaboration never before achievable.
Copyright © 2007 OSIsoft, Inc.
Visuals
*
Functional Groups of the PI System
The PI System is categorized by three major product functions. They are classified in a somewhat self-explanatory way to help identify relevant functionality. Today, these product packages contain many familiar products, but in time some of these products will become more tightly coupled, and less like independent sets of products.
The three groups, from bottom to top are The Server, The Analytics, and The Visuals. These names describe their primary logical functionality. Some products may share a presence in several product groups, however their predominant functionality will be represented in a grouping.
All these groupings exist to help understand the function of our products, not help you navigate product names or install the products we ship.
The Server gives you that all-important real-time reference platform upon which you can build applications, reports, and visualizations. Without this layer, you won't have a consistent way to use the information available to you. In other words: many versions of the truth (which is less than ideal).
The Analytics provide the server-based analytical functionality and products for The PI System. Don't think about it in a deployment sense. This is LOGICALLY where this functionality lives. It doesn't matter where the actual applications are getting installed.
The Visuals are all the client products that talk to The PI System. Both Thin and Smart (or Rich) clients are represented in The Visuals. When we consider the Thin Clients, think of them as a "portal" into the other PI System components… a way to see what's going on. Do NOT think of this as a "Portal". We are not a portal vendor, but we make parts that can enhance a portal's functionality.
Copyright © 2007 OSIsoft, Inc.
OLEDB
ODBC
Web Services
COM Connectors
ERP / Maintenance
Server
The
Analytics
The
Visuals
The
*
*
*
*
Advanced Computing Engine
Analytics
The
Server
The
Visuals
The
*
* Microsoft Office SharePoint Server 2007
Microsoft SQL Server
Intel Pentium 4
Performance
Improvement
Operational
Visibility
Knowledge
Management
Product
Quality
Lean
Manufacturing
Asset
Management
Situational
Awareness
RtTreeView
RtTrend
RtTable
RtXYPlot
RtTimeRange
RtTreeView
RtTrend
RtKPI
The Visuals – Platform Release 1
Visuals
The
Analytics
The
Server
The
*
Why to use OSIsoft's IT Monitoring Tools?
In other words, why is historizing IT data in the PI System a good point?
PI being part of a platform, archiving data leads to a large number of products/tools/technologies for further analysis or calculation
Centralized, organized and flexible ways of looking at IT information, all throughout the organization
Very long term history that allows troubleshooting recurrent – but not frequent – problems
Real-time operations such as alarming
Highly scalable, meaning all of the above for very large numbers of devices/counters on a network
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
*
IT Monitor Architecture
PI Server Subsystems
*
PI Architecture Overview
In a typical PI System installation, the Data Source is linked to the PI Server (formerly named PI Universal Data Server or PI UDS) by an Interface Node (also called "Data Acquisition node", or formerly a PI API node or a PI NET node in the documentation). This node is responsible for transferring data between the data source and the PI server. It also buffers the data when the PI Server is unavailable.
The Data Acquisition node and the PI Server can be a single unit – however, there is no buffering capability in this case. Therefore, data will be lost if the Data source cannot communicate with the PI Server.
The Data Acquisition Node can be connected to the Data Source using a network card (proprietary or standard NIC), a Serial cable, SCSI cable, etc. It is often placed close to the Data Source to prevent network problems from interrupting the data flow.
Data Acquisition nodes can run multiple interfaces to multiple systems or run multiple instances of an interface to the same system (dividing the load). The Data Acquisition Node sends data to the PI Server, where it is permanently archived. PI Servers can handle thousands of continuous data streams and run calculations on this incoming data.
Data can be retrieved by users from the PI Server via PI Client Tools, such as PI ProcessBook and PI DataLink.
Copyright © 2007 OSIsoft, Inc.
Optional (and recommended)
*
IT Monitor Architecture
The same architecture is used with IT Monitor. In this case, the Data Sources are IT devices such as:
Workstations;
Printers;
Servers;
Network routers;
Network switches;
Network traffic.
The Data Acquisition Node is optional, but recommended. If it is not present, the PI Server communicates directly with the Data Sources, therefore there is no buffering capability.
To collect data from the Data Sources, IT Monitor uses software programs called interfaces. These interfaces can be on either the PI Server or the Data Acquisition Node.
72234.unknown
72235.unknown
72236.unknown
Utilities
Interfaces
*
PI Server Subsystems
The PI System’s central subsystem is called the PINetMgr. It provides the connection among PI Server Subsystems residing on the PI home node. Other subsystems included into the PI Server Core Subsystems are:
PI Message Subsystem (PIMsgSS): records status and error messages for the PI Server in a log file;
PI Update Manager (PIUpdMgr): sends notifications of changes in values or point attributes to any interface or client application that has "signed up";
PI Base Subsystem (PIBaseSS): maintains the Point, Digital States, User, Group databases and also hosts the PI Module Database;
PI Snapshot Subsystem (PISnapSS): stores the most recent value for each point and makes it available to users and applications as needed;
PI Archive Subsystem (PIArchSS): stores multiple time stamped measurements of each data point;
PI Shutdown Subsystem (PIShutEv): writes the value Shutdown to all points configured with the shutdown attribute set to 1, when the PI Server starts up; timestamp used is the time of the last shutdown;
PI SQL Subsystem (PISQLSS): allows the PI System to be seen as a SQL-accessible relational database;
PI Redirector: used by the Base, Archive, and Snapshot Subsystems to obtain data from external systems.
Utilities and Applications
OSIsoft provides several utilities to help the PI System manager configuring and maintaining the PI System.
The PI Performance Equations Scheduler (PIpeschd) is a service that allows making calculations with raw data received from the interfaces.
Copyright © 2007 OSIsoft, Inc.
*
*
PI Client Data Requests
A client application can make a request through PINetMgr for either real time snapshot data, archive data, or point database tag searches. The Snapshot, Archive, and Base subsystems will respond with local PI data.
Copyright © 2007 OSIsoft, Inc.
*
Archive Cache
The PI System uses a memory-resident Archive Cache to reduce the frequency of disk access. Cache records are flushed to disk when they are needed for processing other points or at least every 15 minutes (configurable). Therefore, the maximum amount of archive data that can be lost in the event of a power outage is the last 15 minutes' worth.
The Archive Cache holds approximately 4K (configurable) of data for each data stream. It contains the most recently requested values by users or calculations.
Copyright © 2007 OSIsoft, Inc.
500MB – good for CD-ROM backup
Up to 2TB per file
Unlimited number of archives can be registered
The primary archive receives and stores new incoming data
Once filled, another archive takes the primary’s place
Online Archives
Primary Archive
*
Archive Files
An archive file contains events for a certain time period specified by the archive start time and end time. The PI Server is designed to have a set of archive files that cover contiguous and non-overlapping time ranges.
PI archive files can be different sizes, but they must never contain overlapping time ranges. Archives range in size from 2 Megabytes to 2 Terabytes.
Primary Archive
The primary archive is the archive file that covers the current time range. The primary archive has a defined start time but not a defined end time (it is always assumed to be ‘now’.)
The end time for the primary archive is defined when an archive shift occurs. An archive shift is the process of making a different archive file be the primary archive.
Copyright © 2007 OSIsoft, Inc.
*
Float Types (Float 16-32-64)
Step
What is a PI Point?
A point is a unique storage place in the PI System for a specific stream of data
Each of the following examples requires one point:
A flow rate from a router
A status for a switch port
The display message on a printer
The available disk space on a server
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Point vs. Tag
Although the terms point and tag are often used interchangeably, there is a difference:
A point is any measurement or calculation that is stored in the data archive. Points can represent transmitter readings, manual inputs, status, etc.
A tag is the label, the name, for a point.
Copyright © 2007 OSIsoft, Inc.
Descriptor: Description
PointType: Type of variable to store (default: Float32)
Zero/Span : Minimum value / Range the point should be in
Step: (On/Off): Displays information in a stair case manner (prevents interpolation)
Archiving (On/Off): If Off, data is collected but not archived
Scan (On/Off): Includes the point in the list of points to be collected by an interface
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
PI Point Attributes
The configuration information for a point is stored as a list of attributes. These attributes include:
Tag: The tag is used to uniquely identify the point. This means that the "tag" point attribute is the key to the information about the point.
Descriptor: PI point description.
Engineering units: The engineering unit string describes the units of the measurement. You may use any string, and the string may be of any length.
Point Class: The Point Database has several different point classes, such as Base and Classic. Point class is assigned when the point is created. The point class of an existing point cannot be changed. The point class determines which attributes are accessible.
Point Type: There are many point types in the PI Server.
Zero: A zero is required for all numeric data type points to indicate the lowest value possible. It does not have to be the same as the instrument zero, but that is usually a logical choice.
Span: The span is the difference between the top of the range and the bottom of the range. It is required for all numeric data type points.
Archiving: The archiving flag must be set to ON (1) for a point to be archived. This flag can be set to OFF (0) to stop archiving of a point.
Scan: Some interface programs use a scan flag. Interfaces that honor this attribute will not update points whose scan flag is set to OFF. Refer to the documentation to see if your interface programs use it.
Copyright © 2007 OSIsoft, Inc.
The first character must be a letter or a number
No control characters are allowed (linefeeds, tabs, etc.)
The following characters are not allowed:
* ’ ? ; { } [ ] \ ` ‘ “
Also, avoid “_” because it is used in SQL queries as the wildcard character
Point name should be limited to 80 characters
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Point Naming Convention
While any tag that meets the above guidelines is permissible, we recommend that you decide on conventions to make the tags more meaningful.
The point naming convention should include information on the data source (Ping, SNMP, Performance Monitor, etc), the device type and the device name.
Examples:
SQC_Alarm
Classic
Alarm
BASE
Included in all point types
Warning! It is not possible to change the point class of an existing point.
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Point Classes
The Base class is a common set of attributes that all other point classes include. The base class includes both system-assigned and user-assigned attributes.
The Classic point class includes attributes used by interfaces, that’s why most of the points created in the IT Monitor context has Classic point class.
The Totalizer, Alarm and SQC_Alarm point classes includes additional attributes, which are discussed in the PI Server Applications Guide:
Chapter 6, "Totalizer Subsystem"
Chapter 7, "Alarm Subsystem"  
Copyright © 2007 OSIsoft, Inc.
(0 to 32767)
(-2147450880 to 2147483647)
(Accuracy: 1/32767)
(Single precision)
(Double precision)
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Int16
Used for points whose values are 15-bit unsigned integers (0 to 32767).
Int32
Used for points whose values are 32-bit signed integers (-2147450880 to 2147483647). PI reserves some values.
Float16
Used for floating point values, scaled. The accuracy is one part in 32767.
Float32
Float64
Digital
Used for points whose value can only be one of several discrete states, such as Up/Down, High/Medium/Low, On/Off.
String
Used to store string data of up to 976 characters.
Copyright © 2007 OSIsoft, Inc.
Float16
PI can store a floating point value in a 16 bits integer by scaling it. The scaling always brings a rounding error.
Recommendation: do not use a Float16 point unless you have a specific need for it and are ready to accept the rounding error
Why use it ?
Why not use it?
No need to build a PE point to filter values outside the span Reduces the disk space required to store the same value by up to 40%
Values outside the span can’t be archived Brings a rounding error of 1/32767*span (0.00003*span)
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
archived value = (250.9-zero)/span*32767 = 16442
displayed value = 16442*span/32767 + zero = 250.89
Example 2
(750-zero)/span*32767 = 49150.5
Copyright © 2007 OSIsoft, Inc.
Example:
Float64 as 2.1234567890123456789
*
Expressed as (IEEE standard): s * m * e
Where s as sign, m as mantissa and e as exponent
Bit utilization:
m is always expressed as 1.xxxxxxx, therefore the accuracy is:
1/223-1 10-7 for Float32
1/252-1 10-16 for Float64
Digital Points and Digital State Sets
Digital points store values as integer and display them as text
PointType attribute = digital
Use the DigitalSet attribute to store the name of the associated Digital Set
Digital sets are groups of states
Kept in a common table for access by multiple points
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Digital Sets
A collection of digital states is called a digital state set. For example, a digital state set can be defined which consists of two states {Up, Down}. You might also define a digital state set that consists of {High, Medium, Low, N/A}. Typically, there will be many digital state sets defined for a system.
For digital points, the DigitalSet attribute specifies the name of the digital state set that is to be associated with the point. The Digital Set attribute has no meaning for non-digital points and should be ignored. However all points are associated with the system state set. The system state set contains a collection of all the states that may be used for any point. Examples are Shutdown, Over Range, I/O Timeout, etc. Below is an image presenting a part of the system state set:
Copyright © 2007 OSIsoft, Inc.
Zero = 50
Span = 100
*
Zero and Span
The zero is the bottom of the range used for scaling float16 values in the PI Archive.
The span is the difference between the top of the range and the bottom of the range. It is required for all numeric data type points.
For float16 point types, the span is used with the zero for scaling values in the archive. The span must be a positive value. If the value for a point type float16 point is greater than the top of range, it is recorded in the archive as “Over Range”; if the value is less than the bottom of the range, the archived value is “Under Range” as well. For other point types, zero and span do not affect the values recorded in the archive.
The zero is also used when defining a PI ProcessBook trend with a vertical scale of database.
These two attributes are not used for creating digital points and should be ignored.
Copyright © 2007 OSIsoft, Inc.
The step attribute affects both display and compression:
Instead of using the usual compression algorithm, a second exception test is applied using the CompDev value
Step=0
Step=1
*
Step
The step attribute defines whether the archived values are interpolated or not. The default behavior, step OFF (0), treats archived values as a continuous signal. Adjacent archived values are linearly interpolated. For example, at 12:00:00, the value 101.0 is archived and at 12:01:00, the value 102.0 is archived. A request for the archive value at 12:00:30 would return 101.5.
A step attribute of ON (1) treats the archived values discretely. Adjacent archived values are not interpolated; an archived value is assumed constant until the next archived value.
Here is an example of a point with the step attribute set to ON (1):
At 12:00:00, the value 101.0 is archived,
At 12:01:00, the value 102.0 is archived,
A request for the value at 12:00:30 would return 101.0.
Copyright © 2007 OSIsoft, Inc.
Renaming a point
A point can be renamed while preserving history
Renaming has no effect on Interfaces and ProcessBook displays (PointID is stored)
DataLink Reports have to be edited manually to use the new names (when not using the "Point ID to Tag" function)
Expressions in Performance Equation points must be edited manually
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Renaming, Deleting, Modifying points
Once a point is deleted, its Point ID is unassigned and while the data is not removed from the archives, all pointers to the data are removed. If the point is recreated, it has a new PointID and would still not find the old data. Technical support does have a procedure to "undelete", but it is very time intensive and only worthwhile if a serious error was made (deleting the entire point database).
Copyright © 2007 OSIsoft, Inc.
*
PI System Startup and Shutdown
Copyright © 2007 OSIsoft, Inc.
MCN-HM (Manufacturing Control Network – Health Monitor)
Set of 4 interfaces to install on PI Server or Interface Node
Ping, TCPResponse, SNMP and Performance Monitor
Add-ins to PI System Management Tools to create IT points and displays
IT Monitor product suite includes:
PI Server
PI Interface Configuration Utility
PI ProcessBook
PI DataLink
*
IT Monitoring Products
Here are the different products that normally compose the IT Monitor suite:
PI Server Reliability Category PI Ping Interface PI TCPResponse Interface Performance Category PI Performance Monitor Interface PI SNMP Interface PI SNMPTrap Interface PI Windows Event Log Interface Security Category PI IP Flow Interface PI PacketCapture Program PI SysLog Interface WinPCap Libraries
PI Interface Configuration Utility (PI ICU) PI System Management Tools (PI SMT) PI ProcessBook PI DataLink Demo and Samples There are additional interfaces available, but not necessarily in the standard IT Monitor suite. Please contact your account manager to find out more.
Copyright © 2007 OSIsoft, Inc.
Start PI services
\pi\adm\pisrvsitestart.bat (starts interfaces only)
Manually start each service using Control Panel/Services
Automatic startup for Windows Services
Stop PI services
\pi\adm\pisrvsitestop.bat (stops interfaces only)
Manually stop each service using Control Panel/Services
"Site-Specific" startup and shutdown files must be edited manually
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Starting PI
Start PI by running the pisrvstart.bat script from the adm directory. This starts all PI subsystems and then runs the script pisrvsitestart.bat, which contains commands for all of the interfaces and other site-specific applications. Alternatively, if PI was installed to start the services automatically on reboot, you may also reboot the system.
The base PI processes are:
PI Network Manager;
PI Message Subsystem;
PI Update Manager;
PI Snapshot Subsystem;
PI Archive Subsystem;
PI Performance Monitor Interface (basic version, limited to 512 points);
PI SNMP Interface (basic version , limited to 32 points);
PI Ping Interface (basic version , limited to 32 points).
Note: If you have a large point count, it may take a while for PI to complete its initialization at startup time. During the initialization, the processes are all running, but none of the utilities will work. When utilities such System Management Tools work, that is an indication that initialization is complete.
Large systems (greater than 100,000 points) can take 30 minutes or more for initialization to complete, depending on the hardware and system resources.
PI Base Subsystem;
PI SQL Subsystem;
PI Shutdown Subsystem;
PI License Subsystem;
PI Backup Subsystem.
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
3.2 PI System Management Tools (PI SMT)
This chapter covers the tools that the PI System Manager can use to troubleshoot, analyze and manage PI and related applications. These tools are packaged in a product called PI System Management Tools (PI SMT) and can be downloaded from the OSIsoft’s Support web site (http://techsupport.osisoft.com).
Copyright © 2007 OSIsoft, Inc.
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Series of plug-ins, divided in various categories:
Alarms
Operation
Points
Security
Note that these categories may change over time; some can be added/removed/renamed.
Copyright © 2007 OSIsoft, Inc.
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
PI Server Messages – PI SMT
The Message Logs plug-in is a centralized diagnostic tool allowing users to view error/diagnostic information from PI Servers, Client PCs running the PI SDK or directly from the log files. The viewer provides rudimentary message filtering and "time-window" navigation. The current view of the log can be saved as a text file.
Copyright © 2007 OSIsoft, Inc.
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Click on the Point Builder plug-in, under the Points category;
If the Point Name field is not blank, click the New icon from the toolbar;
Choose a server on which to create the PI point by selecting a PI server from the server drop-down list;
Type a point name in the Name field;
Choose a point class for the point. For all regular points that are fed by PI Interfaces, choose "classic";
Choose a point type for the point. If the point type is digital, then a digital set will need to be associated with the PI point;
Edit the remaining attributes that need to be changed from their default values. If Point Builder determines that an edit will cause point creation to fail, it turns the edited attribute yellow. If this happens, determine the cause and assign the attribute a legal value;
Click the Save icon in the toolbar. The session record window should now show the following message:
"PI-PB> Successfully created point <name of point> on server <name of server>.
Copyright © 2007 OSIsoft, Inc.
*
PI TagConfigurator
PI TagConfigurator is an Excel add-in used to create, edit, and delete PI Points on local or remote PI servers.
Prior to using PI TagConfigurator, the add-in has to be loaded in Excel. To do so, follow these steps:
Click Add-Ins… in the Tools menu
Click Browse…
Click OK
*
PI TagConfigurator Settings
The settings for PI TagConfigurator fall under one of these three categories:
General Settings: affect export and import operations;
PIDIFF Settings: used on older PI Systems;
PIConfig Settings: affect the generation of PIConfig files (refer to PI TagConfigurator help for further information).
The General settings are as follows :
Connect to PI Server on startup
If this setting is enabled, PI TagConfigurator will connect to the last server for which an import or export operation was performed. This setting is disabled by default.
Allow Tag Deletion
This setting must be enabled in order to delete PI tags from the Export dialog. This setting is disabled by default.
Allow Tag Creation
This setting must be enabled in order to create PI tags from the Export dialog. This setting is enabled by default.
Copyright © 2007 OSIsoft, Inc.
*
The easiest way to configure PI points is to:
Import existing point attributes from a PI Server to a spreadsheet;
Modify the point attributes on the spreadsheet;
Export the modified point attributes to the target PI Server.
Copyright © 2007 OSIsoft, Inc.
*
PI TagConfigurator requires the spreadsheet to have the following layout:
The attributes are listed in the top row;
The tags are listed in the second column;
Each point has its attributes listed under the headings in the top row, one point per row;
Select a point row by putting an "x" in the first column. Import or export operations are performed on selected points only.
Copyright © 2007 OSIsoft, Inc.
Export only attributes that have been changed (remove unchanged columns)
All the attributes are exported, not only those that have changed
Use tag and newtag to rename points:
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Check that processes are running (Operation > PI Services)
Check data collection from the simulators (Data > Current/Recorded Values)
Read the Installation logs at the root of the C: drive and in the \PIPC\dat folder
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
*
PI System Daily Backup
Daily Backup: It is highly recommended to execute a daily backup of your PI data and configuration
First step of the Emergency Recovery Plan
The backup should be moved to an external media to provide protection against an hardware failure such as a defective hard drive
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Daily Backup
It is highly recommended to execute a daily backup of your PI data and configuration:
Back up the primary and most recently shifted archive(s) and PI database files together
Back up the daily message log file
Back up all the *.bat files used to start, stop, and manage PI and PI interfaces (including pipeschd.bat)
Use PIBackup.bat command file to schedule this task in the PI Server
Create ..\pi\adm\pisitebackup.bat to execute site-specific backup tasks
Copyright © 2007 OSIsoft, Inc.
The number of archive files
A time period
Works with the following systems:
Windows VSS and Windows Non-VSS
Windows with a third-party backup application
Windows Cluster environment
*
Online Backup
The PI Backup subsystem was introduced with version 3.4.370.52 of the PI Server.
For users of previous versions of the PI Server, the introduction of the PI Backup subsystem means:
No more subsystems shutdown during backup
Users will be able to connect to PI during backup
No archives are taken offline during backup
No data gaps in trends, no errors in Performance Equation calculations,…
This class will only focus on the Windows VSS and Non-VSS backup.
Please consult OSIsoft’s documentation or a technical support agent for the third-party application, Microsoft Cluster or Unix backup.
Copyright © 2007 OSIsoft, Inc.
Requires Windows 2003 Server
Windows XP can be used for testing VSS procedures
Freeze: Tells applications to put open files in consistent state and stop writing
Thaw: Tells applications to resume writing data to files
Very little disruption of normal operations
Less than 1s from Freeze to Thaw
Shadow Copy then proceeds in parallel with normal operations
Supported by Windows NTBackup.exe and the most recent version of widely used backup applications
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
*
*
Backup Directory Structure and Content
For a VSS or a non-VSS PI backup, the backup directory structure and content will be identical
adm: site specific files
pisrvsitestart.bat, pisrvsitestop.bat, pisitestart.bat, pisitebackup.bat, pintbackup.bat, pibackup_3.4.370.bat
bin: pipeschd.bat
dat: files from \PI\dat except archive and annotation files
log: files from \PI\log
PI backup log files
*
Upgrading from PI Server 3.4.370
If you upgrade from PI Server 3.4.370 to PI Server 3.4.375, the behavior of your backups will not change
Upgrading will create a pibackup_3.4.370.bat script file that will be used for backup
That script preserves the version 3.4.370 behavior of using NTBackup.exe to perform its VSS backups (PI backup packed into a single .bkf file)
The NTBackup application will not be distributed with Windows Vista and Windows Longhorn Server
Deleting the script file will use the version 3.4.375 backup scheme
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Automating VSS Backups on Windows
Add a Scheduled Task using the PIBackup.Bat script from the \pi\adm folder
Syntax:
Example:
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
E:\PI\backup
Path must be the complete drive letter and path to a directory with sufficient space for the entire backup.
[number of archives]
2
The number of archives to backup. For example, "2“ will backup the primary archive and archive 1.
[archive cutoff date]
*-10d
The cutoff date is specified in PI time format. For example, "*-10d" restricts the backup to archives that contain data between 10 days prior to current time and current time. The more restrictive of [number of archives] and [archive cutoff date] takes precedence.
[–install]
Installs a scheduled task to run pibackup.bat daily at 3:15 am. If the –install flag is not specified, then a non-VSS backup is performed immediately.
Copyright © 2007 OSIsoft, Inc.
Notes and Examples
The more restrictive of [number of archives] and [archive cutoff date] takes precedence.
Regardless of the [number of archives] and [archive cutoff date] empty archives will not be backed up.
Example #1 – Number of archives restriction:
PIBackup.bat E:\PI\Backup 3 1-jan-70 –install
Example #2 – Archive cutoff date restriction:
PIBackup.bat E:\PI\Backup 99999 *-60d –install
Example #3 – Using default settings (3 archives / 1-Jan-1970):
PIBackup.bat E:\PI\Backup –install
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Notes and Examples
Example #1 is assuming that the entire system has more than 3 archive files from 1-Jan-70 to now.
Example #2 is assuming that the entire system has less than 99999 archive files mounted.
Example #3 is using 3 as the default number of archives and 1-jan-70 as the default archive cutoff date. These parameters are configurable using the Tuning Parameters plug-in in PI SMT. The parameters are Backup_NumArchives and Backup_ArchiveCutoffDate.
Copyright © 2007 OSIsoft, Inc.
*
Changing the scheduling time
By default, the backup will run every day at 3:15 AM. You can change these settings with the Schedule tab.
The schedule for the backup task could also be set in the pibackup.bat file
if %IsVssSupportedError% == 0 goto vsssupportedinstall
at 03:15:00 /every:m,t,w,th,f,s,su "%AdmPath%\pibackuptask.bat" "%BackupPath%" %NumArchives% %CutoffDate%
goto theveryend
Modify the Run as user
For VSS backups, it is recommended to change the Run As user for the PI Server Backup scheduled task from NT AUTHORITY\SYSTEM to the account of the user who will be administering the backups. This recommendation is simply for convenience purposes for viewing the NTBackup.exe log file.
Note:
In addition to the Scheduled Tasks control panel, it is also possible to use the at command in Windows 2000 or the schtasks command in Windows 2003.
Copyright © 2007 OSIsoft, Inc.
Site Specific Backup – pisitebackup.bat
Running the PI daily backup is not sufficient. The PI backup directory must be copied elsewhere using a third party backup application or with the pisitebackup.bat script file
The PI backup script calls the pisitebackup.bat script immediately before exiting. Tasks can be added to that script to be executed each day after the PI Backup.
Can be used to move the PI backup directory to tape, to a remote computer or other offline media for safekeeping
See example with instructions (pisitebackup.bat.example) in the \PI\adm folder
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Site Specific Backup – pisitebackup.bat
If there’s no pisitebackup.bat file present in the \PI\adm folder, a warning message will be logged in the PI backup log file
To get rid of the warning message, create an empty pisitebackup.bat file
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Backing up the configuration files along with the archives
Backing up files that are not part of the backup script:
Interface startup files (*.Bat)
Etc.
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Permanent Backup
The daily backup will allow you to quickly restore the last few months of historical data. This is typically the first step of a disaster recovery emergency plan. By restoring your daily backup, you will enable your clients to see the latest data and your interfaces to start sending data to the PI Server.
As a second step, you will use you permanent backup to restore all the historical data from the system start up.
Copyright © 2007 OSIsoft, Inc.
There will be a log file
Ex.: pibackup_2-Oct-06_03.15.02.txt
*
*
5.2 PI System Restoration
This section is an overview of the PI Server restoration. The following two options are going to be reviewed:
Single Archive File Restoration
Complete PI Server Restoration
Copyright © 2007 OSIsoft, Inc.
Register the archive using PI SMT Archive Manager plug-in
Make the archive non-shiftable
*
Single Archive File restoration
This procedure is typically used on system that only keeps a limited amount of on-line data. As an example, your system may have 5 years of historical data on-line. As the time go by, you eventually shift into an archive file already used and erase the oldest values on the system. Today, you might need to look at some values which are no longer on-line. If you kept a permanent backup, you can restore only the archive files covering the time period required.
To restore an archive that was backed up to a removable media, follow these steps:
Copy the files from the backup media to a local hard drive. The file does not have to be in the same folder as the other archive files. Also, make sure you do not overwrite an existing archive.
Register the archive file using the Archives plug-in in PI SMT (or use piartool –ar <filename> command).
Make the file non-shiftable to prevent this archive file to get into the permutation process (or use piartool –ads <filename> command).
Copyright © 2007 OSIsoft, Inc.
Install PI Server software
Restore your backed up files
Restart the PI Server
*
PI Server Restoration Tasks
When using a version of PI older than 3.4.370.x, there are several additional steps involved.
Please consult the "Restoring a Complete Server from Backup", in Chapter 11 of the PI System Management Guide.
Copyright © 2007 OSIsoft, Inc.
Notes on Restoring a PI System
You must install the exact same version of the PI Server than the one used to create the Backup.
In order for the interfaces (especially when buffered) to go back to normal operations, keeping the same name/IP address is recommended
The server should be disconnected from the network for the time of the restoration, and reconnected prior to the final restart
If you do not keep the same folder hierarchy, additional steps are required
See notes below for more details
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Notes on Restoring a PI System
If the restoration does not take place in the same location (folder hierarchy) than where the backup was created from, the 2 following files should not be restored:
\PI\dat\PISubSys.cfg
\PI\dat\PIArStat.dat
Additionally, the archive files will need to be re-registered manually.
Before you start PI with the restored backed up files, run the following command from the \PI\adm directory:
pidiag -ar
This utility will prompt you for the full path and filename of the archive that you want to assign as the Primary Archive. If you are unsure of which archive is the Primary, consult the PI Backup Log and look for Archive 0.
Alternatively, you can use pidiag –ahd and examine the archive dates of each archive file. The primary should have the latest start date and no end date:
pidiag -ahd c:\pi\dat\piarch.001
Then you can restart PI (using \\pi\adm\pisrvstart.bat) and register all of the other archives that you restored to the new archive directory. This can be done using "piartool –ar" commands, or through the Archives plug-in for SMT.
Copyright © 2007 OSIsoft, Inc.
6.0 Quality and Optimization
*
Storing Data Efficiently
Data Flow Recap
Objectives:
Select proper scan rates
*
Storing Data Efficiently
There are many factors that can affect the way information is archived:
Exception reporting
Compression algorithms
Scan rates
Scaling (float16)
These mechanisms can be configured point per point to optimize data storage
Items to consider:
Precision of information
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Exception Reporting
Exception reporting is basically a way of filtering data. Most interfaces poll the equipment on a regular basis and then report new events to the PI Server only after these events are evaluated and found to be significant. This process is called exception reporting. In this process, the current value is compared to the previously sent value.
Compression
Events are evaluated according to the compression specifications to see if they are significant events. If so, they will be archived; if not, they are discarded. This process is called compression. The compression method used by PI allows PI to keep orders of magnitude more data online than conventional scanned systems.
Copyright © 2007 OSIsoft, Inc.
*
Data Flow
A value has to pass two tests to be stored in the PI archive: the exception test and the compression test.
Exception Test
The exception test is done at the interface level. The values that pass this test are sent to the PI server and become “snapshots”.
Compression Test
The compression test is done at the server level. The compression algorithm determines which of the snapshots will be kept in the archive
ICE, ProcessBook, Totalizer, SQC, ACE, Performance Equations all get data directly from the SNAPSHOT.
Copyright © 2007 OSIsoft, Inc.
Without Exception and Compression tests, these would all be archived
Time
Temperature
*
Current Snapshot
The Exception Test is configured on a per point basis and performed by the interface
New values outside the box violate the Exception test.
When a value violates the Exception test, this value and the previous one are sent to the PI Server.
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
A value violates the exception test if:
Its value differs from the previous snapshot value by the exception deviation specification (ExcDev) OR the time since the last exception is greater or equal to the maximum exception time (ExcMax)
BUT
No values are reported until the minimum exception time (ExcMin) has elapsed since the last exception.
When a value violates this test, that value and the previous value are sent to the server
Note: Excmax and Excmin are in seconds
Copyright © 2007 OSIsoft, Inc.
New Value Exception Current Snapshot
12:00 50.0
*
Exception Test
Most interfaces poll the equipment on a regular basis and then report new events to the PI Server only after these events are evaluated and found to be significant. This process is called exception reporting. In this process, the current value is compared to the previously sent value. Manually entered data are not normally reported by exception so that every value can be retained.
Exception reporting is basically a way of filtering data. Interface programs that do exception reporting apply the following algorithm whenever a new value is received:
A new value is compared to the last value reported. The new value is not reported unless:
the difference between the new value and the last value is greater than the exception deviation specification
and
the difference between the times of the new and last values is greater than or equal to the exception minimum time specification
or
the difference between the timestamp of the new value and the timestamp of the last reported value is greater than or equal to the exception maximum time specification.
The time between exception reports can be much greater than the exception maximum time if no new values are received by the interface for a point. Neither the PI Server nor the interface will ‘create’ data.
Copyright © 2007 OSIsoft, Inc.
*
When a value is sent, it becomes the new snapshot.
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Exception Test
When a value passes this test, that value and the previous value are reported.
Why? To have a better representation of the actual behavior
Snapshot value
Trend if previous value is sent
Previous value
*
Sending the previous Value
When a value violates the exception test, that value and the previous value are reported to the server. This is done to ensure the actual behavior of the point is properly represented in a case as shown above. Otherwise, the client tools would show a slow and steady slope from the last archived value to the new violating value instead of a constant value followed by an abrupt change.
Copyright © 2007 OSIsoft, Inc.
Exception turned off.
All values are sent to PI.
This will increase the traffic between the data collection node and the server.
Can also use the Bypass Exception interface startup parameter (in PI ICU, otherwise /sn in the .bat startup file)
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Limitation
The current file size limitation on the PI Buffer server data file (apibuf.dat) is 2GB. This 2GB fills relatively quickly with uncompressed data and even quicker if data has not gone through exception reporting.
Copyright © 2007 OSIsoft, Inc.
value
The Compression Test is configured on a per point basis and performed by the PI Server
Compression can be turned off with the Compressing attribute
If a value between the last archive event and the current snapshot is outside the box, the current snapshot violates the compression test. In this case, the value previous to the current snapshot will be archived.
+ CompDev
- CompDev
Current
snapshot
*
Compression
After leaving the Snapshot, events are evaluated according to the compression specifications to see if they are significant events. If so, they are sent to the Event Queue. If not, they are discarded. This process is called compression.
There are three instances where an event will bypass the compression process and be put directly in the Event Queue:
If the Compressing attribute for the point is set to OFF.
If the timestamp is older than the timestamp of the current snapshot. Such an event is sometimes termed ‘out of order.’
If the Status attribute of the Point has changed.
The compression method used by PI allows PI to keep orders of magnitude more data online than conventional scanned systems. The data are also much more detailed than in an archiving system based on averages or periodic samples.
The compression method is called ‘swinging door compression.’ Swinging door compression discards values that fall on a line connecting values that are recorded in the Archive. When a new value is received by the Snapshot Subsystem, the previous value is recorded only if any of the values since the last recorded value do not fall within the compression deviation blanket. The deviation blanket is a parallelogram extending between the last recorded value and the new value with a width equal to twice the compression deviation specification.
Copyright © 2007 OSIsoft, Inc.
A
A
A
A
A
A
A
The compression algorithm is performed on new snapshots to determine which data is kept in the PI archives
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Time
Temperature
When the user requests a value that turns out to be interpolated, the difference can be no greater than ±CompDev
Values kept in the PI archives
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
*
Compressing set to Off: all exceptions are archived (no compression)
*Better* Compressing set to ON, CompDev set to 0: successive identical values are not archived. This is much more efficient
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
The exception and compression specifications should be adjusted to achieve efficient archive storage without losing significant data.
Disk Space and Performance vs Data Accuracy
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Exception and Compression Attributes
Each PI Point can be individually configured for its exception reporting and compression
Exception Reporting Attributes
CompDev or CompDevPercent CompMax CompMin Compressing
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Zero = 0 and Span = 100
Exception = 1% and Compression = 2%
In many cases, these default values are not adequate.
Carefully review the configuration of following attributes according to the nature of what is being measured:
Compdev, compdevpercent, compmax, compmin, compressing
Excdev, excdevpercent, excmax, excmin
Copyright © 2007 OSIsoft, Inc.
Recommended Data Compression Specifications
Set the Compression Deviation to the minimum change that is measurable by the instrument.
Set the Exception Deviation to ½ of the compression deviation
These are starting point recommendations.
ExcMin, ExcMax, CompMin and CompMax are in SECONDS
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Compression Specifications
You can adjust the compression parameters to produce efficient archive storage without losing significant data. The compression maximum time is usually set to one value for all points in the system. It should be large enough that a point that does not change at all uses very little archive space. A compression maximum time of one work shift (for example, 8 hours) is often a good choice.
Use the compression minimum time (CompMin) to prevent an extremely noisy point from using a large amount of archive space. This parameter should be set to zero for any point coming from an interface that does exception reporting. In this case, the exception minimum time should be used to control particularly noisy points. For a data acquisition system with a slow scan time, this parameter is not important. There are few cases where you want to use a non-zero compression minimum time.
Note: The maximum time specification does not guarantee that a value will be written to the Archive within a certain time. The Archive waits for events to be sent to it. It does not check to see if a point has timed out. It does not 'create' new values.
Copyright © 2007 OSIsoft, Inc.
Recommendation
Do not specify both ExcDev (CompDev) and ExcDevPercent (CompDevPercent) at the same time
Even if ExcDevPercent (CompDevPercent) is empty, it takes precedence and takes the default value
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Typical Scan Rates
The scan rate must be chosen according to the dynamic of the monitored point
Make sure not to miss an important process event because your scan rate is too slow!
Some typical scan rates are:
CPU: 1 second
Memory: 10 seconds
*
Zero = 0 and Span = 100
Exception = 1% and Compression = 2%
In some cases, these default values are not adequate for IT Monitor points
Review the configuration of following attributes according to the nature of what is being measured:
CompDev, CompDevPercent, Compmax, CompMin, Compressing
ExcDev, ExcDevPercent, ExcMax, ExcMin
*
When defining ExcDevPercent and CompDevPercent, ExcDev and CompDev are automatically adjusted according to span
The inverse occurs when ExcDev and CompDev are defined (ExcDevPercent and CompDevPercent are automatically adjusted)
The accuracy and range of Float16 values are set by the Zero and Span
Zero and Span are used by many functions in PI ProcessBook
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
*
* : (NOW)
18-feb-07 16:00:00
+8h : + 8 hours
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
yy Year
mm Minutes
ss Seconds
*
"Time" fields default to 00.
Expression
Meaning
25
18-Feb-07
25 8
21:30:01.02
9:30:01.020 PM on the current date (.020 means 20 milliseconds)
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
y
Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. Sunday
00:00:00 on the most recent of that day of the week
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Examples of time usage:
1. To build a trend report or a trend representing the whole of yesterday.
Start time: y (midnight yesterday morning)
End time: t (midnight this morning)
2. To build a report or a trend from the beginning of the month until now:
Start time: 1 (first day of the current month at midnight)
End time: * (now)
Note: the time range of such a trend will vary from 1 second to 31 days.
Copyright © 2007 OSIsoft, Inc.
Leading sign (+ or -) is required.
No default time unit: must specify d, h, m, s, w, mo, or y
Can use fractions only for Hours, Minutes and Seconds
+2.5h, -0.5m
Relative time is most often part of a Combined time
Years (y)
Months (mo)
Weeks (w)
Days (d)
+32m
*
Note that some older applications may not support the week, month and year time intervals.
Examples:
Copyright © 2007 OSIsoft, Inc.
Uses both an absolute and a relative time
The absolute part of the time can be *, t, y, or a day of the week
Syntax
Meaning
*-8h
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Tuesday-2d
Today at 6:00 AM
12 hours ago
*
Copyright © 2007 OSIsoft, Inc.
7.2 Common Dialog Windows
*
PI Connection Manager
Viewing Connection Information
Use the check boxes to connect / disconnect from the available PI servers
Connection settings
Connection information
*
PI Server Connections
The PI Connection Manager dialog box is used to manage server connections. To connect to a server, click on the check box next to the server name. To add a server to the list, click on the Server menu and choose Add Server…. The added server will now appear in the connection manager.
Copyright © 2007 OSIsoft, Inc.
Click the Save button to apply the changes
To change the default PI server, select Tools Options
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Adding a New Connection
To add a new PI server connection, select Server Add Server
Network Path: either PI Server IP address or Hostname
Default User Name: PI user used to connect
Password: password if PI user is password protected
Confirm: validates the connection at creation time
Connection Type: PI 3 or PI 2 server
Port Number: 5450 for a PI 3 Server or 545 for a PI 2 Server
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Using toolbars:
In PI DataLink:
*
To perform a tag search:
1- Enter the search criteria specifying the attributes of the point(s) you want to find
2- Click the Search button to begin the search.
The number of items in the found list with the percentage of the search that is complete is displayed at the bottom of the dialog. Click the Abort button to stop the search at any time.
When the search is completed or aborted, tags matching the criteria are displayed in the Search Results list. Click on a tag to select it. Click OK to close the PI Tag Search dialog.
Searches can be saved by clicking on the Favorites button and choosing "Save Search..." from the popup menu.  The searches are persisted as XML documents under subdirectories of pipc\dat\tagsearch or pipc\dat\aliassearch. 
Saved searches are restored by clicking on the Favorites button and choosing the name of the search to restore on the popup menu.  The search is executed as soon as the search is selected from the Favorites menu.  
Copyright © 2007 OSIsoft, Inc.
Start searching according to the criteria
Display the attributes/values for selected points
Tag search results
Look for a specific point type/class/source
Tag name mask
Validate selection
*
Tag Search Window – Basic Search
Use any or all of the following criteria to locate the tag:
PI Server: Select the name of the PI Server on which you want to search for the tag from.
Tag Mask: Enter the name of the point. You can use wildcard characters to help with the search: * represents any number of characters and ? represents one character
For example, B* in the Tag Mask text box locates all the points whose name begins with B.
Descriptor. Enter the description of the point. This field is not case-sensitive, and wildcards as described above are valid.
Point Type. To narrow a search to only Float points, Int16 points, String points, etc.
Point Source. Enter the character(s) which associates a point with an interface or PI module. The code is not case-sensitive. Use * to represent any point source.
Point Class. Narrow the search to include only points of a certain class (classic, SQC_alarm, etc). Use * to search through all.
Engineering Units. Narrow the search to points with a certain engineering unit mask. Use * to represent any engineering units. For example to find all the points with units representing a rate, we might enter */* here.
Value/Status/Point Attribute... Only one of these may be specified at once. Value is the current reading for a point. Use * to represent any value. Status allows the specification of a certain system digital state for a point (use the '…' button to look through the system digital state set.) One useful example of this would be to search by Status = Pt Created (state no. 253) to see all points which have not received values since their creation. Searching by Point Attribute allows the specification of any of the point attributes in the search, for example all the points for which compressing=0.
The above field specifications may be combined (but only one of Value, Status and Point Attribute may be selected)
Copyright © 2007 OSIsoft, Inc.
Example: ping* = ping_server1, ping_server2, ping_server3
Use ? to replace one character
Example: disk(?)_%free = disk(C)_%free, disk(D)_%free
Note 1: Search criteria are not case sensitive
Note 2: Search criteria can be combined
Example: Look for Tag Mask = disk*  and Point Source =  # 
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
SQL-like query based on used-defined conditions
1- Define condition
2- Click 'Add'
*
Tag Search Window – Advanced Search
Advanced Tag Search allows almost limitless flexibility for tag searches. You can set and combine very specific criteria on the properties, history, and even behavior of the points you wish to find.
For the Advanced search, the user constructs his or her own SQL query. There is no guarantee that the query will be syntactically correct. However, the search criteria are much more flexible than with the Simple search.  Any point attribute from Point Class Classic can be used to restrict the search and there are various methods to search by value.  Example SQL queries are shipped with the PI Tag Search Dialog.  These queries can be viewed by clicking on the Favorites button and browsing to the desired example under the Examples folder.
Examples
 
To search for all digital points, use: PIpoint.PointType = 'D'
 
To find all integer points that have a snapshot value of 1, use:
PIpoint.PointType = 'I' AND PIcomp.Status = 1 AND PIpoint.Tag = PIcomp.Tag AND PIcomp.Time = DATE("*")
Copyright © 2007 OSIsoft, Inc.
Search for aliases in the PI ModuleDB (described later)
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Tag Search Window – Alias Search
For facilities that have organized data into modules, this is a great way to search for that unknown tag name that corresponds to the more familiar Module/Alias structure.
The Alias Search criteria include the following.
Search Context;
Module Mask;
Alias Mask;
Heading Mask.
The Search Context is a path to a PI Server or PI Module.  For example, the following are valid search contexts as long as PIServer1 is in the Known Servers Table and as long as Reactor1 is a PIModule in PIServer1.
\\PIServer1;
\\PIServer1\Reactor1.
If "\\PIServer1\Reactor1" is used as the search context, then Reactor1 and all sub PIModules to Reactor1 will be searched for PIAliases when the Search button is pressed.
The wildcard characters * and ? can be used in any of the mask fields.  The asterisk (*) is a multi-character wildcard and the question mark (?) is a single-character wildcard.  For example, using "Temp*" as an Alias Mask will return all PIAliases in the Search Context that start with "Temp".  The masks are always case insensitive.  Using "Tem?" as an Alias Mask will return all PIAliases in the Search Context that start with "Tem" and end with any other character.
Copyright © 2007 OSIsoft, Inc.
*
What are Point Attributes?
All of the information that is required to gather data from a particular data source is stored within the context of a PI point by means of point attributes. Certain point attributes can be used to store numeric information such as integers and floating-point numbers, and other attributes can be used to store character string information, such as the name (or tag) of the point. For example, if a measurement needs to be read from a particular device in a network, the IP address needs to be stored in one of the point attributes.
Copyright © 2007 OSIsoft, Inc.
*
Insert static elements in PI ProcessBook
Insert dynamic elements in PI ProcessBook
Use the Multi-State functionality in PI ProcessBook
Use Datasets in PI ProcessBook
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Software to facilitate building and visualization process diagrams, values and trends in real time
PI ProcessBook includes Visual Basic for Applications (VBA) as a development environment
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
What Is PI ProcessBook?
PI ProcessBook is a sophisticated PC tool for displaying plant information stored in the PI System archives and other sources. The PI Server may be thought of as a database of measured or calculated values for each of the points you have established for discrete data sources in your process or facility.
The PI ProcessBook application contains one or more ProcessBooks, which are collections of 'display entries'. These display entries show you data from one or more PI Systems as well as other static and dynamic information from outside sources such as schematic drawings, laboratory data, or specifications.
Displays often include dynamic trends of current values being collected. You can analyze the data in a variety of ways, such as using a cursor to obtain specific values, scrolling backward through historical data, or zooming in to observe more detail.
You can share ProcessBooks among users, thereby eliminating the need to build duplicate displays.
The PI ProcessBook application also incorporates Microsoft Visual Basic for Applications (VBA), so that you can automate special activities or routine chores.
Copyright © 2007 OSIsoft, Inc.
Standard Windows Structure
PI ProcessBook uses a standard Windows type environment that make functions accessible from:
Menus
Toolbars
*
*
Contains commands for opening, saving, printing, and closing ProcessBooks and ProcessBook entries, and for creating new ProcessBooks and ProcessBook entries. This menu also provides access to the PI Server connection window
Copyright © 2007 OSIsoft, Inc.
*
Includes PI ProcessBook object edition functions:
Modify properties of the selected object (Format);
Change background color (Display);
Add/remove scroll bars (Scrolling);
Define multiple states (Multi-State);
Modify linked objects (Links);
View Menu
Choose the toolbars;
Add a cursor on the trend (Trend Cursor);
Zoom part of a trend (Trend Zoom);
Modify Trend Scale;
*
Display;
Text;
Link;
Access Tag Search window;
Configure Data Sets (Summary, Expression, ODBC);
Select a PB and choose the element to display (Display Search & Run);
Edit and run Macro functions;
Load add-ins (Add-Ins Manager);
*
Static objects;
Symbol library.
Arrange Menu
Includes common drawing tools to manipulate and reorganize graphic elements:
Alignment;
*
Help Menu
There are 4 ways to get online help in PI ProcessBook:
Use the Help menu;
Press F1;
Put the mouse cursor on an icon and read the message displayed in the main screen’s status bar.
Copyright © 2007 OSIsoft, Inc.
Run Mode: Used to browse PI ProcessBook elements
Build Mode: Used to build or edit a PI ProcessBook element
Change mode using the Tools menu or Drawing toolbar
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Build and Run Modes
When you work with a ProcessBook or an independent display, you work in one of two modes, Run mode or Build mode.
Build mode is used to edit a ProcessBook, symbols, and other objects within a display.
Once the ProcessBook is built, Run mode is used to open entries and execute commands. Being in Run mode also keeps you from accidentally changing items in a display.
You switch between modes by clicking on the Run mode pointer (an arrow) or the Build mode pointer (a hammer), which are originally found on the Tools menu and the Drawing toolbar. Your preferred mode of operation is set as a default in your Preferences settings.
Copyright © 2007 OSIsoft, Inc.
*
Use the New and Open button:
New creates a new window for every click
Open always refers to the same window
Multiple copies
*
Opening an PB Entry
Use any of these procedures to open a PB entry from either Book view or Outline view of a ProcessBook:
Click on the entry title, then on the New button to activate the selected entry into a new window;
Click on the entry title, then on the Open button to open the entry into the last window you used. If none are open, a new window will open;
With the Run mode pointer, double-click on the entry. The entry will open and will appear within an existing window, if possible;
Click and drag the entry title to an unused area in the application work area and release the mouse. This opens a new window in addition to already opened windows. If you drag the item on top of an open item, it will close that item while opening the dragged one;
To use the keyboard instead of the mouse, use Ctrl+F6, to select the ProcessBook, then use the up or down arrow keys to select the entry title. Press Enter. If you have more than one window open, it will replace the open windows with the new display. Pressing Alt+N is the same as clicking the New button.
If the entry is a Display, Linked Display, or Linked ProcessBook, the entry is opened and the contents are displayed on your work area. If the entry is an Operating System Command, the command is executed or the application is started.
Note: If you click on an Operating System Command more than once, it may or may not open an additional copy of the application, depending on the application.
Displays re-open in the same position, size, and shape as they were saved.
Copyright © 2007 OSIsoft, Inc.
(ALT-V or Outline/Book from the View menu):
Book Mode Outline Mode
*
ProcessBook Views
Book view resembles a binder with tabs and pages. Each page contains displays. Clicking on the tab along the right side of the ProcessBook displays the first page of that group of displays.
Outline view lists all the items in a hierarchy on a single page that can be scrolled up and down.
ProcessBook Hierarchy
In Book view, level 1 creates a new tab.
In Book view, levels 3 to 10 are displayed on level 3.
Copyright © 2007 OSIsoft, Inc.
Outline View
In Run mode, you can choose the number of displayed levels with the numbers or use the + and – symbols to expand or collapse a section
In Build mode, arrows are used to change an object’s level or to move it up and down
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Working in Outline View
Select Outline from the View menu to display a ProcessBook as an outline. When you are in Outline view, an additional toolbar is added to the active ProcessBook window. You may need to resize the window so all the buttons are visible. Use the horizontal and vertical scroll bars to see all the displays in the outline.
How to Collapse, Expand, or Rearrange an Outline View
Sections of the outline can be collapsed or expanded to help you view the list of displays in a meaningful manner. Any display with a plus sign to its left can be collapsed or expanded by clicking on the plus sign, allowing you to hide or show additional displays that are subordinate to the selected display.
Alternatively, highlight a section and use the plus and minus buttons on the Outline Toolbar to collapse or expand it. Use the arrows to move an entry left, right, up, or down.
When collapsed, subordinate displays are not visible and the plus sign to the left of the display changes from hollow to solid.
Use the numbered buttons on the outline Toolbar to collapse the outline to a specific level. For example, click on 3 to collapse the outline so that only levels 1, 2, and 3 are visible. These buttons affect the entire outline, rather than a selected heading or level. Click All to view all 10 levels.
Copyright © 2007 OSIsoft, Inc.
Static Elements
Dynamic Elements
Put it on the display
Define its configuration when prompted for
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
*
Full screen graphic display
Trend cursors
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
How to Use Trend Zoom
With the Run mode pointer, click on an area in the trend on which you want to get a closer look. Drag the pointer diagonally to create a rectangle. When you release the mouse, the trend displays the data within the rectangle.
Trend Zoom 2x In or Out
You can use the Trend Zoom 2x command (View menu) to either reduce or multiply the time range by a factor of 2. In other words, if your time range is 8 hours, Trend Zoom 2x In divides the time range by 2 and displays the trend for a 4 hour time period. Trend Zoom 2x Out multiplies the time range by 2 and would display the trend for a 16 hour time period.
Copyright © 2007 OSIsoft, Inc.
Double-Click again to de-activate
*
Expand a Trend
When you double-click within a trend element using the Run mode pointer, the trend is redrawn so that it occupies the entire display window.
Double-click again to reduce the trend to its original size.
Copyright © 2007 OSIsoft, Inc.
Vertical Axis Scale
The Zoom function previously described does change the vertical axis scale
To manually change the vertical axis scale:
With the Trend Scale function of the View menu
Double-click on the vertical axis
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Scale
Single Scale: All the traces use the same scale (Tags field not enabled)
Multiple Scales: Each trace has its own scale (Tags field enabled)
Minimum and Maximum
Database: Adjusts according to history of a point
Absolute: Adjusts according to user defined parameters
Copyright © 2007 OSIsoft, Inc.
*
Activates a cursor to display the exact value at one (or more) given time(s)
Trend Cursors
*
Adding Trend Cursors
Note whether the time scale is displayed at the bottom and the timestamp is displayed at the upper right. If not, the trend rectangle may be too small to use trend cursors. Enlarge the trend. If the timestamp does not appear, reformat the display format to show it;
With the Run mode pointer, click the Trend Cursor button or, select Trend Cursor from the View menu. An indented icon in front of the command indicates that trend cursors are on. Then, at the right edge of the trend, when the mouse pointer changes to a double-headed arrow, click on the vertical line of the trend cursor and drag left;
or
Move the mouse pointer over the left axis of the trend. The pointer changes to a trend cursor symbol. As you drag to the right, a new trend cursor is added to the trend;
Move the trend cursor back and forth across the trend. As you move it, the timestamp, status, and value are displayed in boxes at the top right of the trend;
When you release the cursor, the values appear in boxes at the top and bottom of the cursor. You can add additional cursors by grabbing the trend cursor icon at the left axis.
Removing a Trend Cursor
Click on the Trend Cursor button or use the Trend Cursor command from the View menu.
To remove one trend cursor but not all of them, click on a trend cursor and drag it to the left or right off the trend.
Copyright © 2007 OSIsoft, Inc.
“One time period forward – backward” functions:
Browses one time period forward or backward and accesses the appropriate archived data
Use the scroll bar:
*
Scroll Time Range
Use the One Time Period Forward and One Time Period Backward buttons to scroll the time range forward or backward on a trend. If no trend is specifically selected, the scroll buttons are ghosted. If no items are selected, all items change.
In Run mode, you may also scroll time by the Scroll Time scrollbar.
The arrows scroll a selected trend backward or forward one time period as defined in the trend. You may also drag the slider.
Trends scroll by the time range specified in the trend definition. When you select multiple trends, each trend maintains its time range as it is scrolled. If you select a trend and a dynamic element such as a value, the element scrolls by the time range specified in the trend definition.
For example, if the trend displays data from 1:00 to 4:00 (3 hours) and the value has a timestamp of 5:00, scrolling backward shows trend data from 10:00 to 1:00. The value’s timestamp also changes by 3 hours (2:00).
Copyright © 2007 OSIsoft, Inc.
Uses absolute or relative time format
The value of the To parameter must be * for automatic trend update
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Changing the Time Range
With the Run mode pointer, select the dynamic element or elements for which you want to change the time range. If no elements are selected, the time range change will affect all dynamic elements in the display;
Select Time Range from the View menu. The Change Time Range dialog is displayed;
Select new starting and ending times from the drop-down lists or define your own starting and ending times. Time ranges can be relative, absolute or combined;
Click OK. The selected elements change to reflect the new time range.
Copyright © 2007 OSIsoft, Inc.
Revert to Original Configuration
Use the Revert function of the View menu or the button to get back to the original display
The changes made in View mode are only temporary and will not change the original configuration
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Revert to Original Configuration
The Revert option discards any changes you have made to the Time Range changes and Trend Zooming. It also removes trend cursors. Alternatively, click the Revert Time Ranges button, usually located on the Time Range toolbar.
Copyright © 2007 OSIsoft, Inc.
Viewing Options on Multiple Items
It is possible to select more than one item at a time
Hold the CTRL or the SHIFT key and click on the desired items
Selected items are framed with a red rectangle
Most view functions will apply to all items that are selected
If none selected, the changes will be applied to all items on the display
These functions will also make Bar Graphs and Dynamic Values show values in the past
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Selecting Multiple Objects
First, with the Build Mode pointer, you must select the objects that you want to change or move. A selected object displays handles.
To select all of the objects in a drawing area, choose Select All from the Edit menu.
To select individual objects, hold down the SHIFT key while clicking on each object. Selection handles are displayed around each item.
To select several objects at the same time, click near the first object. Drag to create a rectangle that includes all the objects you want to select.
If objects are stacked on top of each other, click on the top object. Selection handles appear. If you continue clicking on the top object, the selection handles appear around each object as it moves down each layer in the stack. This helps you locate an object that may be hidden by another object.
Copyright © 2007 OSIsoft, Inc.
Temporary Trends (Ad-Hoc)
In Run mode, there are 2 ways to create a trend:
In the current window:
Select one or many values, click on then draw a rectangle to display the trend
In a new window:
Select one or many values, then click on to create an Ad-Hoc trend
It is possible to save the new window
as a Display
*
Multi-state Symbol displays user defined bad data color
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Familiarize yourself with the PI ProcessBook environment
Learn how to manipulate a trend display using an existing PI ProcessBook
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
*
PB Display: Independent display page
Note : An asterisk (*) beside the name of the PB or the display in the title bar means that the document has not been saved or there have been modifications since the last save
IT Monitor Server and Interfaces Class
All rights reserved, OSIsoft Inc. © 2007
*
Building a PI ProcessBook
Creating a New ProcessBook
In Build mode, from the File menu, select New. Click the ProcessBook (.piw) File option button.
Type the title of the ProcessBook in the ProcessBook Name text box.
Click OK. A new ProcessBook is displayed. If you entered a name in the name text box, the name is shown in the title bar of the ProcessBook; otherwise, it shows “Untitled “
Creating ProcessBook Entries
The next step in creating a ProcessBook is to add individual entries. By arranging and combining displays and other entry types, you can create a complete working environment for plant personnel. You can add the entry titles to the ProcessBook and then complete the detailed design of the entries later.
Independent Display Files
A PI ProcessBook display may be created and saved independently from a ProcessBook file (.piw). Such independent files have a file name with a .pdi extension.
Independent display files may be useful for sharing information across a network. Obviously, if an independent display file is used on a PC without an installed copy of the PI ProcessBook application, the display file cannot open.
Independent display files may be created from existing displays within ProcessBooks or by choosing File> New > ProcessBook Display (.pdi) File and creating a completely new display.
Copyright © 2007 OSIsoft, Inc.
Display
*
There are five specific types of entries:
Text entries, to provide headings or to provide static information. Useful for organizing PI ProcessBook documents by adding titles;
Display entries: page that can contain different objects (trends, process mimics, etc.);
Linked Display entries: link with a display, internal or external, to the current PI ProcessBook. A Linked Display allows you to link a display title in a ProcessBook to an entry elsewhere in the ProcessBook or in another ProcessBook. This means that you create and store only one copy of the entry;
Linked ProcessBook entries: link to another PI ProcessBook document;
Operating System Command entries, which open another application. The icon will usually represent the application; if that icon isn’t available, the default icon is the running man.
Copyright &