Vous êtes sur la page 1sur 326

Historian SE

PROCESSBOOK USERS GUIDE


PUBLICATION HSEPB-UM020A-EN-ESeptember 2007

Contact Rockwell Customer Support Telephone 1.440.646.3434 Online Support http://support.rockwellautomation.com Copyright Notice 2007 Rockwell Automation Technologies, Inc. All rights reserved. Printed in USA. This document and any accompanying Rockwell Software products are copyrighted by Rockwell Automation Technologies, Inc. Any reproduction and/or distribution without prior written consent from Rockwell Automation Technologies, Inc. is strictly prohibited. Please refer to the license agreement for details. Trademark Notices FactoryTalk, Rockwell Automation, Rockwell Software, the Rockwell Software logo are registered trademarks of Rockwell Automation, Inc. The following logos and products are trademarks of Rockwell Automation, Inc.: FactoryTalk Historian Site Edition (SE), RSView, FactoryTalk View, RSView Studio, FactoryTalk View Studio, RSView Machine Edition, RSView ME Station, RSLinx Enterprise, FactoryTalk Services Platform, and FactoryTalk Live Data. The following logos and products are trademarks of OSIsoft, Inc.: PI System, Sequencia, Sigmafine, gRecipe, sRecipe, and RLINK. Other Trademarks ActiveX, Microsoft, Microsoft Access, SQL Server, Visual Basic, Visual C++, Visual SourceSafe, Windows, Windows ME, Windows NT, Windows 2000, Windows Server 2003, and Windows XP are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Adobe, Acrobat, and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. ControlNet is a registered trademark of ControlNet International. DeviceNet is a trademark of the Open DeviceNet Vendor Association, Inc. (ODVA). Ethernet is a registered trademark of Digital Equipment Corporation, Intel, and Xerox Corporation. OLE for Process Control (OPC) is a registered trademark of the OPC Foundation. Oracle, SQL*Net, and SQL*Plus are registered trademarks of Oracle Corporation. All other trademarks are the property of their respective holders and are hereby acknowledged. 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 Warranty This product is warranted in accordance with the product license. The products performance may be affected by system configuration, the application being performed, operator control, maintenance, and other related factors. Rockwell Automation is not responsible for these intervening factors. The instructions in this document do not cover all the details or variations in the equipment, procedure, or process described, nor do they provide directions for meeting every possible contingency during installation, operation, or maintenance. This products implementation may vary among users. This document is current as of the time of release of the product; however, the accompanying software may have changed since the release. Rockwell Automation, Inc. reserves the right to change any information contained in this document or the software at anytime without prior notice. It is your responsibility to obtain the most current information available from Rockwell when installing or using this product.

Version: 9.00.05

Table of Contents
Chapter 1: Introduction ..............................................................................................................1 New Features of Version 3.0 .....................................................................................3 Chapter 2: Working with a ProcessBook ...............................................................................11 What Is a ProcessBook? .........................................................................................11 Right Mouse Menu...................................................................................................11 PI Server ..................................................................................................................12 Basic Facts About Displays and Other Entries........................................................12 What Data May Be Included in a Display? ..............................................................12 FactoryTalk Historian ProcessBook Datasets .........................................................13 Analysis Tools..........................................................................................................13 FactoryTalk Historian ProcessBook OLE ................................................................13 File Sharing Capability.............................................................................................14 Opening and Closing ProcessBooks .......................................................................14 Book View and Outline View of ProcessBooks .......................................................22 Menus and Toolbars ................................................................................................24 Preference Settings .................................................................................................26 Keyboard Shortcuts .................................................................................................37 Printing.....................................................................................................................40 Online Help with FactoryTalk Historian ProcessBook .............................................42 Chapter 3: Working with a Display .........................................................................................45 Elements of Displays ...............................................................................................45 Display Point Attributes............................................................................................47 Managing Displays and Independent Display Files.................................................48 Trends......................................................................................................................53 XY Plots ...................................................................................................................65 Other Dynamic Symbols ..........................................................................................79 Run Mode Pointer....................................................................................................80 Status Report for Dynamic Symbols........................................................................80 Status Flags for Unusual Data.................................................................................81 Using the Available Modules Window .....................................................................82

FactoryTalk Historian Site Edition ProcessBook User Guide

Page iii

Contents

Chapter 4:

Points and Data......................................................................................................83 PI Data Archive........................................................................................................83 Point Database Overview ........................................................................................83 Point Attributes ........................................................................................................84 User-Assigned Attributes .........................................................................................84 System-Assigned Attributes.....................................................................................90 Updates to PI Data ..................................................................................................90

Chapter 5:

Servers and Connections .....................................................................................93 How Displays Behave When Connection to the PI Server Fails .............................93 PI Connection Manager Dialog Box ........................................................................93 How to Display Server Information ..........................................................................95 How to Change the Default Server..........................................................................95 Node Identifiers for Multiple PI Servers ...................................................................95

Chapter 6:

Time Concepts .......................................................................................................97 Time Zones and PI ..................................................................................................97 Time Range Formats ...............................................................................................97 Absolute Time..........................................................................................................98 Relative Time...........................................................................................................99 Combined Time Scales............................................................................................99 Time Range Toolbar ..............................................................................................100 Scrolling Time Range ............................................................................................100 Changing the Time Range.....................................................................................101 Revert Time Range................................................................................................102 Future Trends ........................................................................................................102

Chapter 7:

Building ProcessBooks ......................................................................................105 Build Mode Pointer ................................................................................................105 Basic Steps to Build a ProcessBook .....................................................................105 Creating a New ProcessBook................................................................................106 Book View Tabs.....................................................................................................107 Modifying a ProcessBook Title ..............................................................................107 Saving and Closing a ProcessBook ......................................................................109 Add ProcessBook Entries ......................................................................................109 Creating a Text Entry.............................................................................................110 Creating a Display Entry ........................................................................................111 Creating a Linked Display Entry ............................................................................112 Linked ProcessBook Entries..................................................................................114 Creating an Operating System Command Entry ...................................................114 Working Directory for Operating System Commands ...........................................117

Page iv

Arranging Entries for Easy Navigation...................................................................118 Moving Displays to Other PCs...............................................................................121 Importing Files .......................................................................................................122 Chapter 8: Building Displays.................................................................................................123 Designing a Display ...............................................................................................123 Drawing Area .........................................................................................................123 Searching for Tags ................................................................................................124 Changing Format Settings in an Existing Display .................................................132 Removing an Entry and Pasting It Elsewhere .......................................................132 Importing Files to a ProcessBook..........................................................................133 Moving a ProcessBook to Another PC ..................................................................134 Moving to Another PI Server..................................................................................134 Drawing Tools and Procedures .............................................................................135 Designing Trends...................................................................................................137 Designing XYPlots .................................................................................................152 Other Dynamic Symbols ........................................................................................160 Static Symbols .......................................................................................................168 Formatting Attributes .............................................................................................181 Working with Existing Symbols and Groups of Symbols.......................................188 Connecting Symbols..............................................................................................196 Layers within Displays ...........................................................................................209 Data Sets ...............................................................................................................216 ODBC.....................................................................................................................235 Module-relative Displays........................................................................................253 Chapter 9: Embedding and Linking ......................................................................................259 Overview of FactoryTalk Historian ProcessBook OLE Compound Documents ....259 OLE Automation in FactoryTalk Historian ProcessBook .......................................259 Object Linking and Embedding..............................................................................260 ActiveX Controls ....................................................................................................261 Example of Embedded and Linked Objects in a ProcessBook Display ................264 Icons vs. Graphics .................................................................................................264 Should You Link or Embed? ..................................................................................265 Embedding in ProcessBook...................................................................................265 How to Embed .......................................................................................................265 Windows Drag and Drop........................................................................................267 Linking to ProcessBook .........................................................................................268 Dynamic and Manual Updates of a Linked Object ................................................269 How to Edit, Update, or Break Links......................................................................269 How Links Are Stored ............................................................................................270

FactoryTalk Historian Site Edition ProcessBook User Guide

Page v

Contents

Re-establishing Links.............................................................................................270 Editing the Appearance of an OLE Object.............................................................271 Commands That Ignore OLE objects ....................................................................271 Placement of OLE objects .....................................................................................272 OLE Object Colors.................................................................................................272 Editing the Contents of OLE objects......................................................................272 Editing the Contents of an Embedded Object .......................................................272 Editing the Contents of a Linked Object ................................................................272 How to Delete an OLE Object from a Display .......................................................273 Displaying an OLE Object with an Icon .................................................................273 How to Switch Between an Icon and a Graphic ....................................................274 How to Change the Icon for an Object ..................................................................275 Sharing ProcessBook Displays with Other Applications .......................................276 How to Embed a New ProcessBook Display in Another OLE Application ............277 How to Embed an Existing ProcessBook Display in Another OLE Application.....278 How to Link a ProcessBook to Another Application ..............................................278 OLE Container/Server ...........................................................................................279 Updating and Editing Processbook Linked and Embedded Displays ...................279 Chapter 10: Using Visual Basic for Applications in FactoryTalk Historian ProcessBook281 VBA Toolbar ..........................................................................................................281 The Macros Dialog.................................................................................................282 ActiveX Automation ...............................................................................................282 What You Can Do with ActiveX Automation in FactoryTalk Historian ProcessBook ...............................................................................................................................282 Automation Vocabulary..........................................................................................283 Documentation for Script Writers...........................................................................283 Macro Protection Feature ......................................................................................283 Chapter 11: Troubleshooting Tips ..........................................................................................285 Display Can't Find Data .........................................................................................285 Trend Cursor Doesn't Appear................................................................................285 Trend Legend Doesn't Appear...............................................................................285 Cant Change or Save a Display ...........................................................................285 Is an XYPlot Updating?..........................................................................................286 Is an OLE Object in a Display Linked or Embedded? ...........................................286 Linked Object Data Isn't Updating .........................................................................286 ODBC Problems ....................................................................................................287 Chapter 12: System Administrator Notes ..............................................................................289 FactoryTalk Historian ProcessBook Connection to Windows NT or UNIX Servers ...............................................................................................................................289

Page vi

FactoryTalk Historian ProcessBook Connection to OpenVMS Servers................289 Read/Write Access for Users.................................................................................290 Machine Address ...................................................................................................292 SETUP.INI .............................................................................................................292 PROCBOOK.INI ....................................................................................................292 IMPPIGP.INI ..........................................................................................................297 Running VAX Programs through DECNet - Pathworks.........................................302 TCP/IP ...................................................................................................................303 WRQ's TCP Connection ........................................................................................303 FTP ........................................................................................................................304 Pathworks ..............................................................................................................304 SETUPProcessBook.LOG .....................................................................................304 Index ............................................................................................................................................305

FactoryTalk Historian Site Edition ProcessBook User Guide

Page vii

Chapter 1: Introduction
FactoryTalk Historian ProcessBook is a PC application for displaying plant information stored in the PI Data Archive or in relational databases. The PI Data Archive may be thought of as a database of values for each of the tags you have established for discrete data sources in your process or facility. The FactoryTalk Historian ProcessBook application contains one or more ProcessBooks, which are collections of 'display entries.' These display entries show your process data from one or more FactoryTalk Historian Systems as well as other static and dynamic information from outside sources such as schematic drawings, laboratory data, or specifications. Displays may 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. You can also include buttons that initiate other applications. You can share ProcessBooks among users, thereby eliminating the need to build duplicate displays. On networks, an unlimited number of users may access the same ProcessBook or display at the same time. The FactoryTalk Historian ProcessBook application also incorporates Microsoft Visual Basic for Applications (VBA), so that you can automate special activities or routine chores. OSIsoft produces several add-in products for FactoryTalk Historian ProcessBook, including PI BatchView and PI Statistical Quality Control.

ProcessBook
A ProcessBook file is a container for the information and analysis of the process you are monitoring. A ProcessBook may appear as either a tabbed book or an outline.
Note: The top bar of a ProcessBook window shows the file name, which ends in .piw, rather than the title.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 1

Introduction

Each ProcessBook has summary information, called Properties, that is reached from the File menu. The Author name is originally picked up from the Author field on the Preferences screen at the time the ProcessBook is first saved. You can change it. The Properties button leads to a secondary dialog, giving statistics about the view currently in the active window. If a display, rather than a ProcessBook contents page, has the system focus, similar properties are displayed.

Display
When you open an entry in a ProcessBook, the information that appears in the application workspace is shown in a "display window," usually called a "display." By using the small buttons with up and down arrows at the upper right of the display, the display can be resized to encompass either a part of the FactoryTalk Historian ProcessBook workspace or the entire FactoryTalk Historian ProcessBook window.

Build and Run Modes


When you work with a ProcessBook, you work in one of two modes, Run Mode or Build Mode.

Build mode is used to edit a ProcessBook and symbols within a display. Once the ProcessBook is built, Run mode is used to open entries and execute commands. Being in Run mode also keeps you from accidentally changing items in a display. You switch between modes by clicking the Run mode pointer (an arrow) or the Build mode pointer (a hammer), which are originally found on the Tools menu and the Drawing toolbar. Your preferred mode of operation is set as a default in your Preference settings.

Page 2

New Features of Version 3.0

New Features of Version 3.0


Enhancements for Building and Managing Displays

More Powerful Links


Links can now be configured to use relative paths first. So a group of related files can be

easily moved from one location to another (for example, for moving from development to production), or can be accessed through different paths at the same location (for example, for using the same set of files with FactoryTalk Historian ProcessBook and PI ActiveView). A virtual directory on a Web server can be accessed through the Web server or through a UNC path. There are no special distinctions between different path types (DOS, UNC, URL).
Files opened as URLs are now added to the Most Recently Used list in the File menu. For executable buttons, you now have the option to open the file using the default

operation or inside of FactoryTalk Historian ProcessBook. For example, if a button points to an .svg file, and .svg is associated with the Adobe plug-in for Explorer, you have the option of opening the file in Explorer or in FactoryTalk Historian ProcessBook. Layers of Symbols within Displays You can now build layered displays in order to logically group symbols. For example, when modeling a factory, the display can be segregated into plumbing, electrical, and structural layers. To only view electrical components, hide the plumbing and structural layers and only display the symbols on the electrical layer. Symbols may exist on more than one layer at a time.

Connectors for Symbols Symbols can be connected to each other by directional connectors (page 196), a specialized symbol type.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 3

Introduction

Troubleshooting Using the New Error Icons and Status Report Dialog

In the Status Bar at the bottom right of the FactoryTalk Historian ProcessBook window, there is a troubleshooting icon, either a green circle, meaning all objects are updating, or a red circle with an X, meaning at least one symbol is not updating. If you double click the icon, a Status Report dialog (page 80) opens, showing the status of each object. You can save this data to a file.

XY Plots
This version of FactoryTalk Historian ProcessBook introduces a new native symbol, XYPlot. XYPlot allows you to create a scatter plot comparing 2 or more tag values. Options include the ability to show a linear correlation line and the inclusion of a correlation coefficient on the legend. The XYPlot symbol provides tools similar to the Trend symbol including zoom, scroll, cursors and tooltips. This symbol is integrated with the IContextDataResolver interface.

Trend Enhancements
Tag values on trends may be differentiated at the sub-second level. The maximum number of traces on a plot is no longer limited to eight. The default value is 50. You can configure a color other than black for the first ten traces. You may use a logarithmic scale on a trend. Flags (page 81) for questionable, substituted, and annotated PI data can appear on your trends.

Other Symbol Enhancements


Flags for questionable, annotated, and substituted information in dynamic symbols Engineering units are now shown in Value symbols. Trends and values have configurable attributes. You can use a symbol from the Symbol Library as a Multi-State symbol.

Page 4

New Features of Version 3.0

Time Zone Settings


Formerly, all data on a display were shown with the Server time. Now you can set the desired time by display to reflect either Server time or Client time. This may be useful when the Server and the Client are located physically in different time zones or when there are multiple Servers in more than one time zone. For multiple trace trends, the time scale matches the server being used by the first trace. See Time Zones and PI (page 97) for more detail.

Custom Data Sets


Custom datasets have been enhanced in two ways:
Duplicate traces are now allowed within the same trend. This permits trending the same

information but with different placeholders.


A new interface, IDataProvider3, has been added. This interface provides for the

customization of the generic FactoryTalk Historian ProcessBook placeholder dialog box. The interface is only used if the custom dataset contains placeholders. The new interface contains methods to:
Display custom placeholder dialogs. Display custom column dialogs. Provide better integration with custom data set selection. Provide integration with the PI SDK.

Module-relative Displays
If you are using a Module Database to store information about your facilities, you can create a display in which symbols represent a part or parts of the modules in your Module Database. Then you can go from module to module at run time, changing the data source for the symbol dynamically and viewing current data. The Module Relative Display FactoryTalk Historian ProcessBook add-in has a context handler called Module Context. As a default, the add-in is loaded in ProcessBook at start-up. The add-in adds a Module Context menu item to the Tools menu. This menu item provides one submenu option, Add Modules.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 5

Introduction

For more information, see Module-relative Display Add-in (MRD) (page 253).

RtPortal Integration
You can save directly to .svg and load directly from .svg. FactoryTalk Historian ProcessBook supports direct editing of displays on a properly

configured SharePoint Server.


An .svg add-in now supports the XY Plot, Layers, Connectors, and NamedValues.

PI SDK Integration
FactoryTalk Historian ProcessBook has been updated to use the PI SDK (SDK), rather than the PI API. FactoryTalk Historian ProcessBook will handle a full range of PI Server data types, as shown in this table:
Point Type Digital How It Is Used Used for points whose value can only be one of several discrete states, such as ON/OFF or Red/Green/Yellow. Nearest equivalent to the PI 2.x Digital type. Used for points whose values are 15-bit unsigned integers (0 to 32767). Nearest equivalent to the PI 2.x Integer type. Used for points whose values are 32-bit signed integers (-2147450880 to 2147483647). PI reserves some values. Used for floating point values, scaled. The accuracy is one part in 32767. Nearest equivalent to the PI 2.x Real type. Used for single-precision floating-point values, not scaled. Used for double-precision floating-point values, not scaled. Used to store string data of up to 976 characters. PB Support As currently supported.

Int16

As Integers are currently supported Support negative Integer values As Floats are currently supported. As Floats are currently supported As Floats are currently supported Each string event represents an ad- hoc state in a series. Not supported. Shown as a time using the currently selected time format.

Int32

Float16

Float32 Float64 String

Blob Timestamp

Binary large object Used to store any type of binary data up to 976 bytes. Used to store values of type Timestamp. Any Time/Date in the Range 1-jan-1970 to 1-Jan-2038

Page 6

New Features of Version 3.0

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 7

Introduction

The new PI SDK login will honor either PI Users or PI Trusted users. There is support for single sign on. If a user does not have the appropriate trust/login information for a tag, the dynamic symbol will display an error. The status dialog will explain that the tag cannot be found on the server. The tag search dialog will also not show tags that the user is not authorized to read. Error handling has been improved. Any symbols that have error conditions will display an error indication. This indication will not require any user intervention for other FactoryTalk Historian ProcessBook functions to continue. FactoryTalk Historian ProcessBook uses the following PI SDK dialogs:
Connections Point Attributes Tag Search

When FactoryTalk Historian ProcessBook is connected to a system with a PI Server that is not version 3.3 or greater, the application will make adjustments as necessary. A ConnectUsingAPI setting has been added to the Startup section of the ProcBook.INI file. This was added to aid existing displays that rely on a PI API connection, as opposed to a PI SDK connection, to a PI Server.

VBA Automation Enhancements


The FactoryTalk Historian ProcessBook 3.0 automation model has been augmented with dockable windows. A dockable window can be populated with ActiveX controls and data. These windows can be free-floating or docked within the application. Please refer to the VBA Object Browser for more information on methods, properties, events and objects relating to dockable windows. The automation has also been enhanced to include layers with a display. Layers provide a mechanism for logically grouping symbols. For example, when modeling a factory, the display can be segmented into plumbing, electrical and structural layers. To only view electrical components, hide the plumbing and structural layers and only display the symbols on the electrical layer. Please refer to the VBA Object Browser for more information on methods, properties, events and objects relating to layers.

Composites The parent property of a symbol always returned the display that the symbol is a member of. Now, if the symbol is a member of a composite, the composite symbol is returned, not the display.

Page 8

New Features of Version 3.0

Custom Menu Items Through automation, new menu items can be created with underlying submenus. In addition, popup menus can be customized and appropriate action taken when the updated menu items are selected.

Dockable Windows The FactoryTalk Historian ProcessBook 3.0 automation model has been augmented with dockable windows. A dockable window can be populated with ActiveX controls and data. These windows can be free-floating or docked within the application. A dockable window consists of a collection of views in which a control and/or data is displayed. Views can be added to the dockable window using the Add method of the windows Views property. FactoryTalk Historian ProcessBook supports drag and drop functionality from a docked window to a display. The FactoryTalk Historian ProcessBook View menu now lists all available docked windows. In addition, floating docked windows can be "pinned" so that they do not disappear when they lose focus. Floating docked windows default to the "pinned" state. Refer to the VBA Object Browser for more information on methods, properties, events and objects relating to dockable windows.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 9

Chapter 2: Working with a ProcessBook

What Is a ProcessBook?
A ProcessBook is used to organize data from the FactoryTalk Historian System and other sources so that you can analyze the processes you monitor or the tasks you perform. A ProcessBook is a collection of individual displays of data and analysis. Every display has a title. 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. A ProcessBook and its displays are stored in a single file. Each ProcessBook has a distinct file name, ending in .piw.

Right Mouse Menu


When the cursor is within the FactoryTalk Historian ProcessBook workspace, the right button of the mouse displays a short menu of frequently used commands. For displays, the menu includes common functions such as Undo, Cut, Copy, Paste, Paste Special, Font, Color, LineStyle, and Symbol Attachments. Two choices, Properties and Enable Scripting, relate to VBA. Enable Scripting is used to make a static symbol into one that generates events. When scripting is enabled, the Scripting choice is inactive and the Properties choice is active. The Available Modules pane may be docked or hidden through the right mouse menu. When the cursor is over the toolbars or the Status Bar, the right mouse menu includes the available toolbars.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 11

Working with a ProcessBook

PI Server
When you build a display, you will normally include a number of tags that are dynamically linked to the Archive in the PI Server. The connection to the PI Server allows you to view process data at discrete points in time. Updating of your display occurs dynamically whenever the values in the Archive change.

Multiple Servers and Other Data Sources


You can connect to more than one PI Server through networked servers. This allows you to design displays that show data from multiple servers at the same time. PI Server may also retrieve data from outside databases via COM connectors and provide that data to FactoryTalk Historian ProcessBook displays.

Basic Facts About Displays and Other Entries


There are several types of entries within ProcessBooks. In Outline or Book view, each type except a text entry is shown with an icon:
Icon Name Text entry Description .A text entry can be used to label a section of related displays, or provide explanatory information within a ProcessBook.

A Display entry may also be saved as an independent file. The filename extension is .pdi

What Data May Be Included in a Display?


A display may contain data from any or all of the following sources:
PI Servers, including both point data (actual instrument readings) and calculated data Calculations from PI data Data obtained through the PI Data Archive by COM connectors and stored in outside data

sources
Other databases with ODBC connectivity Other databases with custom interfaces to FactoryTalk Historian ProcessBook

Page 12

FactoryTalk Historian ProcessBook Datasets

Spreadsheets, documents, schematics, graphics, photos, and other Windows applications

through OLE linking and embedding.


VBA code

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 initiate other applications.

FactoryTalk Historian ProcessBook Datasets


FactoryTalk Historian ProcessBook can plot data from relational databases through ODBC (Open Database Connectivity) functionality, which means that you can retrieve and display dynamic data from other ODBC-compliant 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 can be interfaced to FactoryTalk Historian ProcessBook through a VBA add-in and will update dynamically.

Analysis Tools
Analysis tools help you interpret and track data. For example, you can use values for a selected tag to plot a trend. Trends can be created and stored for future use, or created as needed. You can use a tool called a trend cursor to examine the value of a tag at a particular point in time. Other analysis tools include bar graphs, value points, and multi-state symbols that change color as the values they represent reach pre-set limits.

FactoryTalk Historian ProcessBook OLE


FactoryTalk Historian ProcessBook provides the capability to use OLE linking and embedding (page 260). 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. FactoryTalk Historian ProcessBook displays may also be incorporated in other OLE applications.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 13

Working with a ProcessBook

FactoryTalk Historian ProcessBook is an OLE Automation server. Programmers can write scripts that manipulate and retrieve PI data.

File Sharing Capability


Several users may access the same ProcessBook file at the same time. However, if one person makes changes to a particular display entry and saves the changes, then other users are blocked from saving changes in that display. This will protect against accidental overwrites. If a user has already changed a display, the second user who wishes to make changes to the display will receive an error message explaining that someone else has already edited and saved the display. The second user then has two options:
Save the changes under a different ProcessBook name, thus creating two ProcessBooks,

-or Close the ProcessBook and reopen it so that the new version of the display is shown.

Then make changes and save again. The name of the person who has made changes and saved the file most recently is displayed in the Summary Information dialog box, which displays if you click Properties on the File menu. This name is drawn from the Author field under Tools > Preferences > ProcessBook Preferences. If the Author field on the Start tab is blank on that person's PC, then the Author field on the Summary Information dialog will be blank.

Opening and Closing ProcessBooks


Starting FactoryTalk Historian ProcessBook
To use FactoryTalk Historian ProcessBook you will need to start the application, log in to the PI Server, open a specific ProcessBook, and open a display. 1. Either double-click on the FactoryTalk Historian ProcessBook icon on the desktop, or select the Start button, Programs, FactoryTalk Historian System, and then the application FactoryTalk Historian ProcessBook 3.0 from the submenu. 2. If security is not configured at your site, you will be automatically logged into FactoryTalk Historian ProcessBook. If security is configured, the PI Server Login dialog box is displayed within a few seconds. 3. Enter your PI user name or host user name and password (if security is enabled).

Page 14

Opening and Closing ProcessBooks

4. Enter the name of the server to which you want to connect. Your Network Administrator will have set up server names, often called nodes. 5. 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, you will still start FactoryTalk Historian ProcessBook, but will not be connected to the server. Whenever you open a display containing tags from a PI Server, the application will attempt to connect again and you may see the login dialog.

Properties of a ProcessBook
Each ProcessBook contains summary information. On the File menu, click Properties. The Summary Information dialog box is displayed. The Summary Information dialog 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 Author Description Extracted from the Author field on the Start tab in the ProcessBook Preferences dialog box at the time the ProcessBook is first saved. Note: You can change the Author field in either the Summary Information dialog box or the ProcessBook Preferences dialog box. Title Subject Keywords Comments Properties button Name of the ProcessBook. (Extracted from the original creation of the ProcessBook.) May be used to explain the title more fully. May be added at any time. Eventually there will be search capabilities associated with keywords. May be used for any text entry. You can revise this field at any time. Clicking the Properties button displays the FactoryTalk Historian ProcessBook Properties dialog box. This dialog box lists information about the view currently in the active window.

If you want to view the FactoryTalk Historian ProcessBook properties, then click the Properties button. The FactoryTalk Historian ProcessBook Properties dialog box is displayed.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 15

Working with a ProcessBook

Page 16

Opening and Closing ProcessBooks

The following table describes the fields in the FactoryTalk Historian ProcessBook Properties dialog box:
Field Name Title Created Description Extracted from the Summary Information dialog box. Original date and time the ProcessBook was saved. Note: If the ProcessBook file is moved to another machine, the original date and time will be preserved, although Windows Explorer will show the date and time the file arrived on the present machine. 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 box. Most recent revision date and time. Name of the person who saved the ProcessBook most recently. (Extracted from the Author field on the Start tab in the ProcessBook Preferences dialog box.) If this field is blank, the PC login name of the author is used. This is useful for tracking who made which revisions. Number of times the ProcessBook has been revised and saved. Total number of entries in the ProcessBook. Total number of operating system command entries in the ProcessBook.

Last Saved Last Saved By

Revision Displays System Commands

Opening a Specific ProcessBook


1. On the File menu, click Open. -orOn the standard toolbar, click the Open button. The Open dialog box is displayed. 2. Click the specific ProcessBook file (.piw) or display file (.pdi) you want to open. 3. Click the OK button.
Note: Depending on the settings in the ProcessBook Preferences dialog box, a default ProcessBook may open automatically when you start FactoryTalk Historian ProcessBook.

FactoryTalk Historian ProcessBook keeps track of the four most recently opened ProcessBooks or independent display files. Instead of using File > Open to reach the File Open dialog box, you may select a file name from the bottom of the File menu.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 17

Working with a ProcessBook

Page 18

Opening and Closing ProcessBooks

What You See: Book View, Outline View, or No ProcessBook


After your login is verified, the FactoryTalk Historian ProcessBook application workspace is displayed. Your application may be configured to open a ProcessBook file. A ProcessBook is a collection of displays. Displays are representations of your facility or data or both. A ProcessBook will appear in either book or outline view, depending on default settings. Book view resembles a binder with tabs and pages. Each page contains displays. Clicking the tab along the right side of the ProcessBook displays the first page of that group of displays.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 19

Working with a ProcessBook

Outline view lists all the displays in a hierarchical fashion on a single page that can be scrolled up and down.

Book View and Outline View

You can work in either view. Book view is a useful organizational tool when your ProcessBook has only a few dozen displays. If your ProcessBook is large and contains many displays, outline view is faster and easier to use. If no ProcessBook or independent display has been selected in your Preference settings you will need to use File > Open or File > Create to open or initiate a file.

Using Several ProcessBooks at One Time


You can work in several open ProcessBooks and/or independent display files at the same time. Open additional ProcessBooks using the File menu. Switch among them by using the Windows menu to select the ProcessBook title, or clicking inside a ProcessBook window to make it active, or switching among the open windows by pressing CTRL+F6.

Page 20

Opening and Closing ProcessBooks

Reducing ProcessBooks to Icons


To avoid clutter in your workspace, you can reduce a ProcessBook to an icon. Click the Minimize button. The icon is displayed at the bottom of your screen. Double-click the icon when you are ready to use it again.

Opening a ProcessBook from an Icon

You can place this button on a toolbar and use it to open a ProcessBook of your choice. 1. From View > Toolbars > Commands, select Supplemental toolbar. Drag the icon shown above to one of your toolbars. 2. In the Tools > Preferences > Start dialog, type the ProcessBook file name in the Symbol Library box and click OK. This will link the button to a ProcessBook. The default is Symlibry.piw, which contains a variety of simple industrial symbols. Then you can click the button to open the ProcessBook and drag or copy an object into a different display.

Closing a ProcessBook
When you are finished with a ProcessBook, you can close it by double-clicking the icon at the upper left of the title bar. Although you can have several ProcessBooks open at a time, your computer will perform faster if you close the ProcessBooks you don't need. Closing a ProcessBook frees some of your computer's memory and other resources so that other files may use them.

Quitting FactoryTalk Historian ProcessBook


If you have finished working in FactoryTalk Historian ProcessBook, quit by selecting Exit from the File menu. This automatically disconnects you from any servers and quits the application.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 21

Working with a ProcessBook

If you have changed anything in an open ProcessBook, FactoryTalk Historian ProcessBook will prompt you to save the changes.

Book View and Outline View of ProcessBooks


ProcessBooks may be seen in either of two views, Book View or Outline View. You may toggle between them.

Book View

In Book View, the ProcessBook displays as a loose-leaf binder. Tabs indicate major divisions in the ProcessBook. Each tab section has a heading, which may be any ProcessBook display. The display title is used as the tab name. A tab section may contain several pages of displays representing different types of information. 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 section. The boiler, the condenser, and the pump may be separate displays that are arranged underneath the summary display. Each of these displays may have several displays for their components.

Turning Pages in Book View

On the View menu, click Book. The top right corner of the page is divided into two small triangles. Click the upper triangle to move forward one page. Click the lower triangle to move backward a page. A dark gray triangle indicates there are no more pages in that direction. Click the tabs to move quickly between sections of a ProcessBook.

Resizing a ProcessBook Window to See Book View Tabs To resize a ProcessBook window, click and drag on the frame so 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 will be moved to new pages. You can move from page to page by using the dark gray triangles to move forward or backward a page at a time.

Page 22

Book View and Outline View of ProcessBooks

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.

Outline View

In Outline View, ProcessBook displays are arranged hierarchically on a page. Select Outline from the View menu 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 the displays in the outline. Hierarchies of entries may be revised by dragging entries from one location to another, or by promoting and demoting entries.

Collapsing or Expanding Outline View You can collapse or expand sections of the outline to view the list of displays in a meaningful manner. Click the black plus sign to the left of an entry to expand it. This shows additional displays that are subordinate to the selected display. Collapsed View:

Expanded View:

When expanded, subordinate displays are visible and the plus sign to the left of the display changes from solid to hollow. To collapse entries to a higher level in the hierarchy, highlight the top entry and click the minus button. Alternatively, highlight a section and use the plus and minus buttons on the Outline toolbar to collapse or expand it. Use the arrows to move an entry left, right, up, or down.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 23

Working with a ProcessBook

Use the numbered buttons on the Outline toolbar to collapse the outline to a specific level. For example, click 3 to collapse the outline so that only levels 1, 2, and 3 are visible. These buttons affect the entire outline, rather than a selected heading or level. Click All to view all nine levels. You can also change the font for each level in Outline View through the ProcessBook Preference settings (page 30).

Rearranging Entries in Outline View Click on the entry name and drag the entry up or down (not sideways) to a new location. A dotted line indicates the location of the entry you are moving. Alternatively, you can use the four buttons at the top left of the window as follows: Promote highlighted entry Demote highlighted entry Move highlighted entry up Move highlighted entry down

Saving a View of Your Displays


If you frequently work with several specific displays in a ProcessBook, open the displays and arrange them in the workspace as you would like them. Save the ProcessBook. When you reopen the displays, they will be in the same position as when you closed them.

Menus and Toolbars


Command Menus
The active components of menu bars change depending on where you are working. There are now five different collections of menu commands.
Menu Bar Default Function Displays when no documents are active

Page 24

Menus and Toolbars

Menu Bar Book Display View-Only Book

Function Displays when a FactoryTalk Historian ProcessBook workbook is active Displays when a FactoryTalk Historian ProcessBook display document is active Displays when FactoryTalk Historian ProcessBook is running in no-edit mode and a FactoryTalk Historian ProcessBook workbook is active. Displays when FactoryTalk Historian ProcessBook is running in no-edit mode and a display or workbook document is active.

View-Only Display

Toolbars may be selected or omitted, depending on your preferences, by choosing View > Toolbars or through the right mouse menu when your cursor is on menu names.

