PROCESSBOOK USER GUIDE PUBLICATION HSEPB-UM024A-EN-E–June 2012 Supersedes Publication HSEPB-UM023A-EN-E
● ● ● Copyright ● ● Contact Rockwell Automation Customer Support Telephone — 1.440.646.3434 Online Support — http://www.rockwellautomation.com/support Copyright Notice © 2012 Rockwell Automation Technologies, Inc. All rights reserved. Printed in USA. © 2010 OSIsoft, Inc. All rights reserved. This document and any accompanying Rockwell Software products are copyrighted by Rockwell Automation Technologies, Inc.
Contents Introduction ............................................................ 1 Recent History and Requirements for FactoryTalk Historian ProcessBook ....................................................................... 1 What's New in FactoryTalk Historian ProcessBook 3.2 ............. 1 What's New in This Release ..................................................... 2 FactoryTalk Historian ProcessBook Essentials ................... 5 What Can You View with FactoryTalk Historian ProcessBook ......
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Command Menus ............................................................. 14 Customize Toolbars ......................................................... 15 Toolbar Buttons .............................................................. 15 Add Buttons to Toolbars ............................................... 16 Browser Toolbar ................................................................. 16 Browse ProcessBooks and Displays ....................
● ● Contents ● ● ● ● Create a Text or Display Entry ............................................ 43 Linked Display Entry ........................................................ 43 Create a Linked Display Entry ............................................. 44 Linked ProcessBook Entries ................................................ 46 Move Linked Entries ..................................................... 46 Operating System Command Entry .......................................
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Work with a Display .................................................. 67 Overview of Display Elements ................................................ 67 Static Symbols ............................................................... 67 Dynamic Symbols ............................................................ 68 Buttons ........................................................................ 68 OLE Objects .........................................
● ● Contents ● ● ● ● Editable Formatting Attributes ........................................... 81 Font ............................................................................ 82 Line Color ..................................................................... 82 Fill Color ...................................................................... 83 Background Color ............................................................ 84 Line Weight.................................................................
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Create a Trend ............................................................. Build a Trend with Multiple Plots ................................... Move a Plot ............................................................. Delete a Plot within a Trend ........................................ Edit a Trend ................................................................ Define Trend Dialog Box .................................................
● ● Contents ● ● ● ● XYPlots .......................................................................... 133 Draw an XYPlot ............................................................ 136 General Tab ............................................................ 137 Configure Pairings ..................................................... 139 Scale Box ................................................................ 141 Plot Time ...............................................................
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Values ....................................................................... Add a Dynamic Value ................................................. Button ....................................................................... Add a Button ........................................................... Bars .......................................................................... Add a Dynamic Bar ....................................................
● ● Contents ● ● ● ● Select a Default Symbol for Data Favorites .......................... 197 Search for Data Favorites ................................................ 198 Favorites Panel ............................................................ 199 Use Favorites ........................................................... 199 Import or Export Data Favorites .................................... 200 Process Drags Between FactoryTalk Historian ProcessBook and Outside Applications .......................
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Connector Symbol ......................................................... Connect Two Symbols ................................................ Attach a Symbol to a Connector .................................... Connection Points ......................................................... Add Connection Points ............................................... Select Among Multiple Connection Points on One Symbol ..... Delete Connection Points ...........
● ● Contents ● ● ● ● Connect to an AF Database .............................................. Element Search ............................................................ Add Element Relative Data to a Dynamic Symbol ................... Context Path ............................................................... Work with the Element Relative Display Window ................... Data Sets ........................................................................ PI Calculation Data Sets .......................
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● ODBC Driver Manager ..................................................... ODBC Drivers ............................................................... ODBC Data Sources ........................................................ ODBC Data Access ......................................................... ODBC Data Source Administrator ....................................... Prepare for ODBC .........................................................
● ● Contents ● ● ● ● Edit, Update, or Break Links ................................................ How Links Are Stored ......................................................... Select a New Source Link .................................................... Edit the Appearance of an OLE Object .................................... Commands That Ignore OLE Objects ....................................... Placement of OLE objects ................................................... OLE Object Colors ............
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Installed Files .................................................................. 307 System Administrator Notes ...................................... 309 High Availability Configuration Settings................................... 309 Recommended Connection Preference Setting ...................... 310 MDB to AF Migration .......................................................... 311 Module Relative Display Add-in .................................
● ● Contents ● ● ● ● Color Section ............................................................... Line Style Section ......................................................... Font Section ................................................................ Marker Section ............................................................. Display Section............................................................. SETUPProcessBook.LOG ......................................................
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Knowledgebase ............................................................ Worldwide Support ........................................................ Training Programs ......................................................... Consulting Services ....................................................... TechConnect Support ..................................................... Find the Version and Build Numbers ...................................
Chapter 1 Introduction As the easy-to-use graphical display interface to the Rockwell Automation FactoryTalk Historian system, FactoryTalk Historian ProcessBook makes it possible to efficiently display real-time and historical data residing in the FactoryTalk Historian system and other sources. Process owners use FactoryTalk Historian ProcessBook to create interactive graphical displays that can be saved and shared with others.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Enhancements to FactoryTalk Historian ProcessBook Display The Playback toolbar added for v3.2 is enhanced to provide more time controls and synchronization across multiple displays for time range changes only. The name of the toolbar is now Time Range and Playback toolbar to reflect the enhanced functionality. The Bar symbol now has a scale option.
● 1 ● Introduction ● ● ● ● Display navigation is enhanced with browser-based navigation controls (page 16) that traverse, open, and bookmark displays and workbooks. The FactoryTalk Historian sqc Statistical Quality Control symbol is now included with FactoryTalk Historian ProcessBook.
● ● ● ● ● 4 FactoryTalk Historian ProcessBook User Guide
Chapter 2 FactoryTalk Historian ProcessBook Essentials What Can You View with FactoryTalk Historian ProcessBook A FactoryTalk Historian ProcessBook display entry may contain data streams (page 229) from any or all of the following sources: FactoryTalk Historian servers, including both point data (actual instrument readings). Calculations from FactoryTalk Historian data. Other databases with ODBC connectivity. Other databases with custom interfaces to FactoryTalk Historian ProcessBook.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Start FactoryTalk Historian ProcessBook To begin using FactoryTalk Historian ProcessBook: 1. Launch the application. 2. Log in to a FactoryTalk Historian Server (page 6). 3. Open a ProcessBook file (page 10) or display (page 11). Servers and Connections FactoryTalk Historian ProcessBook is a visualization application designed for displaying FactoryTalk Historian system data.
● 2 ● FactoryTalk Historian ProcessBook Essentials ● ● ● ● A selected check box next to a server name in the Connections dialog box indicates an open connection to the FactoryTalk Historian server. To manage connection settings: Click to select a check box and open a connection to a FactoryTalk Historian server in the list. Clear a check box to close a connection. Select a FactoryTalk Historian server in the server pane to access connection settings.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● FactoryTalk Historian Security FactoryTalk Historian ProcessBook is designed to support whatever FactoryTalk Historian Security is configured on the FactoryTalk Historian server. 1. When attempting to connect to a FactoryTalk Historian server, the application first attempts to pass your FactoryTalk Security/Windows log in credentials.
● 2 ● FactoryTalk Historian ProcessBook Essentials ● ● ● ● Displays and Connection Failure If the connection to your data is not successful, the display (page 11) is still drawn, but data in dynamic elements are replaced with indicators signifying that no data is available. Trends are labeled Invalid and no information is plotted. Values are replaced with pound signs (###) and the message Disconnected appears. Bar graphs are drawn using hash marks (//////).
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Node Identifiers for Multiple FactoryTalk Historian Servers A Node Identifier is stored with each tag name used in a display to point to the correct server. If you define FactoryTalk Historian server nodes in the PI Connection Manager dialog box, the identifiers are the same on each PC on the network as long as the node names for the FactoryTalk Historian system are the same.
● 2 ● FactoryTalk Historian ProcessBook Essentials ● ● ● ● Display The main unit for creating presentations of data in FactoryTalk Historian ProcessBook is the display. A display may stand on its own (.pdi or.svg), or it may be part of a ProcessBook (.piw) (page 10). A display contains all the symbols used to represent an operational environment using real-time, production data from FactoryTalk Historian as well as data from other sources.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Run Mode and Build Mode When you work with a ProcessBook or an independent display, you work in one of two operating modes, Run mode or Build mode. Build mode. Most of the functions that you use when you create or modify a ProcessBook require the Build mode pointer. Use Build mode to add, remove, or move symbols on a display, to add, remove, or organize entries in a ProcessBook, and for access to symbol definitions and formatting tools.
● 2 ● FactoryTalk Historian ProcessBook Essentials ● ● ● ● Add-Ins By default, FactoryTalk Historian ProcessBook installs with the following add-in components. You can load or unload these and other add-in components by using the Add-In Manager (page 13). AF 2.x Data Set. Browser toolbar (page 16). Data Favorites (page 196). Details (page 191). Element Relative Displays (ERD) (page 238).
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 2. Click an available add-in from the Available Add-Ins list. 3. A description of what the add-in does appears in the Description box. 4. Under Load Behavior, select the appropriate check boxes: Loaded/Unloaded Loads or unloads the selected add-in. The add-in's current status appears in the Load Behavior column at the top. Load on Startup Loads the selected add-in on startup of FactoryTalk Historian ProcessBook.
● 2 ● FactoryTalk Historian ProcessBook Essentials ● ● ● ● Menu Bar Function Book Displays when a FactoryTalk Historian ProcessBook workbook is active Display Displays when a FactoryTalk Historian ProcessBook display document is active View-Only Book Displays when FactoryTalk Historian ProcessBook is running in no-edit mode and a FactoryTalk Historian ProcessBook workbook is active.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● You can configure toolbars to display as view-only to omit unnecessary buttons. View-only toolbars and others can be specified in procbook.ini (page 315). Add Buttons to Toolbars You can change the icons that appear on the toolbars or create your own custom toolbar. 1. Click View > Toolbars. 2.
● 2 ● FactoryTalk Historian ProcessBook Essentials ● ● ● ● 3. From the Browser toolbar (page 16), click either the Forward or Back buttons to view previously opened ProcessBooks or displays. Only displays opened during the current session of FactoryTalk Historian ProcessBook are included in this navigation. You can also use the Address box to open ProcessBooks and displays. 1. Click the arrow to the right of the Address box to see the last ten valid file paths you entered.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 1. On the Browser toolbar (page 16), click the small arrow next to the Home button 2. . From the drop-down menu, select one of the following: 1. Use Default to make PIDemo.piw your default file. 2. Use Current to set the start file to the current, active ProcessBook or display. Bookmarks and Browser History The Organizer is a docking window that allows you to organize and use bookmarks and the current session's history.
● ● 2 ● FactoryTalk Historian ProcessBook Essentials ● ● ● Bookmarks New bookmarks are automatically added to the root level of the bookmarks tree. You can organize the entries into a hierarchical tree structure by dragging and dropping entries. Right-click the Bookmarks tab to select one of the following from the context menu: New Folder inserts a new folder at the top level of the tree or as a subfolder of a selected folder. Rename makes the entry name of the selected entry editable.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 3. Click to edit a bookmark. If the active file is already bookmarked, the same icon appears as the Edit Bookmark icon. Click this button to edit the bookmark's label and file path. 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.
● ● 2 ● FactoryTalk Historian ProcessBook Essentials ● ● ● Assign a Keyboard Shortcut To assign a keyboard shortcut: 1. Click View > Assign Shortcuts. The Shortcut Keys dialog box appears. 2. Under Select a macro, click the appropriate macro (menu item). The description for that item and its assigned shortcuts, if any, appears. 3. Click Create Shortcut. The Assign Shortcut dialog box appears.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 4. Under Press new shortcut key, type the key you wish to use for the shortcut. If you choose a combination already in use, the current assignment appears in the dialog box. If you click OK, the previous assignment is voided. 5. Click OK. The new shortcut appears in the Assigned shortcuts box.
● 2 ● FactoryTalk Historian ProcessBook Essentials ● ● ● ● Preference settings are stored in the file procbook.ini. Before you change the Preference settings, consider creating a back-up copy of procbook.ini so that you can restore FactoryTalk Historian ProcessBook to the original settings. General Preferences Click Tools > Preferences > General tab to configure application-wide settings. These settings are stored in and retrieved from the [STARTUP] section of your procbook.ini (page 315) file.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Review the following for additional information: 24 Author Determines the name used as the creator of new files and the person who last edited the file. See Summary Information in ProcessBook (page 59) for more information. This field is blank by default when FactoryTalk Historian ProcessBook is first installed on a computer.
● ● 2 ● FactoryTalk Historian ProcessBook Essentials ● ● ● Date and Time Format Settings in this area determine how time is displayed in FactoryTalk Historian ProcessBook. Previews of each format are shown to help you select the desired option. The Use local Windows format option uses the current Regional Options settings in the Windows Control Panel on the client machine to determine how dates and times are displayed.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Table of Contents Preferences Click Tools > Preferences > Table of Contents tab to configure the default view of Table of Contents windows for ProcessBook (PIW) files, as well as the font applied to each level of entry in those files. These settings are stored in and retrieved from your procbook.ini (page 315) file.
● ● 2 ● FactoryTalk Historian ProcessBook Essentials ● ● ● Review the following for additional information: Default View Settings in this area determine how ProcessBook entries are displayed by default. The default is Book view. Font Settings The controls in this area determine the font settings applied to each entry level in a ProcessBook. The font settings control the display of entry names in Table of Contents windows. The Entry level field allows you to select the level to configure.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Display Window Click Tools > Preferences > Display Window tab to set options that apply to display windows. These settings are stored in and retrieved from your procbook.ini (page 315) file.
● ● 2 ● FactoryTalk Historian ProcessBook Essentials ● ● ● Review the following for additional information: Preserve Aspect Ratio on resize Determines whether display element sizes change in proportion to the window size when a window is resized. When the check box contains a check mark (is selected), the aspect ratio is preserved and the display element sizes change in proportion to the window size. Show Symbol ToolTips Determines whether ToolTips are displayed on display symbols.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Trend Preferences Click Tools > Preferences > Trend tab to set default settings for new trend symbols. These settings also apply to instant trends.
● ● 2 ● FactoryTalk Historian ProcessBook Essentials ● ● ● Review the following for additional information: Display Check or clear these options to configure what information a trend displays by default. AutoScale Legend 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 use the Database scale for each tag. Plot Title Select this check box if you want a title to display.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Sample Use this display area to view a preview of selected trend preferences. Trend Elements Preferences Click Tools > Preferences > Trend Elements tab to set what colors, line styles, etc. are used in individual traces gridlines, text, or the background. These settings also apply to instant trends.
● ● 2 ● FactoryTalk Historian ProcessBook Essentials ● ● ● Review the following for additional information: Multi-State on Ad Hoc Select this check box to include data from multi-stated symbols when creating an ad hoc (instant) trend. When this option is cleared, data from a multi-state configuration is not included on instant trends. Traces per Ad Hoc Trend Select the number of traces to have per plot on an ad hoc (instant) trend. The default is 3, the maximum is 8.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Each topic in the help file may be printed separately or you can print them all at once. The Print command is accessible from the File menu, CTRL+P, or the print button. You can print the contents of the active window or if you select items within a display before you open the Print dialog box, then you can choose to print only those items. On a non-color printer, symbols are printed in shades of gray, but trends are printed in black and white.
● ● 2 ● FactoryTalk Historian ProcessBook Essentials ● ● ● Print Preview 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, click File > Print Preview. Zoom in or out of the selection by clicking on the selection with the magnifier cursor or by clicking the Zoom buttons. To print the selection, click the Print button.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Change the Language Used for FactoryTalk Historian ProcessBook You can change the language for the application on your machine if you have a FactoryTalk Historian ProcessBook Language Pack and the desired language resources installed. The language setting is per user locale, so if others want to use the application on the same machine under a different login, they can use different language resources, if they are available.
● ● 2 ● FactoryTalk Historian ProcessBook Essentials ● ● ● Click Copy Info to copy the contents of the list to your Windows clipboard where it can be pasted into a spreadsheet or text editor. This can be useful to share with Rockwell Automation Technical Support engineers if you have a problem. Click System Info to launch the Microsoft System Information dialog box. This information can also be useful when troubleshooting issues through Technical Support.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 38
Chapter 3 Work with a ProcessBook Basic Steps to Build a ProcessBook There are five basic steps to creating a ProcessBook (page 39): 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. 4.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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 current session. FactoryTalk Historian ProcessBook also creates a file name for the new ProcessBook. It suggests the first word from your title and an extension of .piw. For example, FactoryTalk Historian ProcessBook may suggest Filtrat1.PIW.
● ● 3 ● Work with a ProcessBook ● ● ● 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, you may select a file name from the bottom of the File menu.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Linked ProcessBook (page 46) - links to an entry in another ProcessBook. Operating system command (page 46) - opens 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.
● 3 ● Work with a ProcessBook ● ● ● ● Create a Text or Display Entry Use text entries to add labels and clarify text in a ProcessBook table of contents. Display entries represent a display in a ProcessBook. 1. Click File > New. The New dialog box appears. 2. Under Type, select ProcessBook Entry. 3. Click OK. The Define ProcessBook Entry dialog box appears. 4. In the Label dialog box, type a name. 5. For the Type, select Text or Display. 6.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● The linked entry is not a copy; it is a way of opening the original, similar to using a Windows shortcut. The Book View or Outline View shows the title of the linked entry, but the actual display window shows the title of the original entry. If you edit the original from any linked entry, the original is updated and automatically appears updated in all the ProcessBooks that are linked to it.
● 3 ● Work with a ProcessBook ● ● ● ● 6. 7. Click the Browse button, or click the Browse arrow to see more search options. The Open dialog box appears. To link to an independent display file, locate and select the display file (.pdi) to which you want to link and then click the Open button. The display name appears in the Action box. To link to another ProcessBook, locate and select the processbook file (.piw) to which you want to link and click the Open button.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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.
● 3 ● Work with a ProcessBook ● ● ● ● 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 or other documents. Your computer must have enough memory to run the applications you want to use in addition to FactoryTalk Historian ProcessBook.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 8. If you need to specify the location of the executable for the application, click the Browse button to the right of the Working folder box. The Browse for Folder dialog box appears. 1. Locate and select the folder that you want to specify for this operating system command, and click OK. If you know the name of the working folder for this application, then you can type it directly in the Working folder box. 9.
● ● 3 ● Work with a ProcessBook ● ● ● 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. Working Directory for Operating System Commands The Define ProcessBook Entry dialog box has a text box where you can enter the working directory. The command line recognizes file extension associations.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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. 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.
● 3 ● Work with a ProcessBook ● ● ● ● summary display. Each of these displays can have several displays for their components. Turn Pages in Book View To turn pages in the Book view: 1. Click View > Book to view a ProcessBook in Book View (page 50). Notice the top right corner of the page is divided into two small triangles .
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 2. Click the upper triangle to move forward one page, or click the lower triangle to move backward a page. A dark gray triangle indicates there are no more pages in that direction. 3. Click the tabs along the right-hand side to move quickly between sections of a ProcessBook. Resize a ProcessBook To resize a ProcessBook: 1. Click and drag on the frame of a ProcessBook until the window is the size you want.
● ● 3 ● Work with a ProcessBook ● ● ● Change the Name of an Entry in Book View To change the name of an entry in the Book view: 1. Click View > Book to view a ProcessBook in Book View (page 50). 2. In Build mode, double-click the entry you want to change. The Define ProcessBook Entry dialog box appears. 3. Under Label, type a new name. 4. Click OK. Change the Level of an Entry in Book View To change the level of an entry in the Book view: 1.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Hierarchies of entries may be revised by dragging entries from one location to another, or by promoting and demoting entries. Collapse or Expand Outline View You can collapse or expand sections of the outline to view the list of displays in a meaningful manner.
● ● 3 ● Work with a ProcessBook ● ● ● 1. Click View > Outline to view a ProcessBook in Outline View (page 53). 2. 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: -orClick the transparent plus sign to collapse the list of subordinate displays. Expanded View: You can change the font for each level in Outline View in the ProcessBook Preferences (page 22) dialog box.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Move the highlighted entry down. Change the Name of an Entry in Outline View To change the name of an entry in the Outline view: 1. Click View > Outline. 2. In Build mode, click the entry you want to change. 3. Click Edit > Selected Item. The Define ProcessBook Entry dialog box appears. 4. Under Label, type a new name. 5. Click OK. Change the Level of an Entry in Outline View To change the level of an entry in the Outline view: 56 1.
● ● 3 ● Work with a ProcessBook ● ● ● Copy and Paste an Entry To copy and paste an entry: 1. Click 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. A copy of the original entry is created, not a link to the original.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Save and Close 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 stored permanently. The ProcessBook remains open in your workspace so you can continue working. 58 1.
● ● 3 ● Work with a ProcessBook ● ● ● Properties Summary Information in ProcessBook Click File > Properties to display the Summary Information dialog box for a file. The Summary Information dialog box you see is the same for the ProcessBook as a whole or for the individual displays. Review the following for additional information: Field Name Description Author Extracted from the Author field on the General tab in the ProcessBook Preferences dialog box at the time the ProcessBook is first saved.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Field Name Description Keywords May be added at any time. Comments May be used for any text entry. You can revise this field at any time. Properties button Clicking the Properties button displays the FactoryTalk Historian ProcessBook Properties (page 60) dialog box, which gives information about the view currently in the active window. FactoryTalk Historian ProcessBook File Properties To view file properties: 1.
● 3 ● Work with a ProcessBook ● ● ● ● Field Name Description Title Extracted from the Summary Information dialog box. Created 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, however Windows Explorer shows the date and time the file arrived on the present machine. Created By Extracted from the Author field on the General tab in the ProcessBook Preferences dialog box.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● ProcessBook window displays the file name, which ends in .piw, rather than the title. 3. Click OK. FactoryTalk Historian ProcessBook Display Properties To view the display properties: 1. With a display window selected, click File > Properties to display the Summary Information (page 59) dialog box for a display. 2. Click Properties. The Display Properties dialog box appears.
● 3 ● Work with a ProcessBook ● ● ● ● Field Name Description the original date and time will be preserved, however Windows Explorer shows the date and time the file arrived on the present machine. Created By Extracted from the Author field on the General tab in the ProcessBook Preferences dialog box. Shows the original author, unless the author’s name has been modified in the Summary Information dialog box. Last Saved Most recent revision date and time.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 3. Select the file type. 4. Select the drive and directory where the file resides, or type the path and file name in the File Name box. You can select more than one file at a time. 5. 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.
● ● 3 ● Work with a ProcessBook ● ● ● -or Close the ProcessBook and reopen it so that the new version of the display is shown. Then make changes and save again. Open the Summary Information (page 59) dialog box to view the name of the person who has made changes and saved the file most recently.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 66
Chapter 4 Work 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, XYPlots, SQC plots, and Multi-State symbols. Use a Trend Cursor to see the value of plotted tags at a specific point in time. Create an instant trend.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Dynamic Symbols Dynamic symbols are values, bars, trends, XYPlots, SQC charts, and multi-state symbols (such as a pump image tied to temperature data) that change over time, and are based on the value of a tag in the FactoryTalk Historian Archive. If you wish to see how a dynamic symbol was defined, select it and click the Item Definition button on the Drawing toolbar. Dynamic symbols may also report data from outside databases through queries.
● 4 ● Work with a Display ● ● ● ● Manage Displays and Independent Display Files Open a Display Use any of these procedures to open a display from either Book View (page 50) or Outline View (page 53) of a ProcessBook: Click the display title, then on the New button to open the selected display in a new window. Click the display title, then on the Open button to open the display into the last display window you used. If none are open, a display window opens.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● If you click an Operating System Command more than once in the same session, it may run the application repeatedly. This depends on the application and how it has been set up. Displays re-open in the same position, size, and shape as when they were last saved. Open Several Displays at One Time In addition to the procedures for opening a display, you can also open multiple displays simultaneously.
● ● 4 ● Work with a Display ● ● ● Open Independent Display Files Independent Display Files use a .pdi extension in the file name. When you double-click a display file in Windows Explorer, a copy of the FactoryTalk Historian ProcessBook application installed on your PC opens, just as it would if you double-clicked on a .piw file. The independent display appears inside the application. Browse a Display from Internet Explorer You can select a .pdi file and look at it in Internet Explorer.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● the display resize and take up the entire window. OLE objects are not included. 4. Click OK. You must save the display before closing it for your zoom settings to appear the next time you open it. To resize the window: Use the Maximize and Minimize buttons in the upper right hand corner of your display window to adjust your display size. When you maximize a display, all open display windows are maximized.
● 4 ● Work with a Display ● ● ● ● Search for a Display To search for a display: 1. Open the ProcessBooks (page 40) you want to search. 2. Click Tools > Display Search & Run. The Display Search dialog box appears. 3. Under Name, type one or more of the letters of the display name. 4. In the Look in, click the location you want to search. -orIn the drop-down list, click Browse, and then locate the appropriate folder. 5. Select Look in subfolders (optional). 6. Click Search.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Reduce 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 FactoryTalk Historian server, however the results are not shown until the window is restored. When you want to use the display, double-click the icon.
● ● 4 ● Work with a Display ● ● ● Display Settings To edit display properties, click Edit > Display, or double-click the Time Zone setting in the Status bar. The Display Settings dialog box appears. Review the following for additional information: Background Color The color applied to the area of the display where there are no symbols. This field uses a color well control to provide color choices. The color selected in this field also becomes the default background color for new displays.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Time Zone This field determines whether the local computer or FactoryTalk Historian server time zone is used for interpreting dates and times for this particular display. Connectors The Enable Connector Attachments check box allows a symbol dragged and dropped on a Connector symbol to be attached to that Connector. Clearing the check box disables this functionality for the Display.
● ● 4 ● Work with a Display ● ● ● Run Mode Determines the scroll bar behavior of display windows in Run mode. Build Mode Determines the scroll bar behavior of display windows in Build mode. On Display contains scroll bars all the time. Off Scroll bars never appear. Automatic Scroll bars appear when needed (this is the default setting for new displays).
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● You can use the drawing tools to: Create ellipses, polygons, rectangles, arcs, lines, and polylines. Add dynamic elements such as values, bars, trends, buttons, and graphic files. Add ActiveX controls. The Drawing toolbar contains a set of buttons used for creating drawings and the Draw menu contains the corresponding commands. To use the drawing tools, click the appropriate button.
● 4 ● Work with a Display ● ● ● ● 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 Symbols (page 210). Make sure you have selected the item or items with the Build Mode pointer.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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. 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.
● 4 ● Work with a Display ● ● ● ● 5. Click OK. Formatting Each symbol you draw and place on a display has attributes that determine how the symbol looks. The fill and line attributes that are currently selected on the Display Window (page 28) tab of the ProcessBook Preference dialog box are applied to any new drawing symbol. You may configure these attributes for individual symbols or for all selected symbols as a group.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Font To determine what type of formatting is applicable for each symbol, refer to the table of editable formatting attributes (page 81). To configure fonts: 1. In Build mode, open a display, and click the symbol(s) whose font you want to change. 2. On the Symbol Formatting toolbar, click a font name in the list . When choosing fonts, plan to use fonts that other FactoryTalk Historian ProcessBook users are likely to have.
● ● 4 ● Work with a Display ● ● ● Depending on the symbol type, the following elements change to the color displayed on the button. 3. Symbols that display text use the line color to determine the color of the text within the symbol. Symbols that have lines (such as ellipses) use the line color to change lines in the symbol. Click the arrow on the right side of the Line Color button to display the color palette.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 3. Click the arrow on the right side of the Fill Color button to display the color palette. Choose from the 16 colors available or click one of these two buttons: Custom Color Launches the Color dialog box where you can choose additional colors from a color well of options. None Disables fill color. Setting the fill color to None shows the display background color.
● ● 4 ● Work with a Display ● ● ● Line Weight To determine what type of formatting is applicable for each symbol, refer to the table of editable formatting attributes (page 81). To configure line weight: 1. In Build mode, open a display, and click the symbol(s) whose line weight you want to change. 2. On the Symbol Formatting toolbar, click the Line Weight button . A list of six line weight options appears below the button. 3. Select a line weight.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Line Ends To determine what type of formatting is applicable for each symbol, refer to the table of editable formatting attributes (page 81). To configure line ends: 1. In Build mode, open a display, and click the symbol(s) whose line ends you want to change. 2. On the Symbol Formatting toolbar, click the Line Ends button A list of four line ends options appears below the button. These options determine whether arrows appear at the end of lines.
● 4 ● Work with a Display ● ● ● ● ToolTip Statistics In Run mode, hover your mouse over a point on a dynamic symbol to display a ToolTip with summary statistics. Engineering units are shown next to the value followed by the timestamp paired with the value. If you hover your mouse over a point where there is more than one trace, each trace's data is shown on a separate line.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Time Range and Playback Toolbar The Time Range and Playback toolbar allows you to play, pause, loop, and manually scroll a display through a pre-set time period. You can move backwards and forwards in time, alter the display range duration, and revert to the original symbol definitions. Playing back a display can be useful for showing the conditions of various systems and analyzing conditions leading up to a specific time frame or event.
● 4 ● Work with a Display ● ● ● ● Time Tracker The time tracker shows the Display range (page 93) and available Scroll period (page 92). Go to Current Time Click the button to move the display range so that its end time is the current time (*). This action does not change the dimensions of the display range. This button is available only when playback is not active. Change the Display Click the button or double-click the display range to open the Change Range Display Range dialog box (page 94).
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Pause/Play The button drives the playback feature. The Play button changes to the pause icon when a display is in playback mode. When playback is paused, the button shows the play button. Fast Forward Click the button to accelerate the rate of play back. Each successive click of Fast Forward doubles the rate at which the display plays back. The first click doubles playback speed, then advances to 4x, 8x, 16x, and 32x the playback speed.
● 4 ● Work with a Display ● ● ● ● Scroll Options Dialog Box Use the Scroll Options dialog box to set the default behavior settings for the Time Range and Playback toolbar. These defaults apply to the active display or all displays, if synchronization is on. The defaults are retained when FactoryTalk Historian ProcessBook is closed and re-opened on a per user basis.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Review the following for additional information: Display Range Use any accepted FactoryTalk Historian Time (page 337) input parameter to set the length of the display range. Scroll Period (page Use the spin box or calendar controls to select start and end dates and times. Refresh Rate Select the number of seconds between updates of the display that is being played. Speed Select the rate at which the display plays back.
● 4 ● Work with a Display ● ● ● ● Change the Scroll Period There are several ways to change the scroll period: Hover the mouse next to the left or right arrow of the scroll period to change the mouse icon to a calendar icon. Click the icon to open the calendar where you can modify the dates. Click the Scroll Options button to launch the Scroll Options (page 91) dialog box.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● A display must be reverted to re-establish any build time configuration time ranges for individual symbols. The Change Display Range Dialog Box Use the Change Display Range dialog box to specify the display range. Rules for time settings: The start and end time boxes support all time string formats recognized by FactoryTalk Historian. You can edit the times manually.
● 4 ● Work with a Display ● ● ● ● Use the Time Tracker arrow keys to move the display range current position. Click the scroll bar on either side of the display range to move the display range to the position where you click. Click anywhere in the display range and use the left and right arrow keys to move the display range back and forward across the scroll period. Layers within Displays You can divide a display into layers containing one or more symbols.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Click View > Layers. The Layers dialog box appears. 3. 96 Review the following for additional information: Index 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.
● 4 ● Work with a Display ● ● ● ● 4. Click New Layer. The New Layer dialog box appears. A default name comprised of the word Layer prefixed to the layer number appears. The layer number does not necessarily match the index number; it is simply the next unused integer in the list. A new layer is added to the end of the collection. Its index is one higher than the previous high index number. All symbols added to this layer are displayed over symbols on lower indexed layers. 5.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Assign Symbols to Layers If you have at least one layer in a display, you can assign symbols to it. 1. Select a symbol, right-click, and select Assign Layers. The Assign Layers dialog box appears and displays all of your existing layers. 2. Select or clear the check box next to a layer name to add or remove the selected symbol from a layer. If a layer name is grayed out, the layer is locked and you cannot add or remove symbols.
● 4 ● Work with a Display ● ● ● ● You cannot group symbols on locked layers into a composite symbol, but the layers may be locked after the symbols are grouped. You cannot delete a composite symbol that contains symbols on locked layers, however, you can delete an unlocked layer. 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.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Migrate Displays to Another FactoryTalk Historian Server When you want to use an existing tag with a different FactoryTalk Historian server, FactoryTalk Historian ProcessBook attempts to locate the correct tags. Each ProcessBook saves the tag information for all of the symbols it contains. Beginning with PI SDK 1.3.
● 4 ● Work with a Display ● ● ● ● 0 - [default] the Point ID is used to match a missing tag before the stored point name. 1 - uses the tag name before checking Point ID. This mimics behavior of older version of FactoryTalk Historian ProcessBook that are based on the FactoryTalk Historian API.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 102
Chapter 5 Visualize Data with Symbols Symbols are the building blocks of a FactoryTalk Historian ProcessBook display. Dynamic symbols allow you to view live data streams (page 229) in your display. These symbols are updated in real time as FactoryTalk Historian ProcessBook receives updates from your FactoryTalk Historian server. The maximum number of dynamic symbols per display is 278,343. Static symbols (page 177) allow you to embed graphics, text, lines, and other images in a display.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Plot Title The title of the trend being configured. The plot title can be blank, but a title is supplied by default. Grid lines Used to mark intervals along the time and value scales. If the Plot Time continues through the current time, the trend updates as information changes, unless the length of the overall time period exceeds the limit set by your System Administrator. The default limit is 7 days. This value is configurable.
● ● 5 ● Visualize Data with Symbols ● ● ● 4. When you release the mouse button, the Define Trend (page 110) dialog box appears. 5. Under Plot, type a name. 6. (Optional) Click New Plot if you want to build a trend with multiple plots (page 109). 7.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Tag Search (page 231) PI calculation (page 248) (data set) ODBC (page 254) (data set) AF2 (page 269) - launches the Select AF Attribute dialog box, from which you can search an AF database for elements and attributes. Element Relative (page 240) - launches the Element Search dialog box from which you can search an AF database for elements. Your selections for tags, data sets, or attributes appear under Tags in Plot. 8.
● ● 5 ● Visualize Data with Symbols ● ● ● 10. Under Scale, select Single Scale or, if you have more than one trace, you may select Multiple Scales. The multiple scales option shows a value range for each trace. There is only one time scale. 11. Consider checking the following check boxes: Logarithmic 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.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Autorange The trend displays with the value scale ending at the closest available major axis. If the maximum is Autorange and the minimum is not, the plot starts on the minimum value and ends on the largest trace value (neither min nor max will be on a major axis). Database The tag's Zero + Span attributes are used to specify the maximum plot value. 0 (absolute value) The value you type is used as the value scale maximum. 13.
● ● 5 ● Visualize Data with Symbols ● ● ● FactoryTalk Historian ProcessBook allows you to create custom placeholders for a symbol based on a summary Data Set or a FactoryTalk Historian Tag placeholder in an ODBC data set. Placeholders are not allowed for expression Data Sets.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● In Build mode simply click the plot you want to move. Selection handles appear around the plot. Use these handles to drag the plot to its new location. Delete a Plot within a Trend To delete a plot within a trend: 1. In the Define Trend dialog box, click the General tab. 2. In the Plot list, select the plot you want to delete, and then click Delete Plot. This button is only available while the symbol is being created.
● 5 ● Visualize Data with Symbols ● ● ● ● shapes, and you can set the types of point information included with a trend. The Define Trend dialog box has a General tab where you create a trend (page 104), and the following additional tabs for formatting and layout: Display Format (page 112) Options for the elements to be included in the trend. Trace Format (page 113) Provides an alternate way to choose colors and line styles for each trace (plot line) as well as the axes, background, and text.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Display Format Tab Review the following for additional information: 112
● ● 5 ● Visualize Data with Symbols ● ● ● Legend Check or clear options in this group box for displaying the tag name, server name, description, value, and engineering units. Your choices are reflected in the sample trend at the bottom of the dialog box. 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.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● The Trace Format tab gives you an alternate way to update formatting changes. Plot Element drop-down box - select from a list of available traces and other plot elements.
● ● 5 ● Visualize Data with Symbols ● ● ● Element Format group box - select formatting options for the selected plot element. Your choices are reflected in the sample trend at the bottom of the dialog box. Layout Tab The plot arrangement in a multi-plot trend is established by setting up the number of rows and columns of plots in the Layout tab. The Layout tab only appears when you initially create a trend (page 104).
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Under Plot Arrangement, select the number of rows and columns you want. The following example shows four plots, to be arranged in 2 rows of 2 columns each. Tab past the matrix to see the sample of your new selection display in the Preview area.
● ● 5 ● Visualize Data with Symbols ● ● ● Configure Trend Scale The Trend Scale dialog box provides easy access to the value scale settings for each tag in a trend, SQC chart or XYPlot. If the plot uses a data set, only the Autorange and Absolute options are available for the Maximum and Minimum scale settings. To configure a trend scale: 1. In Run mode, double-click the plot's value scale to open the Trend Scale dialog box. In FactoryTalk Historian ProcessBook you can also click View > Trend Scale.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Autorange Sets the value scale using the minimum and maximum tag values between the trend start time and end time. Database Sets the value scale using the tag attribute values in the Point Database. Zero is the minimum. Zero + Span is the maximum. See the FactoryTalk Historian Server Reference Guide for more information on tag attributes. Absolute Allows you to enter a custom value for the value scale of a tag.
● ● 5 ● Visualize Data with Symbols ● ● ● Drag Zoom Drag Zoom lets you contract the time scale of a trend. 1. With the Run mode pointer, click an area in the trend at which you want a closer look. 2. Drag the pointer diagonally to create a rectangle. 3. When you release the mouse, the trend displays the data within the rectangle. Trend Zoom 2x In or Out Click the Zoom In or Out button at the bottom of a trend to reduce or expand the time range of that trend by a factor of 2.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● used as the center of the zoomed trend. See Trend Cursor (page 120), for more information on trend cursors. Expand a Trend When you double-click a trend in Run mode, the trend is redrawn so that it occupies the entire display window. Double-click again to reduce the trend to its original size. While the trend is expanded, the Drawing toolbar is disabled. If you switch to another display, the Drawing toolbar will work there.
● ● 5 ● Visualize Data with Symbols ● ● ● Add a Trend Cursor To add a trend cursor: 1. Notice whether the time scale appears at the bottom and the time stamp appears 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 . A cursor appears at the right edge of the trend.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● To remove one trend cursor but not all of them, click the trend cursor and drag it to the left or right until it moves off of the trend. Change Time Range Scroll time ranges directly on a trend by using the Step Forward or Backward buttons saved with the symbol. on the time scale. These time changes are not Use the Revert button , located next to the time scale, to return the trend to its configured settings.
● ● 5 ● Visualize Data with Symbols ● ● ● FactoryTalk Historian ProcessBook uses an algorithm to identify the peaks and valleys of data values 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 FactoryTalk Historian Archive. Unlike data from a FactoryTalk Historian Archive, data from an ODBC data set refreshes according to a configured refresh rate.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Grid Line Labels Configure the labels for the value scale using single or multiple scales. You can place these labels on either the inside or outside of the value axis: Single Scale The union of the ranges for all traces appears in the label. Multiple Scales The range for each trace in the trend appears in the label.
● ● 5 ● Visualize Data with Symbols ● ● ● Autorange scale The value scale is determined by a calculation based on minimum and maximum values in the trend. As new data are received from the server, the high and low values may change, and the scale is recalculated accordingly. For example, if the original scale ranged from 5 to 100, but the new data has a high of 103, then the new plot shows a range from 5 to 105 (the nearest number divisible by 5 and larger than the high value).
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● flat plot area. These default ranges are not applied if the trace in question is on a single scale trend that contains other visible traces that do not fall into either of the aforementioned categories. A single scale trace containing one flat trace with a constant value of 0. A single scale trend containing a flat trace and a non-flat trace. The default range for the flat trace is not applied.
● ● 5 ● Visualize Data with Symbols ● ● ● Full Timestamp Labels the start and end time limits with the date and time. When space permits, the elapsed time between these lines is also shown. 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. A full time stamp showing the plot end time is shown at the upper right.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 1. Open a trend in Run mode. 2. Hover your mouse pointer over the trend's legend. The mouse pointer changes to a hand cursor , and the trace in the trend is highlighted. 3. Click the legend item to hide or show the trace on the plot. If the trace has a regression line configured, the regression line is also hidden. When a trace is hidden: 1.
● ● 5 ● Visualize Data with Symbols ● ● ● Trace markers If there are too many values to plot based on the size of the trend, the display resolution and the density of the plotted data, actual data markers do not appear and trace markers are used instead. Trace markers are also used if the trend configuration does not specify Markers. Trace markers help you identify the legend information for each trace; they do not indicate actual plot values. Up to three trace markers are used per trace.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● If you create an ad hoc trend display and then choose to save it for future use, it appears on the Book or Outline View as subordinate to the original display. Create an Ad Hoc Trend To create an ad hoc trend for a specific tag or tags: 1. In Run mode, select the dynamic symbol(s) with the data you want to trend, 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.
● ● 5 ● Visualize Data with Symbols ● ● ● Save an ad hoc trend display as an independent display by clicking it and using the Save As command with a .pdi filename extension. If you had a display entry from a ProcessBook open when the instant trend was created, the instant trend can be saved as a subordinate of the display by using the Save command. You may save an ad hoc trend as another file type, such as a bitmap (.bmp) file, using Save As.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Convert Trends This process is used to convert VAX graphics for use with a PC. 1. On the VAX or Alpha at the DCL prompt, type $ Run PISysExe:PIDisDIFF. 2. Select option 1 List Master Display Library from the FactoryTalk Historian Display Data Interchange File Format Builder. 3. Direct the output to a file. 4. Type a file name. If your file name is more than 8 characters and a 3character extension (xxxxxxxx.
● ● 5 ● Visualize Data with Symbols ● ● ● 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 ProcessBook User Guide ● ● This case plotted 10-minute intervals of two points, A and B, for the last hour. Point A had 12 point values; Point B had 16 point values. The number of points plotted equals the number of pairs. Since A had fewer point values, the plot shows only 12 point pairs. The extra data from point B is ignored. You can configure the method by which pairing occurs. Correlation is a measure of the strength of the relationship between two variables.
● 5 ● Visualize Data with Symbols ● ● ● ● A third plot is somewhat correlated: Somewhat correlated. In the case of the third plot, a regression line with a slope (M) of 1 and an offset (B) of 0 drawn diagonally across the plot would show all points lying close to the line, some above it, some below it. This line formula is appropriate in this case because both scales are the same and the points appear to have values very close to each other.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Draw an XYPlot To draw an XYPlot: 1. In Build mode, click Draw > XYPlot, or on the Drawing toolbar, click . 2. Drag a rectangle on the display to create the boundaries. 3. Release the mouse button. The Define XYPlot dialog box opens with the General tab open. Use the tabs to: General Tab (page 137) Select tags to be plotted. Display Format Tab (page 143) Choose what to show in the Legend and on the Display.
● ● 5 ● Visualize Data with Symbols ● ● ● General Tab Plot Title - Type a plot title. Change it later if you wish. Tags in Plot - Select the tags or data sets you want to plot.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● FactoryTalk Historian calculation (page 248) (data set) ODBC (page 254) (data set) AF2 (page 269) - launches the Select AF Attribute dialog box, from which you can search an AF database for elements and attributes. Element Relative (page 240) - launches the Element Search dialog box from which you can search an AF database for elements. Your selections for tags, data sets, or attributes appear under Tags in Plot.
● ● 5 ● Visualize Data with Symbols ● ● ● 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. Interpolated 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.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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. Synchronize Synchronizes data found for X with data for Y using the timestamps for the X data. This may result in interpolated data values for Y. Match Find the event for Y corresponding to the exact time stamp as X.
● 5 ● Visualize Data with Symbols ● ● ● ● Scale Box In the Scale Box, set the scale ranges for all tags. Single Y Scale Combines all Y tag value ranges onto one scale. Multiple Y Scales Provides a separate scale for each Y tag. This choice does not change the scale min and max values, but allows them to be configured independently by selecting each Y tag and making changes. Regardless of your selection, you may independently configure the X scale tag. Max Autorange uses the maximum value plotted.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Plot Time You can set the time for each tag as it is highlighted in the Tags in Plot box. If a Y tag is selected and its selection mechanism is not Recorded or Interpolated, then these boxes are disabled. Start The start time of the selected tag. The list includes *-1h (minus one hour), *-4h, *-8h, *-1d, *-7d. The default is *-8h. End The end time of the selected tag. The list includes *, *-1h, *-4h, *8h, *-1d, *-7d.
● 5 ● Visualize Data with Symbols ● ● ● ● Display Format Tab Review the following for additional information: 143
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Legend Choose the legend elements that appear in the XYPlot. Tag Name Lists the entries in Tags in Plot. Selected by default. Srvr Name Display Select this check box to prepend the tag name with the server name. Cleared by default. Description The tag description may be displayed on the legend. Selected by default. Value The last value of the tag plotted may be displayed. For digital and string tags, a string value is shown.
● 5 ● Visualize Data with Symbols ● ● ● ● 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. Review the following for additional information: Plot Element A list of the elements you can configure, such as major and minor gridlines, background colors, text font, etc. Pens correspond to the Xand Y tags listed in the order in the Tags in Plot box on the General tab.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Element Format After you select an element in the Plot Element list, available formatting options appear. A drop-down arrow is grayed out if the option is not configurable. For example, text has color but no line style options. Line Style Determines the line style for the selected element. Line Weight Sample Determines the line weight for the selected element.
● ● 5 ● Visualize Data with Symbols ● ● ● XYPlot Statistics The XYPlot Statistics dialog box allows you to view and export raw data values and statistics, such as the mean and standard deviation of each tag’s data. You can also view these statistics in the Details (page 191) window in FactoryTalk Historian ProcessBook. To open the XYPlot Statistics dialog box: 1. In Run mode, double-click the XYPlot symbol. The Statistics dialog box appears.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 2. 148 In the Options list, select Raw Data or Statistics.
● ● 5 ● Visualize Data with Symbols ● ● ● To save this data to a text file: 1. Click Save Data to File button. The Save As dialog box appears. 2. Type a file name in the Save As dialog box.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● ,
● ● 5 ● Visualize Data with Symbols ● ● ● To calculate b, the following equation is used: Once m and b are known, the value of y that intersects the best-fit line can be calculated. Correlation Coefficient The Correlation Coefficient (r) varies between -1 and +1. Positive values indicate that as X increases, Y also increases. Negative values indicate that as X increases, Y decreases. A value of zero indicates no correlation in the way the sets of values vary.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Interpreting an XYPlot 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 FactoryTalk Historian 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.
● 5 ● Visualize Data with Symbols ● ● ● ● 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 ToolTip. You can also view plot values by double-clicking the title bar and choosing the Raw Data option, rather than the Statistics option in the Statistics dialog box.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 2. 154 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.
● ● 5 ● Visualize Data with Symbols ● ● ● Original plot Drag Zoom Completed The zoom area must be smaller than the plot area and cannot include the outer 20 percent of the plot. If the mouse is dragged past the plot boundary, the zoom rectangle stops at the border until the mouse reappears within the boundary. If the mouse is dragged off the plot symbol boundary, the zoom is canceled. To revert the changes: Click Undo to return the plot to its state directly before the zoom occurred.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Change Time Range Feature To change time range: 1. Click View > Time Range or click on the Time Range toolbar. The Change Time Range dialog box appears. 2. Type new values in the Time Span box. All tags are affected when you change the range in this dialog box. 3. Click the Revert (page 201) button to return the plot to its configured appearance. XYPlot Cursors The cursor for an XYPlot includes both a horizontal and a vertical line.
● 5 ● Visualize Data with Symbols ● ● ● ● In the XYPlot below, you can see an XYPlot cursor at the Y axis that is not yet intersecting any points on the plot. You can also see an XYPlot cursor that was dropped on a point. The X and Y values appear in small boxes outside the axes. Using the mouse, you may position and release the cursor over any pair on the XYPlot. If the cursor is dropped on an area that contains no points, the cursor snaps to the nearest pair.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● The information on the XYCursor point pair is shown in a box on each axis. If the tags are digital or string, the text value is shown in the box rather than a numeric value. Placing the mouse cursor over one of the cursor boxes shows the time of the event. Bad Status Indicators If a single point of a pair contains a bad status, an X appears on the axis of the good point at its value.
● ● 5 ● Visualize Data with Symbols ● ● ● Example 1: Comparing Values for Two FactoryTalk Historian Tags In this example we will create an XYPlot on a display in FactoryTalk Historian ProcessBook to compare values for two FactoryTalk Historian 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 appears. 2. Type a title for the plot and select 2 tags to be entered in the Tags in Plot list. 3.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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. 4. Configure the plot to show the correlation co-efficient for each of the boilers.
● ● 5 ● Visualize Data with Symbols ● ● ● Example 4: Comparing a Batch Run to a Standard An engineer wants to compare sample measurements taken from one Batch run and compare them 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.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Additional Dynamic Symbols Values A value is the reading obtained at the specified end time for a data stream. It 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 FactoryTalk Historian system that matches the event value shown. Add a Dynamic Value To add a dynamic value: 162 1. In Build mode, open a display. 2.
● ● 5 ● Visualize Data with Symbols ● ● ● When you release the mouse button, the Define Value dialog box is displayed. 4. In the Server list, select the FactoryTalk Historian server to use. If a tag name is manually entered in the Tag box, it is expected to be on the selected server. If both server and tag name are entered in the Tag box, this field is updated with the entered server name. This field has no effect for non-FactoryTalk Historian data.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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 a tag, -orClick the Tag Search arrow to see more search options: Tag Search (page 231) PI calculation (page 248) (data set) ODBC (page 254) (data set) AF2 (page 269) - launches the Select AF Attribute dialog box, from which you can search an AF database for elements and attributes.
● 5 ● Visualize Data with Symbols ● ● ● ● Custom (#,##0.00, 0%) Allows you to enter your own number format. See the Table of Format Values (page 340) for examples. 7. In the Tag list, select the location of the tag name in the value box (None, Left, Right, Top, or Bottom). 8. In the Time stamp list, select the location of the time stamp in the value box (None, Left, Right, Top, or Bottom). 9. Click OK.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● You can add a button to your drawing that: For example: display (.pdi file) on a web site. Note: You need to type the URL (Uniform Resource Locator) address that points to the location of the specific .pdi file on a web server. Executes a VBA script. Create a VBA script called AddTrend that inserts a trend on a display. Add a button to the display and configure it to use the AddTrend script (macro) as its Action. Add a Button To add a button: 1.
● ● 5 ● Visualize Data with Symbols ● ● ● If you know the file or macro name, then you can type this directly in the Action box. The name of the selected item is displayed in the Action box. 7. Click the Browse button to the right of the Working folder box. The Working folder box allows you to specify the working folder for operating system commands. It is ignored if the Action refers to a document type supported by ProcessBook.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 10. Click OK. The button is added to your display. Bars A Bar shows the current value of a tag as compared to a specified range of values. For example, a bar may be used to create the effect of a vessel filling and emptying, as the value changes. The range of values can be the maximum and minimum values specified in the point attributes, or, a bar can be designed to show a specific range of values.
● ● 5 ● Visualize Data with Symbols ● ● ● You can draw a bar using the current line style, line color, and fill attributes. 1. In Build mode, open a display. 2. On the Drawing toolbar, click , or click Draw > 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. 4. When you release the mouse button, the Define Bar dialog box appears.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 5. In the Server list, select the server to use for manually entered tags. If the server and tag name are both entered in the Tag box, this field is updated to show the new server name. This field is ignored for nonFactoryTalk Historian data. 6. In the Tag box, type the name of the tag you want to display on the bar, or 7.
● ● 5 ● Visualize Data with Symbols ● ● ● The Upper and Lower lists are renamed Right and Left when you select Horizontal orientation. The Sample area shows how the bar will look. 12. Under Scales, select Show Scales to show data values and scale tick marks on the bar symbol. When you select Scales, the Scales Inside and Number Formats are enabled. See Bar Scales (page 171) for information on working with scales. 13. Click OK to add the bar to the display.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● The default font is the font of the display. Digital tags show the value of the digital state rather than the numeric value of the state. Compatibility Bars created in FactoryTalk Historian ProcessBook 3.2 are backward compatible with previous versions of FactoryTalk Historian ProcessBook. When a FactoryTalk Historian ProcessBook 3.2 file is opened in a previous version, bar symbols appear as they did in the previous version.
● ● 5 ● Visualize Data with Symbols ● ● ● Horizontal Bar with scales (outside and inside) The lengths of major and minor tick marks is a percentage of the height or width of the bar, depending on the bar orientation, as described in the following table.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● There are major tick marks for each digital state, if the string value for the digital states fits in the width of the bar. There are no minor tick marks for digital tags. Format Appearance To change the appearance of the bar symbol, right-click the bar. Click Format Font to change the font for the bar symbol. Click Format Color to change the color of the bar symbol. The color for the tick marks and values is the same as the bar’s line color.
● 5 ● Visualize Data with Symbols ● ● ● ● is 50 or below, the symbol appears blue. Above 50, the symbol appears red. A color and sometimes a blinking attribute are assigned for data in bad status (e.g., the interface becomes disconnected). For digital point types, a different color may be assigned to each digital state. Create Dynamic Multi-State Symbols 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.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 3. In the Server list, select the server to use for entered tags. If a server and tag are both entered in the Tag box, this field is updated with the new server name. This box does not apply to non-FactoryTalk Historian data. 4.
● ● 5 ● Visualize Data with Symbols ● ● ● tags, the state name is displayed in these boxes. For other tag types, an estimate is made based on the span of values for the tag. 9. 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). 10. Repeat the 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. 11. Click OK.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● ProcessBook symbols, this symbol is not sized by dragging an area on the display. Instead, the symbol is sized to accommodate the text within. When text is added, the symbol grows in size and when text is removed the symbol size shrinks. The size of the font used also affects the size of the symbol. You can format the text symbol for font and color. Text symbols have all the functionality of other static symbols except rotating and flipping.
● ● 5 ● Visualize Data with Symbols ● ● ● 4. When you finish typing, press ESC or click outside the text block. Move a Text Block To move a text box: 1. In Build mode, open a display. 2. Click the text block you want to move, drag it to the new location, and then release the mouse button. Line Symbol Lines within a drawing can be diagonal, horizontal, or vertical. Attributes you can change include line color and whether a line is dotted or dashed, thick or thin, and with or without arrowheads.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Rectangle, Square, Arc, Ellipse, and Circle Symbol Using the drawing tools, you can create these simple shapes: rectangles, squares, arcs, ellipses, and circles. To draw a shape: 1. In Build mode, open a display. 2. On the Drawing toolbar, click appropriate tool. , , or , or click the The mouse pointer changes to a tool pointer. The appearance of the pointer indicates the type of tool you have chosen. 3.
● ● 5 ● Visualize Data with Symbols ● ● ● 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. Polygon Symbol The Polygon tool draws irregular shapes. When you select the polygon tool the mouse pointer changes to a polygon pointer. Polygons are drawn using the current color and line style attributes. To draw a polygon: 1. In Build mode, open a display. 2.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 3. Click inside the display 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 (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.
● ● 5 ● Visualize Data with Symbols ● ● ● To draw a polyline: 1. In Build mode, open a display. 2. On the Drawing toolbar, click Polyline pointer. 3. Click inside the display where you want the starting point of the first line segment. 4. Drag to the location of the second point to make the first line. 5. Each time you click the mouse button again, a new line is drawn from the location of the previously plotted point to the current location of the mouse pointer. 6.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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. A drawing is display resolution dependent, which means it may look different from one monitor to another.
● 5 ● Visualize Data with Symbols ● ● ● ● Add a Graphic To add a graphic: 1. In Build mode, open a display. 2. On the Drawing toolbar, click , or click Draw > Graphic. The mouse pointer changes to a graphic pointer. 3. Click in the display where you want to add the image and drag the pointer to form a rectangle into which the graphic will be placed. When you release the mouse button, the Define Graphic dialog box is displayed.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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. 6. 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. Under Format, select the appropriate option.
● ● 5 ● Visualize Data with Symbols ● ● ● Use a Symbol from the Symbol Library To add a symbol from the Symbol Library to a display: 1. In Build mode, open a display. 2. On the Drawing toolbar, click , or on 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.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 6. Click OK to add the symbol to your display. Symbol Library Options To configure a symbol options: 1. In the Symbol Library (page 187) dialog box, click a symbol in the selection of symbols in the right-hand side of the dialog box, and click Options. -orRight-click the symbol and click Symbol Options. The Symbol Options dialog box appears. 2. 188 Review the following for additional information: Fill Mode Controls the way the image is drawn.
● ● 5 ● Visualize Data with Symbols ● ● ● Rotation Select 90, 180, or 270 to turn the symbol by 90 degree increments. The default setting is 0. This setting returns the symbol to its original position. Transparent Check this box if you want a transparent background. Background Color If the Transparent check box is not selected, you can click the color box to change the background color.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 190
Chapter 6 Work with Symbols Details and Annotations The Details docking window is available to show data from dynamic symbols. The window is only available in Run mode and initially appears along the right side of your ProcessBook window; however, you can click and drag it anywhere inside the FactoryTalk Historian ProcessBook application. The Historian Annotations editor is located at the bottom of the Details window. Details Window To view data in the Details window, click a symbol in your display.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● By default, the window remains open when a different display symbol is selected. The Details window is hidden when you switch to Build mode. You cannot open the Details window while in Build mode.
● ● 6 ● Work with Symbols ● ● ● Option This field allows you to toggle among three different types of information about your data source. Data Shows recorded values for a selected symbol's time range. By default the table is sorted on the time stamp column in descending order. Questionable (Q) The event value is unreliable or the circumstances under which it was recorded are suspect. Annotated (A) An annotation has been made to the event to include further information or commentary.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Copy to Clipboard Allows you to copy the data table to your clipboard. You can then paste this data into another location such as a Microsoft Excel spreadsheet. Note: Use the pin icon to lock the docking window to your screen. Click the pin icon again to unpin the window and minimize it along the border of your FactoryTalk Historian ProcessBook window. When a docking window is unpinned, a button appears along the side of the screen.
● 6 ● Work with Symbols ● ● ● ● FactoryTalk Historian Annotations Maintenance Annotations allow you to associate related information (such as text comments and other binary data) with any archive value. The FactoryTalk Historian Annotation Maintenance group at the bottom of the Details window (page 191) allows you to easily annotate values on your dynamic symbols. Annotations can be added, edited or viewed, provided that: The selected data stream points to a FactoryTalk Historian tag.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● If you select Show All from the Data Source drop-down box on the Details (page 191) window, the Value and Value Type fields in the FactoryTalk Historian Annotation Maintenance group are disabled. Add Annotations To add annotations: 1. Open the Details (page 191) window. 2. In Run mode, select a dynamic symbol on your display. 3. Select the event of interest in the Data table. 4.
● 6 ● Work with Symbols ● ● ● ● The add-in can be unloaded or set not to load at startup by changing the options in the Add-in Manager (page 13) dialog box. When the Data Favorites add-in is first loaded, its window appears in the upper left corner of the FactoryTalk Historian ProcessBook application window. The window is only accessible in Build mode. If the window is closed, in Build mode, click View > Data Favorites.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Search for Data Favorites The Search panel provides controls for searching for FactoryTalk Historian tags. To search for data streams, use the Search Mask text box or click to launch the Tag Search dialog box. Tags selected using the Tag Search dialog box automatically populate the Data Favorites Search list. The Search Mask field searches for tags matching the entered string on your default FactoryTalk Historian server.
● ● 6 ● Work with Symbols ● ● ● FactoryTalk Historian ProcessBook window. When a docking window is unpinned, a button appears along the side of the screen. Hover over it to re-expand the window. Favorites Panel The Favorites panel provides controls for manipulating the list of data favorites (page 196). The Favorites list is saved per user, so when a different user opens FactoryTalk Historian ProcessBook on the same machine, their list may be different. Use Favorites To use data favorites: 1.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 3. In the Favorites list (page 199), drag and drop any listed favorite to an existing trend or XYPlot symbol, or to a blank area of a display. The data stream is permanently added once the display is saved. If the dropped selection contains multiple data streams (for example, multiple tags) and the Bar or Value symbol is selected, a symbol is created for each one, slightly offset from each other, in cascading layout.
● ● 6 ● Work with Symbols ● ● ● Drags can come from any application that supports the text clipboard format, for example, Microsoft Word or Excel. Time Range Toolbar The Time Range toolbar is used for working with dynamic symbols. This toolbar is hidden by default for new installations of FactoryTalk Historian ProcessBook 3.2 and later releases. In general, the commands on this toolbar affect only the symbols selected on the display. If no symbols are selected, all symbols are affected.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● In Run mode, click View > Revert, or click the Revert button. Change the Time Range The Time Range command lets you enter new starting and ending times for dynamic symbols. When you specify a time range for a single-time dynamic element, such as a Multi-State symbol, bar or value, only the end time is used.
● ● 6 ● Work with Symbols ● ● ● 3. Select new starting and ending times from the drop-down lists or define your own starting and ending times. Time ranges can be relative, absolute, or combined. 4. Click OK. The selected elements change to reflect the new time range. Use the Scrolling Time Range To use the scrolling time range: 1. In Run mode, select the dynamic symbol or symbols for which you want to change the time range.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Time Forward and Back Use the time backward and forward buttons to scroll the time range forward or backward. To do this: 1. Click the desired symbols with the Run Mode pointer. 2. Click the Time Forward or Time Backward button. 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.
● ● 6 ● Work with Symbols ● ● ● 1. In Build mode, open a display. 2. Click a symbol in your display. Small squares appear around the bounding rectangle of the symbol. 3. If you want to move the symbol, drag the symbol to the desired location within your display. Press the Tab key to toggle among different symbols in your display once a symbol is selected. When you press the Tab key you deselect the current object and select the next object in the tabbing order.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 3. To select several symbols at the same time, click near a symbol, and then drag to create a rectangle that includes all the symbols you want to select. To select symbols that are stacked on top of each other, click the top symbol. Selection handles appear. Continue clicking the top symbol to select symbols located under the top symbol. Click the symbols you want to change or move. The selected symbols display handles.
● ● 6 ● Work with Symbols ● ● ● Flip a Symbol You can create a mirror image of a symbol by flipping it. You cannot flip text, graphics, or OLE objects. 1. Select the symbol you want to flip. 2. Click Arrange > Flip > Horizontal to flip the symbol from right to left or Vertical to flip the symbol from top to bottom. Delete a Symbol When you want to delete a drawing symbol or group of symbols: 1. Select a symbol or multiple symbols that you want to delete. 2. Press DELETE, or click Edit > Clear.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Using the stacking commands, you can move a symbol forward or backward within the stack (page 208). Depending on the number of objects between top and bottom, you may need to repeat a stacking command several times (page 95) to move the symbol to the desired location within the stack. Move a Symbol Forward or Backward in the Stack To move a symbol in the stack: 208 1. Select the symbol you want to order. 2.
● ● 6 ● Work with Symbols ● ● ● Click Send to Back to move it to the bottom of the stack (below everything). Align Multiple Symbols You can align drawing symbols (page 80) 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 value symbols are aligned, the text justification for each matches the alignment rule: left, center, or right.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 3. Click the alignment options you want. All the selected symbols are aligned to the symbol you first selected, along the axis you specify. Group, Ungroup, or Regroup 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.
● ● 6 ● Work with Symbols ● ● ● Group Ungroup Regroup The symbols combine into one composite symbol with selection handles around the entire group. The group is disassembled into its component symbols. You do not need to re-select all the components to regroup a previously grouped set of symbols. This command is only enabled when it applies. Connect Symbols Connector Symbol You can connect two symbols to each other using the Connector symbol.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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 is 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.
● ● 6 ● Work with Symbols ● ● ● Connection Points Connection points on each symbol define where a Connector may connect. Connection Points are visible in Build mode only and appear on symbols as small x marks. When you select one with your cursor, it changes to an x within a bounding circle. ProcessBook symbols are originally built without Connection Points. A Connection Point is created automatically when a Connector is dragged into a symbol.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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. Add Connection Points If you want an additional Connection Point, you can add it as follows: 1. In Build mode, select the symbol. 2. Click Edit > Connection Points > Add. A point appears at the upper left of the symbol. 3.
● 6 ● Work with Symbols ● ● ● ● 1. In Build mode, click a connection point. 2. Click Edit > Connection Points > Move. The Connection Point Placement dialog box appears, where you can edit the width and height ratios in comparison to the X and Y axes of the symbol. Determine the Identifying Number of a Connection Point In Build mode, if you place your mouse over a Connection Point, a ToolTip shows you the Connection Point number. The following illustration refers to Connection Point 2 on Rectangle 1.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● If you are using a symbol from the Symbol Library, the Connection Point is named , where TBSymbolx represents the specific name of the symbol. Connectors Dialog Box 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 autoavoidance capability of the Connector. Alternatively, you can use the Connectors dialog box to rearrange connections.
● ● 6 ● Work with Symbols ● ● ● 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.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Configure the Flow Tab To configure the Flow tab: 218 1. In Build mode, open the Connectors dialog box (page 216). The Flow tab is in focus. 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.
● 6 ● Work with Symbols ● ● ● ● Connectors Dialog Box, Attachments Tab For very complex displays, it may be helpful to attach or arrange Connector Attachments through the Connectors dialog box, Attachments tab. The Attachments tab does not include Connectors or symbols attached to other symbols. If you do not check the Enable Connector Attachments in the Display Properties dialog box, discussed above, you can still attach symbols to Connectors by using this dialog box.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Configure the Attachments Tab To configure the Attachments tab: 1. In Build mode, create a connector (page 211). Notice its number in the tooltip. 2. Create the auxiliary symbol to be added to the Connector. 3. Open the Connectors dialog box (page 216), and select the Attachments tab. 4. Choose a connector from the numbered list in the drop-down box at the top. 5.
● ● 6 ● Work with Symbols ● ● ● Attach a Symbol as an Adjunct to a Connector Sometimes it is desirable to attach a symbol, such as a flow meter 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. Click Edit > Display to open the Display Properties dialog box. 2.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 1. Select at least two symbols. This enables the Symbol Attachments icon 2. Click . , or click Edit > Symbol Attachments, or On the right-click menu, click Symbol Attachments. The Symbol Attachments dialog box appears. The symbols you selected appear in the Attachments dialog box as possible master or subordinate symbols. 3. 222 Select the Master Symbol. As you change the Master, the title of the dialog box changes also.
● ● 6 ● Work with Symbols ● ● ● 4. Place a check mark for the subordinate symbol or symbols and click OK. 5. Repeat the process for each Master symbol. The Detach All bar at the top can be used to remove all attachments from the currently selected symbol in the Master box. To detach only one attachment, clear its check box. 6. Click OK. When you move a Master symbol, any subordinates move with it. There are two other routes to the Symbol Attachments dialog box.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Reroute a Connector Path When you move a symbol, its Connectors shift automatically to stay connected to the moved symbol and 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. If you select specific Connectors and click Reroute, only those Connectors are rerouted.
● ● 6 ● Work with Symbols ● ● ● Item Definition Use the Item Definition button in either Build or Run mode when you want to see what tags and formatting options were used in any symbol that uses a dialog box for basic configuration. It is the same as double-clicking on the item with the Build mode pointer. If the symbol does not have a definition dialog box, the button is dimmed. You can change the selections and save the new definition.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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 normally. The Status icon is a green circle when there are no errors. It is a blue circle containing a question mark (?) if the display shows questionable data or a yellow arrow for substituted data.
● ● 6 ● Work with Symbols ● ● ● For troubleshooting purposes, click Message Log to view the SDK Log file. You can save this report as a .csv file by using Save to File. The status bar can be displayed or hidden from the View Status Bar item on the View menu. Status Flags for Data In addition to the Error indicator shown in the Status Bar (page 226), FactoryTalk Historian ProcessBook has three types of flags to indicate that the data is valid but additional information is available.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● If you clear the Show Value Attributes check box in your Start Preferences, you do not see these icons. You might disable the icons to improve ProcessBook performance if you have very high speed sub-second data.
Chapter 7 Data Streams A data stream is any set of data that you can visualize (page 103). This data includes, and is not limited to, FactoryTalk Historian tags, AF attributes, data sets, and ODBC queries. About FactoryTalk Historian Data retrieves and helps you visualize data from your FactoryTalk Historian System infrastructure and other systems that support different business functions and provide access to diverse information.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● AF attributes AF Attributes represent data that is associated with an element. They can contain configuration information for the element, or measured or calculated process data that provides the information necessary for getting and setting its value to and from a data stream. Conceptually, an AF Attribute replaces the FactoryTalk Historian Aliases and FactoryTalk Historian Properties formerly used in the FactoryTalk Historian module Database.
● ● 7 ● Data Streams ● ● ● Contextual data Contextual data is a method of associating FactoryTalk Historian points and their properties with their business use, location, service or role. By configuring this information to reflect the correct structure of the information, the content creator can make data and its presentation more logical and accessible to the user community. A FactoryTalk Historian point tag name is an example of contextual data.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● On the Standard toolbar, click , or click the Tag Search button in any of the following dialog box boxes: Define Value Define Bar Define XYPlot Multi-State Symbol Define Trend The Tag Search dialog box provides three types of searches: 232 Basic Search allows you to create a tag mask by specifying FactoryTalk Historian point attributes. The mask is used to find a list of tags on the server with matching attributes.
● 7 ● Data Streams ● ● ● ● Alias Search provides a logical tree view of a FactoryTalk Historian server through the FactoryTalk Historian module Database, which you can use to select tags by their descriptive aliases. To search for tags: 1. Click a tab to choose a Basic, Advanced or Alias search. 2. Type the required search criteria and click Search. Use '*' or '?' as wildcard characters to search for tag names and attributes.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● You can also click Favorites to access previous searches. 3. Tags returned from a search appear listed in a search results panel. Select the desired tags in the results panel, and click OK. 4. Click column headers in the search results panel to sort the results. Ctrl-click or Shift-click to select multiple tags.
● ● 7 ● Data Streams ● ● ● select each tag from the drop-down list or use the up and down arrows on your keyboard to scroll through the tags. The Point Properties dialog box contains the Categorized tab and the Alphabetic tab. The Categorized tab displays the attributes categorically. The following categories are always displayed: Archive Classic Display Overview Security System These categories include all the attributes from the Base PointClass.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Point Type How It Is Used PB Support Int16 FactoryTalk Historian ProcessBook supports these as integers. Used for points whose values are 15-bit unsigned integers (0 to 32767). Supported Int32 Negative integer values are supported. Used for points whose values are 32-bit signed integers (- 2147450880 to 2147483647). FactoryTalk Historian reserves some values.
● ● 7 ● Data Streams ● ● ● Data from a FactoryTalk Historian System Most displays include a number of FactoryTalk Historian tags from one or more FactoryTalk Historian systems. The connection to a FactoryTalk Historian server allows you to view process data at the current time or at other, discrete points in time. Displays update dynamically whenever values on the FactoryTalk Historian server change.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Displays are updated whenever values change. Every five seconds, FactoryTalk Historian ProcessBook displays any new values for tags in open displays from each FactoryTalk Historian server. You can modify the update rate. See Procbook.ini (page 315) for more details. For trends, new values are added to the trend traces. This update by exception algorithm has two benefits: Values that do not change are not sent over the network at every update.
● ● 7 ● Data Streams ● ● ● In order to convert a legacy Module Relative Display to an Element Relative Display you must first migrate modules in the Module Database to elements in the AF database. MDB to AF migration is handled upon upgrade to FactoryTalk Historian SE 2.3. See the FactoryTalk Historian MDB to AF Transition Guide for further details. Connect to an AF Database Use the Select Database dialog box to find and connect to AF databases. 1. Click File > PI systems.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 3. Once you select an AF System, search for an AF database using the Databases search box. Select a database and click OK. The AF database you select is used by the Element Relative Display (page 238) add-in, where you can populate symbols with elements from the AF database you have selected. Element Search To search for AF Elements: 240 1. Connect to an AF System. 2. Specify search criteria for the elements. 3. View the Search Results.
● ● 7 ● Data Streams ● ● ● Add Element Relative Data to a Dynamic Symbol Use the Select Attributes dialog box to add AF Elements and Attributes as data streams to dynamic symbols (page 68) on a display. 1. In Build mode, double-click a dynamic symbol. 2. In the dialog box, click the arrow next to the Tag Search button. A drop-down menu appears. If you plan to work with an element that does not have multiple contexts you can instead click AF2.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 3. Click Element Relative. The Select Attributes dialog box appears. The active elements in the Elements of Interest pane on the Element Relative Display docking window (page 244) appear in the top pane of this dialog box under Current Element of Interest. If an element has attributes, those attributes are available to add to a dynamic symbol.
● ● 7 ● Data Streams ● ● ● UOM - allows you to select a unit of measure for a given attribute. 6. [Optional] Click Add Element Name to add the element name of the current context to the symbol. Select the Use Full Path check box to show the full path of the current context instead of just the element name. 7. Click OK to add the selected attribute(s) to your dynamic symbol. Context Path A context path relates an AF Attribute to a parent element within an AF database.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● How to Change Element Context You can dynamically change the context for the selected element on your symbols by clicking an element name in the Elements of Interest pane on the Element Relative Display window (page 244). The attribute data that appears on your dynamic symbol corresponds to the active element you choose.
● ● 7 ● Data Streams ● ● ● 1. Click View > Element Relative Display. The Element Relative Display window appears. 2. In the Search Mask text box enter a search query, and click the green arrow, or 1. Click to launch the Element Search dialog box, where you can use advanced search fields. 2. Type your search query and click the Search button. The Search results list is populated with your results. 3. Click any element(s) from the Search results list.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 4. 3. 4. Click OK. Any new items are added to the Elements of Interest list in the Element Relative Display docking window. Search results appear in the Elements of Interest pane. 1. Click a column heading to sort results by that heading. 2. Use the Filter text box to filter out unwanted entries. Access previously used filter expressions by clicking the small triangle at the end of the text box. 3.
● 7 ● Data Streams ● ● ● ● create an independent display (a .PDI file), the data set is defined only for that display. Trends including data sets can be manipulated, saved, moved, and copied in the same fashion as other trends. Whenever a display is updated, if a trace or value using a data set is configured using relative times, then the trace or value is updated. No updates occur if the data set is configured using absolute times.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● PI calculation (page 248) data sets (including FactoryTalk Historian expression and FactoryTalk Historian Summary data sets) from FactoryTalk Historian Universal Data Server equations. ODBC (page 254) (Open Database Connectivity) data sets obtained from a relational database.
● 7 ● Data Streams ● ● ● ● FactoryTalk Historian Summary Data Sets FactoryTalk Historian Summary Data Sets enable you to use predetermined functions to retrieve aggregated FactoryTalk Historian data for a tag. The AVG function calculates the average of the tag values for each interval. The Count function is the sum of event count over the time range when calculation basis is event-weighted, sum of event time duration over the time range when calculation basis is timeweighted.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● These functions are fully described in the Performance Equations chapter of the FactoryTalk Historian Server Applications User Guide. FactoryTalk Historian Expression Data Sets FactoryTalk Historian Expression Data Sets enable you to create your own function or expression in FactoryTalk Historian Performance Equation syntax.
● 7 ● Data Streams ● ● ● ● 2. Click New > PI calculation. The PI Calculation Data dialog box appears.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 3. 4. 252 Review the following for additional information: PI Server Select a FactoryTalk Historian server. Name Enter a name for your data set. The name must be unique for the current .piw or .pdi file. PI tag or Expression Enter a tag name or a FactoryTalk Historian expression. Use the Tag Search (page 231) button to search for FactoryTalk Historian tags.
● 7 ● Data Streams ● ● ● ● The sync time must be a valid FactoryTalk Historian Time. Your new data set appears in the Data Sets dialog box. Intervals and Time Value 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.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● moving average to show a smoothed version of the same curve. The moving average is built from the source tag using a data set that recalculates an average point value over recurring intervals. To create a moving average in a trend: 1. In Build mode, double-click the trend to open the Define Trend dialog box. 2. Click the Tag Search arrow and choose FactoryTalk Historian calculation to create a data set based on a tag. 3.
● ● 7 ● Data Streams ● ● ● column of the results for a display. For example, in a trend, each column in the data set that you select appears as a different trace. A SQL query statement may be written so that it executes based on other data in a display, such as FactoryTalk Historian tags or the start or end time. This is done using SQL placeholders (parameters); a tag, time, or text string is then substituted for each placeholder at run time. For more information on ODBC, see ODBC (page 271).
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 4. Under Description, type a description if you like. This text is displayed in the Description legend for the trace, if configured. 5. Under Refresh Interval, type the interval at which you want to automatically update the data set, between 0 and 999. The default for the Refresh Interval is zero minutes. This means the data set only refreshes when the trace is first drawn or when you click the Revert Time Ranges button on the standard toolbar.
● ● 7 ● Data Streams ● ● ● defined in the order in which they are encountered in the SQL statement. 13. Click Placeholders to check the syntax of the query. If the syntax is not valid, the invalid query message is displayed. 14. Click OK. Custom Data Sets A custom data set is one provided through a VBA add-in to FactoryTalk Historian ProcessBook. It is a COM object or a .NET object with a COM wrapper that acts as an interface between FactoryTalk Historian ProcessBook and the custom data provider.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● The standard SQL placeholder character is (?). Placeholders are numbered in their order of appearance, from left to right, in the query statement. For example, the following query statement has two placeholders, one for a text string for a sample ID and the other for a sample time.
● ● 7 ● Data Streams ● ● ● symbol without affecting the placeholders defined for any other symbol using that data set. Add or Edit Placeholders To add or edit placeholders: 1. To open the Placeholders dialog box, click Placeholders in the ODBC Data Sets (page 255) dialog box, or click the Custom Placeholders button on a symbol definition dialog box. In this dialog box, you can rename placeholders, change their type or specify values.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 2. Under Placeholder Name, select the parameter you want to configure. The parameters are in the same order as found in the data set query. The list is limited to the number of parameters found in the query. 3. Under Placeholder Properties, select the Type for the selected parameter. There are four possible types: Text, FactoryTalk Historian tag, Start Time, and End Time.
● ● 7 ● Data Streams ● ● ● 5. Click Set. 6. To configure another parameter, select it and repeat the previous steps. 7. Click OK. 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. FactoryTalk Historian calculation data sets and ODBC data sets are established for an entire ProcessBook (or an independent display).
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Add 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 is 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 displays the discontinuity.
● ● 7 ● Data Streams ● ● ● 4. Click the Tag Search arrow, and then click PI calculation. The PI Calculation Data dialog box appears. 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 select ODBC. 5. Under Saved Data Sets, click the data set you want to add to the trend. 6. Under Data Set Columns, select a column(s) to be plotted in the trend (use the SHIFT or CTRL keys to select more than one column). 7.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● The selected data set/column(s) is now listed under Tags in Plot in the Define Trend dialog box. 8. Select tags as desired and format the trend. If you wish to see or edit the definitions of placeholders, click Custom Placeholders in the Define Trend dialog box. 9. Click OK. Data is displayed on the trend.
● ● 7 ● Data Streams ● ● ● axis with changing FactoryTalk Historian exception data points until the refresh interval expires and new data are received from the data set. If a data set has a FactoryTalk Historian tag placeholder, then the data set is refreshed every time a new value is received for the FactoryTalk Historian tag placeholder. Add 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.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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 because it would be a security risk to store a password locally. If your data source is configured to use Windows Authentication, then your network credentials are used to gain access to the data and you are unlikely to be prompted.
● ● 7 ● Data Streams ● ● ● 3. Click File > Return to ProcBook when you are finished. 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 type the query in the query text box. You can also copy and paste a query from another query building tool. 6.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Delete a Data Set Before you can remove a data set from the FactoryTalk Historian ProcessBook list, you must remove it from any symbols that use it. 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. Click Tools > Data Sets.
● ● 7 ● Data Streams ● ● ● 3. From the Tools menu, select Data Sets. The Data Sets (page 246) dialog box appears. 4. Under Data Sets, click the data set you want to copy, and then click Copy. The Copy Data Sets dialog box appears. 5. Under To Open Workbook, select the correct target, and then click OK. Loading Custom Data Sets 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.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● To select an AF Attribute: 270 1. Connect to an AF database. 2. Select an AF Element. 3. Select an AF Attribute from the drop down list or click Search to search in the AF database. 4. Select a unit of measure in which to display the attribute.
● ● 7 ● Data Streams ● ● ● Configure the AF2.x DataSet To configure an AF dataset: 1. Click Tools > Datasets to open the Data Sets dialog box. 2. Select AF2 dataset from the list. 3. Click Edit to open the AF 2.x DataSet Configuration dialog box. 4. Type a Refresh Interval. 5. Select Do not retrieve AF Data in Build Mode to prevent data refresh while in build mode. Retrieving data might have a negative impact on performance while you are configuring a FactoryTalk Historian ProcessBook symbol.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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: A SQL Server database, the server on which it resides, and the network protocol used to access that server. An Excel spreadsheet on a file server. A directory containing a set of dBASE files you want to access.
● ● 7 ● Data Streams ● ● ● Using ODBC requires that you install the Microsoft ODBC Driver Manager and drivers (most operating systems already have the Driver Manager and some standard drivers installed). You must then configure data sources (page 275) for ProcessBook and define individual queries, called data sets. ODBC Data Source Administrator To access ODBC data source administrative tools from the Windows Start menu: 1.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 3. Click Setup. The Microsoft ODBC Data Source Administrator dialog box appears. Prepare for 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. Open the ODBC Data Source Administrator (page 273) and click the Drivers tab to view the ODBC drivers that are already installed on your system.
● ● 7 ● Data Streams ● ● ● Configure the ODBC Data Source Once any necessary ODBC drivers are installed, you need to configure the ODBC data sources available to the computer. 1. Open the ODBC Data Source Administrator (page 273) dialog box. 2. In the User DSN tab, under User Data Sources, click the name of the ODBC data source you plan to use and then click Configure. The Setup dialog box for the data source you selected appears. 3. Add the ODBC data source.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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.
● ● 7 ● Data Streams ● ● ● 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.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Initiate Call Tracing To initiate call tracing: 1. Click Tools > Data Sets. The Data Sets dialog box 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.
● ● 7 ● Data Streams ● ● ● 1. Open the ODBC Data Source Administrator (page 273) dialog box. 2. In the User DSN tab, under User Data Sources, click the name of the ODBC data source you want to delete and then click Remove. A confirmation message is displayed. 3. Click Yes to delete the data source. 4. Click OK to close the Microsoft ODBC Data Source Administrator dialog box, then close the ODBC Data dialog box. The data source is removed from under Data Sets in the Data Sets dialog box.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 280
Chapter 8 Embedding and Linking FactoryTalk Historian ProcessBook provides the capability to use OLE linking and embedding (page 283). 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 is an OLE Automation server. Programmers can write scripts that manipulate and retrieve FactoryTalk Historian data.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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.
● 8 ● Embedding and Linking ● ● ● ● For more information on how to write Visual Basic scripts for use with FactoryTalk Historian ProcessBook, click Help > FactoryTalk Historian ProcessBook VBA Language Reference. Object Linking and Embedding An object application may be connected to a container application by either embedding (page 283) or linking (page 283). The distinctions between the two have to do with the ways in which the object is stored and updated.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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.
● ● 8 ● Embedding and Linking ● ● ● 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 require additional VBA code before they function correctly. Add a Control To add a control: 1. In Build mode, open a display. 2.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● In Run mode, a user could change the month and date. A programmer could incorporate the calendar into scripts associated with the display. 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.
● ● 8 ● Embedding and Linking ● ● ● Icons vs. Graphics You may choose to have embedded or linked objects displayed either as graphic representations or as icons. An icon uses the minimum area of your display and would be appropriate for reference material, such as definitions. The icon for the source application appears unless you select another one. Choosing an icon to represent a linked file results in a slightly smaller ProcessBook file size.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● You must be in Build mode in order to insert a new object. Click Insert > Object to launch the Insert Object dialog box. Embed an Existing File in a Display To embed an existing file in a display: 1. Open the display. 2. In Build mode, click Insert > Object. The Insert Object dialog box appears. 3. Select Create from File. 4. Click Browse. The Browse dialog box appears. 5. Browse and locate the file you want to embed and then click Open.
● ● 8 ● Embedding and Linking ● ● ● 7. Click OK. The object appears on your display. Embed a New File in a Display To embed a new file in a display: 1. Open the display. 2. In Build mode, click Insert > Object. The Insert Object dialog box appears. 3. Leave Create New selected (the default position). 4. Under Object Type, click the type of object you want to embed. If you want to display an icon rather than a graphic, select the Display as Icon check box. 5. Click OK.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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. Link a File to a Display You can create a link from a ProcessBook display to an existing file. The linked object appears in a rectangle within your display. It is updated whenever the source file changes, unless you change the link setting from Automatic to Manual.
● ● 8 ● Embedding and Linking ● ● ● 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 changes. You can change this updating frequency to manual through the Links dialog box. Manual updates are also initiated through this dialog box. Edit, Update, or Break Links If you have created an automatic link to another object, it updates whenever you open the entry.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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.
● 8 ● Embedding and Linking ● ● ● ● Commands That Ignore OLE Objects The following commands ignore OLE objects: Command Location Action Select All Edit menu Does not include OLE objects. Zoom/Fit All Symbols View menu Ignores OLE objects. Align Arrange menu Does not work because you cannot select more than one OLE object at a time. Forward Arrange menu Does not work because you cannot select more than one OLE object at a time.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Edit 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 opens, displays its menus and commands through the ProcessBook menu bar, and permits you to edit the object in place within FactoryTalk Historian ProcessBook. Other source applications open a new window for editing when you double-click the OLE object.
● 8 ● Embedding and Linking ● ● ● ● Edit Contents of OLE Objects To edit contents of OLE objects: 1. Open the display. 2. In Build mode, double-click the OLE object you want to edit. 3. Review the following for additional information: If Then The source application permits in-place activation, menus and commands for the source application appear on your screen, temporarily replacing ProcessBook menus. Edit the object. Save it if it is a linked file.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● You may select to display 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 below. If you have made the graphic representation other than a square shape, the icon may be distorted. Convert Objects to Icons To convert objects to icons: 1. Open the display. 2.
● ● 8 ● Embedding and Linking ● ● ● 6. To select the icon to use, click Change Icon. The Change Icon dialog box appears. 7. Review the following for additional information: 8. If you want to return to the default icon, then select Default. If you want to select a new icon from the available group, select From File and choose a new icon. If you want to select a new file to provide the icon, click Browse.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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. Embed a New Display in Another OLE Application To embed a new display in another OLE application: 1. Open the container application.
● ● 8 ● Embedding and Linking ● ● ● When you activate the dragged contents, the entire original display is drawn, regardless of which objects were dragged to the new container. Link a ProcessBook to Another Application 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. Click Insert > Object. The Object dialog box appears. 3. Click the Create from File tab. 4.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Historian ProcessBook. To do this, use the Insert Object command in the second application and insert an object of type PI Display Document.
Chapter 9 Visual Basic for Applications in FactoryTalk Historian ProcessBook Rockwell Automation licenses 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.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Design Mode Stops any scripts that may be running or may start running. Useful for debugging. 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.
● ● 9 ● Visual Basic for Applications in FactoryTalk Historian ProcessBook ● ● ● Update a FactoryTalk Historian ProcessBook display by typing new tag names into a spreadsheet. Although Automation scripts are not required to use a dialect of Visual Basic, at the present time, that is the most common approach. Automation Vocabulary Understanding OLE automation requires some technical vocabulary. Terms used in the FactoryTalk Historian ProcessBook VBA Language Reference Guide are defined below.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 304
Chapter 10 Installation A self-extracting zip file is supplied as the distribution kit for FactoryTalk Historian ProcessBook. To install FactoryTalk Historian ProcessBook: 1. Log on to a user's PC with an account that has administrative privileges. 2. Unzip the file into a temporary directory. 3. Run Setup.exe from the temp directory and follow the directions displayed in the installation wizard. After the installation, you will be prompted to restart your computer.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● The default install location for Rockwell Software 32-bit applications: C:\Program Files (x86). Registry settings are located under the Wow6432Node branch. For example references to: ...\SOFTWARE\PISystem\PI - ProcessBook\... will be found under: ...\SOFTWARE\Wow6432Node\PISystem\PI ProcessBook\...
● ● 10 ● Installation ● ● ● If you have FactoryTalk Historian BatchView installed on your system, Setup installs a FactoryTalk Historian ProcessBook Batch group symbol that is compatible with the current version of FactoryTalk Historian ProcessBook. You can also install FactoryTalk Historian BatchView after installing FactoryTalk Historian ProcessBook, and the correct Batch Trend symbol is loaded. FactoryTalk Historian sqc is installed with FactoryTalk Historian ProcessBook.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Setup also installs online help files and Release Notes. See the Release Notes for a complete list of files. You can look at SetupProcessBook.log in the Dat directory of your FactoryTalk Historian ProcessBook installation to see a list of files installed by FactoryTalk Historian ProcessBook's Setup on your computer. SetupProcessBook.log does not show the files installed by VBA.
Chapter 11 System Administrator Notes High Availability Configuration Settings On workstations where FactoryTalk Historian ProcessBook is used to write data or access data that is not available on secondary members of a collective, a configuration setting has been provided that modifies the default connection preference. By editing the procbook.ini file you can configure the preference for a particular collective.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● primary server continue to function. If the use of ProcessBook on a workstation requires access to the primary, then specifying RequirePrimary forces the application to only connect to a primary member and fail when such a connection cannot be completed.
● 11 ● System Administrator Notes ● ● ● ● Dynamic symbols on the display are presented in the same manner as any other symbol attached to a disconnected server, though there is no recovery unless the primary server comes back online. If this occurs after the display is already open, ProcessBook detects the loss of connection, as described previously, and tries to reconnect to the server.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● does not support FactoryTalk Historian AF data and is discontinued in FactoryTalk Historian ProcessBook 3.2. Installing FactoryTalk Historian ProcessBook 3.2 uninstalls MRD add-in. You must use an earlier release of FactoryTalk Historian ProcessBook or download and install the MRD add-in from the Technical Support Web site to view the following: MDB data from earlier versions of FactoryTalk Historian server. Batch displays. MRD displays.
● ● 11 ● System Administrator Notes ● ● ● After you upgrade a FactoryTalk Historian ProcessBook display from MRD to ERD, the display will only show data in FactoryTalk Historian ProcessBook 3.2 or later. Playback Toolbar Setting Defaults The values for Scroll Period, Display Range, and Speed default to the settings they had when you closed FactoryTalk Historian ProcessBook. Default settings do not change from display to display.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Read/Write Data Access for Users Although most data features in FactoryTalk Historian ProcessBook require read-only access (writing annotations (page 195) from the Details add-in being one notable exception), 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 FactoryTalk Historian server node.
● ● 11 ● System Administrator Notes ● ● ● 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. Machine Address Because FactoryTalk Historian ProcessBook is a client/server application, the communication setup is essential.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● ProcessBook Preferences dialog box for the first time. The values in C:\Documents and Settings\\Application Data\PISystem\PIProcessBook\language override the values in PIPC\DAT\ unless an administrator creates Registry entries to override user-specific settings. The following is a list and brief explanation of the most significant sections and keywords in the PROCBOOK.INI file.
● ● 11 ● System Administrator Notes ● ● ● International Date Format Specifies date/time format. 1=Windows format. 0=FactoryTalk Historian Time format. PromptForConversion 1=prompt user when opening a file created with an earlier version, asking whether or not to convert to new format. 0=do not prompt (default). MaxUndoStackSize Maximum number of elements in the Undo stack (default is 200) Build/Run Scroll Mode For each mode, set the scrolling: 0=off. 1=on. 2=automatic.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● MacroProtectionLevel Specifies how ProcessBook handles macros per display. Possible settings: Level 0 No macro protection (default if entry is not defined). Level 1 Prompts user to disable macros when VBA code is opened. Level 2 Prompts user as in Level 1, except when macros are disabled, VBA code is opened and locked in design mode.
● ● 11 ● System Administrator Notes ● ● ● URL Home Specifies the website navigated to when a user clicks the ProcessBook icon in the Help\About box. MaxBitmapMB Maximum file size (in megabytes) that bitmap images may be loaded in displays. If embedded bitmaps are larger than the specified maximum, ProcessBook scales the images down to lower resolutions. The current default maximum is 16.0 MB. ServerTimeZone 1=Show times and time spans based on the time zone of the server where the tags originate.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● PB2TraceCompatibility Indicates whether all snapshot values are retained for trend traces or discarded when a new archive event is received on updating trends. 1 = Yes. Do not replace snapshot values when a new archive event is received. This setting may result in a jagged trace that gets smoothed when the trend is reverted. 0 = No.
● ● 11 ● System Administrator Notes ● ● ● International Date Format=1 MaxUndoStackSize=20 Build Scroll Mode=1 Run Scroll Mode=1 GridSize=12 FileAccessTimeout=5 FileAccessInterval=1 COMTimeOut=30 RunSelectorColor=0,0,0 MacroProtectionLevel=0 TBFilePath= UserDefaultTB= PBDefaultTB= References= URL Home="http://www.rockwellautomation.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● PitchAndFamily=0 FaceName=Arial The FaceName should be a True-Type font so that it can be rotated. Conversion Section The Conversion section of the .INI file identifies resources for importing other file formats and resembles this example: [Conversion] Import0 = PIDisDIFF Files, impd32.dll, dat Import1 = PI-Graphics Files, impp32.dll, dat ImportN identifies the file types used when converting VAX-formatted trends or graphics.
● 11 ● System Administrator Notes ● ● ● ● Trend Definition Section Trend initializations. Possible entries: 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 Background Null 1=sets to have no background color. 0=disable feature 0=have background color specified under Elements.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Element These 16 entries are the main drawn properties of trends. For each of 16 trend elements, you can change the color and shape properties. This is the entry format: ElementX = Name, Color, LineStyle, MarkerStyle Color Decimal conversion of the color to draw the element. ex. Pen 1 has a color of 65280, this converts to 0x00ff00 in hex -->00ff00 = 0 red, 255 green, 0 blue ==> Green LineStyle Line style of the element.
● 11 ● System Administrator Notes ● ● ● ● Trend Definition Example [Trend Definition] Autoscale=1 Value=1 Description=0 Markers=0 Plot Title=1 Grids=1 Scale Inside Axis=1 Tag Name=1 Server Name=0 Eng Units=1 Background Null=0 Start Time=*-8 Hour End Time=* MarkerWarning=1 UpdateTimeRange=604800 ;MaxValues=2000 RequeryThresholdFactor=6 RequeryHoldoffTimeout=300000 Max Traces=50 Element1=Horz. Axis,0,0,-1 Element2=Background,8421504,-1,-1 Element3=Horz. Major Grid,0,0,-1 Element4=Horz.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Colors Section Defines the 16 colors in the ProcessBook palette.
● ● 11 ● System Administrator Notes ● ● ● ThumbScrollNonlinearity Sets the factor by which clicking and holding the thumbwheel of the scrollbar will increase the speed that the thumbwheel moves Example: [Time Range Scroll] TimeRangeMin=*-100d TimeRangeMax=*+10d PageScrollNonlinearity=20 LineScrollNonlinearity=100 ThumbScrollNonlinearity=20 ProcessBook Level Section Font settings for book levels in outline view. Possible entries: Underline 1=underline. 0=no underline.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Italic=0 PitchAndFamily=34 Display Colors Section Possible entries: DisplayBackgroundColor Red, Green, Blue, values can range from 0 to 255, sets the background color for any newly created display. SymbolFillColor Red, Green, Blue, values can range from 0 to 255, sets the fill color for newly created symbols. SymbolLineColor Red, Green, Blue, values can range from 0 to 255, sets the line or text color for newly created symbols.
● 11 ● System Administrator Notes ● ● ● ● Background Null 1=sets to have no background color. 0=have background color specified under Elements. Start Time/End Time Default start and end time range (must be a valid FactoryTalk Historian string). UpdateTimeRange Maximum time period, in seconds, to support updates. The default is 604,800 seconds, equal to 7 days. If the time range is greater than this value, the trend does not update automatically even when the end time is '*'.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Element These 17 entries are the main drawn properties of XYPlots. For each of 17 XYPlot elements, you can change the color and shape properties. This is the entry format: 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.
● ● 11 ● System Administrator Notes ● ● ● MacroProtectionLevel may be set in the [STARTUP] section of Procbook.ini at one of the following levels: Value Description 0 Display is opened with macros enabled. 1 User is prompted when display is opened; project is set to design mode if user selects . 2 User is prompted when display is opened; project is opened with macros disabled if user selects .
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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.
● 11 ● System Administrator Notes ● ● ● ● 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.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 3 = dash dot 4 = dash dot dot 5 = suppress Font Section 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 These default values are based on resolutions for VT340 terminals. If you are using a terminal other than these, appearances may be different.
● 11 ● System Administrator Notes ● ● ● ● Marker Section The Marker section of the .
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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. SETUPProcessBook.
Chapter 12 Supplemental Information FactoryTalk Historian Time FactoryTalk Historian Time abbreviations and FactoryTalk Historian Time expressions allow you to specify times and time ranges for data using constants, variables, and short expressions. FactoryTalk Historian Time Abbreviations An interval is a unit of time that can be used in time entries. Intervals that support fractional values are listed below.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● PI Times can also be expressed using certain constants: Constant Result * The current time. Today or t 12:00 am of the current day. Yesterday or y 12:00 am of the previous day. Sunday or sun 00:00:00 (midnight) on the most recent past Sunday (in reference to the Historian Server). FactoryTalk Historian Time Expressions FactoryTalk Historian allows three types of time expressions: relative time, combined time, and absolute time.
● ● 12 ● Supplemental Information ● ● ● Use absolute or combined time expressions. Avoid using relative time expressions. Multiple relative time expressions in a time range may cause an incorrect start time or an error message, depending on the context of the expression. Relative and combined time expressions contain only a single operator: either a single plus sign (+) or a single minus sign (-). Additional operators can lead to unpredictable results.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● PI Time String Meaning *-1h One hour ago t+8h 8:00:00 am today y-8h 4:00:00 pm on the day before yesterday mon+14.5h 2:30:00 pm last Monday sat-1m 11:59:00 pm last Friday Time Interval Examples In interval expressions, a positive or unmarked interval is based on the start time, and a negative interval is based on the end time of a time expression.
● 12 ● Supplemental Information ● ● ● ● on the Regional Settings on the computer where FactoryTalk Historian ProcessBook is installed. Format Value Result General -25.434 -25.434 0 25.59 26 0.00 17.246 17.25 #,##0 -1732.87 -1,733 #,##0.00 -1732.87 -1,732.87 (#,##0) -1732.87 (1,733) (#,##0.00) -1732.87 (1,732.87) 0% 3.25 325% 0.00% 3.25 325.00% Scientific 3.25 3.25000E+00 Database Uses the Display Digits attribute for the tag from the FactoryTalk Historian system.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 342 Attribute Explanation typicalvalue Typical value. Units Engineering unit string. Zero Zero. Span Span. digstartcode Code for the first digital state string for the tag. dignumber Number of digital states minus 1. pointtype Point type character. pointsource Point source character. location1 Location parameter 1. location2 Location parameter 2. location3 Location parameter 3. location4 Location parameter 4.
● ● 12 ● Supplemental Information ● ● ● Attribute Explanation convers Conversion factor for postprocessed points. displaydigits Controls the format of numeric values on terminal-based FactoryTalk Historian screens. instrumenttag Tagname for value in another system; used by some interfaces. sourcept Tagname for output to other systems; used by some interfaces. taglong Long tagname (up to 80 characters). tagshort 12 character tagname. creator Creator of the tag.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● An ODBC database might have been restructured, invalidating your dataset. Trend Cursor Does Not Appear If the trend is part of a display, select it. If that doesn't enable the Trend Cursor (page 120), the trend is probably too small. Double-click to make the trend larger. Trend Legend Does Not Appear Make the trend larger. If that doesn't help, check the default Trend Format settings.
● 12 ● Supplemental Information ● ● ● ● At least one of the Y tag end times is indicated as the current time (by using *) or is in the future (*+N) and is not synchronized or matched with the X tag (if X is not updating). If both the X tag and the Y tag are updating, an arrow indicator is shown in each legend entry. Updates for retrieval methods Recorded and Interpolated are received from an event pipe that provides the application with snapshot values.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 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. In the Links dialog box, if the file is set to Manual Update, click Update Now, and the file should update. In the Links dialog box, if the entry for the file says Unavail, the source file is not where the application expects to find it.
● 12 ● Supplemental Information ● ● ● ● To resolve the problem, re-define the data source. The following figure shows what happens when a Trend attempts to display a trace for which the data source no longer exists.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● 348
Chapter 13 Technical Support and Resources Rockwell provides dedicated technical support internationally, 24 hours a day, 7 days a week. You can read complete information about technical support options, and access all of the following resources at the Rockwell Automation Support Web site (http://www.rockwellautomation.com/support/). Technical Support Please visit Rockwell Automation Customer Support Center (http://www.rockwellautomation.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Worldwide Support If you are not located in North America and want to contact Rockwell Automation Support, use the Worldwide Locator (http://www.rockwellautomation.com/locations/) for worldwide contact information. Training Programs Rockwell Automation offers a wide range of training programs that include e-learning, regularly scheduled and custom-tailored classes, self-paced training, and certificate programs.
● ● 13 ● Technical Support and Resources ● ● ● When you contact Rockwell Technical Support, please provide: Product name, version, and/or build numbers. Computer platform (CPU type, operating system, and version number). Exact wording of any messages that appeared on your screen. The message log(s) at that time. Descriptions of: What happened and what you were doing when the problem occurred. How you tried to solve the problem.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● directory and type the subsystem name followed by the option -v (for example, piarchss.exe -v). View Computer Platform Information To view platform specifications, right-click My Computer and select Properties. For more detailed information, choose Start > Run, and type msinfo32.exe.
Index Index 6 64-bit Operating Systems • 305 A About FactoryTalk Historian Data • 229 About FactoryTalk Historian ProcessBook • 36 Active Layers Status Bar • 99 ActiveX Automation • 302 ActiveX Controls • 285 Ad Hoc Trends • 129 Ad Hoc XYPlots • 146 Add a Button • 166 Add a Control • 285 Add a Data Set to a Trend • 262 Add a Data Set to an XYPlot • 142 Add a Dynamic Bar • 168 Add a Dynamic Value • 162 Add a Graphic • 185 Add a Trend Cursor • 121 Add Annotations • 196 Add Buttons to Toolbars • 16 Add Conn
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Change the Display Range • 93 Change the Language Used for FactoryTalk Historian ProcessBook • 36 Change the Level of an Entry in Book View • 53 Change the Level of an Entry in Outline View • 56 Change the Name of an Entry in Book View • 53 Change the Name of an Entry in Outline View • 56 Change the Scroll Period • 93 Change the Time Range • 202 Change Time Range • 122 Change Time Range Feature • 156 Collapse or Expand Outline View • 54 Color Section
● ● Index ● ● ● ● Delete Connection Points • 214 DEP Security • 313 Design Placeholder Queries • 258 Details and Annotations • 191 Details Window • 191 Detect Connections and Attachments • 223 Determine the Identifying Number of a Connection Point • 215 Display • 11 Display an OLE Object with an Icon • 295 Display Cannot Find Data • 343 Display Colors Section • 328 Display Format Tab • 112, 143 Display or Change Item Definition • 225 Display Range • 93 Display Scrolling Properties • 76 Display Section • 3
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● F FactoryTalk Historian Annotations Maintenance • 195 FactoryTalk Historian Data Archive • 237 FactoryTalk Historian Point Attributes • 341 FactoryTalk Historian ProcessBook Connection to Windows NT Servers • 313 FactoryTalk Historian ProcessBook Display Properties • 62 FactoryTalk Historian ProcessBook Essentials •5 FactoryTalk Historian ProcessBook File Properties • 60 FactoryTalk Historian Security • 8 FactoryTalk Historian Server Data Types • 235
● ● Index ● ● ● ● Layers within Displays • 95 Layout Tab • 115 Line Color • 82 Line Ends • 86 Line Style • 85 Line Style Section • 333 Line Symbol • 179 Line Weight • 85 Linear Regression by Least Squares • 150 Link a File to a Display • 290 Link a ProcessBook to Another Application • 299 Linked Display Entry • 43 Linked Object Data Is Not Updating • 345 Linked Objects • 283 Linked ProcessBook Entries • 46 Loading Custom Data Sets • 269 M Machine Address • 315 Macro Protection • 330 Manage Displays and I
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Open Independent Display Files • 71 Open Several Displays at One Time • 70 OpenVMS Trends and Graphics • 131 Operating System Command Entry • 46 Organizing Symbols • 78 Other FactoryTalk Historian System Client Products • 306 Out of Range Indicators • 158 Outline View • 53 Overview of Display Elements • 67 Overview of FactoryTalk Historian ProcessBook OLE Compound Documents • 281 P Page Setup for Printing • 34 PI Calculation Data Sets • 248 Placehol
● ● ● Index ● ● ● Select Among Multiple Connection Points on One Symbol • 214 Select and Move a Symbol • 204 Select Multiple Symbols • 205 Servers and Connections • 6 Set a Home Page • 17 Set Grid Size and Grid Snap • 80 Set Time Range for Future Trends • 204 SETUPProcessBook.
● ● ● FactoryTalk Historian ProcessBook User Guide ● ● Use MSQuery to Build Data Sets • 275 Use the Scrolling Time Range • 203 XYPlot Statistics • 147 XYPlots • 133 V Z Value Scale Grid Lines • 124 Values • 162 VBA Commands • 301 View Browsing History • 17 View Computer Platform Information • 352 View Only Mode • 331 View Point Attributes • 234 Visual Basic for Applications in FactoryTalk Historian ProcessBook • 301 Visualize Data with Symbols • 103 Zoom Display Size • 71 Zoom/Revert Functions • 153
