Transcript
PI Training Course
PI TR-011
IT Monitor Server and Interfaces
Version 2.1
Copyright © 2007 OSIsoft, Inc.
Course Content
Day 1 – Installing and Managing the Server
1. Introduction to PI and IT Monitor
2. PI Architecture and Data Flow
3. PI Server Installation and Management
4. Managing Archives
5. PI Backup
6. Quality and Optimization of Data
7. Common Modules for PI Applications
Copyright © 2007 OSIsoft, Inc.
2
Course Content
Day 2 – Consulting and Organizing Data
8. PI ProcessBook
9. PI DataLink
10.PI Module Database
Copyright © 2007 OSIsoft, Inc.
3
Course Content
Day 3 – Gathering Information from IT Infrastructure
11.IT Monitor Interfaces Overview
12.PI Interfaces
13.PI Ping Interface
14.PI TCPResponse Interface
15.PI Performance Monitor Interface
Copyright © 2007 OSIsoft, Inc.
4
Course Content
Day 4 – Gathering Information from IT Infrastructure
16. PI Windows Event Log Interface
17. PI SNMP Interface
18. Organizing Monitored Devices
19. PI SNMPTrap Interface
20. PI SysLog Interface
21. Regular Expressions
Copyright © 2007 OSIsoft, Inc.
5
Course Content
Day 5 – Gathering Information from IT Infrastructure
22.PI Security
23.Distributed Interfaces
24.PI IP Flow and PacketCapture
25.Global Recap exercise
26.Advanced Topics
27.IT Monitoring Suggestions
Copyright © 2007 OSIsoft, Inc.
6
1.0 Introduction
to PI and IT Monitor
Copyright © 2007 OSIsoft, Inc.
Introduction to PI and IT Monitor
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
Copyright © 2007 OSIsoft, Inc.
8
What is IT Monitor?
Based on the PI System
Collects real-time information regarding the
performance of various elements composing an IT
infrastructure
Printers
Networking equipment
Servers and computers
Storage Area Networks (SANs)
Uninterruptible Power Systems (UPSs)
Applications
Voice Over IP Systems
And many more…
Copyright © 2007 OSIsoft, Inc.
9
IT Monitor vs. MCN-HM
MCN-HM (Manufacturing Control Network – Health Monitor)
4 additional data collection agents (PI Interfaces) to a regular
PI System
IT Monitor
Complete IT monitoring solution containing:
PI System and Management Tools
Several IT-purposed PI Interfaces
Copyright © 2007 OSIsoft, Inc.
10
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.
Copyright © 2007 OSIsoft, Inc.
11
Functional Groups of The PI System
Performance Operational Knowledge
Improvement
Visibility Management
The
Visuals
The
Analytics
The
Server
Structure /
Asset
Data
Product
Lean
Asset
Situational
Quality Manufacturing Management Awareness
Deliver Information for Meaningful,
Better Business Decisions
Turn Valuable Real-Time Data
Into Actionable Information
Gathers, Organizes, Distributes,
and Stores Data from Many Sources
Real-Time
Data
Custom
Data
IT Data
Copyright © 2007 OSIsoft, Inc.
Relational
Data
Web
Services
ERP /
Maintenance
12
The Server – Platform Release 1
The
Server
The
Analytics
The
Visuals
Data Access
RtBaseline Services for
Thin Clients
OLEDB
Module Database
Analysis Framework
ODBC
PI Archive
Data Storage, Management Services,
Audit Trail, Batch
Custom Programming
Structure / Asset Data
OPC / HDA
Failover / Management Services
MCN HealthMonitor
& System Management Tools
RLINK
Real-Time Interfaces
Real-Time Data
Custom Data
IT Data
DCS / PLC / SCADA / OPC
Historians / Interfaces
COM Connectors
APIs / SDKs
IT Monitor
Relational Data
OLEDB / ODBC
ORACLE / SQL
Copyright © 2007 OSIsoft, Inc.
ERP / Maintenance
RLINK SERVERS & GATEWAYS
SAP / JD EDWARDS / PEOPLESOFT
MAXIMO / INDUS / MIMOSA
Web Services
SOA / External Data
Legacy Applications
13
The Analytics – Platform Release 1
The
Analytics
The
Server
Windows Server 2003
The
Visuals
Visual Studio.NET
Advanced Computing Engine
(ACE)
RtAlerts
Enterprise Services
RtReports
Compliance & Standard
Sigmafine
Facility Monitor
PI Analytics
(Performance Equations, Totalizer, Alarms, RTSQC)
Copyright © 2007 OSIsoft, Inc.
14
The Visuals – Platform Release 1
The
Server
The
Visuals
The
Analytics
CLIENT: Windows XP, Microsoft Office,
Intel Pentium 4
SERVER: Windows Server 2003,
Windows SharePoint Services / SAP Enterprise Portal
Smart Clients
BatchView
SQC Client
AlarmView
Thin Clients
ProcessBook
RtWebParts
RtActiveView
RtGauge
RtGraphic
RtMessenger
RtTimeRange
RtTreeView
RtTrend
RtTable
RtXYPlot
RtActiveView
RtGauge
RtGraphic
RtTable
RtTagSearch
RtTimeRange
RtTreeView
RtTrend
RtKPI
RLINK iViews
Analysis Framework Modeler Add-in
BatchView Excel Add-in
Analysis Framework Excel Add-in
ActiveView
ProfileView
DataLink
RtPortal iViews
Additional Clients
Other Thin Clients
Microsoft Windows XP or Windows Vista
DataLink Server *
RtReports Editor
RtReports Generator
Microsoft Office SharePoint Portal Server 2003
* Microsoft Office SharePoint Server 2007
Microsoft SQL Server
Performance Operational Knowledge Product
Lean
Asset
Situational
Improvement Visibility Management Quality Manufacturing Management Awareness
Copyright © 2007 OSIsoft, Inc.
15
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
Copyright © 2007 OSIsoft, Inc.
16
2.1 PI Architecture
Copyright © 2007 OSIsoft, Inc.
Typical PI System Architecture
Process Context
Client Stations
Client Stations
- ProcessBook
- DataLink
- RtWebParts
- Profile
- BatchView
- SQC
PI Server
Other System
Analytical
tools
- ERP
- Maintenance
- Lims
- ACE
- Sigmafine
Data
Acquisitio
n Node
Data
Acquisitio
n Node
Data
Sources
Data
Sources
(DCS, PLC, etc)
(DCS, PLC, etc)
Copyright © 2007 OSIsoft, Inc.
18
IT Monitor Architecture
Client Stations
- ProcessBook
- DataLink
- Etc.
Intranet/Interne
t
- ActiveView
- RtWebParts
Optional (and recommended)
Data Acquisition
Node(s) (and buffering)
IT Monitor Server
(PI Server)
Data
Sources
- Printer
- Switch
- Server
- Etc.
Copyright © 2007 OSIsoft, Inc.
19
PI Server Subsystems
Foreign Data Source
PI Server Core
Subsystems
Snapshot
Archive
Client Node
Interfaces
Random Simulator
RampSoak Simulator
Basic IT Monitor
Interfaces
PI Network
Manager
Update Mgr
Base
Server Applications
Message
PI SQL
Equations
Totalizer
Batch
Batch Generator
Alarm
SQC
Redirector
Backup
Data Acquisition Node
Utilities
Recalculator
License
PI Server: Windows NT/2000/XP/2003
Computer
Copyright © 2007 OSIsoft, Inc.
20
2.2 Data Flow
Copyright © 2007 OSIsoft, Inc.
PI Client Data Requests
Client
Application
Request
PI Network
Manager
PI Base
Subsystem
Response
PI Snapshot
Subsystem
Copyright © 2007 OSIsoft, Inc.
PI Archive
Subsystem
22
New Event Processing
PI
Interface
Exception
Report
Snapshot
Event Queue
Data
Compression
file(s)
PISnapSS
Shared Memory
Archive
PIArchSS
Online Archives
Archive
Cache
Primary Archive
Copyright © 2007 OSIsoft, Inc.
23
PI Archives
Online Archives
Primary Archive
Series of large binary files (usually in PI\DAT)
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
Copyright © 2007 OSIsoft, Inc.
24
2.3 PI Points
Copyright © 2007 OSIsoft, Inc.
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
Copyright © 2007 OSIsoft, Inc.
26
PI Point Attributes
Tag: Unique name of the PI Point
Descriptor: Description
EngUnits: Engineering units
PointClass: Category of PI point (default: Classic)
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
Copyright © 2007 OSIsoft, Inc.
27
Point Names
PI Point names are subject to the following
constraints:
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
Copyright © 2007 OSIsoft, Inc.
28
Point Classes
BASE
Included in all point
types
Totalizer
SQC_Alarm
Classic
Alarm
Adds the point attributes
for totalizer points
Adds the point attributes
for SQC Alarm points
Adds the point attributes
for interface points
Adds the point attributes
for alarm points
Base +18
Base +26
Base +15
Base +22
Warning! It is not possible to
change the point class of an
existing point.
Copyright © 2007 OSIsoft, Inc.
29
Point Types
Int16:
Unsigned Integer value, 16 bits
(0 to 32767)
Int32:
Integer value, 32 bits
(-2147450880 to 2147483647)
Float16:
Scaled Floating Point number, 16 bits
(Accuracy: 1/32767)
Float32:
Floating Point number, 32 bits
(Single precision)
Float64:
Floating Point number, 64 bits
(Double precision)
Digital:
Discrete value
(Up/Down, High/Medium/Low, On/Off)
String:
Text value up to 976 characters
Copyright © 2007 OSIsoft, Inc.
30
Float16
PI can store a floating point value in a 16 bits
integer by scaling it. The scaling always brings a
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)
Recommendation: do not use a Float16 point unless you
have a specific need for it and are ready to accept the
rounding error
Copyright © 2007 OSIsoft, Inc.
31
Float32 - Float64
Float32 have 8 significant digits
Float64 have 17 significant digits
Example:
Float32 as 834 568 766.76
insignificant
Float64 as 2.1234567890123456789
Copyright © 2007 OSIsoft, Inc.
32
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
Copyright © 2007 OSIsoft, Inc.
33
Zero, Span and Typical Value
150
100
50
0
-50
100
150
100
50
0
-50
100
150
100
50
0
-50
100
Zero = 50
Span = 100
Zero = 0
Span = 100
Zero = -50
Span = 100
Copyright © 2007 OSIsoft, Inc.
34
Step Attribute
Step=0
Step=1
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
Copyright © 2007 OSIsoft, Inc.
35
Point Changes
Deleting a point
Archived data will be lost!
There is no quick undelete
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
Copyright © 2007 OSIsoft, Inc.
36
3.1 Installation
Copyright © 2007 OSIsoft, Inc.
IT Monitoring Products
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 Interfaces (see notes below for complete list)
PI Interface Configuration Utility
PI System Management Tools (+ IT add-ins)
PI ProcessBook
PI DataLink
Demo and Samples
Copyright © 2007 OSIsoft, Inc.
38
PI System Startup and Shutdown
Start PI services
Stop PI services
\pi\adm\pisrvstart.bat (starts both PI and interfaces)
\pi\adm\pisrvsitestart.bat (starts interfaces only)
Manually start each service using Control Panel/Services
Automatic startup for Windows Services
\pi\adm\pisrvstop.bat (stops both PI and interfaces)
\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
Copyright © 2007 OSIsoft, Inc.
39
3.2 PI System Management Tools
(PI SMT)
Copyright © 2007 OSIsoft, Inc.
System Management Tools 3.x
Container application with several plug-ins
Copyright © 2007 OSIsoft, Inc.
41
Message Logs Plug-In
Gives access the PI Server messages and pipc.log messages
Copyright © 2007 OSIsoft, Inc.
42
Point Builder Plug-In
Allows creation/edition/deletion of PI Points
Copyright © 2007 OSIsoft, Inc.
43
PI TagConfigurator
Copyright © 2007 OSIsoft, Inc.
44
Settings
Connect on startup
Allow point deletion, creation
Copyright © 2007 OSIsoft, Inc.
45
Import Tags
Copyright © 2007 OSIsoft, Inc.
46
Export Tags
Copyright © 2007 OSIsoft, Inc.
47
Recommendations
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:
Copyright © 2007 OSIsoft, Inc.
48
Checking the Installation
Check PI Server status via PI SMT
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
Copyright © 2007 OSIsoft, Inc.
49
5.0 PI Backup
Copyright © 2007 OSIsoft, Inc.
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
Copyright © 2007 OSIsoft, Inc.
51
Online Backup
PI Backup subsystem
Backs up the PI Server by specifying:
The number of archive files
A time period
Uses Microsoft Volume Shadow Services (VSS)
when available
Works with the following systems:
Windows VSS and Windows Non-VSS
Windows with a third-party backup application
Windows Cluster environment
Unix environment
Copyright © 2007 OSIsoft, Inc.
52
Microsoft VSS Overview
VSS Volume Shadow Copy Service
Requires Windows 2003 Server
Very little disruption of normal operations
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
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
Copyright © 2007 OSIsoft, Inc.
53
Online Backup: VSS Mode
Platforms:
- Windows 2003 Server
VSS
VSSAPI
API
(NTFS)
(NTFS)
- Backup is driven by
backup application
1
11
Features:
- Full read/write PI Server
operation except for less
than 1 second
Base
BaseSubsystem
Subsystem
Point
PointDB
DB
Module
ModuleDB
DB
Security
DBs
Security DBs
Snapshot
SnapshotSubsystem
Subsystem
Snapshot
SnapshotTable
Table
11
VSS-aware
VSS-aware Backup
BackupClient
Client
PI Backup Subsystem
PI Backup Subsystem
(pibackup.exe)
(pibackup.exe)
Backup Scripts (simple wrappers)
Backup Scripts (simple wrappers)
pibackup.bat,
pibackup.bat,pibackuptask.bat
pibackuptask.bat
Copyright © 2007 OSIsoft, Inc.
11
Archive
ArchiveSubsystem
Subsystem
Archive
ArchiveTable
Table
Archive
0
(primary)
Archive 0 (primary)
……
Archive
Archivenn
11
Batch
BatchSubsystem
Subsystem
Batches/Batch
Batches/BatchUnits
Units
11
Message
MessageSubsystem
Subsystem
Message
MessageLog
LogFiles
Files
……
54
Online Backup: Non-VSS Mode
Platforms:
- Windows 2000
- Windows XP
- UNIX
Backup
Backup
Subsystem
Subsystem
(pibackup.exe)
(pibackup.exe)
Base
BaseSubsystem
Subsystem
Point DB
Point DB
Module
ModuleDB
DB
Security
DBs
Security DBs
11
2
Snapshot
SnapshotSubsystem
Subsystem
Snapshot Table
Snapshot Table
Features:
- No subsystems
stopped
33
piartool
piartool-backup
-backup
- No closed files
44
- Read-only operation
during each file copy
Backup
BackupScripts
Scripts(simple
(simplewrappers)
wrappers)
pibackup.bat
pibackup.bat
pibackuptask.bat
pibackuptask.bat
Archive
ArchiveSubsystem
Subsystem
Archive
ArchiveTable
Table
Archive
Archive00(primary)
(primary)
……
Archive
Archivenn
55
Batch
BatchSubsystem
Subsystem
Batches/Batch
Batches/BatchUnits
Units
66
Message
MessageSubsystem
Subsystem
Message
MessageLog
LogFiles
Files
…
…
Copyright © 2007 OSIsoft, Inc.
55
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
arc: archive and annotation files
bin: pipeschd.bat
dat: files from \PI\dat except archive
and annotation files
log: files from \PI\log
PI backup log files
Copyright © 2007 OSIsoft, Inc.
56
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
Copyright © 2007 OSIsoft, Inc.
57
Automating VSS Backups on Windows
Add a Scheduled Task using the PIBackup.Bat script from
the \pi\adm folder
Syntax:
PIBackup.bat
[number of archives] [archive cutoff date] [–install]
Example:
PIBackup.bat E:\PI\Backup 2 *-60d -install
Copyright © 2007 OSIsoft, Inc.
58
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
Copyright © 2007 OSIsoft, Inc.
59
View and Edit a Scheduled Backup
Use the Scheduled Tasks control panel
Select the PI Server Backup entry
Using the right-click menu, choose Properties
Copyright © 2007 OSIsoft, Inc.
60
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
Copyright © 2007 OSIsoft, Inc.
61
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
Copyright © 2007 OSIsoft, Inc.
62
Permanent Backup
OSIsoft recommends:
Making a permanent backup of the archive files
Backing up the configuration files along with the
archives
Backing up files that are not part of the backup
script:
Interface startup files (*.Bat)
PISrvSiteStart.Bat, PISrvSiteStop.bat
PI ACE executables and code
Etc.
Keeping two copies, one on-site and one off-site
Keeping a copy of all the setup kits
Copyright © 2007 OSIsoft, Inc.
63
Backup Complete
How do I tell if the Backup was successful?
There will be a log file
Ex.: pibackup_2-Oct-06_03.15.02.txt
PI Server Message Logs
Copyright © 2007 OSIsoft, Inc.
64
5.2 PI System Restoration
Copyright © 2007 OSIsoft, Inc.
Single Archive File Restoration
1. Restore the archive file from the backup media
2. Register the archive using PI SMT Archive
Manager plug-in
3. Make the archive non-shiftable
Copyright © 2007 OSIsoft, Inc.
66
PI Server Restoration Tasks
Install the operating system (if required)
Install PI Server software
Start and stop the PI Server
Restore your backed up files
Restart the PI Server
Copyright © 2007 OSIsoft, Inc.
67
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
Copyright © 2007 OSIsoft, Inc.
68
6.0 Quality and Optimization
of Data
Copyright © 2007 OSIsoft, Inc.
Quality and Optimization of Data
Objectives:
Select proper parameters for the exception test
Select proper parameters for the compression test
Select proper scan rates
Select proper zero and span attributes
Copyright © 2007 OSIsoft, Inc.
70
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
Performance
Storage space
Network utilization
Dynamics of the scanned value
Copyright © 2007 OSIsoft, Inc.
71
Data Flow Recap
New value
(scan or
exception
based)
Exception
Report
Snapshot
Exception
PI
compression
algorithm
PI
Archives
Compression
PI Server
Interface (on Data
Collection Node)
Copyright © 2007 OSIsoft, Inc.
72
Raw Data - Example
Raw values scanned on the data source.
Temperature
Without Exception and Compression tests, these
would all be archived
Time
Copyright © 2007 OSIsoft, Inc.
73
Exception Test (Interface Level)
Exception Test:
ExcMax (time)
Current Snapshot
+ ExcDev
- ExcDev
• 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.
Copyright © 2007 OSIsoft, Inc.
74
PI Exception Test - Example
Scan = 1m … ExcDev = 1 … ExcMax = 10m
New Value
Exception
Current Snapshot
12:00
50.0
Yes
12:00
50.0
12:01
50.3
No
12:00
50.0
12:02
51.1
Yes
12:02
51.1
…
…
No
12:02
51.1
12:12
51.4
Yes
12:12
51.4
Copyright © 2007 OSIsoft, Inc.
75
Temperature
Exception Test - Example
E
E
E
E
P
E
E
E
P
E
P
E
E: Exception
E
P
P: Previous
Copyright © 2007 OSIsoft, Inc.
E
Time
76
Temperature
Exception Test - Results
Successive values sent to the PI Server.
When a value is sent, it becomes the new
snapshot.
Time
Copyright © 2007 OSIsoft, Inc.
77
Exception Test
When a value passes this test, that value and
the previous value are reported.
Temperature
Why? To have a better representation of the actual behavior
Passes the
exception test
Trend if
previous value
is not sent
Snapshot value
Trend if
previous
value is sent
+/- ExcDev
Previous value
Time
Copyright © 2007 OSIsoft, Inc.
78
Turning Off Exception?
Behavior of ExcDev=0 (and ExcMin=0)
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)
Copyright © 2007 OSIsoft, Inc.
79
Compression Test (PI Server)
Compression Test:
Last archived
value
Current
snapshot
ev
+ CompD
ev
- CompD
< CompMax (s)
• 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.
Copyright © 2007 OSIsoft, Inc.
80
Temperature
Compression Test – Example
The compression algorithm is performed
on new snapshots to determine which
data is kept in the PI archives
A
A
A
A
A
A
A: Archived Value
Copyright © 2007 OSIsoft, Inc.
A
Time
81
Compression Results
Temperature
Values kept in the PI archives
When the user requests a value that turns
out to be interpolated, the difference can be
no greater than ±CompDev
Time
Copyright © 2007 OSIsoft, Inc.
82
Compression Results
Temperature
After
Raw values
Exception
Compression
scanned
Time
Copyright © 2007 OSIsoft, Inc.
83
Turning Off Compression?
Behavior of Compression
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
Copyright © 2007 OSIsoft, Inc.
84
Data Flow
The exception and compression specifications
should be adjusted to achieve efficient archive
storage without losing significant data.
Disk Space and Performance vs Data Accuracy
Copyright © 2007 OSIsoft, Inc.
85
Exception and Compression Attributes
Each PI Point can be individually configured for its exception
reporting and compression
Exception Reporting
Attributes
ExcDev or
ExcDevPercent
ExcMax
ExcMin
Compression
Attributes
CompDev or
CompDevPercent
CompMax
CompMin
Compressing
Copyright © 2007 OSIsoft, Inc.
86
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
Copyright © 2007 OSIsoft, Inc.
87
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
Copyright © 2007 OSIsoft, Inc.
88
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:
Memory:
Disk space:
Ping:
1 second
10 seconds
1 minute
1 minute
Copyright © 2007 OSIsoft, Inc.
89
IT Monitor Default Settings
Default settings for PI points are:
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
Zero and span
Copyright © 2007 OSIsoft, Inc.
90
Set Appropriate Zero & Span
Be careful when defining Zero and Span
because:
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
Copyright © 2007 OSIsoft, Inc.
91
7.1 PI Time Format
Copyright © 2007 OSIsoft, Inc.
PI Time Format
Absolute (a specific point in time)
Relative (time is offset from another time)
* : (NOW)
t : 00:00:00 on the current day (TODAY)
18-feb-07 16:00:00
+8h : + 8 hours
Combined
t+8h : today + 8 hours
Copyright © 2007 OSIsoft, Inc.
93
Absolute Time
dd-mmm-yy HH:mm:ss
dd
mmm
yy
HH
mm
ss
Day
Month (Jan, Feb, Mar, Apr, May, …)
Year
Hours in 24 hour format
Minutes
Seconds
Example:
18-feb-07 10:43:29
Copyright © 2007 OSIsoft, Inc.
94
Absolute Time
dd-mmm-yy HH:mm:ss
"Date" fields default to the current date
"Time" fields default to 00.
Expression
Meaning
25
00:00:00 on the 25th of the current month
18-Feb-07
00:00:00 on that date
8:
08:00:00 on the current date
25 8
08:00:00 on the 25th of the current month
21:30:01.02
9:30:01.020 PM on the current date
(.020 means 20 milliseconds)
Copyright © 2007 OSIsoft, Inc.
95
Absolute Time – Other Formats
Absolute time formats
Symbol
Meaning
*
Current time
t
00:00:00 on the current day (TODAY)
y
00:00:00 on the previous day
(YESTERDAY)
Monday, Tuesday,
Wednesday, Thursday,
Friday, Saturday.
Sunday
00:00:00 on the most recent of that
day of the week
Copyright © 2007 OSIsoft, Inc.
96
Relative Time
Number of:
Weeks (w)
Days (d)
Years (y)
Months (mo)
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
Hours (h)
Minutes (m)
Seconds (s)
+2.5h, -0.5m
Relative time is most often part of a Combined time
Syntax
Meaning
+2d
+ two days
-1.5h
- One hour and a half
+32m
+ 32 minutes
-15 s
- 15 seconds
Copyright © 2007 OSIsoft, Inc.
97
Combined Formats
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
8 hours ago
t-7d
00:00:00, 7 days ago
y+11h
Yesterday at 11:00:00 AM
Monday + 14.5h
02:30:00 PM on the most recent Monday
Copyright © 2007 OSIsoft, Inc.
98
Directed Exercise
PI Time
Express the following timestamps using the absolute time
format:
Tuesday-2d
1 6:
y+8h
*-30m
Express the following times in valid PI timestamps:
Today at 6:00 AM
The 4th of the current month at 16:00
12 hours ago
Copyright © 2007 OSIsoft, Inc.
99
7.2 Common Dialog Windows
Copyright © 2007 OSIsoft, Inc.
PI Connection Manager
Viewing Connection Information
Use the check
boxes to connect /
disconnect from the
available PI servers
Connection settings
Connection information
Copyright © 2007 OSIsoft, Inc.
101
PI Connection Manager
Editing Connection Settings
The connection settings
can de edited
Click the Save button to
apply the changes
To change the default PI
server, select Tools
Options
Copyright © 2007 OSIsoft, Inc.
102
PI Connection Manager
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
Copyright © 2007 OSIsoft, Inc.
103
Tag Search Window
In PI ProcessBook:
Tag Search command from Tools Menu
Using toolbars:
From an object properties window:
In PI DataLink:
Tag Search command from PI Menu
Copyright © 2007 OSIsoft, Inc.
104
Tag Search Window – Basic Search
Select PI
Server(s) to
search through
Tag name
mask
Look for a
specific point
type/class/sourc
e
Look for a specific
value/status/attrib
ute
Tag search
results
Start searching
according to the
criteria
Copyright © 2007 OSIsoft, Inc.
Display the
attributes/values
for selected
points
Validate
selectio
n
105
Tag Search Strategies
Tag Search using wildcards:
Use * to replace any number of characters
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 = #
Copyright © 2007 OSIsoft, Inc.
106
Tag Search Window – Advanced Search
SQL-like query
based on useddefined
conditions
1- Define
condition
2- Click 'Add'
…
3- Click 'Search
Copyright © 2007 OSIsoft, Inc.
107
Tag Search Window – Alias Search
Search for aliases
in the PI
ModuleDB
(described later)
Copyright © 2007 OSIsoft, Inc.
108
Point Information Windows
Pt. Attr...
Copyright © 2007 OSIsoft, Inc.
Pt. Values...
109
8.0 PI ProcessBook
Copyright © 2007 OSIsoft, Inc.
PI ProcessBook
Objectives:
Create a ProcessBook document
Create a trend showing multiple points in PI ProcessBook
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
Copyright © 2007 OSIsoft, Inc.
111
What is PI ProcessBook?
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
Copyright © 2007 OSIsoft, Inc.
112
Standard Windows Structure
PI ProcessBook uses a standard Windows
type environment that make functions
accessible from:
Menus
Toolbars
Copyright © 2007 OSIsoft, Inc.
113
File Menu
Copyright © 2007 OSIsoft, Inc.
114
Edit and View Menus
Copyright © 2007 OSIsoft, Inc.
115
Insert and Tools Menus
Copyright © 2007 OSIsoft, Inc.
116
Draw and Arrange Menus
Copyright © 2007 OSIsoft, Inc.
117
Window and Help Menu
Copyright © 2007 OSIsoft, Inc.
118
PI ProcessBook Modes
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
Copyright © 2007 OSIsoft, Inc.
119
8.1 Run Mode
Copyright © 2007 OSIsoft, Inc.
Opening Elements
Double-click to open an item
Use the New and Open button:
New creates a new window for every click
Open always refers to the same window
Multiple
copies
Copyright © 2007 OSIsoft, Inc.
121
View Modes
PI ProcessBook has 2 view modes
(ALT-V or Outline/Book from the View menu):
Book Mode
Outline Mode
Copyright © 2007 OSIsoft, Inc.
122
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
Copyright © 2007 OSIsoft, Inc.
123
The Draw Menu
Lists elements that can be
added to the display
1.
2.
3.
Static Elements
Dynamic Elements
In Build mode, select the
desired element
Put it on the display
Define its configuration
when prompted for
Copyright © 2007 OSIsoft, Inc.
124
Dynamic Elements
Trends
X-Y Plots
Bar Graphs
Dynamic Values
ActiveX Controls
Copyright © 2007 OSIsoft, Inc.
125
Trend Viewing Options
Zoom in/out on a trend
Full screen graphic display
Change the time period
displayed
Change the vertical axis
scale
Trend cursors
Revert to original
configuration
Note: These functions are only
enabled in Run mode
Copyright © 2007 OSIsoft, Inc.
126
Zoom
Drag a rectangle within the trend boundary
Use revert to return to original definition
Copyright © 2007 OSIsoft, Inc.
127
Full Screen
Double-Click in Run mode to activate
Double-Click again to de-activate
Too small?
Double-Click on it
Copyright © 2007 OSIsoft, Inc.
128
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
Copyright © 2007 OSIsoft, Inc.
129
Trend Cursors
Activates a cursor to display the exact value at
one (or more) given time(s)
Copyright © 2007 OSIsoft, Inc.
130
Change Time Range
Zoom function previously described
“One time period forward – backward” functions:
Browses one time period forward or backward and
accesses the appropriate archived data
Use the scroll bar:
Copyright © 2007 OSIsoft, Inc.
131
Change Time Range
Time Range function in View menu or
Uses absolute or relative time format
The value of the To parameter must be * for
automatic trend update
Copyright © 2007 OSIsoft, Inc.
132
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
Copyright © 2007 OSIsoft, Inc.
133
Viewing Options on Multiple Items
It is possible to select more than one item at a time
Most view functions will apply to all items that are
selected
Hold the CTRL or the SHIFT key and click on the desired
items
Selected items are framed with a red rectangle
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
Copyright © 2007 OSIsoft, Inc.
134
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
rectangle to display the trend
then draw a
In a new window:
Select one or many values, then click on
an Ad-Hoc trend
to create
It is possible to save the new window
as a Display
Copyright © 2007 OSIsoft, Inc.
135
Unavailable Data
Trends display nothing
Value displays “No Data”
Trend Cursor displays “No Data”
Bar Graph displays diagonal lines
Multi-state Symbol displays user defined bad
data color
Copyright © 2007 OSIsoft, Inc.
136
Exercise 4
Familiarizing with ProcessBook
Objectives
Familiarize yourself with the PI ProcessBook
environment
Learn how to manipulate a trend display using an
existing PI ProcessBook
Copyright © 2007 OSIsoft, Inc.
137
8.2 Build Mode
Copyright © 2007 OSIsoft, Inc.
Building a PI ProcessBook
Using File/New or
PB File: ProcessBook Workbook
icon
PB Entry: PI ProcessBook elements (displays)
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
Copyright © 2007 OSIsoft, Inc.
139
ProcessBook Elements
5 types of ProcessBook Elements
Display
Linked Display
Operating System Command
Linked ProcessBook
Text
Copyright © 2007 OSIsoft, Inc.
140
Adding a ProcessBook Text Element
Titles to organize the ProcessBook document
(in Build mode, with the option File/New or Insert/Text)
Copyright © 2007 OSIsoft, Inc.
141
Adding a ProcessBook Display Element
Main elements of a ProcessBook document
(in Build mode, with the option File/New or Insert/Display)
Copyright © 2007 OSIsoft, Inc.
142
Adding ProcessBook Linked Elements
References to objects already existing
Linked Display, Linked ProcessBook
Copyright © 2007 OSIsoft, Inc.
143
Adding a ProcessBook OS Command Element
Open external files and launch external applications
Calculator, Notepad
Excel Spreadsheet, Word Document, Access Database
Web site in Internet Explorer
Copyright © 2007 OSIsoft, Inc.
144
Trend Building
In Build mode:
1.
2.
3.
Use Trend option accessible from the Draw menu
or by clicking
Draw a rectangle with the mouse to define the size
of the trend
A Design window with 4 different tabs allows
configuration of the trend: General, Display
Format, Trace Format and Layout
Copyright © 2007 OSIsoft, Inc.
145
Trend Building – "General" Tab
Copyright © 2007 OSIsoft, Inc.
146
Trend Building – "Display Format" Tab
Copyright © 2007 OSIsoft, Inc.
147
Trend Building – "Trace Format" Tab
Copyright © 2007 OSIsoft, Inc.
148
Building Trends – "Layout" Tab
Copyright © 2007 OSIsoft, Inc.
149
Multi-Trends Creation - Example
Simultaneous creation of 5 trends
Row Col ExRow ExCol
2
2
1
1
Total: 2 x 2 + 1 x 1 = 5
Line and column
Bottom Section
Extra line and column
Top Section
Copyright © 2007 OSIsoft, Inc.
150
Trend Modification
Select a trend, and use the Selected Item
function from the Edit menu
Double-click on the trend in Build mode
The
button is used to modify the selected
trend’s font
This button is only accessible in Build mode
Copyright © 2007 OSIsoft, Inc.
151
Exercise 5
Building a PI ProcessBook hierarchy and adding trends to displays
Objectives
Build a new ProcessBook Workbook file
Create ProcessBook entries
Configure trends on displays
Copyright © 2007 OSIsoft, Inc.
152
Static Shapes
Accessed from the Draw menu
Rectangles
Ellipses/Circles
Lines/Polylines
Polygons
Arcs
Connectors
Graphics from Symbol Library and Imported Image Files
All items can be grouped, colored, connected,
and/or made to be multi-state objects
Copyright © 2007 OSIsoft, Inc.
153
Line and Color Properties
In the Formatting toolbar
Change line properties with
Change color properties with
Apply changes to
Selected element(s)
If none selected, default
properties for new objects
Lines
Colors
Copyright © 2007 OSIsoft, Inc.
154
Symbol Library
The
button allows access to a library of symbols
Copyright © 2007 OSIsoft, Inc.
155
Importing Graphic Files
Import an image file in a display
Use the button
or the Graphic option in the Draw menu
Copyright © 2007 OSIsoft, Inc.
156
Alignment
Use the Align option from the Arrange menu
to line-up objects
Copyright © 2007 OSIsoft, Inc.
157
Move Objects Forward and Backward
Use the options Forward, Backward, Bring to
Front and Send To Back in the Arrange menu
to determine the layering of objects
Copyright © 2007 OSIsoft, Inc.
158
Object Grouping
Use the grouping options of the Arrange menu to
group/ungroup objects
Allow manipulation of grouped objects as one single object
Copyright © 2007 OSIsoft, Inc.
159
Exercise 6
Adding Static Elements to Displays
Objectives
Learn how to integrate static elements in a display
entry.
Copyright © 2007 OSIsoft, Inc.
160
Dynamic Elements
The following dynamic
elements can be added
to a display:
Value
Bar
Multi-State Symbols
Command Button
Copyright © 2007 OSIsoft, Inc.
161
Dynamic Elements
Bars and Values
Copyright © 2007 OSIsoft, Inc.
162
Examples of a Bar Graph
Background color
Fill color
Fill color
Background color
Fill color
Background color
Copyright © 2007 OSIsoft, Inc.
163
Bar Graphs
A Bar Graph shows the current value of a point as compared to
a specified range of values.
The following options are available:
Horizontal or Vertical position
Minimum and maximum values based on:
The PI point's zero and span attributes or;
User-defined minimum and maximum values.
Customized colors
Can show values in the past, when using time functions
described earlier
Copyright © 2007 OSIsoft, Inc.
164
Dynamic Values
A Dynamic Value is the current value for a point
The following options are available:
Show or not the point name (and where)
Show or not the timestamp (and where)
Show or not the engineering units
Can show values in the past, when using time
functions described earlier
Copyright © 2007 OSIsoft, Inc.
165
Multi-State Objects
Objects that change
state based upon user
defined values.
Bar Graphs
Dynamic Values
Shapes
Symbols
Copyright © 2007 OSIsoft, Inc.
166
Command Buttons
Launch any operating system command or
recognized file type.
Launch any VBA-developed macro
Can be used for internal navigation scheme
Copyright © 2007 OSIsoft, Inc.
167
Layers
Graphic elements can be built on layers, and then
each layer can be manipulated as a group.
Choose View > Layers to create/edit/delete layers
and choose which one(s) to show
Right-click on symbols on the
page and choose Assign Layers
to associate symbols to one or
more layer(s)
Copyright © 2007 OSIsoft, Inc.
168
Default Properties for New Objects
Trends: Preferences option in the Tools menu
Color, font and line style for all other objects:
Open a display
Do not select anything
Use the Color ( ), Font (
) and Line Style (
tools to define what will be become the default
properties
Copyright © 2007 OSIsoft, Inc.
)
169
Configuring Preferences – Color & Font
Use the Preferences option of the Tools menu
Copyright © 2007 OSIsoft, Inc.
170
Configuring Preferences - Start
Use the Preferences option of the Tools menu
Copyright © 2007 OSIsoft, Inc.
171
Configuring Preferences - Trends
Use the Preferences option of the Tools menu
Copyright © 2007 OSIsoft, Inc.
172
9.0 PI DataLink
Copyright © 2007 OSIsoft, Inc.
PI DataLink
Objectives:
Create reports using the various functions available in PI
DataLink
Copyright © 2007 OSIsoft, Inc.
174
What is PI DataLink ?
PI DataLink is an OSIsoft Add-In for Microsoft
Excel (and Lotus 1-2-3)
This Add-In lets you import data from the PI
System into a spreadsheet for further analysis
Copyright © 2007 OSIsoft, Inc.
175
PI DataLink Menu
Functions that retrieve a single value
Functions that retrieve series of values
Functions that retrieve calculated values
Alternate point identification methods
Trend display tool
Tag search, Module Database, Connections,
Settings and Help
Copyright © 2007 OSIsoft, Inc.
176
PI DataLink Settings
Determines how tags
selected in the "Tag
Search" dialog window
are copied on the
spreadsheet: Columns or
Rows
Determines if the PI
Server's name is copied
automatically in PI
DataLink dialog boxes
Determines the number
format for DataLink results
Determines which time
zone PI DataLink
interprets time from (PI
server vs. client station)
Determines the time/date
format for DataLink
results
Option to display
interval end time
instead of start time
Copyright © 2007 OSIsoft, Inc.
177
Current Value
Function: PICurrVal
Retrieves the current value for a point
Copyright © 2007 OSIsoft, Inc.
178
Archive Value
Function: PIArcVal or PIExTimeVal
Retrieves a single value from the PI archive for a
specified time stamp
Retrieves a value from
the PI archive for a
specified time only if an
archived value exists
at that time
Copyright © 2007 OSIsoft, Inc.
179
Interpolated Values
3.5
3
Values
2.5
2
1.5
1
0.5
0
0
1
2
3
4
5
Time
Copyright © 2007 OSIsoft, Inc.
180
Tag Attributes
Function: PITagAtt
Retrieves an attribute associated with a point
Copyright © 2007 OSIsoft, Inc.
181
Update a Spreadsheet
Pressing F9 key recalculates Excel dynamic time functions
AND the Current Value function:
Pressing CTRL+ALT+SHIFT+F9 simultaneously does the
following:
=Now(), =Today(), =PICurrVal()
Other DataLink functions based on these functions
Everything that F9 does
Recalculate other DataLink functions based on relative PI time
(i.e. '*', '*-3h')
Build your spreadsheet using references to cells for the Tag
Name, Start Time and End Time
Recommended to use references to cells containing dynamic Excel time
functions
Copyright © 2007 OSIsoft, Inc.
182
Dynamic Time Functions in Excel
TODAY()
NOW()
Returns today’s date at 00:00:00
Example: =Today() – 1 = Yesterday at 00:00:00
Returns the current time and date
Example: =Now() - 3/24 = 3 hours ago
Note: these functions are in units of Days
Copyright © 2007 OSIsoft, Inc.
183
To Edit an Array
Three options are available:
1.
Manually:
1.
2.
3.
4.
2.
Via the dialog window:
1.
2.
3.
4.
3.
Select a cell in the array
Press F2
Do the modifications
Press CTRL+SHIFT+ENTER simultaneously
Right-click on a cell in the array
Select the name of the function in the contextual menu
Do the modifications in the dialog window
Click on OK
For functions that need to be resized:
1.
2.
Right-click on a cell in the array
Select the Recalculate (Resize) PIDL formula option
Copyright © 2007 OSIsoft, Inc.
184
Supported Time Formats
In an Excel cell:
The format of a timestamp entered depends on the local
Windows Regional Settings
Examples of valid timestamps:
2007/04/18 10:43:27
18-apr-2007 10:43:27
04/18/07 10:43:27
In a DataLink dialog window:
Entered timestamps have to be of PI Time formats
(absolute or relative)
Examples of valid timestamps:
18-apr-07 10:45:24
*-15m
t-8h
Copyright © 2007 OSIsoft, Inc.
185
Archived vs. Sampled Values
Archived: values stored in the PI archive
Sampled: values evenly spaced in time. These
values are interpolated from the archived values.
120
100
80
Archived
60
Sampled
40
20
0
0
1
2
3
4
5
Copyright © 2007 OSIsoft, Inc.
6
186
Sampled Data
Function: PISampDat
Retrieves evenly spaced interpolated values from
the archive
Remember…
Copyright © 2007 OSIsoft, Inc.
187
Compressed Data (Start Time/End Time)
Retrieves compressed data from the archive
based on a start time and an end time
Copyright © 2007 OSIsoft, Inc.
188
Calculation Boundary Types
C
D
A
F (interpolation)
G (interpolation)
B
E
Start
End
Time
Time
Inside (B,C,D)
Outside (A,B,C,D,E)
Interpolated (F,B,C,D,G)
Copyright © 2007 OSIsoft, Inc.
189
Compressed Data (Start Time/Number)
Function: PINCompDat
Retrieves a specified number of compressed values
from the archive. The user determines the initial
date-time and the number of values to be returned
Copyright © 2007 OSIsoft, Inc.
190
Annotations and Quality Bits
Some applications allow reading or writing
of additional information such as the quality
or the status of a specific value
(questionable, substituted)
These ‘bits’ can be shown in a separate
column, beside the value itself
Consult interface-specific
documentations to know if they support
this functionality
The PI Server allows addition of annotations
on archived values
This information can be shown with the
show annotations option
They will be in another column beside
the other(s)
Copyright © 2007 OSIsoft, Inc.
191
"IF" Function in Excel
Syntax:
=IF(Logical_test, value_if_true, value_if_false)
Copyright © 2007 OSIsoft, Inc.
192
Timed Data
Function: PITimeDat
Retrieves sampled data synchronized with an array of time
values
Must
reference
cells
Copyright © 2007 OSIsoft, Inc.
193
Calculated Data
Function PICalcDat or PICalcVal
Retrieves a calculated value for a given point, in a specified
time interval
Can retrieve the total, the minimum, the maximum, the
standard deviation, the range, the count, the average or
the mean
Copyright © 2007 OSIsoft, Inc.
194
What is a Conversion Factor?
Used with PI DataLink, in the Calculated Data
function
A multiplier used to change a number from on unit of
measure to another
Ex: 1000 g/kg, 2.54 cm/inch, 24 hours/day, 1440 minutes/day
When using the Total function in Calculated Data, it is
used to correct for PI’s assumption that data is in units
per day
Is equal to 1.0 when source data is in units/day
Copyright © 2007 OSIsoft, Inc.
195
Conversion Factors
It is important to supply the correct conversion factor
when calculating TOTALS with PI DataLink because
PI computes totals in units per day
Flow Tag's
Engineering Units
Conversion
Factor
Units/day
1
Units/hour
24
Units/minute
1440
Units/second
86400
Example: For a flow measured in m³/h, a conversion
factor of 24 must be supplied to convert the units to a
per day basis
m³ = m³/h * D * 24 h/d
Copyright © 2007 OSIsoft, Inc.
196
Computing totals
Flow 7
(m3/h)
5
PI considers this
flow to be m3/d
3
1
0
0
1
2
3
4
5
6
7
8
9
10
11
Time (hours)
Normal total = 3m3/h x 3h + 5m3/h x 2h + 1m3/h x 3h = 22 m3
PI total = (3 m3/d x 3/24 d + 5 m3/d x 2/24 d + 1 m3/d x 3/24 d) * 24 h/d = 22m3
The total computed by PI must be multiplied by a factor of 24
Copyright © 2007 OSIsoft, Inc.
197
Trapezoidal Rule in PI
Archived
Average
value
Archived
Integral (Area under curve)
t1
t2
Area under curve for a given time slice
= Average value * Time difference
= Average value (units/time) * (t2 – t1) (time)
= Total units for that time slice
Copyright © 2007 OSIsoft, Inc.
198
Trapezoidal Rule in PI – Example
m3/hr
50
40
30
Total flow for this time slice
5 sec
Total for the example time slice
= 40 somethings * 5 seconds
unit of time
= 40 somethings * 5 seconds * 1 day
day
86400 seconds
= 0.0023 somethings * conversion factor
= 0.0023 somethings * 24 = 0.0556 m3
Copyright © 2007 OSIsoft, Inc.
199
Filtered Sampled Data
Function: PISampFilDat
Retrieves a series of evenly spaced interpolated values
that satisfy a filter condition
Copyright © 2007 OSIsoft, Inc.
200
Filtering Syntax
Numbers – no single/double quotes
Tagnames in single quotes
'*' , '18-apr-07', 't-8h'
Strings in double quotes
‘cdt158' , ‘temp_tank_1', 'FIC5821.PV'
Timestamps in single quotes
0, 0.125, 34.56
"This is a string"
A filter expression can use relational operators
such as “<” or “>=”
'sinusoid' > 50,
'ba:active.1' = "Active"
Copyright © 2007 OSIsoft, Inc.
201
Filtering Syntax
Logical and Mathematical Operators
Filters can use the following logical operators:
And, Or, Not
Filters can use the following mathematical operators:
+, - , *, /, ^
Examples:
('Flow1'+'Flow2' > 50 AND 'Temperature23' > 90)
(('pump_speed1')/2 + ('pump_speed2'-100))
Copyright © 2007 OSIsoft, Inc.
202
Expression Calculation
Examples of built-in functions:
PctGood() % of time point has good values
Range()
Range of min to max
StDev()
Time-weighted standard deviation
TagAvg()
Time-weighted average
TagTot()
Time integral over a period
TagMean() Event-weighted average
TimeGT()
Time the point was greater than a given value
TimeLE () Time the point was lower or equal than a
given value
The file \PIPC\HELP\PEReference.chm, shows the syntax and examples
for these and all other valid Expression functions.
Copyright © 2007 OSIsoft, Inc.
203
"CONCATENATE" Function in Excel
Cannot combine text and references to cells in
DataLink dialog boxes
Use the CONCATENATE function to join several
text strings into one text string
Up to 30 text items
Items can be:
Text
Numbers
References to cell
Syntax: =CONCATENATE(text1, text2, etc…)
Example: =Concatenate("my name", " is ", B2)
(assuming that cell B2 contains a name)
Copyright © 2007 OSIsoft, Inc.
204
Filtered Compressed Data (times)
Function: PICompFilDat
Retrieves compressed data based on a start time
and an end time that satisfy a filter condition
Copyright © 2007 OSIsoft, Inc.
205
Filtered Compressed Data (number)
Function: PINCompFilDat
Retrieves compressed data that satisfy a filter condition.
The user determines the initial date-time and the number
of values to be returned.
Copyright © 2007 OSIsoft, Inc.
206
Expression Calculation
Function: PIExpDat
Retrieves data from calculations on tag expressions
(via the Sampled Data dialog box)
Copyright © 2007 OSIsoft, Inc.
207
Other Expression Calculation Methods
Expression calculations can also be performed
For one specific time in the past (Archive Value dialog box)
For a specific list of timestamps (Timed Data dialog box)
To obtain statistics or totals on an expression (Advanced Calculated
Data dialog box)
Copyright © 2007 OSIsoft, Inc.
208
If-Then-Else Operator in Performance Equation
A filter expression (a calculation or a filter) can use the
If-Then-Else operator
Syntax: IF expr0 THEN expr1 ELSE expr2
Example: IF ‘Tag1’ < 50 THEN “under limit” ELSE “good”
Notes:
You must include the IF, THEN and ELSE statements
It is possible to nest if-then-else expressions
Copyright © 2007 OSIsoft, Inc.
209
Calculated Data vs. Expression Calc
Sampled Data Dialog Box
Expression: TagMax('Srv1 CPU', '*-8h', '*')
Compute the maximum of
Compute the maximum of 'Srv1 CPU'
'Srv1 CPU'
for the most recent 8 hours,
over each 24 h period for the last
every 24 hours,
168 hours (7 days)
for the last 168 hours (7 days)
Copyright © 2007 OSIsoft, Inc.
210
Calculated Data vs. Expression Calc
PI Calculated Data
*-7d
*
time
1day
max
1day
max
1day
max
1day
max
1day
max
1day
max
1day
max
1day
1day
1day
1day
1day
1day
PI Expression
1day
time
8h
max
8h
max
8h
max
8h
max
8h
max
8h
max
8h
max
Note that if the time interval in the PI expression was changed to 1 day, ie
TagMax('Srv1 CPU', '*-1d', '*'), the results of both expressions would be identical.
Copyright © 2007 OSIsoft, Inc.
211
Time Filtered
Function: PITimeFilter
Retrieves the amount of time where an expression is true
Copyright © 2007 OSIsoft, Inc.
212
Time Functions in Performance Equation
TimeEq: Returns the number of seconds that a
point was at a specified value
Syntax: TimeEq(tag, start time, end time, value)
Example: timeeq('PING Srv1', '*-7d', '*', "I/O Timeout")
TimeNE, TimeLT, TimeLE, TimeGT and TimeGE
also available
Note that the result of these functions is in seconds
Divide the result of these functions by 86400 to convert it
in days
Copyright © 2007 OSIsoft, Inc.
213
Trend Display Tool
Create trends similar to ProcessBook trends
Based on PI Data and/or Data from the worksheet
Option to update automatically
Option to modify scales and appearance
Possibility to zoom on a part of the trend
PI Menu > Insert Trend Option
Copyright © 2007 OSIsoft, Inc.
214
Trend Display Tool
Configuration
Trend Wizard
Define data sources
Define how they are
displayed
Format Properties
Configure every single
item on trend
Colors, line styles, etc.
Copyright © 2007 OSIsoft, Inc.
215
Trend Display Tool
Right-Click Menu
The right-click menu allows the user to:
Temporary modify the scales and the time frame
Revert to original scales and time frame
Permanently modify the scales and the time frame
(the Revert option does not apply to this change)
Add a scroll bar for the time frame
Add markers
Change the trend's appearance
(colors, lines, etc.)
Add or remove traces
Delete, move, resize the trend
Copyright © 2007 OSIsoft, Inc.
216
PointID to Tag
This function allows the user to always reference a
specific point ID and not the tag name
Very useful when tag names are expected to change
Copyright © 2007 OSIsoft, Inc.
217
12.0 PI Interfaces
Copyright © 2007 OSIsoft, Inc.
PI Interfaces
Objectives:
Be able to describe how an interface works
Install a PI interface
Find information on interface startup parameters in the documentation
Define scan classes
Configure an interface startup file correctly
Start/stop an interface interactively
Install/remove/start/stop an interface as a service
Use PI ICU to configure/start/stop an interface
Find information on interface-specific attributes in the documentation
Create tags belonging to an interface
Locate and read the interface log file
Adapt the site-specific startup and shutdown files
Copyright © 2007 OSIsoft, Inc.
219
What is a PI Interface?
Software that allows communication between the
PI Server and a data source
Collects data from a data source and sends it to
the PI Server (and vice-versa)
Interfaces
Interfaces
+
Buffering
PI Server
Data Acquisition
Node
(Optional)
Data Sources
Copyright © 2007 OSIsoft, Inc.
220
Interface Files
Installed using the setup kit, in \PIPC\Interfaces\
PI SDK and PI API must be present on the machine
Both are present on the IT Monitor Server
Both are installed with the PI SDK setup kit
The following files are installed in the directory
.exe: executable file, performs data acquisition
.bat: startup file, contains a DOS command line
Contains a path to the interface executable
Contains parameters to pass to the .exe file, to determine its behavior
Parameters are delimited by slashes (/) or dashes (-)
.doc: interface documentation (point/interface configuration)
_.txt: release notes (bug fixes/new features)
Additional folders/files depending on the interfaces (consult interfacespecific documentation)
Copyright © 2007 OSIsoft, Inc.
221
Interface Operation
Can be executed in 2 modes:
Interactive: .bat file is launched:
Starts the specified .exe file
Parameters are directly passed to the .exe file
Non-Interactive: Windows Service is launched (recommended)
Starts the .exe file with no parameters
The .exe file looks for the appropriate .bat file to read its parameters
Startup steps:
Establishes connection to the host PI Server
Retrieves point list from PI Server
Validates point configuration with the data source
Starts data collection
Once started, communicate with the PI Server every 2 minutes
(configurable), for point list updates (addition, modification or deletion)
Copyright © 2007 OSIsoft, Inc.
222
Interface Configuration
Once installed, 2 ways to configure the interface:
Manually, from a command prompt
1.
2.
Install the interface as a Windows service
Modify the parameters in the .bat file (if .bat.new,
rename it to .bat)
With PI Interface Configuration Utility (PI ICU)
1.
2.
3.
4.
Import the .bat (or .bat.new) file
Configure the generic parameters
Configure the interface-specific parameters
Configure the interface as Windows service
Copyright © 2007 OSIsoft, Inc.
223
Step 1- Import the interface in ICU
Utility for interface
management including:
Managing the .bat file
Installing services
Viewing log files
Creating interface
monitoring tags
Configuring buffering
Use the Import option to load
a PI Interface for the first time
(open the .bat or .bat.new file)
Copyright © 2007 OSIsoft, Inc.
224
Generic Interface Parameters
(same for all interfaces)
ICU
.Bat File
Description
Host
/HOST
The name and location of your PI server, and its
port number (optional, but recommended).
/Host=MyServer1:5450
Point
Source
/PS
The point source of the interface
(1 alpha-numeric character)
Interface /ID
ID#
Interface instance identifier (number), when you
run more than one instance of the interface with
the same PointSource
Helps identify interfaces in the PIPC.LOG file
Scan
classes
Scan class specification: sets scan period(s)
and offset(s) for the interface.
/F=00:01:00,00:00:15
/F
Copyright © 2007 OSIsoft, Inc.
225
Scan Classes
PI Interfaces can scan tags at different time intervals.
A Scan Class is defined by an interval and an offset
There are 4 ways to define a scan class:
/f=SS
/f=SS,SS
/f=HH:MM:SS
/f=HH:MM:SS,hh:mm:ss
One could use offsets to avoid having 2 scan classes
with the same frequency scanning at the same time:
/f=00:01:00,00:00:15 /f=00:01:00,00:00:45
Copyright © 2007 OSIsoft, Inc.
226
Directed Exercise
Which of the following scan classes is different
from the others?
/f=5,10
/f=00:00:05, 00:03:05
/f=5,0
/f=00:00:05
Define scan classes for:
A scan every hour which scans at 10:25
2. A scan every minute, on the minute
3. A scan every 15 seconds. No preferences on when the
first scan is done.
1.
Copyright © 2007 OSIsoft, Inc.
227
UniInt-based Interfaces
UniInt: short for The Universal Interface
Reusable code that is integrated in many of OSIsoft’s
interfaces
Includes generic functions such as
Establishing a connection to the PI Server node
Monitoring the PI Point database for changes
Copyright © 2007 OSIsoft, Inc.
228
Step 2 – Configure Generic Parameters
General & UniInt Tabs
Copyright © 2007 OSIsoft, Inc.
229
UniInt Tab – Exception and Shutdown
Tells the interface to write "Intf
Shut"
Possible to tell the interface to
bypass exception reporting
/stopstat="Intf Shut"
/sn (see notes below)
Copyright © 2007 OSIsoft, Inc.
230
Step 3 - Interface-Specific Parameters
In addition to generic parameters, interfaces have
interface-specific parameters
The 3rd tab will adapt to the selected Type of the
interface
Need ICU control for the interface (usually packaged
with the interface)
Copyright © 2007 OSIsoft, Inc.
231
Step 4 – Interface as a Windows Service
Before clicking Create, configure:
Display name (Name displayed in the Services window)
Startup type (Recommended: automatic)
Dependencies (Recommended: "bufserv", when Buffering runs)
Log on as (Some interfaces require the service to run as a
specific account; consult interface-specific documentation)
Copyright © 2007 OSIsoft, Inc.
232
Windows Service Without ICU
(Command Prompt)
Installing the interface as a service:
.exe –install [options]
Options are:
–Auto: ensures the service automatically start when
Windows reboots
–Display "Name": sets the name displayed in the Services
window
–Depend "Process1 Process2": makes the service
dependant on other processes
–ServiceID #: gives the service an identification number
(number is appended to the name of the executable)
See example in the notes
Copyright © 2007 OSIsoft, Inc.
233
Multiple Instances of PI Interfaces
One could want to run multiple instances of the same interface
Better organization of PI Points
Multiple data sources
Load balancing
Example: on a large network with a very high number of devices
to monitor run 5 instances of the PI SNMP interface to
monitor different parts of a network
A single .exe file, launched by multiple Windows services
Services have different ServiceIDs: directed to different .bat files
Two ways to create instances:
Manually, in a command prompt
Interface Configuration Utility (ICU)
Copyright © 2007 OSIsoft, Inc.
234
Multiple Instances in ICU
Load the .bat.new file multiple times using the Import tool
To re-use a .bat file that is already configured, use the
New … from BAT file option from the Interface menu
Then give different Interface ID numbers to make them unique
Then make sure the Interface ID number is set to what you need
In both cases, you need to create the service by hitting
Create on the Service tab
Copyright © 2007 OSIsoft, Inc.
235
Multiple Instances Without ICU
Here are the steps to configure multiple instances of a same
interfaces, without ICU (example with the PI SNMP interface):
Install services from the same .exe file, with different ServiceIDs:
pisnmp.exe –install –auto –display "SNMP-1" –serviceid 1
pisnmp.exe –install –auto –display "SNMP-2" –serviceid 2
… -ServiceID 3, 4, 5 …
ServiceID is appended to the name of the .exe file:
net start pisnmp3
net stop pisnmp3
Interfaces retrieve their configuration from a .bat file having the
same name as the service:
…
Copy the IFC.bat file to IFC1.bat, IFC2.bat, IFC3.bat, etc.
During execution, the /ID parameter determines what tags belong to
what interfaces:
In the .bat files, change the /ID parameter accordingly (/ID=#)
Copyright © 2007 OSIsoft, Inc.
236
Interface Point Configuration
Copyright © 2007 OSIsoft, Inc.
237
PI Interface Configuration Utility
Interface Monitoring Tabs
I/O Rate
Performance Points
Performance
Counters
Copyright © 2007 OSIsoft, Inc.
238
Troubleshooting Interfaces
PIPC.LOG Files
Located in \PIPC\dat\ directory
From ICU: Tools > Log Files
Double-click to view
Configure the service that writes messages to the PIPC.LOG file and
controls his size
Interface Documentation
Located in \PIPC\Interfaces\\ directory
From ICU: Help > Interface Manual
Copyright © 2007 OSIsoft, Inc.
239
Basic PI Interfaces
The default PI Server installation includes 5 interfaces
Simulators
Basic versions
Random Interface
Ramp_Soak Interface
PI Ping Basic Interface (32 tags max.)
PI SNMP Basic Interface (32 tags max.)
PI Performance Monitor Basic Interface (512 tags max. and limited to
local data collection)
It is possible to disable the basic versions when the full
versions of these interfaces are installed
These will only appear in the Services applet if previously configured
as services.
Copyright © 2007 OSIsoft, Inc.
240
Interface Recommendations
Interfaces should be installed as automatic services
Interfaces automatically start when the machine reboots
The clock on the Data Acquisition nodes should be synchronized with
the clock on the PI Server
Data more than 10 minutes in the future is rejected by the Server
Because not all Servers run the same Interfaces, site-specific
command files should be edited to include installed interfaces
Located in \PI\adm
When PISrvStart.bat and PISrvStop.bat are called, site-specific files are
called to start/stop services with the rest of core services
PISrvSiteStart.bat contains "net start "
commands
PISrvSiteStop.bat contains "net stop " commands
Buffering should be enabled on Data Acquisition Nodes (buffering will
be covered later)
Copyright © 2007 OSIsoft, Inc.
241
Shutdown Events
To activate writing of a state when an Interface goes down,
use the Write status to tags on shutdown option, on the
UniInt tab of ICU
(/StopStat="State" in .bat file)
When restarted, the Server adds "Shutdown" events to all
the tags that have the Shutdown attribute set to On (1)
Copyright © 2007 OSIsoft, Inc.
242
22.2 Database Security
Copyright © 2007 OSIsoft, Inc.
Database Security
Controls access to the various tables. Allows
administrators grant specific groups to have
access to certain tables
Access to the Base Subsystem:
To create new points
To create or modify Digital State Sets
To create or modify Users and Groups
To control PI Module Database security
Copyright © 2007 OSIsoft, Inc.
244
Edit the Database Security Table
Modified with the Database Security plug-in for SMT.
Name: PI database name
Access: Security string (o:rw g:r :w:r)
Owner: PI user owner of the table
Group: PI group assigned to this table
Copyright © 2007 OSIsoft, Inc.
245
22.3 Security Recommendations
Copyright © 2007 OSIsoft, Inc.
Security Recommendations
Ref: PI Server Security Best Practices (Support Website)
Computer System Security:
Physical Security: controlled-access location
File system: remove access permission for
Everyone in the PI directories. Do not share the PI
directories and subdirectories
Auditing: log the successful and failed
operations in the Windows Event Viewer
Boot setting: do not log in automatically on
computer start-up
Screensaver: should engage after a short
interval and require a password to resume
Copyright © 2007 OSIsoft, Inc.
247
Security Recommendations
Ref: PI Server Security Best Practices (Support Website)
PI Server Security:
PI Trusts: Do not use the piadmin user in your
interfaces’ trusts.
Medium security (users and groups):
Password for all users with write privileges
Members of the piadmin group create points
Access to data but not point configuration, for points
with manually entered values
High security (users and groups):
No "world" access
Point groups
All the attributes of medium security
Copyright © 2007 OSIsoft, Inc.
248
23.0 Distributed Interfaces
Copyright © 2007 OSIsoft, Inc.
Distributed Interfaces
Objectives:
Explain what a distributed architecture consists of
Explain how the buffering service works
Configure correctly the buffering service
Explain how the PI Trusts work
Configure the PI Trusts so the interface can send values
to the IT Monitor Server
Copyright © 2007 OSIsoft, Inc.
250
Distributed Architecture
Intranet/Interne
t
PI Client Tools
- ProcessBook
- DataLink
- Etc.
Data
Sources
- Printer
- Switch
- Server
- Etc.
- PI ActiveView
- Reports
- RtWebParts
Data
Acquisition
(and
buffering)
node(s)
<-Trust ->
IT Monitor Server
(PI Server)
Authentication
Copyright © 2007 OSIsoft, Inc.
251
23.1 PI Buffering
Copyright © 2007 OSIsoft, Inc.
Buffering Service
With buffering
Buffering
Service
Snapshot
Without bufferingSubsystem
Interface
Data
Acquisition
Node
PI Server
Copyright © 2007 OSIsoft, Inc.
253
Buffering Service
OSIsoft recommends installing and using the
buffering capabilities of the PI Interfaces
Buffering is a Windows service
Two buffering options are available
The API Buffer Server (bufserv.exe)
The PI Buffer Subsystem (pibufss.exe)
Included in the PI SDK install kit (along with the PI API)
Has its own install kit
Buffering is configured through the
\pipc\dat\piclient.ini file, PI ICU or the PI SMT
Buffer Server plug-in (API Buffer Server only)
Copyright © 2007 OSIsoft, Inc.
254
API Buffer Server vs. PI Buffer Subsystem
Element
Supported Platforms
API Buffer Server
Unix, Linux,
Windows
PI Buffer Subsystem
Windows
Supported PI Servers All PI Servers
PI Server version
3.4.375 and later
Compression
Algorithm
On the PI Server
On the data
acquisition node
Maximum Buffering
Capacity
2 GB
Available disk space
Maximum Throughput 5,000 events / sec
Copyright © 2007 OSIsoft, Inc.
50,000 events / sec
255
Buffering Principles
Memory Buffer #1
Interface
15
1 10
2
3
9
16
4 11
17
5 126 181319
7 14 20
8
PI Server
14
24
23
22
21
20
19
18
17
16
15
13
12
11
10
1
2
4
3
6
5
7
9
8
149
10
11
12
13
16
17
15
1
2
4
3
8
7
5
6
24
18
19
20
21
22
23
And
In
When
normal
new
full,values
the
PI
Memory
server
are
Then
Memory
Buffer
is
operation,
communication
sent
nottoavailable,
#2
Memory
is
data
flushed
Buffer
#2
fills
to diskthrough
Memory
flows
resumes,
Buffer
#2
and
Buffer
Memory
filled#1
again #1Buffer
fills
Memory
Buffer
is sent#1to
the server
Memory Buffer #2
15
9 16
10
11
18
13 14
20
21
22 17
23 12
24 19
File Buffer
9 10 11 12 13 14
15 16 17
18 19 20
Note: The buffer service
must start
BEFORE the Interface
service!
Data is always sent to the server in chronological order
Copyright © 2007 OSIsoft, Inc.
256
Monitoring the Buffer Activity
API Buffer Server
Use the \pipc\bin\bufutil program
PI Buffer Subsystem
Use the PI Buffer Subsystem interactive mode
Copyright © 2007 OSIsoft, Inc.
257
Enabling the Buffer Service
To enable buffering on a data acquisition node,
select Buffering from the Tools menu in PI ICU
Copyright © 2007 OSIsoft, Inc.
258
Buffering – Choose Buffer Type
Copyright © 2007 OSIsoft, Inc.
259
Buffering – Settings
Change the default buffering settings
PI Buffer Subsystem
API Buffer Server
Copyright © 2007 OSIsoft, Inc.
260
Buffering – Buffered Servers
Select the buffered and replicated PI servers
PI Buffer Subsystem
API Buffer Server
Copyright © 2007 OSIsoft, Inc.
261
Buffering – Buffer service
API Buffer Server
PI Buffer Subsystem
Copyright © 2007 OSIsoft, Inc.
262
Buffering Dependency
PI ICU will recognize if an interface does not
have a dependency set on the buffering
service when it is enable
Copyright © 2007 OSIsoft, Inc.
263
PI SMT Plug-In - Buffer Server
The API Buffer Server can also be configured
in the Buffer Server PI SMT plug-in
Copyright © 2007 OSIsoft, Inc.
264
23.2 PI Trust Authentication
Copyright © 2007 OSIsoft, Inc.
PI Trust Mechanism
Associates credentials (IP Address, Machine Name,
Windows-based application, Windows domain and/or a
Username) to a PI User
Must be implemented where the system is installed in a
distributed architecture
An interface requires that the data acquisition node has
an entry in the PI Trust for access to the PI server
PI Server
Credentials
PI Trust
Table
PI
Other
User PI Databases
Data Acquisition
Node
Copyright © 2007 OSIsoft, Inc.
266
PI User Authentication
NonInteractive
login
User
Authentication
(by user and
password)
Group
authentication
PINetMG
R
PI TRUST
Authentication
Access to
PI Databases
(according
to
credentials)
Interacti
ve login
Copyright © 2007 OSIsoft, Inc.
267
Available Credentials
Credentials available for PI API Login (Interfaces,
PB/DL 2.x)
Application name (4-Characters+E)
IP Address and Subnet Mask
Machine Name
Credentials available with a PI SDK login (SMT,
PB/DL 3.x)
Application process name (Name of the EXE)
IP Address and Subnet Mask
Machine name
Local Domain or Windows 2000 Domain membership
Windows Username, as logged into the domain
Copyright © 2007 OSIsoft, Inc.
268
IP Address and Netmask
A Machine IP Address is trusted based on the
combination of IPAddr and NetMask in the trust
table
Row
Trust IPAddr
Trust Netmask
Machine IPAddr
Result of AND
Match
1
0.0.0.0
0.0.0.0
192.168.168.121
0.0.0.0
Yes
2
192.168.168.0
255.255.255.0
192.168.168.121
192.168.168.0
Yes
3
192.168.168.0
255.255.255.0
192.168.175.004
192.168.175.0
No
4
192.168.168.22
255.255.255.255
192.168.168.22
192.168.168.22
Yes
5
192.168.168.22
255.255.255.255
192.168.168.20
192.168.168.20
No
0 in the NetMask means any number
255 means that this field must be matched exactly
Copyright © 2007 OSIsoft, Inc.
269
Domain and OSUser
OSUser
PI SDK applications only.
A dollar sign ("$") represents any domain user.
OSUser
PIUser
Result
$
$
PIUser assigned is the same as OSUser (if it exists)
$
pidemo
All OSUsers are assigned the same PIUser
Domain
PI SDK applications only.
The Windows domain must be the same for the Server and
the connecting application.
Copyright © 2007 OSIsoft, Inc.
270
Trusts Plug-In for SMT
Trusts can be created and managed with the Trusts plugin for SMT
Provides a series of windows to help create a new trust
Copyright © 2007 OSIsoft, Inc.
271