Toolbars
FactoryTalk Historian ProcessBook provides a variety of toolbars, including three major ones, called Standard, Formatting, and Drawing. Two context-related small toolbars are provided for convenience in editing displays and book menus. There is a Full Screen toolbar that can maximize screen area available to the display. There is a Time Range toolbar whose default configuration includes icons for Revert Time, Scroll Time, and Change Time Range. The Time Zone toolbar contains two buttons, Local Time Zone and Server Time Zone. These may be useful when the PI Server that provides data is not located in the same time zone as the client PC. When you select Local Time, the status bar at the bottom of the ProcessBook window indicates Client Time. Timestamps in the displays are given in local time. When you select Server Time Zone, the status bar indicates Server Time is shown in timestamps in the displays. The MRD Module Context toolbar allows you to assign a module context or add tag aliases to modules. The VBA toolbar provides access to the VBA automation environment. To display toolbars, click Toolbars on the View menu and select the toolbar name on the submenu.

Customizing Toolbars Toolbars may be displayed or omitted as follows:

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 25

Working with a ProcessBook

1. Click on the View menu. 2. Click Toolbars, which opens the Toolbars tab of the Customize dialog. 3. Check those toolbars you wish to display and click OK. Each toolbar may be dragged to new locations on the workspace or reshaped, if you prefer. 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. 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 FactoryTalk Historian ProcessBook can be selected by clicking a button on a toolbar. To determine the use of a button on a toolbar, pause the mouse over the button. A small text window will appear. Toolbars for view-only use are configured to omit unnecessary buttons. View-only toolbars and others can be specified in procbook.ini.

Adding Buttons to Toolbars You can change the icons that appear on the toolbars or create your own custom toolbar by selecting View > Toolbars. From the Commands tab of the Toolbars dialog, you can select a particular toolbar in the dialog and drag buttons to existing toolbars in your FactoryTalk Historian ProcessBook window. While the Commands tab is open, you can also drag buttons off of a toolbar to get rid of them from your window.

Preference Settings
You can customize the way FactoryTalk Historian ProcessBook will work for you by setting a number of Preference settings. The Preference settings determine, for example, how the ProcessBook entries look, what colors are available when you draw, and whether your ProcessBook opens in Book View or Outline View.

Page 26

Preference Settings

Note: Preference settings are stored in the file procbook.ini. Before you change the Preference settings, you may want to make a back-up copy of the procbook.ini so that you can restore FactoryTalk Historian ProcessBook to the original settings, if desired.

You can reach the ProcessBook Preferences dialog box by selecting Preferences from the Tools menu. As you click on different tabs at the top of the screen, you will see different sets of preference options. These defaults will be used each time you open FactoryTalk Historian ProcessBook. You can also set these features individually for displays such as trends.
Color determines the palette with which you build display objects. Book determines whether the ProcessBook opens in Book View or Outline View and

what font sizes are used in the Outline View.


Start determines defaults for the application, such as which ProcessBook of displays is

opened initially.
Trend settings include Display, Legend, and Plot Scale choices. Trend Elements include the default settings for plotting, such as plot and background

colors, marker types, line styles, etc.

Color Preferences
The Color tab is used for choosing the colors you can apply to lines and fills. The colors you choose will be in the color lists in the Format Color and Format Trend dialogs. For information on changing the colors within a specific display, see Changing Color Attributes. Although you can only use sixteen colors at a time, you can change the available colors or select a custom color whenever you wish.

Changing Color Preferences 1. Select Preferences from the Tools menu and click the Color tab. Your current 16 color settings are displayed.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 27

Working with a ProcessBook

2. Click the Choose Colors button if you want to change a color selection. 3. The Color dialog box is displayed.

Page 28

Preference Settings

Note: We recommend you use solid, not dithered, colors for custom colors. (Dithered colors include alternate pixels of white.)

4. You may select a new color by clicking any color point in the color swatch at the right. -orYou may select a new color by clicking any color under Basic colors. The color you have selected appears in the Color/Solid box. 5. Click the color swatch to change the Hue and saturation (Sat), and then move the slider in the color gradient to change the luminescence (Lum). 6. Click the Add to Custom Colors button, and then click OK to return to the Format Color dialog box. 7. Click OK to apply your color choice.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 29

Working with a ProcessBook

Book Preferences
The Book tab is used for changing the default view of the ProcessBook, as well as the fonts, sizes and styles with which each level of the ProcessBook is displayed. Changing Book Preferences 1. Select Preferences from the Tools menu and click the Book tab. 2. In the View Mode option box, select either Book View or Outline View as the view in which you want ProcessBooks to open. 3. To change the font used for a ProcessBook entry level, select the level and click the Choose Font button. The Font dialog box is displayed. 4. Select the font, font style, and size from the list boxes. A sample of the formatted text is displayed in the dialog box. Click OK. 5. Repeat this step for each of the entry levels you want to change. Click OK when you are satisfied with your selections.
Note: For Book View, only the first 3 font levels are used. The font for level 3 is used for levels 3 through 10.

Start Preferences
The Start tab is used for selecting the defaults used when you start the FactoryTalk Historian ProcessBook application. It is important to fill in the Author field so that your displays will be saved with your name as author. Notice that the default for the new scrolling option is on this dialog. A backup option lets you enable or disable backup files when saving a ProcessBook. When backup is enabled, the backup file is named to match the original but with a .bak extension. Value Attributes for dynamic symbols can be displayed in ToolTips. These are flags for questionable, annotated, or substituted data values. To improve performance, this preference should be turned off for tags that update very frequently, e.g., tags with an update rate of less then one second.

Page 30

Preference Settings

You can choose to use the Windows time format (configured through the Windows Control Panel) instead of the PI Time Format. The PI Time Format, which can report subseconds, is dd-Mmm-yy hh:mm:ss:sssss You will receive an invalid time format error message if a display is saved with a valid PI date/time format and then is opened in a FactoryTalk Historian ProcessBook application that uses Windows data/time format.

Changing Start Preferences 1. Select Preferences from the Tools menu, and click the Start tab.

2. In the Author box, type your name. Your name will be stored with each display and ProcessBook that you create.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 31

Working with a ProcessBook

3. In the ProcessBook box, type the path of the ProcessBook (or independent display) you want to use as the default. -orClick the Browse button and locate the ProcessBook (or independent display). 4. In the Symbol Library box, type the file name of the Book of Symbols you want to use as the default. -orClick the Browse button and locate the Book of Symbols.
Note: ProcessBook files end in .piw; independent displays in .pdi.

5. Select the Preserve Aspect Ratio check box if you want the display element sizes to change in proportion to the window size when you resize a window. 6. Select the Run Mode Bias check box if you will be working mostly with existing ProcessBooks and using the Run mode pointer. Clear the Run Mode Bias check box if you are building ProcessBooks and you want the cursor to remain in Build mode after drawing a new symbol. 7. Select the Create Backup Files check box to create backup files as you work. Whenever you save a file, the previous version is saved with a new extension, .bak. 8. Under Time, select the formatting option you prefer for labeling values and trends. It does not affect date entry in a display.
Note: If a display is saved with a valid PI date/time format and then is opened in a FactoryTalk Historian ProcessBook application that uses Windows data/time format, you will receive an invalid time format error message.

9. Under Zone Selection, select either Client or Server (Server is the default setting) to display and evaluate time strings.
Note: A time zone property has been added to FactoryTalk Historian ProcessBook displays. If you select Client, then FactoryTalk Historian ProcessBook will use the time zone setting of the machine running ProcessBook to handle time strings. If you select Server, then the time is presented with respect to the time zone of each PI Server which has tags being displayed.

10. Click OK to save the changes.

Page 32

Preference Settings

Scrolling Preferences 1. From the Start tab of the ProcessBook Preferences dialog, click the Scrolling button to change your scrolling preferences.
Note: Scrolling can be set separately for each display.

The Scrolling dialog box is displayed.

2. Under Run Mode and Build Mode, select the appropriate option (the settings for Run mode and for Build mode can be different):
On Off Automatic If you want the display to contain scrollbars all the time. If you never want scrollbars to appear. If you want scrollbars to appear when needed (this is the default setting for new displays).

3. Click OK to return to the Start tab of the ProcessBook Preferences dialog.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 33

Working with a ProcessBook

Trend Preferences
Your Trend tab is used for setting the default format for new and instant trends. You can select options such as line colors and data markers, and change the types of point information displayed with a trend. The changes you make do not affect existing trends, just new trends and instant trends. There are two tabs of Trend Preferences, one for determining what items appear on a trend (Trend tab) and one for determining what colors, LineStyles, etc., are used in individual traces (Trend Elements tab).

Changing Trend Preferences 1. Select Preferences from the Tools menu, and click the Trend tab.

The current format options are displayed.

Page 34

Preference Settings

2. Under Display, select or clear the following check boxes:


Autoscale Select this check box if you want trends to be scaled as tag values change over time. If you do not select this check box, then trends will use the Database scale for each tag. Select this check box if you want a title to display. Select this check box to display the vertical scale inside the axis. If you do not select this check box, then the vertical scale will display outside the axis.

Plot Title Vert.Scale Ins. Axis (Vertical Scale Inside Axis)

Grids Multiple Scales

Markers

Select the Markers check box if you want markers to indicate data points on the trend. If you do not select the Markers check box, then three markers will display on each line. These markers help you match a line to a tag.

3. Under Legend, select or clear the Tag Name, Description, Value, and Eng Units check boxes. 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, then the legend will not be displayed. If the height of the text in the legend is longer than the total height of the trend, then the items will be removed in this order: engineering units, tag name, then value. If the tag name is too long to fit in the legend, then it will not be displayed.

4. Your choices are reflected in the legend in the Sample area. Under Plot Scale, from the Style drop-down list, select Full time stamp, Partial time stamp, or Relative time stamp to indicate time on the horizontal axis. 5. From the Start and End drop-down lists, select a time. An asterisk (*) represents the current time. 6. Your choices are reflected in the legend in the Sample area. Click OK to apply the changes.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 35

Working with a ProcessBook

Trend Elements Preferences


The Trend Elements tab is used for setting the default format for new and instant trends (any changes you make will not affect existing trends). You can choose:
Plot Elements (pens, text, grids, and background) Markers associated with each pen Line colors, weights, and styles associated with each plot element Characteristics for instant (ad hoc) trends.

Changing Trend Elements Preferences 1. Select Preferences from the Tools menu, and click the Trend Elements tab. 2. From the Plot Element drop-down list, select the element that you want to change. 3. Choose the desired options from the Marker Type, Line Style, Color and Line Weight drop-down lists.
Note: You may select one of several line styles for each trace. If you select a solid line, you can also specify the line thickness. Depending on your operating system, if you select one of the dotted or dashed styles, the line thickness may be fixed. One of the line style choices is 'none,' which you may use, for example, when you wish to omit a grid line.

4. Repeat Steps 2 - 6 for the other elements. 5. Select the Multistate on AdHoc check box. If you want to draw an ad hoc (instant) trend of a Multi-State symbol. 6. In the Traces per AdHoc Trend list, select the number of traces you want to have per plot on an ad hoc (instant) trend. The default is 3. The maximum is 8. 7. Click OK to apply the formatting changes. Your choices will be reflected in the Sample box at the bottom of the window.

Page 36

Keyboard Shortcuts

Format Settings that FactoryTalk Historian ProcessBook Remembers from Last Time
Some format settings are not set from the Preferences option on the Tools menu. They are set while working on a display. FactoryTalk Historian ProcessBook remembers your most recent settings for these general formatting options: Font style and sizes
Line Style Line, fill, and background colors. Grid size

Keyboard Shortcuts
A keyboard shortcut is a combination of keystrokes to use for frequent actions. Several of these are already assigned in FactoryTalk Historian ProcessBook. They appear to the right of the corresponding menu command on the drop-down menus. FactoryTalk Historian 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.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 37

Working with a ProcessBook

How to Assign a Keyboard Shortcut


1. On the View menu, click Assign Shortcuts. The Shortcut Keys dialog box is displayed.

2. Under Select a macro, click the appropriate macro (menu item). The description for that item and its assigned shortcuts, if any, will be displayed. 3. Click the Create Shortcut button.

The Assign Shortcut dialog box is displayed.

Page 38

Keyboard Shortcuts

4. In the Press new shortcut key box, type the key you wish to use for the shortcut.
Note: If you choose a combination already in use, the dialog will tell you so. If you click OK, the previous assignment will be voided.

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 FactoryTalk Historian ProcessBook was installed, click the Reset All button, and then the OK button.

How to Remove a Keyboard Shortcut


1. In the Shortcut Keys dialog box, under Select a macro, click the appropriate macro (menu item). The description for that item and its assigned shortcuts, if any, will be displayed.

2. Under Assigned shortcuts, select the shortcut you want to remove, and then click the Remove button.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 39

Working with a ProcessBook

3. Click OK.

Printing

When you print from a ProcessBook, you can:


In Outline View, print a list of the ProcessBook contents or selected displays. In Book View, print a list of the entire book or a selected tab section. 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 icon. You can print the contents of the active window or if you select items within a display before you open the Print dialog box, then you can choose to print only those items.
Note: On a non-color printer, symbols will be printed in shades of gray, but trends will revert to black and white. On some printers, when you print a trend with cursors, the value and time stamp boxes of the cursor will 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.

Page Setup for Printing


You can select the particular printer, the orientation of the paper, the paper size, and the source within the printer of the paper. Use the Properties button to fine-tune the quality of output or the performance of the printer. The settings you choose in Page Setup become the defaults for all your printing.
Note: FactoryTalk Historian ProcessBook supports dot matrix, HP PCL (LaserJet), Postscript, and color printers. However, all Windows print drivers may not be compatible. If you are not sure if your printer is supported or you observe any printing problems, contact Rockwell Automation Technical Support.

Page 40

Printing

Previewing Before Printing

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 Print Preview from the File menu. 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. From the File menu, select Page Setup. The Print Setup dialog box is displayed. 2. Select the printer, orientation, and paper size and source.
Note: FactoryTalk Historian ProcessBook supports dot matrix, HP PCL (LaserJet), Postscript, and color printers. However, all Windows print drivers may not be compatible. If you are not sure if your printer is supported or you observe any printing problems, contact Rockwell Automation Technical Support.

3. Click the Properties button to select printer-specific options. Refer to your printer documentation for additional information about these options.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 41

Working with a ProcessBook

Online Help with FactoryTalk Historian ProcessBook


Online help with FactoryTalk Historian ProcessBook is available in several ways:
Online Help with Contents, Index, and Search tabs Help Buttons in dialog and message boxes What's This? Help, also called Context-Sensitive Help. ToolTips

Using Online Help


Click F1 or go to the Help menu and select FactoryTalk Historian ProcessBook help. The Help file appears in a separate window. Across the top of the Help window are several buttons, described below:

or The Hide button removes the Table of Contents; the Show button displays the Table of Contents.

The Back and Forward buttons retrace your route through topics you have seen.

To print a topic, click the Print button. When you click the Contents tab, you can see the Contents of the online Help file. Clicking a topic will take you to more information. Clicking the Index tab will show you an alphabetical list of items. You can begin typing the word you want to reach it quickly in the list. When you highlight a term and click Display, you will see either a topic or a list of topics. Clicking the Search tab will permit you to look for particular words or topics. Within topics, when a green word or phrase has a solid underline, you can click it to jump to a related topic. Click the Back button to return.

Page 42

Online Help with FactoryTalk Historian ProcessBook

If you are new to using the online Help system, you can get additional instructions by selecting Help on Help from the Help menu. When a green word or phrase has a dotted underline, you can click it to get a small window containing a definition of the term.

Help Buttons in Dialog and Message Boxes


When you click a Help button, it opens the online Help system at the information related to that dialog or message box. At the top of the Help window, you will find the usual Contents, Index, and Search icons on the tabs.

Context-Sensitive Help
You can get information about an item on the screen such as a button, display, or ProcessBook view. 1. Click the Help button on the standard toolbar. The pointer changes to a large question mark with an arrow. 2. Click the button, or area on the screen where you need help. Information about that feature is displayed.

ToolTips

If you put the mouse cursor over a toolbar button for more than a second, a small help hint, called a ToolTip appears next to the cursor, describing the function of the button. ToolTips also appear for symbols and controls within displays.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 43

Chapter 3: Working with a Display


FactoryTalk Historian ProcessBook provides tools for manipulating and analyzing the information shown in a display. For example, you can:
Display the point attributes of a tag Change the time range that is used for values, bars, trends, and Multi-State symbols Use Trend Cursor to see the value of the plotted tags at a specific point in time Create an instant trend

Elements of Displays
Displays contain a variety of individual items, including static elements, buttons, OLE objects, and dynamic elements.

Static Symbols
Static symbols are symbols that dont change, 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 or retrieve data and do not start any application. Text labels and flow lines are examples of static symbols. Other types include rectangles, circles, arcs, etc.

Dynamic Symbols
Dynamic symbols are values, bars, trends, XYPlots, and Multi-State Symbols (such as a pump) that change over time, 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.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 45

Working with a Display

Dynamic symbols may also report data from outside databases through queries. (See Chapter 5 for additional information.) If you rest your cursor on a value, bar, or Multi-State Symbol, you will see the current value, tag name, and time stamp. Icons for questionable, substituted, and annotated PI data can appear on your displays. Any point type can be used with any dynamic symbol. FactoryTalk Historian ProcessBook will handle a full range of PI Server data types, as shown in this table:
Point Type Digital How It Is Used Used for points whose value can only be one of several discrete states, such as ON/OFF or Red/Green/Yellow. Nearest equivalent to the PI 2.x Digital type. FactoryTalk Historian ProcessBook supports these as integers. Used for points whose values are 15-bit unsigned integers (0 to 32767). Nearest equivalent to the PI 2.x Integer type. Negative integer values are supported. Used for points whose values are 32-bit signed integers (- 2147450880 to 2147483647). PI reserves some values. Used for floating point values, scaled. The accuracy is one part in 32767. Nearest equivalent to the PI 2.x Real type. Used for single-precision floating- point values, not scaled. Used for double-precision floating- point values, not scaled. Each string event represents an ad- hoc state in a series. Used to store string data of up to 976 characters. Binary large object Used to store any type of binary data up to 976 bytes. Plotted as seconds over a given range. Not supported for logarithmic traces. Used to store values of type Timestamp. Any Time/Date in the Range 1-jan-1970 to 1-Jan-2038 PB Support As currently supported

Int16

As Integers are currently supported

Int32

Support negative Integer values

Float16

As Floats are currently supported As Floats are currently supported As Floats are currently supported Each string event represents an ad-hoc state in a series. Not supported Plotted as seconds over a given range. Not supported for logarithmic traces.

Float32 Float64 String

Blob Timestamp

Buttons
Buttons are elements that create a link to other applications, such as a calculator or word processor, or other ProcessBooks or displays.

Page 46

Display Point Attributes

For example, if you find you work in a particular display and frequently need to update a report with the information you've been 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 268) or embedded (page 265) into displays.

Display Point Attributes

A tag, which may also be called a point, is any measurement or calculation that is received or generated periodically. It can be transmitter readings, manual inputs, status, or control limits. The configuration information for a point is stored as a list of attributes. You can display this list of properties for any dynamic symbol. The Point Properties dialog box displays the attributes and snapshot values of PI Points. You may also see properties of dynamic symbols in Build mode through the right-click menu. 1. Using either the Run mode or Build mode pointer, click the dynamic symbol. 2. On the standard toolbar, click the Tag Properties button. -orClick the Pt. Attr. (Point Attributes) button if you are in the Tag Search dialog box. The Point Properties dialog box is displayed. 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, each tag may be selected from the drop-down list or you may use the up and down arrows on your keyboard to scroll through the tags. (See Appendix C, "Point Database" for an explanation of the point properties.) The Point Properties dialog box contains the Categorized tab and the Alphabetic tab.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 47

Working with a Display

The Categorized tab displays the attributes categorically. The following categories are always displayed: Archive Classic Display Overview Security System

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 will be 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.

Managing Displays and Independent Display Files


Opening a Display
Use any of these procedures to open a display from either Book View (page 22) or Outline View (page 23) of a ProcessBook: 1. Click on the display title, then on the New button to activate the selected display into a new window. 2. 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 will open. 3. With the Run Mode pointer, double-click the display. The display will open and will appear within an existing window, if possible. 4. Click and drag the display title to an unused area in the application workspace and release 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 will close that display while opening the dragged display. 5. 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

Page 48

Managing Displays and Independent Display Files

than one display open, it will replace 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 they were saved.

Browsing a Display from Internet Explorer


You can click a .pdi file and look at it in Internet Explorer.* FactoryTalk Historian ProcessBook menus and toolbars appear in the Internet Explorer window. This is similar to embedding a display in Excel, except that the display becomes the entire Internet Explorer document. The display will be updated within the same limits as it would within a ProcessBook. * Internet Explorer 4 or greater and FactoryTalk Historian ProcessBook 2.2 or greater are required.

Resizing a Display
You may want to resize the window to make it larger or smaller. You may also want to change the size of the drawing within the window. To resize the window to fill the monitor, click on the Maximize button. 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. If you have your Preference setting for Preserve Aspect Ratio check box selected, the contents of the display will 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.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 49

Working with a Display

If you want the display to fill the entire screen, click the Full Screen button on the Full Screen toolbar. Other toolbars will vanish and the display will enlarge. When you wish to see your toolbars again, click the Full Screen button again. A default keyboard shortcut of F11 also toggles between Full Screen and Normal presentations. You can customize the Full Screen toolbar to contain other buttons you may wish to use with a Full Screen display.

You can also use the Zoom command to change the size of the drawing within a display window. On the View menu, click Zoom. The Zoom dialog box is displayed. 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. 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 will resize so that the items you selected take up the entire window. OLE objects will not be included, however. There is also a zoom level combo box on the standard toolbar. This will allow you to enter or select a scale factor or choose 'Fit All.'

Searching for a Specific Display


1. Open the ProcessBooks you want to search through. 2. From the Tools menu, select Display Search & Run. The Display Search dialog box is displayed.

Page 50

Managing Displays and Independent Display Files

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. -or5. In the drop-down list, click Browse, and then locate the appropriate folder. 6. Select the Look in subfolders check box (optional). 7. Click the Search button. 8. The search results are displayed under Results. 9. Under Filename, click the display you want to open and then click OK. 10. The display is opened.

Reducing a Display to an Icon to Save Space


If you find your work area cluttered with many open displays, you can reduce a display to an icon by clicking its Minimize button. Even though, the display is minimized, it continues to be updated with information from the PI Server but the results are not shown until the window is opened. When you want to use it, double-click the icon.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 51

Working with a Display

Saving ProcessBook Displays


A display may be saved within a ProcessBook or as an independent file. If you use the Save command on the File menu, the display will be saved within the ProcessBook. If you select Save As from the File menu, you will be able to choose one of six formats from the "Save as type" drop-down box. The default is .pdi:
File Format Display file SVG file for Web use JPG-JPEG-JFIF compliant 32-bit Bitmap Windows Metafile CompuServe Portable Network Graphics Extension .pdi .svg .jpg .bmp .wmf .png

If you select the display file format, .pdi, your display will become an independent file that will update under certain circumstances and that can be browsed via Internet Explorer. If you select .svg, this will become the default file type when saving files later. FactoryTalk Historian ProcessBook 3.0 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).

Closing a Display

To close a display when you have finished working on it, select Close from the File menu. If you've made changes to the display, the Save dialog box is displayed, asking if you want to save changes before closing.

Opening 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. Click the

Page 52

Trends

New button at the bottom of the list of displays. Each display or linked display is opened in your workspace.

Managing Multiple Open Displays


Just as you can work with multiple ProcessBooks, you can have multiple displays open in the work area at a time. To make a display active, click in the display window or press CTRL+F6. The display is moved to the top so you can work on it. You can switch to a different open display by selecting the title from the Window menu. If you cannot see all the open displays, click Window and then Cascade. The open displays will be cascaded down the screen so that you can select the title you wish to move to the top.

Opening Independent Display Files


Independent Display Files use a .pdi extension in the file name. When you click on a display file in Windows Explorer, a copy of the FactoryTalk Historian ProcessBook application installed on your PC will open, just as it would if you clicked on a .piw file. Then the independent display will appear.

Saving Independent Display Files


When a display is in focus, you can choose to save it as an independent file, completely separate from the ProcessBook where it was originally constructed. These independent files have a .pdi extension and are created by using the Save As command. The display files are called PI Display Documents, rather than ProcessBooks. When you select Save As and provide a file name, the display inside the ProcessBook is closed and the independent display that is created retains the focus of the application.

Trends

A Trend is a type of dynamic element that lets you plot values against time. Trends may show more than one plot and may be formatted in a variety of ways. Trends will update if they are set up to reflect no more than a pre-set limit, usually 24 hours.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 53

Working with a Display

Jagged traces at the right of a trend indicate snapshot values; these can be smoothed by clicking Revert.

How Trends Refresh


If the right-hand time of the trend is current (*), Trend Cursor is off, and the time span of the trend is one day or less, then the trend is updated whenever information changes and is sent from the factory instrumentation to the PI Archive. You will note a vertical dashed line on the right edge of the trend. If the information has not changed at the instrumentation sensor, the trend shows a flat line from the last update to the current time. If the trend is longer than one day, you can force a refresh by clicking the Revert button on the Standard toolbar.
Note: If desired, the FactoryTalk Historian System Manager can configure the one-day limit to another interval.

FactoryTalk Historian 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 refresh according to a stipulated refresh rate.

Instant Trends
You can create a trend on an ad hoc basis for tags represented by values, bars, or Multi-State Symbols in a display within a ProcessBook. Instant 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 instant 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 for the instant trend.
Note: You can build a trend display before you open any displays.

If you create an instant Trend Display and then choose to save it for future use, it will appear on the Book or Outline View as subordinate to the original display.

Page 54

Trends

How to Create an Instant Trend


To create an instant trend for a specific tag or tags, select Run mode. 1. Select the dynamic symbol representing the tag, such as a bar, value, or Multi-State Symbol. To select more than one dynamic symbol, hold down the Shift key while you click them. 2. Select the Trend Display tool.

A new display window is opened, and the trend is created automatically for the selected symbols, using the default format and time range. The trend is added as a display to the ProcessBook, subordinate to the current display. It is given the unique name Trend Display#, where # is a number. The plot title is "Ad Hoc Trend." - or -

Select the Trend tool. The mouse pointer changes to a trend pointer. Click in the 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.

Saving an Instant Trend Display


If you create an instant trend display and wish to save it for future use, then you must use the Save or Save As command before you close the instant trend. Otherwise, it will disappear when you close it. There are several options:
The instant trend display may be saved as an independent display, by clicking it and

using the Save As command with a .pdi filename extension.


If you had a display open when the instant trend was created, the instant trend will be

saved as a subordinate of the display, by using the Save command.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 55

Working with a Display

You may save an instant trend as another file type, such as a bitmap (.bmp) file, using

Save As.
Note: You cannot save an instant trend from view-only mode.

Page 56

Trends

Trend Scale
The Trend Scale dialog box displays when you double-click the vertical axis of a Batch or ProcessBook trend in Run mode. It can also be reached from the View menu. This dialog provides easy access to change the vertical scale for each tag in a trend. If the trend is defined through a Data Set, only the Autorange and Absolute options are available for the Maximum and Minimum scale settings.

Trend Scale dialog

1. In Run mode, double-click the vertical axis. 2. Select Single Scale or Multiple Scales. 3. If you are using Multiple Scales, then select from the Tags drop-down list, the tag for which you are setting the vertical scale. 4. Select Autorange, Database, or Absolute options for the Maximum and Minimum values of the vertical scale.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 57

Working with a Display

If you want to set the following load behavior: Autorange

Then select this check box to: Automatically select a vertical scale depending on the minimum and maximum tag values between the Trend start time and end time.

Database

Select a vertical scale depending on the Zero and Span tag attributes as configured in the Point Database for the selected tag. The minimum is zero; the maximum is Zero plus Span. For digital tags, Minimum is 0 and Maximum is the number of digital states minus 1. Refer to the PI Reference Manual for additional information on tag attributes. Enter your own Maximum and Minimum values for the vertical scale of a selected tag.

Absolute

5. If you have selected the Absolute option, then type in the Maximum and Minimum values of the vertical scale in the adjacent boxes. 6. Click OK. The modifications made to the trend through use of this dialog will not affect the stored settings of the trend. To return the trend scale to its original settings, click the Revert button.

Trend Analysis Tools


FactoryTalk Historian ProcessBook provides a number of tools for analyzing or monitoring the data in a trend.
Trend Zoom lets you use the mouse to drag a box around the data you would like to

expand.
Trend Expand temporarily expands a trend element so that it occupies the entire display

window.
Trend Cursor shows you the value of the plotted tags at a specific point in time.

Trend Zoom Dialog Trend Zoom lets you expand or contract the time scale of a single trend element. 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.

Page 58

Trends

Trend Zoom 2x In or Out You can use the Trend Zoom 2x command (View menu). Trend Zoom 2x either reduces or multiplies the time range by a factor of 2. In other words, if your time range is 8 hours, Trend Zoom 2x In divides the time range by 2 and displays the trend for a 4 hour time period. Trend Zoom 2x Out multiplies the time range by 2 and displays the trend for a 16 hour time period. 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 59), for more information on trend cursors.

Expanding a Trend When you double-click within a trend element using the Run Mode pointer, the trend is redrawn so that it occupies the entire display window. Double-click again to reduce the trend to its original size. While the trend is expanded, the Drawing toolbar is disabled. If you switch to another display, the Drawing toolbar will work there. All the descriptive information (Title, Tag Descriptor, Tag Value) is shown on an expanded trend.

Trend Cursor

A trend cursor lets you to 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.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 59

Working with a Display

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.

Adding a Trend Cursor or Multiple Trend Cursors

1. Notice whether the timescale is displayed at the bottom and the time stamp is displayed at the upper right. If not, the trend rectangle may be too small to use Trend Cursor. Enlarge the trend. If the time stamp does not appear, reformat the display format to show it. 2. With the Run mode pointer, click the Trend Cursor button or, on the View menu, click Trend Cursor. An indented icon in front of the command indicates that trend cursors are on. Then, at the right edge of the trend, when the mouse pointer changes to a double-headed arrow, click the vertical line of the trend cursor and drag left. - or Move the mouse pointer over the left axis of the trend. The pointer changes to a trend cursor symbol. As you drag to the right, a new trend cursor is added to the trend. 3. Move the trend cursor back and forth across the trend. As you move it, the time stamp, status, and value are displayed in boxes at the top right of the trend. 4. When you release the cursor, the values appear in boxes at the top and bottom of the cursor. You can add additional cursors by grabbing the trend cursor icon at the left axis.

Removing a Trend Cursor Click the Trend Cursor button, or, on the View menu, click Trend Cursor. To remove one trend cursor but not all of them, click the trend cursor and drag it to the left or right off the trend.

Trend Appearance
A trend appears according to the format established in the Preferences settings established from the Tools menu. You may override this format by selecting the Trend Formatting (page 141) button. Usually, the title of the trend is shown at the upper left, and the current timestamp is shown at the upper right. The selected tag names, current or end value, and engineering units are displayed at the right.

Page 60

Trends

Grid Lines and Labels Trends that you draw will be formatted according to certain defaults. On the Trend Elements tab in the ProcessBook Preferences dialog box you can create your own default format for new trends. You can set options like line colors and point markers, and set the types of point information included with a trend. Grid Lines Horizontal and vertical grid lines align with even units (whole numbers) on the scales. Grid lines for the vertical scale line up with whole numbers at intervals of 1, 2, 5, 10, or powers of 10 times those intervals. Grid lines for the horizontal scale line up with time intervals such as weeks, days, hours, minutes, etc. The lines then scroll as time passes on an updating trend. Grid Line Labels You can configure the labels for the vertical scale using single or multiple scales and you can place these labels on either the inside or outside of the vertical axis:
Single Scale Multiple Scales The union of the ranges for all the pens appears in the label. The range for each pen in the trend appears in the label.

You can configure the labels for the horizontal axis using a full timestamp, partial timestamp, or a relative timestamp:
Full time stamp Displays a complete timestamp for the start and end times. The time range of the trend is in the middle of the horizontal axis.

Partial time stamp Labels most grid lines in the units of the horizontal range. Displays the full time stamp for the end time of the trend next to the plot title. Relative time stamp Displays the offset from the right time limit in weeks, days, hours, etc. and the full time stamp for the end time of the trend next to the plot title.

Note: Labels for the grid lines are displayed unless the trend rectangle is too small.

Vertical Scale Grid Lines Vertical grid lines are shown in scale intervals of 1, 2, 5, 10, or powers of 10 times those intervals. The vertical axis at the left is scaled by one of four methods:
Autorange scale

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 61

Working with a Display

Database scale Logarithmic scale Manually Defined scale

Autorange Scale The vertical 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 will be recalculated accordingly. For example, if the original vertical scale ranged from 5 to 100, but the new data has a high of 103, then the new plot will show 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 vertical scale is calculated from the highest and lowest values for all the plots. 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 will therefore be based on making the minimum and maximum values 3 to 9. Logarithmic Scale If you prefer a logarithmic scale, check this option. This will be disabled for digital or integer tags. Manually Defined Scale When the trend is designed, an arbitrary vertical scale may be chosen.

Single and Multiple Scales for the Vertical Axis Vertical scales are labeled whenever there is enough room. These labels can be configured with either single or multiple scales. For a single scale label, the union of the ranges for all the pens appears.

Page 62

Trends

For multiple scale labels, the range for the first pen appears next to the vertical axis. Ranges for the other pens are displayed in increasing distance from the vertical axis in the order the tags are listed at the upper right of the trend.

Horizontal Scale Grid Lines Grid lines for the horizontal scale line up with whole units of time, such as days, hours, minutes, etc. On a trend that receives updates, the grid lines scroll as time passes. For an updating trend, the most recent time is indicated by a dotted vertical line. Labels for the horizontal axis can be configured in one of three ways:
Full Timestamp Partial Timestamp Relative Timestamp

Full Timestamp Full Timestamp labels the left and the right time limits with the date and time. When space permits, the elapsed time between these lines is also shown. Partial Timestamp Partial Timestamp labels each grid line in whole units, such as hours. For example, the grid lines might be labeled 9:00, 10:00, and 11:00. Relative Timestamp Relative Timestamp labels 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.

Continuous and Staircase 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 a horizontal line and a vertical line for the tag (staircase trace).

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 63

Working with a Display

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 or legend, the text translation is displayed (for example, ON or OFF). Staircase traces are used for points from Open VMS FactoryTalk Historian Systems that have a Resolution Code of 4 and for points from PI Server that have a Step Flag set to TRUE. ODBC queries may produce either curves or staircase traces, depending on the Stepped Plot check box setting in the ODBC Data dialog box. For more information on point types, see Point Attributes (page 84).

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, and bad data markers. At least three markers are shown on a trace, unless the trace 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 will be 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 more than 200 values to plot, actual data markers are omitted and trace markers are used instead. Trace markers are also used if your trend formatting preferences do not specify Markers. Trace markers help you identify the legend information for each trace; they do not indicate actual plot values. Up to 3 trace markers are used per trace. X Markers When a value is outside the limits defined in the trend format, it is plotted as over- or under-range. When a value is out of range or has a bad value, it is not plotted. An X marker is placed on the trend at the beginning and end of the time when data were 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.

