ProcessBook Pi
ProcessBook Pi
Overview ................................................................................................................... 1
Fixes and Enhancements ........................................................................................ 1
Fixes .................................................................................................................... 1
Enhancements..................................................................................................... 2
Known Issues ........................................................................................................... 3
Setup ......................................................................................................................... 8
Operating Systems .............................................................................................. 8
Server Platforms .................................................................................................. 9
Hardware Requirements ..................................................................................... 9
Distribution Kit Files ............................................................................................. 9
Installation and Upgrade ...................................................................................10
Uninstalling PI ProcessBook .............................................................................10
Documentation Overview ......................................................................................10
Security Information and Guidance .....................................................................10
Technical Support and Resources ......................................................................11
Appendix A: Changes in PI ProcessBook 2015 R2 SP1 ...................................12
Security Information and Guidance ...................................................................12
Fixes ..................................................................................................................12
Known Issues ....................................................................................................13
Fixes
This section lists items that were resolved or added in this release of PI ProcessBook 2015 R2
(3.6.0).
16674OSI8 PI Calculation Refresh interval cannot be less than 1 minute
17317OSI8 Add tag description to ToolTip in ProcessBook
18997OSI8 Enhancement Request for Processbook 3.1 Trending--highlight scale
20520OSI8 Programmatically formatting Processbook trends--remove now lines for spark
line trends
21224OSI8 ProcessBook Composite with PolyLine problem
21457OSI8 Expose the Y-Axis Maximum and Minimum Values from a Trend after a zoom
event in the ProcessBook automation model
22852OSI8 ProcBook Crash in PIValue::OaGetValue
23033OSI8 RE: Question re Y-Axis scale values not visible on a multiple scale trend
23180OSI8 critical problem in PB; lack of precision on trend scale
23181OSI8 Question re Loss of trace markers on ProcessBook trend control.
23495OSI8 AF/Processbook Complaint...long error messages from AF
24341OSI8 Issues with ProcessBook's Bookmark Organizer
25152OSI8 Highlight Tag Description when clicked on Tag Name on a ProcessBook Trend
26139OSI8 Processbook: position of zoom (buttons) changes on subsequent use of zoom
function
26354OSI8 Browser and Playback toolbars do not remember their settings
26476OSI8 Unable to add AF2 dataset if default AF Server is unavailable
26502OSI8 Values on Trend in Scientific Notation Do Not Honor Display Digits
26676OSI8 SetTagName (\\SERVER\TagName) method and SetTagName(TagName) return
NO DATA on initial run
27043OSI8 Trend value scale minimum values are not saved when max is set to autorange
27053OSI8 PI ProcessBook may crash when launching the Multi-State Symbol window after
the user changes the referenced tag's point type
27070OSI8 PI ProcessBook symbols do not automatically reflect tag name changes
9248OSI8 Dragging line for new symbol can be same as background color
9684OSI8 Check drive space on target drive (Network or otherwise) when saving file
Enhancements
Ensuring data integrity provides increased security against malicious attacks and intrusions
into your data infrastructure. Transport security provides an additional layer of defense
essential to protecting against data breaches, injection attacks, unauthorized eavesdropping,
etc. It not only protects your deployment, but the confidentiality of any secondary
infrastructure or client connecting to your system.
Known Issues
This section lists problems and enhancements that have been deferred until a future release.
The User guides and online help of PI ProcessBook in the setup kit incorrectly refer to PI
Data Archive as PI Server. Newer versions of the User Guides with the corrections can be
found on the installation media and online.
On recent operating systems, Microsoft .NET 4.5 can fail during installation of PI
ProcessBook 2015. This is an issue because the .NET installer is no longer supported by
Microsoft. In “Programs and Features”, select “Turn Windows features on or off” and
select “.Net Framework 4.5” and then restart the install.
Future Data tags cannot be used as placeholders for datasets.
If you are a user of Sigmafine and the AF Modeler, be aware that the AF Modeler is not
compatible with this version of PI ProcessBook when the AF Display Builder is enabled.
To continue using the AF Modeler, disable the AF Display Builder using the Tools>Add-
in Manager Dialog before opening any Sigmafine displays. Clear the checkboxes for
Loaded/Unloaded and Load on Startup for the AF Display Builder.
If you are not using Sigmafine and want to upgrade displays to use the new PI
ProcessBook functionality, you should manually uninstall the Sigmafine AF Modeler
add-in before installing PI ProcessBook 2015.
Allowing PI ProcessBook 2015 to automatically update displays created in Sigmafine’s
AF Modeler may result in a loss of configuration choices for some dynamic symbols.
This most often effects Trends, XY-plots, and Multi-State symbols. The lost
configuration can be reapplied manually and does not result in a loss of data.
The Data Sheet Control versions 1.0 and 2.0.0.20 are incompatible with PI ProcessBook
2012 SP2 and later. Version 2.0.1.0 of the Data Sheet Control is compatible with PI
ProcessBook 2015.
Contextual help fails to open a direct link to the help topic. The workaround is to use the
index and search features available in the PI ProcessBook Users Guide available under
Help->PI ProcessBook Help or by pressing F1 at any time.
PI BatchView versions 3.1.5 and later may have an issue with a non-default path to
pihome. The issue is due to registry files not cleaning up properly during uninstall of PI
BatchView which can result in issues installing PI BatchView later.
SVG files saved with the old AF Modeler cannot be imported by AF Display Builder
because AF1 datasets are no longer supported in ProcessBook 2015. Use the PDI format
instead for these displays.
PI ProcessBook 2015 R2 cannot be installed on the same system as any version of PI
ActiveView. Displays created in PI ProcessBook 2015 R2 are compatible with PI
ActiveView, but it must be installed on a separate system.
Add-ins compiled with previous versions of PI ProcessBook and some VBA code in
Display_Activate may experience errors when run in PI ProcessBook 2015 R2. The
typical error is a display object not found error or various errors pertaining to unknown
interfaces. The problem is the result of needed changes that were introduce during the
upgrade to .Net 4. The old references to the ProcessBook libraries must be removed and
references to the libraries that ship with this version of ProcessBook must be added.
There is no corresponding MUI kit for PI ProcessBook 2015 R2. The MUI kit for PI
ProcessBook 2015 can be used but newly added text will not be translated.
Due to .Net incompatibilities, the PI ProcessBook 2015 R2 add-ins will appear in English
even if the PI ProcessBook 2015 MUI is installed. This will be addressed in the next
release of the MUI itself.
PI ProcessBook MUI kit does not need to be uninstalled if upgrading from PI
ProcessBook 2012 SP1 or later. If upgrading from PI ProcessBook 2012 or earlier, then
previous versions of the PI ProcessBook MUI kit should be manually uninstalled prior to
upgrading to PI ProcessBook 2015.
With PI SDK v1.4.2.445 the Server Alias, often used in Batch processes, may have an
erroneous value (i.e. 0). This results in no data being seen on Batch Trends that use the
server-alias and other issues. This can be corrected by deleting any such values using the
About-PISDK executable. Additional information and updates on this problem are posted
on the OSIsoft Technical Support web site – reference KB00810.
Note that once a Module Relative Display is upgraded to an Element Relative Display,
the display will not show data for Element Relative dynamic symbols in versions of PI
ProcessBook prior to 3.2.
Setup
Operating Systems
The following operating system platforms (with minimum Service Pack requirements noted,
where they apply) are supported:
• Windows Server 2008 R2 (non-CORE version)
• Windows 7 SP1
• Windows 8
• Windows 8.1
• Windows Server 2012 R2
• Windows 10
PI ProcessBook communicates with most versions of PI Data Archive (3.x). PI Data Archive
2016 is recommended.
PI ProcessBook communicates with versions PI AF 2.0 and up. PI AF 2016 is recommended.
Hardware Requirements
These requirements are based on the minimum supported operating system. For newer
operating systems, the requirements may be higher.
Physical Memory: 1 GB for 32-bit OS, 2 GB for 64-bit OS.
Processor Speed: 1 GHz processor or faster. 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: 400 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.
PI AF Client 2.8.6.7801
PI SDK 1.4.6.494
NOTE: Any prior beta of PI ProcessBook or other beta PI System software should be
uninstalled prior to the installation of PI ProcessBook 2015 R2 SP1.
To install PI ProcessBook manually, double-click on the PIProcessBook_2015.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.
Uninstalling PI ProcessBook
PI ProcessBook can be removed from your system by selecting it for removal in the Programs
and Features Control Panel. You must have administrator privileges on your machine to
successfully uninstall PI ProcessBook.
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.
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.
PI ProcessBook Programmer’s Reference: Detailed information about the PI ProcessBook
automation model for those who are writing VBA code or custom Add-Ins.
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.
Vulnerability Communication
Vulnerability Scoring
OSIsoft has selected the Common Vulnerability Scoring System (CVSS) to quantify the
severity of security vulnerabilities for disclosure. To calculate the CVSS scores, OSIsoft
uses the National Vulnerability Database (NVD) calculator maintained by the National
Institute of Standards and Technology (NIST). OSIsoft uses High, Medium and Low
categories to aggregate the CVSS Base scores. This removes some of the opinion related
errors of CVSS scoring. As noted in the CVSS specification, Base score range from 0 for
the lowest severity to 10 for the highest severity.
Microsoft Software Security Defenses
In addition to finding and fixing security bugs within PI ProcessBook, it is equally critical
that OSIsoft leverage security defenses provided by the Microsoft Visual C++ compiler
that builds it and the Microsoft Windows operating system that runs it. Over the past
decade, Microsoft has continually added new defenses and improved existing defenses
with successive versions of the compiler and the operating system. To learn more about
many of these key defenses, consult the Microsoft whitepaper Mitigating Software
Vulnerabilities.
Please see Appendix A for the Vulnerabilities that are Addressed in PI ProcessBook
2015 R2 SP1.
Fixes
Upgrading from the PI ProcessBook 2015 R2 SP1 Beta is not supported. Please uninstall
the Beta before installing this version.
Microsoft has provided no upgrade path from VBA 6.5 to VBA 7.1. Therefore VBA 6.5
remains installed if a previous PI ProcessBook version is upgraded to PI ProcessBook
2015 R2. Instructions on how to remove VBA 6.5 can be found here.
Only English is currently supported for the VBA interface.
OSIsoft, LLC
San Leandro Tech Campus
San Leandro, CA 94577 USA
Tel: (01) 510-297-5800
Fax: (01) 510-357-8136
Web: http://www.osisoft.com
PI ProcessBook
© 1992-2017 by OSIsoft, LLC. All rights reserved.
No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or
by any means, mechanical, photocopying, recording, or otherwise, without the prior written permission
of OSIsoft, LLC.
OSIsoft, the OSIsoft logo and logotype, Managed PI, OSIsoft Advanced Services, OSIsoft Cloud Services, OSIsoft Connected
Services, PI ACE, PI Advanced Computing Engine, PI AF SDK, PI API, PI Asset Framework, PI Audit Viewer, PI Builder, PI
Cloud Connect, PI Connectors, PI Data Archive, PI DataLink, PI DataLink Server, PI Developer's Club, PI Integrator for
Business Analytics, PI Interfaces, PI JDBC driver, PI Manual Logger, PI Notifications, PI ODBC, PI OLEDB Enterprise, PI OLEDB
Provider, PI OPC HDA Server, PI ProcessBook, PI SDK, PI Server, PI Square, PI System, PI System Access, PI Vision, PI
Visualization Suite, PI Web API, PI WebParts, PI Web Services, RLINK and RtReports are all trademarks of OSIsoft, LLC.
All other trademarks or trade names used herein are the property of their respective owners.