Professional Documents
Culture Documents
Process Book
Process Book
PI ProcessBook 2012
Version 3.3
Fixes
This section lists items that were resolved or added in this release of PI
ProcessBook.
Punch List Item Description
10216OSI8 Regional Settings are used for the formatting of numeric values
10417OSI8 Symbol names can be any UNICODE character
10477OSI8 All symbols will report an error if the TagName cannot be resolved
10482OSI8 The Message Log dialog is now resizable
10489OSI8 Tag Names containing multiple periods ("..") are correctly resolved
10489OSI8, Summary datasets using TagNames containing multiple periods (".") are
12917OSI8 correctly resolved
10545OSI8 Both traces and horizontal grid lines scroll on an updating trend.
Behavior now mirrors PI ProcessBook 2.35 for partial timestamps.
10616OSI8 The CSV text file created when the status report is exported will use the
regional settings for the field separator
10679OSI8 Repeated creation of a Toolbar via VBA will not affect PI ProcessBook
Enhancements
PI Notifications Add-In
PI ProcessBook includes support for user presence through Office Communications
Server 2007 or Lync Server 2010 and the Unified Communications Client API. This
allows users to communicate and collaborate with other users from within PI
ProcessBook (without having to launch a separate application). A Contacts docking
window is available that not only shows the set of available contacts available
through Office Communicator/Lync but also a list of subscribers to a notification in
escalation order. The Help file has more information on using this functionality.
The Contacts docking window not only allows Instant Messaging (IM) but the ability
to send an image of the active display through e-mail.
Note that Office Communicator 2005/2007 or Lync 2010 must be on the machine for
this functionality to be present. In addition, the Microsoft Outlook XP or later client
must be on the machine for the ability to send e-mail through this add-in.
Playback and Time Range Toolbar
In addition to the playback feature introduced in version 3.2, this version provides
additional time controls including the ability to reset the display to updating without
losing the new time duration, the ability to scroll time across multiple displays at the
same time, and updated controls for scrolling time and changing the effective
duration of a display‟s time range. Please see the Help file for additional information.
Note that zoom areas and trend cursors are reverted/lost when the new time controls
are used.
SQC Symbol
The PI SQC symbol is included with PI ProcessBook; a separate license is not
required.
Symbol Library
The Renewables category has been added to the Symbol Library. In addition, new
images have been added to the Maps and Flags category.
Known Issues
This section lists problems and enhancements that have been deferred until a future
release.
The Data Sheet Control versions 1.0 and 2.0.0.20 are incompatible with PI
ProcessBook 2012. Version 2.0.1.0 of the Data Sheet Control is compatible
with PI ProcessBook 2012.
PI ProcessBook does not support MFC-based ActiveX controls created with
Microsoft Visual Studio 2005. ActiveX controls created with Visual Studio
2005 should be based on ATL or should override
COleControl::OnSetObjectRects in ctlinplc.cpp with a version based on MFC
version 7.
The servers dropdown and Unit Name Mask Selection dialog in PI
BatchView will cause Data Execution Protection (DEP) exceptions if DEP is
configured for OptOut and AlwaysOn (See
http://support.microsoft.com/kb/875352)
To use the IT OverView v1.3 add-in for PI ProcessBook on operating
systems that restrict file operations on folders under “Program Files”
(Windows Vista, Windows 7, Windows Server 2008 and later) PI
ProcessBook must be run in XP compatibility mode.
If PI ProcessBook 2012 and PI ActiveView are to be installed on the same
system then PI ActiveView 2012 must be used.
On systems missing a .NET35 update the .NET40 installation will trigger a
REBOOT request. The presented option to ‘Continue’ should not be selected.
REBOOT the machine and rerun setup to complete the installation.
Visual Basic 6 add-ins compiled with previous versions of PI ProcessBook
may experience errors when run on recent versions of Microsoft Windows
(Vista, 2008 Server and later) with PI ProcessBook 2012. The typical error is
a display object reference error. The problem is the result of needed changes
to the display object interfaces and can be corrected by either recompiling the
add-in or running PI ProcessBook 2012 in XP compatibility mode.
Internal Description
Issues
(SCR #)
23907 In Windows XP or Vista, using any Desktop Theme other than
Windows Classic, the first tab of the VBA color palette does not
render correctly. It appears blank, yet still selects a color if clicked on.
The second tab (System Colors) works fine. The VBA color palette
appears both in the VBA editor when changing the colors of forms
and controls as well as in PI ProcessBook when changing colors of
ActiveX control symbols in the Properties dialog.
In order to clearly see these dialogs, you need to disable support for
Desktop Themes by setting the EnableXPThemes key to 0 in the
[Startup] section of the ProcessBook.INI file.
Setup
To install PI ProcessBook manually, double-click on the ProcessBook_2012_.exe
file. The installation files are unpacked and the setup starts after the file extraction is
acknowledged.
You must have administrator privileges on your machine to successfully install PI
ProcessBook.
PI BatchView version 3.1.4 is the supported version for PI ProcessBook 2012. For
best results, uninstall PI BatchView (any version) before updating PI ProcessBook
and then install the PI ProcessBook update followed by installing PI BatchView 3.1.4.
This version of PI ProcessBook installs or upgrades Microsoft Visual Basic for
Applications (VBA) 6.5. If you already have VBA 6.5 installed on your machine, PI
ProcessBook uses the existing installation and increments the installation reference
count.
Internet Explorer (IE) 8 or a later version is the recommended browser for client
machines to take advantage of SharePoint Server interaction with PI ProcessBook.
The OSIsoft pre-requisite kit should be installed on a target system before silently
installing PI ProcessBook. For silent installations with Active Directory Group Policy,
please consult Support Solution 3136OSI8: “How to Deploy Products with Active
Directory Group Policy”.
To invoke a silent installation, enter the command „setup.exe –f silent.ini‟. The
silent.ini file can be customized to provide default a PI Server configuration setting as
follows:
[COMMANDLINE]
4 = /qn REBOOT=Suppress ALLUSERS=1 PI_SERVER= localhost
PI_ALIAS=localhost PI_TYPE=3 PI_PORT=5450 PI_USER=piadmin
INSTALLDIR="C:\Program Files\PIPC"
The line above is the only line that should be changed in the silent.ini file delivered
with PI ProcessBook. localhost entries for the PI SDK, component 4, should be
changed to reference the appropriate PI server.
NOTE: This version of PI ProcessBook requires .NET version 4, which requires a
reboot of the system. In order to do a silent installation this version of .NET must
already be present on the target system.
The following operating system platforms (with minimum Service Pack requirements
noted, where they apply) are supported:
Windows XP SP2
Windows Vista
Windows 2003 Server SP1
Windows 2008 Server
Windows 7
Note that saving a file in Windows Vista, Windows 7 or Windows 2008 to a restricted
area, e.g. Program Files\PIPC, results in the file being stored in the users Virtual
Store folder although PI ProcessBook continues to report that the file is saved in the
restricted area.
.
The Allow button must be clicked in order to repair or remove PI ProcessBook when
UAC is turned on.
UAC should be disabled to ensure successful deployment using silent installation.
Otherwise, elevated permission dialogs can be displayed by the operating system.
System Prerequisites
OSIsoft products and their installation depend on operating system components such
as Microsoft run time libraries, the Windows Installer engine, .NET Framework, and
other operating system redistributable packages. These operating system
components are available in three prerequisite setup kits. All three setup kits contain
both 32 and 64-bit redistributables.
Server Platforms
Hardware Requirements
Physical Memory: Minimum 128 MB; Recommended 512 MB. Although 128 MB
provides acceptable performance for many, increasing the available RAM improves
performance, especially when there are multiple applications running simultaneously
on the same machine.
Processor Speed: Pentium III CPU or better. A faster processor may help
performance if displays have complex calculations performed locally, but increasing
the installed RAM is more likely to help with general performance.
Hard Disk Space: 300 MB of empty space on the system drive for application files
and registry entries.
In addition to the drive space required for the application files and registry entries,
there must also be enough space available to keep a backup copy of the pisdk.msi
and ProcessBook.msi files. Even after the product is uninstalled the backup copy still
exists. This copy is deleted only when the system is rebooted.
Software Requirements
Only the OSIsoft and Microsoft components previously identified are required to run
PI ProcessBook.
Uninstalling PI ProcessBook
PI ProcessBook can be removed from your system by selecting it for removal in the
Add/Remove Programs utility in Control Panel for Windows XP and 2003, or the
Programs and Features Control Panel for Windows Vista, Windows 7 and 2008
Server. You must have administrator privileges on your machine to successfully
uninstall PI ProcessBook on Windows XP or Windows 2003 Server.
If PI ProcessBook is uninstalled on a system with PI ActiveView, the PI ActiveView
installation should be repaired to ensure proper functionality. The repair needs to be
done to support non-administrator users.
The following tables list the files installed by the PI ProcessBook 2012 installation
program.
Non Executables:
Folder File Name
<MicrosoftShared>\Office10\ CTRYINFO.TXT
<MicrosoftShared>\OFFICE11\1033\ ADO210.AW
<MicrosoftShared>\OFFICE11\1033\ DAO360.AW
<MicrosoftShared>\OFFICE11\1033\ FM20.AW
<MicrosoftShared>\OFFICE11\1033\ OFMAIN11.CHM
<MicrosoftShared>\OFFICE11\1033\ VBAOF10.AW
<MicrosoftShared>\OFFICE11\1033\ VBAOF11.CHM
<MicrosoftShared>\OFFICE11\1033\ VEEN3.AW
<MicrosoftShared>\VBA\VBA6\ VBE6EXT.OLB
<MicrosoftShared>\VBA\VBA6\1033\ FM20.CHM
<MicrosoftShared>\VBA\VBA6\1033\ VBCN6.CHM
<MicrosoftShared>\VBA\VBA6\1033\ VBENDF98.CHM
<MicrosoftShared>\VBA\VBA6\1033\ VBHW6.CHM
<MicrosoftShared>\VBA\VBA6\1033\ VBLR6.CHM
<MicrosoftShared>\VBA\VBA6\1033\ VBOB6.CHM
<MicrosoftShared>\VBA\VBA6\1033\ VBUI6.CHM
<PIPC>\DAT\ PROCBOOK.INI
Documentation Overview
These release notes are part of a documentation set that supports PI ProcessBook.
The set also includes:
PI ProcessBook User Guide: An introduction to PI ProcessBook for the end user.
This user guide provides a product overview, installation procedures, a tutorial to
acquaint you with the user interface, and other topics to allow you to work with and
troubleshoot PI ProcessBook.
Additional information, including the latest release notes, about PI ProcessBook and
other topics of interest can be found in respective documents available on the
OSIsoft Technical Support and Resources Web site.
When you open a case using any of the above methods, you will receive a response
from a Technical Support Engineer within four hours. Be sure to provide:
Product name, version, and/or build numbers
Computer platform (CPU type, operating system, and version number)
The time that the difficulty started
The message log(s) at that time
You can also take advantage of the Self-service Search page on our Technical
Support Web Site to look for answers to your technical questions and issues. The
search tool searches our online library of documentation, knowledge base articles,
technical announcements and bulletins, known product issues, and documented
product enhancement requests, as well as a collection of resources for system
managers.
OSIsoft, the OSIsoft logo and logotype, PI Analytics, PI ProcessBook, PI DataLink, ProcessPoint, Analysis Framew ork, IT Monit or,
MCN Health Monitor, PI System, PI ActiveView, PI ACE, PI AlarmView , PI BatchView , PI Data Services, PI Manual Logger, PI
ProfileView , PI WebParts, ProTRAQ, RLINK, RtAnalytics, RtBaseline, RtPortal, RtPM, RtReports PI Event Frames, PI Coresight and
RtWebParts are all trademarks of OSIsoft, LLC. All other trademarks or trade names used herein are the property of their respective
ow ners.
Published: 09-Dec-2011