Page 64

XY Plots

XY Plots
Conceptual Overview of XY Plots

One way to measure the efficiency or quality of a process is to compare collected data against a known quantity. A chart that plots a relationship between validated data (for example) and new data can help a process engineer determine whether adjustments may be needed. This type of chart, an XY chart, can be used to quickly determine whether the expected correlation exists. Data values from the newer data that vary greatly from the optimized data may indicate a very specific problem. In other instances, one may wish to compare sets of data to determine their relationship (for example, do they increase at the same rate? Or, does one value increase as the other decreases?). An XY plot shows a correlation between one or more paired sets of data. On an XY plot (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

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 65

Working with a Display

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:

Perfectly correlated

A third plot is somewhat correlated:

Somewhat correlated

In the case of the third plot, a 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

Page 66

XY Plots

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 correlation 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.

Ad-hoc XYPlots

You can draw an XYPlot in Run mode on an ad hoc basis. Click the XYPlot icon to begin and follow the procedure described in Drawing an XYPlot (page 152).

Linear Regression by Least Squares


The best-fit correlation line is a straight line that attempts to summarize the trend of the points. This line may be shown on the XYPlot legend. The best-fit line has the formula:

y = mx + b
Where m is the slope and b is the offset. To calculate m, we use the following equation:

n n n N xi yi xi yi i =1 i =1 m = i =1 2 n n 2 N xi xi i =1 i =1

To calculate b, the following equation is used:

b=

y m( x )
n

Once m and b are known, the value of y that intersects the best-fit line can be calculated.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 67

Working with a Display

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).
Note: Bad data points are not included in this calculation.

r=

1 n ( xi xmean )( yi ymean ) n 1 i =1 sx s y

Standard deviation(s) is calculated using the following formula:

1 n s= (xi xmean ) n 1 i =1

The mean is the arithmetic average.

Interpreting an XY Plot
In FactoryTalk Historian 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 scrolling is used on an XYPlot symbol, all tags time ranges are changed to support the scroll duration.

Page 68

XY Plots

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.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 69

Working with a Display

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. Plot values may also be seen by double-clicking the title bar (Plot-O in the above illustration) and choosing Raw Data, rather than Statistics.

Zoom/Revert Functions
You may wish to enlarge a portion of an XYPlot temporarily by using the Zoom feature.

Enlarging the whole plot to fill the display window 1. In Run mode, double-click the plot. 2. To reduce it to the original size, double-click it again. It will not update while enlarged.

Enlarging a small area of the plot 1. Place the mouse cursor on the upper left corner of the area to be zoomed. 2. Hold the left mouse button down while dragging a rectangle to cover the appropriate area. When you release the mouse, this area is enlarged to the borders of the original plot.

Page 70

XY Plots

Original plot

Drag Zoom Completed

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 71

Working with a Display

Note: The zoom area must be smaller than the plot area and cannot include the outer 20% 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 Revert to return the plot to its original appearance.

Change Time Range Feature

1. On the View menu, click Time Range to launch the Change Time Range dialog box. -orOn the Time Range toolbar, click the Change Time Range button. All tags are affected when you change the range in this dialog box. 2. Click Revert to return the plot to its original appearance.

Page 72

XY Plots

Raw Data Values and Statistics


An information dialog is provided that allows the user to view and export raw data values as well as various statistics, such as the mean and standard deviation of each tags data. To open the XYPlot Details dialog box, be sure you are in Run mode and double click on the title of the XYPlot. The Statistics dialog appears.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 73

Working with a Display

In the Options drop-down list, there is a statistics choice and a raw data choice. The dialog box above shows the statistics option. Below is the raw data option.

On each of these pages, you can save the data to a text file. Click the Save Data to File button and enter a file name via the Windows Save As dialog. The data is saved to the file in the following format: Tag, <tag name> Start Time, <start time> End Time, <end time> Count, < number of points paired> Mean, <mean> STDEV, <standard deviation> Data Type, <data type>

Page 74

XY Plots

Index, Time, Value, Status <index>, <time>, <value>, <status> <index>, <time>, <value>, <status> Tag, <tag name> Start Time, <start time> End Time, <end time> Count, < number of points paired> Mean, <mean> STDEV, <standard deviation> Correlation, <correlation coefficient> Slope, <slope> Intercept, <intercept> Data Type, <data type> Index, Time, Value, Status <index>, <time>, <value>, <status> <index>, <time>, <value>, <status> Etc.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 75

Working with a Display

XY Plot Cursors
The cursor for an XYPlot includes both a horizontal and 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 it into the plot. In the XYPlot below, you can see an XY cursor at the Y axis that is not yet intersecting any points on the plot.

You can also see an XYCursor that was dropped on a point. The X and Y values are displayed 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 will snap to the nearest point.

Moving the XYCursor from Point to Point Once you have initiated an XYCursor and dropped it on a point, you may use the arrow keys to move from point to point in time order. For example, moving the right arrow will move the cursor to the point that is plotted immediately after the current point in the same series. The left arrow moves the cursor to the point that is plotted immediately before the current point in the same series. The up arrow moves the cursor to the first point in the previous series. The down arrow moves the cursor to the first point in the next series. The cursor looks the same when it is dropped.

Page 76

XY Plots

The information on the XYCursor point pair is shown in a box on each axis. If the tags had been digital or string, the text value would be shown in the box rather than a numeric value. Placing the mouse cursor over one of the cursor boxes shows the time of the point.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 77

Working with a Display

Bad Status Indicators


For a bad status code on a measurement, connecting lines are interrupted with Xs before and after the bad data point(s). If a single point of a pair contains a bad status, an X will appear on the axis of the good point at its value. If both points of a pair contain bad statuses, an X will appear at the origin of the plot. The XYPlot symbol supports Questionable and Substituted indicators.

Out of Range Indicators


When a point on the XYPlot falls above or below the X or Y scale range, it is not visible. This may be because the plot is zoomed or because the scales have been set within a certain range that does not cover the actual data. In order to indicate there is a point outside of the visible area, an X is used. By default, a straight line connects the points in the order that they are plotted. This line attempts to connect hidden points as well. An X is placed at each position where this line crosses the top or bottom of the plot area.

Too Many Points


When an X Tag has too many points to show on the plot, the following error message will appear and no points will be shown. The maximum number is 10,000 points.

Page 78

Other Dynamic Symbols

Other 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. The PI Archive uses three point types or value types:
Real or floating point values can be positive or negative and have decimals. Integer values are positive integers. Digital values are strings describing discrete states such as On or Off.

Multi-State Symbols

A Multi-State Symbol is a symbol that changes color based on the value of a tag. For example, you may have a symbol showing 2 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.

Bars

A Bar shows the current value of a tag as compared to a specified range of values.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 79

Working with a Display

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.

Run Mode Pointer


The Run Mode pointer is used primarily for opening and executing displays and their associated commands. To obtain a Run Mode pointer, on the Drawing toolbar, click the Run button, or on the Tools menu, click Run. The mouse cursor appears to be a small arrow.

Status Report for Dynamic Symbols


The Status Bar at the bottom of the FactoryTalk Historian ProcessBook application shows whether dynamic symbols in a display are updating. The Status icon is a green circle if there are no errors. It is a blue circle containing a ? if the display shows questionable data or a yellow arrow for substituted data. It contains an X if a dynamic symbol is reporting bad data (or shutdown status). As you shift focus from one display to another, the icon may change. If you shift back to the Table of Contents, the status icon remains from the last display in focus. or

Page 80

Status Flags for Unusual Data

The Status Report dialog appears when you have a display in focus and double-click the Status icon. This report lists all the symbols in a display, both dynamic and static. For dynamic symbols, you also see the tag to which the symbol is connected and, if it is shutdown, a message. You can sort the list by any of the column headings.

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.

Status Flags for Unusual Data


In addition to the Error indicator for dynamic symbols shown in the Status Bar (page 80), FactoryTalk Historian ProcessBook has three types of flags to indicate that the data is valid but additional information is available. Each dynamic symbol can display a flag when there is additional status information available. When you hover the mouse over a flagged symbol, you will see a tooltip with the status message. In trends, status messages will appear to the right of the tag values in the legend.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 81

Working with a Display

These flags are shown below:


Questionable - indicates that there is some reason to doubt the accuracy of the value. Annotated - indicates that there is a comment about a value. Text annotations are shown in symbol tool tips. Future versions of PB will provide a mechanism to enter and view annotations. Substituted - used 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. If you clear the Show Value Attributes checkbox in your Start Preferences, you will not see these flags. You might disable the flags to improve ProcessBook performance if you have very high speed sub-second data.

Using the Available Modules Window


The Available Modules window appears when your display includes a dynamic symbol (trend, value, etc.) associated with the PI Module Database. It allows you to shift from one module or context to another as the source of the dynamic data in your display. The current module being used is highlighted in the Available Modules window. Click another module to shift the focus. Your display will reflect different data in its dynamic symbols. If a dynamic symbols configuration contains an alias or property not supported by the selected context, NO DATA is displayed for that symbol. The label at the bottom of the Available Modules list provides the path in the module database for the current module.
Note: When you shift focus from a display to a ProcessBook, there will be no available modules listed.

Page 82

Chapter 4: Points and Data

PI Data Archive
The PI Archive can be thought of as a time-series database that collects, stores, and retrieves numerical and string data. The Archive resides on a host computer and is connected to your PC via the PI Server and your network. When you open a display containing dynamic symbols, FactoryTalk Historian ProcessBook retrieves data from the PI Archive. While this is happening, the cursor changes to an hourglass and the message Accessing PI Archive is displayed on the Status Bar. Sometimes the retrieval is so quick that the message is not seen. FactoryTalk Historian ProcessBook also notifies the 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 Archive. At a stipulated scan rate, usually 5 seconds, this new information is sent to the display and all the new values are added to the trend traces. This is true even if you reduce the display to an icon. If you open a display but are not connected to a PI Server, FactoryTalk Historian ProcessBook automatically tries to connect to the default server. If multiple servers are accessed, the application tries to connect to each disconnected server used in the display. The message Attempting to Connect is displayed on the Status Bar. If security is enabled on the server, you may need to log in to the server. Information on configuring multiple servers is given later in this chapter.

Point Database Overview


A point is any measurement or calculation that is received or generated periodically. Points can be transmitter readings, manual inputs, status, control limits, etc. Points in the Point Database are created, modified, or deleted using utilities on the PI Server node.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 83

Points and Data

Point Attributes
The configuration information for a point is stored as a list of attributes. Some attributes are assigned by the user and some by the system. Additional information is found in PI Server for NT and UNIX.

User-Assigned Attributes
Tag Name
The tag name is the unique name used to identify the point. Tag names may be up to 80 characters long. They may include letters, numbers, and spaces. PI Servers on OpenVMS may have a second name, which is limited to 10 characters plus two delimiters. Tag delimiters separate the tag name after the second character and after the eighth character. Tag delimiters are site-dependent. Most systems use a colon (:) and a period (.) as delimiters. Many systems use a hyphen (-) as the first delimiter. Either or both delimiters may be null. Tag names may not contain the following characters:
* ? asterisk and question mark (these are reserved for use as wildcard characters) " ' single and double quotes (these are used to denote tags in expressions) the delimiter characters: colon and period (system-specific) non-printable characters (control characters)

Tag names are not case-sensitive. Lower-case alphabetic characters are converted to uppercase. While any tag name that meets the above guidelines is permissible, we recommend that you decide on conventions to make the tag name more meaningful. Often, the first two characters are used to indicate a unit name or an area of the plant. The next six characters are used within the unit and match the standard instrument tag. The last two characters are used to differentiate raw data from calculations. The last two characters can be blanks for raw data. Or, the last two could be used to indicate whether a tag is a setpoint, temperature-corrected flow, total, alarm, control limit, etc.

Page 84

User-Assigned Attributes

Descriptor
The descriptor is a 26-character field that can be shown on trend symbols.

Extended Descriptor
The extended descriptor is an 80-character text field that appears just below the tag name on the point attribute dialog. For most points, it is used only to provide additional information for documentation. This attribute has additional meaning for PI alarm points (see the Alarm Manual) and for several interfaces (see the Interface Manual).

Typical Value
The typical value is mainly for documentation. This value is used for sample calculations by the Formula Library screens.

Point Type
There are three point types in the FactoryTalk Historian System:
Point type R is used for real or floating-point values. This is the most common point type

for most systems.


Point type I is for points whose values are always positive integers (0 - 32767). Point type D is used for points whose value can only be one of several discrete states.

These states are codes that point to the digital state table. Digital points are used to record status or test results such as ON/OFF or Red/Green/Yellow.

Zero
The zero is the bottom of the range used for scaling floating point values in the PI Archive. It does not have to be the same as the instrument zero, but that is a logical choice. Certain interfaces require that the Zero and Span match the instrument system range; see the Interface Manual for details. If the value for a type R point is less than the bottom of range, it is recorded in the archive as "Under Range."

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 85

Points and Data

Span
The span is the difference between the top of the range and the bottom of the range. It is used with the zero for scaling floating point values in the archive. The span must be a positive value. If the value for a type R point is greater than the top of range, it is recorded in the archive as "Over Range."

Starting Digital State Code


For digital points, the starting digital code is the pointer to the digital state table for the string that corresponds to a state of 0. See the PI Server Manual for more information about the Digital State Table. The starting digital state code is shown in the Zero field of the Point Attribute dialog for digital tags.

Number Digital States


This is the number of possible digital states minus one. The sum of the starting digital code and the number digital states is the last possible digital state for the point. The number of digital states minus one is shown in the Span field of the Point Attribute dialog for digital tags.

Engineering Unit String


This is the string that describes the units of measurement for a tag. Examples are 5, DegC, and tons.

Resolution Code
This attribute applies only to PI Servers on OpenVMS. WindowsNT and UNIX PI Servers use a Step attribute to determine whether to plot trends as interpolated values or as a staircase. The resolution code controls some aspects of archive storage for a tag. They are shown in the table below.
Resolution code 1 2 3 4 Time resolution in the archive 1 sec 6 sec 60 sec 1 sec

Page 86

User-Assigned Attributes

Time resolution in the archive is the accuracy of the time stamp for each archived value. For example, values for tags with resolution code 2 are stored with a time stamp that is accurate to the nearest 6 seconds. Values recorded at 12:00:00 and 12:00:01 would have the same time stamp in the archive. The frequency of data collection is determined by the interface and is not affected by the resolution code. For PI Server, the time resolution of a value is 1 second or better. The Point Attribute dialog shows a Resolution Code of 1 if the Step attribute is False. The Resolution Code shows as 4 if the Step attribute is True.

Point Source
The point source is a one-character code that associates a tag with an interface or PI module. Point source codes are not case sensitive. The standard point sources are:
L C T @ Q ? Lab measurement or manually entered value Calculated value (from Performance Equations) Postprocessing (total, average, etc.) Alarms Real-time Statistical Quality Control Fractal (random number generator)

Additional point sources may be defined for each interface. For example:
W H P N M V Westinghouse Honeywell POL Network90 MODCOMP VAREC

Location Codes
There are five integer location codes. Their meaning depends on the point source. See whichever manual describes the point source. For a point source of L, the location codes are usually not used. For instrument interfaces, the location codes often describe a hardware or software address for reading or writing the value. See the Interface Standard in the Interface Manual.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 87

Points and Data

Exception Report Specifications


Some interface programs use exception report specifications to determine when to send data to the system. The specifications are a deviation, a minimum time, and a maximum time. An exception occurs if the time since the last value is greater than or equal to the minimum time and the value has changed by more than the deviation. An exception also occurs if the elapsed time is greater than or equal to the maximum time. When an exception occurs, the previous value and the value which caused the exception are sent to the system. The exception deviation should be less than the compression deviation by at least a factor of 2.

Compression Specifications
Compression is another algorithm for separating significant values from unchanging values. This algorithm is slightly more complex than exception reporting (see the PI Server Manual). The specifications are a deviation, a minimum time, and a maximum time. The most important compression specification is the deviation. Setting this value too low causes too little data compression and wastes space in the archive. Setting this value too high causes loss of useful data.

Archiving Flag
The archiving flag must be set to ON for a point to be archived. This flag can be set to OFF to stop archiving of a point.

Compression Flag
The compression flag should be turned ON for most points except laboratory results and totals. With compression off, every value sent to the snapshot is saved in the archive.

Filter Code
This is the time constant of the first-order filter used to smooth incoming data.
Filter code 0 1 2 3 4 Time constant no filtering 10 seconds 1 minute 2 minutes 5 minutes

Page 88

User-Assigned Attributes

A longer time constant means more smoothing of the data. Operator-entered points and totals should not be filtered.

Square Root Code


This is a code from 0 to 10 used by some interface programs. Check the Interface Manual to see if your interface programs use this code.

Scan Flag
A scan flag is used by the Performance Equation module and some interface programs. Performance Equation tags are calculated only when the Scan flag is ON. Refer to the Interface Manual to see if your interface programs use scan flag.

Conversion Factor
The conversion factor is used with tags with a point source of T. These are totals and other postprocessed tags. This floating-point number is used to convert from the engineering units of the raw data or rate tag to the units of the total or average.

Display Digits
This code controls the format of numeric values on trends. It also controls the numeric format of value symbols when the formatting is set to Database. Zero or a positive number is a number of digits to display to the right of the decimal point. A negative number is the number of significant digits to display. In this case, the absolute value of Display digits is the number of significant digits. The following table shows how a value of 23.45 would appear on the screen for different values of Display digits:
Display Digits 3 2 1 0 -2 -4 Format 23.450 23.45 23.5 23. 23. 23.45

The Display digits attribute is not shown in the Point Attribute dialog box.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 89

Points and Data

System-Assigned Attributes
Some attributes are assigned by the system. You cannot change the values of these attributes.

Creator This is the name of the person who created the point.

Creation Date This is the time and date the point was created.

Changer This is the name of the last person to edit the attributes for this point.

Change Date This is the time and date that the attributes for this point were last edited.

Updates to PI Data
When a display is opened, current values of PI tags are used for dynamic elements other than trends. For trends, the time scale is configurable on a plot-by-plot basis. See the topic Changing the Time Range (page 101) for information on viewing historical values. Displays are updated whenever values change. Every five seconds, FactoryTalk Historian ProcessBook asks each server for all the new values for tags in open displays. (This update scan rate can be adjusted, see "Timer," under the Procbook.ini (page 292) topic.) 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 every scan. This can be a

significant efficiency improvement over traditional scanning.


Values that change more than once within five seconds are shown accurately on trends

because all of the changes are delivered to FactoryTalk Historian ProcessBook. Values from PI calculations and custom datasets are also updated dynamically.

Page 90

Updates to PI Data

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 91

Chapter 5: Servers and Connections

How Displays Behave When Connection to the PI Server Fails


