Professional Documents
Culture Documents
2 OSIsoft - PI - PI ProcessBook User
2 OSIsoft - PI - PI ProcessBook User
Version 3.1
OSIsoft, Inc.
OSIsoft Australia
Perth, Australia
Auckland, New Zealand
OSIsoft Japan KK
Tokyo, Japan
Sales Outlets/Distributors
Middle East/North Africa
Republic of South Africa
Russia/Central Asia
South America/Caribbean
Southeast Asia
South Korea Taiwan
www.osisoft.com
OSIsoft, Inc. is the owner of the following trademarks and registered trademarks: PI System,
PI ProcessBook, Sequencia, Sigmafine, gRecipe, sRecipe, and RLINK. All terms mentioned
in this book that are known to be trademarks or service marks have been appropriately
capitalized. Any trademark that appears in this book that is not owned by OSIsoft, Inc. is the
property of its owner and use herein in no way indicates an endorsement, recommendation, or
warranty of such party's products or any affiliation with such party of any kind.
RESTRICTED RIGHTS LEGEND
Use, duplication, or disclosure by the Government is subject to restrictions as set forth in
subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at
DFARS 252.227-7013
Published: 9/25/2008
Table of Contents
Introduction.....................................................................................................................................1
What Can You View with PI ProcessBook? .......................................................................1
System Requirements ........................................................................................................4
Installation ..........................................................................................................................4
PI ProcessBook Essentials ...........................................................................................................7
Starting PI ProcessBook ....................................................................................................7
Workspace .........................................................................................................................7
ProcessBook (PIW) ............................................................................................................8
Display................................................................................................................................8
Run Mode and Build Mode.................................................................................................8
Servers and Connections...................................................................................................8
Time Concepts .................................................................................................................10
Menus and Toolbars.........................................................................................................16
Preference Settings..........................................................................................................18
Add-Ins .............................................................................................................................25
Keyboard Shortcuts..........................................................................................................28
Print ..................................................................................................................................29
About PI ProcessBook .....................................................................................................31
Using Online Help ............................................................................................................32
Work with a ProcessBook ...........................................................................................................33
Basic Steps to Build a ProcessBook ................................................................................33
Create a New ProcessBook .............................................................................................33
Open an Existing ProcessBook........................................................................................34
Run Mode Pointer ............................................................................................................35
Build Mode Pointer ...........................................................................................................35
Add ProcessBook Entries ................................................................................................35
Arrange ProcessBook Entries ..........................................................................................41
Properties .........................................................................................................................47
Import Files to a ProcessBook .........................................................................................50
File Sharing Capability .....................................................................................................51
Move a ProcessBook to Another PC................................................................................51
Work with a Display......................................................................................................................53
Overview of Display Elements .........................................................................................53
Manage Displays and Independent Display Files ............................................................55
Drawing Area....................................................................................................................60
Tags .................................................................................................................................60
PI ProcessBook User Guide
iii
Table of Contents
Table of Contents
vi
Chapter 1
Introduction
PI ProcessBook is a PC application for displaying plant information stored in the PI Data
Archive (page 2) or in relational databases.
The PI ProcessBook application displays one or more ProcessBooks (page 8), which are
collections of display (page 8) entries. These display entries show your process 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 can also be saved as
independent files.
ProcessBook displays may be linked to other displays within the same ProcessBook or to
displays in a separate ProcessBook or independent file. You can also include buttons that
launch other applications.
You can share ProcessBooks among users, thereby eliminating the need to build duplicate
displays, however, only one user at a time can open individual display files. On networks, an
unlimited number of users may access the same ProcessBook at the same time. Furthermore,
you can have up to six simultaneous sessions of the application active on a computer.
The PI ProcessBook application incorporates Microsoft Visual Basic for Applications (VBA),
so that you can automate special activities or routine chores.
OSIsoft produces several add-in products for PI ProcessBook, including PI BatchView and PI
Statistical Quality Control (SQC).
sources
Other databases with ODBC connectivity
Other databases with custom interfaces to PI ProcessBook
Spreadsheets, documents, schematics, graphics, photos, and other Windows applications
Introduction
ProcessBook displays may be linked to other displays within the same ProcessBook, or to
displays in a separate ProcessBook. You can also include buttons that launch other
applications.
PI Data Archive
The PI Archive is a time-series database that collects, stores, and retrieves numerical and
string data. The PI Archive resides on a host computer and is connected to your PC via the PI
Server and your network.
When you open a display (page 8) containing dynamic symbols, PI ProcessBook retrieves
data from the PI Archive.
PI ProcessBook also notifies the PI Server that it would like to receive data whenever the
readings for the dynamic symbols change. Each time a reading changes for points in the
display, the information is recorded in the PI Server. This new information is sent to your
displays and all the new values are added to trend traces. This is true even if you reduce the
display to an icon (page 58).
If you open a display but are not connected to a PI Server, PI ProcessBook automatically tries
to connect to the servers in the display. If multiple servers are accessed, the application tries
to connect to each disconnected server used in the display and the message Attempting
to Connect displays on the Status Bar. If security is enabled on the server, you may be
prompted to log in to the server.
Updates to PI Data
When a display is opened, current values of PI tags are used for dynamic elements other than
trends and XY plots. For trends and XY plots, the time scale is configurable on a plot-by-plot
basis. See Changing the Time Range (page 14) for information on viewing historical values.
Displays are updated whenever values change. Every five seconds, PI ProcessBook displays
any new values for tags in open displays from each PI Server. You can modify the update
rate. See Procbook.ini (page 196) for more details.
For trends, new values are added to the trend traces. This update by exception algorithm has
two benefits:
Values that do not change are not sent over the network at every update. This can be a
PI ProcessBook Datasets
PI ProcessBook can plot data from relational databases through Open Database Connectivity
(ODBC), which means that you can retrieve and display dynamic data from other ODBCcompliant databases based on fixed or variable criteria.
You can also view data from data sets based on PI Performance Equations or standard
functions, such as minimum or maximum value. These are called PI Calculation data sets.
If you have custom data sets, these may be available to PI ProcessBook using a VBA add-in
and will update dynamically.
PI ProcessBook OLE
PI ProcessBook provides the capability to use OLE linking and embedding (page 172). You
can embed or link OLE objects from other Windows applications into a ProcessBook display.
The data might be derived from a wide variety of OLE-compliant applications, such as
spreadsheets, documents, graphics objects, etc.
PI ProcessBook is an OLE Automation server. Programmers can write scripts that manipulate
and retrieve PI data.
Introduction
System Requirements
You can use PI ProcessBook with Windows 2000, XP, Vista, 2003 Server, 2000 Server, and
on Intel platforms. The 3.1 release of PI ProcessBook is shipped in a 32-bit version.
As more advanced PI ProcessBook features are added, your system may require more
memory.
Installation
Upgrade from Previous Version of PI ProcessBook
If you have a previous version of PI ProcessBook installed on your computer, you should
upgrade that version, rather than uninstall it. During the installation of PI ProcessBook 3.1,
your previous version of PI ProcessBookis removed; however, .ini files settings are
retained.
If you have created or edited displays and ProcessBooks with other versions of PI
ProcessBook, those files will work with PI ProcessBook 3.1.
Installation
Installation Test
You can view the results of the installation process by examining the setup log:
PIPC\DAT\SetupProcessBook.log
This log also contains information pertaining to the directory structure, node, .dlls, user
name, and installation of various PI ProcessBook files. If the log file is not found in the
\PIPC\Dat folder, look in the root directory of your system drive (e.g., C:\).
Once you install PI ProcessBook, you can see the words PI System on the Windows
Start menu under Programs. At this point, you are ready to use PI ProcessBook.
Call OSI Technical Support (page 211) if you experience problems with your software.
Installed Files
Upon completion, Setup installs PI ProcessBook under the root directory PIPC.
Setup also installs online help files and Release Notes.
See the Release Notes (readme.htm) for a complete list of files. The Release Notes are
normally installed at:
C:\Program Files\PIPC\procbook\readme.htm
Chapter 2
PI ProcessBook Essentials
Process data is stored in the PI Server Archive, part of the foundation of the PI System. The
Archive handles the collection, storage, and retrieval of numerical and string data.
PI ProcessBook provides access to these data. When you log in to PI ProcessBook, you
obtain values from the Archive via the PI Server or servers to which you are connected.
Starting PI ProcessBook
To use PI ProcessBook you need to start the application, log in to the PI Server, open a
specific ProcessBook file, and open a display.
1. Either double-click on the PI ProcessBook icon on the desktop, or select the Start button
> Programs > PI System > PI ProcessBook. If security is not configured at your site,
you automatically log into PI ProcessBook. If security is configured, the PI Server
Login dialog appears.
2. Enter your PI user name or host user name and password (if prompted).
3. If the PI Server to which you want to connect is not shown, enter the desired PI Server
name (sometimes called the node).
4. Click OK to begin the login process. This may take a few seconds while the application
connects to the specified server. The status bar displays the message, Attempting to
Connect. When the application connects to the server, the status bar displays the
message, Connection Was Successful.
Note: If you click Cancel, PI ProcessBook starts, but is not connected to the server.
Whenever you open a display containing tags from a PI Server, the application
attempts to connect again and you may see the login dialog.
Workspace
When you start PI ProcessBook, it appears as an open window or workspace on the desktop.
Depending on your settings, you may initially see an empty workspace, or an open
ProcessBook (page 8) in either Book or Outline view.
Within the PI ProcessBook workspace you can open a ProcessBook or independent display.
PI ProcessBook Essentials
ProcessBook (PIW)
In PI ProcessBook we refer to a ProcessBook as the container for the information and
analysis of the process you are monitoring. A ProcessBook may appear as either a tabbed
book - Book view (page 41), or an outline - Outline view (page 44), and is saved as a separate
file with a PIW extension.
A ProcessBook is a collection of individual displays of data and analysis. Use a ProcessBook
to organize data from the PI System and other sources so that you can analyze the processes
you monitor or the tasks you perform.
A ProcessBook and its displays are stored in a single file.
Display
The main unit for creating presentations of data in PI ProcessBook is the display. A display
may stand on its own (.pdi or.svg), or it may be part of a ProcessBook (.piw). A display
contains all the symbols used to represent an operational environment using real-time,
production data from PI as well as data from other sources. In addition to containing this
collection of data elements, the display has its own set of features and properties that affect
the collection of data elements.
Displays can show a variety of elements, such as a schematic representation of a production
line, a plot of readings taken from a production line, or a comparison of lab data and batch
specifications. Displays can also be linked to other ProcessBooks, displays in other
ProcessBooks, or other applications.
You switch between modes by clicking the Run mode pointer (an arrow) or the Build mode
pointer (a hammer), which are located on the Tools menu and the Drawing toolbar. Your
preferred mode of operation is set as a default in your Preference settings.
Connect to a Server
1. Choose File > Connections. The PI Connection Manager dialog appears. The dialog
lists the configured servers to which you can connect and the PI Version used by each
server. It also shows the server you have chosen as the default server.
2. Select the check box next to a server name. You may select more than one, or
Choose Server > Connect to <server name>.
3. Click Close.
Note: If you select more than one server, the application tries to connect to each
server using the same user ID and password. If it fails, a new PI Server Login
dialog appears. If you already are logged in to the server from a different PI
application, such as DataLink or Control Monitor, the application uses the user
ID and password with which you logged in. See the PI-SDK Controls and
Dialogs User Help for more detail.
Network Errors
Network Errors update the Status Report dialog, rather than displaying error messages on
your monitor. When a display is opened but the server is not found, only one Select New
Node dialog appears. The dialog appears once for each server that is not in the Known
Servers table.
PI ProcessBook Essentials
If a server has been disconnected and cannot be found, a Select New Node dialog appears.
You can choose a new server from the drop-down list of connected servers or you can choose
File > Connections to launch the PI Connection Manager dialog.
Time Concepts
PI Time
PI Time abbreviations and PI time expressions allow you to specify times and time ranges for
PI data using constants, variables, and short expressions.
PI Time Abbreviations
An interval is a unit of time that can be used in time entries. Intervals that support fractional
values are listed below. For intervals where the Fractions column indicates No, fractional
amounts cannot be used in time strings.
10
Name
Short name
Plural name
Member names
Fractions
second
seconds
no
yes
minute
minutes
no
yes
hour
hours
no
yes
day
days
no
no
month
mo
months
no
year
years
no
no
week
weeks
no
no
Time Concepts
Name
Short name
Plural name
Member names
Fractions
weekday
wd
weekdays
no
yearday
yd
yeardays
no
no
You can spell out month and weekday names, or enter the first three letters (for example,
Dec, Tue).
PI Times can also be expressed using certain constants:
Constant
Result
Today or t
Yesterday or y
Sunday or sun
PI Time Expressions
PI allows three types of time expressions: relative time, combined time, and absolute time.
These time expression types are defined in the following table.
Expression
Description
Examples
Relative Time
+1d
-24h
-3m
+24s
Combined
Time
*+8h
18-dec-02 3m
t+32s
Absolute Time
*
14-Dec-97
11-Nov-96
2:00:00.0001
t
y
Otherwise you may get an error message or a starting time that is not what you expect,
depending on the context of the expression.
Relative and combined time expressions contain only a single operator: either a single
plus sign (+) or a single minus sign (-). Additional operators can lead to unpredictable
results. For example, the following are not valid time expressions:
*+1d+4h
T-1d+12h
The name or short name for an interval used to denote PI time is not case-sensitive.
11
PI ProcessBook Essentials
Meaning
06-dec-91 15:00:00
25
25-aug-92
8:
25 8:
*-1h
t+8h
8:00:00 am today
y-8h
mon+14.5h
sat-1m
Meaning
1.5h
32m
Thirty-two minutes
49s
Forty-nine seconds
+5h
-5h
The Time Range toolbar is used for working with dynamic symbols. In general, the
commands on this toolbar affect only the symbols selected on the display. If no symbols are
12
Time Concepts
selected, all symbols are affected. This toolbar, which must be used in Run mode, contains
three buttons:
Revert (page 13)returns the trend or other dynamic symbol to its original setting.
Change Time Range (page 14)opens a dialog to set new, temporary start and end
times. For Bars, Values, and Multi-State symbols, there is no start time, only an end time.
To discard any of the changes you have made to the time range of a trend or the effective
time of a Bar, Value, or Multi-State symbol and return it to its original or saved setting:
In Run mode, choose View > Revert, or
Click the Revert button.
New Dialog
In order to create a new ProcessBook, an entry within the ProcessBook that is currently open,
or an independent display, choose File > New to launch the New dialog.
13
PI ProcessBook Essentials
New ProcessBook
When you create and save a new ProcessBook, the application initially gives it the title
Untitledn where n represents the number of ProcessBooks created during the current
session.
You may specify a better title, including up to 43 characters and spaces, such as
Filtration Plant Number 5. This title is displayed in the title bar of the window
listing the contents of your ProcessBook.
PI ProcessBook also creates a file name for the new ProcessBook. It suggests the first word
or first eight characters from your title and an extension of .piw. For example, PI
ProcessBook may suggest Filtrati.piw. If you plan to build a whole set of
ProcessBooks, you might choose to modify the title to something that sorts your set of
ProcessBooks within the Windows Explorer in some meaningful order, such as
05FiltrP.piw. Using Windows Explorer, you may also change the file name after the file
is closed.
New ProcessBook Entry
The name of the current ProcessBook is shown in the ProcessBook Name text box. Click
OK to launch the Define ProcessBook Entry dialog where you can add a ProcessBook
entry.
Once created, you can change either the name or the location of your entry while in Book
View (page 41) or Outline View (page 44).
New Display File (.pdi)
If you want to create a separate file for a display, rather than one within a ProcessBook,
choose this option and enter the name for the display. This name will be used at the top of the
display window. When you save the display, you can specify where it should be stored.
The Time Range command lets you enter new starting and ending times for dynamic
symbols. When you specify a time range for a single-time dynamic element, such as a MultiState symbol, bar or value, only the end time is used.
Note: The time represented on your display is the time relative to the PI Server, unless
you have selected the client time zone setting for your display. If the PI Server to
which you are connected is in a different time zone, time on your display
represents the distant time zone, not the local one.
1. In Run mode, select the dynamic symbol or symbols for which you want to change the
time range. If no symbols are selected, the time range change affects all dynamic symbols
on the display.
2. Click the Time Range button on the Time Range toolbar, or
14
Time Concepts
3. 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.
4. Click OK. The selected elements change to reflect the new time range.
1. In Run mode, select the dynamic symbol or symbols for which you want to change the
time range. If no symbols are selected, the time range change affects all dynamic symbols
in the display.
2. On the Time Range toolbar, click the forward or backward Scroll Time button, or
Click and drag the Scroll Time slider, or
Click the space on either side of the Scroll Time slider to increment or decrement by a
time span.
If the slider is dragged, a ToolTip is updated with the end time that is applied when you
release the mouse button.
3. Release the mouse button. Selected symbols are refreshed with the new time range.
Note: You can scroll the time for all items in a display or selected items. If no trend is
included in the selected items, the scroll buttons are disabled.
Use the time backward and forward buttons to scroll the time range forward or backward. To
do this:
1. Click on the desired symbols with the Run Mode pointer.
2. Click the Time Forward or Time Backward button.
15
PI ProcessBook Essentials
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 non-trend symbol scrolls by the time range specified in
the trend definition.
For example, if the trend displays data from 1:00 to 4:00 (three 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 three hours (2:00).
Future Trends
It is possible to set trends with an end date in the future by choosing an end time of the
present (*) plus an amount of time, such as 4 hours or 8 days. These trends update if they are
less than the update time limit. The default update time limit is 24 hours, but that duration
limit can be changed.
You can set the time range for a trend into the future by using * + an amount of time no more
than 7 days greater than the start time. A trend can also be scrolled into the future using the
time range buttons, but then it does not update.
Function
Default
Book
Display
View-Only Book
View-Only Display
Toolbars
Standardcontains standard Windows and ProcessBook commands, including buttons
for new, open, save, print, copy, paste, undo, tag search, trend cursor, trend display,
zoom, layers, and help
VBAprovides access to the VBA automation environment
16
windows
Context Book Menuappear in the context menu for Table of Contents windows
Full Screenallows you to view your workspace in full screen mode
Time Rangefor manipulating time in Run mode
Symbol Formattingnew in version 3.1, this toolbar contains buttons for formatting
fonts, colors, and line styles. PI ProcessBook also includes the now deprecated
Formatting toolbar to support backwards compatibility
Layoutprovides controls to affect the layout of selected symbols on a display
Customize Toolbars
Toolbars may be displayed or omitted as follows:
1. Choose View > Toolbars. The Toolbars tab of the Customize dialog opens.
2. Check the toolbars you wish to display, and click OK.
3. To move a toolbar, click on the double vertical bar at the left end and drag to the new
location. If the toolbar has no move handle, click on the title bar instead.
4. To reshape a floating toolbar (one without move handles), grab one of its edges and drag
to a new shape.
Toolbar Buttons
Many of the menu commands in PI ProcessBook can be selected by clicking a button on a
toolbar. To determine the use of a button on a toolbar, hover the mouse pointer over the
button. A small text window appears.
You can configure toolbars to display as view-only to omit unnecessary buttons. View-only
toolbars and others can be specified in procbook.ini (page 196).
17
PI ProcessBook Essentials
Preference Settings
You can reach the ProcessBook Preferences dialog by choosing Tools > Preferences.
Preference settings determine how the ProcessBook entries look, what colors are available
when you draw, and whether your ProcessBook opens in Book View or Outline View.
Note: Preference settings are stored in the file procbook.ini. Before you change the
Preference settings, consider creating a back-up copy of procbook.ini so that
you can restore PI ProcessBook to the original settings.
General Preferences
Choose Tools > Preferences > General tab to configure application-wide settings. These
settings are stored in and retrieved from the [STARTUP] section of your procbook.ini
(page 196) file.
AuthorDetermines the name used as the creator of new files and the person who lasted
edited the file. See Summary Information in Processbook (page 47) for more information.
This field is blank by default when PI ProcessBook is first installed on a computer.
Startup FileThe file name and path in this field determine which, if any, file is open when
the application is launched. The default value when PI ProcessBook is first installed is
<installation path>\procbook\pidemo.piw.
Library FileThe file name and path in this field determine which, if any, file is opened
when the original symbol library command is used. The default value when PI ProcessBook
is first installed is <installation path>\procbook\symlibry.piw.
Prefer Run ModeDetermines whether ProcessBook starts up in Run mode or Build mode
by default. By default, this option is enabled when PI ProcessBook is first installed on a
computer.
18
Preference Settings
Create Backup FilesDetermines whether backup files (with a .bak extension) are
automatically created when a PI ProcessBook file is opened. By default, this option is turned
off when PI ProcessBook is first installed on a computer.
Retain snapshot values on updating plotsDetermines whether the archive event pipe is
used for updating trends, discarding any snapshot values between stored, archive values. This
setting is stored as PB2TraceCompatibility in the [STARTUP] section of your
procbook.ini. By default, this option is turned on when PI ProcessBook is first installed
on a computer. Leaving this option selected results in a more jagged trace that gets smoothed
when the display is reopened or the trend is reverted.
Date and Time FormatSettings in this area determine how time is displayed in PI
ProcessBook. Previews of each format are shown to help you select the desired option.
The Use local Windows format option uses the current Regional Options settings in the
Windows Control Panel on the client machine to determine how dates and times are
displayed. Dates are shown using the currently configured Short Date format and Times
are shown using the current time format settings.
The Use PI Time Format option displays timestamps in the default PI format of dd-
mmm-yy HH:mm:ss.ssss, where dd is the day of the month, mmm is a the short text
abbreviation of the month name (e.g., Jan for January), yy is the two digit year, HH is the
hour in 24-hour format, mm is the minute and ss.sss is the second, including subseconds, if present.
Default Time ZoneDetermines whether timestamps reflect the time zone of the PI Server
used to retrieve data (PI Server time zone), or the time zone of the local computer (Client
machine time zone), when a new display is created. By default, the PI Server option is
selected when PI ProcessBook is first installed on a computer. This setting can also be
changed and is stored with each display.
19
PI ProcessBook Essentials
Default ViewSettings in this area determine how ProcessBook entries are displayed by
default. The default is Book view.
Font SettingsThe controls in this area determine the font settings applied to each entry
level in a ProcessBook. The font settings control the display of entry names in Table of
Contents windows.
The Entry level field allows you to select the level to configure. You can only select one
level at a time.
The Font field lists all the fonts installed on the computer running PI ProcesBook.
The Size field determines the size of the text. The first time ProcessBook is installed, the
current Windows system font determines the default font settings to use.
The Font style group determines whether text is shown in bold or italic.
PreviewThis read-only field displays font settings for each level in a ProcessBook. Each of
the 10 possible entry levels is listed and displayed with its current font name, and style
settings.
20
Preference Settings
Display Window
Choose Tools > Preferences > Display Window tab to set options that apply to display
windows. These settings are stored in and retrieved from your procbook.ini (page 196)
file.
Off
Automatic
Scroll bars appear when needed (this is the default setting for new displays).
Color PaletteThese fields present the 16 colors selected for use throughout the application
as the basic colors for the color well control.
Use the Modify button to launch the Color dialog, where you can select additional
colors.
Use the Reset button to return the Color Palette to system default values.
21
PI ProcessBook Essentials
Default Display Background ColorDetermines the default color used for new displays.
The color well control is used to select a color. This color is also set when the Background
color of the current display is changed.
Symbol Defaultscontains fields to set the default formatting values for new symbols.
These defaults are also changed when the Formatting controls are used and no symbols are
selected.
Trend Preferences
Choose Tools > Preferences > Trend tab to set default settings for trend symbol display
options.
over time. If you do not select this check box, then trends use the Database scale for each
tag.
Plot TitleSelect this check box if you want a title to display.
Vert. Scale Ins. Axis(Vertical Scale Inside Axis)Select this check box to display the
numeric scale inside the axis. If you do not select this check box the scale displays
outside the axis. Note that the value scale is drawn horizontally when the trend
orientation is vertical.
GridsSelect to display grid lines.
22
Preference Settings
Multiple ScalesAdd a value scale for each data point when selected. When the check
the trend. If you do not select the Markers check box three markers display on each line.
These markers help you match a line to a tag.
LegendSelect or clear these options to configure what information appears in the trend
legends. The information that can fit in the legend is determined by the size of the trend.
Consequently, not all of the information in the legend may be visible:
If the width of the legend is more than the width of the trend the legend does not appear.
If the height of the text in the legend is longer than the total height of the trend, items are
23
PI ProcessBook Essentials
Plot ElementsUse the drop down list to select from pens, text, grids, and backgrounds,
Multi-State on Ad HocSelect this check box to draw an ad hoc (instant) trend of a
Multi-State symbol. When this option is cleared, data from a multi-state configruation is
not included on instant trends.
Traces per Ad Hoc TrendSelect the number of traces to have per plot on an ad hoc
(instant) trend. The default is 3, the maximum is 8. Once this number is reached,
additional plots are created to show the remaining tags selected for the instant trend.
For each plot element, select a Marker Type, Line Style, Line Weight, and Color.
Note: You may select one of several line styles for each trace. You can also specify the
line thickness. Select none to omit a grid line.
SampleSee your changes previewed in the Sample area at the bottom of the dialog.
24
Add-Ins
Add-Ins
By default, PI ProcessBook installs with the following add-in components:
Details (page 135)Enables a docking window that displays data from dynamic symbols
in a tabular format.
Module Context (page 72)Gives you access to the Module Database, allowing you to
symbols.
Data Favorites (page 26)Provides a way to configure symbols in ProcessBook by
dropping a PI tag name (or other data reference) from a list onto the symbol.
Other add-ins are installed with PI ProcessBook, however, don't become available until you
add additional applications:
PI Notifications (page 26)Enables a docking window that contains the notification
viewer control.
Add-In Manager
The Add-In Manager lists the Add-Ins (page 25) available in your PI ProcessBook
installation. Use this dialog to control whether the add-ins are loaded whenever you use PI
ProcessBook.
1. Choose Tools > Add-in Manager. The Add-In Manager dialog appears.
25
PI ProcessBook Essentials
PI Notifications in ProcessBook
The PI Notifications add-in to PI ProcessBook is a docking window that contains the
notification viewer control. ProcessBook automatically loads the PI Notifications add-in at
startup. The notification viewer control itself first opens to show all the active notifications to
which the current user is subscribed. A notification rule is shown as a parent node and its
notifications are shown indented below it. The criteria for which notifications to show can be
changed and the columns can be sorted by clicking on the heading.
When you click on a notification, the time range context (start and end time) is automatically
passed to the current active display. Additionally, a button above the notification viewer
control allows you to open content in the AF database associated with the currently selected
notification rule (which is the parent of the selected notification). If no content has been
associated with the notification rule, then a new display is created and a trend of the inputs
and outputs is created.
In PI System explorer, you can select an existing ProcessBook display and attach it in an
email.
The PI Notifications Help file is included with your PI ProcessBook installation. You can
find it in the PIPC\HELP directory on your hard drive, typically located here:
C:\Program Files\PIPC\HELP\
26
Add-Ins
XYPlot symbols, the first selected tag/data reference is used for the X tag.
If the selected symbol type does not support the data type of the dropped PI Tag, a value
symbol is drawn instead.
Drag List Items onto a Trend
When search results or favorites are dropped on an existing Trend or XYPlot symbol in Build
mode, traces are added the same way they would be if they were added via script. The add-in
also supports dropping traces onto trend type symbols that are part of a composite symbol.
Drag List Items onto a Display
When search results or favorites are dropped on a blank area of a display in Build mode,
symbols of the selected type are added the same way they would be if they were added via
script. If the dropped selection contains multiple data references (for example, multiple tags)
and the Bar or Value symbol is selected, a symbol is created for each one, slightly offset
from each other, in cascading windows.
Process Drags Between PI ProcessBook and Outside Applications
The Data Favorites add-in supports tag list drags in the following formats:
One row of tags separated by either a semi-colon or tab delimiter
Multiple rows (row delimited by a new line) of at least two columns which are delimited
by either a tab or a semi-colon. Only one delimiter is used, and while there can be more
than two columns in the dragged rows, only the first two columns are used. The first
column must be the tag name, the second column may be an optional tag descriptor.
Drags can come from any application that supports the text clipboard format.
PI ProcessBook User Guide
27
PI ProcessBook Essentials
Keyboard Shortcuts
A keyboard shortcut is a combination of keystrokes to use for frequent actions. Several of
these are already assigned in PI ProcessBook. They appear to the right of the corresponding
menu command on the drop-down menus.
PI ProcessBook lets you assign new combinations of keystrokes or change existing ones.
For example you can:
Assign a keyboard shortcut for inserting symbols without needing multiple mouse clicks.
Assign more than one keyboard shortcut to a specific action.
Change an existing shortcut, such as Ctrl+S, to another sequence you prefer.
28
2. Under Select a macro, click the appropriate macro (menu item). The description for that
item and its assigned shortcuts, if any, appears.
3. Click the Create Shortcut button.
5. Click OK.
The new shortcut appears in the Assigned shortcuts box.
Note: If you want to reset all the keyboard shortcuts to their original positions when
PI ProcessBook was installed, click the Reset All button, and then the OK
button.
29
PI ProcessBook Essentials
Print the entire contents of a display or selected items from that window.
You can also set various printing options, such as the number of copies.
Each topic in the help file may be printed separately or you can print them all at once.
The Print command is accessible from the File menu, CTRL+P, or the print button. You can
print the contents of the active window or if you select items within a display before you open
the Print dialog, then you can choose to print only those items.
Note: On a non-color printer, symbols are printed in shades of gray, but trends revert to
black and white.
On some printers, when you print a trend with cursors, the value and time stamp
boxes of the cursor does not hide the information beneath them. However, other
trend cursors and the trend time scale may show through the trend cursor boxes,
making the values hard to read.
Print Preview displays your selection as it will look when it is printed. Note that the Print
Preview shows colors even though you may be using a black and white printer.
Once you select the item you want to preview, choose File > Print Preview. Zoom in or out
of the selection by clicking on the selection with the magnifier cursor or by clicking the
Zoom buttons. To print the selection, click the Print button.
Printer Setup
Select Print Setup to choose a printer, page orientation, and paper size. In addition, you can
fine-tune the quality of output or the performance of your printer. The settings you choose in
Print Setup become the defaults for all your printing.
1. Choose File > Page Setup. The Print Setup dialog appears.
30
About PI ProcessBook
3. Click the Properties button to select printer-specific options. Refer to your printer
documentation for additional information about these options.
About PI ProcessBook
You can launch the About PI ProcessBook dialog by clicking Help > About PI
ProcessBook.
The dialog provides version and build information, as well as a link to the OSIsoft tech
support site.
Click Copy Info to copy the contents of the grid control to your Windows clipboard where it
can be pasted into a spreadsheet or text editor.
Click System Info to launch the Microsoft System Information dialog.
31
PI ProcessBook Essentials
Click the Index tab to view an alphabetical list of items. Begin typing the word you want to
reach it quickly in the list.
When you select a term and click Display, you see either a topic or a list of topics.
Click the Search tab to look for particular words or topics.
Click green text that has a solid underline to jump to a related topic.
Click green text that has a dotted underline to open a small window that contains a definition
of the underlined text.
Click the Back button to return.
32
Chapter 3
33
PI ProcessBook keeps track of the four most recently opened ProcessBooks or independent
display files. Instead of using File > Open, you may select a file name from the bottom of the
File menu.
You can place this button on a toolbar and use it to open another ProcessBook of your choice.
1. Choose View > Toolbars.
2. Select the Commands tab.
3. Under Categories, select Supplemental toolbar.
4. Drag the icon shown above to one of your toolbars.
5. Choose Tools > Preferences. The ProcessBook Preferences dialog opens.
6. Click the General (page 18) tab.
7. In the Library File box enter the location of a ProcessBook and click OK. This links the
button to that ProcessBook.
Note: By default, this button links to Symlibry.piw, which opens the original Symbol
Library (page 131) book.
34
, or
, or
35
When you add entries to a ProcessBook in either Outline or Book View, the entries are
arranged hierarchically. Subentries are indented under main entries. The name you give each
new entry is the name that shows in the ProcessBook.
When you create a new entry, it is placed in the ProcessBook just before the selected entry. If
no entries are selected, the new entry appears at the end of the current tab section in Book
View or at the end of the Outline View. You can press the ESC key to clear all entries.
36
8. Click OK. The entry is added to the ProcessBook. If the entry is at Level 1 and you are in
Book view, a tab is created using the name of the entry.
9. Click the Save button on the toolbar, or
Choose File > Save. If you are creating several entries in one session you may wait to
save until the last one is created.
37
12. Clear the Options check box if you want the absolute path used first.
Note: By default, ProcessBook attempts to open a linked display from its relative
path first. If the relative path fails, then the absolute path is checked. Clearing
the Use relative path check box reverses the order in which the paths are
resolved. For new displays, this option is checked by default.
13. Click OK. A linked display entry icon is added to the outline and book view of the
ProcessBook you are developing.
14. Click the Save button. If you are creating several entries, you may wait to save until the
last one is entered.
Note: If you need to move the original entry to another directory or ProcessBook,
you must redefine the link between the ProcessBooks. If you move both the
original and the linked item and the relationship between the two file paths is
unchanged, you do not need to relink.
38
39
9. If you need to specify the location of the executable for the application, click the Browse
button to the right of the Working folder box. The Browse for Folder dialog appears.
10. Locate and select the folder that you want to specify for this operating system command,
and click OK.
Note: If you know the name of the working folder for this application, then you can
type it directly in the Working folder box.
11. In the Level list, click the level at which you want to position the entry in the
ProcessBook hierarchy of entries, or
Type a number between 1 and 10.
Note: If you are creating the first entry in the ProcessBook, the level is automatically
set to 1 and cannot be changed.
12. By default, ProcessBook attempts to launch an OS command from its relative path first.
If the relative path fails, then the absolute path is attempted. To reverse the order, clear
the Use relative path before absolute path check box. For new displays, this option is
checked by default.
13. If the file specified in the Action box is associated with one application and you want to
open it with another, select the Ignore the default shell command for recognized file
types check box. This option is normally only used with files such as displays saved as
SVG so that they can be opened in PI ProcessBook instead of the associated Viewer
application.
Note: If the file type is supported by ProcessBook (either natively or through an addin), then it is opened directly when this option is selecte for a Link or OS
command entry. For example, an .svg file is opened using the .svg File
Converter in ProcessBook, even if you have Adobe SVG Viewer installed.
Clearing this check box disables this behavior, so the default shell command
is used to open the file instead.
14. Click OK. An icon for the program you are launching is added to the outline and book
view of the ProcessBook and the application opens. Close the application.
15. Click the Save button. If you are creating several entries, you may wait to save until the
last one is entered.
Note: If you need to move the original entry to another directory or ProcessBook,
you must redefine the link between the ProcessBooks. If you move both the
original and the linked item and the relationship between the two file paths is
unchanged, you do not need to relink.
40
Book View
In Book View
Tabs indicate major divisions in the ProcessBook. Each tab section has a heading, which may
be any ProcessBook entry. The entry title is used as the tab name. A tab section may contain
several pages of entries representing different types of information.
When you create a first-level entry in Book View, the name becomes the label for the section
tab. If the entry is the first entry you have added to the ProcessBook, the entry level is
automatically set at 1. Subsequent sub-entries are listed below the main entry. When you
select another first level entry, a new page is created with a new tab.
Displays within a tab section are typically arranged in a hierarchical fashion. For example, a
display that includes a boiler, a condenser, and a pump may be at the top level of a tab
41
section. The boiler, the condenser, and the pump may be separate displays that are arranged
underneath the summary display. Each of these displays can have several displays for their
components.
Book View
Resize a ProcessBook
1. Click and drag on the frame of a ProcessBook until the window is the size you want.
As you make a window smaller, the ProcessBook is resized so you can still see all of the
tabs. If the window becomes too small to display all the members of a group of displays,
the displays are moved to new pages.
2. If the ProcessBook window becomes too small, all the tabs behind the first tab are
collapsed into one tab labeled More. Click the More tab to display a pop-up list of the
other tab sections.
42
43
Outline View
In Outline view
Choose View > Outline to display a ProcessBook as an outline. When you are in Outline
View, a set of buttons is added to the active ProcessBook window to collapse or expand the
outline. You may need to resize the window so all the buttons are visible. Use the horizontal
and vertical scroll bars to see all entries in the outline.
Hierarchies of entries may be revised by dragging entries from one location to another, or by
promoting and demoting entries.
Outline View
-orClick the transparent plus sign to collapse the list of subordinate displays.
44
Expanded View:
Note: You can change the font for each level in Outline View in the ProcessBook
Preferences (page 18) dialog.
45
Remove an Entry
1. In Build mode, select an entry title in either Book View or Outline View.
2. Press the DELETE key. The entry is removed from the ProcessBook.
Note: If you accidentally delete the wrong entry choose Edit > Undo.
46
Properties
Properties
Summary Information in ProcessBook
Choose File > Properties to display the Summary Information dialog for a file. The
Summary Information dialog you see is the same for the ProcessBook as a whole or for the
individual displays.
The following table describes the fields in the Summary Information dialog:
Field Name
Description
Author
Extracted from the Author field on the Start tab in the ProcessBook
Preferences dialog at the time the ProcessBook is first saved.
Subject
Keywords
Comments
May be used for any text entry. You can revise this field at any time.
Properties button
47
Note: If you click the Properties button while an display is open, you launch the Display
Properties dialog.
The following table describes the fields in the PI ProcessBook Properties dialog:
Field Name
Description
Title
Created
48
Created By
Extracted from the Author field on the Start tab in the ProcessBook
Preferences dialog box. Shows the original author, unless the authors
name has been modified in the Summary Information dialog.
Last Saved
Last Saved By
Name of the person who saved the ProcessBook most recently. (Extracted
from the Author field on the Start tab in the ProcessBook Preferences
dialog.) If this field is blank, the PC login name of the author is used. This is
useful for tracking who made which revisions.
Revision
Displays
System Commands
Properties
4. Click OK.
The following table describes the fields in the Display Properties dialog:
Field Name
Description
Title
Created
49
Field Name
Description
Created By
Extracted from the Author field on the Start tab in the ProcessBook
Preferences dialog box. Shows the original author, unless the authors
name has been modified in the Summary Information dialog.
Last Saved
Last Saved By
Name of the person who saved the ProcessBook most recently. (Extracted
from the Author field on the Start tab in the ProcessBook Preferences
dialog.) If this field is blank, the PC login name of the author is used. This is
useful for tracking who made which revisions.
Revision
Total Symbols
Tags
Dynamic Symbols
Static Symbols
Servers Required
50
When a trend is successfully imported, a new Text display showing the full file name is
added to the ProcessBook. Each trend is added as a subordinate display and retains its
original trend name. For graphics, the VAX display name becomes the Display name. Once
converted, graphics and trends can be edited like any other display.
-or Close the ProcessBook and reopen it so that the new version of the display is shown.
ProcessBook uses the closest color when drawing an entry. This is true for any graphics
you may have included in an entry.
If an entry calls for a font that is not available on the new PC, PI ProcessBook substitutes
a similar font.
If a ProcessBook includes links to other entries, ProcessBooks, or applications, PI
ProcessBook may not be able to locate them if the path on the new PC is not the same as
the old one.
Node names (for PI Servers) must be identical.
Different monitors have different resolutions, which may distort the appearance of an
existing ProcessBook.
PI ProcessBook records both the absolute and relative paths for Linked displays and Linked
ProcessBooks. This means you can copy ProcessBooks to new directories without breaking
links as long as either all the linked files are placed in a similar directory tree or all the drive,
directory, and file names remain the same.
51
Chapter 4
Static Symbols
Static symbols are symbols that do not automatically change as time passes, such as a process
diagram or descriptive text.
Static symbols include all items in a display that do not connect to the PI Server or other
application to retrieve data, and do not start any application. Text labels and flow lines are
examples of static symbols. Other types include rectangles, circles, arcs, and images.
Dynamic Symbols
Dynamic symbols are values, bars, trends, XYPlots, and Multi-State Symbols (such as a
pump) that change over time, that are based on the value of a tag in the PI Archive. If you
wish to see how a dynamic symbol was defined, select it and click the Item Definition button
on the Drawing toolbar.
Dynamic symbols may also report data from outside databases through queries.
If you rest your mouse on a value, bar, or Multi-State Symbol, you can see a ToolTip with the
current value, tag name, and time stamp.
Icons for questionable, substituted, and annotated PI data can also appear on your displays.
Most point types can be used with any dynamic symbol. There are some restrictions on string
and timestamp data. PI ProcessBook handles a full range of PI Server data types, as shown in
this table:
53
Point Type
How It Is Used
PB Support
Digital
As currently supported
Int16
Int32
Float16
Float32
Float64
String
Blob
Not supported
Timestamp
Buttons
Buttons are elements that create a link to other applications, such as a calculator or word
processor, or other ProcessBooks or displays. You can also use buttons to execute a script.
For example, if you find you work in a particular display and frequently need to update a
report with the information you are monitoring, you can add a button that automatically opens
a spreadsheet program. You also can use a button to connect to frequently used displays,
other ProcessBooks, or Web sites.
OLE Objects
OLE objects include information from outside applications, such as text, spreadsheets, or
graphics. This information may be configured to update dynamically. OLE objects may be
either linked (page 176) or embedded (page 175) into displays.
54
window.
Click on the display title, then on the Open button to open the display into the last
display window you used. If none are open, a display window opens.
With the Run Mode pointer, double-click the display. The display opens and appears
the mouse. This opens a new display in addition to already opened displays. If you drag
the display on top of an open display, it closes that display while opening the dragged
display.
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 display title. Press Enter. If you have more
than one display open, it replaces the open display with the new display. Pressing
CTRL+N is the same as clicking the New button.
If the display is a Display, Linked Display, or Linked ProcessBook, the display is opened and
the contents are displayed on your workspace. If the display 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 in the same
session, it may run the application repeatedly. This depends on the application
and how it has been set up.
Displays re-open in the same position, size, and shape as when they were last saved.
Open Several Displays at One Time
In addition to the procedures for opening a display, you can also open multiple displays
simultaneously. Press SHIFT while highlighting the displays you want to open in Outline
view. Click the New button at the bottom of the list of displays. Each display or linked
display is opened in your workspace.
Manage Multiple Open Displays
Just as you can work with multiple ProcessBooks, you can have multiple displays open in the
work area.
To make a display active, click in the display window or press CTRL+F6 to toggle between
open displays.
To improve viewing when there are multiple open displays, choose:
55
Window > CascadeThe titles of all open displays and ProcessBooks appear in a
2. Click a percentage, or
Type a number in the Custom text box to enlarge or reduce the drawing. The Custom
text box displays the current Scale Factor. Typing a number greater than the current
Scale Factor enlarges the drawing; typing a number less than the current Scale Factor
reduces it.
3. Select Fit all symbols to resize all the symbols in a display to fit within the window.
If you want only specific symbols to fit within the display window, select the symbols,
and then select Fit Selected Symbols. The items in the display resize and take up the
entire window. OLE objects are not included.
4. Click OK to accept your changes.
Note: There is also a zoom level combo box on the Standard toolbar
this to enter or select a scale factor, or choose Fit All.
. Use
To resize the window to fill the monitor, click the Maximize button in the upper right
hand corner of your display window. When you maximize a display, all open windows
are maximized. You can also drag the edge or corner of the window to the desired size.
To minimize the display again, click the Minimize button in the upper right hand corner
56
Note: If you have your Preference setting for Preserve Aspect Ratio check box
selected, the contents of the display resize as you resize the window. If this option
is not enabled, the size of each element in the display does not change as you
change the window size.
2. Click the Full Screen button again to restore your toolbars. A default keyboard shortcut
of F11 also toggles between Full Screen and Normal presentations.
Note: You can customize the Full Screen toolbar to contain other buttons to use with a
Full Screen display.
3. In the Name box, type one or more of the letters of the display name.
4. In the Look in drop-down list, click the location you want to search.
-orIn the drop-down list, click Browse, and then locate the appropriate folder.
5. Select the Look in subfolders check box (optional).
6. Click the Search button.
7. The search results are displayed under Results.
8. Under Filename, click the display you want to open and then click OK.
PI ProcessBook User Guide
57
Save a Display
A display may be saved within a ProcessBook or as an independent file (.pdi).
1. Choose File > Save or Save As.
2. From the Save as type drop-down box, select one of the following six formats. The
default is .pdi:
.pdiDisplay file. If you select this format your display becomes an independent
file that updates under certain circumstances and that can be browsed via Internet
Explorer.
.svgSVG file for Web use. If you select this format it becomes the default file
type when saving files later. PI ProcessBook 3.0 or higher only supports version 3.0
or higher of the SVG add-in. See the SVG add-in release notes for more information.
The last four file types are graphics formats and do not update. If you choose one of the
graphic formats, the display in focus is unchanged by the Save-As operation. The display
is left open and remains in the same mode (Run or Build).
.jpgJPG-JPEG-JFIF compliant
.bmp32-bit Bitmap
.wmfWindows Metafile
.pngCompuServe Portable Network Graphics
Display Settings
Choose Edit > Display, or
58
Double-click the Time Zone setting in the Status bar. The Display Settings dialog appears.
Background ColorThe color applied to the area of the display where there are no symbols.
This field uses a color well control to provide color choices. The color selected in this field
also becomes the default background color for new displays.
Time ZoneThis field determines whether the local computer or PI Server time zone is used
for interpreting dates and times.
ConnectorsThe Enable Connector Attachments check box allows a symbol dragged and
dropped on a Connector symbol to be attached to that Connector. Clearing the check box
disables this functionality for the Display. Note that even if this feature is disabled for the
Display, the you can still use the Connectors dialog to attach Symbols to Connectors.
OKClicking this button accepts the changes made and closes the dialog box. These settings
are saved as part of the Display object.
Run mode scrollingDetermines the scroll bar behavior of display windows in Run mode.
59
Build mode scrollingDetermines the scroll bar behavior of display windows in Build
mode.
On
Off
Automatic
Scroll bars appear when needed (this is the default setting for new displays).
Drawing Area
The drawing area of a display is actually much larger than your monitor. There are scroll bars
on the display window for moving around this area.
You should plan to set a few options before you begin drawing:
Consider turning on grid snap and setting the grid size, font style, and default colors of
lines, backgrounds, and fills before you begin. It is usually easier to work with a grid
when laying out a display. Symbols in your drawing automatically align themselves with
the grid lines or the intersections of grid lines. Grid lines not only make it easier to place
objects in the drawing, but it helps keep the objects proportional. You can start with one
grid size and then modify it as your work gets more detailed.
Select a font and font size for any values, trends, or text boxes you might add to the
drawing.
Select colors for lines, fills, and backgrounds that are easy on the eyes.
While you are drawing, you can use the zoom feature to zoom in on an area that requires
more attention. Zoom out if the drawing is larger than your monitor.
Tags
A tag, which may also be called a point, is any measurement or calculation that is received or
generated periodically. It can consist of transmitter readings, manual inputs, status, or control
limits.
There are three types of tag searches you can perform: Basic, Advanced, and Alias. Searches
can be defined and then saved for future use.
Click the Tag Search button
For more information on tags click the Help button from any Tag Search dialog in PI
ProcessBook, or
open the PISDKToolsUsr.chm Help file, typically located here:
C:\Program Files\PIPC\HELP
Either action launches the PI SDK Controls and Dialogs user help.
60
-orClick the Tag Search button in any of the following dialog boxes:
Define Value
Define Bar
Define XYPlot
Multi-State Symbol
Define Trend
For more information on tags click the Help button from any Tag Search dialog in PI
ProcessBook to launch the PI SDK Controls and Dialogs user help.
, or
Click the Pt. Attr. (Point Attributes) button if you are in the Tag Search dialog.
The Point Properties dialog appears.
The tag for which the properties are displayed is shown in the Point Name drop-down list at
the top of the dialog box. If a trend has several tags, select each tag from the drop-down list
or use the up and down arrows on your keyboard to scroll through the tags.
The Point Properties dialog contains the Categorized tab and the Alphabetic tab.
The Categorized tab displays the attributes categorically. The following categories are
always displayed:
Archive
Classic
Display
Overview
Security
System
61
These categories include all the attributes from the Base PointClass. The Base PointClass
attributes are common to all PI Points. If the PI Point that is being displayed is not from the
Base PointClass, there is one additional category. This category is given the name of the
PointClass to which the displayed PI Point belongs. The PointClass-specific attributes are
displayed in this category.
The Alphabetic tab displays the attributes alphabetically.
Drawing Tools
PI ProcessBook includes a drawing environment with features that allow you to create
symbols and graphics within an entry.
You can use the drawing tools to:
Create ellipses, polygons, rectangles, arcs, lines, and polylines
Add dynamic elements such as values, bars, trends, buttons, and graphic files
Add ActiveX controls
The Drawing toolbar contains a set of buttons used for creating drawings and the Draw
menu contains the corresponding commands.
To use the drawing tools, click the appropriate button.
When you draw a line or other shape, the tool uses the current formatting attribute (page 63)
preferences.
Each of these objects is considered a symbol by PI ProcessBook. In Build mode, when you
select a symbol by clicking it with your mouse, you see small squares around the bounding
rectangle of the symbol. These are called selection handles and allow you to resize the
symbol. For arcs, polygons, and polylines, there are also reshaping handles at the intersection
of the line segments.
Each symbol has a name, reflecting the order in which it was added to the display, such as
Rectangle1, Rectangle2, etc.
In Build mode (or VBA Design mode), an identifying ToolTip (page 68) appears whenever
your mouse hovers over a symbol.
Note: If you are drawing multiple objects, press the CTRL key while selecting the
drawing tool. This lets you continue to work with that tool until you select a
different tool.
Organizing Symbols
PI ProcessBook provides several tools to help you organize your drawings. These tools
include a drawing grid, flip and rotate capabilities, and the ability to change the order in
which objects overlap each other. You can move and resize drawing objects. You can also
divide a display into layers so that you can segregate various elements. For example, you
might separate HVAC elements from Electrical elements in a display.
62
Formatting
Any of these functions can be performed on a single screen element or group of them. For
information on grouping objects, see Grouping Symbols (page 141).
Make sure you have selected the item or items with the Build Mode pointer.
OLE objects behave somewhat differently; their behavior is discussed under Commands that
Ignore OLE Objects (page 178).
Drawing Grid
The grid is a system of vertical and horizontal lines spaced at regular intervals on the drawing
area. Dots are placed at the intersection of the grid lines. The grid helps you align drawing
objects.
When you move an object to a location on the drawing area, the corners or edges of the object
are aligned with the closest grid intersection. This is called snap-to-grid or grid snap. When
you turn off grid snap, you can move an object to any location within the drawing area.
You determine the interval at which you want the grid lines to be spaced by setting the grid
size.
5. Select the Snap to Grid check box. Once grid snap is on, any symbols you draw are
automatically aligned to the grid.
Note: The Snap to Grid command also appears on the Arrange menu.
6. Click OK.
Formatting
Each symbol you draw and place on a display has attributes that determine how the symbol
looks. The fill and line attributes that are currently selected on the Display Window (page
21) tab of the ProcessBook Preference dialog are applied to any new drawing symbol. You
may configure these attributes for individual symbols or for all selected symbols as a group.
63
New in version 3.1, the Symbol Formatting toolbar contains buttons for formatting fonts,
colors, and line styles. PI ProcessBook also includes the older Formatting toolbar to support
backwards compatibility
Line Styles
Fill
Background
Style
Weight
Ends
Line
Rectangle
Text
Ellipse
Arc
Value
Polygon
X
X
X
X
Polyline
Bar
Trend
Font
To determine what type of formatting is applicable for each symbol, refer to the table of
editable formatting attributes.
1. In Build mode, open a display, and click the symbol(s) whose font you want to change.
2. On the Symbol Formatting toolbar, click a name in the Font box.
Note: When choosing fonts, plan to use fonts that other PI ProcessBook users are
likely to have. If another user does not have the fonts you used, PI
ProcessBook attempts to match the font to an existing font. However, the
match may make it difficult for another user to read the entry.
Formatting
Line Color
To determine what type of formatting is applicable for each symbol, refer to the table of
editable formatting attributes.
1. In Build mode, open a display, and click the symbol(s) whose line color you want to
change.
2. On the Symbol Formatting toolbar, click the Line Color button
Depending on the symbol type, the following elements change to the color displayed on
the button.
Symbols that display text use the line color to determine the color of the text within
the symbol
Symbols that have lines (such as ellipses) use the line color to change lines in the
symbol
3. Click the arrow on the right side of the Line Color button to display the color palette.
Choose from the 16 colors available or click on one of these two buttons:
Custom ColorLaunches the Color dialog where you can choose additional colors
from a color well of options
NoneDisables line color. Setting the line color to None for Pen elements on a trend
hides the trace and its associated markers
Fill Color
To determine what type of formatting is applicable for each symbol, refer to the table of
editable formatting attributes.
1. In Build mode, open a display, and click the symbol(s) whose fill color you want to
change.
2. On the Symbol Formatting toolbar, click the Fill Color button
of the selected symbol(s) changes.
Note: The Fill Color button is disabled if the selected symbol has no interior.
3. Click the arrow on the right side of the Fill Color button to display the color palette.
Choose from the 16 colors available or click on one of these two buttons:
Custom ColorLaunches the Color dialog where you can choose additional colors
from a color well of options
NoneDisables fill color. Setting the fill color to None shows the display
background color.
65
Background Color
To determine what type of formatting is applicable for each symbol, refer to the table of
editable formatting attributes.
1. In Build mode, open a display, and click the symbol(s) whose background color you
want to change.
2. On the Symbol Formatting toolbar, click the Background Color button
background of the selected symbol changes.
. The
Note: The Background Color button is disabled if the selected symbol has no
background.
3. Click the arrow on the right side of the Background Color button to display the color
palette. Choose from the 16 colors available or click on one of these two buttons:
Custom ColorLaunches the Color dialog where you can choose additional colors
from a color well of options
NoneDisables background color. Setting the background color to None shows the
display background color.
Line Weight
To determine what type of formatting is applicable for each symbol, refer to the table of
editable formatting attributes.
1. In Build mode, open a display, and click the symbol(s) whose line weight you want to
change.
2. On the Symbol Formatting toolbar, click the Line Weight button
weight options appears below the button.
3. Select a line weight. The thickness of the selected symbol's line weight changes.
Line Style
To determine what type of formatting is applicable for each symbol, refer to the table of
editable formatting attributes.
1. In Build mode, open a display, and click the symbol(s) whose line style you want to
change.
. A list of six line
2. On the Symbol Formatting toolbar, click the Line Style button
style options appears below the button. Options include solid, dash, dot, dash-dot, dashdot-dot, and none. Selecting None for a trend Pen element hides the trace line, but not the
marker.
3. Select a line option. The symbol's line pattern changes.
66
Formatting
Line Ends
To determine what type of formatting is applicable for each symbol, refer to the table of
editable formatting attributes.
1. In Build mode, open a display, and click the symbol(s) whose line ends you want to
change.
2. On the Symbol Formatting toolbar, click the Line Ends button
. A list of four line
ends options appears below the button. These options determine whether arrows appear at
the end of lines.
3. Select a line ends option. The selected symbol's line pattern changes.
Formatting Paintbrush
To determine what type of formatting is applicable for each symbol, refer to the table of
editable formatting attributes.
1. In Build mode, open a display, and click the symbol(s) whose font, color, or line
formatting you want to replicate.
2. On the Symbol Formatting toolbar, click the Formatting Paintbrush button
Note: Double clicking the Formatting Paintbrush button allows you to apply
formatting to more than one symbol. To turn off the Formatting Paintbrush
selection, click the button again or press ESC.
3. Click another symbol. The formatting of the first symbol is copied to the selected
symbol(s).
67
ToolTip Statistics
In Run mode, hover your mouse over a point on a dynamic symbol to display a ToolTip with
summary statistics. Engineering units are shown next to the value followed by the timestamp
paired with the value. If you hover your mouse over a point where there is more than one
trace, each trace's data is shown on a separate line.
Choose Tools > ToolTip Statistics to launch the ToolTip Statistics dialog, where you can
select what type of data you want to see when viewing ToolTips.
mode.
You can move symbols between layers or remove them from a layer.
Add, make visible, restack, and lock layers while ProcessBook is in either Run mode or
68
Create Layers
1. Open a display.
2. Click the Layers toolbar button
, or
3. Click the New Layer button to open the New Layer dialog.
A default name comprised of the word Layer prefixed to the layer number appears. The
layer number does not necessarily match the index number; it is simply the next unused
integer in the list.
A new layer is added to the end of the collection. Its index is one higher than the previous
high index number. All symbols added to this layer are displayed over symbols on lower
indexed layers.
4. Click OK to return to the Layers dialog.
69
Indexspecifies the index number of the layer. The index is used in determining the
display order (Z Order) of overlapping symbols. A layer with a lower index number
is lower in the stack than one with a higher number. Higher layers may obscure
symbols in lower levels.
Countthis is a read-only value that contains the number of symbols on a layer. A
composite symbol is counted once and each of its subordinate individual symbols is
also counted.
Up/down arrowsbuttons at the right side of the dialog box are used to move the
relative position of one layer to another within a display. As a layer is moved down
the list, its index number becomes larger, and vice versa. Symbols on layers with
higher index numbers may hide or cover symbols with lower-index numbers. Locked
layers cannot be reordered.
Visiblemakes the elements in the layer visible in Run mode. New layers are
visible by default.
Activeaccepts all new symbols as you add them to the display. Inactive prevents
symbols from being added automatically. New layers are Active by default.
Lockedprevents you from adding symbols to a layer. Existing symbols on locked
layers cannot be cut, copied, pasted, deleted, or moved. New layers are not locked by
default.
6. Repeat steps 3-5 as needed. Click OK to accept changes and close the Layers dialog.
70
2. Select or clear the checkbox next to a layer name to add or remove the selected symbol
from a layer. If a layer name is grayed out, the layer is locked and you cannot add or
remove symbols. You may add the same symbol to more than one layer.
3. Click OK.
on the Layout toolbar. The symbols may be on different layers when they
the symbol is inside a composite symbol it is not deleted. It stays in the composite
symbol.
If a composite symbol is hidden, all its parts are hidden. If the composite symbol is
visible its individual parts may still be hidden if the layers they are assigned to are
hidden.
Since you can not individually select the parts of a composite symbol you must first use
71
Module-relative Displays
Module Context Add-in
The Module Context Display PI ProcessBook add-in is designed to give you a way to create
dynamic symbols in a display for a general structure, and then to apply data to the display
symbols using different instances of the structure. For example, you can use the same
dynamic symbol, such as a trend, and scroll through the Available Modules window to
display that trend with different data points representing the selected item in the Available
Modules window.
The add-in gives PI ProcessBook access to the PI SDK Module Database, taking advantage
of its contents as well as its structure.
The Module Context Add-in:
Allows you to use aliases as a data source for dynamic symbols so that a tag can be
changed without redefining a symbol that uses it indirectly through its alias.
Allows you to use properties in dynamic symbols to show user-defined supplementary
information.
Allows you at run-time to switch among different PI SDK Module Database Nodes using
make available at run time. Contexts are saved with the display or independent display,
not with a ProcessBook or the application.
A Configuration Dialog (Select Items dialog) for assigning these Aliases and Properties
72
Module-relative Displays
All known PI 3 Servers are available; modules can be selected from multiple Module
databases.
The Selected Modules listshows all the selected contexts. During run-time you can
73
At least one module must be selected using the Select Available Modules dialog before a
dynamic symbol can be configured to use a module alias or property. More modules may be
added later.
Unresolved contexts display as NO DATA. An unresolved context occurs when a dynamic
symbol is configured to show a property and the active context doesn't have the property. For
example, suppose you select Module1 and Module2 as the available contexts. Module1
contains PropertyA and Module2 contains PropertyB. A dynamic symbol is
configured to display PropertyB. If Module1 is the current context, NO DATA appears in
the dynamic symbol.
74
Module-relative Displays
2. Highlight each desired alias and property in the Items from Current Module tree and
click the arrow button or drag the item to the Selected Items list. You can repeat the
process for other modules if there are different aliases or properties to be included. A NO
DATA message appears if assigned aliases or properties are not present in a particular
module.
Note: Click the Add Modules button to open the Select Available Modules (page
73) dialog.
3. To display the current module context in the dynamic symbol, click the Current Context
check box above the Selected Items list.
4. Click OK.
75
saved tag name. If a match is found, the value is shown in the entry.
If a match is not found, PI ProcessBook uses the tag ID saved with the ProcessBook
76
Chapter 5
Trends
A trend is a type of dynamic element that lets you plot values against time. Use trends to
show the value of one or more tags over a time period. You may also use trends to show the
results of a data set query or to combine data from the PI Server and other sources. Generally,
trends are used to graphically display time series data, although you may also include nontime series data.
Some components of trends include:
TracesLines drawn on a trend to represent a series of data points, either from a PI Tag
supplied by default.
Grid linesUsed to mark intervals along the time and value scales.
If the Plot Time continues through the current time, the trend updates as information changes,
unless the length of the overall time period exceeds the limit set by your System
Administrator. The default limit is 24 hours.
Create a Trend
1. Open a display.
2. On the Drawing toolbar, click the Trend button.
, or
77
Trends
4. In the Plot box, type a name. Click the New Plot button if you want to build a trend with
multiple plots (page 80).
5. In the Tags in Plot box, type the name of the tag, or
Click the Tag Search button to locate the tag, or
Click the Tag Search arrow to see more search options.
6. If you manually enter tag names, select the appropriate PI server from the Server dropdown list. Normally, the default PI Server is listed.
7. You can rearrange, add to, or delete the selected tags by clicking one of the buttons above
the Tags in Plot box.
8. Under Scale, select Single Scale or, if you have more than one trace, you may select
Multiple Scales. The multiple scales option shows a value range for each trace. There is
only one time scale.
9. Consider checking the following check boxes:
Logarithmicto display the data in a logarithmic scale. If you have multiple scales,
you may set this option differently for each trace. This option is disabled for digital
tags.
Note: You may use logarithmic and non-logarithmic scales for traces in the same
trend when you select the Multiple Scales option. In this case, the minor grid
lines associated with a logarithmic plot may confuse the plot. You can turn off
the minor grid lines by setting the vertical minor grid color or line style to none.
10. In the Max and Min drop-down lists, select Autorange or Database or enter the values
to determine the value scale.
78
Create a Trend
Min Settings:
AutorangeThe trend displays with the value scale starting at the closest available
major axis. If the minimum is Autorange and the maximum is not, the scale starts at
the lowest data value in the trace (not on a major axis) and ends on the closest major
axis.
DatabaseThe tag's Zero attribute is used to specify the minimum plot value. If the
Zero value is <= 0, the minimum is re-interpreted as Autorange.
0 (absolute value)The value you type is used as the first value on the value scale.
Max Settings:
AutorangeThe trend displays with the value scale ending at the closest available
major axis. If the maximum is Autorange and the minimum is not, the plot starts on
the minimum value and ends on the largest trace value (neither min nor max will be
on a major axis).
DatabaseThe tag's Zero + Span attributes are used to specify the maximum plot
value.
0 (absolute value)The value you type is used as the value scale maximum.
11. From the Format drop-down list, select the number format for the scale. Database is the
default format. This number format is also applied to legend, cursor, and ToolTip
numbers.
12. Under Plot Time, from the Start and End drop-down lists, select a time. An asterisk (*)
represents the current time.
13. In the Style drop-down list, select Full time stamp, Partial time stamp, or Relative
time stamp to indicate how time is displayed on the time axis.
14. Click OK.
79
Trends
Note: PI ProcessBook allows you to create custom placeholders for a symbol based on
a summary Data Set. Placeholders are not allowed for expression Data Sets. The
Custom Placeholders button in symbol definition dialog boxes allows you to
specify different PI Tags for a PI Summary Data Set. The change applies only to
the configured symbol. See Add or Edit Placeholders (page 163) for details.
Move a Plot
If you have created more than one plot in the trend, you can move each plot separately.
In Build mode simply click the plot you want to move. Selection handles appear around the
plot. Use these handles to drag the plot to its new location.
80
As you create a new trend, you can specify the desired tags, the colors and fonts for traces,
legends, and backgrounds, as well as how much tag information is displayed with the trend.
Use the Symbol Formatting (page 63) toolbar to make trend formatting changes.
The Define Trend dialog has a General tab where you create a trend (page 77), and the
following additional tabs for formatting and layout:
Display Format (page 81)options for the elements to be included in the trend.
Trace Format (page 82)provides an alternate way to choose colors and line styles for
each trace (plot line) as well as the axes, background, and text.
Layout (page 83)options determine the arrangement of rows and columns for multiple
plot trends. This tab only appears when you first create a trend symbol.
, or
81
Trends
3. In the Legend group box, check or uncheck options for displaying the tag name, server
name, description, value, and engineering units. Your choices are reflected in the sample
trend at the bottom of the dialog.
The information that can fit in the legend is determined by the size of the trend.
Consequently, not all of the information in the legend may be visible.
If the width of the legend is more than 50 percent of the width of the trend, the legend
does not display.
If the length of the text in the legend is longer than the total height of the trend, the
items on the bottom are not shown.
4. In the Display box, check or uncheck the following options. The sample trend reflects the
changes you make.
Plot Title
Vertical Scale Inside AxisDraws the value scale inside the plot area
GridsShows grid lines on the trend
MarkersWhen checked, markers indicate data points on the trend. If the Markers
box is not selected, three markers appear on each line to help you match a line to a
tag.
5. Choose a trend orientation from the three radio button options at the top of the dialog:
Now at right (horizontal), Now at top (vertical), or Now at bottom (vertical). New in PI
ProcessBook 3.1, this feature allows you to orient your trend in a horizontal or vertical
direction.
82
Layout Tab
The plot arrangement in a multi-plot trend is established by setting up the number of rows
and columns of plots in the Layout tab.
To revise the proposed plot arrangement matrix:
1. Follow the steps to build a trend with multiple plots (page 80).
2. In the Define Trend dialog, click the Layout tab.
3. Under Plot Arrangement, select the number of rows and columns you want. The
following example shows four plots, to be arranged in 2 rows of 2 columns each. Tab
past the matrix to see the sample of your new selection display in the Preview area.
83
Trends
4. When you are satisfied with the matrix arrangement, click OK to draw the plots.
Note: The Layout tab only appears when you initially create a trend (page 77). Once the
layout is set, you cannot revise it because the plots are no longer associated when
the symbol is created. However, individual plots can be moved on the display in
Build mode.
84
Autorange: selects a vertical scale depending on the minimum and maximum tag
values between the trend start time and end time.
Database: selects a vertical scale depending on the Zero (for minimum) and Span
(for maximum) tag attributes as configured in the Point Database for the selected tag.
See the PI Server Reference Guide for more information on tag attributes.
Absolute: allows you to enter custom values for the vertical scale of a selected tag.
Enter a custom value in the adjacent box.
5. If you have selected the Absolute option, then type in the Maximum and Minimum
values of the scale in the adjacent boxes.
6. Click OK.
Modifications made to a trend through use of this dialog do not affect the stored settings of
the trend.
Note: To return the trend scale to its original settings, choose View > Revert.
85
Trends
display window.
Trend Cursorshows the value of the plotted tags at a specific point in time.
Drag Zoom
Drag Zoom lets you expand or contract the time scale of a trend.
1. With the Run Mode pointer, click an area in the trend at which you want a closer look.
2. Drag the pointer diagonally to create a rectangle.
3. When you release the mouse, the trend displays the data within the rectangle.
Click the Zoom In or Out button at the bottom of a trend to reduce or expand the time range
of that trend 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 displays the trend for a 16 hour time period.
You can remove changes to the time range by clicking the Revert button
Note: If the trend is too small these buttons may not appear. Simply expand the trend's
size to display hidden buttons.
If there are no trend cursors, the Trend Zoom 2x command zooms in or out of the last
portion of the time period. For example, if the initial time range is 60 minutes and you select
Trend Zoom 2x In, the trend displays the last 30 minutes. Trend Zoom 2x Out displays 120
minutes adding 60 minutes to the beginning of the trend.
When a trend cursor is displayed, the command uses the trend cursor as the center of the
zoomed trend. If several cursors are used, the last one set is used as the center of the zoomed
trend. See Trend Cursor (page 87), for more information on trend cursors.
Expand a Trend
When you double-click a trend in Run Mode, the trend is redrawn so that it occupies the
entire display window. Double-click again to reduce the trend to its original size.
While the trend is expanded, the Drawing toolbar is disabled. If you switch to another
display, the Drawing toolbar will work there.
All descriptive information (title, tag descriptor, tag value) is shown on an expanded trend.
86
Trend Cursor
A trend cursor lets you read tag values for a particular time. When you select a trend cursor, a
vertical line indicates the cursor position. The box at the top of the line indicates the value
and status. The box at the bottom displays the time and date of the value.
You may display several trend cursors at one time.
Note: A trend does not update while trend cursors are visible.
If the trend is too small, the Trend Cursor command is disabled and the mouse pointer does
not change when you move over the left axis. You can expand the trend by double-clicking it.
Trend cursors may be automated.
87
Trends
, located next to the time scale, to return the trend to its configured
Note: If the trend is too small these buttons may not appear. Expand the trend's size to
display hidden buttons.
You can also use buttons on the Time Range (page 12) toolbar to modify time configurations
settings.
PI ProcessBook uses an algorithm to identify the peaks so that no information is lost when
the trend time range is large. It ensures that the plot is not under- or over-sampled and that the
correct amount of information is sent from the PI Archive.
Unlike data from a PI Archive, data from an ODBC data set refreshes according to a
stipulated refresh rate.
Trend Appearance
A trend appears according to the format established in the Preference settings (page 22). You
may override this format by selecting the Trend Formatting (page 81) button
Typically, the title of the trend appears at the upper left, and the current timestamp appears at
the upper right. The selected tag names, current or end value, and engineering units appear in
the legend opposite the value scale.
88
Trend Appearance
Grid Lines
Horizontal and vertical grid lines align with even units (whole numbers) on the scales. Grid
lines for the value scale line up with whole numbers at intervals of 1, 2, 5, 10, or powers of
10 times those intervals. Grid lines for the time scale line up with time intervals such as
weeks, days, hours, minutes, etc. The lines then scroll as time passes on an updating trend.
The union of the ranges for all the pens appears in the label.
Multiple Scales
The range for each pen in the trend appears in the label.
Configure the labels for the time axis using a full timestamp, partial timestamp, or a relative
timestamp:
Full timestamp
Displays a complete timestamp for the start and end times. The time range of
the trend is in the middle of the time axis.
Partial
timestamp
Labels most grid lines in the units of the time range. Displays the full
timestamp for the end time of the trend at the top right edge of the plot.
Relative
timestamp
Displays the offset from the end time limit in weeks, days, hours, etc. and the
full timestamp for the end time of the trend at the top right edge of the plot.
Note: Labels for the grid lines appear unless the trend rectangle is too small.
89
Trends
Autorange Scale
The value scale is determined by a calculation based on minimum and maximum values in
the trend. As new data are received from the server, the high and low values may change, and
the scale is recalculated accordingly.
For example, if the original scale ranged from 5 to 100, but the new data has a high of 103,
then the new plot shows a range from 5 to 105 (the nearest number divisible by 5 and larger
than the high value).
If more than one tag is plotted on a single scale, the value scale is calculated from the highest
and lowest values for all the tags.
Database Scale
If the scale is set to Database, the range is the same as the limits for the point on the server.
The minimum value is termed zero, and the maximum value is the sum of the zero value plus
the span value.
For example, suppose the tag attributes for a point are Zero = 3 and Span = 6. The plot range
therefore is based on making the minimum and maximum values 3 to 9.
Logarithmic Scale
If you prefer a logarithmic scale, check this option. This option is disabled for digital, string,
timestamp, or integer tags.
for the other pens appear in increasing distance from the axis in the order the tags are
listed in the trend legend.
Note: On a single scale trend, traces that contain only one value (a flat line) or have no
data are governed by special scaling rules. When a trend is composed of only flat
or no data traces, the default value scale range is inflated to prevent showing a flat
plot area. These default ranges are not applied if the trace in question is on a
single scale trend that contains other visible traces that do not fall into either of the
aforementioned categories.
90
Trend Appearance
A single scale trace containing one flat trace with a constant value of 0.
A single scale trend containing a flat trace and a non-flat trace. The default range for the flat trace is not
applied.
PI ProcessBook User Guide
91
Trends
space permits, the elapsed time between these lines is also shown.
Partial Timestamplabels each grid line in whole units, such as hours. For example,
the grid lines might be labeled 9:00, 10:00, and 11:00. A full timestamp showing the plot
end time is shown at the upper right.
Relative Timestamplabels each grid line with the amount of time preceding the right
time limit in days, hours, minutes, or seconds. For example, the grid lines might be
labeled -4, -3, - 2, -1, meaning 4, 3, 2, and 1 hours previously. A Full Timestamp for the
last reading is shown at the upper right. A full timestamp showing the plot end time is
shown at the upper right.
Traces
A Trace, also referred to as a pen, is a single line on a trend. When a trace is continuous, a
line is drawn from measurement to measurement. When a trace is discrete, the value is
propagated forward until a new value is recorded in the database. This results in horizontal
and vertical lines for the tag (staircase trace).
Digital points are discrete type measurements, producing staircase traces. For digital points,
the offset from the starting digital state code is plotted. When the value is shown in a trend
cursor, ToolTip, or legend, the text translation is displayed (for example, ON or OFF).
Staircase traces are used for points from a PI Server that have a Step Flag set to TRUE.
ODBC queries may produce either curved or staircase traces, depending on the Stepped Plot
check box setting in the ODBC Data dialog.
Hide Traces
You can hide one or more traces on the trend in Run mode so that an area of concern is more
easily viewed.
1. Open a trend in Run mode.
2. Hover your mouse pointer over the trend's legend. The mouse pointer changes to a hand
cursor
3. Click on the legend item to hide or show the trace on the plot. If the trace has a regression
line configured, the regression line is also hidden. When a trace is hidden:
92
the trace name is dimmed in the legend and the description, value, and engineering
units are hidden (if they were shown before).
Trend Appearance
the space reserved on the legend for the description, value, and engineering units
collapses so that the trace under the hidden trace is moved. This clearly shows the
visible traces on the legend, especially on a trend with many traces.
on a multi-scale trend, the scale associated with the hidden trace is hidden.
on a single scale trend, the minimum and maximum values shown on the scale may
be adjusted.
You can show hidden traces by clicking their names a second time in the legend, or by
clicking the Revert button. All hidden traces are shown in Build mode.
Note: You can also right click on a trend and select Show All or Hide All to make traces
visible or invisible.
Markers
Markers indicate data points and allow you to differentiate between traces on a trend. There
are three types of markers:
actual data
trace markers
bad data markers
At least three markers are shown on a trace, unless the plot is too small.
Actual Data Markers
Actual data markers plot each value stored in the database. The color of the trace and of the
marker is the same. You can select the shape of the marker, such as diamonds, circles,
squares, or triangles, which can be helpful for color- blind users and for monochrome
monitors.
Trace Markers
If there are too many values to plot based on the size of the trend, the display resolution and
the density of the plotted data, actual data markers do not appear and trace markers are used
instead. Trace markers are also used if the trend configuration does not specify Markers.
Trace markers help you identify the legend information for each trace; they do not indicate
actual plot values. Up to three trace markers are used per trace.
X Markers
When a value is outside the limits defined for the trend, it is plotted as over- or under-range.
When a value is out of range or has a bad value, it is not shown on the plot. An X marker is
placed on the trend at the beginning and end of the time when data are not plotted. When the
data are missing, (for example, not connected to a server) they are given the value No Data
and are not plotted.
93
Trends
Ad Hoc Trends
Create a trend on an ad hoc basis for tags represented by dynamic symbols in a display within
a ProcessBook.
Ad hoc trends are like any other trends in that you can scroll the time forward and backward,
view cursors, zoom, view point attributes, use multiple scales, or change the time range.
To create an ad hoc trend, use either the Trend tool
or Trend Display tool
. The
Trend tool allows you to add a trend to an existing display. The Trend Display tool creates a
separate, new display with the instant trend.
Note: You can build a trend display before you open any displays.
If you create an ad hoc Trend Display and then choose to save it for future use, it appears on
the Book or Outline View as subordinate to the original display.
A new display window opens, and the trend is created automatically for the selected
symbols using the default format and time range. It is given the unique name Trend
Display#, where # is a number. The plot title is Ad Hoc Trend.
- or . The mouse pointer changes to a trend pointer. Click in the
Click the Trend button
display and drag to create a rectangle. It is given the name Ad Hoc Trend.
The trend appears in the rectangle, using the default format.
Note: If you select more tags than the default set in your Preference settings, usually 3,
then you will have more than one plot in your trend or trend display.
94
If you had a display entry from a ProcessBook open when the instant trend was created,
the instant trend can be saved as a subordinate of the display by using the Save
command.
You may save an ad hoc trend as another file type, such as a bitmap (.bmp) file, using
Save As.
Note: You cannot save an ad hoc trend from view-only mode.
Before you can convert your trend files (PIDisDIFF), you must convert them as ASCII text
files on the VAX and then download them to your PC.
Once the files are on the PC, you can import them to a ProcessBook. Trends are formatted
based on the settings on the Trend Elements tab in the ProcessBook Preference dialog.
Convert Trends
This process is used to convert VAX graphics for use with a PC.
1. On the VAX or Alpha at the DCL prompt, type $
Run PISysExe:PIDisDIFF
2. Select option 1 List Master Display Library from the PI Display Data Interchange File
Format Builder.
3. Direct the output to a file.
4. Enter a file name. If your file name is more than 8 characters and a 3-character extension
(xxxxxxxx.xxx), the name is truncated during the download process.
5. Accept the defaults for display mask, group numbers and unit numbers (*).
6. Select the trend display types you are importing. For optimum performance select only
options 1 (horizontal), 2 (vertical), 3 (composite), and 8 (overview).
7. Quit the PIDisDIFF application (option Q).
8. Transfer the file from the VAX or Alpha to the PC using any ASCII text file transfer
program you have available.
95
Trends
Convert Graphics
This process is used to convert VAX graphics for use with a PC.
On the OpenVMS computer, copy a graphic file to your working directory. Graphic files are
named PISysDat:PIGP_xxxxxxxxxx.dat, where xxxxxxxxxx is the display
name.
1. At the DCL prompt, type $
RUN PISysExe:GPAB
2. Select option 1 Convert Binary to ASCII from the PI Graphics Package ASCII/Binary
File Conversion menu.
3. Type the display name of the graphic you want to convert and press Enter. Repeat for
each file you want to convert.
4. Select option Q to quit the application.
5. Transfer the file from the VAX or Alpha to the PC using any ASCII text file transfer
program you have available.
Your PI ProcessBook Install disks include an OpenVMS command file which performs Steps
1 - 5 for all graphics. The file is named GPPBConv.com.
96
Chapter 6
XYPlots
An XYPlot shows a correlation between one or more paired sets of data. On an XYPlot (also
called a scatter plot), the X scale shows possible values for one of the items in the pair and
the Y scale shows the value of the other item in the pair. A basic scatter plot looks like the
following:
Uncorrelated data
This case plotted 10-minute intervals of two points, A and B, for the last hour. Point A had 12
point values; Point B had 16 point values. The number of points plotted equals the number of
pairs. Since A had fewer point values, the plot shows only 12 point pairs. The extra data from
point B is ignored. You can configure the method by which pairing occurs.
Correlation is a measure of the strength of the relationship between two variables. Correlation
is indicated graphically by the spread of the data points around a fitted straight line (for
example, a straight line that indicates the trend of the data). In general, the closer the points
are to the fitted line, the stronger the correlation. The two PI tags shown in figure 1 are not
strongly correlated. Another plot shows perfectly correlated data:
97
XYPlots
Perfectly correlated
Somewhat correlated
In the case of the third plot, a regression line with a slope (M) of 1 and an offset (B) of 0
drawn diagonally across the plot would show all points lying close to the line, some above it,
some below it. This line formula is appropriate in this case because both scales are the same
and the points appear to have values very close to each other. In other cases, one value may
be two or three times the other value (for example) and the regression line would fall on a
different slope, depending upon how the scales are configured. If the scales are the same, the
slope of the line determines the relationship between the points. If the scales are not the same,
the slope is insignificant.
98
Draw an XYPlot
Draw an XYPlot
1. In Build mode, choose Draw > XYPlot,
-orOn the Drawing toolbar, click the XYPlot button
99
XYPlots
General Tab
Enter tag names by typing in the list or by using the Tag Search button or the Data set
arrow.
Tag Search button: Click this button to reach the Tag Search dialog, where you may
choose the X-tag and one or more Y-tags for your plot. When you have selected tags
or data sets through this dialog, they will appear on the Tags in Plot list.
Dataset Retrieval Arrowhead button: Click this arrowhead to choose a data set for
plotting. The data set values may be retrieved through ODBC or through a PI
Calculation.
After you complete the configuration of your data set selection, they appear as tag names
in the Tags in Plot text box. An Options radio button appears next to each tag name.
Select the Options radio button to choose the X-axis tag. Unselected tags are Y-axis
tags.
If a tag that is selected as the X-axis is deleted, the first tag in the list becomes the X-axis
tag.
Use the four toolbar buttons on the title bar to rearrange this list. They are, in order, Add,
Delete, Up Arrow, and Down Arrow.
100
Draw an XYPlot
ServerEnter or select a PI Server name. This field is only used when a PI Tag name is
Configure Pairings
Once the tags are listed in the Tags in Plot list, configure the method for pairing values
between X and Y in the Data Retrieval Methods box.
X Tagchoose either Recorded or Interpolated for the retrieval method.
Y Tag(s)the Y tag data retrieval method applies to individually selected tags in the
Tags in Plot list (unless the Use for all Y tags check box is selected). The default data
retrieval method for Y tags is Synchronize.
Y Tags, paired by position in the listTo use multiple time ranges, select Recorded or
Interpolated. In this case, data is paired by position in the point list. If Interpolated is
selected for the X tag as well, the interval value for the Y tag defaults to the one for the X
tag.
When Recorded is the retrieval mechanism, the results are not skewed by minor
timestamp differences.
Y Tags, paired by timestampsto pair values by time, rather than by list position,
101
XYPlots
If you select Synchronize or any of the Match options, the start and end times for that
tag are set the same as for the X tag and cannot be changed.
Note: The XYPlot supports ODBC data sets that don't contain timestamps. This type
of entry must be plotted as a Y-tag, and data values must be retrieved using
the Recorded retrieval method. If a tag is changed from a Y tag to an X tag
and has a value for Retrieval Method that is only valid for Y tags, the method
is changed to Interpolated. If the tag is a data set, the method is changed to
Recorded.
In all cases, if a pair is not made, the unmatched Y points are ignored.
Use for all Y tagsSelecting this box indicates that the Y-tags data retrieval mechanism
applies for all Y-tags. If one of the tags is a Custom or ODBC data set and the selection
mechanism is Interpolated or Synchronize, the selection mechanism will be Recorded
or Match respectively for that tag only.
Scale Box
In the Scale Box, set the scale ranges for all tags.
Single Y Scalecombines all tag values onto one scale.
Multiple Y Scalesprovides a separate scale for each tag. This choice does not change
the scale min and max values, but allows them to be configured independently by
selecting each Y tag and making changes.
Regardless of your selection, you may independently configure the X scale tag.
MaxAutorange uses the maximum value plotted. You may enter an absolute value here
as well. Default is Autorange. Database uses the zero plus span value of the tag in the PI
Archive to determine the max. Database with a data set plot uses the maximum value
plotted.
MinAutorange uses the minimum value plotted. You may enter an absolute value here
as well. Default is Autorange. Database uses the zero value of the tag in the PI Archive to
determine the min. Database with a data set plot uses the minimum value plotted.
FormatSelects the number format of the Y scale, legend entries, cursor values, and
ToolTip values.
Plot Time
You can set the time for each tag as it is highlighted in the Tags in Plot box. If a Y tag is
selected and its selection mechanism is not Recorded or Interpolated, then these boxes are
disabled.
StartThe start time of the XYPlot. The list includes *-1h (minus one hour), *-4h, *-8h,
Draw an XYPlot
103
XYPlots
Legend
Choose the legend elements that appear in the XYPlot.
Tag NameLists the entries in Tags in Plot. Selected by default.
Srvr NameSelect this check box to prepend the tag name with the server name. Cleared by
default.
DescriptionThe tag description may be displayed on the legend. Selected by default.
ValueThe last value of the tag plotted may be displayed. For digital and string tags, a
string value is shown. Selected by default.
Engineering UnitsSelected by default. If the tag does not report units, they are not shown
on the legend for that tag.
Correlation CoefficientA check indicates that the correlation coefficient should be
calculated and displayed on the legend. Selected by default.
Display
Select the optional elements to be included in the XYPlot.
Plot TitleSelected by default.
104
Draw an XYPlot
Vertical Scale Inside AxisCheck this box to show the vertical scale to the right of the
Vertical Axis, inside the plot area. Selected by default.
GridsCheck this box to include vertical and horizontal grid lines. Selected by default. On
the Plot Format Page, you can configure the appearance of the major and minor grid lines.
Linear Correlation LineCheck this to show a linear regression line. The default is
cleared, which does not draw a line.
Connecting LinesCheck this box to show the paired points connected with straight lines in
the order they are plotted. Selected by default. Clear the box to configure a scatter plot with
points only, no lines.
Sample
This area displays a sample XYPlot with the options you have selected. When you have
completed the Display Format page, click the tab for the Plot Format page.
105
XYPlots
Plot Elementdrop-down list of the elements you can configure, such as major and
minor gridlines, background colors, text font, etc. Pens correspond to the X-and Y tags
listed in the order in the Tags in Plot box on the General tab.
Element FormatAfter you select an element in the Plot Element drop-down,
available formatting options appear. A drop-down arrow is grayed out if the option is not
configurable. For example, text has color but no line style options.
Line StyleDetermines the line style for the selected element.
Line WeightDetermines the line weight for the selected element. If the selected
element does not have a line weight property, this field is disabled.
Marker ShapeDetermines the marker shape for pen elements.
ColorDetermines the color for the selected element. Pen elements apply the color
to the line and marker.
Last Marker ColorAllows selection of a different color for the last marker for a
pen. If Match Trace is true (selected), this field is disabled. If the selected element
does not have a marker, this field is disabled.
Next To Last Marker ColorAllows selection of a different color for the secondto-last marker for a pen. If Match Trace is true (selected), this field is disabled. If the
selected element does not have a marker, this field is disabled.
Match TraceDetermines whether all marker colors match the trace color (true) for
a pen. If set to false, the Last Marker Color and Next To Last Marker Color fields
are enabled so the marker color can be changed for those two plotted points. By
default, this field is selected (true). If the selected element does not have a marker,
this field is disabled.
SampleProvides a preview of your formatting changes.
Ad-hoc XYPlots
You can draw an XYPlot in Run mode on an ad hoc basis. Click the XYPlot button
begin, and follow the steps described in Drawing an XYPlot (page 99).
to
XYPlot Statistics
The XYPlot Statistics dialog [deprecated] allows you to view and export raw data values and
statistics, such as the mean and standard deviation of each tags data.
You can also view these statistics in the Details Window (page 135).
To open the XYPlot Statistics dialog:
1. In Run Mode, double-click the XYPlot symbol. Your cursor turns into a pointer.
2. Use the pointer to double-click an XYPlot on your display. The Statistics dialog appears.
3. In the Options drop-down list, select Raw Data or Statistics.
106
Draw an XYPlot
107
XYPlots
Etc.
108
Where m is the slope and b is the offset. To calculate m, we use the following equation:
Once m and b are known, the value of y that intersects the best-fit line can be calculated.
Correlation Coefficient
The Correlation Coefficient (r) varies between -1 and +1. Positive values indicate that as X
increases, Y also increases. Negative values indicate that as X increases, Y decreases. A
value of zero indicates no correlation in the way the sets of values vary.
The Correlation Coefficient for a set of points is calculated using the following formula: (n is
the number of points, s is the standard deviation). You can display the correlation coefficient
in the plot legend.
Note: Bad data points are not included in this calculation.
109
XYPlots
Interpreting an XYPlot
In PI ProcessBook the XYPlot is a dynamic symbol. It has specialized characteristics, such as
its statistical calculations, which are described in the following paragraphs.
Point Properties
Data may be retrieved from PI or from independent data sets. Use the Tag Properties button
or the right mouse menu Properties item to determine the attributes of the points in your
XYPlot .
Scroll Feature
Scrolling is available from the ProcessBook toolbar. When time scrolling is used on an
XYPlot symbol, all tags time ranges are changed to support the scroll duration.
Plot Values
In a typical XYPlot, the current value for X appears below the plot. The current values for the
two different Y tags appear at the upper right. Below each one is the correlation coefficient
for that XY pair. The dots and lines on the plot are colored to match the tags.
Plot values appear in a small box over the plot when the mouse cursor is hovering over an
actual plotted point pair. The following illustration shows an example.
In the figure above, if there had been more than one Y tag, each one would be displayed on a
different line. The X tag information is placed at the bottom. For digital or string tags, the text
value is displayed in the tool tip.
You can also view plot values by double-clicking the title bar and choosing the Raw Data
option, rather than the Statistics option.
Zoom/Revert Functions
You can enlarge a portion of an XYPlot by using the Zoom feature.
Zoom/Revert Functions
Original plot
111
XYPlots
Note: The zoom area must be smaller than the plot area and cannot include the
outer 20 percent of the plot. If the mouse is dragged past the plot boundary,
the zoom rectangle stops at the border until the mouse reappears within the
boundary. If the mouse is dragged off the plot symbol boundary, the zoom is
canceled.
Revert
1. Click Undo to return the plot to its state directly before the zoom occurred.
2. Click the Revert button
XYPlot Cursors
The cursor for an XYPlot includes both a horizontal and a vertical line. The mouse cursor is
at the cross point of both cursor lines. You must be in Run mode to use the XYPlot cursor.
To create a cursor, place the mouse very close to either the X- or Y-axis. Drag the cursor onto
the plot.
In the XYPlot below, you can see an XYPlot cursor at the Y axis that is not yet intersecting
any points on the plot.
112
You can also see an XYPlot cursor that was dropped on a point. The X and Y values appear
in small boxes outside the axes.
Using the mouse, you may position and release the cursor over any point on the XYPlot. If
the cursor is dropped on an area that contains no points, the cursor snaps to the nearest point.
113
XYPlots
Examples of XYPlots
For these examples, the X-axis represents one of the values in the pair and the Y-axis
represents the other. The configuration of these axes regarding minimum and maximum
values and interval (or unit) settings is left to you.
114
Examples of XYPlots
115
XYPlots
116
Chapter 7
Additional Symbols
Dynamic Symbols
Values
A Value is the reading obtained at a particular moment in time for a tag in the PI Archive. A
value is shown as a number or a digital state string. The tag name and time stamp may also be
shown. The time stamp is the time stamp from the PI Archive.
Add a Dynamic Value
1. In Build mode, open a display.
2. On the Drawing toolbar, click the Value button
117
Additional Symbols
4. In the Server drop-down list, select the PI Server to use. If a tag name is manually
entered in the Tag box, it is expected to be on the selected server. If both server and tag
name are entered in the Tag box, this field is updated with the entered server name. This
field has no effect for non-PI data.
5. In the Tag box, type the name of the tag you want to display in the value box.
-orClick the Tag Search button to locate the tag.
-orClick the Tag Search arrow to see more search options.
Note: The Sample area shows how the value will look.
6. In the Format drop-down list, select a number for the value, or type your own format
(page 119).
7. In the Tag drop-down list, select the location of the tag name in the value box (None,
Left, Right, Top, or Bottom).
8. In the Time stamp drop-down list, select the location of the time stamp in the value box
(None, Left, Right, Top, or Bottom).
9. Click OK to add the value to the display.
Note: PI ProcessBook allows you to create custom placeholders for a symbol based on
a summary Data Set. Placeholders are not allowed for expression Data Sets. The
Custom Placeholders button in symbol definition dialog boxes allows you to
specify different PI Tags for a PI Summary Data Set. The change applies only to
the configured symbol. See Add or Edit Placeholders (page 163) for details.
118
Dynamic Symbols
Value
Result
General
-25.434
-25.434
25.59
26
0.00
17.246
17.25
#,##0
-1732.87
-1,733
#,##0.00
-1732.87
-1,732.87
(#,##0)
-1732.87
(1,733)
(#,##0.00)
-1732.87
(1,732.87)
0%
3.25
325%
0.00%
3.25
325.00%
Scientific
3.25
3.25000E+00
Database
Uses the Display Digits attribute for the tag from the
PI System.
The following table describes how to create a custom number format mask.
Symbol
Explanation
Button
For example:
119
Additional Symbols
For example:
Add a Button
1. In Build mode, open a display.
On the Drawing toolbar, click the Button button
, or
120
Dynamic Symbols
Note: By default, ProcessBook attempts to open a linked display from its relative
path first. If the relative path fails, then the absolute path is attempted.
Clearing this box reverses the order in which the paths are resolved. For new
displays, this option is checked by default.
Ignore the default shell command for recognized file types (for example, SVG).
Note: If the file type is supported by ProcessBook (either natively or through an addin), then it is opened directly. For example, an .svg file is opened using the
.svg File Converter in ProcessBook, even if you have Adobe SVG Viewer
installed. Clearing this check box disables this behavior, so the default shell
command is always used to open a file.
Bars
A Bar shows the current value of a tag as compared to a specified range of values.
For example, a bar may be used to create the effect of a vessel filling and emptying, as the
value changes.
The range of values can be the maximum and minimum values specified in the point
attributes, or, a bar can be designed to show a specific range of values.
For example, if a tags specified value is between 0 and 100 but it typically falls between 0
and 30, a bar can designed to show that range. However, if the value is outside the range of
the bar, the bar will appear the same as a value right at one of the limits of the bar.
The start of the bar may be within the limits of the bar. This lets you display deviations from
a standard or target value. Bad values are shown with hash marks across the entire bar.
121
Additional Symbols
You can draw a bar using the current line style, line color, and fill attributes.
1. In Build mode, open a display.
2. On the Drawing toolbar, click the Bar button
, or
4. In the Server drop-down list, select the server to use for manually entered tags. If the
server and tag name are both entered in the Tag box, this field is updated to show the new
server name. This field is ignored for non-PI data.
5. In the Tag box, type the name of the tag you want to display on the bar.
-orClick the Tag Search button to locate the tag.
-orClick the Tag Search arrow to see more search options.
122
Dynamic Symbols
6. From the Upper and Lower drop-down lists, select the maximum and minimum values
you want to use for the bar. Select a constant, or choose Tag Zero() or
TagZero()+TagSpan() for either or both values.
Note: If you choose a maximum value that is too small, the bar will be fully colored
but there will be no warning that it has exceeded the maximum.
7. From the Start drop-down list, select the point on the bar from which you want to start
drawing the bar. Select a constant, or select TagZero()+TagSpan() or Tag Zero().
8. Under Orientation, select one of the options to display the bar either vertically or
horizontally.
Note: The Sample area shows how the bar will look.
Multi-State Symbols
A Multi-State symbol changes color to reflect changes in value for a particular tag or data set
value. Any symbol except a trend, XYPlot, graphic, button, or OLE object can be made a
Multi-State symbol by assigning a tag to it. String and timestamp data cannot be used to
configure multi-state behavior.
You determine the number of value ranges, and the colors assigned to each range. As the
value of the tag changes, the Multi-State symbol changes color to reflect the current value.
You can make a symbol seem to disappear by setting a state color to the background color or
to a color of none. For alarms or other purposes, you can set a state color to blink.
For example, you may have a symbol showing two states. State 1 has a value range from 0 to
50 and a color of blue assigned to it. State 2 may have a range from 50 to 100 and have red
assigned to it. When the reading is 50 or below, the symbol appears blue. Above 50, the
symbol appears red. A color and sometimes a blinking attribute are assigned for bad data. For
digital point types, a different color may be assigned to each state.
123
Additional Symbols
2. Click the symbol that you want to use for creating a Multi-State symbol.
On the Formatting toolbar, click the Multi-State Symbol button
, or
4. In the Server drop-down list, select the server to use for entered tags. If a server and tag
are both entered in the Tag box, this field is updated with the new server name. This box
does not apply to non-PI data.
5. In the Tag box, type the name of the tag you want to assign.
-orClick the Tag Search button to locate the tag.
-orClick the Tag Search arrow to see more search options.
6. In the Number of States box, select the number of states to usel. If the number of states
is not entered, the number defaults to 2. (For digital tags, the number of states is
automatically set to the number of defined states for that tag.)
7. From the Color for Bad Data drop-down color palette, select a color that will be used
when the information is in bad status. You may also select the Blink check box to call
attention to the symbol when data is bad (optional).
8. In the State box, select 1.
9. In the Values box, type in a new value.
Note: The Values boxes display a range of values for each state. The total range of
the tag is automatically divided by the number of states. For digital tags, the
state name is displayed in these boxes. For other tag types, an estimate is
made based on the span of values for the tag.
124
Static Symbols
10. From the Color drop-down color palette, select a color that will be used for the state. You
may also select the Blink check box (optional).
11. Repeat Steps 9 and 10 for each state in the symbol. Your choices and the relative range of
values are displayed on the bar at the bottom of the dialog box.
12. Click OK.
Note: You can remove a Multi-State symbol definition by clicking the Convert to Static
button, which breaks the link between the symbol and the tag.
Note: PI ProcessBook allows you to create custom placeholders for a symbol based on
a summary Data Set. Placeholders are not allowed for expression Data Sets. The
Custom Placeholders button in symbol definition dialog boxes allows you to
specify different PI Tags for a PI Summary Data Set. The change applies only to
the configured symbol. See Add or Edit Placeholders (page 163) for details.
Static Symbols
Text Symbol
The text symbol allows you to put one line of text on a display. Multiple lines of text are not
supported. When this symbol is first added to the display, a text box with a blinking text
cursor is displayed.
You can add or edit text by double-clicking the Text symbol while in Build mode, which
provides the text cursor. Unlike most other ProcessBook symbols, this symbol is not sized by
dragging an area on the display. Instead, the symbol is sized to accommodate the text within.
When text is added, the symbol grows in size and when text is removed the symbol size
shrinks. The size of the font used also affects the size of the symbol.
You can format the text symbol for font and color. Text symbols have all the functionality of
other static symbols except rotating and flipping.
Add Text to a Display
Use the Text tool to add text to a display.
1. In Build mode, open a display.
2. On the Drawing toolbar, click the Text button
, or
125
Additional Symbols
Note: Text block refers to the text area associated with a shape that appears when
you click the shape with the text tool or select it with the pointer tool.
5. When you finish typing, press ESC or click outside the text block.
Edit a Text Box
1. In Build mode, open a display and double-click the text block you want to edit.
2. Click where you want to add or edit text.
3. Type to add text or edit the text.
4. When you finish typing, press ESC or click outside the text block.
Move a Text Block
1. In Build mode, open a display.
2. Click the text block you want to move, drag it to the new location, and then release the
mouse button.
Line Symbol
Lines within a drawing can be diagonal, horizontal, or vertical. Attributes you can change
include line color and whether a line is dotted or dashed, thick or thin, and with or without
arrowheads.
Draw a Line
1. In Build mode, open a display.
2. On the Drawing toolbar, click the Line button
, or
126
Static Symbols
Using the drawing tools, you can create these simple shapes:
Rectangle, Square
Arc
Ellipse, Circle
, Arc
, or
Example of an arc
PI ProcessBook User Guide
127
Additional Symbols
Polygon Symbol
The Polygon tool draws irregular shapes. When you select the polygon tool the mouse pointer
changes to a polygon pointer. Polygons are drawn using the current color and line style
attributes.
Draw a Polygon
1. In Build mode, open a display.
2. On the Drawing toolbar, click the Polygon button
, or
Example of a Polygon
128
Static Symbols
Polyline Symbol
A Polyline is a set of line segments that you can draw using the Polyline tool. It uses the
current line style attributes.
Once you add a Polyline symbol, you may edit it in the same manner as the existing Polygon
symbol. You can move or resize the entire symbol, as well as move the individual endpoints
to create any desired arrangement.
Draw a Polyline
1. In Build mode, open a display.
2. On the Drawing toolbar, click the Polyline button
Graphic Symbol
graphic file. (Linking means that if the original graphic is edited or moved, it affects the
appearance of the display as well.)
Load an image in one file format and later save it in a different format.
129
Additional Symbols
Note: A drawing is display resolution dependent, which means it may look different from
one monitor to another. Test the drawing on each monitor to see how it will look.
BMP
CUR
A file that contains an image that defines the shape of a cursor on the screen.
EMF
Enhanced Metafile Format; 32-bit Microsoft Windows Metafile vector format that also
supports raster images.
ICO
JPEG
Joint Photographic Experts Group - Refers both to the standard for storing
compressed images and a graphic stored in that format.
PNG
Portable Network Graphics - graphic image format that utilizes lossless compression.
SVG
Scalable Vector Graphics is a vector graphics language written in XML. Using SVG,
graphics can be coded directly into an XML document.
TIFF, TIF
WMF
The Windows Metafile Format - the original 16-bit native vector file format for the
Microsoft Windows operating environment.
Add a Graphic
1. In Build mode, open a display.
2. On the Drawing toolbar, click the Graphic button
, or
130
Static Symbols
Embed if you want to update the graphic within the display file.
Link if you want to store the graphic separately from the display file.
7. Click OK.
8. A copy of the graphic is added to the display.
Symbol Library
A large selection of symbols is available in the Symbol Library. Many of these have
characteristics such as color, fill type, orientation, or background, which you can modify.
On the installation CD, OSIsoft provides several other commonly used symbols in the
ProcessBook called SYMLIBRY.PIW. This is usually installed in C:\Program
Files\ProcessBook\ProgramFiles\pipc\Procbook\SYMLIBRY.PIW. You
can cut and paste these symbols into a display.
131
Additional Symbols
-orOn the Draw menu, click Symbol Library.The mouse pointer changes to the Symbol
Library pointer.
3. Click in the display where you want to add the symbol and drag the pointer to form a
rectangle into which the symbol will be placed.
When you release the mouse button, the Symbol Library dialog appears.
4. Under Categories, click the type of symbols you want to use, such as Boilers,
Controllers, Valves, etc.
132
Static Symbols
Fill ModeEdits the way the image is drawn. Options include Original, Shaded,
Solid or Hollow.
Fill ColorClick the color box to change the fill color.
FlipSelect Horizontal, Vertical, or Both to change the orientation of the symbol.
The default setting is None. This setting returns the symbol to its original position.
RotationSelect 90, 180, or 270 to turn the symbol by 90 degree increments. The
default setting is 0. This setting returns the symbol to its original position.
TransparentCheck this box if you want a transparent background.
Background ColorIf the Transparent check box is not selected, you can click the
color box to change the background color.
Note: You can also change the symbol's fill and background color directly on a trend
by using the Fill Color
and Background Color
Symbol Formatting toolbar.
buttons on the
2. Click the Defaults button if you want to revert to the default settings.
3. Click OK to accept the changes and return to the Symbol Library (page 132) dialog.
Symbol Properties
If you right-click a symbol in the Symbol Library, the focus box at the upper left reflects that
symbol. A small dialog appears; you can choose either Symbol Options or Properties.
133
Additional Symbols
If you choose Properties, you see a Symbol Properties dialog, which displays the Symbol
description, Data size, Type, and Handle information. This information could be used in VBA
automation of PI ProcessBook.
134
Chapter 8
135
Data SourceThis field allows you to choose a data source, including datasets and PI
Tags(by default, the first trace or main data source for the selected symbol is shown). The
Show All entry shows data for all the data sources in the selected symbol.
Note: If a dataset or XY Plot symbol returns more than 3,500 values the Show All option
is not available. In addition, only the first 3,500 values are displayed. This value
can be increased by adding the registry key HKCU\Software\PISystem\PI ProcessBook\DetailsAddin\MaxPoints (type DWORD) and setting it to
the maximum number of points desired.
OptionThis field allows you to toggle between three different types of information about
your data source.
Datashows all rows for a selected symbol's time range. By default the table is
sorted on the timestamp column in descending order. Click a heading to resort the
table on a different column.
Statisticsshows a table of available summary values available, for example,
Average, Minimum, Maximum. Selecting this option disables the PI Annotation
Maintenance window. Available statistics vary for each symbol type.
Point Attributesshows an alphabetized list of PI point attribute values.
Makes the text size bigger or smaller. This may reduce the
Allows you to copy the data table to your clipboard. You can then
Copy to Clipboard
paste this data into another location such as a Microsoft Excel spreadsheet.
136
PI Annotations Maintenance
Annotations allow you to associate related information (such as text comments and other
binary data) with any archive value. The PI Annotation Maintenance group at the bottom of
the Details window (page 135) allows you to easily annotate values on your dynamic
symbols.
The PI Annotation Maintenance group is located at the bottom of the Details window and is
enabled so that annotations can be added, edited or viewed, provided that:
The selected data source is a PI Tag
The target PI Server can read and write annotations
A row representing an event is selected in the Data table
If the target PI Server (or collective) is unavailable or cannot accept edits from the current
user, the control is disabled. If the PI Server becomes unavailable while you are entering an
annotation and you then click the Save button, you will receive an error.
Note: If you select Show All from the Data Source drop-down box on the Details (page
135) window, the Value and Value Type fields in the PI Annotation Maintenance
group are disabled.
Add Annotations
1. Open the Details (page 135) window
2. In Run mode, select a dynamic symbol on your display.
3. Click inside the Value text box and enter the information you wish displayed in your
annotation.
4. Select a value from the Value Type drop-down box.
at the top of the PI Annotations Maintenance group. An
5. Click the Save button
annotation icon
appears on the dynamic symbol. Hover over this icon to read your
annotation. A record of the annotation also appears on the Details window when the
Data option is selected.
137
Note: You need to be running a PI Server 3.4 or higher for annotations to work correctly.
Otherwise, it is possible that an annotated event will not only be marked as
annotated, but will also be marked as substituted.
138
To select all of the symbols in a drawing area, click Choose Edit > Select All.
To select individual symbols, press SHIFT while clicking each symbol. Selection
handles display around each selected item.
To select several symbols at the same time, click near a symbol, and then drag to
create a rectangle that includes all the symbols you want to select.
Rotate a Symbol
To select symbols that are stacked on top of each other, click the top symbol.
Selection handles appear. Continue clicking the top symbol to select symbols located
under the top symbol.
3. Click the symbols you want to change or move. The selected symbols display handles.
Rotate a Symbol
You can rotate a drawing symbol in 15 or 1 increments. You cannot rotate text, graphics, or
OLE objects. Symbol Library images can only be rotated in 90 increments.
1. Select the symbol you want to rotate.
2. Choose Arrange > Rotate. A rotation object appears in the center of the symbol.
3. Click a selection handle and drag in the direction that you want to rotate the symbol. The
symbol is rotated in 1 increments.
-orPress SHIFT while dragging to rotate in 15 increments.
Flip a Symbol
You can create a mirror image of a symbol by flipping it. You cannot flip text, graphics, or
OLE objects.
1. Select the symbol you want to flip.
2. Choose Arrange > Flip > Horizontal to flip the symbol from right to left or Vertical to
flip the symbol from top to bottom.
Delete a Symbol
When you want to delete a drawing symbol or group of symbols:
139
Stacking Order
Each symbol you add to a drawing occupies its own space in the drawing. The layers, and
therefore the symbols, are stacked on top of each other. By default, the first symbol you draw
is at the bottom of the stacking order and the last symbol you draw is at the top of the
stacking order.
Using the stacking commands, you can move a symbol forward or backward within the stack
(page 140). Depending on the number of objects between top and bottom, you may need to
repeat a stacking command several times to move the symbol to the desired location within
the stack.
140
3. Click the alignment options you want. All the selected symbols are aligned to the symbol
you first selected, along the axis you specify.
141
Connect Symbols
Connector Symbol
You can connect two symbols to each other using the Connector symbol. The Connector
symbol remains attached to each of the connected symbols whenever one or both are moved.
The advantage of using a Connector, rather than a line, is that the Connector remains attached
to other symbols when you move the other symbols and avoids overlapping other symbols.
The Connector is intended for modeling and automation purposes.
Connection Points on each symbol define where the connection occurs. Connection Points
can be added, deleted, or moved on a symbol.
Connectors try to avoid objects as they are being connected between two symbols.
The Connector symbol is supported by automation within PI ProcessBook.
142
Connect Symbols
2. Click on the first symbol, called the "Source," and drag the mouse into the second
symbol, called the "Destination." The Connector arrow has a flow direction from the
Source to the Destination. Connection Points appear on both symbols.
Note: If your mouse does not touch a symbol, you do not see a Connection Point. Do not
adjust the Connector manually. If you do not see Connection Points on both
symbols, delete the Connector and draw it again.
Connection Points
Connection points on each symbol define where a Connector may connect. Connection Points
are visible in Build mode only and appear on symbols as small x marks. When you select one
with your cursor, it changes to an x within a bounding circle.
ProcessBook symbols are originally built without Connection Points. A Connection Point is
created automatically when a Connector is dragged into a symbol. This Point is created at the
midpoint of the nearest edge of the bounding rectangle of the symbol. The end of the
Connector is moved to the Connection Point. You may add Connection Points and move
them to specific locations.
A Connection Point can be used for either the start of the flow or the end of a flow. The same
Connection Point can be used for both. A flow can be bi-directional.
If a second Connector is dragged over a symbol, it either moves to the existing Connection
Point or creates a new one.
For irregular figures, Connection Points are placed near the midpoint of the side of the
bounding rectangle of the figure, as shown in the illustration below, rather than inside the
figure itself. You can adjust the position of the Connection Point to touch the actual figure.
143
Note: If a symbol is placed in front of another, the Connection Points on the hidden
symbol cannot be selected. You can solve this problem by placing the two
symbols on different layers of the display.
144
Connect Symbols
In other words, Connection Points have identifying names that are derived from the symbol
name. For example, for a rectangle named Rectangle2, two Connection Points would be
named <Rectangle3 : 1> and <Rectangle 3 : 2>.
If you are using a symbol from the Symbol Library, the Connection Point is named
<TBSymbolx : n>, where TBSymbolx represents the specific name of the symbol.
Connectors Dialog
In Build mode, if you wish to adjust a Connector's end point, you might click and drag the
end point. Unfortunately, this action stops the auto-avoidance capability of the Connector.
Alternatively, you can use the Connectors dialog to rearrange connections. To reach this
dialog:
Click the Connectors toolbar button,
-orChoose Edit > Connectivity,
-orOn the right-click menu, click Connectivity.
The Connectors dialog affects Connector symbols only. It cannot be used to attach one
symbol to another symbol without a Connector. The Connectors dialog has two tabs, Flow
and Attachments. Each Connector is identified by a unique number, which is revealed by a
tooltip in your display.
145
The Auto Avoid option is checked as a default, so that Connectors route around other objects
in the display.
146
Connect Symbols
147
Connector Attachments on the Display Properties dialog, discussed above, you can still
attach symbols to Connectors by using this dialog.
148
To move the symbol closer to one end of the Connector, double-click the specified %
and change it.
To move the symbol from the top of the Connector to another placement, doubleclick the default Top and choose Left, Right, or Bottom.
Connect Symbols
149
3. Select the Master Symbol. As you change the Master, the title of the dialog changes
also.
4. Place a check mark for the subordinate symbol or symbols and click OK.
5. Repeat the process for each Master symbol. The Detach All bar at the top can be used to
remove all attachments from the currently selected symbol in the Master box. To detach
only one attachment, clear its check box.
6. Click OK. When you move a Master symbol, any subordinates move with it.
Note: There are two other routes to the Symbol Attachments dialog. Choose Edit >
Symbol Attachments, or, on the right-click menu, click Symbol Attachments.
second.
150
Item Definition
If there are existing Connectors, all Connectors with attached symbols for this
symbol are spotlighted and display in a different color (for example, white for black
or yellow for blue).
If there are no Connectors, nothing happens.
Rerouting can consume significant system resources (CPU and Memory) to solve complex
problems. Factors that can increase complexity include:
A very large display
Large numbers of Connectors on a single display
Large numbers of symbols to be avoided
A high number of "Lines per Screen Unit" (set in "Arrange", "Grid Size", "Lines per
Screen Unit"1 equals the largest cell size; 30 gives the smallest cell size)
Routing multiple displays on the same PC
Item Definition
Use the Item Definition button in either Build or Run mode when you want to see what tags
and formatting options were used in any symbol that uses a dialog box for basic
configuration. It is the same as double-clicking on the item with the Build mode pointer. If
the symbol does not have a definition dialog box, the button is dimmed. You can change the
selections and save the new definition. This button does not open any of the formatting
dialogs (for example, Font or Color).
PI ProcessBook User Guide
151
3. In the appropriate dialog box, make your changes to the item's definition, and then click
OK. These changes are saved with the symbol. These changes are saved with the symbol.
152
For troubleshooting purposes, the Message Log button shows you the SDK Log file.
You can save this report as a .csv file by using the Save to File button.
Note: The Status Bar can be displayed or hidden from the View Status Bar item on the
View menu.
Questionableindicates that there is some reason to doubt the accuracy of the value.
Substitutedused to indicate that the value has been changed from its original value.
This value is set only by the PI Server when an existing value is changed.
If a tag has more than one flag, the highest priority status will be shown. The priority from
high to low is: Error, Questionable, Annotated, Substituted.
PI ProcessBook User Guide
153
If you clear the Show Value Attributes check box in your Start Preferences, you will not see
these icons. You might disable the icons to improve ProcessBook performance if you have
very high speed sub-second data.
154
Chapter 9
Data Sets
In PI ProcessBook you can build dynamic symbols using data retrieved from data sets just as
you can from specific points in the PI Data Archive.
A data set is basically the set of results of a query that addresses a specific data source. You
can use placeholders to link PI tags and ODBC data within a query.
Data sets are defined at the Book level so that they can be defined once and then shared
among different displays within that ProcessBook. Trends including data sets can be
manipulated, saved, moved, and copied in the same fashion as other trends.
Whenever a display is updated, if a trace or value using a data set is configured using relative
times, then the trace or value is updated. No updates occur if the data set is configured using
absolute times. For independent displays, the data set definition is saved with the display file.
You can edit an existing data set, either from the Tools menu or from a symbol that uses the
data set. However, if you have attached the data set to more than one symbol, editing the data
set affects all the symbols. If you move a PI ProcessBook display containing a data set to
another machine, you may need to reconfigure the data set.
database. ODBC client capability means that without writing vendor-specific code, you
can access data from certain relational databases outside the PI System and include that
data in your PI ProcessBook displays. The outside data source must be ODBC-compliant;
for example, it must provide an ODBC Driver. An outside ODBC data source might
PI ProcessBook User Guide
155
Data Sets
include laboratory results, cost tables, or other sets of information that can be obtained
through SQL queries. Since access to ODBC sources is configured on a particular
computer, moving a display file that uses an ODBC data set may require the data source
to be configured on the new computer.
Custom (page 159) data sets built as COM objects supplied by Visual Basic or C++
PI Summary Data Sets enable you to use several pre- determined functions to retrieve
calculated PI data for a tag.
The AVG function calculates the average of the tag values for each interval.
The MIN function selects the minimum of the tag values for each interval.
The MAX function selects the maximum of the tag values for each interval
The PCTGOOD function determines the percentage of time for each interval, when
the tags archived values are good (that is without errors, such as out of range errors
or shutdown flags). It is not used for digital tags.
The RANGE function calculates the difference between the tags maximum and
minimum values for each interval.
The STDEV function calculates the population Standard Deviation of the tag values
for each interval.
These functions are fully described in the Performance Equations chapter of the PI Server
Reference Manual.
PI Expression Data Sets
PI Expression Data Sets enable you to create your own function or expression in PI
Performance Equation syntax. These expressions can include tag variables with
mathematical and logical operations as described in the Performance Equations chapter
of the PI Server Reference Manual. This syntax is also documented on the OSIsoft
Technical Support Web site, http://techsupport.osisoft.com
(http://techsupport.osisoft.com), under the hierarchy Support > Downloads >
Documentation for the PI Server.
156
ServerSelect a PI Server.
NameEnter a name for your data set. The name must be unique for the current
.piw or .pdi file.
157
Data Sets
DescriptionThis description appears on trends of this data set in the tag descriptors
area.
Calculation IntervalThe interval (minutes, hours, days) for the calculation.
Interval Sync TimeThis is the absolute time of day at which the periodic
calculations are done. For example, if the Interval Sync Time box is set to 12:00:24
PM and the time in the Refresh Interval box is set to ten minutes, then the
calculation for each period is executed at the following times: 12:10:24, 12:20:24,
12:30:34, etc.
Value Column NameThe name that represents the time-value pairs of the
calculated data.
Refresh IntervalThe interval at which you want to automatically update the data
set. You can also type a number between 0 and 999. If you select 0, data is not
automatically updated.
Stepped PlotSelected by default. Clear the check box if you want a point-to-point
plot.
The data set name must be unique for the current .piw or .pdi file.
The node name and tag name must be valid.
The interval must be a valid PI time.
The sync time must be a valid PI time.
158
1:07:00 8
1:08:00 9
1:09:00 10
1:10:00 11
The calculated value for the AVG, STDEV, and PCTGOOD functions includes the tag value
at the lower interval boundary time and excludes the tag value at the upper interval boundary
time. For the example above, the tag value "10" at time 1:09:00 is excluded in the function
calculation, therefore the calculated value for AVG is 4.5 and the calculated value for
STDEV is 2.872281.
The calculated value for the MIN, MAX and RANGE functions includes the tag value of
both the lower and upper interval boundary times. For the example above, the calculated
value for MIN is 1, the calculated value for MAX is 11 and the calculated value for RANGE
is 12.
159
Data Sets
data could be a data store (like MS SQL Server) or a data calculation engine. PI ProcessBook
will request updates to the data every few seconds and adjust its display accordingly.
Before you can access custom data sets in a display, the Data Set Add-In must be installed
through the Add-In Manager (page 25) dialog. Later, as you build a display, you select the
data set and column to be used for a symbol on a display through the symbol definition
dialogs.
Building a custom data set is beyond the scope of this user guide. It is discussed in Creating a
Custom Data Set, a white paper supplied with the PI ProcessBook software CD and also
available through the OSIsoft Web site.
160
6. From the Data Source drop-down list, click the appropriate ODBC data source. If you do
not already have an ODBC Data Source configured on your computer (using the Control
Panel), click the Setup button to create or modify one.
7. Click the Design button.
The Microsoft Query application is displayed.
Note: If Microsoft Query is not installed, then the Design button is disabled. You can
key in the query manually. You can also copy and paste a query from another
query building tool.
161
Data Sets
Placeholders
A Placeholder in an SQL query identifies a value that is to be provided when the query is run.
You can validate a query before the actual values are provided.
The standard SQL placeholder character is ?. Placeholders are numbered in their order of
appearance, from left to right, in the query statement.
For example, the following query statement has two placeholders, one for a text string for a
sample ID and the other for a sample time.
Select value, sample_time from Lab_data where sample_ID=?
and sample_time>?
PI ProcessBook allows placeholders in queries. You may provide text, start, or end times, or
tag values as substitutes for placeholders.
162
Placeholders
In this example, the values of the tag in the PI System that records the current product code
are retrieved. The result set of the ODBC query is built by executing the query once for each
placeholder value. In the case of this example, that would be one query execution for each
product code found between the start and end times.
1. In the Placeholder Name box, select the parameter you want to configured. The
parameters are in the same order as found in the data set query. The list is limited to the
number of parameters found in the query.
163
Data Sets
2. In the Placeholder Properties group, select the Type for the selected parameter. There
are four possible types, Text, PI Tag, Start Time, and End Time. You can optionally
change the name of the placeholder to make its purpose clear.
3. Selecting a type transforms the dialog to allow you to enter the settings for the selected
type, if any.
If the query uses:
164
3. Click in the display where you want to add the trend and drag the pointer to form a
rectangle into which the trend will be placed.
4. When you release the mouse button, the Define Trend (page 80) dialog appears.
5. Click the Tag Search arrow, and then click PI Calculation.
6. The PI Calculation Data dialog appears.
Note: If you want to display the ODBC Data dialog instead of the PI Calculation
Data dialog, then click the Tag Search arrow, and then select ODBC.
7. Under Saved Data Sets, click the data set you want to add to the trend.
8. Under Data Set Columns, select a column(s) to be plotted in the trend (use the SHIFT or
CTRL keys to select more than one column).
9. Click OK.
Note: Until you select a data set and at least one column, the OK button is dimmed.
10. The selected data set/column(s) is now listed under Tags in Plot in the Define Trend
dialog. Select tags as desired and format the trend. If you wish to see or edit the
165
Data Sets
definitions of placeholders, click the Custom Placeholders button in the Define Trend
dialog.
11. Click OK. Data displays on the trend.
Note: If you select the Description check box, on the Display Format tab in the Define
Trend dialog, then the description of the data set is taken from the PI Calculation
Data dialog and repeated for each column that is plotted. There are usually no
engineering units for a data set column.
166
167
Data Sets
1. Add or edit the appropriate WHERE clause in the query to edit a placeholder data set or
existing placeholders (question marks represent placeholders in the query statement).
2. Click the Placeholders button. This action causes the syntax of the query to be checked.
3. If the syntax is valid, then the Placeholders dialog displays with the current placeholders.
If the syntax is invalid, then an invalid query message is displayed.
4. Click the Check Syntax button, to complete a syntax check of your query. The status of
the query is returned.
5. When you have finished modifying the data set, click OK. If the data set is in use in a
display, the Confirm Data Set Modification dialog displays.
6. If you wish to proceed, click Continue. The Data Sets dialog appears.
7. Select the column(s) to be used and click OK to return to the dialog.
168
5. From the To Open Workbook drop-down list, select the correct target, and then click
OK.
169
Chapter 10
Excel spreadsheet. In fact, you can write the script to retrieve the display only when
certain tag values or other conditions are met.
Write a Visual Basic program to start PI ProcessBook, assess a particular display, and
data of the current trend in ProcessBook. Then you could change the time range of the
ProcessBook, click the button again, and see the Excel spreadsheet update with the new
time range.
Although Automation scripts are not required to use a dialect of Visual Basic, at the present
time, that is the most common approach. OSIsoft is using Visual Basic as the standard testing
language for OLE Automation.
PI ProcessBook User Guide
171
For more information on how to write Visual Basic scripts for use with PI ProcessBook, click
Help > PI Processbook VBA Language Reference.
Embedded Objects
Embedded objects are copied from an existing file or created and then stored as an integral
part of the container application, such as PI ProcessBook. Using an embedded object
increases the file size of a ProcessBook significantly.
Formats not natively supported by PI ProcessBook, such as Windows metafiles, can now be
pasted from the Windows clipboard as objects in a ProcessBook display.
To change the contents of an embedded file, double-click it. The source application software
is invoked, and you can edit the object with the source application's commands.
ProcessBook is a time-based application. When ProcessBook is used as an embedded object,
it updates dynamically whenever you double-click it.
If you rename a ProcessBook or move it to another directory, drive, or PC, any embedded
objects in displays can still be changed as long as your system can locate the appropriate
source application software.
Linked Objects
Linked object information is not stored as a part of the destination application. Instead, the
destination file stores only the location of the linked source file. No matter how many links it
has, only one version of the linked file is stored and maintained. Using a linked file increases
the file size of a ProcessBook less than using an embedded object.
In establishing an OLE link, you may update the:
Contents of the object dynamically whenever the source file changes
Update the object only by manual command
To change the data in a linked file, such as which tags you have selected, you switch to the
source application and open the file. Changes are then reflected in the container display
according to the update method you selected.
Alternatively, if you double-click the object, the source application and the actual file open,
allowing you to edit the object. If the source application supports in-place activation, you can
edit within the container window; otherwise a source application window opens.
If you rename a ProcessBook or move it to another directory, drive, or PC, any links from displays to
source files can break. These broken links need to be re-established if you wish to continue using them.
172
ActiveX Controls
ActiveX Controls
You can insert ActiveX controls that are installed on your PC into PI ProcessBook displays.
If you move the displays to other machines, then you must also install the controls there.
Some ActiveX controls are self-contained and will work without further scripting. Most
require additional VBA code before they function correctly.
Add a Control
1. In Build mode, open a display.
2. On the Drawing toolbar, click the Control button
, or
In Run mode, a user could change the month and date. A programmer could incorporate
the calendar into scripts associated with the display.
173
The equipment parts list is stored with the ProcessBook display. If your PC has an installed
copy of MSWord, you can peruse or modify the list at any time simply by double-clicking it.
The lab results are stored by the source application, not in the ProcessBook display. The
display can be set to update lab data dynamically whenever the results in the source
application changed, or it can be set to update lab data when you click an Update Now button
on the Edit Links dialog.
174
Embedding in ProcessBook
Embedding in ProcessBook
Objects may be created within a PI ProcessBook display by the source application and then
stored as embedded objects. Alternatively, you may create objects from existing files or parts
of files. In addition, you can embed an object by dragging it from another application.
Unless you are using drag and drop embedding, you must be in Build mode in order to insert
a new object. Choose Insert > Object to launch the Insert Object dialog.
175
Note: If you want to display an icon rather than a graphic, select the Display as Icon
check box.
176
5. Click OK.
177
Location
Action
Select All
Edit menu
Zoom/Fit All
Symbols
View menu
Align
Arrange menu
Does not work because you cannot select more than one
OLE object at a time.
Forward
Arrange menu
Does not work because you cannot select more than one
OLE object at a time.
Backward
Arrange menu
Does not work because you cannot select more than one
OLE object at a time.
Group
Arrange menu
Does not work because you cannot select more than one
OLE object at a time.
Rotate
Arrange menu
Flip
Arrange menu
178
In addition, you can reach the source application through the Links dialog.
1. Choose Edit > Links. The Links dialog appears.
2. Click the appropriate link.
3. Click the Open Source button to open the source file.
179
If
Then
180
6. To select the icon to use, click the Change Icon button. The Change Icon dialog
appears.
181
3. On the Create New tab, under Object type, click PI Display Document.
Note: If you want to display an icon rather than a graphic, select the Display as icon
check box.
4. Click OK.
5. The display is embedded in the container application.
OLE Container/Server
A ProcessBook display may be shown in another application. For example, you could include
an updating trend in an incident report produced in a word processing application such as
Microsoft Word. Or, you could prepare a presentation for a group by using Microsoft
PowerPoint to prepare slides and including embedded displays from PI ProcessBook. To do
this, use the Insert Object command in the second application and insert an object of type PI
Display Document.
182
Appendix A
VBA Commands
Access VBA through the VBA toolbar, or by choosing Tools > Macro:
Visual Basic Editor
Run Macros
Design Mode
ActiveX Automation
ActiveX Automation refers to the technology of placing ActiveX controls (independent
software modules) within applications and using scripts to manipulate the application and/or
the controls.
Excel spreadsheet. In fact, you can write the script to retrieve the display if and only if
certain tag values or other conditions are met.
183
Write a VB program to start PI ProcessBook, access a particular display, and then alter it
in some way.
Click on a command button in ProcessBook to make an Excel spreadsheet show the
average and raw data of the current trend in ProcessBook. Then you change the time
range of the ProcessBook, click the button again, and see the Excel spreadsheet update
with the new time range.
Use a mouse click within a PI ProcessBook display to initiate updates or adjustments in
the display.
Update a PI ProcessBook display by typing new tag names into a spreadsheet.
Although Automation scripts are not required to use a dialect of Visual Basic, at the present
time, that is the most common approach.
Automation Vocabulary
Understanding OLE automation requires some technical vocabulary. Terms used in the PI
ProcessBook VBA Language Reference Guide are defined below.
184
Automation
ActiveX
Automation
Server
ActiveX
Automation
Container
Object
Property
Method
An action that can be performed on an object and may or may not return a value.
Sometimes called a function.
Event
Appendix B
ODBC
ODBC Driver Manager
PI ProcessBook sends queries to a standardized interface from Microsoft called the ODBC
Driver Manager. The Driver Manager forwards ODBC queries to appropriate vendorprovided Drivers, which access the outside databases and return the requested data to your
ProcessBook display.
ODBC Drivers
Each DBMS (database management system), such as Microsoft SQL Server, requires a
specific ODBC Driver, provided by the vendor of the DBMS or a third party. Each driver is a
Dynamic Link Library (.dll) that implements a set of subroutine calls to retrieve data from
a particular database.
The Microsoft ODBC Driver Manager is included as a part of PI ProcessBook installation.
ODBC data sources have an explicit name, are configured for a particular computer, and may
be used by any ODBC- compliant application installed on that computer.
185
ODBC
bar. The SQL needed to retrieve data for PI ProcessBook can be configured once and used by
many displays and symbols.
PI ProcessBook must return a time and value pair(s) for display within a symbol (trend,
value, or bar). Placeholders act as parameters to an SQL function call. They are evaluated at
run time. Placeholders can take three forms: text, start/end times, or a PI tag name. Use the
start and end time placeholders when the time limits of the query should be determined from
the trend symbol where the query is used. The PI tag name placeholder can be used to join PI
data with relational database data. A PI Value is retrieved for the PI tag and then substituted
into the query.
Using ODBC requires that you install the Microsoft ODBC Driver Manager and drivers
(most operating systems already have the Driver Manager and some standard drivers
installed). You must then configure data sources (page 187) for ProcessBook and define
individual queries, called data sets.
186
187
ODBC
4. When you have completed configuring the data source, click OK to return to the
Microsoft ODBC Data Source Administrator dialog.
Note: To create data sources for any user of the computer, use the System DSN tab
instead of the User DSN tab.
Tag. This time will supersede any timestamps returned by the query.
One or more of the columns returned by the query may contain a date and/or time. If
more than one timestamp column is returned, the first one as ordered by the SQL query is
used.
Text
StartTime
Current time
EndTime
Current time
Tag
An ODBC data set is created with a set of default placeholders. When it is attached to a
specific symbol, the query's placeholders can be customized for that symbol, without
affecting the placeholders defined for other symbols using that data set.
For example, you can create a query for a database of laboratory data using a text placeholder
for the sample name. You can then use a different sample name for every trend, bar, or value,
rather than defining a new data set query for each sample name.
189
ODBC
190
Appendix C
Troubleshooting Tips
Display Can't Find Data
When a display does not receive data, the problem may be one of the following:
The network is down.
A display has been moved from one PC to another and Node Identifiers to the Server(s)
Is an XYPlot Updating?
When an XYPlot is updating, the updating tags are shown with an arrow indicator in the
legend. An XYPlot is updating if the following conditions exist:
PI ProcessBook User Guide
191
Troubleshooting Tips
The end time for the X tag is indicated as the current time (by using *) or is in the future
(*+N)
At least one of the Y tag end times is indicated as the current time (by using *) or is in the
future (*+N) and is not synchronized or matched with the X tag (if X is not updating).
If both the X tag and the Y tag are updating, an arrow indicator is shown in each legend entry.
Updates for retrieval methods Recorded and Interpolated are received from an event pipe that
provides the application with snapshot values. For this reason, when a tag is using recorded
values, you may see many more values while the plot is updating than are actually recorded.
Once the plot is regenerated or reverted, only recorded values are shown. When using the
interpolated retrieval method, values on the plot are interpolated using the snapshots coming
in through the event pipe.
has become a picture. It can't update from the source. Re-create the object.
On the Links dialog, if the file is set to Manual Update, click Update Now, and the file
should update.
On the Links dialog, if the entry for the file says Unavail, the source file is not where the
application expects to find it. Use the Change Source button to locate the file and reestablish a path for the link.
192
ODBC Problems
ODBC Problems
Missing ODBC Trace
If no values are found for one of the selected columns in a query, the trace will not be drawn
and the value in the legend reads No Data.
If the necessary time value is not defined in the query, either by a date/time column or by a
placeholder tag, the trace is drawn as a straight line using one value.
193
Appendix D
NNNNNN is the node name of the PC. This may be a number, depending on whether the PC
node is defined in the network database on the VAX or Alpha.
SSSS is the first four characters of your user name from the PI ProcessBook login dialog box
or "Book" if you leave the user name field blank.
IIII is the process ID of the PI ProcessBook process, which is always E.
There is also a log file in the PISysExe: directory for each PI ProcessBook connection.
For DECNet connections, this log file is NetServer.LOG. For TCP/IP connections, the
name is xxxPIServer.LOG where xxx depends on the vendor of the VMS TCP/IP
software.
PI Server connections are managed through the PI-SDK on the machine running PI
ProcessBook.
195
DEFAULT=PI
[CLIENTACCESS]
DEFAULT=RW
DYAN=R
ERIC=R
JOHN=NONE
The above entries in piserver.dat result in:
The machines named DYAN and ERIC have only read access to PI data.
The machine named JOHN does not have any access to PI data.
All other machines have both read and write access to PI.
The value for the DEFAULT entry is initially set to RW. Otherwise, existing PINet nodes will
not function properly.
If you want to restrict write access from PCs, set the default CLIENTACCESS to R and add
entries to accommodate your PINet Nodes. For example:
[USERDATABASE]
DEFAULT=PI
CLIENTACCESS
DEFAULT=R
BRIAN=RW
The preceding entry allows the PINet node BRIAN to read and to write data to the PI System.
All other nodes have read- only access.
TCP/IP node names are case-sensitive. In addition, the values for the entries in the
CLIENTACCESS section (for example, R and W) are also case-sensitive.
Machine Address
Because PI ProcessBook is a client/server application, the communication setup is essential.
The machine address, which allows the PI System to recognize your machine, is a key item.
Often, the address may be found as an alias in the TCP host file. The Network Administrator
should resolve any questions or difficulties regarding the network and addressing.
PROCBOOK.INI
The PROCBOOK.INI file contains configuration and preference settings for PI ProcessBook.
This file generally resides in two places, the user's default location, C:\Documents and
Settings\<user name>\Application Data\PISystem\PIProcessBook\<language>, and the PIPC\DAT directory (on the local drive where PI
ProcessBook is installed).
196
PROCBOOK.INI
Startup Section
Initializations for startup of PI Processbook
Possible entries:
StartupProcessBookSpecifies file to be opened on start of Processbook
DefaultFileLocationBy default, clicking File > Open directs you to the local user's My
Documents directory. Specifying a different directory in this entry defaults File > Open and
File > Save to a new folder when ProcessBook starts.
ModeBiasR=run-mode, B=build-mode
RetainAspectRatio1=preserve aspect ratio for displays, 0=do not
Symbol LibrarySpecifies workbook that is opened by selecting Book of Symbols
MakeBackupFile1=make backup files while using ProcessBook, 0=do not make backup
files
AuthorSets the default author for created displays and workbooks
ToolTipsEnabledSetting this entry equal to Y enables tool tips on ProcessBook symbols.
Setting equal to N disables them. The default (if this entry is not in the .ini file) is Y.
International Date FormatSpecifies date/time format. 1=Windows format, 0=PI Time
format
PromptForConversion1=prompt user when opening a file created with an earlier version,
asking whether or not to convert to new format, 0=do not prompt (default)
MaxUndoStackSizeMaximum number of elements in the Undo stack (default is 200)
Build/Run Scroll ModeFor each mode, set the scrolling: 0=off, 1=on, 2=automatic.
GridSizeSets the Grid Size, in lines per screen unit. Default is 12.
File Access EntriesFileAccessTimeout and FileAccessInterval entries,
described below, first check the common INI file for these settings as opposed to the private
INI files.
FileAccessTimeoutNumber of seconds ProcessBook will attempt to open a locked file
(default is 5 seconds)
197
198
PROCBOOK.INI
199
Author=
International Date Format=1
MaxUndoStackSize=20
Build Scroll Mode=1
Run Scroll Mode=1
GridSize=12
FileAccessTimeout=5
FileAccessInterval=1
COMTimeOut=30
RunSelectorColor=0,0,0
MacroProtectionLevel=0
TBFilePath=
UserDefaultTB=
PBDefaultTB=
References=
URL Home="http://www.osisoft.com/"
MaxBitmapMB=16
ServerTimeZone=1
Processbook=PRIMARY
EnableScreenSaver=1
ConnectUsingAPI=0
EnableConnectorAttachments=1
Conversion Section
The Conversion section of the .INI file identifies resources for importing other file formats
and resembles this example:
[Conversion]
Import0 = PIDisDIFF Files, impd32.dll, dat
Import1 = PI-Graphics Files, impp32.dll, dat
ImportN identifies the file types used when converting VAX-formatted trends or graphics.
N increments by one for each file type.
200
PROCBOOK.INI
The second field is the name of the file type to be imported and will appear in the List Files
of Type drop-down box in the Import File dialog box.
The third field is the DLL used to import the file type. No path is necessary, since the files
reside in the same directory as Procbook.exe.
The fourth field is the default extension for the file type. You may have more than one
extension for each import type, separated by semicolons.
TIMER sets the poll timer, in milliseconds, for checking whether PI ProcessBook should
perform any time-related task. Time-related tasks include retrieving exception reports from PI
and re-querying sources. (60,000 is the maximum setting; the default is 5000.)
201
Colors Section
Defines the 16 colors in the ProcessBook palette.
Parameters: ColorX = Red, Green, Blue, values can range from 0 to 255
202
PROCBOOK.INI
Example:
[Colors]
Color1=255,255,255
Color2=255,0,0
Color3=0,255,0
Color4=0,0,255
Color5=0,255,255
Color6=255,0,255
Color7=255,255,0
Color8=0,0,0
Color9=192,192,192
Color10=128,0,0
Color11=0,128,0
Color12=128,128,128
Color13=128,0,128
Color14=0,0,128
Color15=128,128,0
Color16=0,128,128
203
204
PROCBOOK.INI
Macro Protection
The primary purpose of the macro protection feature is to prevent misbehaved VBA event
code from executing. Whenever a ProcessBook display (either standalone .pdi file or table
of contents entry) is opened, ProcessBook determines whether the display has any VBA code
present.
MacroProtectionLevel may be set in the [STARTUP] section of Procbook.ini at one
of the following levels:
Value
Description
User is prompted when display is opened; project is set to design mode if user selects
<Disable Macros>.
User is prompted when display is opened; project is opened with macros disabled if user
selects <Disable Macros>.
User is prompted when display is opened; project is always set to design mode when
opened.
User is prompted when display is opened; project is always opened with macros
disabled.
The default value for this setting is 0, so that if it is not present at all in the .ini file, then
PI ProcessBook always executes macros.
205
Security
Any string or integer value in PROCBOOK.INI can be overriden in the registry. Overrides
can be provided in the HKEY_LOCAL_MACHINE\SOFTWARE\PISystem\PI ProcessBook\Security key. Under that key there is a key for the INI file section. The
values are in that section. For example, to override the EnableScreenSaver setting in the
STARTUP section of PROCBOOK.INI, a DWORD value EnableScreenSaver with a value of
1 would be created in HKLM\SOFTWARE\PISystem\PI ProcessBook\Security\Startup.
If a value is found in the Security overrides section of the registry, the PROCBOOK.INI files
will not be accessed.
The PI ProcessBook setup kit does not create these registry keys; it is up to each site
administrator to create the keys if they want to override the PROCBOOK.INI settings.
IMPPIGP.INI
The IMPPIGP.INI file contains configuration settings used by the Import utility in PI
ProcessBook. The file generally resides in the PIPC\DAT directory. As with other .INI
files, SETUP.EXE creates this file with default settings.
When you import VAX-formatted graphics and graphics that include trends, the import utility
uses the settings found in this .INI file to convert items such as color, line style, and fonts.
You can edit the .INI file if you want to change these default settings. Before you edit this
file, you should make a backup copy so you can restore PI ProcessBook to its original
settings.
Note: The settings in this .INI file affect graphics and trends included in graphics only.
When importing trend displays, the format specified in the Trend Preference
setting is used.
The following is a list of the keywords in the IMPPIGP.INI file. The values shown are
examples and not necessarily the default settings shipped with PI ProcessBook:
The Color section of the .INI file maps VAX colors to PI ProcessBook colors:
[Color]
Clear=0,0,0
Black=0,0,0
White=255,255,255
Red=255,0,0
206
IMPPIGP.INI
Green=0,255,0
Blue=0,0,255
Cyan=0,255,255
Magenta=255,0,255
Yellow=255,255,0
Orange=255,128,0
GreenYellow=128,255,0
GreenCyan=0,255,128
BlueCyan=0,128,128
BlueMagenta=0,0,128
RedMagenta=255,0,128
DarkGray=128,128,128
LightGray=192,192,192
The values shown to the right of the equal sign are the red, green, blue values. Refer to
Creating Your Own Colors in the Windows documentation for more information on
changing these values.
The Line Style section maps the VAX line format to the PI ProcessBook line format:
[Line Style]
Supress=5
Solid=0
XShortDash=2
DotShortDash=3
LongDash=1
XLongDash=1
TwoDotDash=4
LongDotDash=3
ShortDash=1
=
=
=
=
=
=
solid
dash
dot
dash dot
dash dot dot
suppress
The Font section maps the VAX supported fonts to PI ProcessBook fonts:
StandardFont=35,400,0,0,34,Arial
SmallVector=-29,400,0,0,34,Arial
MediumVector=-52,400,0,0,34,Arial
LargeVector=-77,400,0,0,34,Arial
Note: These default values are based on resolutions for VT340 terminals. If you are
using a terminal other than these, appearances may be different.
The values to the right of the equal sign represent these font characteristics.
Position
Font
Characteristic
Definition
Height
Specifies the height of the font. If the value is greater than zero,
it specifies the cell height. If the value is less than zero, it
specifies the character height, which is the cell height minus the
leading.
Weight
207
Position
Font
Characteristic
Definition
Italic
Underline
Specifies the pitch and family of the font. Pitch can be fixed,
variable, or default. Font families, such as Old English, describe
the look of a font in a general way. They are intended for
specifying fonts when the exact typeface desired is not available.
Face Name
The Marker section of the .INI file maps the VAX trend markers to the markers provided
in PI ProcessBook:
[Markers]
NoMarker=9
Dot=0
SmallPlus=6
LargePlus=7
Asterisk=0
Circle=1
LargeX=8
Box=5
Diamond=3
BoxWithDot=4
DiamondWithDot=2
BoxWithDiamond=4
The values to the right of the equal sign represent these marker types in PI ProcessBook:
0
1
2
3
4
5
6
7
8
9
=
=
=
=
=
=
=
=
=
=
filled circle
open circle
filled diamond
open diamond
filled square
open square
filled triangle
open triangle
cross
none
The Display section in the .INI file specifies the supported terminals in PI ProcessBook:
[Display]
Terminal Type=VT340
Keywords for supported terminals are shown below. The horizontal and vertical dimensions
are also shown.
VT340 = 800 x 500
Reflection = 800 x 500
Tektronix = 4095 x 3130
X1024 = 880 x 640
X800 = 560 x 448
If your terminal is not included in the list of keywords, you can create your own. The syntax
is:
Terminal Type=Custom,X,Y
208
SETUPProcessBook.LOG
where X equals the horizontal dimension and Y equals the vertical dimension.
SETUPProcessBook.LOG
This log tracks the setup of PI ProcessBook on your system and holds information pertaining
to directory structure, user-entered information for Node, .DLL, and User name, and the
installation of the various ProcessBook files.
209
Appendix E
Email Support
Email technical support inquiries, including the problem description and message logs, to
techsupport@osisoft.com. You will receive a response within 24 hours.
Knowledge Center
The Knowledge Center provides a searchable library of documentation and technical data, as
well as a special collection of resources for system managers. For these options, click
Knowledge Center in the Technical Support Web site.
The Search feature allows you to search Support Solutions, Bulletins, Support Pages,
211
System Manager Resources include tools and instructions that help you manage: archive
sizing, backup scripts, daily health checks, daylight savings time configuration, PI Server
security, PI system sizing and configuration, PI trusts for interface nodes, and more.
212
213
Index
.
.piw 36
A
ActiveX Control 175, 177
Ad Hoc Trend 97, 98
Create 97
Save 98
Add-In Manager 25
Add-Ins 25, 26
Alias 74
Module Database 74
Aligning Multiple Symbols 145
Annotations 139, 141
Add 141
Arc command 131
Archive 2
Assign Layers dialog 72
Attributes
Changing 66
Color 67, 68
Font 66
Line 68, 69
Autorange 91, 92
B
Background color 68
Bar 125
Create a bar 125
Book View 43, 44, 45
Preferences 20
Section of Procbook.ini file 202
Browsing Displays from Internet Explorer 58
Build Mode 8, 37
Button
Adding a Button 124
C
Call Tracing 195
Cascade 57
Circle 131
Close
a ProcessBook 48
Color 21, 67, 68, 85, 212
of plot elements 85
Pen 24
section of the imppign.ini file 212
Trend Element Preferences tab 24
COM object 163
Compound Documents 175
Configuring the Data Source 159, 191, 196
Connection Points 146, 147
Add 148
Delete 148
Connections 146, 147
Connectors Dialog 149
Failure 9
to OpenVMS Servers 201
Connector Symbols 146
Container 175, 177
Context for Module Relative Displays 74, 75, 77
Change at Run 77
Continuous trace 95
Control 177
Convert 184
VAX-formatted trends and graphics 98
Copy 47
a data set to another ProcessBook 172
Correlation
Correlation Coefficient for XY Plot 113
Cursors 89
Missing 197
Custom Data Sets 163
Custom Menus 17
Custom Toolbars 17
D
Data 2, 3
Data Manager in Procbook.ini file 202
Not in Display 197
Data Archive 2
Data Set 159, 160, 164, 169, 170, 171, 172
Adding to a column 169
Adding to Bars or Values in a Display 170
Copying a 172
Custom 163
Edit a 171
Is it in Use? 168
ODBC 164
PI Calculation 160
Running in ProcessBook 171
215
Index
216
E
Edit 171, 182, 183, 196
a Data Set 171
a text box 130
an ODBC Data Source 196
Embedded Objects 183
Linked Objects 183
Ellipse 130, 131
Embed 176, 186
discussion of 176
Example of 178
Existing ProcessBook Display in Another OLE
Application 186
ProcessBook Display in Another OLE
Application 186
vs. Link 177
Entries 37, 43, 47
Arranging 43
Change the Name of 45, 47
Creating 37
Placement in ProcessBook 37
Rearranging 47
Types of 45
Expanding a Trend 88
F
File
How to Import 52
Sharing 53
Flags for Data 157
Flip command 143
Floating Point values 121
Font 66
Font section of the imppign.ini file 212
Format 65, 66, 67, 68, 69
Color 67, 68
Editable Formatting Attributes 66
Font 66
Line 68, 69
Trend 82, 83, 85, 86
Formatting Paintbrush 69
Full Screen 17, 59
Full Timestamp 95
Future Trends 16
G
Graphics 99, 133, 134
Convert from VAX to PC 99
Graphic Symbol 133, 134
Icons vs. Graphics 178
Grid 65
Grid Lines 91
Size 65
Group Symbols 145
H
Handles 142
Horizontal flip 143
How Trends Refresh 90
I
Icons 60
Graphics vs. Icons 178
impg32.dll 202
Import 52, 98
Files 52
VAX-formatted trends and graphics 98
imppigp.ini 212
Independent Display files 58
Saving 60
Installation 4
Testing 4
Integers 121
Internet Explorer 58
Interpolated data retrieval method 103, 104
Interval 103, 104
Invisible line on a trend 24
Item Definition 155, 156
K
Keyboard Shortcuts 28, 29, 30
Assign symbol to 72
Composite symbols 72
Working with 70
Z Order 70
Layout tab 82, 86
Legend 103, 104, 108, 109
Level of an Entry 45
Line 24, 68, 85, 130, 212
Draw 130
Ends 69
Style 23, 24, 68, 85
Weight 68, 85
Linear Correlation Line 108
Linear Regression by Least Squares Method 113
Link 176, 177, 180, 181, 186
Existing File into a ProcessBook Display 180
ProcessBook to Another Application 186
Re-establishing 182
vs. Embed 177
Linked Displays or ProcessBooks 39
Add 39
Logarithmic scales 79, 91
M
Macros 3, 189, 211
Markers 23, 96
Shapes 24
Menu 16
Minimize 58
Missing Data Sources 191, 199
Missing Trace 199
Mode, Run and Build 8, 37
Module Context 73, 74, 75, 76, 77
Features 74
Module Context Add-in 73
Move 41, 53, 77, 82
a Display to another PI Server 77
a Plot 82
a ProcessBook to another PC 53
MSQuery 194
Multiple Objects 142, 144, 145
Align Multiple Symbols 145
How to Select 142
Stacking Order 144
Ungroup 145
Multi-State Symbol 127
L
Layers 70, 72, 73
Adding a Layer 70
PI ProcessBook User Guide
N
Name 35, 45, 70
217
Index
a ProcessBook 35
of a layer 70
Network Connections 8, 9, 10
Network Errors 9
New 14
Display 14
ProcessBook 14, 35
ProcessBook Entry 14
O
ODBC 164, 191, 192, 193, 194, 195, 196, 199
Data Access 191
Data Sets 164
Data Sources 191, 196
Driver Manager 191
Drivers 191, 196
Preparing to Use 193
Troubleshooting 199
OLE 175, 176, 177, 178, 182, 183, 184, 186, 187,
198
Edit 181, 182, 183, 184
Embed 176, 179
Link 176, 180, 181, 182
Overview 175, 176, 177
Troubleshooting 198
Open 36, 57, 58
a Display 57
Independent Display Files 58
Multiple entries 57
ProcessBook 36
Several Displays at Once 57
OpenVMS Trends and Graphics 98, 99
Organizing Symbols 64, 65, 142, 143, 145, 146
OSIsoft Developer Network (DevNet) 3
Out of Range Indicators 118
Outline View 45, 46, 47
P
Pages 44
Turning in Book View 44
Partial Timestamp 95
PI Data Archive 2
PI ProcessBook 1, 7
PI Server 2, 8, 9, 10
Connect/Disconnect 9
Updates to 2
Pisysdat 201
Placeholders 166, 167
Plot 79, 82, 104
Plot Title 103, 104
218
Q
Queries 166, 167, 194
Questionable Data Flag 157
R
Rectangle 130, 131
How to Draw 131
Re-establishing Links 182
Refresh Interval 90, 164, 170
Refresh Timer section of Procbook.ini file 202
Regrouping a Composite Symbol 145
Relative paths 181
Relative Timestamp 95
Remove
a Trend Cursor 89
an Entry 48
Reset 13
Resize 44, 58
a Display 58
a ProcessBook Window 44
Retain Aspect Ratio 202
Rotate 143
Select 142
Stacking 144
Static 55
System Administration 201, 202, 212, 215
System Requirements 4
S
Save 48, 60, 98
Ad Hoc Trend Display 98
Preferred View of Your Entries 48
ProcessBook 48
ProcessBook Displays 48, 60
Scripting 3, 189
Scrollbars 13, 15, 16, 61, 90
Search 59, 63
for a Specific Display 59
for a Tag 63
Select Available Modules dialog 75
Selected Modules list 75
Selection handles 64, 82, 139, 142, 145
Server 8, 9, 10
Connect to a 9
Disconnect from 9
Display information about 10
Setup procedure 31, 202, 215
setup.exe 202
setup.log 215
Single Scale for the Vertical Axis 92
Snap to grid 65
Span 91
Square 131
How to Draw 131
Stacking Order 144
Starting PI ProcessBook 7
Startup section of Procbook.ini 202
Static Symbols 55
Status Report 156
Stored Procedures in Queries 194
Substituted Data Flag 157
Summary Information 49
Symbol Attachments
Dialog Box 153
Symbol Library 202
Symbols 55, 121, 129, 135, 139
Connect 146, 147
Delete 143
Details and Annotations 139, 140, 141, 142
Dynamic 55
Flip 143
T
Tags 62, 63
Text Symbol 129, 130
Tile Windows 57
Time 10, 13, 15, 16
Time Forward and Back 16
Time Range Toolbar 13
Time range 13, 15, 16
Changing 15
Revert 13
Toolbar 13
Timestamp 95
Title
of a trend 90
of ProcessBook or Display 49
Too Many Points 118
Toolbars 16, 17, 18
Add Buttons to 18
Customize 17
ToolTips 21, 69
Trace 85, 95, 96, 195
Definition of 95
Hiding 95
Markers 96
Missing 199
Trace ODBC Calls 195
Trend 23, 24, 79, 82, 88, 89, 90, 97, 98, 169, 197,
207
Ad Hoc 97
Analysis tools 88
Cursors 89, 197
Data Sets in 169
Default Format 82
Default Preferences 23
Definition section of procbook.ini 202
Delete a Plot 82
Expand 88
Formatting a 82
Grid Lines and Labels 91
Horizontal Scale Grid Lines 95
Importing VAX-Formatted 98
Invalid data 9
219
Index
Multiple Plots 82
Preferences 23
Refresh rate for data 90
Refreshing data from a data set 170
Tool 82, 97
Zoom 2x In or Out 88
Trend Scale Grid Lines 95
formatting 85
Troubleshooting 197, 198, 199, 215
Cant save a display 197
Display Has No Data 197
Legend Missing on Trend 197
ODBC Problems 199
Setup.log 215
Trend Cursors Missing 197
Updating Linked Objects 198
U
Ungroup Symbols 145
Updates 181, 198
Break Links 181
by Exception 2
for Future Trends 16
for Trend data 90
Links 181
to Linked Objects 181
to PI Data 2
Troubleshooting 198
Update dynamically 176
Upgrades 4
V
Value 121
Value Scale 23, 79, 91, 92, 95
VAX 52, 98, 99, 201, 206, 212
VBA 1, 3, 17, 177, 189, 190
View Only Mode 212
Views 43, 45
Book 43
Outline 45
Visible Layer 70
VMS 98, 99, 201
W
Workspace 7
X
XY Plot 101, 103, 104, 108, 109, 110, 113, 114,
116, 118
220
Z
Zoom 58, 88, 114
2x 88
Display Size 58