If the connection to your data is not successful, the display will still be drawn, but data in dynamic elements will be replaced with "no data indicators." Trends are labeled "Invalid" and no information is plotted. Values are replaced with pound signs (###). Then the message Disconnected appears. Bar graphs are drawn using a hash symbol (//////). Multi-State symbols show the color for bad data. If a server has been disconnected and cannot be found, a Select New Node dialog appears. You can choose a new server from the dropdown list of connected servers or you can go to the Connections dialog (page 93).

PI Connection Manager Dialog Box


The Connections entry on the File menu opens the PI Connection Manager dialog. The display lists the 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.

How to Connect to a Server


1. From the File menu, select Connections. The PI Connection Manager dialog box is displayed. 2. Click on the box next to the server name in the PI Connection Manager dialog box. You may select more than one.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 93

Servers and Connections

-orClear the check boxes in the list of servers. On the Connect menu, click the appropriate server to connect to. 3. In the PI Server Login dialog box, type your user ID and password, and then click OK. When connection is completed, the status is displayed in the PI Connection Manager dialog box.
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 box is displayed. 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.

How to Disconnect from a Server


1. From the File menu, select Connections. The PI Connection Manager dialog box is displayed. 2. Clear the checkbox next to the server name you want to disconnect from or on the Connect menu click Disconnect from. 3. Click Close. You are automatically disconnected from all servers when you exit FactoryTalk Historian ProcessBook.
Note: You are automatically disconnected from all servers when you exit FactoryTalk Historian ProcessBook.

Connecting to Multiple Servers


FactoryTalk Historian ProcessBook can access multiple PI Servers simultaneously. Using multiple servers allows you to build displays that show data from two or more servers at the same time.

Network Errors
Network Errors update the Status Report, 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 is displayed. It is displayed once for each server that is not in the Known Servers table.

Page 94

How to Display Server Information

How to Display Server Information


1. From the File menu, select Connections. The PI Connection Manager dialog box is displayed. 2. Double-click a server name. 3. The Connections Information dialog will appear, providing extensive information about your server connections.

How to Change the Default Server


The Advanced Settings dialog box is used to change default connection settings. Do not change these settings unless you understand the ramifications. Changing to an incorrect setting may prevent the client application from connecting to the server. 1. From the File menu, select Connections. The PI Connection Manager dialog box is displayed. 2. Double-click a server name. 3. In the Connection Information dialog, click the Connection Settings button. 4. In the Connection Settings dialog, click the Advanced button. 5. In the Advanced Settings dialog, change the default server and click OK.
Note: The name of the new server name will display on the status bar in the PI Connection Manager dialog box.

Node Identifiers for Multiple PI Servers


In FactoryTalk Historian ProcessBook, a Node Identifier is stored with each tag name used in a display to point to the correct server. If you define PI Server nodes in the PI Connection Manager dialog, the identifiers will be the same on each PC on the network as long as the node names for the FactoryTalk Historian System are the same.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 95

Chapter 6: Time Concepts

Time Zones and PI


FactoryTalk Historian ProcessBook allows you to display times according to either PI Server Time (where the data is stored) or PI Client Time (your PC time). If both the server and the client are in the same time zone, this is not important. However, when you are looking at data from several servers in different time zones, you may wish to define the time zone to be displayed with your data. There is a default setting on the Tools > Preferences > Start tab. This will affect all displays within a ProcessBook. You can change this setting for a single display by using the two buttons on the Time Zone toolbar or through the Edit > Display menu option. There is a Status Bar indicator at the bottom of the ProcessBook window to let you know whether server time or client time is being used by the display in focus. If a trend contains traces from PI servers in different time zones, the first valid trace in the list in the Define Trend dialog will be used to determine the time zone for the X-axis. The time zone setting is saved with the display. When you open it later, it may be in conflict with your current time zone setting for the ProcessBook; in this case, the Status Bar indicator will be red.

Time Range Formats


Dynamic symbols in ProcessBooks have timestamps associated with the data they are displaying. These timestamps may be reported to the sub-second level if they have been recorded that way in the PI Server. The format for specifying and displaying sub-second time values is: mm/dd/yy hh:mm:ss.sssss

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 97

Time Concepts

In the Start pane of the FactoryTalk Historian ProcessBook preferences, the user can select either Windows or PI time formatting. Sub-second data will always be displayed for both string formats, except when the sub-second data is zero. All trends have a left and a right time scale that define the span of time for which tag data is plotted. Each scale can be expressed in either absolute or relative time. Trends may be defined to end at the current time by using an asterisk for the End Time. Trends may also be defined to end at a future time. Only the following strings are valid for entering time range information.
Name second minute hour day month year week weekday yearday Short Name s m h d mo y w wd yd Plural Name seconds minutes hours days months years weeks weekdays yeardays

Absolute Time
Absolute times have one of these formats:
Format DD-MMM-YY hh:mm:ss * T Y S,M,TU,W,TH,F,SA Description day-month (alphabetic)- year hour:minute:second The current time. 00:00:00 on the current day (TODAY) 00:00:00 on the previous day (YESTERDAY) 00:00:00 on the most recent Sunday, Monday,.., Saturday.

Page 98

Relative Time

For the DD-MMM-YY hh:mm:ss format, if any of the date fields are left out, they default to the current date. Time fields default to 00. Examples of the FDD-MMM-YY hh:mm:ss format, including defaulted fields:
Example 25 25-Aug-86 8: 25 8 21::30 Description 00:00:00 on the 25th of the current month 00:00:00 on that date 08:00:00 on the current date 08:00:00 on the 25th of the current month 9:00:30 PM on the current date

Note that this format is slightly different from the DEC Open VMS format, which uses a 4-digit year. You may also use the Windows time and date format for an absolute time. These are configured through the Control Panel.

Relative Time
Relative time is some number of days, hours, minutes, or seconds. The leading sign (+ or -) is required. +/- N d | h | m | s where N is any number. The default starting point for relative time is usually the current time. Therefore, a time of -8h is eight hours before the current time. Fractional times may be entered. For example, use 1.5d for one and one-half days. For trends, relative times for the left time scale are relative to the current time. Relative times for the right time scale are relative to the left time scale.

Combined Time Scales


Combined time scales use both an absolute and a relative time. The absolute part of the time can be *, T, Y, or a day of the week.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 99

Time Concepts

Examples of combined time scales:


Example T + 8h Y - 8h M + 14.5h SA - 1m * - 1h Description 08:00:00 AM on the current day (today) 04:00:00 PM on the day before yesterday 02:30:00 PM on the most recent Monday 11:59:00 PM last Friday one hour ago

Time Range Toolbar


The Time Range toolbar is used for working with dynamic symbols. This toolbar, which must be used in Run mode, contains three buttons: Revert icon to return the trend or other dynamic symbol to the original setting. Change Time Range button that brings up a dialog (page 101) to set new, temporary start and endpoints for the symbol. For Bars, Values, and Multi-State symbols, there is no start point, only an end point.

Scroll Bar to move through values on a trend by time.

Scrolling Time Range

Use the time backward and forward buttons to scroll the time range forward or backward. Trends scroll by the time range specified in the trend definition. When you select multiple trends, each trend maintains its time range as it is scrolled. If you select a trend and a dynamic element such as a value, the element scrolls by the time range specified in the trend definition. For example, if the trend displays data from 1:00 to 4:00 (3 hours) and the value has a timestamp of 5:00, scrolling backward shows trend data from 10:00 to 1:00. The value's timestamp also changes by 3 hours (2:00).

Page 100

Changing the Time Range

Click on the element or elements with the Run Mode pointer, and then click the Time Forward or Time Backward button. Time Range Scroll Control on Time Range Toolbar

You can also use the time range scroll control. When the scroll bar buttons are clicked or the scroll bar thumb is dragged, the time of each selected trend and value is shown in a ToolTip. When empty areas of the scroll bar are clicked, the end time of each selected trend is incremented or decremented by its time span. This operation is the same as would happen if the "forward/backward one period toolbar buttons" were clicked. 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.

Changing the Time Range

When you open a display, values, bars, and Multi-State symbols show the current values for points. A trend may specify a time range that may encompass the last hour or the last week or another time range. You can change the time range that is used for values, bars, trends, and Multi-State symbols by using the Time Range command or by using the Change Time Range button that has been added to a toolbar. The Time Range command lets you enter new starting and ending times. When you specify a time range for a single-time dynamic element, such as a Multi-State 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. If the server to which you are connected is in a different time zone, time on your display will be from the distant time zone, not the local one.

1. With the Run Mode pointer, select the dynamic symbol or symbols for which you want to change the time range. If no symbols are selected, the time range change will affect all dynamic symbols in the display.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 101

Time Concepts

2. The Change Time Range dialog allows you to change the time span for a trend or the effective time for a Bar, Value, or Multi-State symbol. To reach this dialog, click the Time Range button. -orSelect Time Range from the View menu.

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 (page 99), absolute (page 98), or combined (page 99). 4. Click OK. The selected elements change to reflect the new time range.

Revert Time Range

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, select Revert from the View menu or click the Revert button.

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 hr or 8 days. These trends will update if they are less than the update time limit. In the past, only those trends with an end time of the current time, indicated by an asterisk, *, would update. You can now set the time range for a trend into the future by using * + an amount of time no more than 24 hours greater than the start time, and the trend will update.

Page 102

Future Trends

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 103

Chapter 7: Building ProcessBooks

Build Mode Pointer

Most of the functions that you use when building a ProcessBook require the Build mode pointer. Build mode is used for editing ProcessBook and symbols within a display. The Build Mode pointer looks like a hammer and provides access to symbols and formatting tools. On the Drawing toolbar, click the Build button, or, on the Tools menu, click Build. The mouse cursor turns into the Build mode pointer.
Note: You can choose Build mode as your preferred mode of operation by setting this preference in the ProcessBook Preferences dialog box.

Basic Steps to Build a ProcessBook


There are five basic steps to creating a ProcessBook: 1. Create and save a ProcessBook. 2. Add, organize, and edit entry titles. 3. Design a detailed display for each display entry title, using the drawing tools to create schematics or other drawings with trends, bars, and values. To import outside data, add OLE objects and values from data set queries.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 105

Building ProcessBooks

4. Format trends and make other adjustments to each display to present your data in the most useful manner. 5. Save the completed ProcessBook and install it wherever it will be needed.
Note: In some installations, the System Administrator has set your FactoryTalk Historian ProcessBook to the View Only mode. If so, you cannot create and save new ProcessBooks.

Creating a New ProcessBook


Before you create a ProcessBook, you may wish to plan an organizational structure and a naming convention for the ProcessBook and the entries within it. When you create and save a new ProcessBook, the application initially gives it the title Book1 where 1 represents the number of ProcessBooks created during the session. FactoryTalk Historian ProcessBook also creates a file name for the new ProcessBook. It will suggest the first word from your title and an extension of .piw. For example, FactoryTalk Historian ProcessBook may suggest Filtrat1.PIW. If you plan to build an entire set of ProcessBooks, you might choose to modify it to something that will sort your set of ProcessBooks in some order, such as 05FiltrP.PIW. How to Create a ProcessBook 1. In Build mode, on the File menu, click New. 2. The New dialog box is displayed. 3. Select ProcessBook (.piw) File. 4. In the ProcessBook Name box, type a name for the new book. 5. Click OK. 6. A new ProcessBook is displayed.
Note: If you typed a name in ProcessBook Name box, then the name appears on the ProcessBook title bar. If you did not type a name, then Book1 etc. will display on the title bar.

Page 106

Book View Tabs

Book View Tabs


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.

Modifying a ProcessBook Title


You can change the name of a ProcessBook at any time. 1. In either Build Mode or Run Mode, select Properties from the File menu. 2. The Summary Information dialog box is displayed.

3. In the Title box, type a new title.


Note: The ProcessBook title is different from the file name established in the New dialog box when you created the new ProcessBook. The title bar on the ProcessBook window displays the file name, which ends in .piw, rather than the title.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 107

Building ProcessBooks

4. Click OK.

Page 108

Saving and Closing a ProcessBook

Saving and Closing a ProcessBook


After creating a ProcessBook, it is a good idea to name the file and save it immediately. It is also important to save a ProcessBook periodically while you are working in it. When you save a ProcessBook, all changes to all entries and to the organizational structure are permanently stored. The ProcessBook remains open in your workspace so you can continue working. 1. To save a ProcessBook for the first time, select Save or Save As from the File menu. The Save As dialog box is displayed. 2. Type a name for the ProcessBook file. A .piw extension is automatically added. 3. Select the drive and directory where you want to save it. 4. Click OK.

Add ProcessBook Entries


After creating a ProcessBook, the next step is to add individual entries. By arranging and combining displays and other entry types, you can create a complete working environment for plant personnel. You can add the entry titles to the ProcessBook and then complete the detailed design of the entries later. There are five specific types of entries:
Display entries Linked Displays, which simply point to another display entry Linked ProcessBook entries, which point to another ProcessBook Text entries, to provide headings or static information Operating System Command entries, which open another application.

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 will be placed in the ProcessBook just before the selected entry. If no entries are selected, the new entry will appear at the end of the current tab section

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 109

Building ProcessBooks

in Book View or at the end of the Outline View. You can press the ESC key to clear all entries. In order to create an entry, the general procedure is:
Create a new entry Specify the Label, Entry type, and Level as well as any associated entries, files, or

applications
Save the entry

Creating a Text Entry


Text entries are used to add labels and clarifying text to the ProcessBook. 1. On the File menu, click New. The New dialog box is displayed. 2. Under Type, select ProcessBook Entry, and click OK. 3. The Define ProcessBook Entry dialog box is displayed. 4. In the Label box, type a name.
Note: There is no limit to the number of characters you may use, but for headings, you should try to be as brief and descriptive as possible.

5. For the Type, select Text. 6. In the Level list, click the level at which you want to position the entry in the ProcessBook hierarchy of entries. -orType a number between 1 and 10.
Note: If it is the first entry in the ProcessBook, the level is automatically set to 1 and cannot be changed.

7. 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.

Page 110

Creating a Display Entry

8. Click the Save button on the toolbar or from the File menu, click Save. If you are creating several entries in one session you may wait to save until the last one is entered.

Creating a Display Entry


Once you have defined a display in the Define ProcessBook Entry dialog box, you can return at another time to create the contents. 1. On the File menu, click New. The New dialog box is displayed. 2. Under Type, select ProcessBook Entry. 3. Click OK. 4. The Define ProcessBook Entry dialog box is displayed. 5. In the Label box, type a name.
Note: There is no limit to the number of characters you may use, but for headings, you should try to be as brief and descriptive as possible.

6. For the Type, select Display. 7. In the Level list, click the level at which you want to position the entry in the ProcessBook hierarchy of entries. -orType a number between 1 and 10.
Note: If it is the first entry in the ProcessBook, the level is automatically set to 1 and cannot be changed.

8. Click OK. 9. The entry is added to the ProcessBook and a blank display is opened. If the entry is at Level 1 and you are in book view, a tab is created. 10. Click the Save button on the toolbar or select the File menu and then the Save command. If you are creating several entries, you may wait to save until the last one is entered. If

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 111

Building ProcessBooks

you wish to save the entry as an independent file, use the Save As command on the File menu.

Creating a Linked Display Entry


A Linked Display allows you to link a display title in a ProcessBook to an entry elsewhere in the ProcessBook or in another ProcessBook. This means that you create and store only one copy of the entry. In other words, you can access the same entry from several different locations in one ProcessBook. Or, while you are in one ProcessBook, you can open an entry from another one without having to exit the first ProcessBook. The linked entry is not a copy; it is a way of looking at the original. The Book View or Outline View will show the title of the linked entry, but the actual display window will show the title of the original entry. If you edit the original from any linked entry, the original will be updated and will automatically appear updated in all the ProcessBooks to which it is linked. To prevent unexpected updates, you can restrict access to an entry so that only the original entry can be edited and all others to which it is linked are read-only. If the entry resides on a server, you can write-protect the file on the server. If you need more information on restricting access to files, see your System Administrator. Before you create a link to an original entry in a different ProcessBook, the ProcessBook that contains the original entry must be open. Once the link is established, you only need to open the ProcessBook with the Linked Display. If you wish to link to an entry in a second ProcessBook, open the second book. If you wish to link to an entry in your current ProcessBook, create the original first and then the link.

How to Create a Linked Display Entry


1. Open the ProcessBook you are developing. On the File menu, click New. The New dialog box is displayed. 2. Under Type, select ProcessBook Entry. 3. Click OK. 4. The Define ProcessBook Entry dialog box is displayed. 5. In the Label box, type a name.

Page 112

Creating a Linked Display Entry

Note: There is no limit to the number of characters you may use, but for headings, you should try to be as brief and descriptive as possible.

6. For the Type, select Link/OS Command. 7. Click the Browse button. -orClick the Browse arrow to see more search options. 8. The Open dialog box is displayed. 9. Browse and locate the display file (.pdi) that you want to link to and then click the Open button. 10. The display name is displayed in the Action box. 11. In the Level list, click the level at which you want to position the entry in the ProcessBook hierarchy of entries. -orType a number between 1 and 10.
Note: If it is the first entry in the ProcessBook, the level is automatically set to 1 and cannot be changed.

12. Clear the Options check box if want the relative path to display.
Note: ProcessBook always attempts to open a linked display from its absolute path first. If the absolute path fails, then the relative path is used. Selecting this box reverses the order in which the paths are resolved. For new displays, this option is checked by default.

13. Click OK. 14. A linked display entry icon is added to the outline and book view of the ProcessBook you are developing. 15. Click the Save button. If you are creating several entries, you may wait to save until the last one is entered.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 113

Building ProcessBooks

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.

Linked ProcessBook Entries


Similar to a Linked Display, a Linked ProcessBook entry is a link to a different ProcessBook. When you open a linked ProcessBook entry, another ProcessBook is opened. You may open any of the entries in that ProcessBook. Using a Linked ProcessBook entry is the same as opening a ProcessBook using the Open command on the File menu. The same rules apply to Linked ProcessBook entries as to Linked entries.

Moving Linked Entries


If you move a linked pair of displays or ProcessBooks to another location and if this move changes the relationship of the two file paths, you will need to relink the items.

Creating an Operating System Command Entry


An operating system command is used to start another application, such as Microsoft Excel, in addition to FactoryTalk Historian ProcessBook. Use an operating system command to link to FactoryTalk Historian DataLink reports or calculations. You can also create links to CAD drawings, modeling packages, or statistics packages. When you have reports created on a different system, you can convert them to ASCII and, using an operating system command, create a link to Notepad to read the reports. If your company has online Help files for certain procedures, you can create a link to those help files. Your computer must have enough memory to run the applications you want to use in addition to FactoryTalk Historian ProcessBook. If you do not know whether or not your computer has enough memory, contact your System Administrator.

Page 114

Creating an Operating System Command Entry

How to Create an Operating System Command Entry


1. Open the ProcessBook you are developing. On the File menu, click New. The New dialog box is displayed. 2. Under Type, select ProcessBook Entry. 3. Click OK. 4. The Define ProcessBook Entry dialog box is displayed. 5. In the Label box, type a name.
Note: There is no limit to the number of characters you may use, but for headings, you should try to be as brief and descriptive as possible.

6. For the Type, select Link/OS Command. 7. Click the Browse button to the right of the Action box. -orClick the Browse arrow and then click Applications. 8. The Open dialog box is displayed. 9. Browse and locate the file that you want to link to, and then click the Open button.
Note: If you know the name of the .exe file for the application, such as C:\excel\Excel.exe for Excel or the path and name of a data file, such as C:\document\report.xls, then you can type this directly in the Action box.

10. The application's path/name is displayed in the Action box. 11. Click the Browse button to the right of the Working folder box. 12. The Browse for Folder dialog box is displayed. 13. Browse and locate the folder that you want to specify for operating system commands, and click OK.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 115

Building ProcessBooks

Note: If you know the name of the working folder for this application, then you can type this directly in the Working folder box.

14. In the Level list, click the level at which you want to position the entry in the ProcessBook hierarchy of entries. -orType a number between 1 and 10.
Note: If it is the first entry in the ProcessBook, the level is automatically set to 1 and cannot be changed.

15. ProcessBook always attempts to open a linked display from its absolute path first. If the absolute path fails, then the relative path is used. To reverse the order, select the Use relative path before absolute path check box. For new displays, this option is checked by default. Use the relative path before the absolute path. Ignore the default shell command for recognized file types.
Note: If the file type is supported by ProcessBook (either natively or through an add-in), then it is opened directly. For example, a .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.

16. Click OK. 17. An icon for the program you are running is added to the outline and book view of the ProcessBook and the application opens. Close the application. 18. 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.

Page 116

Working Directory for Operating System Commands

Working Directory for Operating System Commands


The Define Entry dialog has a text box so that you can enter the working directory. The command line recognizes file extension associations. For example, in the past you needed to enter a command like: C:\EXCEL\EXCEL.EXE C:\MYWORK\MINE.XLS Now you can use a command like: C:\MYWORK\MINE.XLS

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 117

Building ProcessBooks

In other words, if the string will work for the Run command under the File menu of the Program Manager, it will work in FactoryTalk Historian ProcessBook. Some applications that you can access with an operating system command, such as MS Excel, have been improved so that only one copy of the application will open, even if you press the command several times.

Arranging Entries for Easy Navigation


Once you have created your entry titles, it is a good idea to consider how they are arranged in your ProcessBook. Each ProcessBook gives you two possible views of your entr (page 22)y titles, Book View and Outline View (page 23). You can have up to 10 levels of entries in a ProcessBook, but levels 3 to 10 are displayed in Book View as though they were at the same level. There is no limit to the number of tabs you may have in a Book. However, as you add tabs or reduce the size of the ProcessBook, the tabs are stacked to the right of the Book. This might make the ProcessBook difficult to read in Book View. Whether you are in Outline view or Book view, you can edit and rearrange entries, or delete entries altogether. Some functions are performed the same regardless of the view in which you are working.

Copying an Entry and Pasting It Elsewhere


1. Click on the Build Mode pointer and select the entry. 2. Click the Copy button. This copies the selection to the Clipboard. 3. If it is not already open, open the ProcessBook where you want to paste the entry. 4. Click the Paste button. This copies the contents of the Clipboard to your ProcessBook.
Note: If you highlight an entry first, the new entry will be placed above the highlighted entry.

Page 118

Arranging Entries for Easy Navigation

Removing an Entry
1. In Build mode, select its 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 select Undo from the Edit menu.

How to Turn Pages in Book View

Click a tab to show the first page of that section. Or, you can click the triangles in the upper right corner of the ProcessBook page to move forward and backward a page at a time.

Editing an Entry in Book View


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.

How to Change the Title of an Entry in Book View 1. On the View menu, click Book. In Build mode, double-click the entry you want to change. The Define ProcessBook Entry dialog box is displayed. 2. In the Label box, type a new name. 3. Click OK.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 119

Building ProcessBooks

How to Change the Level of an Entry in Book View 1. On the View menu, click Book. In Build mode, double-click the entry you want to change. The Define ProcessBook Entry dialog box is displayed. 2. In the Level list, click the level at which you want to reposition the entry in the ProcessBook hierarchy of entries. -orType a number between 1 and 10. 3. Click OK.

How to Rearrange Entries in Book View Use the Cut and Paste commands.

Editing an Entry in Outline View

How to Change the Name of an Entry in Outline View 1. On the View menu, click Outline. 2. In Build mode, click the entry you want to change. 3. On the Edit menu, click Selected Item. The Define ProcessBook Entry dialog box is displayed. 4. In the Label box, type a new name. 5. Click OK.

How to Change the Level of an Entry in Outline View 1. On the View menu, click Outline. 2. In Build mode, click the entry you want to change. 3. On the Edit menu, click Selected Item. The Define ProcessBook Entry dialog box is displayed.

Page 120

Moving Displays to Other PCs

4. In the Level list, click the level at which you want to reposition the entry in the ProcessBook hierarchy of entries. -orType a number between 1 and 10. 5. Click OK.

How to Rearrange Entries in Outline View In Build mode, click the name of the entry and drag the entry up or down (not sideways) to a new location. A dotted line indicates the location of the entry you are moving.

Moving Displays to Other PCs


Relative and Absolute Paths for Linked Displays or ProcessBooks
FactoryTalk Historian 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.

Node Identifiers for Multiple PI Servers


In FactoryTalk Historian ProcessBook, a Node Identifier is stored with each tag name used in a display to point to the correct server. The algorithm for determining the Node Identifiers has been changed. If you define PI Server nodes in the PI Connection Manager dialog, the identifiers will be the same on each PC on the network as long as the node names for the FactoryTalk Historian System are the same. In previous versions, Node Identifiers were assigned independently within each PC, which caused displays built on one PC to fail when moved to another. "Old" displays will continue to have this problem until the Node Identifier is reassigned through the PI Connection Manager dialog.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 121

Building ProcessBooks

Importing Files
1. Select Open from the File menu. 2. Select the drive and directory where the file resides or type the path and file name in the File Name list. 3. From the Files of Type list, select all files or a specific file type to be imported. You can import more than one file at a time. 4. Click OK. The status bar displays each file as it is imported. When completed, a message displays the number of files successfully imported. If errors occurred during the import process, a message box is displayed at the end of the import process showing the number of errors. You can check the PIPC.log for error messages. 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.

Page 122

Chapter 8: Building Displays

Designing a Display
Consider these suggestions when designing your drawing:
Follow your plant's color conventions, especially if they adhere to safety standards. While you are designing, it is a good idea to test the display with some of the people who

will be using it.

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 in this large drawing 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. Symbols in your drawing will 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.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 123

Building Displays

PI Server Connections
Some of the symbols you add to a drawing can display information from the database via the PI Server. These symbols are called dynamic symbols and include bars, values, trends, and Multi-State symbols. You can retrieve information from multiple databases at one time. You can also search the databases to find the name of a tag.

Searching for Tags


There are 3 types of searches, Basic, Advanced, and Alias. Searches can be defined and then saved for future use.

Tag Search Dialog

The Tag Search dialog box is used for searching for tags (a name of a point that is a measurement or calculation received or generated periodically). The Tag Search dialog box contains three tabs (Basic Search, Advanced Search, and Alias Search). On the standard toolbar, click the Tag Search button. -orClick the Tag Search button in any of the following dialog boxes:
Define Value dialog box Define Bar dialog box Define XYPlot dialog box Multi-State Symbol dialog box Define Trend dialog box

The Tag Search dialog box is displayed.

Page 124

Searching for Tags

Basic Search
The Basic Search tab has eight fields for specifying search criteria. Seven of the fields have a fixed context, and one of the fields has a variable context. How to Perform a Basic Search 1. Click the PI Server box on the Basic Search tab in the Tag Search dialog box. 2. The Multi-Server Pick List dialog box is displayed.

3. Click the name of the server on which you want to search for the tag or follow the instructions in the dialog box for selecting multiple servers. 4. Click OK. -orRight-click the PI Server box to display the shortcut menu, click the appropriate server. -orClick the PI Server arrow and then click the appropriate server.
Note: If you do not see the desired server in the drop-down list, click the Connections button to connect to it.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 125

Building Displays

5. In the Point Type box, click the appropriate point type in the drop-down list.
Note: The available Point Types depend upon the whether you are searching against a PI 2 or PI 3 server.

6. In the Point Class box, click the appropriate point class in the drop-down list.
Note: Custom point classes are not displayed unless the target PI Server is connected. Searching by Point Class is supported only by PI 3.3 and greater.

7. The Tag Mask, Descriptor, Point Source, and Engineering fields are associated with tag attributes that have a string value. The Value field behaves in the same manner as these fields when the context is associated with a point attribute of type string, such as TotalCloseMode. Leaving one of the mask fields blank is equivalent to specifying it as *. You must use the Advanced Search tab to search for a tag that has an attribute value that is blank. An example is available by clicking the Favorites button to search for all tags with a blank descriptor. 8. Use wildcard characters in any of the mask fields listed above. Type: * to represent any number of characters ? to represent one character * and ? combined with other characters to find a range of matches

For example, B* in the Tag Mask box locates all the tags whose name begins with B.
Note: You cannot specify both a single quote (') and a double quote ("") in any of the mask fields because this will cause an error. However, you can search for an attribute that contains one or more single quotes (') or one or more double quotes (""). For example, you can search for PI Tags that have a descriptor of "Hg (the element sign for mercury) by specifying "Hg in the Descriptor box. You would not do this by specifying "Hg" in the Descriptor box.

9. In the Descriptor box, type the description of the tag.


Note: Type a few characters of the description exactly as they would appear. Do not use wildcard characters. An asterisk (*) in this field finds tags with asterisks in their descriptor. This field is not case-sensitive.

10. Choose the appropriate setting for the Value field from the following table:

Page 126

Searching for Tags

Leave the Value box at the If you want to search for PI Tags that have a particular snapshot default setting (* to represent any value, as long as the snapshot value is not a digital state. value) Click the Value arrow and then click Status Click the Value arrow and then click Point Attribute To search for tags that are in a particular digital state. Search by "Status" examples are available by clicking the Favorites button. To set this field to a context of any other PI 3 point attribute from any Point Class. For example, you can search for Totalizer tags that have a particular TotalCloseMode. When you click Point Attribute, the Select Point Attributes dialog box will display.

Note: Never use a double quote (") in the Value box, or an error will occur.

11. Click the Search button to begin the search. The number of items in the found list with the percentage of the search that is complete is displayed on the status bar in the Tag Search dialog box. Click the Abort button to stop the search at any time. 12. When the search is completed or aborted, tags matching the criteria are displayed in the Search Results list. To select adjacent tags, click the first tag, and then hold down SHIFT and click the last tag. To select nonadjacent tags, click the first tag, and then hold down CTRL and click additional tags. To select all tags, click the Select All button.

13. If you want more detailed information about the values or attributes of a tag, then select the appropriate tag in the Search Results list and click either the Pt. Attr or Pt. Values button. 14. Click OK to close the Tag Search dialog box. If you used the Tag Search feature while defining a dynamic symbol, the tags you selected will be added to the symbol.
Note: When you reopen the Tag Search dialog box, the Search Results list shows the results of your previous search. This lets you search once for a group of tags to be used in several symbols.

Advanced Search
The Advanced Search tab is used for constructing an SQL query. The search criteria are much more flexible than using a basic search. Any point attribute from Point Class Classic

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 127

Building Displays

can be used to restrict the search and there are various methods to search by value. To view examples of SQL queries, click the Favorites button, point to Examples, and then click the appropriate example. You can construct a query two ways:
By selecting the components of the query from using the Where Clause generator

drop-down lists and text box (located under SELECT Tag FROM PIPoint). -or By typing a query in the Where Clause box (beneath the Where Clause generator). Do

not type the word "where" in the Where Clause box. The Where clause is the part of the SQL statement after the word "where." Although you can join the PIPoint table with other PI tables, such as PIComp, you will probably have the most success with queries that are limited only to the PIPoint table. You may also have trouble with "OR" conditions in the SQL queries. Examples:
To search for all PI Points that have archiving OFF (0), use: To search for all digital points, use: PIpoint.Archiving = 0

PIpoint.PointType = 'D' To search for all real, integer, or string points, one would replace the 'D' with 'R', 'I', or 'S', respectively. PIpoint.PointType = 'I' AND PIcomp.Status = 1 AND PIpoint.Tag = PIcomp.Tag AND PIcomp.Time = DATE("*") It is very important to include the equi-join condition: PIpoint.Tag = PIcomp.Tag. Note that integer values are retrieved using PIcomp.Status and floating-point values are retrieved using PIComp.Value.

To find all integer points that have a snapshot value of 1, use:

Note: If you want more detailed information about the values or attributes of a tag, then select the appropriate tag in the Search Results list and click either the Pt. Attr or Pt. Values button.

Alias Search
The Alias Search tab is used to search for PI Aliases in the PIModule database.
Note: A PI Alias is simply a PI Point that is associated with a particular PI Module in the PI Module Database.

Page 128

Searching for Tags

How to Perform an Alias Search 1. On the Alias Search tab, in the Tag Search dialog box, specify search criteria in the appropriate fields. 2. Click the Search button to retrieve a list of PI Aliases. 3. When the search is completed or aborted, tags matching the criteria are displayed in the Search Results list. To select adjacent PI Aliases or PI Points, click the first PI Alias or PI Point, and then hold down SHIFT and click the last PI Alias or PI Point. To select nonadjacent tags, click the first PI Alias or PI Point, and then hold down CTRL and click additional PI Alias or PI Point. To select all PI Aliases or PI Points, click the Select All button.

4. If you want more detailed information about the values or attributes of a tag, then select the appropriate tag in the Search Results list and click either the Pt. Attr or Pt. Values button. 5. Click OK to close the Tag Search dialog box. If you used the Tag Search feature while defining a dynamic symbol, the tags you selected will be added to the symbol.

Additional Search Features


You can save searches, edit them, and reorganize them:
Save a search Edit a search Rename a search Move a search Delete a search Copy saved searches to another machine Restore a saved search

You can perform these tasks from either the Basic Search tab, Advanced Search tab, or Alias Search tab in the Tag Search dialog box. When you click the Favorites button, a submenu displays with commands allowing you to save your search, organize your search, or view your last search.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 129

Building Displays

Note: Searches are persisted as XML documents under subdirectories of pipc\dat\tagsearch or pipc\dat\aliassearch.

How to Save a Search 1. Click either the Basic Search tab, Advanced Search tab, or Alias Search tab in the Tag Search dialog box. 2. Specify the search criteria in the appropriate fields, click the Favorites button, and then click Save Search. The Save Search dialog box is displayed. You can now save the search in an existing folder or you can add the search to a new folder. 3. In the Name box, type a name for the search. 4. Leave the Save selected servers as part of search check box at the default setting (selected) if you want to associate a server with a search.
Note: If you clear the check box, then the search criteria will be applied to whichever servers are selected at the time that the search is invoked.

5. Click the Save button. The search is added to the Folder list.
Note: The new search is also added to the bottom of the Favorites submenu.

6. Click the Save button to add the search to the new folder. The new folder is also added to the bottom of the Favorites submenu.

How to Edit a Search In the Tag Search dialog box, click the Favorites button, and then click the search to be edited.

How to Rename a Search 1. In the Tag Search dialog box, click the Favorites button and then click Organize Searches. The Organize Search dialog box is displayed.

Page 130

Searching for Tags

2. In the Folder list, click the search you want to rename, and then click the Rename button. 3. Type a new name for the search.

How to Move a Search 1. In the Tag Search dialog box, click the Favorites button and then click Organize Searches. The Organize Search dialog box is displayed. 2. In the Folder list, click the search you want to move, and then click the Move to Folder button. The Browse for Folder dialog box is displayed. 3. Click the name of the folder you want to move the search to. 4. Click OK.

How to Delete a Search 1. In the Tag Search dialog box, click the Favorites button and then click Organize Searches. The Organize Search dialog box is displayed. 2. In the Folder list, click the search you want to delete, and then click the Delete button. The following message is displayed. 3. Click the Yes button to delete the search.

How to Copy Saved Searches to Another Machine A saved search (XML file) can be copied to remote client machines and placed in the appropriate subdirectory of the PIPC\dat directory. Searches that do not have PI Servers associated with them can be used without conflict. If a PI Server is associated with a saved search and if the PI Server is not in the Known Servers Table of the client machine, then the Tag Search dialog box will report this error.

How to Restore a Saved Search 1. In the Tag Search dialog box. 2. Click the Favorites button and then click the search to be restored.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 131

Building Displays

The search is executed immediately.

Changing Format Settings in an Existing Display


You can change the background or object formatting in an existing display as follows: Click ESC to ensure no display objects are selected. 1. Use the Build Mode pointer. 2. Select the object you wish to change. 3. Select one of the Format commands from the Edit menu (Font. Color, or Line Style). -orClick on one of these Format buttons on the Formatting toolbar. The appropriate format dialog box is displayed. 4. Click OK after filling out the dialog. The new settings appear and are used when drawing new objects. 5. Choose Edit > Display to alter the background color or to select a Time Zone for the display. Click OK.

Removing an Entry and Pasting It Elsewhere


Click on the Build Mode pointer and select the entry. 1. Click the Cut button on the Standard toolbar. This deletes the entry but places a copy on the Clipboard. 2. Press the ESC button to clear any highlighting. 3. Click the Paste button on the Standard toolbar. This copies the contents of the Clipboard to your ProcessBook.
Note: If you highlight an entry first, the new entry will be placed above the highlighted entry.

Page 132

Importing Files to a ProcessBook

Importing Files to a ProcessBook


1. Start FactoryTalk Historian ProcessBook. 2. Open the ProcessBook into which you want to import the files or create a new ProcessBook. 3. In Build mode, on the File menu click Import. The Import Files dialog box is displayed. 4. Select the file type. 5. Select the drive and directory where the file resides. -orType the path and file name in the File Name box. You can select more than one file at a time. 6. Click the Open button. The status bar displays each file as it is imported. When completed, a message displays the number of files successfully imported. If errors occurred during the import process, a message box is displayed at the end of the import process showing the number of errors. You can check the Message Log from the Status Report icon at the bottom of your display.
Note: Depending on the size, some files may take several minutes to import.

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.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 133

Building Displays

Moving a ProcessBook to Another PC


If you decide to move a ProcessBook to another PC, you may experience some differences in display entry appearance on the new PC:
When the number of colors is different between the original PC and new PC, FactoryTalk

Historian 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, FactoryTalk Historian

ProcessBook substitutes a similar font.


If a ProcessBook includes links to other entries, ProcessBooks, or applications,

FactoryTalk Historian 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 must be identical. Different monitors have different resolutions, which may distort the appearance of an

existing ProcessBook.

Moving to Another PI Server


When you want to use an existing entry with a different PI Server, FactoryTalk Historian ProcessBook attempts to locate the correct tags for that entry. Each ProcessBook saves the tag information for all of the entries it contains. When an entry is used with a PI Server other than the one for which it was created, FactoryTalk Historian ProcessBook searches the database for a matching tag ID. If a match is found, FactoryTalk Historian ProcessBook retrieves the tag name associated with the tag ID and compares the tag name with the saved tag name.
If the tag names are the same, the value is shown in the entry. If the tag names are different, FactoryTalk Historian ProcessBook searches the database

for the tag ID of the saved tag name. If a match is found, the value is shown in the entry.
If a match is not found, FactoryTalk Historian ProcessBook uses the tag ID saved with

the ProcessBook regardless of the different tag names. If no tag ID or tag name is found in the database, FactoryTalk Historian ProcessBook displays a message informing you of the missing tag.

Page 134

Drawing Tools and Procedures

Drawing Tools and Procedures


Drawing Tools
FactoryTalk Historian ProcessBook includes a drawing environment with features that allow you to create symbols and graphics within an entry. 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. A button appears recessed when its tool is selected. When you draw a line or other shape, the tool uses the current formatting attribute preferences. 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.

Each of these objects is considered a symbol by FactoryTalk Historian ProcessBook. In Build mode, when you select a symbol by clicking it with your mouse cursor, you will see small squares around the bounding rectangle of the symbol; these are called selection handles and you use these 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 appears whenever your cursor hovers over a symbol.

About the Toolbars


The toolbars are floating palettes of tools. You can use these when you want to draw an object or format the attributes of objects. To use the drawing tools, click the appropriate button. A button appears recessed when its tool is selected. Clicking a tool is the same as selecting the tool from the Draw menu.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 135

Building Displays

When you draw a line or other shape, the tool uses the current formatting attributes. These are established through the Preferences choice on the Tools menu. Toolbars can be moved by clicking their edges and dragging to a new location. They can be adjusted to be different rectangular shapes. To toggle toolbars on and off your screen, go to the View menu and click Toolbars. To have a toolbar appear, check its name. To add icons to a toolbar, drag them from the Commands page. To remove them, drag them off the toolbar while the Toolbars dialog is open. You can also create a custom toolbar. To see the name of a button, allow your mouse pointer to pause over the button.

Drawing Several Objects with the Same Tool


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
FactoryTalk Historian 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. Any of these functions can be performed on a single screen element or group of them. For information on grouping objects, see Grouping Multiple Objects (page 195). Make sure you have selected the item or items with the Build Mode pointer. OLE objects behave somewhat differently; this is discussed under Commands that Ignore OLE Objects (page 271).

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.

Page 136

Designing Trends

Setting Grid Size and Grid Snap 1. In Build mode, open a display. 2. On the Arrange menu, click Grid Size. 3. The Grid Size dialog is displayed. 4. In the Lines per Screen Unit box, type or select the number of grid lines per unit of drawing space.
Note: The size of a unit as displayed on your monitor varies according to the monitor's resolution and driver software.

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.

Designing Trends
Creating a Trend

You can 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 PI and other sources. You may create trends as part of a ProcessBook, or when you need a trend for a displayed value, bar, or Multi-State symbol. If the Plot Time continues through the current time, the trend will update 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.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 137

Building Displays

How to Create a Trend 1. In Build mode, open a display. 2. On the Drawing toolbar, click the Trend button. -orOn the Draw menu, click Trend.

The mouse pointer changes to the Trend pointer. 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. When you release the mouse button, the Define Trend dialog box is displayed.

Page 138

Designing Trends

4. In the Plot box, type a name. 5. In the Tags in Plot box, type the name of the tag. -orClick the Tag Search button to locate the tag. -orClick the Tag Search arrow to see more search options. 6. From the Server drop-down list, select the appropriate server if the tag is on another server. 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. 9. Select the Logarithmic check box to 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 gridlines associated with a logarithmic plot may confuse the plot. You can turn off the minor gridlines by setting the vertical minor grid color to "none" (see "Formatting a Trend" in this chapter).

10. In the Max and Min drop-down lists, select Autorange or Database or enter the values to determine the vertical scale.
Min Settings Autorange The trend will display with the Y scale starting at the closest available major axis. If the minimum is Autorange and the maximum is not, the scale will start at the lowest data value in the trace (not on a major axis) and end on the closest major axis. Max Settings The trend will display with the Y scale ending at the closest available major axis. If the maximum is Autorange and the minimum is not, the plot will start on the minimum value and end on the largest trace value (neither min nor max will be on a major axis).

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 139

Building Displays

Min Settings Database The tag's Zero attribute will be used to specify the minimum plot value. If the Zero value is <= 0, the minimum will be re-interpreted as Autorange. The value you type will be used as the first value on the Y axis. Values <= 0 will not be accepted.

Max Settings The tag's Zero + Span attributes will be used to specify the maximum plot value. If the Zero + Span is <= 0, the maximum will be replaced with Autorange. The value you type will be used as the Y scale maximum. Values <= 0 will not be accepted.

0 (absolute value)

11. From the Format drop-down list, select the format for the scale. Database is the default format.
Format Settings Database Database format will look at the tag's digits attribute and display the vertical axis values in standard format. If the length of the number exceeds the digits value, scientific notation will be used. Scientific notation will be used for all values. There will be no change to the scientific format used for trends. It will display in the format: 0.00E+00. The significant digits will be ignored for logarithmic plots, i.e., format 0.0 will not truncate 0.0000001 to 0.0. Because of precision issues, any number with more than DBL_DIG (15) significant digits will be rounded off at significant digit DBL_DIG. A value of 12345678901234567890 will be displayed as 12345678901234600000. The number is displayed with standard formatting with the exception of numbers with more than DBL_DIG (15) digits. In this case, scientific notation will be used. The program logic will use 1.0e+15 and 1.0e-15 as the maximum and minimum for standard formatting.

Scientific

Standard format (do not switch to scientific format for large numbers).

General

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 time on the horizontal axis. 14. Click OK.

Formatting a Trend
Trends that you draw will be formatted according to certain defaults. Using the Trend Preference settings (page 34), you can create your own default format for new trends. You can set options like line colors, background, and point markers, and you can set the types of point information included with a trend.

Page 140

Designing Trends

As you are drawing 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. The Define Trend dialog has a General tab for defining the trend and two other tabs for specifying the format:
Display Format tab gives options for the elements to be included in the trend. Trace Format is used to choose colors and linestyles for each trace (plot line) as well as

the axes, background, and text.


Layout Tab options determine the arrangement of rows and columns for multiple plot

trends.

Display Format Tab


1. Select Format Extended from the Edit menu -orClick the Trend Format button on the Formatting toolbar -orClick the Display Format tab in the Define Trend dialog box. The Display Format Tab is displayed. 2. In the Legend 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 below. 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 will not be displayed. If the length of the text in the legend is longer than the total height of the trend, the items will be removed in this order: engineering units, tag name, and then value. If the tag name is too long to fit in the legend, it will not be displayed.

3. In the Display box, check or uncheck options for displaying the plot title, vertical scale, the grid, and markers. The sample trend reflects the changes you make.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 141

Building Displays

When the Markers option is checked, markers indicate data points on the trend. If the Markers option is not checked, three markers are shown on each line to help you match a line to a tag. 4. Switch to the Trace Format (page 142) tab and select the plot element you want to format from the Plot Element drop- down list. 5. Choose the desired options from the marker type, line style, color, and line weight drop-down lists. 6. If you have multiple plots (not multiple traces or lines), click the Layout tab (page 142) to choose the arrangement of the separate plots. 7. Click OK to apply the formatting changes.

Trace Format Tab


The Trace Format tab is used to format several plot elements, including marker type, line style, color, and line weight for traces on trends. Text and background colors can be established; these are found near the bottom of the Plot Element drop-down box. Vertical and horizontal major and minor grid colors are also selected here. The default color for the vertical major and minor grids (as defined in the initial Trend Preferences settings) is black. Sometimes using another color or omitting a minor grid can be effective. If you wish to omit one of the grids, change the color to "none." 1. Select a plot element and choose the options you prefer. 2. Click OK to apply the formatting changes.

Layout Tab
The plot arrangement in a multi-plot trend is established by setting up the number of rows and columns of plots. For example, if you have 6 plots, you can arrange them in 6 rows with 1 column, or you can arrange them in 3 rows and 2 columns.

Page 142

Designing Trends

By using the ExRow and ExCol fields, you can set up 2 rows with one plot each and 2 rows with 2 plots each, as illustrated here:

Revising the Format for an Existing Trend

You can change the format of an existing trend (for example, to turn the grid on or off). The options you choose affect only the options of the trend you are displaying, not the default options. 1. In Build mode, open a display, and click the trend whose attributes you want to change. 2. On the Formatting toolbar, click the Trend Format button. -orOn the Edit menu, point to Format, and then click Extended.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 143

Building Displays

The Define Trend dialog box is displayed.

3. On the Display Format tab, under Legend, select or clear the Tag Name, Description, Value, and Eng Units check boxes. Your choices are reflected in the legend in the Sample area. 4. Under Display, select or clear the Plot Title, Vertical Scale Inside Axis, Grids, and Markers check boxes.
Note: Select the Markers check box if you want markers to indicate data points on the trend. If you do not select the Markers check box, then three markers will display on each line. These markers help you match a line to a tag.

Page 144

Designing Trends

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, then the legend will not be displayed. If the height of the text in the legend is longer than the total height of the trend, then the items will be removed in this order: engineering units, tag name, then value. If the tag name is too long to fit in the legend, then it will not be displayed.

Your choices are reflected in the legend in the Sample area. 5. Click the Trace Format tab. 6. From the Plot Element drop-down list, select the plot element you want to format. 7. Choose the desired options from the Marker Type, Line Style, Color and Line Weight drop-down lists. 8. Click OK to apply the formatting changes.

Moving a Plot
If you have created more than one plot in the trend, you can move each plot separately. 1. In Build mode click the plot you want to move. Selection handles appear around the plot. 2. Drag the plot to its new location.

Building a Trend with Multiple Plots


1. In Build mode, open a display. 2. On the Drawing toolbar, click the Trend button. -orOn the Draw menu, click Trend.

The mouse pointer changes to the Trend pointer.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 145

Building Displays

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. A new display window is opened. When you release the mouse button, the Define Trend dialog box is displayed.

Note: You can also open the Define Trend dialog box by clicking the Trend Display button. See "How to Build a Trend Display" in this chapter.

4. In the Plot box, type a name. The default name is Plot-0. 5. In the Tags in Plot box, type the name of the tag to be displayed in the first plot. -orClick the Tag Search button to locate the tag.

Page 146

Designing Trends

-orClick the Tag Search arrow to see more search options. 6. From the Server drop-down list, select the appropriate server if the tag is on another server. 7. To create another plot, click the New Plot button and select tags again. Repeat as necessary. To view the tags you have selected, you can click each plot name in the Plot box. 8. To view a sample of the arrangement matrix for the plots you are creating, click the Layout tab.
Note: These matrix options are available only when you create the trend and cannot be edited later. However, you can revise the traces on the display individually.

9. To revise the proposed plot arrangement matrix, under Plot Arrangement tab to 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. No extra rows or columns (ExRow and ExCol) were needed. Tab past the matrix to see the sample of your new selection.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 147

Building Displays

To arrange the four plots in separate rows, use this matrix:

Page 148

Designing Trends

To handle uneven numbers of plots, use a matrix like the one below for 5 plots in 3 rows:

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 149

Building Displays

When you are satisfied with the matrix arrangement, click OK. The plots will be drawn.
Note: Once the layout is set, you cannot revise it.

10. If you have built a trend display, click Save on the File menu. It will be added below the original display and labeled Trend Display.

Deleting a Plot within a Trend


1. In the Define Trend dialog box, click the General tab. 2. In the Plot drop-down list, select the plot you want to delete, and then click the Delete Plot button.
Note: Once you have drawn a trend, and you want to delete a plot, you can select the plot and then press DELETE.

Using OpenVMS Trends and Graphics


FactoryTalk Historian ProcessBook allows you to convert your existing OpenVMS trend and graphic files for use within a ProcessBook. Specifically, the following types of files are supported:
PIDisDIFF files, which contain trend graphs built using the PI Data Trending Package.

You can convert horizontal, vertical, composite, and overview trends.


PI-GP files, which are graphic files built using the PI-GP Graphics Builder.

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 box.

Converting 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

Page 150

Designing Trends

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 will be 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.

Converting 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 FactoryTalk Historian ProcessBook Install disks include an OpenVMS command file which performs Steps 1 - 5 for all graphics. The file is named GPPBConv.com.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 151

Building Displays

Designing XYPlots
Drawing an XY Plot

To create an XYPlot in FactoryTalk Historian ProcessBook, the general procedure is as follows: 1. In Build mode, on the Draw menu, click XYPlot -orOn the Drawing toolbar, click the XYPlot button. 2. Drag a rectangle on the display to create the boundaries. 3. Release the mouse button.

4. The Define XYPlot dialog box is displayed. displayed. 5. General Tab

The General Page (Tab) will be

Select tags to be plotted (see details on the next page). Choose what to show in the Legend and on the Display. Select how to color and style the plot elements, such as trace pens

6. Display Format Tab 7. Plot Format Tab and background.

8. Click OK. The XYPlot will appear. To revise an existing XYPlot, go to Build mode and double-click the XYPlot. The "Define XYPlot" dialog will appear. Make your changes and click OK.
Caution: Undo will restore your original plot, not simply remove one change.

Page 152

Designing XYPlots

General Tab
Plot Title box: Type in a plot title. You can change it later if you wish. Tags in Plot box: Select the tags or data sets you wish to plot. Enter tag names by typing in the list or by using the Tag Search button or the Dataset 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. When you have completed this configuration of your data set selection(s), they will appear as tagnames in the Tags in Plot list. When a tagname is entered, an options button appears in the Tags in Plot list. Click the Options button to choose the X-axis tag. Unchecked 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. You can use the four toolbar buttons on the title bar to rearrange this list. They are, in order, Add, Delete, Up Arrow, and Down Arrow. Server Box: Enter or select a server name to correspond to the highlighted tag. You may use different servers for different tags.

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 Tag Choose either Recorded or Interpolated for the retrieval method. If Interpolated is selected, an interval may be entered in the Plot Time section. Interpolated is the default for tags and is disabled for ODBC and Custom data sets. Y Tag(s)

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 153

Building Displays

Your data retrieval method applies to individually selected tags in the Tags in Plot list (unless Use for all Y tags is checked). The default data retrieval method is Synchronize. Y Tags, paired by position in the list To 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 timestamps To pair values by time, rather than by list position, choose one of these retrieval methods: Synchronize, Match, Match or Previous, or Match or Next. Match will find the point for Y corresponding to the exact timestamp as in X. Match or Previous: Find the point for Y corresponding to the exact timestamp as in X. If there is none, find the value that is the closest but earlier in time. Match or Next: Find the point for Y corresponding to the exact timestamp as in X. If there is none, find the value that is the closest but later in time. Synchronize will synchronize data found for X with data for Y using the timestamps for the X data. Synchronize and Match use different PI-SDK value retrieval methods. Synchronize uses TimedValues. Match uses RecordedValues and then uses the ones where the timestamps match. TimedValues: Match uses RecordedValues and then uses the ones where the timestamps match. Synchronize is disabled for ODBC and Custom data sets. If Synchronize or any of the Match selections is chosen, the start and end times for that tag are set to the ones for the X tag.
Note: The XYPlot supports ODBC data sets that don't contain timestamps. This type of entry must be plotted as a 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 will be changed to Interpolated. If the tag is a data set, the method will be changed to Recorded.

In all cases, if a pair is not made, the points are ignored.

Page 154

Designing XYPlots

Use for all Y tags Check Box: Checking this box indicates that the Y-tags data retrieval mechanism applies for all Y-tags. The default is 'unchecked.' 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 Scale or Multiple Y Scales Single Y-Scale is the default setting. Single Y Scale combines all tags onto one scale. All Y tags will have the scale visible in the combo boxes at the time of selection. Multiple Y Scales provides a separate scale for each tag. This choice will not change the scales min and max values, but will allow them to be configured independently. Regardless of the choice, the X scale tag may be configured independently. Min Autorange uses the minimum value plotted. User 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 will use the minimum value plotted. Max Autorange uses the maximum value plotted. User 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 will use the maximum value plotted. Format Selects the format of the Y scale.

Plot Time Time may be set 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. Start The start time of the XYPlot. The list includes *-1h (minus one hour), *-4h, *-8h, *-1d, *-7d. The default is *-8h. End The end time of the XYPlot. The list includes *, *-1h, *-4h, *-8h, *-1d, *-7d. The default is * (current time). Interval This is enabled when the retrieval method is Interpolated. It provides a sampling interval for data.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 155

Building Displays

When you have completed the General page, click the Tab for the Display Format Page.

Dataset Search Dialog To add a data set to an XYPlot, follow these steps: 1. In Build mode, double-click the XYPlot button to bring up the Define XYPlot dialog. 2. Click the arrow next to the Tag Search button. 3. Select ODBC or PI Calculation to see the corresponding Dataset Details or PI Calculation Data configuration dialog box. When you have completed the configuration, click OK and the data set name will appear in the Tags in Plot box. Click OK to see the plot.

Display Format Tab

Legend Choose the legend elements to be included in the XYPlot. Tag Name Server name is also included if it is not the default server. Default is checked. Description The tag description may be displayed on the legend. Default is yes. Value The last value of the tag plotted may be displayed. For digital and string tags, a string value is shown. The default is yes. Engineering Units The default is yes. Correlation Coefficient A check indicates that the correlation coefficient should be calculated and displayed on the legend. The default is yes.

Page 156

Designing XYPlots

Display Select the optional elements to be included in the XYPlot. Plot Title The default is yes. Vertical Scale Inside Axis Check this to show the vertical scale to the right of the Vertical Axis, inside the plot area. The default is yes. Grids Check this to include vertical and horizontal gridlines. The default is yes. On the Plot Format Page, you can configure the appearance of the major and minor gridlines. Linear Correlation Line Check this to show the linear correlation line. The default is NO. Connecting Lines Check this to show the points connected with straight lines in the order they are plotted. The default is YES. Unchecked indicates 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.

Plot Format Tab


In the Plot Format tab of the Define XYPlot dialog box, you can select colors and styles for the various elements of your plot. 1. Plot Element is a drop 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 order in the Tags in Plot box on the General page.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 157

Building Displays

2. Select an element in the Plot Element drop-down. The available options appear in the Element Format drop-down boxes. A drop-down arrow is grayed out if the option is not configurable. For example, text has color but not line style options. 3. Select the appropriate options. Your choices appear immediately in the Sample box. 4. When you have completed the Plot Format page, click OK and the XYPlot appears.

Examples of XY Plots
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. Example 1: Create an XYPlot on a display in FactoryTalk Historian ProcessBook to compare values for two PI tags 1. On the Drawing toolbar, click the XYPlot button and drag to form the bounding rectangle for the plot. The Define XYPlot dialog box is displayed. 2. Enter a title for the plot and select 2 tags to be entered in the Tags in Plot list. 3. Click an options button to select one tag to be the X tag. 4. Use the default settings for time range, scale, and retrieval method. 5. Click the Display Format tab and check the box for the linear correlation line. 6. Select the Plot Format tab and accept the default values. 7. Click OK and the plot appears. Example 2: Compare different tags to help optimize equipment performance For example, suppose an engineer has just completed some optimization work on Boiler1, one of the four boilers in the plant. He wants to optimize the other three boilers (Boiler2, Boiler3, and Boiler4) so that they perform at the same level. After adjusting the three boilers, he wants to see how closely they perform to the optimized Boiler1. Assume that all four boilers run identical processes. 1. Plot the temperature of Boiler1 (the B1Temp tag) on the X-axis of an XYPlot and the temperatures of the other three boilers (B2Temp, B3Temp and B4Temp) on the Y-axis. 2. Use the same time range for all four tags. 3. Select a single scale so that the Boilers 2, 3 and 4 are compared directly against Boiler1.

Page 158

Designing XYPlots

4. Configure the plot to show the correlation co-efficient for each of the boilers. By viewing how far from the correlation line each of the boilers falls, you can determine how closely their performance matches and which boilers you should continue to adjust. When all three boilers have an acceptable correlation coefficient, you know the work is complete.

Example 3: Lab Comparisons An engineer wants to compare lab results from his lab to those of another lab for the same sample of material. The plant's quality assurance lab has instituted some new testing procedures. In order to gauge the validity of the new testing procedures, an engineer wants to compare results from the new process against data from an outside lab that is known to have valid testing procedures. 1. Put the results from the in-house lab into a data set. 2. Place the results for the same test from the other lab into another data set. 3. Selects each data set as a tag in the plot, and select which one to be the X-axis. 4. Choose Recorded as the retrieval mechanism for each data set so that the results are not skewed by minor timestamp differences. If the XYPlot shows the results from the new process are well correlated with the outside lab's data, the new test procedure is validated.

Example 4: Comparing a Batch Run to a Standard An engineer wants to compare sample measurements taken from one Batch run and compare to a fixed set of measurements he knows to be desirable. 1. Select the fixed set of measurements by choosing the appropriate tag or data set and indicating it is to be used for the X-axis. 2. Select the appropriate tags for the comparison batches, entering their specific time ranges. 3. Use Recorded values for all retrieval mechanisms. The data points are paired according to their position in the events list. The XYPlot shows how closely the results correlated by how closely the points fall on a correlation line. Points that fall outside this correlation may indicate problems with the batch run.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 159

Building Displays

Example 5: Comparing Two Time Ranges An engineer wants to compare the performance of a Boiler unit over two time ranges. He needs to determine whether a boiler's performance has degraded over time or whether there are specific problems with the equipment. To do this, he creates an XYPlot that compares the temperature tag data from two different time ranges. 1. Enter the tag twice and assign one instance as the X tag. 2. Enter separate time ranges for each tag. Values are paired by their position in the list. If the points fall close to a correlation line, you can assume the boiler's performance is at least steady. If some points are far from the correlation line, it may indicate that the equipment has a specific problem.

Other Dynamic Symbols


Creating Dynamic Multi-State Symbols

A Multi-State symbol is one that changes color to reflect changes in value for a particular tag or data set value. Any object except a trend, graphic, button, or OLE object can be made a Multi-State symbol by assigning a tag to it. 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. You can create a Multi-State symbol after you have drawn a symbol or copied one from the Symbol Library dialog box. 1. In Build mode, open a display. 2. Click the symbol that you want to use for creating a Multi-State symbol. 3. On the Formatting toolbar, click the Multi-State Symbol button. -orOn the Edit menu, click Multi-State.

Page 160

Other Dynamic Symbols

4. The Multi-State Symbol dialog box is displayed.

5. In the Server drop-down list, select the server on which the tag resides. 6. In the Tag box, type the name of the tag you want to assign to the symbol. -orClick the Tag Search button to locate the tag. -orClick the Tag Search arrow to see more search options. 7. In the Number of States box, select the number of states for the symbol. 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.)

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 161

Building Displays

8. From the Color for Bad Data drop-down color palette, select a color that will be used when the information is bad. You may also select the Blink check box to call attention to the symbol when data is bad (optional). 9. In the State box, select 1. 10. 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.

11. 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). 12. 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. 13. Click OK.

Converting a Symbol from Multi-State to Static


You can remove a Multi-State symbol definition by breaking the link between the symbol and the tag. 1. In Build mode, open a display. 2. Click the symbol that you want to convert from multi-state to static. 3. On the Formatting toolbar, click the Multi-State Symbol button. -orOn the Edit menu, click Multi-State.

Page 162

Other Dynamic Symbols

The Multi-State Symbol dialog box is displayed.

If the symbol is already a Multi-State symbol, the dialog box contains the tag name and other information for the symbol. If the Tag box is empty, the symbol is not a Multi-State symbol. 4. Click the Convert to Static button.

Adding a Dynamic Value

1. In Build mode, open a display. 2. On the Drawing toolbar, click the Value button.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 163

Building Displays

-orOn the Draw menu, click Value. The mouse pointer changes to the Value pointer. 3. Click in the display where you want the value to be placed. When you release the mouse button, the Define Value dialog box is displayed.

4. In the Server drop-down list, select the server on which the tag resides. 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.

Page 164

Other Dynamic Symbols

Note: The Sample area shows how the value will look.

6. In the Format drop-down list, select a format for the value, or type your own format.
Format General 0 0.00 #,##0 #,##0.00 (#,##0) (#,##0.00) 0% 0.00% Scientific Database Value -25.434 25.59 17.246 -1732.87 -1732.87 -1732.87 -1732.87 3.25 3.25 3.25 Result -25.434 26 17.25 -1,733 -1,732.87 (1,733) (1,732.87) 325% 325.00% 3.25E+00

Uses the Display Digits attribute for the tag from the FactoryTalk Historian System.

Symbol # 0

Explanation Placeholder for a digit. Leading and decimal zeros are not displayed Placeholder for a digit. Leading and decimal zeros are displayed.

7. In the Tag drop-down list, select the location of the tag name in the value box (None, Left, Right, Top, or Bottom).
Note: The Sample area shows how the value will look.

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).
Note: The Sample area shows how the value will look.

9. Click OK to add the value to the display.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 165

Building Displays

Creating a Dynamic Bar

Creating a bar for a value allows you to see how the current value compares to the possible range of values. Since bars are dynamic, they are updated as the information changes from the PI Server. Bars may also be used to display the result of a data set query. 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. -orOn the Draw menu, click Bar. The mouse pointer changes to the Bar pointer. 3. Click in the display where you want to add the bar and drag the pointer to form a rectangle into which the bar will be placed.

Page 166

Other Dynamic Symbols

When you release the mouse button, the Define Bar dialog box is displayed.

4. In the Server drop-down list, select the server on which the tag resides. 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. 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.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 167

Building Displays

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.

9. Click OK to add the bar to the display.

Static Symbols
Adding a Button

You can add a button to your drawing that will: Open an independent display (.pdi).

For example you can: Create a drawing that shows the first part of a general process and add a button that opens a more detailed process in a separate display. Create a drawing and add a button that opens a FactoryTalk Historian DataLink spreadsheet to show a report. Create a drawing and add a button that opens an independent FactoryTalk Historian ProcessBook display (.pdi file) on a Web site. Note: You will need to enter the URL (Uniform Resource Locator) address, which points to a Web server and to the location of the specific .pdi file within that server.

Open a ProcessBook (.piw).

Execute an operating system command.

How to Add a Button 1. In Build mode, open a display. 2. On the Drawing toolbar, click the Button button. -or-

Page 168

Static Symbols

On the Draw menu, click Button. The mouse pointer changes to the Button pointer. 3. Click in the display where you want to add the button and drag the pointer to form a rectangle into which the button will be placed. When you release the mouse button, the Define Button dialog box is displayed.

4. In the Text box, type the name of the button.


Note: The name should be no more than one or two words, and should describe the file to which the button is linked.

5. Click the Browse button. -orClick the Browse arrow to see more options.

The Open dialog box is displayed. 6. Browse and locate the item that you want to link to the button and then click the Open button.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 169

Building Displays

Note: If you know the file or macro name, then you can type this directly in the Action box.

The file name is displayed in the Action box.

7. Click the Browse button to the right of the Working folder box.
Note: The Working folder box allows you to specify the working folder for operating system commands. It is ignored if the link refers to a document type supported by ProcessBook. If you know the name of the working folder for this application, then you can type this directly in the Working folder box.

The Browse for Folder dialog box is displayed. 8. Browse and locate the folder that you want to specify for operating system commands, and then click OK. 9. Leave the appropriate Options check box selected if you want to: Open a display in a new window. (This option is selected by default.) Use the relative path before the absolute path.

Note: ProcessBook always attempts to open a linked display from its absolute path first. If the absolute path fails, then the relative path is used. Selecting 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.

Page 170

Static Symbols

Note: If the file type is supported by ProcessBook (either natively or through an add-in), then it is opened directly. For example, a .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.

10. Click OK. The button is added to your display.

Drawing Polygons (Free-form Objects)

1. In Build mode, open a display. 2. On the Drawing toolbar, click the Polygon button. -orOn the Draw menu, click Polygon. The mouse pointer changes to the Polygon pointer. 3. Point to where you want to start drawing the first point of the polygon. (Point "a" in the example below.) 4. Drag to create the first side. (From point "a" to point "b" in the example below.) 5. Release the mouse button to position the second point of the polygon. (Point "b" in the example below.) 6. Click at each of the remaining points of the polygon. (Points "c" through "g" in example below.) Lines are drawn between the clicks. 7. To close and fill the polygon, double-click to place the last point in the polygon. (Point "g" in the example below.) A line is drawn from the last point to the first point. (Point "g" to point "a" in the example below.)

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 171

Building Displays

Symbol Library

Symbols include all of the shapes you can draw, as well as trends, bars, and values. You can group several symbols together to create one element of an entry. 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, Rockwell Automation 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.

Adding a Symbol 1. In Build mode, open a display. 2. On the Drawing toolbar, click the Symbol Library button. -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.

Page 172

Static Symbols

When you release the mouse button, the Symbol Library dialog box is displayed.

4. Under Categories, click the type of symbols you want to use, such as Boilers, Controllers, Valves, etc. 5. Click Options (page 173) to modify your symbol. 6. Click OK to add the symbol to your display. Symbol Options 1. In the Symbol Library (page 172) dialog, a selection of symbols is displayed in the right-hand side of the dialog box, click the appropriate symbol, and then click the Options button. -orRight-click the symbol and click Symbol Options.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 173

Building Displays

The Symbol Options dialog box is displayed.

2. From the Fill Mode drop-down list, select Original, Shaded, Solid or Hollow.
Note: The default setting for the Fill Mode drop-down list is Original. This setting returns the symbol to its original state.

3. Double-click the Fill Color box to change the color of the symbol. The Color dialog box is displayed.

4. Under Basic colors or Custom colors, click the appropriate color you want for your display, and then click the OK button.

Page 174

Static Symbols

Note: You cannot change the color of a symbol if Original is selected in the Fill Mode drop-down list.

5. From the Flip drop-down list, select Horizontal, Vertical, or Both to change the orientation of the symbol.
Note: The default setting for the Flip drop-down list is None. This setting returns the symbol to its original position.

6. From the Rotation drop-down list, select 90, 180, or 270 to turn the symbol by 90 degree increments.
Note: The default setting for the Rotation drop-down list is 0. This setting returns the symbol to its original position.

7. Under Background Options, clear the Transparent check box if you don't want a transparent background. Double-click the Background Color box to change the color of the background.
Note: The default setting for the Transparent check box is selected. The Background Color box shows the current background color of the display.

The Color dialog box is displayed. 8. Under Basic colors or Custom colors, click the appropriate color you want for your background, and then click OK. 9. Click the Defaults button if you want to revert to the default settings. 10. Click OK to accept the changes and return to the Symbol Library (page 172) dialog.

Changing the Appearance of a Symbol After you have created a symbol and added it to your display you can change its appearance through the Symbol Library dialog box. To do this: 1. Double-click the symbol you want to change. -or-

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 175

Building Displays

2. Click the symbol, and on the Formatting toolbar, click the Item Definition button. The Symbol Library dialog box is displayed.

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. 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 FactoryTalk Historian ProcessBook.

Graphics
In FactoryTalk Historian ProcessBook you can:
Include a graphic file from another application, such as Microsoft Visio or CorelDRAW. Use a drawing or picture as the background for your display, then add symbols to it. This

can reduce the amount of time you take to create a drawing.


Rotate or flip a picture. Add an illustration to a display, and store it within the display or link it to the original

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. 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 EMF ICO JPEG PNG SVG Windows Bitmap file; standard, non-compressed bit-mapped graphic A file that contains an image that defines the shape of a cursor on the screen. Enhanced Metafile Format; 32-bit Microsoft Windows Metafile vector format that also supports raster images. A file that contains a graphic of an icon. Joint Photographic Experts Group - Refers both to the standard for storing compressed images and a graphic stored in that format. Portable Network Graphics - graphic image format that utilizes lossless compression. Scalable Vector Graphics is a vector graphics language written in XML. Using SVG, graphics can be coded directly into an XML document.

Page 176

Static Symbols

TIFF, TIF WMF

Tag Image File Format graphic image. The Windows Metafile Format - the original 16-bit native vector file format for the Microsoft Windows operating environment.

Adding a Graphic

1. In Build mode, open a display. 2. On the Drawing toolbar, click the Graphic button. -orOn the Draw menu, click Graphic. The mouse pointer changes to a graphic pointer. 3. Click in the display where you want to add the text and drag the pointer to form a rectangle into which the graphic will be placed. When you release the mouse button, the Define Picture dialog box is displayed.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 177

Building Displays

4. Click the Browse button to locate the graphic drawing. -orIn the File Name box, type the path and file name of the graphic you want to insert. 5. Under Image Location, select: 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.

6. Under Format, select the appropriate option.


Note: Stretching the image to fit the bounding rectangle may distort the appearance of the graphic.

7. Click OK. 8. A copy of the graphic is added to the display.

Adding Text Labels

Use the Text tool to add labels to a schematic or flow diagram. 1. In Build mode, open a display. 2. On the Drawing toolbar, click the Text button. -orOn the Draw menu, click Text. 3. The mouse pointer changes to a text pointer. 4. Click in the display where you want to add the text. 5. Type the text in the text block. (You can only type the text on one line. It will not wrap.)
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.

Page 178

Static Symbols

6. When you finish typing, press ESC or click outside the text block.

Editing 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.

How to 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.

Drawing a Line

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.

How to Draw a Line 1. In Build mode, open a display. 2. On the Drawing toolbar, click the Line button. -orOn the Draw menu, click Line. 3. The mouse pointer changes to the line pointer. 4. Point to where you want to start the line.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 179

Building Displays

5. Drag to draw the line. Press the SHIFT key while drawing to constrain the line to a horizontal or vertical line.

Drawing a Rectangle, Square, Arc, Ellipse, or Circle

Using the drawing tools, you can create these shapes:


Rectangle, Square Arc Ellipse, Circle

1. In Build mode, open a display. 2. On the Drawing toolbar, click the Rectangle, Arc or Ellipse button. -orClick the appropriate tool. The mouse pointer changes to a tool pointer. The appearance of the pointer indicates the type of tool you have chosen. 3. Click the display to place the upper left corner of the shape, and drag down and to the right to create a shape of the desired size. Press SHIFT while drawing to constrain the object to a square, circle, or circular arc. 4. Release the mouse button. This completes Rectangles, Squares, Ellipses, or Circles. 5. If you used the arc tool, one quarter of the shape is drawn. You can then click on it and resize it to the desired shape. Click and drag the end of the arc to change the angle.

Page 180

Formatting Attributes

Press SHIFT to change the angle in 15-degree increments. When the arc is first drawn, the handle for reshaping the angle is just inside the resize handle.

Formatting Attributes
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 in the ProcessBook Preference dialog box are applied to any new drawing symbol. You may change these attributes, however, for individual symbols or for all selected symbols as a group. Attributes of each symbol that you may edit include line and fill colors, background colors, line styles, weights, and end markers, depending on the symbol. You must use the Build Mode pointer to select the symbol you want to edit. The following table shows the attributes that may be edited for each object.
Colors Line Line Rectangle Text Ellipse X X X X X X X X X Fill Background Line Styles Style X X Weight X X Ends X

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 181

Building Displays

Arc Value Polygon Polyline Bar Trend

X X X

X X X

X X

X X X

X X

X X

X X X

Applying Color Attributes

When selecting colors, keep in mind if you choose a dark background for a drawing, you should plan to use a lighter or brighter color for other symbols. With any color scheme, you should select colors that will be easy on the eyes. You may wish to select colors that will accommodate color-blind viewing.
Note: The color attributes you can change vary depending on the symbol you have selected.

1. In Build mode, open a display, and click the symbol whose color attributes you want to change. -orIf you want to change the color attributes of new symbols you draw, then don't select any symbols. 2. On the Formatting toolbar, click the Drawing Color button. -orOn the Edit menu, point to Format, and then click Color.

Page 182

Formatting Attributes

The Format Color dialog box is displayed.

3. Click the Line, Fill, or Background box, and in the color palette, click the color you want to use.

Note: The 16 colors that display in the color palette are the colors you specified in the ProcessBook Preference dialog box.

-orClick the None button if don't want any color. -orClick the Custom Color button if you want to create a new custom color. 4. Click OK to apply the color changes.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 183

Building Displays

Custom Colors 1. In the color palette, click the Custom Color button.

The Color dialog box is displayed.

Note: We recommend you use solid, not dithered, colors for custom colors. (Dithered colors include alternate pixels of white.)

2. You may select a new color by clicking any color point in the color swatch at the right. -or-

Page 184

Formatting Attributes

You may select a new color by clicking any color under Basic colors. The color you have selected appears in the Color/Solid box. 3. Click the color swatch to change the Hue and saturation (Sat), and then move the slider in the color gradient to change the luminescence (Lum). 4. Click the Add to Custom Colors button, and then the OK button to return to the Format Color dialog box. 5. Click OK to apply your color choice.

Font Attributes
Font attributes include the font (for example, Arial), the style of the font (for example, italic) or the size of the font (for example, 10 point). You can change font attributes for each selection individually or for the entire entry. When choosing fonts, plan to use fonts that other FactoryTalk Historian ProcessBook users are likely to have. If another user does not have the fonts you used, FactoryTalk Historian ProcessBook attempts to match the font to an existing font. However, the match may make it difficult for another user to read the entry. You can change the font for text, values, or trends within an entry.

How to Change Font Attributes

1. In Build mode, open a display, and click the symbol whose font attributes you want to change. -orIf you want to change the font attributes of new symbols you draw, then don't select any symbols.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 185

Building Displays

2. On the Formatting toolbar, click the Font button. -orOn the Edit menu, point to Format, and then click Font. The Font dialog box is displayed.

3. In the Font box, click a name. 4. In the Font style box, click a style. 5. In the Size box, click a font size. The Sample area reflects your changes. 6. Click OK to apply your font choice.
Note: For information about the Script box, refer to your Windows documentation.

Page 186

Formatting Attributes

Line Attributes
You can choose the type of line you want to draw. Lines can be of varying thickness, solid or dashed, and can include arrowheads. Line styles can be changed for any of the shapes (rectangle, ellipse, etc.) as well as for lines and bars. These attributes are available for the objects as shown.
Style Line Rectangle Ellipse Arc Polygon Bar X X X X X X Weight X X X X X Ends X

Changing Line Attributes

1. In Build mode, open a display, and click the symbol whose line attributes you want to change. -orIf you want to change the line attributes of new symbols you draw but not existing ones, then open a display but don't select any symbols. 2. On the Formatting toolbar, click the Line Width button. -orOn the Edit menu, point to Format, and then click Line Style.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 187

Building Displays

The Format Line Style dialog box is displayed.

3. From the Style drop-down list, select a line style. 4. From the Weight drop-down list, select the line thickness you want. 5. From the Ends drop-down list, select the line end you want for the end point of the selected shape. The Sample area reflects your changes. 6. Click OK to apply your line choices.

Working with Existing Symbols and Groups of Symbols


How to Select a Symbol 1. In Build mode, open a display. 2. Click a symbol in your display. Small squares appear around the bounding rectangle of the symbol; these are called selection handles.
Note: To cancel a selection, press ESC or click outside the handles.

Page 188

Working with Existing Symbols and Groups of Symbols

How to Move a Symbol 1. In Build mode, open a display. 2. Click the symbol you want to move.
Notes: A selected symbol displays handles. For freeform symbols, such as polygons or polylines, you may click anywhere within the bounding rectangle

3. Drag the symbol to the new location.

How to Delete a Symbol When you want to delete a drawing symbol or group of symbols: 1. In Build mode, open a display. 2. Click the symbol or group you want to delete and then press DELETE. -orOn the Edit menu, click Clear.
Note: A selected symbol displays handles.

Displaying an Item's 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 a dynamic symbol. It is the same as double-clicking on the item with the Build mode pointer. If the object does not have a definition dialog box, the button will be dimmed. You can change the selections and save the new definition.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 189

Building Displays

How to Display or Change a Definition 1. In either Build or Run mode, open a display. 2. Double-click the symbol whose definition you would like to change (such as a value, bar, trend, or button). -orClick the symbol, and on the Formatting toolbar, click the Item Definition button. Depending on the symbol you select, one of the following dialog boxes displays:
Symbol: Value Bar Trend Button XYPlot Name of Dialog Box Define Value Define Bar Define Trend Define Button Define XYPlot Refer to: "How to Add a Value" "How to Create a Bar" "How to Create a Trend" "How to Add a Button" "Drawing an XYPlot"

Note: If the Item Definition button appears dimmed, then the symbol you selected does not have a definition dialog box.

3. In the appropriate dialog box, make your changes to the item's definition (see corresponding topic under the "Refer to" column in the table above) and then click OK.

Resizing or Reshaping a Symbol


In Build mode, open a display, and click the symbol want to resize or reshape. If the symbol has:
Selection handles

, then drag a selection handle until the shape of the symbol is the size you want. To resize the symbol proportionally, drag a corner handle. , then drag a reshaping handle until the shape of the symbol is the shape you want.

Reshaping handles

Page 190

Working with Existing Symbols and Groups of Symbols

Rotating a Symbol
You can rotate a drawing symbol in 15 or 1 increments. You cannot rotate text, graphics, or OLE objects. 1. In Build mode, open a display, and click the symbol you want to rotate. On the Arrange menu, click Rotate. A rotation object appears in the center of the symbol. 2. Click a selection handle and drag in the direction in which you want to rotate the symbol. The symbol is rotated in 1 increments. Press SHIFT while dragging to rotate in 15 increments.

Flipping a Symbol
You can create a mirror image of a symbol by flipping it. You cannot flip text, graphics, or OLE objects. 1. In Build mode, open a display, and click the symbol want to flip. 2. On the Arrange menu, point to Flip, and then click Horizontal to flip the symbol from right to left or Vertical to flip the symbol from top to bottom.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 191

Building Displays

Deleting a Symbol
When you want to delete a drawing symbol or group of symbols: 1. In Build mode, open a display. 2. Click the symbol or group you want to delete and then press DELETE. -orOn the Edit menu, click Clear.
Note: A selected symbol displays handles.

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. The first symbol you draw is at the bottom of the stacking order. The last symbol you draw is at the top of the stacking order. Using the stacking commands, you can change the location of a symbol within the stack. 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. How to Move a Symbol Forward or Backward in a Stack 1. In Build mode, open a display. 2. Click the symbol you want to move.
Note: A selected symbol displays handles.

Page 192

Working with Existing Symbols and Groups of Symbols

3. On the Arrange menu, choose the direction you want to move the symbol:
Click Forward to move it up one layer. Click Backward to move it down one layer.

Click Bring to Front to move it to the top of the stack. Click Send to Back to move it to the bottom of the stack.

Working with Multiple Symbols


You can perform many of the editing and organizing functions on more than one symbol at a time. For example, once selected, you can move multiple symbols to a new location, edit the color of lines and fills for multiple symbols, or even flip and rotate multiple symbols.

Selecting Multiple Symbols


1. In Build mode, open a display. 2. Click the symbols you want to change or move.
Note: A selected symbol displays handles.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 193

Building Displays

3. Do the following:
If you want to: Select all of the symbols in a drawing area. Select individual symbols. Then: Click Select All on the Edit menu.

Press the SHIFT key while clicking each symbol. Selection handles are displayed around each item.

Select several symbols at the same time. Select symbols that are stacked on top of each other.

Click near the first symbol. Drag to create a rectangle that includes all the symbols you want to select. Click the top symbol and selection handles appear. If you continue clicking on the top symbol, the selection handles appear around each symbol as it moves down each layer in the stack. This helps you locate a symbol that may be hidden by another symbol.

Aligning Multiple Symbols


You can align drawing symbols with each other. Use this feature to align symbols along their tops, bottoms, sides, or centers (either vertically or horizontally). The first symbol you select is the symbol to which others are aligned. When two or more values are aligned, the justification for each matches the alignment rule: left, center, or right. How to Align Symbols 1. In Build mode, open a display. 2. Click the symbols you want to align.
Note: A selected symbol displays handles.

3. On the Arrange menu, click Align.

Page 194

Working with Existing Symbols and Groups of Symbols

The Align submenu is displayed.

4. Click the alignment options you want. All the selected symbols are aligned to the symbol you first selected, along the axis you specify. Examples of Alignment Options

Grouping Multiple Symbols


When creating or manipulating complex shapes, it is sometimes easier to combine individual symbols into one. You can group two or more symbols together, or you can group several groups. Once grouped, any commands that you apply affect the composite symbol as if it were a single symbol. How to Group Two or More Symbols into One Composite Symbol 1. In Build mode, open a display. 2. Click the symbols you want to group.
Note: A selected symbol displays handles.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 195

Building Displays

3. On the Arrange menu, click Group. The symbols are combined into one composite symbol with selection handles around the entire group. How to Ungroup a Composite Symbol into Two or More Symbols To break a composite symbol apart for editing or resizing individually, 1. In Build mode, open a display. 2. Click the composite symbol.
Note: A selected symbol displays handles.

3. On the Arrange menu, click Ungroup. Selection handles appear separately around each symbol. How to Regroup Symbols into a Composite Symbol 1. In Build mode, open a display. 2. Click at least one symbol in the group. 3. On the Arrange menu, click Regroup.
Note: You do not need to reselect all the components.

Connecting Symbols
Using Connector Symbols
Two symbols can be connected to each other using the Connector symbol. The Connector symbol remains with each of the connected symbols whenever they are moved. The advantage of using a Connector, rather than a line, is that the Connector will remain attached to other symbols when you move the other symbols and will avoid 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.

Page 196

Connecting Symbols

Connectors try to avoid objects as they are being connected between two symbols. The Connector symbol is supported by automation within FactoryTalk Historian ProcessBook.

Connecting Two Symbols with a Connector To draw a Connector to link symbols use the Connector toolbar button. -orOn the Draw menu, click Connector. As Connectors are drawn, they are orthogonal to the display, meaning that they go horizontally or vertically. There are no diagonal connectors. Each end of a Connector attaches to a Connection Point on another symbol. If you have not already created a Connection Point on this symbol, a Connection Point will be built automatically as you draw the Connector across a bounding line of the symbol. Connectors and Connection Points have unique numbers to help you manipulate them in the Connectors dialog box. Once you have drawn one Connector, even if it is not attached to any symbols, you can open the Connectors dialog. Do not manipulate Connectors by dragging and dropping them. Use the Connectors dialog to rearrange them. Follow these steps to connect two existing symbols on a display: 1. Click the Connector toolbar button, shown above. 2. Click on the first symbol, called the "Source," and drag the cursor into the second symbol, called the "Destination." The Connector arrow will have a flow direction from the Source to the Destination. Connection Points will appear on both symbols.
Note: If you do not quite touch a symbol, you will 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.

You can use Undo/Redo with Connectors.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 197

Building Displays

Attaching a Symbol to a Connector You can attach a symbol, such as a text box or a meter, to a Connector. "Attaching" is different from "Connecting." An attached symbol moves with a connector but does not involve flow direction.

Working with 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 built originally 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 will either move to the existing Connection Point or create 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.

Connector with Connection Point on the Bounding Rectangle

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.

Page 198

Connecting Symbols

Adding Connection Points If you want an additional Connection Point, you can build it as follows: 1. In Build mode, select the symbol. 2. On the Edit menu, choose Connection Points > Add. A point appears at the upper left of the symbol. 3. If you wish, drag the new Connection Point to a different location.

Selecting among Multiple Connection Points on One Symbol After you select one Connection Point, you can press the C key on the keyboard to cycle through any additional Connection Points on that symbol.

Deleting Connection Points To delete a Connection Point from a symbol, select the Connection Point and choose Edit > Connection Points > Delete.

Moving Connection Points Connection Points may be moved to a new position within a symbol. To do this, click on a Connection Point in Build mode and drag it. For very fine adjustments, you can move Connection Points on a symbol. 1. In Build mode, click on a connection point. 2. On the Edit menu, click Connection Points > Move. The Connection Point Placement dialog appears, where you can edit the width and height ratios in comparison to the X and Y axes of the symbol.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 199

Building Displays

Page 200

Connecting Symbols

Adjusting Connection Points

Determining the Identifying Number of a Connection Point In Build mode, if you place your mouse over a Connection Point, a tooltip will show you the Connection Point number. The following illustration refers to Connection Point 2 on Rectangle 1. These Connection Point numbers are used on the Connectors Dialog Flow tab (page 201).

Connection Point Numbering 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.

Rearranging Connectors from One Connection Point or Symbol to Another

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 201

Building Displays

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, or On the Edit menu, click Connectivity, or On 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.

Connectors Dialog with Source and Destination Trees

Page 202

Connecting Symbols

Connectors Dialog, Flow Tab The Connectors Dialog, Flow tab specifies the source and destination of each Connector from one symbol's Connection Point to another symbol's Connection Point. The dialog is available whenever a Connector exists on a display. The Flow tab shows two tree diagrams, Source and Destination, where you can change the Connection Points for the Connector shown in the Connector drop-down box. There is also a Flow Direction drop-down box associated with the Connector that appears in the Connector drop-down box. Each Connector and each Connection Point are numbered.
Note: Use the tooltip on the display to identify the Connector(s) and Connection Point(s) you wish rearrange before you open the Connectors dialog.

The Auto Avoid option is checked as a default, so that Connectors will route around other objects in the display.

Using the Flow Tab 1. In Build mode, click the Connectors button to open the Connectors dialog. The Flow tab will be in focus.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 203

Building Displays

2. In the Connector drop-down box, select a Connector. Connectors are numbered; you can find a tooltip on the display to identify each one. In the Source and Destination boxes, you will see highlights for the current Connection Points for that Connector. 3. Modify the Flow Direction if you wish. 4. Click a new Connection Point on the Source tree to change the Source Connection Point. 5. Click a Connection Point on the Destination tree to change the Destination Connection Point. 6. Click Apply. This will change the display. 7. Repeat these steps for all Connectors on the display that you wish to modify. 8. Click OK. If the display is satisfactory, save it.

Attaching a Symbol as an Adjunct to a Connector


Sometimes it is desirable to attach a symbol, such as a flowmeter or a text label, along a Connector so that the symbol moves as the Connector does. This subordinate symbol is called a 'symbol attachment.' Note that this is different from connecting a symbol to either end of a Connector. To attach a symbol to a Connector, follow these steps: 1. On the Edit menu, click Display to open the Display Properties dialog. Be sure the Enable Connector Attachments option is checked. Click OK. 2. Create the subordinate symbol and drag and drop it across the Connector. The subordinate attachment is attached to the Connector. The placement is snapped either left/right or top/bottom depending upon the orthogonal direction of the connector at the position where the attachment has been placed. 3. To attach symbols to Connectors, select the Connector, then on the Edit menu, click Symbol Attachments.

Removing an Attached Symbol from a Connector Select the attached symbol and drag it away from the Connector.

Connectors Dialog, Attachments Tab

Page 204

Connecting Symbols

For very complex displays, it may be helpful to attach or arrange Connector Attachments through the Connectors Dialog, Attachments Tab. (The Attachments Tab does not include Connectors or symbols attached to other symbols.) If you do not check the Enable Connector Attachments on the Display Properties dialog, discussed above, you can still attach symbols to Connectors by using this dialog.

How to Add a Symbol as an Adjunct to a Connector 1. In Build mode, create the Connector. Notice its number in the tooltip. 2. Create the auxiliary symbol to be added to the Connector. 3. Click the Connectors icon or right-click on the display and select Connectors.... The Connectors Dialog appears. 4. Select the Attachments tab. 5. Choose a Connector from the numbered list in the drop-down box at the top. 6. After you select a Connector, unattached symbols on the display will be listed in the Symbols box. Symbols that are already attached to the Connector will appear in the

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 205

Building Displays

Currently Attached box. Existing Source and Destination symbols that are connected to Connectors will not be listed. Highlight a symbol in the Symbols box to be added. Click Add. The symbol will now appear in the Currently Attached Box.

Page 206

Connecting Symbols

7. If you wish, adjust the position and placement of the attached symbol. 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, double-click the default Top and choose Left, Right, or Bottom.

8. Click Apply and select another Connector to adjust. 9. If you need to remove an attachment, highlight the attachment in the Currently Attached box and click Remove. 10. When you are finished adjusting, click OK.

Attaching a Symbol as an Adjunct to Another Symbol


You may wish to attach two or more symbols (not Connector Symbols) so that they move together but do not become a Composite Symbol. For example, you might attach a text label symbol to a pump symbol. The text symbol is subordinate to the pump symbol and follows the pump symbol if the latter is moved. The advantage of this method of attachment is that each symbol in the group retains its identity and can be acted on individually for automation purposes. 1. Select at least two symbols. This enables the Symbol Attachments icon, shown above. 2. Click the Symbol Attachments icon. The Symbol Attachments dialog will appear. The symbols you selected will appear in the Attachments dialog as possible master or subordinate symbols.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 207

Building Displays

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, uncheck its checkbox. 6. Click OK. When you move a Master symbol, any subordinates will move with it.
Note: There are two other routes to the Symbol Attachments dialog. On the Edit menu, click Symbol Attachments; or, on the right-click menu, click Symbol Attachments.

Moving Attached Symbols Independently Click and drag an attached symbol that is not the Master Symbol to move the symbol independently without affecting the position of the Master Symbol.

Spotlighting Connections and Attachments


To see whether Connectors or attached symbols exist for a particular symbol, select it and hold down the mouse button for more than one half second. If there are no Connectors, nothing happens.

Page 208

Layers within Displays

If there are existing Connectors, all Connectors with attached symbols for this symbol will be highlighted in a reverse color (for example, white for black or yellow for blue). Spotlighting occurs with Symbols attached and/or connected to Connectors and with Symbols attached to Symbols.

Rerouting Connector Path


When you move a symbol, its Connectors shift automatically to stay connected to the moved symbol and to avoid overlapping other symbols in the display. Connectors can overlap each other. If a drawing becomes complex, you can request that all Connectors be rerouted by clicking the Reroute button, shown above. If you select specific Connectors and click Reroute, only these will be rerouted. Connectors crossing each other may be unavoidable but should be minimized. Do not move Connectors manually.
Note: Object avoidance will no longer occur after you drag and drop a Connectors line segment. If you modify the position of a Connector manually, the center point and end points on the Connector change from green to red, indicating that automatic object avoidance is turned off and you are responsible for all further updates to that Connector.

The object avoidance feature of ProcessBook can either ignore or take Connectors into account when looking for the shortest path from the source to a destination. The ConnectorsAvoidConnectors setting in the ProcBook.ini (page 292) file controls this behavior for the application. 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

Layers within Displays

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 209

Building Displays

You can divide a display into layers. A layer may contain one or more symbols. This feature could be useful in building a complex display with several systems depicted (electrical, HVAC, etc.). If you separate systems by layer, you can look at any one of the layers by making the other layers invisible. A layer can be Visible or Invisible in Run mode. Layers are always Visible in Build mode. Regardless of mode, a layer can be Active, which means it accepts all new symbols as you add them to the display. Alternatively, the layer may be Inactive," which means no symbols will be added automatically. When a symbol is added to a display, it is automatically added to all active layers. Symbols can also be moved between layers or removed from a layer. You can still add a symbol to an Inactive Layer with a manual procedure.

Page 210

Layers within Displays

Regardless of mode, a layer can be Locked, which means its contents cannot be moved, symbols cannot be added, the position in the stack of layers cannot be modified, and the layer cannot be deleted. Alternatively, the layer may be Unlocked, and can be edited in these ways. Each layer has an index number representing its relative position in the stack of layers. Layer 1 is on the bottom; its contents may be hidden by larger elements of Layer 2, etc. Layers can be restacked to change the sequence. To summarize, layers can be added, made visible, restacked, and locked while ProcessBook is in either Run Mode or Build Mode. Layers can only be deleted when ProcessBook is in Build mode. There is an icon in the Status Bar at the bottom of your FactoryTalk Historian ProcessBook window indicating whether or not your selected display has layers. The tooltip tells how many active layers are present. A slash in the icon indicates there are no layers.

Working with Layers


After you open a display, you can begin to change the Layers characteristics of the display. First, open the Layers Dialog box by one of these methods:
Double-click the Layers icon in the Status Bar. Click the Layers toolbar button. On the View menu, click Layers.

The Layers dialog box appears. This dialog box is used to add, rename, and delete layers from the current display. The dialog box is also used to determine the Visible, Active, and Locked properties:

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 211

Building Displays

Layer Properties Dialog Box

Index The Index column specifies 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.

Name This column specifies the name of the layer. Rename a layer by double-clicking a name and typing a new name in the same space.

Count This 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.

Page 212

Layers within Displays

Visible Checking this column in Build mode makes the elements on this layer visible in Run mode. If the column is not checked, then symbols that belong only to the selected layer are not displayed in Run mode. Symbols on visible layers are displayed in layer order. This means that symbols that are on higher numbered (higher index number) layers will cover/hide symbols on symbols that are on lower index numbered visible layers.

Active/Inactive When you add a symbol to a display with layers, the symbol is included in all Active layers automatically. It is not included in any Inactive layers. You can add a symbol to an Inactive layer or remove a symbol from any Unlocked layer by selecting the symbol and right clicking. Choose Assign Layers. Select and deselect the layers as needed.

Locked/Unlocked You cannot add symbols to locked layers. Symbols on locked layers cannot be cut, copied, pasted, deleted, or moved. If you select a symbol on a locked layer, you can click the right mouse button and choose Assign Layers. You can assign the symbol to one or more additional unlocked layers. If you open the Layer dialog box, you can change the properties of all layers, including the locked ones.

Move Layers Arrows Up and down arrows 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 restacked.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 213

Building Displays

Creating a New Layer Clicking the New Layer button opens a dialog box prompting for the name of a new layer. A default name comprised of the word Layer prefixed to the layer number is presented. The layer number does not necessarily match the index number; it is simply the next unused integer in the list.

New Layer Dialog

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.

Delete Layer Button The Delete Layer button is enabled when a layer has been selected. If you click Delete Layer, you are prompted with a dialog box to confirm the deletion. Symbols are deleted if they belong only to the layer that is being deleted. If a symbol belongs to more than the layer being deleted, the symbol is not deleted. Also, symbols within composites will remain unless the entire composite is deleted.

Apply Button If you are manipulating layers in Run mode, the Apply button can be used to see the impact of changes to the Visibility property. Use this to accept changes without leaving the dialog.

Assigning Symbols to Layers


If you have at least one layer in a display, you can assign symbols to it. Select a symbol and right click. The context menu shows an Assign Layers item.

Page 214

Layers within Displays

Selecting this menu item displays the Assign Layers dialog box, showing all current layers.

Assign Layers Dialog Box

Selecting or clearing the checkbox adds or removes a 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.

Layers and Composite Symbols

To link symbols and create composite symbols select Arrange > Group, or click the Group button on the Formatting toolbar. The symbols may be on different layers when they are grouped.
A composite symbol can be assigned to any layer(s) regardless of its component symbols. Symbols on locked layers cannot be grouped into a composite symbol, but the layers may

be locked after the symbols are grouped.


A composite symbol that contains symbols on locked layers may not be deleted. The

unlocked layer may be deleted.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 215

Building Displays

Normally, a symbol existing only on one layer is deleted if the layer is deleted, but when

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 the parts of a composite symbol cannot be selected individually, they must be

ungrouped in order to change their layer assignments individually.

Active Layers Status Bar


The Layers icon on the Status Bar shows whether or not the display has more than one layer. This icon appears in the status bar at the bottom of your application, indicating one or more layers in the display currently in focus. Double-clicking the icon displays the Layers dialog box. If no layers have been defined, the icon appears with a slash through it. Hovering the mouse over the icon displays a tooltip with the names of any active layers, beginning with the top layer.

Active Layers Status Bar Area (with tool tip)

Data Sets
FactoryTalk Historian ProcessBook can build trend traces, values, or bars from data retrieved from data sets just as it does 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. Placeholders may be used 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 will be updated. This is unnecessary if the data set is configured using absolute times.

Page 216

Data Sets

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 217

Building Displays

You can edit an existing data set, either from the Tools menu or from a trend, bar, or value that accesses the data set. However, if you have attached the data set to more than one symbol, the editing of the data set affects all the symbols. If you move a FactoryTalk Historian ProcessBook display containing a data set to another machine, you will need to reconfigure the data set. Three types of data sets are available to provide data to displays:
PI Calculation (page 218) data sets (including PI Expression and PI Summary data

sets) from PI Universal Data Server equations.


ODBC (page 242) (Open Database Connectivity) data sets obtained from a relational

database. ODBC client capability means that without writing vendor-specific code, you can access data from certain relational databases outside the FactoryTalk Historian System and include that data in your FactoryTalk Historian ProcessBook displays. The outside data source must be "ODBC-enabled"; i.e., it must provide an ODBC Driver. An outside ODBC data source might include laboratory results, cost tables, or other sets of information that can be obtained through SQL queries.
Custom data sets (page 223) built as COM objects supplied by Visual Basic or C++

programs as Add-Ins to FactoryTalk Historian ProcessBook.

PI Calculation Data Sets


PI Calculation Data Sets include PI Summary Data Sets and PI Expression Data Sets. These are drawn from the PI Universal Data Server and plotted dynamically. The new data sets are very efficient in terms of the network traffic needed to support the data access. The PI Calculation dialog is used to create, edit, or delete data sets. You can select predetermined calculations or create your own expressions. A similar dialog is used to link to ODBC data sets (page 236). PI Summary Data Sets 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.

Page 218

Data Sets

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.

How to Create a PI Calculation Data Set 1. From the Tools menu, click Data Sets. 2. The Data Sets dialog box is displayed.

3. Click the New button, then choose PI Calculation.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 219

Building Displays

4. The PI Calculation Data dialog box is displayed. 5. In the Name box, type a name for the data set.
Note: The data set name must be unique for the current .piw or .pdi file.

6. In the Description box, type a description that will appear on trends of this data set in the area where tag descriptors appear. 7. Leave the Stepped Plot check box at the default setting (selected) or clear the check box if you want a point-to-point plot. 8. In the Refresh Interval list, click the interval at which you want to automatically update the data set. -orType a number between 0 and 999.
Note: If "0" is selected, then the data will not be automatically updated.

For a Predetermined PI Summary Data Set 1. Complete Steps 1 - 6 in How to Create a PI Calculation Data Set (page 219). 2. From the Server drop-down list, select a Server. 3. Click the Tag Search button to search for a tag. 4. The Tag Search dialog box is displayed. -orIn the Tag or Expression box, type a tag name or calculation. 5. In the Interval list, click the interval (minutes, hours, days) for the calculation. Some common choices are already provided. See further details below. -orType a number.

Page 220

Data Sets

6. In the Sync Time box, type a time. This is the absolute time of day at which the periodic calculations are done. For example, if the Sync Time box is set to 12:00:24 PM and the time in the 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. 7. Under Columns, click the available PI summary function(s) you want. You can see a preview of the first functions results. 8. Click OK. A confirmation message is displayed. 9. Click OK to save your changes.

For a PI Expression Data Set 1. Complete Steps 1 - 6 in How to Create a PI Calculation Data Set (page 219). 2. From the Server drop-down list, select a server. 3. In the Tag or Expression box, type an Expression using PI Performance Equations syntax, such as one of these: sinusoid * 2 (cdt158+sinusoid)/2 log(cdt158) ((sinusoid) tagzero (sinusoid))/tagspan(sinusoid) 4. In the Interval list, click the interval (minutes, hours, days) for the calculation. Some common choices are already provided. See further details below. -orType a number. 5. In the Sync Time box, type a time. This is the absolute time of day at which the periodic expressions are evaluated. For example, if the Sync Time box is set to 12:00:24 PM and the time in the Interval box is set to ten minutes, then the expression for each period is evaluated at the following times: 12:10:24, 12:20:24, 12:30:34, etc. 6. Under Columns, click the name which will represent the time-value pairs of the calculated data.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 221

Building Displays

7. Click OK. A confirmation message is displayed. 8. Click OK to save your changes. If the properties are not completely and correctly filled, the following warning message is displayed; "The Data Set is not executable because the query is not valid."
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.

Intervals The calculated value for each interval is plotted at the start of the interval. For example, if the tag "t_min" has the following time-value pairs in a 10 minute interval, then the calculated value for this interval would be plotted at time 1:00:00. Time Value 1:00:00 1 1:01:00 2 1:02:00 3 1:03:00 4 1:04:00 5 1:05:00 6 1:06:00 7 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

Page 222

Data Sets

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 the 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.

Custom Data Sets


A custom data set is one obtained through a VBA Add-In to ProcessBook. It is a COM object that acts as an interface between FactoryTalk Historian ProcessBook and the custom data provider. The source of data could be a data store (like MS SQL Server) or a data calculation engine. FactoryTalk Historian 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 dialog box. Later, as you build a display, you select the data set and column to be used for a symbol on a display through the Define Bar, Define Value, or Define Trend dialog boxes. 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 FactoryTalk Historian ProcessBook software CD and also available through the Rockwell Automation Web site.

Is a Data Set in Use?


Before you modify a data source or data set, it is important to determine whether it is being used in another display or symbol. PI Calculation data sets and ODBC data sets are established for an entire ProcessBook (or an independent display). Custom data sets are installed with the FactoryTalk Historian ProcessBook application and are available to any display that you open.

Normal Print Only Template 1. From the Tools menu, click Data Sets.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 223

Building Displays

2. The Data Sets dialog box is displayed.

3. Under Data Sets, click the data set name, then click the Show Use button. 4. The Data Set Use dialog box is displayed.

In the example above, the data set Lab Data is being used in five separate places on a total of three displays.

Page 224

Data Sets

Data Set Details


Each Data Set is initially determined from a Data Source that must already be configured. If the Data Source you need is not listed, click the Setup button to add it. Once the Data Source is selected, add the query. If the Design button is unavailable you must type in the query. If MS Query is enabled, the Design button will not be unavailable. Click it to design the query. You can check syntax after you add the query. If you wish to use placeholders from PI in your query, establish them by clicking the Placeholder button and completing the process on the Placeholder dialog.

Using Information from Data Sets in Displays


Once you have successfully established a data set, you may add some or all of the data to your ProcessBook displays in bars, values, or trends.

Adding a Data Set to a Trend


Just as you would add tags in defining a trend, you can add columns chosen from a data set. Each column will be plotted as a separate trace. However, the data set columns that appear on your trend do not appear in the Point Properties dialog box. If the query returns a null value, the trace will show the discontinuity. Information from more than one data set may be plotted on the same trend. You can manipulate trends containing data from data sets just as you would other trends, by using functions such as:
Trend Zoom Scrolling Trend Cursor Time Range Revert Time Ranges Autorange Markers

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 225

Building Displays

How to Add a Data Set to a Trend 1. In Build mode, open a display. 2. On the Drawing toolbar, click the Trend button. 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 dialog box is displayed.

5. Click the Tag Search arrow, and then click PI Calculation. 6. The PI Calculation Data dialog box is displayed.
Note: If you want to display the ODBC Data dialog box instead of the PI Calculation Data dialog box, then click the Tag Search arrow, and then click ODBC.

Page 226

Data Sets

7. Under Datasets, click the data set you want to add to the trend. 8. Under 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 will be dimmed.

10. The selected data set/column(s) will now be listed under Tags in Plot in the Define Trend dialog box. Select tags as desired and format the trend. If you wish to see or edit the definitions of placeholders, click the Custom Placeholders button in the Define Trend dialog box. 11. Click OK. You will now see the data displayed on the trend.
Note: If you select the Description check box, on the Display Format tab in the Define Trend dialog box, then the description of the data set will be taken from the PI Calculation Data dialog box and repeated for each column that is plotted. There are no engineering units for a column.

Time Intervals for Plotting Tags and Data Sets


The Start and End plot times on the Define Trend dialog box are used to determine the time range for plotting tags. However, a data set may have different time boundaries than the plot time start and end for the tags. If the time range for the data set starts later than the time range for the tags, the data set traces will begin with X marks.

How a Trend Containing a Data Set Refreshes


In a display containing only data from data sets, the data will be refreshed based on the Data Set Refresh Interval list, which is configured in the data set. The trend will not update again until the Data Set Refresh Interval has expired, at which time it will request another set of values and redraw itself. A PI tag in a display, on the other hand, will be updated whenever it receives exception notifications from the FactoryTalk Historian System. If both PI and data set data are to be plotted on the same trend, then the latest data set value will be continued to the right with changing PI exception data points until the refresh interval expires.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 227

Building Displays

A PI Tag in a display, on the other hand, will be updated whenever it receives exception notifications from the FactoryTalk Historian System. If both PI and data set data are to be plotted on the same trend, then the latest data set value will be continued to the right with PI exceptions until the refresh interval expires.

Adding Data Sets to Bars or Values in a Display


A single value from a data set may be added to a display as either a Value or a Bar. In general, queries can return many rows of results. The Value or Bar uses only the data from the first row of the results for the column you select; the rest of the results are discarded. In many cases, you can use an order by clause to control which rows are returned first. For example, the following query guarantees that most recent sample will be displayed in the ProcessBook Value field: Select lab_val from Lab_Data where last_ID = BW Order by Sample_time desc

Running FactoryTalk Historian ProcessBook When Data Sets Are Included


When you start FactoryTalk Historian ProcessBook, it connects to your FactoryTalk Historian System and remains connected until you close FactoryTalk Historian ProcessBook. If you have configured data sets in a ProcessBook, FactoryTalk Historian ProcessBook connects to a data source as soon as you open a display containing data set results. The first time you use a particular data source, the external database may ask you for login information through a login dialog. After a successful connection, FactoryTalk Historian ProcessBook retains this information for use throughout the session. When you close the session, FactoryTalk Historian ProcessBook does not store your password locally.

Editing a Data Set


You may change the Data Source, the Data Set Refresh Interval, the Description, or the query. However, when you change a data set, you may affect other queries that use the same data set.

Page 228

Data Sets

How to Edit a Data Set 1. From the Tools menu, click Data Sets. 2. The Data Sets dialog box is displayed.

3. Under Data Sets, click the data set you want to edit, and then click the Edit button. 4. Either the PI Calculation Data dialog box or the ODBC Data dialog box will display depending upon the data set you selected. 5. If the PI Calculation Data dialog box displays, then make your changes in the appropriate fields. 6. If the ODBC Data dialog box displays, then do the following:
Note: To determine if Microsoft Query is installed, the application will check your MS-DOS path for the existence of msquery.exe)

If the Design button is enabled, then: 1. Click the Design button an instance of Microsoft Query will be started using the current data source and query. 2. Edit the data set in the MS Query environment.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 229

Building Displays

3. On the File menu, click Return to ProcBook when you are finished.
Note: Microsoft Query cannot edit query statements that contain placeholders.

If the Design button is disabled, then: If Microsoft Query is not installed, the Design button is disabled; however, you can key in the query manually in the query text box. You can also copy and paste a query from another query building tool. 1. Add or edit the appropriate WHERE clause in the query to edit a placeholder data set or existing placeholders. 2. Click the Placeholders button.This will cause the syntax of the query to be checked. 3. If the syntax is valid, then the Placeholders dialog box will display with the current placeholders. If the syntax is invalid, then an invalid query message will be displayed. 4. Click the Check Syntax button, to complete a syntax check of your query. The status of the query will be 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 box will display.

6. If you wish to proceed, click Continue. The Data Sets dialog box is displayed. 7. Select the column(s) to be used and click OK to return to the Define Trend dialog box.

Page 230

Data Sets

Deleting a Data Set


Before you can remove a data set from the FactoryTalk Historian ProcessBook list, you must remove it from any trends, values, or bars.

How to Delete a Data Set If the Data Set is a custom data set, which is a COM object, remove it through Add-in Manager dialog box. Otherwise, use the following steps to delete a data set first from all displays in which it is used and then from the ProcessBook altogether. 1. From the Tools menu, click Data Sets. 2. The Data Sets dialog box is displayed.

3. Under Data Sets, click the data set name, and then click the Show Use button to determine if any display or symbol is using the data set. 4. Close the Data Sets dialog box. 5. Open each display in which a data set is being used and delete the data set from the appropriate dialog box, such as the Define Trend or Define Value dialog.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 231

Building Displays

6. Save each display. 7. Reopen the Data Sets dialog box.

8. Under Data Sets, click the data set you want to delete, and then click the Delete button. 9. The data set will be removed from under Data Sets in the Data Sets dialog box. If the data set is in use, then the Can't Delete Data Set dialog box will display.

Copying a Data Set to Another ProcessBook


While data sources are configured for a computer, data sets are established for only one ProcessBook.

How to Copy a Data Set to Another ProcessBook 1. Open the new or target ProcessBook or independent file. 2. Open the old or source ProcessBook or independent file. 3. From the Tools menu, select Data Sets.

Page 232

Data Sets

The Data Sets dialog box is displayed.

4. Under Data Sets, click the data set you want to copy, and then click the Copy button. The Copy Data Sets dialog box is displayed.

5. From the To Open Workbook drop-down list, select the correct target, and then click OK.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 233

Building Displays

Add-In Manager

Before you can access a custom data set in a display, you must create a data set add-in and install it on your computer. Then you must select it through the FactoryTalk Historian ProcessBook Add-In Manager dialog box. The Add-In Manager dialog box allows you to register an add-in, load or unload it, and set its load behavior.

How to Use the Add-In Manager 1. On the Tools menu, click Add-In Manager. 2. The Add-In Manager dialog box is displayed.

3. In the Available Add-Ins list, click the appropriate add-in. 4. A description of what the add-in does appears in the Description box.

Page 234

ODBC

5. Under Load Behavior, select the following:


If you want to set the following load behavior:

Then select this check box to:

Loaded/Unloaded Load on Startup Command Line

Load or unload the selected add-in. Load selected add-in on startup of development environment. Load the selected add-in when the development environment is started from the command prompt or from a script.

6. Click OK to update the behavior of the selected add-ins. 7. The custom data set is now added to the Data Sets dialog box.

ODBC
ODBC Data Access
FactoryTalk Historian ProcessBook stores relational queries in data sets within ProcessBook files. The data sets are created, stored, and accessed by name. FactoryTalk Historian ProcessBook symbols can then access the data sets. The columns in the data set make up the items that can be assigned to the trend, value, or bar. The SQL needed to retrieve data for FactoryTalk Historian ProcessBook can be configured once and used by many displays and symbols. FactoryTalk Historian 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 Microsoft ODBC Driver Manager and drivers. You must then configure data sources (page 241) for ProcessBook and then define individual queries, called data sets.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 235

Building Displays

ODBC Data Sets


FactoryTalk Historian ProcessBook uses the term ODBC data set for the concept of an ODBC query that retrieves data from a relational database to produce a group of data values organized into rows and columns and used to build a trend or other element in a ProcessBook display. A data set is identified within a ProcessBook by a unique name. The data set name refers to the combination of an SQL query statement and an ODBC Data Source with which to execute the query. The results of the SQL query are organized into rows and columns. You may select any column of the results for a display. For example, in a trend, each column in the data set that you select will appear as a different trace. A SQL query statement may be written so that it will execute based on other data in a display, such as PI tags or current time. This is done using SQL placeholders (parameters); a tag, time, or text string is then substituted for each placeholder at run time.

ODBC Driver Manager FactoryTalk Historian ProcessBook will send queries to a standardized interface from Microsoft called the ODBC Driver Manager. The Driver Manager forwards the queries to appropriate vendor- provided 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 FactoryTalk Historian ProcessBook installation.

ODBC Data Sources An ODBC data source identifies a database a user wants to access and the information needed to connect to that data. Examples of ODBC data sources are:
An SQL Server database, the server on which it resides, and the network protocol used to

access that server.


A directory containing a set of dBASE files you want to access.

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.

Page 236

ODBC

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 237

Building Displays

Preparing to Use ODBC


In order to use ODBC within your ProcessBook, you must install an ODBC driver and configure the corresponding ODBC data source on your computer.

How to Determine Which ODBC Drivers Are Installed 1. On the Windows Start menu, point to Settings, click Control Panel, double-click Administrative Tools, and then double-click Data Sources (ODBC). The Microsoft ODBC Data Source Administrator dialog box is displayed. Skip to Step 5. -orFrom the Tools menu, click Data Sets. The Data Sets dialog box is displayed.

2. Click the New button, and then click ODBC.

Page 238

ODBC

The ODBC Data dialog box is displayed.

3. Click the Data Source drop-down list to see what ODBC data sources you have already configured, if any. 4. Click the Setup button. The Microsoft ODBC Data Source Administrator dialog box is displayed.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 239

Building Displays

5. Click the Drivers tab to view the ODBC drivers that are installed on your system.

6. Click OK.

Page 240

ODBC

Configuring the ODBC Data Source


Once ODBC drivers have been installed, you need to configure the ODBC data sources available to the computer.

How to Configure an ODBC Data Source 1. Open Microsoft ODBC Data Source Administrator program.

2. On the User DSN tab, under User Data Sources, click the name of the ODBC data source you plan to use and then click the Configure button. The "Setup" dialog box for the data source you selected displays.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 241

Building Displays

The following is an example of the ODBC Microsoft Access Setup dialog box.

3. Add the ODBC data source.


Note: Click the Help button, if necessary, and follow Microsoft's instructions for completing the dialog box.

4. When you have completed configuring the data source, click OK to return to the Microsoft ODBC Data Source Administrator dialog box.

Defining an ODBC Data Set


1. From the Tools menu, click Data Sets. The Data Sets dialog box is displayed.

Page 242

ODBC

2. Click the New button and then click ODBC. The ODBC Data dialog box is displayed.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 243

Building Displays

3. In the Name box, type a name for the data set. 4. In the Description box, type a description if you like. This is displayed with the trace. 5. In the Refresh Interval list, click the interval at which you want to automatically update the data set. -orType a number between 0 and 999.
Note: The default for the Refresh Interval list is zero minutes. This means the data set will only refresh when the trace is first drawn or when you click the Revert Time Ranges button on the standard toolbar. If a tag placeholder is used, the Refresh Interval list is grayed out.

6. From the Data Source drop-down list, click the appropriate ODBC data source. 7. Click the Design button. The Microsoft Query application is displayed.

Page 244

ODBC

Note: If Microsoft Query is not installed, then the Design button will be disabled. You can key in the query manually. You can also copy and paste a query from another query building tool.

8. Choose your ODBC data source and design your query.


Note: Click the Help button, if necessary, and follow Microsoft's instructions for completing the query.

9. Click OK to return to the ODBC Data dialog box. 10. To verify if the query can be understood by the ODBC data source, click the Check Syntax button. One of the following messages will display:

Valid Query

Invalid Query

11. Click OK.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 245

Building Displays

12. If you want to use placeholders in the query, enter the appropriate WHERE clause and click the Placeholders button. Placeholders are defined in the order in which they are encountered in the SQL statement. Clicking the Placeholders button will cause the syntax of the query to be checked. If the syntax is not valid, the invalid query message will be displayed. 13. Click OK.

Using MSQuery in Building Data Sets


You can use Microsoft Query (MS Query) for writing queries. It is not distributed with FactoryTalk Historian ProcessBook, but if you click the Design button in the ODBC Data dialog box, then FactoryTalk Historian ProcessBook will search the registry in your computer to locate MSQry32.exe.
Note: The MS Query application wont work with an ODBC query if the query includes placeholders. Consequently, the Design button in the ODBC Data dialog box may be disabled.

Assumptions about Timestamps and Data Sets


When a trend receives data from an ODBC data source, it receives the data as a Time / Value pair. The Value is generated by the query. The Time, however, may be obtained in one of two ways:
If a Tag placeholder is used, then the time will be the time returned by the Tag. This time

will supersede any timestamps returned by the query.


One or more of the columns returned by the query may be a timestamp type. If more than

one timestamp column is returned, the first one as ordered by the SQL query will be used.

Placeholders
A Placeholder in an SQL query identifies a value that is to be provided when the query is run. The query can be validated before the actual values are provided. The standard SQL placeholder character is ?. Placeholders are numbered in order of appearance, left to right. 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.

Page 246

ODBC

Select value, sample_time from Lab_data where sample_ID=? and sample_time>? FactoryTalk Historian ProcessBook allows placeholders in queries. You may provide text, start, or end times, or tag values as substitutes for placeholders.

Processing of Placeholder Queries


Text placeholder values are substituted into a query when it is run. Start and End times are determined when a display is opened and substituted into queries. Processing of Tag Placeholder Queries Tag values can also be used as placeholders. With a Tag placeholder, the attempt is being made to process a join between the ODBC data source and the PI data source. When a display is opened, FactoryTalk Historian ProcessBook obtains tag values between the start and end time and substitutes these values into the SQL query, one at a time. The use of a tag placeholder is shown in the SQL query statement below: Select target from specs where product_code=? In this example, the values of the tag in the FactoryTalk Historian 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.

Adding Placeholders
1. In the ODBC Data dialog box, click the Placeholders button. The Placeholders dialog box is displayed.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 247

Building Displays

2. In the Placeholder Name box, select the parameter to be constrained. The parameters are in the same order as found in the WHERE clause of the data set query. It is also limited to the number of parameters in the query. 3. In the Placeholder Properties box, select the Type for the selected parameter. There are four possible constraining types, Text, PI Tag, Start Time, and End Time. 4. The dialog will then transform into one which will allow you to then enter the selected type of data:
If the query uses: Text input Tag values Start and/or end times: Then type: The replacement text value in the Text field. A node id and tag name or press the Tag Search button to open the Tag Search dialog box. A node id and tag name or press the Tag Search button to open the Tag Search dialog box.

5. Click the Set button. 6. To enter another parameter, select another constraint and repeat the previous steps. Proceed to the next step when you are finished. 7. Click OK.

Page 248

ODBC

Designing Placeholder Queries


Placeholders can be customized for a symbol. You can create an ODBC data set with a set of default placeholders. When that data set is attached to a specific symbol, the querys placeholders can be customized for that symbol without affecting the placeholders defined for any other symbol using that data set.

Stored Procedures in Queries


Stored procedures can be used in a query. They may contain placeholders as long as your database will accept the stored procedures call as a text string. The common syntax for this is: execute procname ('arg', 22, ?) Check the documentation of your database management system for details. Stored procedures generally return results in rows and columns, just as a normal SQL query does. The only way to determine the columns returned by a stored procedure is to perform a test execution. When you are building the data set, because ProcessBook needs to know the columns returned, it will execute the procedure. If the procedure call includes placeholders, the following defaults are used:
Text StartTime EndTime Tag Actual text placeholder string Current time Current time 0

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.

Troubleshooting ODBC Data Sets


Data Sets may be added, deleted, copied, or edited by selecting the New, Delete, Edit, or Copy buttons. Columns are defined by the data sets. Highlight a data set name to see the related columns that will be returned by the query.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 249

Building Displays

The Show Use button will open a dialog that indicates what displays and symbols include data from this data set.

Tracing ODBC Calls


The ODBC Driver Manger provides an option for recording a log of all calls to the Driver Manager from all ODBC clients. The default options for ODBC are set to omit tracing and logging ODBC calls If you choose to trace ODBC calls, you may suffer some degradation in system performance.

Initiating Call Tracing


1. From the Tools menu, select Data Sets. The Data Sets dialog appears. 2. Click New. Click ODBC. The ODBC Data dialog box appears. 3. Click Setup. The ODBC Data Source Administrator dialog box appears. 4. Select the Tracing tab. 5. To change the file where tracing is logged, choose a new file path in the Log File Path text box. Use the Browse button to search for files. 6. To initiate tracing, click the Start Tracing Now button. The label changes from Start Tracing Now to Stop Tracing Now, and the Log File Path text box becomes unavailable. 7. To stop tracing, click the Stop Tracing Now button.

Deleting an ODBC Driver


If you have deleted all data sources using a particular driver, you may unistall it from your system. To do this, you must use the setup program for the ODBC driver.
Note: If you delete the wrong driver you will need to reload it from the vendor's diskettes.

Deleting an ODBC Data Source


You cannot remove data sources until they are no longer in use. Consequently, before you try to remove a data source, remove all data sets in which it is being used.

Page 250

ODBC

How to Remove a Data Source 1. From the Tools menu, click Data Sets. The Data Sets dialog box is displayed.

2. Click the New button and then click ODBC. The ODBC Data dialog box is displayed. 3. Click the Setup button. The Microsoft ODBC Data Source Administrator dialog box is displayed.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 251

Building Displays

4. On the User DSN tab, under User Data Sources, click the name of the ODBC data source you want to delete and then click the Remove button. A confirmation message is displayed. 5. Click the Yes button to delete the data source. 6. Click OK to close the Microsoft ODBC Data Source Administrator dialog box, then close the ODBC Data dialog box. The data source has been removed from under Data Sets in the Data Sets dialog box.

Editing an ODBC Data Source


Occasionally you may want to use a different computer to access an existing ProcessBook display. If the display contains data from a PI Calculation Data Set, the display will work correctly unless the new machine does not point to the same PI Universal Data Server as the previous one. If this display contains data from an ODBC data set, you will need to reconfigure the correct ODBC data source on the new computer. Essentially this means establishing the same ODBC data source name that was used on the original computer. Follow the steps under Installing ODBC Drivers, and Configuring the ODBC Data Source (page 241).

Page 252

Module-relative Displays

If the display contains data from a custom data set, then you must install that FactoryTalk Historian ProcessBook add-in on the new machine.

Module-relative Displays
Module Context Add-in
The Module Context Display FactoryTalk Historian ProcessBook add-in is designed to give users a way to create dynamic symbols in a display for a general structure, and then, at run time, to apply the symbols to different instances of the structure. In simple words, you can use the same dynamic symbol, such as a trend, and can scroll through the Available Modules window to display several instances of that trend, each representing different data points. The add-in gives FactoryTalk Historian ProcessBook access to the PI SDK Module Database, taking advantage of its contents as well as its structure. The Module Context Add-in:
Allows Aliases to be used as a data source for dynamic symbols, so that a tag can be

changed without affecting a symbol which uses it indirectly through its alias.
Allows Properties to be used in dynamic symbols to show user-defined supplementary

information.
Allows the user, at run-time, to switch among different PI SDK Module Database Nodes

reflected by the same display symbols. The PI SDK Module Database organization is similar to a file directory structure. Each node (which is like a directory) is called a Module, and can contain:
Properties, which are variables containing any kind of data (including arrays, and

collections of more properties).


Aliases (like variables for a tag name) Modules (sub-modules, like sub-directories in a file directory) Properties and aliases in the Module Database are time-dependent. See the PI SDK

Online Help for more on the Module Database.

Module Context Add-in Architecture


The Module Context implements a Custom Dataset and a Context Handler.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 253

Building Displays

The Context Handler uses a user-selected Context (for example, "\\philly\mod1\mod2") and the Context Name of a dynamic symbol (for example, "MODULECONTEXT.Property1") to construct a full (absolute) path to a Property or Alias in the Module Database. A Resolved Name, which ProcessBook can interpret, is then given to the symbol. The Context Handler also includes functions for the validation of Context Names and for calling up a Configuration Dialog (similar to the Tag Search dialog) for selecting Aliases and Properties to use with symbols. The Custom Data set is used to retrieve data from properties in the Module Database. It is also used to make the Currently Selected Context of the Context Handler available as a string that can be shown in a dynamic symbol, usually a value symbol. The following figure shows the relationship of FactoryTalk Historian ProcessBook and the Module Database. FactoryTalk Historian ProcessBook has a collection of Custom Data sets and Context Handlers, and the Module Context Add-in supplies an instance of each. Context information specific to a display is persisted along with the display, but is managed by the Module Context Add-in.

Relationship of FactoryTalk Historian ProcessBook and the PI Module Database

Page 254

Module-relative Displays

Module Context Add-in Features


The Module Context Add-in supports the following features:
Use of Module Database Aliases in dynamic symbols. Use of Module Database String and Numeric PI Properties in dynamic symbols. A user option at design time (Select Available Modules dialog box) to choose Contexts

to make available at run time. Contexts are saved with the display or independent display, not with a ProcessBook.
A Configuration Dialog Interface (Select Items dialog box) for assigning these Aliases

and Properties to dynamic symbols in ProcessBook.


Use of Current Context String in dynamic symbols. This provides a mechanism to show

the current context in a display.


A user interface for changing the context at run-time (Available Modules Window). Programmatic access to the Available Context values.

Add-In Manager
The Add-In Manager dialog box, reached from the Tools menu, lists the Add-Ins available in your FactoryTalk Historian ProcessBook installation. Use this dialog to control whether the add-ins are loaded whenever you use FactoryTalk Historian ProcessBook. 1. From the Tools menu in ProcessBook, select the Add-in Manager. 2. Highlight Module Context. 3. There are two checkboxes to define the load behavior. Check the Loaded/Unloaded checkbox to load the Module Context Add-in. Check the Load on Startup checkbox to load the add-in each time you open FactoryTalk Historian ProcessBook. 4. Click OK to complete the action and close the dialog. If the add-in is unloaded and then reloaded, you must click the Revert toolbar button to resynchronize any symbols using the add-in.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 255

Building Displays

Module Context Add-in Startup


When the Module Context Add-in add-in is loaded in ProcessBook, the add-in adds a Module Context menu item to the Tools menu. This menu item provides one submenu option, Add Module. Available modules for the current display are also listed in a docked toolbar at the left of the display.
Note: When you shift focus from a display to a ProcessBook, there will be no available modules listed.

Module Context Selection


Before a Module Context is associated with a symbol, you must choose which Module Database Modules will be available to select as a Context during run time. The chosen modules should have a common structure and common items so that the display can obtain symbol data for any run-time Context the user selects. From the Tools menu, select Module Context > Add Modules to see the Select Available Modules dialog box, which is used to establish the available contexts for the active display. This dialog contains two parts:
The PI Module Database Tree: Use the arrow keys to select nodes to use as contexts.

All known PI 3 Servers are available; modules can be selected from multiple Module databases.
The Selected Modules list, showing all the selected contexts. During run-time the user

may select any of these to use as a context. 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.

Page 256

Module-relative Displays

Selecting Contexts (Properties and Aliases) on the Select Items Dialog


After you have selected the modules to be available to a display you are ready to build a dynamic symbol with specific Module-related properties and aliases. The Select Items dialog has two main parts:
The Items from Current Module tree from which items may be selected. Only aliases

and properties contained in the currently selected Module can be selected to be displayed in the dynamic symbol. You cannot add Modules in this dialog.
A Selected Items list. As in the Tag Search dialog, any number of items may be

selected. A path is shown in this list when a Module has been opened in the Items from Selected Contexts tree and a property or alias from the expanded Module has been selected. The dialog allows you to assign Aliases and numeric and string Properties to the dynamic symbol. (Other properties are either not shown at all, or marked as unsupported types with a different icon.) These Aliases and Properties are attached to the specific Module shown highlighted in the Available Modules Window. 1. To reach the dialog, on the Tag Search dialog, click the down arrow next to Tag Search and select ModuleContext. The Select Items Configuration dialog is displayed. 2. Highlight each desired Alias and Property and click the arrow button or drag the item from the left tree to the right list. Click OK. 3. To display the current display context in the dynamic symbol, check Current Context above the Selected Items list. 4. Click OK. You can repeat the process for other modules if there are different aliases or properties to be included. At runtime, you will receive 'no data' messages if assigned aliases or properties are not present in a particular module. If you need to add a module, click the Add Modules button to reach the Select Available Modules dialog box.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 257

Building Displays

Change the Run-time Module (context)


After you have identified Modules, properties, and aliases for a display, you can switch from one module to another by highlighting its name in the Available Modules dialog. In Run mode, from the Available Modules Window, click a different module to highlight it. The associated symbol in the display will show the data from the Property or Alias based on the newly selected Module.

Page 258

Chapter 9: Embedding and Linking

Overview of FactoryTalk Historian ProcessBook OLE Compound Documents


ActiveX is Microsoft's name for their System Object Technology. "Container" applications are those that can contain ActiveX objects. Compound Documents are documents that contain parts from more than one application. The parts may be spreadsheets, word processing documents, ProcessBook displays, etc. A compound document consists of a container document plus sub-documents that are 'served' by other applications FactoryTalk Historian ProcessBook compound document functionality has two aspects:
ProcessBook displays can be containers for objects from other applications, such as

databases, spreadsheets, or documents.


ProcessBook displays may be used to exhibit dynamic data within other container

applications. In this case, the ProcessBook or display is considered an object.

OLE Automation in FactoryTalk Historian ProcessBook


OLE Automation of FactoryTalk Historian ProcessBook means that an application or program outside FactoryTalk Historian ProcessBook can manipulate FactoryTalk Historian ProcessBook objects such as displays or symbols. Currently, applications with OLE capability include Microsoft Excel, Access, and Visual Basic (VB), among others. A specific set of properties and methods are associated with each object type. Data from FactoryTalk Historian ProcessBook can be retrieved or manipulated according to scripts originating outside FactoryTalk Historian ProcessBook. For example, with the proper scripts in place, you could:

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 259

Embedding and Linking

Obtain a FactoryTalk Historian ProcessBook object, such as a display, from FactoryTalk

Historian ProcessBook and print it in an 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.
Write a Visual Basic program to start FactoryTalk Historian ProcessBook, assess a

particular display, and then alter it in some way.


Click a button in ProcessBook to make an Excel spreadsheet show the average and raw

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. Rockwell Automation is using Visual Basic as the standard testing language for OLE Automation. To write Visual Basic scripts for use with FactoryTalk Historian ProcessBook, refer to the Programmer's Guide to FactoryTalk Historian ProcessBook.

Object Linking and Embedding


An object application may be connected to a container application by either "embedding" or "linking." The distinctions between the two have to do with the ways in which the object is stored and updated.

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 ProcessBook. Using an embedded object will increase the file size of a ProcessBook significantly. Formats previously unsupported by FactoryTalk Historian 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, you double-click it. The source application software will be 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 will update 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.

Page 260

ActiveX Controls

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. Object only on 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 will open, and then you can edit the object. If the source application supports in-place activation, you can edit within the container window; otherwise a source application window will open. If you rename a ProcessBook or move it to another directory, drive, or PC, any links from displays to source files may be broken and need to be re-established.

ActiveX Controls
You can insert ActiveX controls that are installed on your PC into FactoryTalk Historian 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 will require additional VBA code before they will function correctly.

How to Add a Control


1. In Build mode, open a display. 2. On the Drawing toolbar, click the Control button. -orOn the Draw menu, click Control.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 261

Embedding and Linking

The mouse pointer changes to a control pointer. 3. Click in the display where you want to add the control and drag the pointer to form a rectangle into which the control will be placed.

Page 262

ActiveX Controls

When you release the mouse button, the Insert Control dialog box is displayed.

4. Under Controls, click the appropriate control, and then click OK. For example, if you add a calendar control to a display, it might look like this:

In Run mode, a user could change the month and date. A programmer could incorporate the calendar into scripts associated with the display.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 263

Embedding and Linking

Example of Embedded and Linked Objects in a ProcessBook Display


In the example below, a ProcessBook display includes a process schematic, an embedded list of equipment parts, and a link to lab results.

The equipment parts list is stored with the ProcessBook display. If your PC contained a copy of MSWord, you could peruse or modify the list at any time simply by double-clicking on it. The lab results are stored by the source application, not in the ProcessBook display. The display could be set to update lab data dynamically whenever the results in the source application changed, or it could be set to update lab data when you click an Update Now button on the Edit Links dialog.

Icons vs. Graphics


You may choose to have embedded or linked objects displayed either as graphic representations or as icons. An icon will use the minimum area of your display and would be appropriate for reference material, such as definitions.

Page 264

Should You Link or Embed?

The icon for the source application will appear unless you select another one. Choosing an icon to represent a linked file will result in a slightly smaller ProcessBook file size. Choosing icons for embedded objects does not reduce ProcessBook file size.

Should You Link or Embed?


Embed Link If you want to update the object data within the target document or if you want to store all the source data within the container application. If you want the data to update dynamically or when you need to minimize file size. The source application must continue to be available.

Note: When you link to a ProcessBook container, there is a risk of changing the source file.

Embedding in ProcessBook
Objects may be created within a FactoryTalk Historian 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. You may edit objects in either Build or Run mode.

How to Embed
How to Embed an Existing File in a ProcessBook Display
1. Open the display. 2. In Build mode, on the Insert menu, click Object. The Insert Object dialog box is displayed.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 265

Embedding and Linking

3. Select Create from File. 4. Click the Browse button. The Browse dialog box is displayed. 5. Browse and locate the file you want to embed and then click the Open button. The file name is displayed in the File box. -orIn the File box, type the path where the file is located. 6. If you want to display an icon rather than a graphic, click the Display as Icon check box. 7. Click OK. The object will appear on your display.

How to Embed a New File in a ProcessBook Display


1. Open the display. 2. In Build mode, on the Insert menu, click Object. The Insert Object dialog box is displayed.

Page 266

Windows Drag and Drop

3. Leave Create New selected (the default position). 4. Under Object Type, click the type of object you want to embed.
Note: If you want to display an icon rather than a graphic, select the Display as Icon check box.

5. Click OK. The object will appear on your display. 6. Adjust the size and positioning of the object. 7. Commands for the source application are available on the menus. Create the contents of the new object and click elsewhere on the display to return to ProcessBook. 8. Save the display.

Windows Drag and Drop


You can use the Windows drag and drop feature to move or copy an object from another OLE application or display into a ProcessBook display or vice versa. To move an object, simply drag it. To copy an object, press CTRL and drag it.
Note: if you open a display and drag an object elsewhere, the display is permanently changed, regardless of whether you save it or simply close it.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 267

Embedding and Linking

Linking to ProcessBook
You can create a link from a ProcessBook display to an existing file. The linked object will appear in a rectangle within your display. It will be updated whenever the source file changes, unless you change the link from Automatic to Manual. You must be in Build mode in order to insert a linked object. You may move or resize linked objects in either Build or Run mode. You may also edit the contents of a linked object, but you are actually editing the original source file, not simply the image in the ProcessBook display.

How to Link a File into a ProcessBook Display


1. Open the display. 2. In Build mode, on the Insert menu, click Object. The Insert Object dialog box is displayed.

3. Select Create from File. 4. Click the Browse button. The Browse dialog box is displayed.

Page 268

Dynamic and Manual Updates of a Linked Object

5. Browse and locate the file you want to embed and then click the Open button. The file name is displayed in the File box. -orIn the File box, type the path where the file is located.
Note: If you want to display an icon rather than a graphic, select the Display as Icon check box.

6. Select the Link check box. 7. Click OK. The object will appear on your display. 8. Adjust the size and positioning of the object.

Dynamic and Manual Updates of a Linked Object


The default setting for a link is automatic updates, meaning that whenever the source data are changed, the data in your display will change. You can change this updating frequency to manual through the Links dialog box. Manual updates are also initiated through this dialog. Whenever you open a ProcessBook display containing an OLE link, even if you have set all links to manual updating, the following dialog box will briefly display:

How to Edit, Update, or Break Links


If you have created an automatic link to another object, it will update whenever you open the entry. If you have created a manually updated link, use the Update Now button on the Links dialog to update your linked object.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 269

Embedding and Linking

Use the Links dialog to change from Manual to Automatic Updating and vice versa. When you move a display, you may need to change the sources for linked objects by breaking the links and re- establishing them. 1. Open the display. 2. In Build mode, on the Edit menu, click Links. 3. The Links dialog box is displayed. 4. Click the link you want to change.
Note: You can select several links at once by pressing the CTRL key and clicking each link.

5. Choose one of the following options:


To Update the linked data manually Update the linked data immediately Edit the linked data Break the link Do this Select Manual. Click the Update Now button. Click the Open Source button. Click the Break Link button. Note: Breaking a link is a permanent change. The object is converted to a Picture (Metafile).

6. Click OK.

How Links Are Stored


When you establish a link between a ProcessBook display and a source file, the link is stored in two ways, the relative path for the link, and the absolute path for the link. The relative path is the relationship between the location of the source file and the location of the target file in the directory tree. The absolute path includes the drive, directory, and file name of the source file.

Re-establishing Links
When you move a ProcessBook or display that contains links to source files, if both the absolute and the relative paths change, then you will need to reestablish the links. To reestablish these links, follow the procedure below.

Page 270

Editing the Appearance of an OLE Object

How to Select a New Source Link 1. Open the display. 2. In Build mode, on the Edit menu, click Links. The Links dialog box is displayed. 3. Click the Change Source button. The Change Source dialog box is displayed.

Editing the Appearance of an OLE Object


Once an OLE object appears in a display, you can resize it, move it around on the display, or copy it. There are, however, a few differences in how OLE objects respond to ProcessBook commands, compared to objects such as symbols that you have drawn. Although you must be in Build mode to insert an OLE object or edit links, you can edit OLE objects from either Run mode or Build mode. When you select an OLE object, switching modes will not cancel the selection.

Commands That Ignore OLE objects


Command Select All Zoom/Fit All Symbols Align Forward Backward Group Rotate Flip Location Edit menu View menu Arrange menu Arrange menu Arrange menu Arrange menu Arrange menu Arrange menu Action Does not include OLE objects. Ignores OLE objects. Does not work because you cannot select more than one OLE object at a time. Does not work because you cannot select more than one OLE object at a time. Does not work because you cannot select more than one OLE object at a time. Does not work because you cannot select more than one OLE object at a time. Does not work with OLE objects. Does not work with OLE objects.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 271

Embedding and Linking

Placement of OLE objects


OLE objects will appear to be beneath of other elements of the display, such as text or symbols, even if the OLE objects were created first. The most recently created OLE object will appear on top of older OLE objects.

OLE Object Colors


You may wish to use a background within an OLE object in a contrasting color to the display. To change the colors used in an OLE object, go to the source application. ProcessBook Color Preferences do not apply to OLE objects.

Editing the Contents of OLE objects


Some source applications permit in-place activation, which means that if you double-click the OLE object, the source application will open, display its menus and commands through the ProcessBook menu bar, and permit you to edit in place. Other source applications will open a new window for editing when you double-click the OLE object. OLE object contents may be edited from either Run or Build mode.

Editing the Contents of an Embedded Object


You cannot edit an embedded object by opening the source application first because the embedded object is not a separate file. Instead, the procedure is to open the source application from within the embedded object in the ProcessBook display.

Editing the Contents of a Linked Object


To edit the contents of a linked object, either double-click the object or open the source application and make changes. These will be reflected immediately in the ProcessBook display if it is open; otherwise the changes will appear the next time you open the ProcessBook display.
Note: When editing a linked object file, remember that the file may also be an object in other applications besides FactoryTalk Historian ProcessBook.

Page 272

How to Delete an OLE Object from a Display

In addition, you can reach the source application through the Links dialog box. 1. On the Edit menu, click Links. 2. The Links dialog box is displayed. 3. Click the appropriate link. 4. Click the Open Source button to open the source file.

How to Edit Contents of OLE objects


1. Open the display. 2. In Build mode, double-click the OLE object you want to edit. 3. Refer to the following table:
If The source application permits in-place activation, menus and commands for the source application will appear on your screen, temporarily replacing ProcessBook menus. The source application does not permit in-place activation, a new window containing the source application will appear. Then Edit the object. Save it if it is a linked file. Click elsewhere on the display to return to ProcessBook or press the ESC key. Edit the object. Save it if it is a linked file. Close the window and return to ProcessBook.

How to Delete an OLE Object from a Display


1. In Build mode, click the OLE object you want to delete. 2. On the Edit menu, click Clear.

Displaying an OLE Object with an Icon


To save space on a ProcessBook display or for a linked object, to save space in the ProcessBook file, use an icon, rather than a graphic representation of the data.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 273

Embedding and Linking

You may select an icon when you are creating the object by selecting the Display as Icon check box in the Insert Object dialog box. Later, you can switch between an icon and a graphic representation of the object, as described in the procedure below. If you have made the graphic representation other than a square shape, the icon may be distorted.

How to Switch Between an Icon and a Graphic


1. Open the display. 2. In Build mode, click the object you want to change. 3. On the Edit menu, point to the name of the object (at the bottom of the menu), and then click Convert. The Convert dialog box is displayed.

4. Select the Display As Icon check box 5. Click OK. The object will switch from an icon to a graphic.
Note: To switch from a graphic to an icon, clear the Display as Icon check box.

Page 274

How to Change the Icon for an Object

How to Change the Icon for an Object


If you are using icons in ProcessBook displays, either embedded or linked, the default icons that display will reflect the application source. You may wish to assign a different icon. 1. Open the display. 2. In Build mode, click the object you want to change. 3. On the Edit menu, point to the name of the object (at the bottom of the menu), and then click Convert. The Convert dialog box is displayed.

4. Click the Change Icon button.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 275

Embedding and Linking

The Change Icon dialog box is displayed.

5. If you want to return to the default icon, then select Default. 6. If you want to select a new icon from the available group, select From File and choose a new icon. 7. If you want to select a new file to provide the icon, click the Browse button. 8. If you want to change the name of the label that displays beneath the icon, then type the new name in the Label box. 9. Click OK to return to the Convert dialog box. 10. In the Convert dialog box, click OK.

Sharing ProcessBook Displays with Other Applications


You can embed a ProcessBook display within another OLE application, or you can link an entire ProcessBook. In embedding, the display is called a PI Display Document. Although applications with OLE functionality use similar commands, they are not exactly alike. The following general procedure uses examples from an Excel spreadsheet. The procedures for linking are similar to those for linking objects to ProcessBook displays.
Note: When a trend is used in a display embedded in Word 97, the trend stops updating after approximately one minute.

Page 276

How to Embed a New ProcessBook Display in Another OLE Application

How to Embed a New ProcessBook Display in Another OLE Application


1. Open the container application. For example, open a spreadsheet and select a cell in which you want to place a display. 2. On the Insert menu, click Object. 3. The Object dialog box is displayed.

4. 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.

5. Click OK. 6. The display is embedded in the container application. 7. Design the display.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 277

Embedding and Linking

How to Embed an Existing ProcessBook Display in Another OLE Application


1. Open the display you want to embed. 2. Open the container application. For example, open a spreadsheet and select a cell in which you want to place a ProcessBook display. 3. In Build mode, on the Edit menu, click Select All, and drag the objects in the display into the other application. 4. Save the file.

How to Link a ProcessBook to Another Application


1. Open the container application. For example, open a spreadsheet and select a cell in which you want to place a display. 2. On the Insert menu, click Object. The Object dialog box is displayed.

3. Click the Create from File tab.

Page 278

OLE Container/Server

4. In the File name box, type the path. -orClick the Browse button and locate the ProcessBook file (.piw) that you want to link to. 5. Select the Link to File check box. 6. Click OK. The ProcessBook icon will be displayed in your application.
Note: If you select the Display as Icon check box, then the Object Packager icon will be used, rather than the ProcessBook icon.

OLE Container/Server
A ProcessBook display may be shown in another application. For example, you could include a 'living' 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 FactoryTalk Historian ProcessBook. To do this, use the Insert Object command in the second application and insert an object of type "PI Display Document."

Updating and Editing Processbook Linked and Embedded Displays


1. Double-click the ProcessBook object to start FactoryTalk Historian ProcessBook. Your display or ProcessBook will receive updates from the FactoryTalk Historian System. 2. Edit the book or its displays. 3. When you are finished, close FactoryTalk Historian ProcessBook to return to the container application.
Note: ProcessBook objects cannot be dragged and dropped into other applications.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 279

Chapter 10: Using Visual Basic for Applications in FactoryTalk Historian ProcessBook
OSIsoft has licensed Visual Basic for Applications (VBA) from Microsoft in order to provide an integrated development environment. This is the same VBA that is used in Microsoft Office, Visio, AutoCAD, Great Plains Dynamics, and many other applications. In FactoryTalk Historian ProcessBook, each display has a VBA project associated with it. Users can write scripts that execute in response to events in FactoryTalk Historian ProcessBook, either from user actions or data updates. VBA can be used to automate routine tasks or to cause changes in a display when data changes. In addition, you can insert other ActiveX controls, which you have obtained through Microsoft Office software or from outside sources.

VBA Toolbar
VBA is accessed through the VBA toolbar, shown at right. The three buttons are:
Visual Basic Editor Switches to VBA Editor window.

Run Macros

Brings up Macros dialog box.

Design Mode

Stops any scripts that may be running or may start running. Useful for debugging.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 281

Using Visual Basic for Applications in FactoryTalk Historian ProcessBook

The Macros Dialog


The Macros Dialog provides a way to select, debug, and run VBA scripts. This command is available from the main menu or VBA toolbar, or by pressing ALT+F8.

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.

What You Can Do with ActiveX Automation in FactoryTalk Historian ProcessBook


Data from FactoryTalk Historian ProcessBook can be retrieved or manipulated according to scripts originating either within or outside FactoryTalk Historian ProcessBook. For example, with the proper scripts in place, you could:
Obtain a FactoryTalk Historian ProcessBook object, such as a display, from FactoryTalk

Historian ProcessBook and print it in an 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.
Write a VB program to start FactoryTalk Historian ProcessBook, assess 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 could 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 FactoryTalk Historian ProcessBook display to initiate updates

or adjustments in the display.


Update a FactoryTalk Historian ProcessBook display by typing new tagnames 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.

Page 282

Automation Vocabulary

Automation Vocabulary
Understanding OLE automation requires some new vocabulary. Terms used in the Programmers Guide are defined below.
Automation ActiveX Automation Server ActiveX Automation Container Object Property Method Event Accessing an object in an application and changing it or using it in some way. The application that provides data. FactoryTalk Historian ProcessBook is an OLE Automation Server. It provides access to its internal objects from other applications. The application that initiates changes through scripts. FactoryTalk Historian ProcessBook is an Automation container, as are Microsoft Excel, Microsoft Access, and a few other commercial products. A specific item that may be manipulated by a script. For example, a ProcessBook, a display, or a symbol may be the object of a VB or VBA script. An attribute of an object. An object with read-write properties can have variable information assigned to it by the script. A read-only property cannot be changed. Performs an action on an object and may or may not return a value. Sometimes called a function. A procedure that executes whenever a particular action occurs, such as a mouse click.

Documentation for Script Writers


To write VBA scripts for use with FactoryTalk Historian ProcessBook, refer to the online help for FactoryTalk Historian ProcessBook.

Macro Protection Feature


FactoryTalk Historian ProcessBook has a macro protection feature that may be enabled by your System Administrator in one of several ways. If you see the dialog below when you open a display, the system administrator has permitted you to choose whether to disable macros for that display.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 283

Using Visual Basic for Applications in FactoryTalk Historian ProcessBook

If you choose to enable macros when prompted by the above dialog, the underlying VBA macros will run as designed. If you choose to disable macros, VBA code will not run. In order to enable macros, either you will need to switch from Run mode to Build mode and back again or, if that fails, you will need to close and reopen the display. The system administrator may also set all macros enabled or set all macros disabled, or set displays with macros to open in VBA design mode.

Page 284

Chapter 11: Troubleshooting Tips

Display Can't Find Data


When a display does not receive data, the problem may be one of the following:
Network is down. A display has been moved from one PC to another and Node Identifiers to the Server(s)

need to be re-established through the Connections dialog.


An ODBC Data Source may have been altered, causing the dataset to fail to return data. An ODBC database might have been restructured, invalidating your dataset.

Trend Cursor Doesn't Appear


If the trend is part of a display, select it. If that doesn't enable the Trend Cursor, the trend is probably too small. Double-click to make the trend larger.

Trend Legend Doesn't Appear


Make the trend larger. If that doesn't help, check the default Trend Format settings.

Cant Change or Save a Display


If your FactoryTalk Historian ProcessBook is part of a View-only installation, you will be unable to save any ad hoc trends or alter displays or ProcessBooks. If you cant alter a display or ProcessBook, you may be in either View mode or Run mode. If you are in View mode, you will have only one toolbar. If you are in Run mode, the Run

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 285

Troubleshooting Tips

mode arrow button on the Drawing toolbar will be depressed. Press the Hammer button to switch to Build mode.

Is an XYPlot Updating?
An XYPlot is updating if the following condition exists: The end time for the X tag is indicated as the current time (by using *) or is in the future and at least one of the Y tag end times is indicated as the current time (by using *) or is in the future. 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.

Is an OLE Object in a Display Linked or Embedded?


To determine if an object is linked or embedded, look at the border around it. Linked objects are surrounded with dashed lines; embedded objects are surrounded with solid lines. Depending on colors used, sometimes the border of an object is difficult to see. If so, select the object and click on the Edit menu. The last entry in the menu will appear as: xx object for embedded objects or Linked xx object for linked objects where xx is the object type, such as document, spreadsheet, etc.

Linked Object Data Isn't Updating


If your linked data doesn't update when you open a display, click Edit > Links.
If the Edit > Links choice is unavailable, the link is permanently broken and your object

has become a picture. It can't update from the source. Re-create the object.

Page 286

ODBC Problems

On the Links dialog box, if the file is set to Manual Update, click Update Now, and the

file should update.


On the Links dialog box, 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 re-establish a path for the link.

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 will indicate "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 will have insufficient information and will not be drawn.

Missing ODBC Data Sources


Occasionally, an ODBC data source cannot be found. This can occur because the data source was deleted or because the ProcessBook .piw file has been moved to a machine that does not have the same data source defined. To resolve the problem, re-define the data source. The following figure shows what will happen when a Trend attempts to display a trace for which the data source no longer exists.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 287

Troubleshooting Tips

Trend Display after a Data Set failure

Page 288

Chapter 12: System Administrator Notes

FactoryTalk Historian ProcessBook Connection to Windows NT or UNIX Servers


Each FactoryTalk Historian ProcessBook user creates a new connection to a single PINETMGR process on the PI node. See PI Server documentation for information on security and troubleshooting.

FactoryTalk Historian ProcessBook Connection to OpenVMS Servers


For OpenVMS, each FactoryTalk Historian ProcessBook user creates a PI Server process on the PI Server PI node. You can see all these connection processes on the PI Server with the VMS "Show System/Network" command. The process name of each PI Server process is:
NNNNNN:SSSSIIII

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 FactoryTalk Historian ProcessBook login dialog box or "Book" if you leave the user name field blank. IIII is the process ID of the FactoryTalk Historian ProcessBook process, which is always E. There is also a log file in the PISysExe: directory for each FactoryTalk Historian 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.

Error! Style not defined.

Page 289

System Administrator Notes

Read/Write Access for Users


Although the only feature FactoryTalk Historian ProcessBook currently supports is a read-only access, the FactoryTalk Historian System Administrator can configure a user's setup for read-only, read/write, or no access. For more information, refer to PIBuild:PIServer.txt on your PI Server node.

Page 290

Read/Write Access for Users

If you want to restrict read and/or write access to PI data, make changes in the CLIENTACCESS section of the file pisysdat:piserver.dat. For example: [USERDATABASE] 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 FactoryTalk Historian 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.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 291

System Administrator Notes

Machine Address
Because FactoryTalk Historian ProcessBook is a client/server application, the communication setup is essential. The machine address, which allows the FactoryTalk Historian 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.

SETUP.INI
The SETUP.INI file in the ini folder contains two entries:
TBFilePath: Location and filename that the user's toolbar configuration data will be

persisted (this file must have both read and write access). This will also be the first location looked for when loading the toolbar configuration.
PromptForConversion: 1=prompt user when opening pre-2.2 files, asking whether

or not to convert to new format, 0=do not prompt (default).

PROCBOOK.INI
The PROCBOOK.INI file contains configuration and preference settings for FactoryTalk Historian ProcessBook. This file generally resides in two places, the users default location, C:\Documents and Settings\<user name>\Application Data\PISystem\PI-ProcessBook, and the PIPC\DAT directory (either on the users local drive or on a network). When FactoryTalk Historian ProcessBook is installed on an individual PC using SETUP.EXE, the procbook.ini file in PIPC\DAT is created. The file in C:\Documents and Settings\<user name>\Application Data\PISystem\PI-ProcessBook is created once FactoryTalk Historian ProcessBook is run for the first time. For most entries the values in C:\Documents and Settings\<user name>\Application Data\PISystem\PI-ProcessBook override the values in PIPC\DAT. When running from a network, the C:\Documents and Settings\<user name>\Application Data\PISystem\PI-ProcessBook PROCBOOK.INI on the PC is created the first time the program is executed. The file is modified as the individual user sets preferences and configurations. Thus, the Systems Administrator can set enterprise-wide default standards in the network PIPC\DAT\PROCBOOK.INI file, and yet allow users to set their own local preferences in

Page 292

PROCBOOK.INI

the C:\Documents and Settings\<user name>\Application Data\PISystem\PI-ProcessBook PROCBOOK.INI file. The following is a list and brief explanation of the most significant sections and keywords in the PROCBOOK.INI file. The settings used are examples and not necessarily the default values.

PI Section
The PI section of the .INI file in the DAT directory should resemble this example: [PI] DLL = PIAPI32.DLL

Conversion Section
The Conversion section of the .INI file should resemble 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. 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.

Data Manager Section


The Data Manager section of the .INI file should be added by the System Manager and should resemble this example.
[Data Manager] TIMER = 5000

TIMER sets the poll timer, in milliseconds, for checking whether FactoryTalk Historian ProcessBook should perform any time-related task. Time-related tasks include retrieving

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 293

System Administrator Notes

exception reports from PI and re-querying sources. (60,000 is the maximum setting; the default is 5000.)

Startup Section
The Startup section of the .INI file should be modified through the Tools menu/Preferences dialog and should resemble this example:
[Startup] Startup ProcessBook=PBDEMO.PIW Retain Aspect Ratio=0 ModeBias=R

Startup ProcessBook line sets the default ProcessBook loaded at startup. Retain Aspect Ratio controls the preservation of the aspect ratio of a screen when the screen is expanded or reduced. When 0 is set, the objects remain the same size regardless of the increase/decrease of the window size. With a setting of 1 the size of the symbols in relation to the window size remains the same (0= default/ignored, 1= preserved). Mode Bias establishes the default working mode for the cursor (R = Run Mode, B = Build Mode). PromptForConversion controls what happens when you open a file created with an earlier version of FactoryTalk Historian ProcessBook. If this setting is missing, then FactoryTalk Historian ProcessBook will open all files created in previous versions as read-only. If PromptForConversion = 0, files are opened in read-only mode, without any prompting. This is the default setting. If PromptForConversion = 1, then FactoryTalk Historian ProcessBook will prompt you to convert the file as soon as it is opened. If you choose to convert the file, FactoryTalk Historian ProcessBook will make a backup copy of the original file and name it the same as the original file, except with a .BAK extension. If you choose not to convert, it is opened in read-only mode. ComTimeOut entry determines the amount of time in seconds to wait for a response from an external COM object before presenting a message box stating that FactoryTalk Historian ProcessBook is waiting for response from a COM object. This setting is 30 seconds by default. DefaultFileLocation entry determines the default location from which files will be saved and loaded. This default location is the My Documents directory.

Page 294

PROCBOOK.INI

ProcessBook View Section


The ProcessBook View section of the .INI file should be modified through the Tools menu/Preferences dialog and should resemble this example:
[ProcessBook View] BookView = 1

BookView controls the view in which a ProcessBook is displayed when opened (0 = Outline, 1 = Book). To change the font for the tabs in book view, add a section similar to this example:
[BookTab_Font] Height=-13 Weight=0 Italic=0 Underline=0 PitchAndFamily=0 FaceName=Arial

The FaceName should be a True-Type font so that it can be rotated.

Trend Definition Section


This section contains the settings from the Trend Preference dialog, which are used to determine the formatting of a trend. Only two items might need modification by the System Administrator. 1. FactoryTalk Historian ProcessBook includes a warning dialog whenever a trend has found too many marker values. The warning occurs when the number of markers exceeds several hundred. This can be turned on or off by changing a ProcBook.ini setting as follows: MarkerWarning=1 is on; MarkerWarning=0 is off. 2. Time Range sets the maximum limit for a trend to update with current values from the PI Archive. To reconfigure the maximum time period for an updating trend, revise the following section. The default is 24 hours. UpdateTimeRange=<sec> If the time range of a trend is greater than this value, it will not refresh automatically even when the end time is *. Note that the maximum time range is different from the update rate, which is the frequency with which the PC asks for new data from the server, typically every 5 seconds.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 295

System Administrator Notes

XYPlot Definition Section


Several of the defaults in this section can be configured to determine the formatting of an XYPlot.
Autoscale 1=yes, 0=no Value/Description/Plot Title/Grids/Scale Inside Axis/Tag Name/Eng

Units/Correlation Coefficient/Linear Correlation/Connecting Lines 1=enable feature, 0=disable feature


Background Null

1=sets XYPlots to have no background color, 0=XYPlots have background color specified under Elements

Start Time/End Time - Default start and end time range for the XYTag (must be a valid

PI string)
UpdateTimeRange

Maximum time period, in seconds, to update on an XYTag. The default is 86,400 seconds, equal to 24 hours. If the time range of an XYTag is greater than this value, it will not refresh automatically even when the end time is '*'. The maximum update range is different from the update rate, which is the frequency with which the PC asks for new data from the server, typically every 5 seconds. XYPlot elements, you can change the color and shape properties. This is the entry format:

Element - These 17 entries are the main drawn properties of XYPlots. For each of 17

ElementX = Name, Color, LineStyle, MarkerStyle

Color - Decimal conversion of the color to draw the element. LineStyle - Line style of the element. Key is as follows: -1=no line, 0=solid, 1=dashed, 2=dotted, 3=dash-dot, 4=dash-dot-dot MarkerStyle - Marker style of each XYTag. Key is as follows: -1=no marker, 0=closed circle, 1=open circle, 2=closed diamond, 3=open diamond, 4=closed square, 5=open square, 6=closed triangle, 7=open triangle, 8=cross

Macro Protection
The macro protection feature prevents misbehaved VBA event code from being executed. Whenever a ProcessBook display (either standalone .pdi file or table of contents entry) is opened, ProcessBook will determine 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:

Page 296

IMPPIGP.INI

Value 0 1 2 5 6

Description Display is opened with macros enabled. User will be prompted when display is opened; project will be set to design mode if user selects <Disable Macros>. User will be prompted when display is opened; project will be opened with macros disabled if user selects <Disable Macros>. User will not be prompted when display is opened; project will always be set to design mode when opened. User will not be prompted when display is opened; project will always be opened with macros disabled.

The default value for this setting will be 0, so that if it is not present at all in the .ini file, then FactoryTalk Historian ProcessBook will always execute macros.

View Only Mode


Installations of FactoryTalk Historian ProcessBook can be configured so that users on a network may only view ProcessBooks and not change them. The user has access to the Standard toolbar, including the Trend Display feature, but cannot save an ad hoc display. To put FactoryTalk Historian ProcessBook into view-only mode, add the line
ProcessBook=Primary

to the Startup section of your ProcBook.ini file. Alternatively, if you use NT Network security, you could set the file permissions to read-only for those users who should not modify ProcessBooks. Such users could, of course, make a copy of the file locally and modify it.

IMPPIGP.INI
The IMPPIGP.INI file contains configuration settings used by the Import utility in FactoryTalk Historian 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 FactoryTalk Historian ProcessBook to its original settings.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 297

System Administrator Notes

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 FactoryTalk Historian ProcessBook:

Page 298

IMPPIGP.INI

The Color section of the .INI file maps VAX colors to FactoryTalk Historian ProcessBook colors:
[Color] Clear=0,0,0 Black=0,0,0 White=255,255,255 Red=255,0,0 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 FactoryTalk Historian ProcessBook line format:
[Line Style] Supress=5 Solid=0 XShortDash=2 DotShortDash=3 LongDash=1 XLongDash=1 TwoDotDash=4 LongDotDash=3 ShortDash=1

The FactoryTalk Historian ProcessBook values to the right of the equal sign represent:
0 1 2 3 4 5 = = = = = = solid dash dot dash dot dash dot dot suppress

The Font section maps the VAX supported fonts to FactoryTalk Historian 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

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 299

System Administrator Notes

Note: These default values are based on resolutions for VT340 terminals. If you are using a terminal other than these, appearances may be different.

Page 300

IMPPIGP.INI

The values to the right of the equal sign represent these font characteristics.
Position 1 Font Characteristic Height Definition 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. Specifies the weight of the font (for example, light, medium, bold). Values can be from 0 to 900 in increments of 100. 100 equals the lightest; 900 the darkest. Specifies an italic font if the value is not zero (for example, 0 = non-italic; 1 = italic). Specifies an underlined font if the value is not zero (for example, 0 = non-underlined; 1 = underlined). 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. Specifies the typeface name of the font.

Weight

3 4 5

Italic Underline Pitch and Family

Face Name

The Marker section of the .INI file maps the VAX trend markers to the markers provided in FactoryTalk Historian 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 FactoryTalk Historian 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

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 301

System Administrator Notes

The Display section in the .INI file specifies the supported terminals in FactoryTalk Historian 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

where X equals the horizontal dimension and Y equals the vertical dimension.

Running VAX Programs through DECNet - Pathworks


VAX programs can be run from a PC using DECNet remote file access. The Pathworks program NFT.EXE can be used to copy or submit VAX files. The Pathworks installation procedure puts this program in either a local \DECNET directory or a server \DECNET directory. The following steps create a ProcessBook entry that runs a PI report and lists the output a screen at a time. 1. Create a command file on the VAX that runs the report. This command file should not require any arguments. The command file should be in the login directory of the account that will run the command. Make sure the account has Execute access to that file. Here is an example: $! PISysExe:MyReport.com $! $! This command file runs a report. It is called $! by MyReport.bat on a PC. $! $ RWCollect := $PISysExe:RWCollect $ RWPrint := $PISysExe:RWPrint $ RWCollect PISysDat:AReport /start=-1d /end=* $ RWPrint PISysDat:AReport 2. Create a DOS batch file that looks like: \DECNET\NFT Submit Casaba"UsernamePassword"::PISysExe:MyReport.com \DECNET\NFT Copy Casaba"Username Password"::PISysDat:AReport.txt \ Type c:\AReport.txt | More

Page 302

TCP/IP

3. Create a ProcessBook entry that is an operating system command. The command string is the batch file name from step 2.

Notes on Running VAX Programs


The command file can do any VAX commands. A PI report is just an example of a program that you may want to run on a VAX. In step 2, the SUBMIT command submits the command file to the default batch queue on the VAX. The COPY command is not necessary if the command file puts the report in a directory that is a Pathworks file service. There are no commands to synchronize the end of the batch job and copying the resulting file to the PC. If the file is in a Pathworks file service (that is, you can see the file from your PC), you could use MS-DOS batch commands to check for the file before typing. It is possible to have the VAX copy the resulting report to the PC by setting up a file listener (FAL object) on your PC. You can use DECNet proxies to avoid putting the user ID and password in the DOS batch file. You can also use the PIServer account and put the command file in the PIServer directory. In this case, you have to add Batch access to the PIServer account using Authorize.

TCP/IP
TCP/IP can be used to execute commands remotely using the rsh, rexec, or rlogin protocols. The details are different depending on the vendors of the TCP/IP software for the VAX and the PC.

WRQ's TCP Connection


There is no program provided with Walker Richer and Quinn's TCP Connection that can run programs on the VAX. There is an FTP program that can be used to transfer files.

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 303

System Administrator Notes

FTP
FTP's PC TCP software provides an rsh program for executing remote commands. This can be used to run command files on the VAX. Steps 1 and 3 above are the same. The DOS batch file uses the RSH program instead of NFT.EXE.

Pathworks
DEC's TCP/IP version of Pathworks supports an RSH program for executing remote commands. This can be used to run command files on the VAX.

SETUPProcessBook.LOG
This log tracks the setup of FactoryTalk Historian 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.

Page 304

Index
Annotated Data Flag 81 Application 1 Workspace 19 Arc command 180 Architecture 253 Archive 12, 83 Arrange Icons 21 Aspect Ratio 49 Preserve 49 Assign Layers 214 Assign Layers dialog 214 Attributes Font 185 How to Change Lines 187 Line 187 Author 15 Automation 261 Autorange 61 Available Context Setup 256 Available Modules 256, 258 Enable Scripting 11 Menu 11 Mouse Menu 11 Pane 11, 258 Properties 11 Right Mouse Menu 11

.
.pdi 49, 53 .piw 17 .Standalone displays 53 .svg 52

A
Absolute Paths 121, 270 Absolute Time 98 Active Layer 211 Active Layers 211 ActiveX Control 259, 261 Actual Data Markers 64 ad hoc trends 54 Add 60, 109, 112, 114, 225, 255 Button 168 Data Set to a Trend 225 Graphic 177 Linked Display Entry 112 Linked ProcessBook entry 114 Operating System Command entry 114 ProcessBook Entries 109 Symbol from a Symbol Library 172 Text Labels 178 Trend Cursor or Multiple Trend Cursors 60 Value 163 Add-In Manager 255 Dialog 234 Alias 255 Module Database 255 Aligning Multiple Objects 194 Analysis Tools 13

B
Background color 142 Bad data 64, 93, 160 Bad Status Indicators 68, 78 Bar 79 Bad data indicator 79, 93

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 305

Index

Creating a bar 166 Invisible 166 Blinking attribute 160 Book View 22 Editing in 107 Preferences 30 Section of Procbook.ini file 292 Tabs 22, 107, 292 Browsing Displays from Internet Explorer 49 Build Mode Pointer 105 Buttons 23, 26, 45, 47, 48, 54, 59, 95, 100, 102, 118, 132 Adding a Button 168 Advanced Layout 145 Copy 118 Cut 132 Information 95 Item Definition 189 New 48 Open 48 Outline 23 Paste 118, 132 Revert 54, 102 Tag Attributes 47 Time Backward 100 Time Forward 100 Toolbar 26 Trend Cursor 59

C
Call Tracing 250 Change 21, 27, 34, 51, 95, 101, 132, 182, 185, 187, 275 Color Attributes 182 Default 27 Default Server 95 Display to Icon 51 Font Attributes 185 Format Settings in an Existing Display 132 Icon for an Object 275 Line Attributes 187 ProcessBook View Preferences 30 ProcessBooks to Icons 21 Time Range 101

Trend Default Preferences 34 Change the Run-time Module context 258 Change Time Range 25, 68 Circle 180 Draw a 180 Client Time 25, 97 Close a Display 52 a ProcessBook 21, 109 Entry 52 Collapse Outline View 23 Color 27, 142, 272, 297 Attributes 27 Change Default Preferences 27 Changing 182 Custom Colors 184 for bad data 160 of plot elements 142 OLE Object 272 Pen 36 Preferences 27 section of the imppign.ini file 297 Trend Element PreferencesTrend Element Preferences tab 36 Trend Preferences 34 COM connectors 12 COM object 223 Combined Time Scales 99 Commands 23, 24, 40, 49, 50, 59, 118, 132, 271 Align 194 and OLE Objects 271 Copy 118 Cut 132 Display Search and Run 50 Flip 191 Format Font 185 Format Line Style 187 Import 150 Menus 24 Multi-State symbol 160 Outline 23 Page of Toolbars dialog 25 Paste 118, 132 Print 40 Rotate 191

Select All 193 Trend Cursor 59 Trend Zoom 2x 59 Zoom 49 Comments field on Summary Dialog 15 Composite Symbol Automation 8 Layers 214, 215 Compound Documents 259 Configuring the Data Source 252 Connection Points 196, 198 Deleting 198 Naming 198 Placement dialog 198 Working with 198 Connections 93 Display Information 95 Failure 93 to Networks 228 to OpenVMS Servers 289 Connectivity 196 Connector 3 Avoidance PI API 292 Connector Symbols 196 Container 259, 261 Context 253, 255, 256, 258 Change at Run 258 Handler 253 Setup 256 Unresolved 256 Using Context string in dynamic symbols 255 Context for Module-relative Displays 258 Context-Sensitive Help 42 Continuous trace 63 Control 261 Conversion section of Procbook.ini file 292 Convert 274, 275 a Symbol from Multi-State to Static 162 Graphics 151 Trends 150 VAX-formatted trends and graphics 150 Copy 118, 232 Correlation 65

Correlation Coefficient for XY Plot 68 Definition of 65 Create 55, 106, 109, 110, 111, 112, 114 a Bar 166 a Linked Display Entry 112 a New ProcessBook 106 a ProcessBook 106 an Instant Trend for an Existing Value 55 an Operating System Command Entry 114 Display Entry 111 Dynamic Multi-State Symbols 160 Operating System Command Entry 114 ProcessBook Entries 109 Text Entry 110 Cursors 285 Missing 285 Custom Colors 184 Custom Data Sets 5, 223 Custom Menus 9 Custom Toolbars 26

D
Data 285 Data Manager in Procbook.ini file 292 Not in Display 285 Values 68 Data Archive 12, 83 Data Retrival Methods box 152, 153 Data Set 218, 225, 227, 228, 232, 242 Adding to a column 225 Adding to Bars or Values in a Display 228 Copying a 232 Custom 223 Edit a 228 Is it in Use? 223 More than one per trend 225 Refreshing 227 Running in ProcessBook 228 Data Source 236, 241, 250, 252, 287 Configuring the 252 Definition of 236 Delete a 250 Edit a 252

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 307

Index

Missing 287 Data Type 3, 6 Database definition of Vertical Scale 61 DECnet 302 Pathworks 302 Default 95 Format for New Trends 140 Server 95 Trend Format 140 Delete 119, 150, 231, 250, 273 a Data Set 231 a Layer 211 a Plot within a Trend 150 an Entry 119 an ODBC Data Source 250 an ODBC Driver 250 an OLE Object 273 Designing 123 Digital values 79 Directory 117 Working for Operating System Commands 117 Disabling macros 296 Discrete trace 63 Display and Other Entry types 12 as an Embedded Object 276 Can't Find Data 285 Connection Failure 93 Data sources for 12 Designing a 123 Elements of 152, 153, 156, 157 Manage multiple displays 53 Module-relative 253 No data in 285 Point Attributes 47 Reducing to Icon 51 Resizing 49 Saving 52 Saving separately 53 Display Document 276 Display Entry 12, 45, 123 Contents of 45 Designing a 123 Display Format Page Tab 152, 153, 156, 157

Display Search and Run command 50 Display Section in the imppign.ini file 297 Displaying an Item's Definition 189 Displaying an Object with an Icon 273 Displaying an OLE object with an Icon 273 Distinctions between 260 embedding and linking 260 dll section of Procbook.ini 292 Dotted line 54 Drag and Drop Embedding 267 Draw 171, 179 Free-form Objects 171 Polygons 171 Rectangle, Square, Arc, Ellipse, or Circle 180 Several Objects with the Same Tool 136 Drawing 123, 136, 192 Area 123 Grid 136 Stacks of symbols 192 Drawing Tools 135 Bar 166 Font 185 Format Line Style 187 Multi-State Symbol 160 Polygon 171 Symbol 172 Text 178 Trend 55, 145 Trend Display 55, 145 Driver Manager 236 Drivers 236 definition of 236 Dynamic Element 45 Dynamic Link Library 236 Dynamic Symbol 45, 53, 79, 189, 269 Bar 79 definition of 189 Multi-State symbol 79, 160 Status of 80 Trend 53 Value 163 Dynamic Update 269 of a Linked Object 269

E
Edit 107, 228, 252, 271, 272 a Data Set 228 a text box 179 an ODBC Data Source 252 Connectors 196 Embedded Objects 272 Linked Objects 272 OLE Object appearance 271 OLE Object Contents 272 Elements of Displays 45 Ellipse 180 How to Draw 180 Embed 260, 264, 265, 277, 278 a New File into a ProcessBook Display 265 an Existing File into a ProcessBookDisplay 265 discussion of 260 Example of 264 Existing ProcessBook Display in Another OLE Application 278 ProcessBook Display in Another OLE Application 277 Embedding 265, 267, 276, 286 Distinguishing from Linking 286 Drag and Drop 267 in ProcessBook 265 Sharing an Embedded ProcessBook Display 276 vs. Linking 265 Engineering Units 34, 163 on a trend 60 Enhancements 3, 4, 5, 6, 8, 253 Displays 3 Module-relative Displays 253 RtPortal 6 Symbols 4 Time zone settings 5 VBA Automation 8 Entries 12, 24, 109, 118 Arranging 118 Changing the Level of 119, 120 Changing the Name of 119 Creating 109

Placement in ProcessBook 109 Rearranging 24 Types of 12 Entry 48, 52, 109, 119 Add 109 Close 52 Deleting an 119 Open 48 Run 48 Saving a view of your entries 24 Error icon 3 Examples 264 Embedded and Linked Objects 264 Exception Updating 90 Expand Outline View 23 Expanding a Trend 59

F
FactoryTalk Historian ProcessBook 1, 279, 289 as OLE Container 279 as OLE2 Server 279 Connection to Windows NT or UNIX Servers 289 Introduction 1 Log on procedure 14 ODBC 13 OLE 13 Quitting 21 Server connection 289 Starting 14 Features 255 File 14, 122, 260, 304 Converting Graphics 151 Converting Trends 150 How to Import 133 Sharing 14 Size 260 Transfer Program 304 Fit 49 all symbols 49 Selected Symbols 49 Flags for Data 4, 81

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 309

Index

Flip command 191 Floating Point values 79 Font Attributes 185 Color 142 Font section of the imppign.ini file 297 Format Color 182 Font 185 Line 187 saving displays 53 Settings that FactoryTalk Historian ProcessBook Remembers from Last Time 37 Trend 140, 141 Freeform Objects 171, 190 How to Draw 171 How to Resize 190 FTP 304 Full Timestamp 63 Future Trends 102

I
Icons 21, 51 Graphics vs. Icons 264 Icons and Graphics Switching Between 274 Using 273 impg32.dll 292 Import 133, 150 command 150 Files 133 VAX-formatted trends and graphics 150 imppigp.ini 297 Independent Display files 53 Saving 52 saving individually 53 Index 211 Layers 211 Indicators 64 Annotated 81 Bad Data 64, 160 Bad Status 78 Out of Range 78 Questionable 78, 81 Substituted 78, 81 Too Many Points 78 Information button 95 Initiating Call Tracing 250 Insert 265 an object into a Display 265 Installation 292 interactive 292 quiet 292 Instant Trend 54, 55 How to Save 55 Integers 79 Internet Explorer 49 Interpolated data retrieval method 152, 153 Interval 152, 153 Invisible line on a trend 36 Invisible objects 182 Item 189 definition of 189 Item Definition button 189

G
General Page Tab 152, 153 Graphics 151, 177 Conversion to FactoryTalk Historian ProcessBook 151 Icons vs. Graphics 264 Grid 136, 152, 153, 156, 157 Grid Lines 34, 61 Size 137 Snap 136 Grouping Multiple 195 Commands Group 195 Group command 195 Multiple Symbols 195

H
Hash marks 93 Help 42 Context-sensitive help 42 Topics 42 Horizontal flip 191 Horizontal Scale Grid Lines 63 formatting 142 How Trends Refresh 54

K
Keyboard Shortcuts 37 Keywords 15 in a ProcessBook or Display 15

L
Labels 63 Horizontal Scale Grid Lines 63 Log scales 61 Trends 61 Vertical Scale Grid Lines 61 LastMarker 156 Color 156 Layers 3, 211 Active 211 Assign symbol to 214 Composite symbols 215 Count 211 Delete 211 Hierarchy 211 Index 211 Locked 211 Name 211 New Layer 211 Visible 211 Working with 211 Z Order 211 Layout tab 142, 145 Legend 152, 153, 156, 157, 285 Level of an Entry 119, 120 Line 36, 142, 179, 187, 297 Change Attributes 187 how to draw 179 LineStyle section of imppign.ini file 297 Style 34, 36, 142 Weight 142 Width 36 Linear Correlation Line 152, 153, 156, 157 Linear Regression by Least Squares Method 67 Link 268, 278 Existing File into a ProcessBook Display 268 ProcessBook to Another Application 278

Linked Displays or ProcessBooks 12, 121 Adding 112, 114 Relative and Absolute Paths for 121 Linked Object Data Isn't Updating 286 Updates of 269 Linking 260 discussion of 260 Distinguishing from Embedding 286 Example of 264 Sharing a Linked ProcessBook 276 to ProcessBook 268 vs. Embedding 265 Links 3, 270 Re-establishing 270 Storage of 270 Local Address 95 Locked Layer 211 Logarithmic scales 61, 137

M
Machine Address 292 Macro 296 Disabling 296 protection 292, 296 Manual update 269 of a Linked Object 269 Manually Defined Vertical Scale 61 Marker 34, 64 Bad data 93 Marker section of the imppign.ini file 297 No data 93 Shapes 36 Type 34, 142 Warning in procbook.ini 292 Match data retrieval method 152, 153 Max Traces Startup INI 137 Menu 9 Custom Items 9 Minimize button 21 Missing Data Sources 287 Missing Trace 287 Mode

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 311

Index

Mode Bias section of Procbook.ini file 292 Module 253, 255, 258 Add-in Architecture 253 Alias 253 definition of 253 Docked Window 258 Features 255 Load on Startup 255 Module Context Add-in 253 Module Context Handler 255 Module Database 253 Aliases 255 Choosing modules for use 256 Tree 256 Using Properties in dynamic symbols 255 Move 114, 121, 134, 145 a Display to another PI Server 134 a Plot 145 a ProcessBook to another PC 134 Displays to Other PCs 121 Linked Entries 114 MRD 253, 255, 258 MSQuery 246 for Building Data Sets 246 Multiple 12, 53, 60, 62, 145 Open Displays 53 Plots 145 Scales for the Vertical Axis 62 Servers 12 Trend Cursors 60 Multiple Objects 192, 193, 194 Align command 194 How to Select 193 Select 193 Stacking Order 192 Working with 193 Multi-State Symbol 79, 93, 160 Bad data indicator 93 Convert to static 162 Multi-State Command 160

of an Entry 111, 119, 120 Navigation 118 New 48, 106, 112, 114 button on Views 48 Linked Display Entry 112 Linked ProcessBook entry 114 Operating System Command entry 114 ProcessBook 106 No data indicators 93 Node 95 Identifiers 95, 121 Null value 225

O
Object 136, 259 Avoidance 292 Displaying with an Icon 273 How to Flip 191 How to Rotate 191 How to Select Multiples 193 Linking and Embedding 260 Organizing objects 136 Object Avoidance 292 ODBC 13, 228, 236 Data Access 235 Data set dialog 228 Data Sets 236 Data Sources 236 Driver Manager 236 Drivers 236 Preparing to Use 238 Troubleshooting 287 OLE Automation 13 Container/Server 279 in FactoryTalk Historian ProcessBookObject type 259 OLE Object 45, 271 Colors 272 Editing 272 Editing Appearance of 271 Linked or Embedded? 286 Placement of 272 Online Help 42 Open 17, 48, 52, 53 a Display 48

N
Name 106, 111, 119, 120, 211 a ProcessBook 106 of a layer 211

button 48 Entry 48 Independent Display Files 53 Multiple entries 53 ProcessBook 17 Several Displays at Once 52 Open Database Connectivity 13, 236 OpenVMS Trends and Graphics 150 Importing to FactoryTalk Historian ProcessBook 150 Operating System Command Entry 12 Adding 114 Organizing Objects 136 Out of Range Indicators 68, 78 Outline View 23 Buttons 23 Overview 1, 83, 259 FactoryTalk Historian ProcessBook 1 FactoryTalk Historian ProcessBook OLE Compound Documents 259 Point Databas 83

P
Pages 22 Turning in Book View 22 Paired 152, 153 by position 152, 153 by timestamps 152, 153 Partial Timestamp 63 Paste command 118 Pathworks 302, 304 PI API 6 PI Data Archive 83 PI Display Document 276 PI DLL 95 PI SDK Integration 6 PI Server 12, 83 Connection Fails 93 Updates to 90 PI UDS see PI Server 83 PIDIFF 83 PISDK Log 80 Pisysdat 290

piserver.dat 290 Placeholders 246 Editing 271, 272 Plot Element 34 How to Delete 150 How to Move 145 Multiple 145 Scale 34 Titles 34 XY Plot Element 152, 153, 157 Plot Format Page Tab 152, 153, 157 Plot Time 152, 153 Plot Title 152, 153 XY Plot 152, 153 Point 47, 53, 79, 83, 84 Attributes 47, 68, 84 Database Overview 83 Types 79 Types for Bars 79 Types for Values 79 Types on Trends 53 Pointers 80 Build Mode 105 Run Mode 80 Polygon How to Draw 171 Resizing 190 Tool 171 Port number 95 Preference Settings 26 Preferences Book or Outline View 30 Color 27 Trend 34 Trend Elements 36 Preserve aspect ratio 49 Print 40 Commands 41 Print Preview 41 Print Setup 41 Preview 41

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 313

Index

Print Preview command 41 Printer Setup command 41 Procbook.ini 292 ProcessBook 109 Add entries 109 as a Linked Object 276 Basic Steps to Build a 105 Creating a New 106 Creating Entries in 109 Default Preference settings 30 How to Create 106 Modify title 107 New ProcessBook 106 Open 17 Overview 11 Save and close 109 Saving a 109 Using More than One 20 View section of Procbook.ini 292 Properties 259 of a ProcessBook or Display 15 of Symbols in the Symbols Library 176

Q
Queries 249 Designing 123 Edit with Placeholders 228 Stored Procedures in 249 Questionable Data Flag 81 Quitting 21 a ProcessBook 21 FactoryTalk Historian ProcessBook 21

Relative paths 121, 270 Relative Time 99 Relative Timestamp 63 Remove 60, 119, 132, 250 a Data Source 250 a Trend Cursor 60 an Entry 119 an Entry and Paste It Elsewhere 132 Reset 102 Time Ranges 102 Resize 22, 49, 190 a Display 49 a FreeForm Shape 190 a ProcessBook Window 22 Polygon 190 Retain Aspect Ratio 292 Returnpoints of Procbook.ini file 292 Revert button 54, 68, 102 Revert Time 25 Revert Time Range 102 Right Mouse menu 176 Symbol Library 176 Rotate command 191 Rotating an Object 191 rows and columns 145 for arranging multiple plots 145 RtPortal Integration 6 Run 48, 258 Entry 48 Mode Pointer 80 Multiple entries 53

S
Save 24, 55, 109 Instant Trend Display 55 Preferred View of Your Entries 24 ProcessBook 109 ProcessBook Displays 52 Save As 53 Scale Box 152, 153 Scatterplot 65 Scrollbars 100 Scrolling Time Range 100 Scrolling 68 SDK 6

R
Rangesize section of Procbook.ini file 292 Read/Write Access 290 Real values 79 Rearranging Entries 24 in Outline View 24 Recorded data retrieval method 152, 153 Rectangle 180 How to Draw 180 Re-establishing Links 270 Refresh Interval 54, 227, 242 Refresh Timer section of Procbook.ini file 292

Search 50 for a Specific Display 50 Select 193, 270 a New Source Link 270 All 193 Multiple Objects 193 Select Available Modules dialog 256 Select Items Configuration Dialog 256, 257 Select New Node dialog 93 Selected Modules list 256 Server 95 Address 95 Default 95 Display information about 95 Multiple 12 Server box 152, 153 Server Time 25, 97 Servers 12 Setting Grid Size and Grid Snap 137 Setup procedure 292, 304 setup.exe 292 Setup.ini options 292 setup.log 304 SharePoint Services 6 Sharing 1, 276 ProcessBook Displays with Other Applications 276 ProcessBooks 1 Show Value attribute 30 Single Scale for the Vertical Axis 62 Single sign-on 6 Snap to grid 136 Source Application 259 Source Link 270 Span 61 Square 180 How to Draw 180 Stacking Order 192 Starting FactoryTalk Historian ProcessBook 14 Author 30 Backup files 30 Change Default Start Preferences 30

Tooltips 30 Create Backup files for a ProcessBook 30 Default Time Formats 30 Display 30 Module Context Add-in 256 PI Time Format 30 Preferences Start 30 Preserve aspect ratio 30 ProcessBook Default setting 30 Run Mode 30 Scrollbars 30 Defaults 30 Start Preferences 30 Startup Module Context Add-in 256 Subsecond Timestamps 30 Troubleshooting Slow performance 30 Value Attributes for Symbols 30 Windows Operating Systems Time Format 30 Startup section of Procbook.ini 292 Static Elements 45 Status Bar Active Layers 216 Status dialog 3 Status Flags 81 Status Icon 80 Status Report 80 Stored Procedures in Queries 249 Subject 15 of a ProcessBook or Display 15 Sub-second Timestamps 97 Substituted Data Flag 81 Summary 15 Information Dialog 15

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 315

Index

Switch Between Icon and Graphic 274 Symbol 172 Assign to layers 214 Book of Symbols specifying a 21 Connector Symbols 196 Enhancements in version 3 4 How to add 135, 172 Moving Attachments 207 Multi-State 160 Names 135 Symbol Attachments Dialog Box 207 Symbol Library 292 Synchronize 255 Modules and symbols 255 System 90, 292 defaults 292 System-Assigned Attributes 90

T
Tabs 22, 107 Tag Attributes 47 Name 34 Tags in Plot box 152, 153 TCP/IP 289, 303 Text color 36, 142 Edit a text box 179 entry 12 invisible 182 Labels 178 Tool 178 Time 25 Intervals forTags and Data Sets 227 Time Backward button 100 Time Forward button 100 Time Zone Toolbar 25 Time range 97, 98, 99, 100, 101, 102, 292 Absolute time 98 Changing 101 Combined time 99 Defined 101 Formats 97

Maximum updating limit for trends 292 Relative time 99 Revert 102 Scroll forward or backward 100 Toolbar 100 Time zones 97 Settings 5, 97 Timer section of the Procbook.ini file 292 Timestamp 63, 97 Title of a trend 60 of ProcessBook or Display 15 Too Many Points 78 Toolbars 25, 135 Buttons 26 Context-sensitive 25 Custom 26 Floating 25 Outline View 23 Rearranging 25 Time Range 100 View-onlyTime Range Toolbar 25 ToolTips Help 42 Trace 287 Format dialog 142 Markers 64 Maximum number of 137 Missing 287 Tracing ODBC Calls 250 Trend 53, 145 Appearance of 60 Cursors 59, 60, 285 Data Sets in 225 Default Format 140 Default Preferences 34 definition of 137 Definition section of procbook.ini 292 Delete a Plot 150 Enhancements in 3.0 Enhancements Trends 4 Expand 59 Formatting a 140 Formatting Procedure 141 Future End Times 102

Future time 137 Grid Lines and Labels 61 Horizontal Scale Grid Lines 63 Importing VAX-Formatted 150 Instant 54 Invalid data 93 Legend Doesn't Appear 285 Multiple Plots 145 Multiple Plots on 145 Preferences 34 Refresh rate for data 54 Refreshing data from a data set 227 Revise Format 143 Title of 60 Tool 55, 145 Vertical Scale Grid Lines 61 Zoom 2x In or Out 59 Troubleshooting 182, 285, 286, 287, 304 Cant save a display 285 Display Has No Data 285 Invisible objects 182 Legend Missing on Trend 285 ODBC Problems 287 Setup.log 304 Trend Cursors Missing 285 Updating Linked Objects 286 Trust logins 6 Types for Multi-State symbols 79

Editing 269 Updating 269 Processbook Linked and Embedded Displays 279 to Linked Objects 269 to PI Data 90 Troubleshooting 286 Update dynamically 260 Update Links 269 Updating cue for trends 54 User defaults 292 User-Assigned Attributes 84

V
Value 79, 163 attribute 30 Bad data indicator 93 Vanishing objects 182 VAX 292 Connections 292 Converting VAX-Trends and Graphics 150 Importing trends and graphics 150 VBA 281 VBA Automation Enhancements 8 Vertical flip 191 Vertical Scale 34 Grid formatting 142 Grid Lines 61 Single and multiple scales 62 View Only Mode 105, 297 Views Default Preference settings 30 Visible Layer 211 VMS 289

U
Undo 102 Updates 269, 286 Break Links 269 by Exception 90 Edit Links 269 for Future Trends 102 for Trend data 54 Links Breaking 269

W
Walker Richer and Quinn's TCP Connection 303 What's This? help button 42 Window Dockable Layers 8 Resize 49 Zoom 49

FactoryTalk Historian Site Edition ProcessBook User Guide

Page 317

Index

Windows Operating Systems 267 Drag and Drop 267 Work area 19 Working Directory for Operating System Commands 117 WRQ TCP Connection 303

X
XY Plot 65, 68, 152, 153, 156, 157, 158 Change Time Range 68 Conceptual Overview 65 definition of 65 Display Format Page Tab 152, 153, 156, 157 Examples 158 General Page Tab 152, 153 Interpreting 68 Legend 152, 153, 156, 157 Plot Format Page Tab 152, 153, 157 Plot Title 152, 153 Point Attributes 68 XYPlot 65 Procbook.ini settings 292

Z
Zero as a minimum tag value 61 Zoom 68 2x 59 Command 49

Vous aimerez peut-être aussi