FTHistorian Student Manual_10!4!2012
Short Description
Download FTHistorian Student Manual_10!4!2012...
Description
FactoryTalk Historian
Student Manual Version: October 4, 2012 For Rockwell and Partner Use Only!
Copyright © 2012 Rockwell Automation, Inc.
Table of Contents Lesson 1 – FactoryTalk Historian (SE and ME) ............................................................................................ 7 FactoryTalk Historian Site Edition (SE) ..................................................................................................... 7 Ordering Information................................................................................................................................ 10 FactoryTalk Historian System Requirements .......................................................................................... 14 System Limits .......................................................................................................................................... 16 Architecture Examples ............................................................................................................................. 17 FactoryTalk Historian Machine Edition (ME) ........................................................................................... 19 The Virtual Machines ............................................................................................................................... 24 Lab 1 – FactoryTalk Historian Site Edition (SE) Configuration ............................................................... 25 Part A – Overview of FactoryTalk Directory and Application ............................................................... 25 Part B – Basic FactoryTalk Historian SE Configuration ....................................................................... 27 Lab 2 – FTLD Interface Configuration ..................................................................................................... 43 Part A – Configuring Security and AboutPI-SDK to Connect to Server ............................................... 43 Part B – Configuring Interface Buffering .............................................................................................. 52 Part C – Configuring Disconnected Startup ......................................................................................... 56 Lab 3 – Using Discover Historian Points ................................................................................................. 59 Lesson 2 - Understanding Tags and Using Excel Tag Configurator .......................................................... 69 Lab 1 – Working with FTH Tags In Excel ................................................................................................ 78 Part A - Configuring CLIENT image to communicate with SERVER ................................................... 78 Part B - Adding PI Tag Configurator add-in to Microsoft Excel 2010 .................................................. 81 Part C - Using the PI Tag Configurator Add-In .................................................................................... 84 Changing Tag Names.............................................................................................................................. 95 Lesson 3 - Using VantagePoint .................................................................................................................. 99 Lab 1 – Using VantagePoint to Visualize Historian Data ...................................................................... 100 Part A – Creating VantagePoint FactoryTalk Connector and Importing Historian Tags ................... 100 Part B – Creating and Publishing a VantagePoint Trend .................................................................. 104 Part C – Creating and Publishing a VantagePoint Excel Report ....................................................... 107 Lesson 4 - Understanding and Using Exception and Compression ......................................................... 117 Exception Specifications........................................................................................................................ 117 Compression Specifications .................................................................................................................. 119 Lab 1 – Using Exception and Compression: ......................................................................................... 124 Part A - Filter Less with Exception/Compression .............................................................................. 124 Part B - Filter More with Exception/Compression .............................................................................. 127 Lesson 5 - FactoryTalk Historian Tag Types ............................................................................................ 133 Lab 1 – FactoryTalk Historian Tag Types ............................................................................................. 137 Part A - Polled versus Advised Collection Modes ............................................................................. 137 Part B - Event Tags............................................................................................................................ 139 Part C - Output Tags .......................................................................................................................... 142
2 of 458
Lesson 6 - Using Performance Equations and Totalizers ......................................................................... 145 Performance Equations (PE) Functions ................................................................................................ 145 Historian Totalizer Subsystem ............................................................................................................... 152 Lab 1 – Performance Equations ............................................................................................................ 154 Part A – Simple Conversion Calculation ............................................................................................ 154 Part B – Using a Performance Equation Function ............................................................................. 157 Lab 2 - Totalizers ................................................................................................................................... 163 Part A – Summary Calculation Totalizer Example ............................................................................. 163 Part B – Count Events Totalizer Example ......................................................................................... 166 Lesson 7 - Working with Digital States ..................................................................................................... 169 Lab 1 – Creating Digital State Sets, Assigning Tags and Displaying States ........................................ 170 Part A - Configuring Digital State ....................................................................................................... 170 Part B - Create Tag in Historian Using Digital State .......................................................................... 172 Part C - Displaying with VantagePoint ............................................................................................... 178 Lesson 8 - Configuring Event Framing and Using BatchView .................................................................. 181 Lab 1 – Using FactoryTalk Historian Event Framing and BatchView ................................................... 183 Part A – MDB to AF Preparation Wizard ........................................................................................... 183 Part B - Configuring PIBaGen ............................................................................................................ 188 Part C - Create a new PIUnit ............................................................................................................. 192 Part D - BatchView............................................................................................................................. 203 Lesson 9 - Using Health Points and Performance Monitor Tags .............................................................. 211 Lab 1 – Using FTLD Health Points and Historian Server Performance Monitor Tags .......................... 212 Lesson 10 - Using and Displaying Audit Information ................................................................................ 217 Lab 1 – Auditing FactoryTalk Historian ................................................................................................. 220 Part A - Enable Auditing of your PI Server ........................................................................................ 220 Part B - Make Changes and Use Audit Viewer to Examine the Activity ............................................ 223 Lesson 11 - Using Archive Management Tools ........................................................................................ 231 Lab 1 – Managing FactoryTalk Historian Archives ................................................................................ 234 Lesson 12 - Scheduling Backups of Historian Data .................................................................................. 241 Lab 1 – FactoryTalk Historian Backups ................................................................................................. 242 Part A - Create a Scheduled Task to Perform Backups .................................................................... 242 Part B - Creating a pisitebackup.bat file to Backup to Remote Computer......................................... 249 Lesson 13 - Using FactoryTalk View SE Trend and ActiveView to Display Historian Data ..................... 253 Lab 1 – Using FactoryTalk View SE Trend to Display Historian Data .................................................. 254 Lab 2 - Using FactoryTalk Historian ActiveView ................................................................................... 261 Part A – FactoryTalk Historian ActiveView Configuration .................................................................. 261 Part B – Using ActiveView via Internet Explorer ................................................................................ 265 Part C – Using ActiveView in a FactoryTalk View SE Display........................................................... 270 Lesson 14 - FactoryTalk Historian SE High Availability ............................................................................ 275
3 of 458
Interface Buffering ................................................................................................................................. 275 Interface Redundancy and Collectives .................................................................................................. 278 Lab 1 - Interface Buffering ..................................................................................................................... 283 Lab 2 - Interface Redundancy ............................................................................................................... 290 Part A – Configuring Buffering and Initial CLIENT Interface Configuration ....................................... 290 Part B - Create Shared Folder ........................................................................................................... 297 Part C – Configuring Interfaces for Failover ...................................................................................... 300 Part D – Modifying FTLD Service Properties ..................................................................................... 302 Part E – Finishing up and Testing the Interface Redundancy ........................................................... 304 Lab 3 – Using a Collective ..................................................................................................................... 311 Part A – Confirming and Adding Security Mappings ......................................................................... 311 Part B – Creating Collective Preparation ........................................................................................... 317 Part C - Creating the Collective ......................................................................................................... 319 Part D - Testing and Using the Collective .......................................................................................... 325 Appendix A - Installing FactoryTalk Historian SE ..................................................................................... 331 Appendix B - FactoryTalk Historian Time Format ..................................................................................... 345 Appendix C - Using FactoryTalk Historian DataLink ................................................................................. 347 Lab 1 – Using FactoryTalk Historian DataLink ...................................................................................... 347 Part A – DataLink Introduction ........................................................................................................... 347 Part B – DataLink Sampled vs. Compressed Data ............................................................................ 355 Part C - Archived data and Digital tags .............................................................................................. 364 Part D - DataLink Trend Object ....................................................................................................... 368 Part E - Time Filtered Function .......................................................................................................... 373 Appendix D - Using FactoryTalk Historian ProcessBook .......................................................................... 379 Lab 1 – Using FactoryTalk Historian ProcessBook ............................................................................... 379 Part A – Single-page ProcessBook ................................................................................................... 379 Part B - Multi-Trend Layout ................................................................................................................ 385 Part C – Multi-Page ProcessBook ..................................................................................................... 392 Appendix E - Introduction to SQC Charts in ProcessBook ....................................................................... 401 Lab 1 - SQC Charting in ProcessBook .................................................................................................. 401 Appendix F - Accessing FactoryTalk Historian SE Data via OLEDB ........................................................ 413 Lab 1 – Accessing FactoryTalk Historian SE Data via OLEDB............................................................. 414 Part A – FactoryTalk Historian OLEDB Basics .................................................................................. 414 Part B - Using Microsoft Reporting Services ..................................................................................... 416 Appendix G - VantagePoint Dashboards with Historian Data ................................................................... 429 Lab 1 – VantagePoint Dashboards with Historian Data ........................................................................ 429 Part A - Creating a Dashboard Report from a Template ................................................................... 429 Part B - Publish and View the Dashboard from the VantagePoint Portal .......................................... 443 Appendix H – FactoryTalk Historian Advanced Calculation Engine (ACE) Overview .............................. 447
4 of 458
Appendix I – FactoryTalk Historian to Historian Interface Overview......................................................... 455
5 of 458
This page intentionally left blank
6 of 458
Lesson 1 – FactoryTalk Historian (SE and ME) What you will learn:
Understand key features/concepts of FactoryTalk Historian SE and ME
Configure FactoryTalk Historian Server
Configure FactoryTalk Historian Distributed Interface
FactoryTalk Historian Site Edition (SE) FactoryTalk Historian SE is a scalable and integrated solution. It redefines the options for manufacturers who want to maximize their ability to collect and analyze process data. Use FactoryTalk Historian to capture data across your enterprise while serving the data to plant applications. This allows for fast and reliable data capture at the controller level and at high speeds and low intervals.
Historians are utilized across many industries and applications: – Consumer Products, Food and Beverage, Automotive, Life Sciences – Continuous Process, Packaging, Material Routing
Key benefits of a Historian: – Capture and process high-speed, time-series data – Store in a central (Site or Enterprise) data repository for future analysis
Historical data is used for: – Analysis through calculations, statistical processes, quality controls – Supports business and operational analysis: • Trends and graphs of data
7 of 458
8 of 458
FactoryTalk Historian SE provides the capability to collect, store, analyze, and visualize data using a powerful engine and a set of reporting tools such as time-series trends, bar charts, piecharts, pareto and tabular trends, and an easy method of generating reports using Microsoft Excel. It also uses compressed storage data algorithms to contain a vast amount of data in a small format. You can retrieve data spanning a long or short time span quickly. FactoryTalk Historian SE is closely integrated with the following Rockwell Automation’s FactoryTalk Services Platform and Applications.
FactoryTalk Live Data (FTLD) A direct data interface to FTLD delivers native FTLD data directly to FactoryTalk Historian SE without requiring intermediate interfaces and standards such as OPC.
FactoryTalk Directory FactoryTalk Historian SE uses FactoryTalk Directory to look up data points for configuring points to historize. The FactoryTalk Directory is also used for autodiscovering controller data sources and tags in the initial configuration process.
FactoryTalk Activation FactoryTalk Historian SE is activated by Rockwell Automation's central licensing system based on the FactoryTalk Activation Server.
FactoryTalk Diagnostics Because of FactoryTalk Historian SE close integration with FactoryTalk Diagnostics, all system and diagnostics messages from FactoryTalk Historian SE are centrally stored and maintained in the FactoryTalk Diagnostics database.
FactoryTalk Audit All FactoryTalk Historian SE Server auditing messages are stored and available in the FactoryTalk Audit database.
FactoryTalk View SE Trending FactoryTalk View Site Edition natively trends data from FactoryTalk Historian SE.
FactoryTalk Historian Machine Edition (ME) FactoryTalk Historian ME provides a Data Transfer service to allow its logged data to be transferred to the FactoryTalk Historian SE for long-term storage and analysis.
FactoryTalk VantagePoint The data from multiple FactoryTalk Historian SE Servers and FactoryTalk Historian ME Servers can be brought together into a single information management and decision support system using FactoryTalk VantagePoint.
FactoryTalk Batch The event journal data from your FactoryTalk Batch system can be collected through the FactoryTalk Batch Interface and stored within FactoryTalk Historian SE.
9 of 458
Ordering Information FactoryTalk Historian Site Edition A FactoryTalk® Historian Site Edition server includes a data point-limited license, calculation engine (performance equations, totalizers and SQC alarms), Batch database, Analytics Framework (AF), module database, and one node-locked FactoryTalk® Historian DataLink (Excel Add-In) license. Additionally, server licenses include RSLinx® Enterprise and FactoryTalk Administration Console Communication to Rockwell Automation controllers is via FactoryTalk® Live Data using RSLinx Enterprise. Communication to third-party devices can either be through FactoryTalk Live Data – using a third-party OPC server (purchased separately) configured as a FactoryTalk Live Data server or through one of the third-party Historian interfaces listed below. The included Historian Client is based on the FactoryTalk VantagePoint EMI Trending and Reporting solution that offers a single solution for advanced trending, Microsoft Excel reporting and dashboards with the capability of publishing all these different trends and reports in a thin client portal that allows for access to data with just a browser.
FactoryTalk Historian SE Servers With the introduction of Historian SE v3.0, the server licensing has been consolidated into a single set of tag licensing - no longer distinguishing between Rockwell Automation and 3rd party data sources. With this new licensing, you will be able to allocate up to 1,000 tags or 20% of the total tags (whichever is higher) to 3rd party tags. In the case where there is a higher utilization of 3rd party tags, 3rd party only tag licenses are available. Example 1:
250 Data points
500 Data points
Total: 750 tag licensing
All 750 tags can be used for 3rd party devices
Example 2:
500 Data points
1,000 Data points
Total: 1,500 tag licensing
Up to 1,000 tags can be used for 3 party devices
rd
Example 3:
5,000 Data points
10,000 Data points
Total: 15,000 tag licensing
Up to 3,000 tags can be used for 3rd party devices – 20% of 15,000 data points
10 of 458
Description:
Part Number:
FT Historian Site Edition - 250 tags
9518-HSE250
FT Historian Site Edition - 500 tags
9518-HSE500
FT Historian Site Edition - 1,000 tags
9518-HSE1K
FT Historian Site Edition - 2,500 tags
9518-HSE2K5
FT Historian Site Edition - 5,000 tags
9518-HSE5K
FT Historian Site Edition - 10,000 tags
9518-HSE10K
FT Historian Site Edition - 20,000 tags
9518-HSE20K
FT Historian Site Edition - 50,000 tags
9518-HSE50K
FT Historian Site Edition - 100,000 tags
9518-HSE100K
FT Historian SE Server – 2,000 3rd Party Tags
9518-HSE2K3ADD
FT Historian SE Server – 5,000 3rd Party Tags
9518-HSE5K3ADD
FT Historian SE Server – 10,000 3rd Party Tags
9518-HSE10K3ADD
FT Historian SE Server – 20,000 3rd Party Tags
9518-HSE20K3ADD
FactoryTalk Historian SE – Advanced Server Option FactoryTalk® Historian SE Advanced Server License adds the following capability: Data Access (OPC DA and HDA servers, OLE DB Provider, JDBC data provider and web services), Advanced Computation Engine (ACE), and Notifications for using Microsoft® Lync Unified Communication Server. With the purchase of Advance Server Option (9518-HSEADV) you will get the following client licensing (Please refer to Client Access Licensing section for more details): - 5 named users CAL license - Unlimited users CAL license (ONLY for FT Historian SE - 250 tags or 500 tags)
FactoryTalk Historian Site Edition Advanced Server
9518-HSEADV
FactoryTalk Historian SE – Client Access Licensing Data Access components (OLEDB, JDBC, Web services, etc.) that are part of the Advance Server Option, require client licensing to consume data from the Historian database. The licensing model is similar to SQL Server licensing from Microsoft where we have two options: CAL - named user based and CAL – unlimited users. With the purchase of Advance Server Option (9518-HSEADV) you will get the following client licensing (pick one): - 5 named users CAL license - Unlimited users CAL license (ONLY for FT Historian SE - 250 tags or 500 tags)
The following catalog items can be purchased for additional data access client licensing Historian Client Access License - 1 Named User
11 of 458
9518-HCALENE
Historian Client Access License - Unlimited Users for 1,000 Tags
9518-HCAL1KENF
Historian Client Access License - Unlimited Users for 2,500 Tags
9518-HCAL2K5ENF
Historian Client Access License - Unlimited Users for 5,000 Tags
9518-HCAL5KENF
Historian Client Access License - Unlimited Users for 10,000 Tags
9518-HCAL10KENF
Historian Client Access License - Unlimited Users for 20,000 Tags
9518-HCAL20KENF
Historian Client Access License - Unlimited Users for 50,000 Tags
9518-HCAL50KENF
Historian Client Access License - Unlimited Users for 100,000 Tags 9518-HCAL100KENF
FactoryTalk Historian SE Client Tools The FactoryTalk Historian ProcessBook application allows you to build ProcessBooks, which are collections of “display entries.” These display entries show your data from one or more historian systems – with displays including components such as values, trends, SQC/SPC charts etc. The FactoryTalk Historian ActiveView Runtime client license enables ProcessBook content (including BatchView) to be hosted/displayed from within Microsoft® Internet Explorer®, FactoryTalk View SE or any other ActiveX container. The FactoryTalk® Historian DataLink Excel reporting tool provides a Historian add-on for Microsoft® Excel. The FactoryTalk® Historian BatchView client allows users to visualize batch events from the Historian Batch database in Historian – batch trends, Gantt charts comparing multiple batches etc. FactoryTalk Historian ProcessBook Authoring Client – Single User
9518-HPBENE
FactoryTalk Historian DataLink Excel Reporting Tool – Single User
9518-HDLENE
FactoryTalk Historian Historian ActiveView Client - Single User
9518-HAVENE
FactoryTalk Historian BatchView Add-in - Single User
9518-HBAVENE
FactoryTalk Historian SQC ProcessBook Add-in – Single User
9518-HSAENE
(SQC Add-in intended for pre-3.2 versions of ProcessBook)
Third-Party Interfaces Historian Interface for OPC Alarm and Events – media only
9518-HINOPCAE
Historian Interface for OPC HDA – media only
9518-HINOPCHDA
Historian Interface for OPC XML plug-in – media only
9518-HINOPCXML
Historian Interface for ODBC – media only
9518-HINRELDB
Historian Interface for DDE – media only
9518-HINDDE
Historian Interface for TCP Response – media only
9518-HINTCP
Historian Interface for Trace Route Response – media only
9518-HINTRACE
Historian Interface for HTML – media only
9518-HINHTML
Historian Interface for XML – media only
9518-HINXML
Historian Interface for File Reader XML plug-in – media only
9518-HINXMLFILE
12 of 458
Historian Interface for Batch Files – media only
9518-HINBATFILE
Historian Interface for Universal File Loader – media only
9518-HINUNIFILE
Historian Interface for MS Windows Event File – media only
9518-HINWINEVT
Historian Interface for DNP 3.0 – media only
9518-HINDNP3
Historian Interface for Fourier Transformations – media only
9518-HINFFT
Historian Interface for Historian Performance Monitor – media only
9518-HINPERFMON
Historian Interface for Modbus Ethernet – media only
9518-HINEPLC
Historian Interface for Modbus/Modbus Plus PLC – media only
9518-HINMPLC
Historian Interface for ABB IMS Advant – media only
9518-HINABBIMS
Historian Interface for ABB IMS Advant PDL – media only
9518-HINABBPDL
Historian Interface for ABB Procontrol P for PBS – media only
9518-HINABBPBS
Historian Interface for Citech – media only
9518-HINCITECH
Historian Interface for Foxboro AW70 Series –- media only
9518-HINFOXBORO
Historian Interface for GE Cimplicity – media only
9518-HINGECIMPL
Historian Interface for GE EPIC – media only
9518-HINGEEPIC
Historian Interface for GE PAC 4010/4020 – media only
9518-HINGEPAC4K
Historian Interface for Honeywell PHD – media only
9518-HINHONPHD
Historian Interface for Honeywell Scan3000 – media only
9518-HINHONSC3K
Historian Interface for Siemens Simatec Net S7 – media only
9518-HINSIEMS7
Historian Interface for AspenTech CIM-IO Client – media only
9518-HINASPEN
Historian Interface for Intellution FIX (FIX32/iFIX) – media only
9518-HINIFIX
Historian Interface for Wonderware InTouch – media only
9518-HININTOUCH
FactoryTalk Historian Machine Edition Enhance your data management capabilities with the powerful high speed data collection and analysis engine of FactoryTalk Historian ME and the extensive series of Microsoft-compatible reporting tools in the FactoryTalk Suite as well as a built in thin client Web UI for configuration. With the Historian ME modules data collection speeds more than 10 times faster than traditional data collection rates, data collection can now be an integrated part of more applications. FactoryTalk Historian Machine Edition is an embedded appliance module in a ControlLogix form factor, and as such is comprised of both hardware and software. The Software comes pre-installed on the module, and can be updated with firmware updates using ControlFlash. ControlLogix Guidelines and Requirements: ControlLogix version 13.x and up supported; AOP is supported with version 15.x and up; connect up to maximum four (4) controllers in the same ControlLogix chassis; Maximum two Historian ME’s in a single chassis. FactoryTalk Services support includes backplane data connector, FactoryTalk Security Integration, and FactoryTalk Directory Integration.
13 of 458
FactoryTalk Historian ME 1GB Module (Hardware w/ME Historian)
1756-HIST1G
FactoryTalk Historian ME 2GB Module (Hardware w/ME Historian)
1756-HIST2G
FactoryTalk Historian System Requirements The hardware required with FactoryTalk Historian Site Edition depends on the demands an application places on the system. The greater the demand, the more powerful a system is required. In any application, faster processors and more memory will result in better performance. In addition, there should always be sufficient disk space to provide virtual memory that is at least twice the size of the physical memory.
FactoryTalk Historian SE Server Machine System Requirements:
FactoryTalk Historian SE 25,000 points and below - Minimum: Intel Pentium Xeon, 3.2 GHz, 4GB RAM
FactoryTalk Historian SE 50,000 points and below - Minimum: Intel Pentium Xeon, 3.2 GHz, 4GB RAM
FactoryTalk Historian SE 100,000 points and below - Minimum: Intel Pentium Xeon dual processor, 3.4 GHz, 4GB RAM
Operating Systems:
Microsoft Windows Server 2008 R2 with Service Pack 1 64-bit
Hardware:
100 Megabit or faster Ethernet card, network cable; concentrator if using twisted pair wiring; TCP/IP protocol
SVGA TrueColor monitor with 1 MB of video RAM and 1024x768 resolution
FactoryTalk Historian Live Data Interface Machine Minimum: Intel Celeron D, 3.0Ghz, 512MB RAM Operating Systems:
Microsoft Windows 7 with Service Pack 1 32-bit and 64-bit
Microsoft Windows XP with Service Pack 3 32-bit Microsoft Windows Server 2003 R2 with Service Pack 2 32-bit and 64-bit Microsoft Windows Server 2008 R2 with Service Pack 1 64-bit Microsoft Windows Server 2008 with Service Pack 2 32-bit and 64-bit
FactoryTalk Historian Client Machine Minimum: Intel Pentium III, 600Mhz, 512MB RAM Recommended: Intel Celeron, 3GHz or higher, 1GB RAM or more
14 of 458
Operating Systems:
Microsoft Windows 7 with Service Pack 1 32-bit and 64-bit
Microsoft Windows XP with Service Pack 3 32-bit
Microsoft Windows Server 2003 R2 with Service Pack 2 32-bit and 64-bit
Microsoft Windows Server 2008 R2 with Service Pack 1 64-bit
Microsoft Windows Server 2008 with Service Pack 2 32-bit and 64-bit
Hardware:
100 Megabit or faster Ethernet card, network cable; concentrator if using twisted pair wiring; TCP/IP protocol
SVGA TrueColor monitor with 1 MB of video RAM and 1024x768 resolution
Software:
Microsoft Internet Explorer 6SP1, IE7, IE8
Microsoft Excel 2003 or newer for FactoryTalk Historian DataLink or FactoryTalk Historian System Management Tools (SMT)
FactoryTalk Historian Asset Framework Operating Systems (both 32-bit and 64-bit versions, if available):
Microsoft Windows Server 2008 R2
Microsoft Windows Server 2008
Microsoft Windows Server 2003 (with Service Pack 1 or later)
Microsoft Windows 7
Microsoft Windows Vista
Microsoft Windows XP with Service Pack 2 or later
Hardware:
Processor: a single quad-core processor, minimum 2.2 GHz
SQL Server Requirements: Supported SQL Server editions:
Express
Standard
Supported SQL Server versions (both 32-bit and 64-bit versions, if available):
SQL Server 2008
Required SQL Server components:
Database Engine
Agent (backup and replication)
15 of 458
System Limits Historian SE licenses are available in the following counts:
250; 500; 1,000; 2,500; 5,000; 10,000; 20,000; 50,000; 100,000
The licenses are additive, so to support 7,500 tags, licenses for 5,000 + 2,500 tags, or a single license for 10,000 tags, could be purchased. With these “additive” tags, up to 20% or 1,000, whichever is greater, can be used for 3rd party tags. To support Server High Availability (i.e., a Collective), quantity 2 of each license must be purchased. There are no additional licenses required for FTLD Interface Node redundancy. Specific 3rd party tag licenses are available in the following counts.
2,000: 5,000: 10,000: 20,000
To design and configure a non-redundant Historian SE system successfully, also observe the following limits:
The maximum number of Historian SE Servers in a FactoryTalk System (Directory) = 1
The maximum number of FTLD Interface Nodes per Historian SE server = 25 - or - 50,000 Archived Events at the Server/sec, whichever occurs first.
The maximum events per second on the FTLD Interface (for Advised and Polled tags) = 20,000
To design and configure a redundant Historian SE system successfully, also observe the following limits:
The maximum number of Collectives in a FactoryTalk System = 1, where the maximum number of Servers in the Collective = 2
The maximum number of redundant FTLD Interface Nodes per Historian SE server = 25 pairs - or - 50,000 Archived Events at the Server/sec, whichever occurs first.
The maximum events per second on the redundant FTLD Interface (for Advised and Polled tags) = 15,000
The following the limits apply to all systems:
The maximum number of tags per system =100,000 (e.g., 100,000 Live Data or 75,000 Live Data & 25,000 3rd Party)
The maximum number of Clients that can have simultaneous access to a Historian SE Server = 20
The maximum number of FTLD Interfaces on one computer = 1
Maximum events/sec to the FTHSE Archive = 50,000
16 of 458
Architecture Examples
17 of 458
18 of 458
FactoryTalk Historian Machine Edition (ME)
19 of 458
20 of 458
21 of 458
22 of 458
23 of 458
The Virtual Machines In this class there are three virtual machine images. The first is called SERVER. This image is both the Historian and VantagePoint Server for the class. It will also host the SoftLogix controllers, RSLogix software and RSLinx Classic and Enterprise. It is already loaded with the following software products:
FactoryTalk Services Platform
FactoryTalk Activation Manager
FactoryTalk Network Directory
Microsoft SQL Server
FactoryTalk VantagePoint Server
Microsoft Excel
FactoryTalk Historian Site Edition Server
RSLogix 5000
SoftLogix 5800
RSLinx Classic
RSLinx Enterprise
The second virtual machine image is called DATA. This image will serve as a FactoryTalk View SE Server and FactoryTalk Live Data Interface. It is already loaded with the following software products:
FactoryTalk Services Platform
FactoryTalk Activation Manager
FactoryTalk Historian Live Data Interface
FactoryTalk View SE Server
The third virtual machine image is called CLIENT. This image will host the clients that will connect to FactoryTalk Historian and VantagePoint Servers. It is already loaded with the following software products:
FactoryTalk Services Platform
FactoryTalk Activation Manager
Microsoft Excel
FactoryTalk Historian Live Data Interface (for Redundant Interface exercise)
ProcessBook
DataLink
VantagePoint Dashboard Builder (Xcelsius)
VantagePoint Clients
The fourth virtual machine image is called SERVER2. This image will only need to be running for the Collectives lab and will serve as the Secondary Server in the Collective. It is already loaded with the following software products:
FactoryTalk Services Platform
FactoryTalk Activation Manager
FactoryTalk Historian Site Edition Server
24 of 458
Lab 1 – FactoryTalk Historian Site Edition (SE) Configuration Before you begin:
Images need to be fully running…Server started first until running (“started” dialog appears), Data next until running and finally Client until running
Part A – Overview of FactoryTalk Directory and Application The Server image you are using in this training has a FactoryTalk Historian SE Server already installed. This Server install also installs a “local” FactoryTalk Live Data Interface on this image as well. Separately, pre-installed on the Data image is another FactoryTalk Historian Live Data Interface. Although the Server and Interfaces have already been installed, no configurations have been done. Before continuing, if you haven’t already done so, please review Appendix A for examples of the installation process/procedure. 1. Verify that you are on the SERVER image::
2. Verify that SoftLogix is running with two controllers. In the controller applications used in this training, one controller is running a simulated “BreadLine1” (BL1) and the other a “BreadLine2” (BL2). Each BreadLine is made of three workcells…Mixer, Proof_Oven and Packaging. These simulated applications will provide us with data to collect, such as Oven Temperatures, Steps in the workcell cycles, etc.
3. Open the FactoryTalk Administration Console by going to Start > All Programs > Rockwell Software > FactoryTalk Administration Console. Select Network directory.
25 of 458
4. Observe the following in the FactoryTalk Directory:
The “host” of the FactoryTalk Networked directory is “THIS COMPUTER”. Other images we will use during this training “point” to the FactoryTalk Directory on this computer.
There is one application named RA Foods already created in this Directory.
Under Connections (click on the + sign to open the tree), there is a folder to identify FactoryTalk Historian SE Servers (Historical Data), but none are present at this time (nothing in the folder).
5. Do the following steps: a. Open the RA Foods application. b. Notice a Data Server named RSLE. This is an instance of RSLinx Enterprise installed on the Server image. c.
Double-click on Communication Setup under RSLE.
d. If you click on BL1, you will see that BL1 is a shortcut for the controller in Slot 2 of the SoftLogix Chassis. e. Click on BL2 to see it is a shortcut to the controller in Slot 3. f.
In this training you will be collecting data coming from FactoryTalk, with application of RA Foods, Data Server of RSLE and shortcuts of BL1 and BL2.
26 of 458
Part B – Basic FactoryTalk Historian SE Configuration 1. Before we add our FactoryTalk Historian Server to the FactoryTalk Directory, it is a good idea to check and make sure it is up and running and able to be “connected to”. Select Start > All Programs > Rockwell Software > FactoryTalk Historian SE > FactoryTalk Historian SE System > AboutPI-SDK
Continued next page…
27 of 458
2. Do the following steps: a. Click Connections. b. Check the SERVER box. Note: The AboutPI-SDK Utility at default assumes that there is a FactoryTalk Historian Server on the same computer (image) that it is installed on. So, “SERVER” was here automatically at default as this is the name of this computer (image) and also the name of the FactoryTalk Historian Server. c.
You should see a SERVER connected as piadmin message and get no errors. Note: The three images you are using are all configure with an automatic logon of the user “Administrator” with password of “rockwell". Later in this training you will learn about Mapping users to FactoryTalk Historian Groups, Users or Identities. Without doing any Mappings, whatever user is logged into the Historian Server computer is assumed to be a “piadmin” user, with unrestricted rights to the FactoryTalk Historian Server.
d. Close the AboutPI-SDK.
3. The above results indicate that the FactoryTalk Historian Server can be found and “connected to”. If not already running, start the FactoryTalk Administration Console and select Network directory.
28 of 458
4. Expand the Connections tree.
5. Right-click on Historical Data and select New Historian Server Connection…
6. Do the following steps: a. Notice default name of Production Historian that will be used. b. Click Test Server Connection button (grayed out in below graphic). c.
Look for green checkmark and Server found message.
d. Click Finish.
29 of 458
7. You have added a FactoryTalk Historian Server to your FactoryTalk Directory. Expand the Historical Data tree, right-click on Production Historian and click on Properties…
8. Do the following steps: a. Click the Licensing tab. b. Specify to use 1 of the FHSE.50K activations c.
Specify to use 1 of the FHSE.Advanced activations
d. When both above assignments have been made, click Apply
Note: In the above dialog, licenses or activations that appear are as follows:
FHSE.50K – This is Historian 3.0 license for up to 50,000 tags. Of these tags, up to 10,000 (20%) could be used for 3rd party verses Rockwell Automation devices (tags).
FHSE.Advanced – This is version 3.0 Advanced Server option.
FHSE.H2H – This is version 3.0 FactoryTalk Historian to FactoryTalk Historian Interface option.
FHLD.5000 – Version 2.2 and license for up to 5000 Rockwell Automation devices (tags). Historian 3.0 would recognize and be able to use this license.
30 of 458
PTY3.2500 – Version 2.2 license for up to 2500 3rd party devices. Historian 3.0 would recognize and be able to use this license.
AVIEW.1 – License for ActiveView.
9. Click the Point Sources tab. This tab would be used to allocate a maximum number of points to a specific interface type or point source. FTLD are standard Rockwell tags, and currently all 50,000 tags are configured to be used for Rockwell tags. If intending to use 3rd party tags with their own unique point source, or tags coming from a FactoryTalk Historian ME module via Data Transfer using point source FTMS, allocations of maximum number of such tags would be made here. Click OK when ready to proceed.
10. Whenever changes are made to FactoryTalk Historian licensing assignments, you should stop and restart the Server. Stop the FactoryTalk Historian server by selecting Start > All Programs > Rockwell Software > FactoryTalk Historian SE > Stop FactoryTalk Historian SE
11. Wait for all services to stop and the dialog to automatically close.
31 of 458
12. When the “stop” dialog closes (be patient!), start FactoryTalk Historian again by selecting Start > All Programs > Rockwell Software > FactoryTalk Historian SE > Start FactoryTalk Historian SE
13. Wait for all services to start and the dialog to automatically close. 14. Back in the Administration Console, under Production Historian, right-click on FTLD1 and click on Properties…
Continued…
32 of 458
15. When a FactoryTalk Historian Server is installed, it automatically installs a FactoryTalk Live Data (FTLD) Interface on the same computer. Notice the ID of 1 assigned to this interface, which is where the FTLD1 under Production Historian came from. Also notice that it indicates this interface is on the SERVER computer. If you wanted to use this interface, you could now click the Start button (don’t!) and proceed. We don’t want to use this “local” interface during this training, because it would not support interface buffering or redundancy. We have to have an interface on a separate computer to use those features. So, to continue, click Cancel without having made any changes.
16. Next, right-click FTLD1 and click on Delete.
17. Click Yes.
33 of 458
18. Right-click on Production Historian and click New Data Collection Interface…
19. We want to tell FactoryTalk Historian Server to use a FTLD interface that we’ve got installed on the Data image. By using an interface on a separate computer, interface buffering and redundancy can be used. Do the following steps in this order: a. Verify that the interface ID that will be used is 1. Since you deleted the interface that was there at default, and was named FTLD1, this new interface will take that ID and FTLD1 name. b. Change “Computer hosting the interface” to DATA. c.
Click Apply (already selected in below graphic, so grayed out).
d. Click Start (already selected in below graphic, so grayed out). e. Verify that you see the “Started” status (Under “Service Status”). The FTLD interface on the Data image is now configured to be able to collect data for FactoryTalk Historian. f.
Click OK.
34 of 458
20. To “test” data collection by the FTLD1 interface, right-click on the RA Foods application and select Add Individual Historian Points…
21. Notice that all options except for Default scan rate are grayed out at this time. The default scan class is 1, which is 1 second. There are 10 different scan classes you could pick from (1-10) in a default configuration (click the down arrow to see them listed), but it is possible to add more and even edit/delete existing ones. Leaving the scan class at 1, click Browse Tags…
22. After a delay of maybe 30-45 seconds, a Tag Browser should appear. This capability to Browse Tags is coming from RSLinx Enterprise, the Data Server we are using in our FactoryTalk Application. After this initial delay to bring up the Tag Browser, it should appear faster next time. 23. In the Tag Browser, you see the RA Foods application with BL1 and BL2 shortcuts listed under it. These are the two shortcuts you observed in the FactoryTalk Directory earlier, each one “pointing” to a different controller in the SoftLogix chassis. Under the RA Foods application, navigate to BL1 > Online and click on Program:Proof_Oven
35 of 458
24. In the pane on the right, scroll down and use Ctrl-click to pick the tags SimpleMachineStep and SimpleTempZone1. Be careful not pick the SimpleTempSetPtZone1 tag by mistake!
25. Do the following steps in this order: a. Click Add Tag(s) to List. b. Verify tags appear on “Selected tag(s) list. Note the “full” tag names will include shortcut name (BL1), program name from within the controller (Program:Proof_Oven) and then the actual names of the tags from within the program. c.
Click OK.
26. Review the different information about the tags listed, then click OK.
36 of 458
27. To see the tags being collected within FactoryTalk Historian, start System Management Tools (SMT) by going to Start > All Programs > Rockwell Software > FactoryTalk Historian SE > System Management Tools
28. Do the following steps in this order: a. Move and/or resize the SMT as desired. b. Check the box to connect to the FactoryTalk Historian Server named SERVER. c.
Under Data, click on Current Values.
d. Click the Search icon to select one or more tags to view their current data.
37 of 458
29. Click the Search button. Without any filters to limit your search, every tag in your FactoryTalk Historian server will be shown alphabetically by their name. In this server there are many more tags than what you initially see, and you’d have to scroll down to find them all.
30. To make tags easier to find, you usually would want to use some of the optional filters like Tag Mask and/or Point Source. In the Tag Mask field, you would specify the exact tag name you are looking for, or a “partial” tag name with asterisks (*) for wildcards.
31. The Point Source for our FactoryTalk Live Data tags will be FTLD. Do the following steps in this order: a. To limit our search to these tags, specify FTLD for Point Source and click Search. b. Use Ctrl-click to select both tags then click OK.
38 of 458
32. Click the Start Updating button. You should see the values of the tags occasionally change. Over approximately a one minute time period, the MachineStep increments from 0 to 5 and then resets. When the machine is in step 2, the TempZone1 part of the oven is active, and it’s value rapidly increases, and then drops down to approximately 65 again after that step. Watch your tags’ values for a few minutes to observe this repeatable behavior.
33. To see some “archived values”, click Archive Editor and then the Search icon.
34. The same “blank” Search dialog will appear. You could specify a Tag Mask and/or Point Source to filter your search. As an alternative, since we just recently did a specific search and want to do the same one again, in the upper-right corner of this dialog click Favorites > Last Search. Note that you can Save as well as Organize Searches in this area as well.
35. Click Select All and then OK.
36. The last two hours of values in the archives with their time stamps should be shown. Two hours because the default Start Time is *-2h and End Time is *. The asterisk (*) in FactoryTalk Historian Time refers to “now” or “current time”. See Appendix B for more information and examples of syntax used with FactoryTalk Historian Time.
39 of 458
37. Observe these items: a. The drop-down list to the left of the Search icon will let you pick from either of the two tags you added from the Search dialog. But, because of the long tag names it is sometimes hard to see which tag you’ve picked in this field. b. The “full” tag name is shown at the top, so you can look here to see what tag you’ve selected. c.
Since you just recently added this tag to Historian, you might have a Pt Created (Point Created), following by the values of this tag that are in the archive along with their timestamps.
d. Interesting to note that although you saw the MachineStep tag going from 0, 1, 2, 3, 4 and 5 over and over again, not all of the values were captured in the archive. At default, tags you add to Historian from the Administration Console have a certain amount of filtering assigned to them, called Exception and Compression. Adjustments can be made to filter “more” or “less” from the defaults, and you will spend more time leaning about this later in this course.
38. Use the drop down box to pick the TempZone1 tag and observe its archived values ranging from approximately 65 to almost 400.
40 of 458
39. Go to Operation > Licensing and then under Resources open PointSourceLimit.FTLD. Here is where you can see what licenses you have for the FTLD point source. In our case, 50,000 are possible and so far we’ve used 2 with 49,998 left.
40. One other item to be aware of is under Security > Mappings & Trusts and then the Trusts tab. For Interfaces to have access to the FactoryTalk Historian Server, it is very common that one or more Trusts have to already exist or be created. It is good to be aware that installing FactoryTalk Historian Server automatically includes two Trusts for the FTLD interfaces to work. FTLDE refers to the FTLD interface application and pibufss.exe is the PI Buffer Subsystem application that allows the FTLD interface to buffer data. Adding any other interfaces to your FactoryTalk Historian Server would require you to add correct Trusts (specified in interface documentation).
41 of 458
[Optional] Create SERVER Desktop Shortcuts The installation of FactoryTalk Historian created a new “Start” menu program group. There are several utilities in that group which will be used throughout this course. You may wish copy one or more these shortcuts onto your desktop to provide easier access during the course. If you wish to create desktop icons, simply Ctrl-drag and drop the shortcuts from the “Start” menu onto the desktop:
IMPORTANT NOTE: Always Use “Stop FactoryTalk Historian SE” Shortcut From this point on, you should always use the “Stop FactoryTalk Historian SE” shortcut before you shutdown, restart, reboot, or even pause the SERVER image. This will ensure that all subsystems are shutdown cleanly, which may not always happen if you rely on them automatically shutting down in response to an operating system shutdown request.
This lab is complete
42 of 458
Lab 2 – FTLD Interface Configuration Before you begin:
Need to have successfully completed configurations and added tags specified in Lesson 1, Lab 1.
When you started Lab 1, a FactoryTalk Historian Server was already installed on the Server image, and Historian Live Data Interface installed on the Data image. Lab 1 walked you through configurations in the FactoryTalk Administration Console to add a Historian Server and Interface to the FactoryTalk Directory. It also had you add a couple of tags to Historian from the Administration Console, and use System Management Tools (SMT) to look at Current versus Archived data for those tags. Assuming you successfully completed Lab 1, you know that there is a running FactoryTalk Live Data Interface on the Data image and it is actively collecting tags from one of the SoftLogix controllers and sending data from those tags to the Historian Server which is archiving them. In the different parts of Lab 2, you will look at some of the recommended steps to configure a FactoryTalk Live Data Interface. Some are options, but strongly recommended and encouraged that you do on your own FactoryTalk Historian Server systems. You will start by making changes necessary for the AboutPI-SDK on the Data image to “connect” to the FactoryTalk Historian Server on the Server image. This “connection”, with required “rights” assigned, will be necessary to allow the current logged in user on the Data image to be able to use tools “remotely” such as System Management Tools (SMT) and the Interface Configuration Utility (ICU).
Part A – Configuring Security and AboutPI-SDK to Connect to Server 1. Go to the Data image.
2. Select Start > All Programs > Rockwell Software > FactoryTalk Historian SE > FactoryTalk Historian SE System > AboutPI-SDK.
43 of 458
3. Do the following steps in this order: a. Click on Connections b. Click on DATA (you will get an error described in next step)
4. After performing the above steps, you should have received the below error. In this case, you are using the AboutPI-SDK in its default state. And at default, the AboutPI-SDK assumes there is a Historian Server installed on the same computer it is installed on, the computer (or image) named DATA. We do not have a Historian Server on the DATA image, but an Interface. So, we need to modify the AboutPI-SDK so that it looks for a Historian Server on the image where we have it installed, the Server image. Click OK on the following dialog to close it. Notice the “Connection to DATA failed” message that then appears at the bottom of your AboutPI-SDK.
5. Under Connections, click on Add Server…
6. Do the following steps in this order: a. Enter Network Path or Fully Qualified name of SERVER. b. Uncheck the Confirm checkbox. This is not really a “required step” at this point, but in this lab will prevent the AboutPI-SDK from trying to connect as soon as we add this server…we want to wait a bit to actually try to connect. c.
Click OK.
44 of 458
7. Now, you should see both DATA and SERVER servers listed. Again, DATA is not really a valid server so we should get rid of it from this list. Right-click on it and select Remove selected Server.
8. Click Yes.
9. Now, with the only server listed the “valid” one we have installed on the SERVER image, check the box next to SERVER (if you get an error, just continue to the next step).
10. You should have received the below error. You have correctly specified a FactoryTalk Historian server to connect to named SERVER, but in order for the server to allow you to connect, it needs to know “who you are” and that you “have proper access”. In other words, we have to make one or more FactoryTalk Historian security setting changes to allow the current user on this DATA image (Administrator is logged in at default) to have a “connection to” or “access to” the Historian Server. Click OK to continue. Note the Collection to SERVER failed message that then appears at bottom of AboutPI-SDK.
11. Go to the Server image.
45 of 458
In order to give individual Users access to the FactoryTalk Historian Server, we have to make some configuration additions/changes related to Security. This is also required for applications other than those installed on the FactoryTalk Historian Server itself to be given access. In the last several steps you have seen that at this time you can’t access the Historian Server from the AboutPI-SDK installed on the DATA image. A standard practice is to create Windows Groups that individual Windows Users can be members of. In FactoryTalk Historian Server, these Windows Groups can then be mapped to existing FactoryTalk Historian Security Groups depending on what levels of access you want individual Users within the Windows Groups to have. Individual Historian Security groups that exist at default for the purposes of these mappings are:
FTHAdministrators
FTHEngineers
FTHSupervisors
FTHOperators
See FactoryTalk Historian SE Installation and Configuration Guide for more details regarding these groups, their levels of access and other security-related information.
12. On the Server image, right-click on Computer and select Manage.
13. Go to Configuration > Local Users and Groups > Groups. Note the two groups that have already been created on this image, WIN_FTHAdministrators and WIN_FTHEngineers.
46 of 458
There is nothing “special” about these names, you could call these groups whatever you want. What will be important is that we will put Users in these Windows Groups that we want to be considered either FTHAdministrators or FTHEngineers, and then map these two Windows Groups to the Historian Groups using the SMT. In our case, we only have one user, Administrator. The Administrator User is the current user logged into each image you are currently using…Data, Server and Client. So, whatever “rights” we give the groups Administrator belongs to, will be the “rights” available from each image. Also, be aware that in our case, since we are using a Windows Workgroup, we have these exact same Windows Groups configured on each image, as well as the same Administrator User with same password on each image. Administrator is the default logged in user. These Windows Groups and Administrator user will be “common” to each image. Note: Besides FTHAdministrators and FTHEngineers, there is a Historian Group named FTHSupervisors. This is the only group that can edit archived values of FTLD tags. We are not going to be including FTHSupervisors in our security mappings, but be aware that in a “real application” you may want to consider mapping appropriate persons to this group as well.
14. Click Users, then right-click on Administrator and select Properties.
15. Click the Member Of tab. You will see that on this image, the Administrator user has been preconfigured as a member of the Windows Groups WIN_FTHAdministrators and WIN_FTHEngineers groups. Again, there is nothing special about the names of these groups. For the purpose of this training, we are configuring the Administrator user to belong to these Windows Groups and will in the next steps be mapping these Windows Groups to FactoryTalk Historian Groups to give the Administrator user the privileges/access needed for future labs to work.
16. Close the Administrator Properties and Server Manager dialogs.
47 of 458
17. Start the SMT if not already open. Go to Security > Mappings & Trusts and on the Mappings tab click the New button.
18. This dialog is used to Map Windows Users and/or Groups to a FactoryTalk Historian User, Group or Identity. Start by clicking the Browse button for Windows Account.
48 of 458
19. Enter WIN_FTHAdministrators and click the Check Names button.
20. It will add SERVER in front of the User Name. Click OK.
21. Now click the Browse button for the PI Identity.
22. Note that you can select Type of Identities, Groups, Users or All. There are pre-configured Identities, Groups and Users in a FactoryTalk Historian Server that have specific “rights” or “capabilities” within the server. Things like “who can create or edit tags” and “who can only view”, is decided by what FactoryTalk Historian Identity, Group or User individual Windows Users or Groups are mapped to. See FactoryTalk Historian SE Installation and Configuration Guide for more details on setting up security with mappings.
49 of 458
23. Select PI Groups and then FTHAdministrators. Click OK when done.
24. Click OK to accept this mapping and you will see it listed on your Mappings tab.
25. Select New… to add another mapping.
50 of 458
26. Following previous steps 18 – 24, create another mapping of Windows Group WIN_FTHEngineers to PI (FactoryTalk Historian) Group FTHEngineers. Click OK when done.
27. You Mappings tab should now appear as follows.
28. Return to the DATA image.
29. Click the SERVER checkbox again. Since these mapping have been added and Administrator is logged onto this image, you are connecting as FTHAdministrators, FTHEngineers and PIWorld (“everyone”).
30. Close the AboutPI-SDK.
51 of 458
Part B – Configuring Interface Buffering Interface Buffering is a recommended option to allow your FTLD interface to continue collecting and storing data in local buffer files if/when the server is not available. The interface will occasionally check to see if the server “becomes” available, and when so it sends it the buffered data. 1. Open the Interface Configuration Utility (ICU) by going to Start > All Programs > Rockwell Software > FactoryTalk Historian SE > Interface Configuration Utility
2. Note that you could get to a Connection Manager to check or add/delete connections similar to what you earlier did with AboutPI-SDK by selecting Interface > SDK Connections. Close the Connection Manager if you opened it.
3. Using the drop-down arrow, select the FTLD1 interface that the ICU already knows is configured and running on this image.
52 of 458
4. Note the following visible on the default General area of the ICU: a. You are in the General area of the ICU. b. This interface uses Point Source of FTLD. c.
Interface ID is 1.
d. The interface is collecting tags for a server named SERVER. e. In the Scan Class area you can view and even edit, add and delete scan classes. f.
The interface is currently Ready and Running.
5. To configure this interface for buffering, select Tools > Buffering.
53 of 458
6. Select Enable buffering with PI Buffer Subsystem and then Yes on the dialog that appears.
7. Read this message and then click OK.
8. The Buffered Servers section of this dialog will automatically appear. Select the server named SERVER from the drop-down listbox and then click OK.
54 of 458
9. Click on the Service section on the left side of the ICU. Since we’ve added Buffering, the dialog that appears is asking if you’d like the ICU to create a dependency on the PI Buffer Subsystem. Click Yes.
10. Here you can see that there is a dependency added for this interface to PIBufss (PI Buffer Subsystem). If the ICU had not added this dependency for you, you would have had to move from the “Installed services:” list on the right to make it a Dependency.
11. Notice that the ICU has stopped (bottom of the ICU). Click the Start icon to start again.
55 of 458
12. Click Yes to start the PI Buffer Subsystem that now must be running when the interface is running. You may see Starting Service… and then Ready and Running at the bottom of the ICU. You have now completed configuring interface buffering (congratulations!).
Part C – Configuring Disconnected Startup Disconnected Startup is a feature that allows a remote FTLD Interface to start from a local cache file with or without a valid connection to the host Historian Server. This critical functionality prevents data loss when an interface needs to start up and it does not have a connection to the Historian Server. Disconnected startup also provides the added benefit of faster Interface startups (even with a valid connection the Historian Server). As a rule, using Disconnected Startup is recommended. However, it is not enabled by default. To properly enable Disconnected Startup on the default configuration of a FTLD Interface, a conflict must be resolved between the Cache synchronization period of 250 milliseconds and three default high speed scan classes:
Scan Class 2 (0.05 sec)
Scan Class 3 (0.1 sec)
Scan Class 4 (0.25 sec)
These three high speed scan classes are typically too fast for most Data Servers, so if deleted they probably won’t be “missed”. If data collection faster than .5 seconds is required, one could consider using a FactoryTalk Historian Machine Edition (ME) module which can reliably collect data from a ControlLogix processor at scan rates as fast as 10 milliseconds.
Continued…
56 of 458
1. On the left side of the ICU, click on the General section. In the Scan Classes area, select these scan frequencies one at a time and delete them with the “X” (Remove selected scan class) icon.
Scan Frequency 0.05 sec (be aware when this one is deleted, the ones below will “move up” the list)
Scan Frequency 0.1 sec (same comment as above)
Scan Frequency 0.25 sec
Note: Be aware that you started with scan classes 1-10 and when you are done you only have scan classes 1-7. Scan Frequencies that used to be numbered 5-10 would now be numbered 2-7. In a “real” application, if the FTH System is new (i.e., no tags configured), you simply use the Interface Configuration Utility (ICU) to delete the three scan classes from the interface as you have above. However, if the FTH System is existing (i.e., tags are already configured), then all tags should first be changed to use scan class 1 (1.0 sec) prior to deleting the three scan classes from the interface. Then, after the three conflicting scan classes have been deleted, the system's existing tags can be modified a second time to use the remaining 7 scan classes (now numbered 2-7). 2. Click Apply in the lower-right corner of the dialog and then OK on the message that appears.
57 of 458
3. Do the following steps in this order: a. Click on Disconnected Startup on the left side of the ICU. b. Check the checkbox for Enable disconnected startup (with point caching). c.
Click Apply
4. Read this message and click OK.
5. Restart the interface by clicking the Restart interface service button.
6. Look for Ready and Running messages at the bottom.
7. Close the ICU on the DATA image.
This lab is complete
58 of 458
Lab 3 – Using Discover Historian Points Before you begin:
Need to have successfully completed configurations and added tags specified in Lesson 1, Lab 1.
59 of 458
Often times there are many tags from different sources that you would like to archive with Historian. From the FactoryTalk Administration Console you can select to Add Individual Historian Points, which will let you browse for one tag at a time from the FactoryTalk Directory. Another option is to Discover Historian Points, which you will use in this lab to bring in potentially many tags from many different sources…a very powerful tool to easily add tags to your Historian system. Both FactoryTalk Historian SE as well as ME support a similar Discover Historian Points functionality.
1. Go to the Server image.
2. If not already open, start the FactoryTalk Administration Console by selecting Start > All Programs > Rockwell Software > FactoryTalk Administration Console
3. Select Network directory and OK.
60 of 458
4. Do the following steps. a. Browse through the RA Foods application and under the RSLE Server double-click on Communication Setup. b. Notice that there are two shortcuts, BL1 and BL2. Each of these is pointing to a different controller. c.
Click on BL2 and then BL1 again and notice either the controller in Slot 2 or 3 is assigned.
5. Right-click on the RA Foods at the top of the tree and select Discover Historian Points.
6. Do the following steps in this order: a. We only want to discover points that are accessed by Linx Enterprise, so de-select the other three sources. b. Click Edit Discovery Rules.
61 of 458
7. A dialog will appear and there will be no rule definition files created at default. Click Rule File Management…
8. Click New to create a new Rule file. 9. Enter Rule File Name of Tags to Discover and click OK.
10. Select the Active checkbox for this Rule file and click the Open button to make this rule file the “Current” file.
62 of 458
11. Note the path and actual xml file name being created. Click New to define the rules this file will use to Discover Historian Points.
12. Identify two items to look for, tags that have either StorageDint OR Shift_Timer in their names. Click a “+” sign that appears in order to select the “or” option. Your dialog should appear as follows (do NOT click OK yet!).
13. While tags are being “discovered”, a configuration file can be used to set specific tag attributes. Rather than use the “Default Configuration”, select with the drop-down box.
63 of 458
14. A dialog will appear. Do the following steps in this order: a. Enter File Name of Discovered Tag Attributes. b. On the General tab, enter Description of Tag was Discovered. c.
Enter Eng Units of ms.
15. On the Archive tab, notice the specific attributes that could be changed from the default as these tags are “Discovered”. Do not make any changes and click OK.
16. Click OK.
64 of 458
17. The Rule Editor dialog should appear as follows. Click Save, then Close (the Close button will appear after you click Save).
18. On the Discover Historian Points dialog, click Next > to start the Discovery process.
19. A dialog such as the following will appear during the Discovery process.
20. When Discovery has completed, you should get a dialog like this that indicates 16 discovered points were found that have names containing either Shift_Timer or StorageDint.
65 of 458
Note: In the dialog being displayed, notice that some of the tags are coming from the controller with shortcut of BL1, and other tags are in the controller with shortcut of BL2. In this example, all of these tags are “controller-scoped”, but if tags would have been “program-scoped”, they would have been found as well. This discovery process could be a huge time saver compared with finding points to add one-at-a-time using “Add Individual Historian Points” or some other method. 21. Do the following steps a. Click on None to de-select all of the tags that were discovered. b. Select only the [BL1]Shift_Timer.ACC and [BL1]StorageDint1 tags. c.
Select Confirm Points.
22. You should see Added 2 points to Production Historian (FTLD1). Click OK. 23. If not already running, start System Management Tools (SMT).
66 of 458
24. Select Points > Point Builder and then the Search icon.
25. Do the following steps in this order: a. Specify Point Source of ftld. b. Click Search. c.
Go to the bottom of the list and use Ctrl-clicks to select the two discovered tags.
d. Click OK.
67 of 458
26. Clicking on either tag (one at a time), you should see the Descriptor and Eng Units you specified in the Configuration file that was used with your Rule file. Note that if you had discovered hundreds or thousands of points, rather than just two, they all would have been discovered and brought into Historian with a common set of configuration attributes.
27. Close the SMT and Administration Console.
This lab is complete
68 of 458
Lesson 2 - Understanding Tags and Using Excel Tag Configurator What you will learn: After completing this lesson, you should be able to:
Understand concepts, terminology and definitions of tags and their attributes.
Use the Tag Configurator in Microsoft Excel to perform bulk tag creation and manipulation
Understanding Tags Points, sometimes also called tags, are the basic building blocks of a Historian system, because they are how you track the events that comprise your data history. When the System Manager or Field Services Engineer installs a Historian Server, he creates a Historian Point for every source of data that the Historian System needs to track. Each point has more than 50 attributes that define exactly how the data should be collected for that point. These attributes determine how frequently the point gets new values, the data type of the point values (whether integer or string, for example), who is allowed to view and/or edit the point, and so on. The Historian Base Subsystem stores points and their attributes in the Point Database. The System Management Tools (SMT) contains many tools used to manage the Historian System:
69 of 458
During the Lesson 1 lab, you used the SMT tools of Data > Archive Editor and Data > Current Values to verify that Historian was “connected” to the CLX controller and able to read and record tag values.
The SMT also has a very important tool for creating, monitoring and/or editing the configuration of tags. This tool is Points > Point Builder.
When Points > Point Builder is selected, such as in above graphic, the right portion will allow you to create new tags or edit existing tags after using the search feature. A number of tabs that appear for the editing of the tags are:
General
Archive
Classic
Security
System
70 of 458
The tabs that are most often used to monitor and/or edit Tags that come from our FactoryTalk Live Data (FTLD) Interfaces are as follows. Note: Not all tabs and fields are listed below. See online help and/or other FactoryTalk Historian SE reference manuals for additional details.
General Tab:
Name: The Tag attribute specifies the name of the point/tag. Many Historian users use the terms tag and point interchangeably, which is fine. Technically though, the tag is actually just the name of the point. Follow these rules for naming Historian points:
The name must be unique on the Historian Server
Tag name length limited to 256 characters
The first character must be alphanumeric, the underscore (_), or the percent sign (%)
No control characters are allowed; such as linefeeds or tabs
The following characters are not allowed: * ’ ? ; { } [ ] | \ ` ‘ “
Point Source: Identifies the source interface for this tag. Tags coming from FactoryTalk Live Data will be identified with FTLD.
Engineering Units (Eng Units): The Engineering Units field is optional.
Extended Descriptor (Exdesc): The Extended Descriptor field is not used for most FTLD tags. However, for an “Event Triggered Input” tag, this field will store the “event” that triggers the read of this type of tag.
71 of 458
Source Tag: For a standard FTLD “input” tag, the Source Tag field is not used. If a tag is configured as an Output Tag, the Source Tag field identifies the tag that will be used as the source of the data to be output (written) and also acts as a “trigger tag” (the source tag changing triggers a “write” of the source tags value to the destination tag).
Archive Tab:
Typical Value: Documents an example of a reasonable value for this point. For a numeric tag, it must be greater than or equal to the zero, and less than or equal to the zero plus the span.
Zero: Indicates a point’s lowest possible value. Zero does not have to be the same as the instrument zero, but that is usually a logical choice. This attribute is required for all numeric data type points and is critically important for float16 points.
Span: The difference between the top of the range and the bottom of the range. This attribute is required for all numeric data type points. The care with which one should set the Zero and Span attributes depends upon a variety of factors. For example, the Zero and Span affect the very values that are stored in the archive for float16 Historian points. The Zero and Span are used by the Historian Data Archive, various client applications, and some interfaces, as described below.
72 of 458
If the PointType attribute is float16, the Zero and Span attributes determine the maximum and minimum values that can be stored in the Historian Archive for that point. If a value below Zero is sent to the Historian point, the digital state Under Range is written to the Historian point instead of the value. If a value above Zero+Span is sent to the Historian point, then the digital state Over Range is written to the Historian point. The actual value that is stored in the archive for float16 points is a scaled integer between 0 and 32767. For example, if the Zero is 0 and the Span is 100 and a value of 50 is sent to the Historian point, then the value is stored as 16383. If the Zero or Span is changed for the Historian point, then the actual value that is stored in the Archive is not changed, but the scaled value that is displayed will be different.
For point types other than float16, the Zero and Span attributes do not affect the values that are stored in the Archive. Values below Zero and values above Zero+Span can be archived with no problem.
The Zero and Span Attributes should never be changed for digital Historian points. They are set internally by the Historian Server. Changing the Zero and Span for digital points will invalidate the point configuration.
The Zero and Span Attributes affect the displays for some client applications. In HistorianProcessBook for example, one can choose to scale the y-axis of trended data according to the "database." If this option is chosen, then the Zero and Span for the Historian point is used to scale the y-axis.
Some interfaces use the Zero and Span attributes to scale the values that are sent to Historian. This scaling has nothing to do with the scaling of the stored archive values for float16 Historian points that is done by the Historian Archive. One should consult the interface-specific documentation to determine whether any scaling of incoming or outgoing values is performed.
Scan: Interfaces that honor this attribute will not update points whose scan flag is set to OFF.
Archiving: The archiving flag must be set to ON (1) for a point to be archived. This flag can be set to OFF (0) to stop archiving of a point.
73 of 458
Step: The step flag affects only numeric points. It defines how numeric archived values are interpolated. The default behavior, step OFF (0), treats archived values as a continuous signal. Adjacent archived values are linearly interpolated. For example, at 12:00:00, the value 101.0 is archived and at 12:01:00, the value 102.0 is archived. A request for the archive value at 12:00:30 would return 101.5. A step flag of ON (1) treats the archived values discretely. Adjacent archived values are not interpolated; an archived value is assumed constant until the next archived value.
Shutdown: In some cases it is useful to record when the Archive was shut down. That way there is a clear indication of a gap in the data collection. Points may be configured so that Historian will automatically add a shutdown event with the timestamp of the Historian Server shutdown. These events are called shutdown events. The shutdown flag for a point is set to TRUE (1) to indicate that shutdown events should be recorded for this tag. The default is TRUE. For points collected from interfaces on distributed collection nodes, set this flag to FALSE (0) because data buffering will retain the data until the home node is running again. Therefore, there are no data gaps to identify with shutdown events.
Compressing: The compression flag should be set to ON (1) for most points. With compression off, every value sent to the Snapshot is saved in the archive. Compression should be turned on for all real-time points in the system. Compression affects digital points, since a new value is recorded only when the current value changes.
Exception Deviation and Compression Deviation: Exception reporting specifications determine which events the interface sends to Historian and which it discards. These options/features will be discussed in much more detail in a future lesson.
74 of 458
Classic Tab:
Location 1 - 5: The uses of “Location” fields are based on the type of Point Source of a tag. In the case of FTLD Point Sources, the Locations are used as follows:
Location1: Defines the Interface ID (FTLDx, where x is the ID). The DEFAULT is 1, typically used when the Interface is installed on the FTHSE Server. If Interfaces are installed remotely (on non-FTHSE computer, typically on a remote FTView SE and/or RSLinx Enterprise computer), then you would reference that Interface ID (typically 2 or larger).
Location2: Not used
Location3: Tag type
0: Polled or Event Trigger Input point
1: Unsolicited/Advised Input point (default)
2: Output point
75 of 458
Location4: Scan class number (DEFAULT is 1, equates to 1 second scan rate). The scan class number is defined in the Data Collection Interface Properties. This is found in the FactoryTalk Administration Console (FTAC) > System > Connections > Historical Data > Production Historian > FTLD1:
Right-click on Properties and select Scan Classes tab which appears as follows. Note that the below are the “default” scan classes. If you have deleted or added any scan classes to your system, your actual list may appear different.
76 of 458
Location5:
0: Polled from cache (default)
1: Polled from device (only use for event triggered tags)
Instrument Tag: For a standard Polled or Advised Mode FTLD tag, the Instrument Tag field is identifying the actual location from where the data from this tag is coming from. If using “Discover Historian Points…” or “Add Individual Historian Points…” wizards, the contents of the Instrument Tag field will automatically match the name of the tag. However, names of tags can be modified, which often would be desirable. If the name of a tag is modified, the Instrument Tag field would still point to the “actual” source of data, the original tag in the CLX processor, for example. For a tag configured as Output Mode, the Instrument Tag field identifies where the data from the Source Tag is being “written to” (the “destination” of the data transfer).
If Tags are no longer needed: Decommissioning Points: Typically, to decommission a point, you set the Scan attribute to 0 (off): 1. Open SMT and select the PI Server for that point. 2. In the System Management plug-ins list, under Points, choose Point Builder. 3. Search for the point. 4. Click the Archive tab. 5. Under Scan, click Off.
Deleting Points: When you delete a point, you lose all data for that point, so you break any client displays that use the point. Further, once you delete a point, you can't get it back. If you are unsure about the purpose of a point’s existence or about the need for any historical data associated with it, it’s safer to decommission the point rather than deleting it.
77 of 458
Lab 1 – Working with FTH Tags In Excel Before you begin:
Historian and Interface should be configured as per Lesson 1.
The following tags must be added manually to the FactoryTalk Historian server, or imported from file Tags Added in Lesson 1 Labs.xlsx in C:\Class Files\FTH Tags\ on the Client image. The first two Parts of this Lab establish a connection from the Client image to the FactoryTalk Historian Server and then add the PI Tag Configurator add-in to Excel. The tags could be exported from the .xlsx file after Part B. o
RA Foods:RSLE:BL1.Program:Proof_Oven.SimpleMachineStep
o
RA Foods:RSLE:BL1.Program:Proof_Oven.SimpleTempZone1
o
RA Foods:RSLE:BL1.Shift_Timer.ACC
o
RA Foods:RSLE:BL1.StorageDint1
Part A - Configuring CLIENT image to communicate with SERVER 1. Verify that you are on the CLIENT image by checking the hostname on the background image:
2. Launch the AboutPI-SDK:
78 of 458
3. Select Connections.
4. Note that at default the AboutPI-SDK assumes it will be communicating with a Historian server on the same image (computer) that it is installed on.
5. Select Connections > Add Server…
6. Do the following steps: a. Identify the server as SERVER. b. Uncheck Confirm (this is not a “required” step at this point, but when unchecked, instead of connecting as soon as you click OK we will wait for a few more steps before actually testing our connection). c.
Click OK.
79 of 458
7. Right-click on CLIENT and select Remove selected Server (requires Yes response).
8. Click on the SERVER checkbox and verify connection to SERVER without errors. This is working because of the Mappings done in Lesson 1, Lab2, and the fact that Administrator user is the current logged in user on this CLIENT image. Review Lesson 1, Lab 2, for additional information on this topic.
9. Close the PI SDK Utility.
80 of 458
Part B - Adding PI Tag Configurator add-in to Microsoft Excel 2010 FactoryTalk Historian comes with a useful add-in for Microsoft Excel called the PI Tag Configurator. This add-in shows up as the PI-SMT menu in Excel. Using this add-in we can perform bulk tag management tasks such as creation, modification, and even deletion. In this exercise we will be using the PI Tag Configurator to automatically create historian tags as well as to do bulk modifications of tags. 1. Still on the CLIENT image, launch Excel 2010 by selecting Start > All Programs > Microsoft Office > Microsoft Excel 2010. 2. Click File and then select Options:
81 of 458
3. Click Add-Ins and then the Go... button next to "Manage: Excel Add-Ins":
4. Click Browse...
82 of 458
5. Browse to C:\Program Files (x86)\Rockwell Software\FactoryTalk Historian\PIPC\SMT. Select the PITagCnf.xla file and click OK (OK button not shown below):
6. Notice the PI Tag Configurator Add-In listed. Click OK:
7. Select Add-Ins tab (above the spreadsheet area) and you will see the PI-SMT add-in you have just added into Excel:
83 of 458
Part C - Using the PI Tag Configurator Add-In 1. In Excel, open the file BA2 Tags.xls located in C:\Class Files. This is a file that was "imported" from another FactoryTalk Historian Server and we are going to export them into your current Historian Server. Using the PI Tag Configurator in this way demonstrates the capability of “saving” tag configurations if you need to “restore” them later, or, “copying” tags from one FactoryTalk Historian Server and possibly using them later as a basis of tags to create in a different FactoryTalk Historian Server. Note: The text at the top of the columns indicates what information (attribute) is contained in the cells below. Items such as the name of the Tag, if archiving is on or off, when this tag was last changed and by who, settings for Compression (deviation, percent and max), etc., are contained within this spreadsheet.
2. We want to add these tags to the FactoryTalk Historian system for use in a later exercise. Go to the Add-Ins tab and select Export Tags… on the PI-SMT menu.
84 of 458
3. On the Export PI Tags dialog, change to or verify that the Mode is set to Create and then click the OK button.
4. Acknowledge the results dialog by clicking the OK button.
5. These tags will start being collected within a couple of minutes. Create a new workbook to work with by clicking File > New:
85 of 458
6. Select Blank Workbook and then Create.
7. We are going to import into Excel one of the tags that we added to Historian in the previous lab. Go to the Add-Ins tab and select Import Tags… on the PI-SMT menu.
8. Set the Tag Mask to *Temp* and Point Source to FTLD. Note that the Tag Mask includes two asterisks (*) which are “wildcards”. The text Temp (not case sensitive) could be located anywhere in the tag name in this example, as long as Point Source is FTLD (also not case sensitive). Click the OK button
86 of 458
9. Acknowledge the results dialog by clicking the OK button.
10. Note that at this time there is only one tag that meets the criteria of Temp in the name and FTLD Point Source. We want to use the PI Tag Configurator add-in to create additional tags in Historian and edit them as a “group” (rather than one at a time as you might do with a tool called Point Builder in the SMT). Begin by selecting the entire Row 2, right-clicking and selecting Copy.
11. Right-click and drag to select Rows 3, 4 and 5. Right-click and select Paste.
87 of 458
12. Press Esc to get rid of the dotted line around the first row and click an empty cell to “de-select” rows 3-5. You should have four identical rows as follows.
13. The first thing we want to do is configure this spreadsheet so that when you export it the tag you started with will be “edited”, and three new, similar tags will be “created”. In the Tag column, rd th th containing the tag “names”, change the 3 , 4 and 5 tag names as follows (…TempZone2, 3 and 4).
14. Scroll to the right and note that column Y is identified as instrumenttag. There are some syntax differences, but the content is very similar to the default tag names. You can modify tag names, but the instrument tags are critical to “point at” the specific sources of tags, even if you do change nd rd th the tag names in Historian. In this column, make similar changes so that the 2 , 3 and 4 tags are coming from different tags in the controller.
Note: All of the above tags already exist in our SoftLogix controller identified with shortcut BL1 in RSLinx Enterprise. The procedure you are using is another example of how you might add tags to Historian that “come from” or “point to” existing tags in a controller. The other methods you’ve used so far are Add Individual Historian Points and Discover Historian Points, both accessed from the FactoryTalk Administration Console.
88 of 458
15. Now let’s make some changes to some of the other attributes of these tags before exporting. Look at columns S and T. You will learn more about this later in the class, but these columns are storing the amount of Exception Deviation that will be used to potentially filter the tag values between the values coming into the FTLD Interface and the values that the Interface will pass on to the Historian Server Snapshot (considered the “current values” in the Historian). Escdev (exception deviation) is in “units”, where excdevpercent (exception deviation percent) is in “percent of span”. At default, the attribute of span for a tag, which is assumed to be the tag’s “range”, is a value of 100. So, at default with these tags, excdev of 0.25 “matches” the excdevpercent of 0.25%.
16. Just as an example, change the excdev values slightly to 0.26.
17. Now, as mentioned earlier, both excdev and excdevpercent control the amount of Exception Deviation that these tags will use. Very important to realize that the excdevpercent attribute has precedence or would “override” the excdev attribute (one of them would have to override the other since they control the same function). So, in order for our new excdev values to be used, right-click on and delete the entire excdevpercent column (column T).
89 of 458
18. Don’t make any changes, but note that Columns F and G are “similar” attributes for the amount of Compression Deviation, another type of filtering you will learn more about later. In this case as well, compdevpercent would override compdev, so if you wanted to use this worksheet to modify the amount of compdev, you would need to delete the column compdevpercent so it wouldn’t override.
19. One last modification to make in these tags is the step attribute. In our simulated TempZone temperatures, there are times when the values are not changing and when they do they will quickly ramp up. In order to give a trend of this data a more “accurate” representation, turn “on” the step attributes bay changing from 0 to 1. See beginning of this lesson for a more complete description of the step attribute.
Note: We are changing the excdev attribute of these tags to 0.26 and span attribute to 1 for the purposes of this training. In the “real world”, you would need to determine proper settings for these and all other attributes based on the situation. 20. To export these tags to Historian, under Add-Ins, select PI-SMT > Export Tags…
90 of 458
21. Since we are editing one tag and creating three (we started by importing the *TempZone1 tag), be sure to select Mode of Create or Edit. You will get errors if you only say Edit and some of the tags don’t exist yet, or if you say Create and one or more tags already exist. Then, click OK.
22. You should get these results. Click OK.
23. Close Excel and don’t save any workbooks.
Continued…
91 of 458
24. Start System Management Tools (SMT).
25. Do the following steps in this order: a. If not already checked, check the Historian Server named SERVER. b. Select Points > Point Builder. c.
Click the Search button.
92 of 458
26. Do the following steps in this order” a. Enter Tag Mask of *Temp* b. Enter Point Source of FTLD c.
Click Search
d. Note tags TempZone1 through TempZone4 now exists in Historian e. Click Select All f.
Click OK
27. Note that one at a time, each tag can be “selected” by clicking on in the list above, and individual attributes for selected tag appear below with tabs “categorizing” the attributes.
93 of 458
28. Note the Save icon above the list of tags. If you edited any attributes of “selected” tags (don’t at the moment), you would need to be sure and click Save before going to any other tag or your changes will be lost!
29. Select any one of these tags and look at the Archive tab. You should see the two edits we made to each of these tags.
Exception Deviation of 0.26
Step of On
30. Confirm all four of your TempZone tags have the above attributes set to 0.26 and On. 31. Close the SMT.
This lab is complete, but read next few pages for additional information
94 of 458
Changing Tag Names (do not do these steps…read for informational purposes only) Note that many tag names resulting from using the Discover Historian Points… and Add Individual Historian Points… can be very long, including FactoryTalk Application, Area and Server names such as the ones you’ve just been working with in this lab:
If you don’t want to work with these long, somewhat “complex” names, one option available to you is in the SMT Point Builder. By selecting the Rename button, you can rename the tag. All of the data previously archived will still be associated with this tag: For example, in the dialog box below, after clicking the Rename button, the new name of TempZone1 is being given to the tag originally named RA Foods:RSLE:BL1.Program:Proof_Oven.SimpleTempZone1.
If wanting to change many names at once, the Tag Configurator in Excel could be very useful. However, if one attempts to change the names in the tag field and export the tags to Historian as an Edit, there would be errors because the exporting function would be looking for tags with these exact names to already exist.
95 of 458
The example below shows what would happen if tag names were manually changed in Column B and you tried to Edit the tags by exporting. You would get errors because the export feature is thinking these tag names should already exist.
Bulk-changing of tag names in Excel can be done, but what must occur is an inserted column identified as NewTag.
Names entered into that column will be the new names for the tags, and data previously archived will still be associated with those tags.
If a row in that column is left “empty”, that tag name will not be affected.
Continued…
96 of 458
In the following example, notice the NewTag column that has been inserted and the four tags have new, “reduced-length” tag names specified. When exported, all four of these tags were “edited”, all given new (or modified) tag names.
Important to realize that the instrumenttag column, identified as column Z in the below, would remain with the original, “full” tag names. The instrumenttag setting for a tag identifies the actual address and/or location of the data.
Note: If you had time and actually followed this procedure to change your “Temp” tag names, please change them back as the original names will be used in future exercises. Sorry for any inconvenience, but congratulations for your great initiative!
This lesson is complete
97 of 458
This page intentionally left blank
98 of 458
Lesson 3 - Using VantagePoint What you will learn:
Importing Historian Site Edition tags into VantagePoint
Create simple VantagePoint trend using Site Edition data
Create simple VantagePoint Excel report using Site Edition data
View created VantagePoint reports in the VantagePoint Portal
99 of 458
Lab 1 – Using VantagePoint to Visualize Historian Data Before you begin:
FactoryTalk Historian and Interface configured as per Lesson 1
Tags exist in Historian from Lesson 1 and 2, or imported from Tags as of end of Lesson 2 Lab.xlsx file from C:\Class Files\FTH Tags on CLIENT image
Part A – Creating VantagePoint FactoryTalk Connector and Importing Historian Tags 1. Go to the Client image:
2. Select Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Manager.
3. If the first time running the VantagePoint Manager, you may get this message. Click Run.
100 of 458
4. Expand the folders System > Sources. Right-click on FactoryTalk and select New > Item…
5. The FactoryTalk Connector in VantagePoint (the “thing” you are creating) will need a FactoryTalk User that has access to FactoryTalk resources that it needs. You could either “point” to an existing user that has required privileges, or let the below wizard create its own user. Go ahead and create a new user by leaving User name of VantagePoint, specify password of rockwell and click Next.
101 of 458
6. When asked, select Yes, please (very polite software!) and click Finish.
7. Select I would like to import FactoryTalk Historian tags and click Next (Next button not shown below):
8. Check the box for Production Historian and click Next (Next button not shown below):
102 of 458
9. The next dialog is used when importing FactoryTalk Historian Machine Edition (ME) tags. You would need to specify the Historian ME connector in the FactoryTalk Directory (one would need to have been created to communicate with the ME module), RSLinx Enterprise shortcut to the Controller the ME module is reading from, and the slot the Controller is in. We are importing from a FactoryTalk Historian Site Edition server, so just click Finish (not shown below).
10. When tags are imported, you should get following message. Note that you are not really “importing” any data…you are just creating “references” in VantagePoint to the Historian tags, so when VantagePoint is asked to provide a report based on data from Historian tags, it will know where to “find them”. Click OK.
Continued…
103 of 458
11. Go to System > Sources > FactoryTalk > local host > Historians > Production Historian and click on Tags. You will see references to the tags in your Site Edition Server displayed in the pane below. If you scroll down the list you will see the BL1 tags that are in Historian at this time.
12. Close VantagePoint Manager.
Part B – Creating and Publishing a VantagePoint Trend 1. Open FactoryTalk VantagePoint Trend.
104 of 458
2. Again, if first time running Trend you will get the following. Click Run.
3. In the Model tree, go to System > Sources > FactoryTalk > localhost > Historians > Production Historian > Tags and double-click on the …TempZone1 and …TempZone2 tags (one at a time) to add them to the trend display on the right. You could also drag and drop them onto the trend surface.
4. Click the Live Mode and Stack Y-axes tools:
5. You should see the pens on the trend separated, each with their own Y-axes.
105 of 458
6. Select File > Publish.
7. Click on MyEnterprise and select the New Folder icon. Name the new folder MyPlant.
8. Do the following steps:
Create another folder in the MyPlant folder named Reports
With the Reports folder selected, enter report name of MyPlant Oven TempZone Trend
Click Publish
9. Close VantagePoint Trend.
106 of 458
Part C – Creating and Publishing a VantagePoint Excel Report 1. Start Microsoft Excel 2010. 2. Select File > Open and open C:\Class Files\MyPlant Oven TempZone Summary Template.xlsx 3. Click on Sheet2. You will see a partially created report intending to show Minimum, Average and Maximum values of data that needs to be populated on Sheet1.
4. Select Sheet1 and click on cell C3, which has a fill color of red. Click on VantagePoint tab, then Insert.
107 of 458
5. Select History and then Next button (the Next button is not shown below):
6. Do the following steps: a. Go to System > Sources > FactoryTalk > localhost > Historians > Production Historian > Tags b. Click on the …TempZone1 tag and add it to the list on the right with the c.
>
button
Click Next
7. Click Use this Period (Last 5 minutes) and then the Next button (the Next button is not shown below).
108 of 458
8. Do the following steps: a. Click Narrow data format b. Check Skip advanced options c.
Click Next.
9. Uncheck TagName and Quality String, leaving Datetime and Value checked, and then click Finish.
10. Your Sheet1 should be populated with the last 5 minutes of data for the …TempZone1 tag in columns C and D:
109 of 458
11. Click on cell F3 which has a fill color of green and select VantagePoint > Insert.
12. Verify History is selected and click Next. 13. Click New... to select a new tag.
14. Select the …TempZone2 tag, click the > button to move it to the right, and then click Next:
15. Use the Last 5 minutes time period and click Next
110 of 458
16. Do the following steps: a. Select Narrow b. Check Skip advanced options c.
Click Next
17. Uncheck TagName and Quality String and click Finish.
18. You should now see …TempZone2 timestamps and values in columns F and G:
111 of 458
19. Click the Sheet2 tab. Your “template” should be displaying a “summary report” based on data VantagePoint has populated on Sheet1 for the …TempZone1 and …TempZone2 tags.
20. With Sheet2 being displayed, select VantagePoint > Publish.
21. Select A report with no parameters and click Next (the Next button is not shown below):
112 of 458
22. Go to MyEnterprise > MyPlant > Reports and specify name of MyPlant Oven TempZone Summary and click Next.
23. Click Finish and then close Excel 2010. Save the changes to your workbook. 24. Open VantagePoint Portal.
113 of 458
25. Go to Reports > MyEnterprise.
26. Select the MyPlant Oven TempZone Trend report (select Run to run application if asked the first time).
27. Select the MyPlant Oven TempZone Summary report.
28. Close the VantagePoint Portal.
114 of 458
29. Do the following steps: a. Go to the SERVER image. The VantagePoint Server is actually installed on this image. You were accessing the VantagePoint Manger, Trend and Excel reporting functionality from the CLIENT image, but publishing reports to the VantagePoint Server. b. Open the VantagePoint Portal on this image from Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Portal. c.
Select Reports > MyEnterprise.
d. Display your MyPlant Oven TempZone Trend and Excel reports in the VantagePoint Portal on this image.
30. Close VantagePoint Portal.
This lab is complete
115 of 458
This page intentionally left blank
116 of 458
Lesson 4 - Understanding and Using Exception and Compression What you will learn:
Edit exception testing to a tag
Edit compression testing to a tag
Trending and displaying the values of tags from the archives to see the differences caused by exception and compression
Exception Specifications Most Historian interfaces use Exception Specifications to determine whether the raw values that they receive are sent to the Snapshot Subsystem. The interface-specific documentation must be consulted to determine whether or not the interface uses the exception specifications. The exception specifications consist of the following attributes: Attribute Name ExcMin ExcMax ExcDev ExcDevPercent
Point Class Base Base Base Base
Type uint16 uint16 float32 float32
Default Value 0 seconds 600 seconds 1 eng unit 1 % of Span
Limits 0 to 65535 0 to 65535 0 to Span 0 to 100
Note: When adding FTLD points using “Add Individual Historian Points…” or “Discover Historian Points…” from the FactoryTalk Administration Console, the default for ExcDev is .25 engineering units and ExcDevPercent is .25% of Span. ExcMin is the exception minimum time, ExcMax is the exception maximum time, ExcDev is the exception deviation in engineering units, and ExcDevPercent is the exception deviation in units of percent of span. ExcDev and ExcDevPercent are related by ExcDev = ExcDevPercent * Span / 100 where Span is defined by the Span attribute. If either ExcDev or ExcDevPercent is changed, the other is automatically updated to be compatible. If both are changed at once, the change to ExcDevPercent takes precedence.
117 of 458
Raw values from an interface pass the exception test when the following conditions are met. The difference between the new value and the last value that passed exception is greater than ExcDev. and The difference between the timestamp of the new value and the timestamp of the last value that passed exception is greater than ExcMin, where ExcMin has units of seconds. or The difference between the timestamp of the new value and timestamp of the last value that passed exception is greater than ExcMax, where ExcMax has units of seconds. The last value that passed the exception test is called the "old value." The next value that passes the exception test is called the "new value." In between the "old value" and the "new value" there may be several values that are received that do not pass the exception test. The last of these values that are received between the "old value" and "new value" is called the "previous value." There will not be a "previous value" if the interface did not receive a value between the "old value" and the "new value." When a new value passes exception, the "previous value" (if it exists) and the "new value" will be sent to the Snapshot Subsystem. The "new value" will then become the "old value," and the cycle continues. Note that the "previous value" will be sent to Historian even if it was received before ExcMin seconds has expired. ExcMin applies only to the "new value." The time between exceptions can be greater than ExcMax if no new values are received by the interface for a point.
Exception Test Examples
118 of 458
Compression Specifications The compression specifications determine whether events from the Snapshot Subsystem are archived or discarded. If the compressing attribute is set to OFF, then the compression specifications are ignored, and all events that are sent to the Snapshot Subsystem are archived in Historian. The compression specifications are always ignored for digital Historian Points. The compression specifications consist of the following attributes: Attribute Name CompMin CompMax CompDev CompDevPercent
Point Class base base base base
Type uint16 uint16 float32 float32
Default Value 0 seconds 28800 seconds 2 eng units 2 % of Span
Limits 0 to 65535 0 to 65535 0 to Span 0 to 100
Note: When adding points using “Add Individual Historian Points…” or “Discover Historian Points…” from the FactoryTalk Administration Console, the default for CompDev is .5 engineering units and CompDevPercent is .5% of Span. CompMin is the compression minimum time, and CompMax is the compression maximum time. CompDev is the compression deviation in engineering units and CompDevPercent is the compression deviation in units of percent of span. CompDevPercent and CompDev are related by CompDev = CompDevPercent * Span / 100 where Span is defined by the Span attribute of the point. If either CompDev or CompDevPercent is changed, Historian automatically recalculates the other attribute. If both attributes are edited simultaneously, the change to CompDevPercent takes precedence.
119 of 458
Compressing Attribute The compression attribute should be set to ON (1) for most points. When compression is OFF (0), every value that is sent to the Snapshot Subsystem is saved in the Archive. When compression is ON, only the values that deviate significantly from the current trend are archived. See the description of the compression algorithm for more detail. Compression should be turned on for all real-time points in the system. Compression even affects digital points, since a new value is recorded only when the current value changes or when the compression maximum is exceeded. Sampled data, such as laboratory tested data, are typical noncompressed points. Attribute Name Compressing
Point Class Base
Type byte
Default Value ON (1)
Limits OFF (0) or ON (1)
Compression After leaving the Snapshot, events are evaluated according to the compression specifications to see if they are significant events. If so, they are sent to the Event Queue. If not, they are discarded. This process is called compression. There are three instances where an event will bypass the compression process and be put in the Event Queue:
If the Compressing attribute for the point is set to OFF.
If the timestamp is older than the timestamp of the current snapshot. Such an event is sometimes termed "out of order."
If the Status attribute of the Point has changed.
The compression method used by Historian allows Historian to much more data online than conventional scanned systems. The data are also much more detailed than in an archiving system based on averages or periodic samples. The compression method is called "swinging door compression." Swinging door compression discards values that fall on a line connecting values that are recorded in the Archive. When a new value is received by the Snapshot Subsystem, the previous value is recorded only if any of the values since the last recorded value do not fall within the compression deviation blanket. The deviation blanket is a parallelogram extending between the last recorded value and the new value with a width equal to twice the compression deviation specification. Each point has three attributes that comprise the compression specifications: CompDev (compression deviation), CompMin (compression minimum time), and CompMax (compression maximum time). CompDev is half of the width of the deviation blanket (as shown in the illustration). CompDevPercent is similar to CompDev, but it specifies the compression deviation in percent of span rather than in engineering units. Just like exception reporting, compression is a filter. The difference is that the exception specifications determine which events should be sent to Historian, whereas the compression specifications determine which of the events sent to Historian should go into the Archive. CompMin and CompMax are limits that refer to the time between events in the Archive. A new event
120 of 458
is not recorded if the time since the last recorded event is less than the compression minimum time for the point. A new event is always recorded if the time since the last recorded event is greater than or equal to the compression maximum time. The duration of time between archive events can be greater than the compression maximum time. However, if the duration of time between events exceeds the compression maximum time the next event will be archived even if the value is the same as the last event that was archived. One can adjust the compression parameters to produce efficient archive storage without losing significant data. The compression maximum time is usually set to one value for all points in the system. It should be large enough that a point that does not change at all uses very little archive space. A compression maximum time of one work shift (for example, 8 hours) is often a good choice.
Compression Test Examples
121 of 458
122 of 458
123 of 458
Lab 1 – Using Exception and Compression: Before you begin:
FactoryTalk Historian and Interface configured as per Lesson 1
Tags exist in Historian from Lesson 1 and 2, or imported from Tags as of end of Lesson 2 Lab.xlsx file from C:\Class Files\FTH Tags on CLIENT image
VantagePoint configured and Historian tags imported as done in Lesson 3
Part A - Filter Less with Exception/Compression 1. Start on the Client image.
2. Start System Management Tools (SMT) by going to Start > All Programs > Rockwell Software > FactoryTalk Historian SE > System Management Tools 3. Do these steps in this order: a. Select Points > Point Builder b. Search for and display the tag ending in *MachineStep c.
Click on this tag in the upper pane to make sure it has focus
d. Click the Archive tab
4. Note that this tag currently has “default” Exception and Compression attributes, unchanged since you added this tag to Historian from the FactoryTalk Administration Console using Add Individual Historian Points. Verify these attributes are currently set as follows: a. Exception Deviation: 0.25 Eng. Units b. Compressing: On c.
Compression Deviation:0.5 Eng. Units
124 of 458
5. Do the following steps in this order: a. Select Data > Current Values b. Search for and display the tag ending in *MachineStep c.
Click Start Updating
6. Verify that the value of this tag is incrementing from 0 to 5 (0, 1, 2, 3, 4, 5) over approximately a one minute period, then resetting to 0 and incrementing to 5 again, repeatedly. Watch at least one complete “cycle”.
7. Do the following steps in this order: a. Go to Data > Archive Editor b. Search for the tag that ends in *MachineStep c.
Click Get events to get the last two hours of data in the archives for this tag. Note default Start time of *-2h (two hours ago) and End time of * (now).
125 of 458
8. Scroll down the list of Value/Event Time entries. Are you seeing values for this tag of 0, 1, 2, 3, 4 and 5 over and over again? Or, are you seeing "filtered" data "skipping" some of the values such as in the below example, "filtered" by exception and compression? (“skipping” of values is what you should be seeing at this time)
9. This behavior is how this tag's values are archived if using "default" exception and compressions settings. For the purpose of this training, and a more “realistic” set of data for this “step” type of tag, we want to be sure that all changes in this tag's value are archived. 10. Go back to Point Builder for this tag and change attributes as follows: a. Exception Deviation: 0 b. Compression Deviation: 0 c.
Compressing: Off
11. Click the Save icon and verify receiving "Successfully edited point..." message.
12. Wait two minutes to be sure the FTLD Interface has enough time to put your changes in effect. 13. Did you wait two minutes?? If not, wait. If so, go back to Data > Archive Editor. Click the Get events button and scroll to the bottom of your Value - Event Time window. You should be seeing values archived no longer "skipping" or "filtering" data. Be sure to scroll to the bottom…the results we want to see will only be during the last few minutes, not during the majority of the two hours of data being shown. Your most recent data should appear as follows (so “skipping” values):
14. Close the SMT.
126 of 458
Part B - Filter More with Exception/Compression 1. Start on the Client image. 2. Start System Management Tools by going to Start > All Programs > Rockwell Software > FactoryTalk Historian SE > System Management Tools 3. Do the following steps in this order: a. Select Data > Current Values b. Search for and select the tag ending in *TempZone1 c.
Click Start Updating
4. Verify that this tag's value remains "static" (unchanging) for approximately 45 seconds, then changes rapidly for approximately 15 seconds. The value changes from between 65 to around 395 during this time period. This behavior should repeat relatively consistently, creating one minute "cycles".
Continued…
127 of 458
5. In System Management Tools (SMT), do the following steps in this order: a. Go to Data > Archive Editor b. Search for the tag ending in *TempZone1 c.
Change Start time to *-1m to get last one minute of data from archives
d. Click Get events e. Note that in below graphic the window size is reduced so you don't see all values returned, but you should be getting around 14-17 events every minute from the archive for this tag
6. Minimize the SMT and start VantagePoint Trend by going to Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Trend 7. In the Model, navigate to System > Sources > FactoryTalk > localhost > Historians > Production Historian > Tags and double-click on or drag the tag ending in TempZone1 to the plot surface.
8. In the above Trend you should visually be seeing the behavior you noticed earlier, every 45 seconds the tag ranges between 65 and 395 over a 15 second period. 9. Minimize Trend and go back to the SMT.
128 of 458
10. Do the following steps in this order: a. Go to Points > Point Builder b. Search for the tag ending in TempZone1 c.
Click on the Archive tab
11. Note that this tag is currently using default settings from when it was originally brought into Historian with the FactoryTalk Administration Console, although you edited the Exception Deviation to be .26 rather than .25. Current settings should be: a. Exception Deviation: 0.26 b. Compression Deviation: 0.5 12. Change the settings to the following: a. Exception Deviation: 10 b. Compression Deviation: 20 13. Note that these settings are in no way "recommended" or necessarily "typical" settings to be used in any other case except for purposes of this training lab. Your settings should now appear as follows:
14. Click the Save button and look for "Successfully edited" message in the Session Record:
129 of 458
15. Wait for two minutes and then go to Data > Archive Editor in the SMT and click the Get events button. If you closed the SMT you will have to again search for the tag ending in *TempZone1. You should now be seeing only 9-11 events in a one minute period. Earlier you were getting 1417 events.
16. Return to the VantagePoint Trend that you had minimized earlier and review how that previous trend appeared. Click the Refresh button and you should get an updated trend that looks similar to what you had seen before.
130 of 458
17. A key outcome of this lab is that you have seen that by increasing the amount of exception and compression you have cut the amount of data going into the Historian Archive significantly...from approximately 17 values every minute to only 11. And, the overall trend of the data looks similar. Less data stored with similar trend of data over time. 18. Be aware, however, that the amount of data being discarded in this case could be significant in some cases and care needs to be taken not to filter their data with exception and compression "too much". 19. To better visualize the changes that have taken place, right-click on the Trend plot surface and select Properties > Trace:
20. Turn on Point markers and click OK
Continued…
131 of 458
21. See if you can find where the changes you made to your exception/compression took place (you may need to change the trend to “Last 10 minutes”). In the below example, you can see that soon before 1:16:39 PM on 8/6/2012 the changes took place, with less points being archived in the same amount of time. See especially how the filtering reduced the number of points archived during the "ramping down" of the value back to the minimum? Can you find this point in your data?
22. Set the attributes on the TempZone1 tag back to the following: a. Exception Deviation: 0.26 b. Compression Deviation: 0.5 23. Be sure to Save your changes. 24. Close the SMT and Trend applications (no need to save the trend).
This lab is complete
132 of 458
Lesson 5 - FactoryTalk Historian Tag Types What you will learn:
Compare Polled against Advised data collection modes
Use Event tag to read tag’s value based on an "event" or "trigger"
Use Output tag to write a value from within FactoryTalk Historian to “outside” Historian, such as to a CLX controller
133 of 458
Polled Mode Collection
Set location 3 = 0 for polled or event mode
Location 4 stores scan rate
Poll the data source at scan interval
ExcMax setting can ensure data goes to Snapshot even if unchanging
134 of 458
Advised Mode Collection
Set location 3 = 1 for advised mode
Location 4 stores scan rate
ExcMax setting cannot ensure unchanging data will go to Snapshot, as interface would not be receiving updated timestamps from data source (only sent when data changes)
Less network intensive than polled mode at fast scan rates
Event Mode Collection
Set Location 3 = 0 for polled or event mode
Location 4 stores scan rate
ExDesc setting stores “trigger” that will control when the Instrument Tag gets read. Example: EVENT=’tagname’ Increment
As in above example, EVENT must be all in uppercase and the tagname must be within single quotes
Events to select from are Increment, Decrement, Anychange and Nonzero
Location 5 can be used to identify if tag value should be read from RSLinx cache (default), or RSLinx should read direct from the device (0=cache, 1=device)
135 of 458
Output Tags
Set Location 3 = 2 for output tag
Source tag is the tag that acts as a source of data and also the “trigger” (the value changing triggers the write)
Instrument tag is the destination of the value from the Source tag
136 of 458
Lab 1 – FactoryTalk Historian Tag Types Before you begin:
FactoryTalk Historian and Interface configured as per Lesson 1
Tags exist in Historian from end of Lesson 4, or imported from Tags as of end of Lesson 4 Lab.xlsx file from C:\Class Files\FTH Tags on CLIENT image
Part A - Polled versus Advised Collection Modes 1. Start on the Client image. 2. Do the following steps in this order: a. Start System Management Tools from Start > All Programs > Rockwell Software > FactoryTalk Historian SE > System Management Tools b. Go to Data > Archive Editor c.
Search for and display the tag ending in *TempZone1
d. Click Get events to see the last 2 hours of archived data for this tag
3. This tag is remaining relatively "static" or unchanging for 30-45 seconds, and then is changing rapidly for about 15 seconds. Scroll through the list of Value/Timestamps and see if you can see a time where there is a "gap" in changing data. The largest gaps should be between when the tag was “static” at approximately 65 and “jumped” in value. In the below example, there is a 3 second "gap" followed by a 43 second "gap". Try to find similar gap(s) in your data.
137 of 458
4. The reason this tag is currently giving "gaps" in data is that the data is not changing at this time, or, if it is but only slightly, it is being filtered with exception and compression. There are applications where it might be required to archive data at some minimum time interval, whether or not it changes. A Tag Attribute called Exception Deviation Maximum Time (ExcMax) can be used as the first step to achieve this functionality. Do the following steps in this order: a. In System Management Tools, go to Points > Point Builder b. Search for the tag ending in *TempZone1 c.
Go to the Archive Tab
d. Change Compressing to Off e. Change ExcMax to Minutes: 0 and Seconds: 10
5. Click Save icon and look for "Successfully edited point" message. 6. Go to the Classic Tab, and change Location3 from a 1 (Advised Mode) to a 0 (Polled Mode).
7. Save your change. As Polled Mode, the FTLD Interface is asking RSLinx Enterprise for the value of the tag at the tag's Scan Rate. This is currently every one second, determined by the 1 in Location4. The Interface then decides based on the Exception settings, including ExcMax, whether or not to send the value/timestamp to the Historian Server for possible archival (depending on Compression settings). When in Advised Mode, RSLinx Enterprise would never send the value to the Interface, "unless" it had changed since the last time it sent the value/timestamp. So, the Interface would never have a chance to send the value/timestamp to the server when it wasn't changing.
138 of 458
8. Go back to Data > Archive Editor and click Get Events. 9. Scroll down to the bottom of the data and look for value/timestamps such as the below. Even though the tag's value did not change, value/timestamps are archived at least every 10 seconds. Note that when a value "outside" the 10 second window is archived, the "previous value" is archived as well. That is why you should be seeing "pairs" of the same value in the archive, one second apart. The tag was being "polled" every second, and if it didn't change there was a value archived anyway from "outside" the 10 second window, and its previous value that would have been "inside" the 10 second window.
10. When done confirming/observing the above results. so that the archiving functionality of this tag performs similar to the "other" Proof_Oven TempZone tags, change the attributes of the BL1 TempZone1 tag back to the following: a. Change Compressing to On b. Change ExcMax to Minutes: 10 and Seconds: 0 c.
Location3 to a 1
d. Be sure to Save your changes 11. Close the SMT.
Part B - Event Tags 1. Start on the Client image. 2. Start the System Management Tools by going to Start > All Programs > Rockwell Software > FactoryTalk Historian SE > System Management Tools
139 of 458
3. Do these steps in this order: a. Go to Data > Current Values b. Search for and select the tag ending in *Shift_Timer.ACC c.
Click Start Updating
d. Notice the value of this tag changing approximately every second
4. Do the following steps in this order: a. Select Points > Point Builder b. Search for and display tag ending in *Shift_Timer.ACC c.
Click on Classic Tab
140 of 458
5. Location3 is currently set to 1 which is Advised Mode. Location4 is set to 1 which is identifying a 1 second scan class for this tag. Change Location3 to a 0 for Polled/Event collection mode.
6. If you save and "only" made the above change, the tag would be in Polled mode, with the Interface polling RSLinx Enterprise for the value of the tag every second. We actually want this tag to act in Event mode, updating when some "event" or "trigger" occurs. Do these steps in this order: a. Go to the General tab b. In the Exdesc field, enter the following (Note that "EVENT" must be uppercase!): EVENT='RA Foods:RSLE:BL1.Program:Proof_Oven.SimpleMachineStep' Nonzero c.
Note in the above there should be spaces between RA and Foods, and between MachineStep' and Nonzero.
d. Click the Save icon and look for "Successfully edited point" message
7. Go back to Data > Current Values and add the *Proof_Oven.SimpleMachineStep tag to your display and click Start Updating. If it was left in the Start Updating mode, after you add this tag you may need to select Stop Updating and then Start Updating again. You should see that instead of every one second, the value of the Timer.ACC is now updating only when the MachineStep tag changes to anything "except" a zero.
141 of 458
Part C - Output Tags 1. On the Client image, got to System Management Tools (should be open from previous steps) 2. Go to Points > Point Builder and add tag RA Foods:RSLE:BL1.StorageDint1 (be sure you click on to highlight this tag once you've added it to the tag list).
3. On the Classic Tab, change Location3 to a 2, in order to make this an Output Tag. 4. Back on the General Tab, use the Source tag Search button to select the *Shift_Timer.ACC tag.
5. Save your changes. 6. Go back to the Data > Current Values screen where you should be still seeing the value of this Shift_Timer.ACC tag along with the MachineStep tag.
7. To see the actual value of the *StorageDint1 output tag in the controller, start FactoryTalk Data Client by going to Start > All Programs > Rockwell Software > FactoryTalk Tools > Rockwell Software Data Client. 8. Select FactoryTalk and then Network directory. 9. Under $Global, select RA Foods and click OK.
10. Select OK to create Group1.
142 of 458
11. Select BL1 > Online, then StorageDint1 and finally click OK.
12. Position Data Client over the top of System Management Tools (SMT) such as below. Note that when the value of the Shift_Timer.ACC changes (Source Tag), very soon after the StorageDint1 tag (Output Tag) is written to with the same value.
13. When done verifying above, close the SMT and Data Test Client.
This lab is complete
143 of 458
This page intentionally left blank
144 of 458
Lesson 6 - Using Performance Equations and Totalizers What you will learn:
How to use Performance Equations to perform server-side recordable instance and summary calculations.
How to use Totalizers to perform server-side recordable instance and summary calculations.
Performance Equations (PE) Functions In addition to all the basic arithmetic operators, the PE subsystem provides a large number of built-in functions that you can use to perform more complex operations, such as taking the sine or cosine of a point value, taking the average of a tag's value over time, etc. Function Arguments Functions have one or more arguments, or inputs, which are enclosed in parenthesis following the function name. Some of the arguments may be optional. If there are several arguments, they are separated by commas: functionName(argument1, argument2, argument3) The following are examples of function expressions: Max(3, 5, 12.6, 'sinusoid') PrevEvent('sy:arc001', '*-2h') Sqr(Abs(TagMax('tag', 'y', 't'))) Log(if 'tag'=2 then .5 else .2) Functions can also be nested and joined in expressions: Avg(TagVal('TagA', 'y'), TagVal('TagB', 'y'), TagVal('TagC', 'y') ) if TagVal('TagA', '*') < TagVal('TagB', '*') then sin('TagB') else sin('TagA') You can use a tagname in any argument where a number or character string is called for. A tagname in single quotes is evaluated as if it had been written TagVal(tagname), which is the same as TagVal('tagname', '*' ). This gets the point's value at the "current" time for the calculation. If the argument calls for a number, but the point's value is a digital state when the function is evaluated, a run-time error (Calc Failed) is generated.
145 of 458
List of Built-in Functions by “Type” The PE Scheduler provides a wide range of built-in functions that make it easier for you to perform calculations on Historian data. These functions are discussed in detail in the FactoryTalk Historian SE Applications User Guide Math functions Asin Arc sine Acos Arc cosine Atn Arc tangent Atn2 Arc tangent (two arguments) Cos Cosine Cosh Hyperbolic cosine Exp Exponential Log Natural logarithm Log10 Common logarithm Sin Sine Sinh Hyperbolic sine Sqr Square root Tanh Hyperbolic tangent Tan Tangent Other Math Functions Abs Absolute value Float Conversion of string to number Frac Fractional part of number Int Integer part of number Poly Evaluate polynomial Round Round to nearest unit Trunc Truncate to next smaller unit Aggregate Functions Avg Average Max Maximum Median Median selector Min Minimum PStDev Population standard deviation SStDev Sample standard deviation Total Sum Miscellaneous Functions BadVal See if a value is bad (not a number or time) Curve Get value of a curve DigState Get digital state from a string IsDST Test whether a time is in local daylight savings time period IsSet Test if a PI value is annotated, substituted, or questionable StateNo The code number of a digital state TagBad See if a point has an abnormal state PI Archive Retrieval NextEvent Time of a point's next Archive event NextVal Point's next value after a time PrevEvent Time of a point's previous Archive event PrevVal Point's previous value before a time TagVal Point's value at a time
146 of 458
PI Archive Search FindEq Timestamp when point = value FindGE Timestamp when point >= value FindGT Timestamp when point > value FindLE Timestamp when point = value TimeGT Total period when point > value TimeLE Total period when point Current Values b. Search for and display the two “TempZone1” tags c.
Select Start Updating
d. You should see the TempZone 1 Deg C Performance Equation tag display calculated Celsius values from the source …TempZone1 tag’s Fahrenheit values
156 of 458
Part B – Using a Performance Equation Function 1. Go back to Points > Performance Equations and click the New button.
2. Let’s say we need to do maintenance on the Proof Oven when the temperature zones are so many minutes or hours over a certain temperature. In this case, as a “starting point” for such a set of calculations, we will create one Performance Equation to calculate the number of minutes TempZone1 is over 200 degrees in the last hour. First, do the following steps on the General tab: a. Specify name of TempZone1 GT 200 b. Descriptor of Minutes in last hour TempZone1 greater than 200 degrees Fahrenheit c.
Point type Float32
d. Eng Units of Minutes
157 of 458
3. On the Equation tab, do the following steps: a. Enter following Equation (Hint: Use Tag Search button to fill in tag name rather than type in!): TimeGT('RA Foods:RSLE:BL1.Program:Proof_Oven.SimpleTempZone1','*-1h','*',200) /60 b. Click Evaluate. You should be getting a value similar to the below and no errors
Note: The TimeGT (time greater than) function includes the Tag Name, Starttime, Endtime and Value to be greater than in the parentheses that follow. The result is a value in seconds. In the above, we are dividing by 60 to convert seconds to minutes. 4. On the Scheduling tab, select Clock scheduling and Scan class of 3 which will cause the equation to be calculated every 30 seconds.
Note: At this time the Scheduling tab is not “identifying” what actual time period the “3” in Scan class represents. Neither would it if you had entered a “1” or “2”. You will do something later in this lab that will have an effect on this display. 5. On the Archive tab, set the following fields: a. Exception Deviation of 0 b. Compressing Off
158 of 458
6. Click the Save toolbar button and check for a success message in the session record.
7. In the “top window”, click on the TempZone1 GT 200 row to make sure it has focus.
8. Now, we want to open the Performance Equation Scheduling batch file to see where we could edit, add or delete scan classes if desired. Go to the SERVER Image.
9. Start the Interface Configuration Utility (ICU).
10. Click the Create New Interface Instance from .BAT file button
159 of 458
11. Open the pipeschd.bat file located in C:\Program Files\Rockwell Software\FactoryTalk Historian\Server\bin
12. As you can see, this interface is set at default to have three scan classes…1, 2, and 3…at 1 minute, 2 minutes and 30 seconds respectively.
13. Do not make any changes, but note the buttons above the scan class list that would allow you to add, delete and/or reorder the scan classes.
14. Close the ICU without having made any changes.
160 of 458
15. Go back to the CLIENT image that should still have the SMT open on the Performance Equations editor. 16. Close the SMT. 17. Reopen the SMT and do the following steps: a. Go to Points > Performance Equations. b. Click Search (the binoculars icon) to list existing Performance Equation tags. c.
Click on the TempZone1 GT 200 tag.
d. On the Scheduling tab, note you now have a “drop-down list box” to select scan class and the time represented by this scan class is shown. Compare to what you had seen previously in step 4.
Note: This “functionality” exists because of what you did in the ICU on the Server…you created the Performance Equation (PE) Scheduler Interface Instance. We could have done this “before” we created the Clock scheduled tag, but we wanted you to see the “before and after”. From now on, as you create additional PE tags, this functionality will continue.
Continued…
161 of 458
18. Do the following steps: a. Go to Data > Current Values b. Search for and display tag TempZone1 GT 200 c.
Click Start Updating
d. You may see this tag occasionally changing by a small amount. Remember we are only calculating this Performance Equation once every 30 seconds, and the oven temperatures are changing pretty consistently over time in our simulation.
19. Close the SMT.
This lab is complete
162 of 458
Lab 2 - Totalizers Before you begin:
FactoryTalk Historian and Interface configured as per Lesson 1
Tags exist in Historian from end of Lesson 4, or imported from Tags as of end of Lesson 4 Lab.xlsx file from C:\Class Files\FTH Tags on CLIENT image
Part A – Summary Calculation Totalizer Example 1. Verify that you are on the CLIENT image: 2. Launch the System Management Tools (SMT). 3. Select Points > Totalizers and click the New button.
Continued…
163 of 458
4. We will create a Totalizer to calculate the Moving Time Weighted Average of the Temperature of TempZone1. Perhaps in the future all of the zone average temperatures could be calculated and compared for determining maintenance needs, comparing efficiencies, etc. Start by doing the following steps on the Name & Type tab: a. Name of TempZone1 Average Temp b. Source tag of …TempZone1 (see full tag name below) c.
Summary calculation of Moving Time Weighted Average
5. On Sampling tab, specify Whenever a new source tag event occurs (Natural)
6. On the Results tab, do the following: a. Select Write final results After a time period elapses b. Results every 1 Minute c.
Write interim results At source time (ramp)
164 of 458
7. On the Archive tab, do the following: a. Exception Deviation of 0 b. Compressing Off
8. Click Save and look for “Successfully created totalizer…” message 9. Do the following steps: a. Go to Data > Current Values b. Search for and monitor the tags …TempZone1 and TempZone1 Average Temp c.
Click Start Updating
Note: For the first minute or so, the Totalizer tag might contain the text “Configure”. After this first minute (the first “Write final results” time period), the tag should start to update with “interim” values as new values are coming into the Source Tag. If more than a minute has gone by, and the Source Tag updates but the Totalizer remains “Configure”, there may be something wrong in its configuration (please check your previous steps).
165 of 458
Part B – Count Events Totalizer Example 1. In the SMT, go to Points > Totalizers and click the New button.
2. On the Name & Type tab, enter the following: a. Name of BL1 Proof_Oven Machine Cycles b. Source Tag of …MachineStep c.
Count Events
d. Events where value changes e. Block equal to 5 (we want the Totalizer we are creating to keep track of the number of “cycles” the Machine has gone through, and we will consider reaching Step 5 a “cycle”)
166 of 458
3. On the Results tab, verify/set the following: a. Start schedule at 0 Hour(s) after midnight b. Results every 1 Hour. c.
Write interim results At source time (ramp).
Note: These settings will cause the Totalizer to accumulate events every hour on the hour, write “final results” at the end of the hour, reset and start the count again. “Write interim results” set to “At source time (ramp)” will cause interim counts to be collected as they occur as well, the count not collected just at the end of each hour. 4. On Archive tab, set Exception Deviation to 0 and Compressing to Off.
5. Save the Totalizer and look for “Successfully created totalizer…” message.
167 of 458
6. Add the …Machine Cycles and …MachineStep tags to Data > Current Values. Verify Start Updating is selected (may have to Stop and Start Updating again). You should see that every time the MachineStep reaches 5, the Machine Cycles tag increments. If the time on your image is nearing the top of an hour, you should be able to see the Machine Cycles reset. If not happening soon, perhaps you can come back later and watch it occur.
7. When ready to proceed, close the SMT.
This lab is complete
168 of 458
Lesson 7 - Working with Digital States What you will learn:
How to configure a digital state set
How to create a digital tag which uses the new digital state set
Digital State Sets and Digital Tags Digital tags provide the ability to record information about discrete states, such as: running, idle, estop, shutdown. Digital tags cannot be created without assigning them to a digital state set. First, you must use the System Management Tools to create a digital state set. Then, tags can be “assigned” to that digital state set.
169 of 458
Lab 1 – Creating Digital State Sets, Assigning Tags and Displaying States Before you begin:
FactoryTalk Historian and Interface configured as per Lesson 1
Tags exist in Historian from end of Lesson 4, or imported from Tags as of end of Lesson 4 Lab.xlsx file from C:\Class Files\FTH Tags on CLIENT image
VantagePoint configured as per Lesson 3
Part A - Configuring Digital State 1. Verify that you are on the Client image.
2. Launch the System Management Tools (SMT). 3. Expand the Points category and select the Digital States plug-in:
4. In the Digital States plug-in, first click on SERVER at the top of the tree. Once that is selected, click the Add a digital state toolbar button.
170 of 458
5. Type in a name of Machine_State.
6. To the right of the Digital State names, start by clicking in the State Name column. 7. Enter the text Manual.
8. Fill in all the following values. Important: Be sure to press Enter after typing in the last State Name of Failed so the Failed state actually gets entered.
9. Click on the Save toolbar button so that your changes are not lost:
171 of 458
Part B - Create Tag in Historian Using Digital State 1. Open the FactoryTalk Administration Console and select Network directory.
2. Right-click on the application RA Foods and select Add Individual Historian Points…
3. Select Browse Tags…
172 of 458
4. Do the following steps: a. Select RA Foods > BL1 > Online b. Select StorageDint2 tag c.
Click Add Tag(s) to List
d. Click OK
5. Click OK on dialog that follows to add this tag to Historian. 6. Close FactoryTalk Administration Console.
173 of 458
7. Now that you earlier created the Machine_State digital state set, we can create a new digital point that uses the created digital state set. Do the following steps. a. Back to the SMT, select Point Builder b. Search and select the tag ending in *StorageDint2 c.
Select or highlight the tag in the window immediately below the Search button to make sure it has focus
8. Do the following steps: a. In the Name field, overwrite the …StorageDint2 name with a new tag name of Machine1_Current_Status. This will actually create a new tag by this name, and leave the original tag of …StorageDint2 unaffected. Since we “started” with the …StorageDint2 tag in this editor, the …StorageDint2 tag in the SoftLogix controller is still the Instrument tag (on the Classic tab), so the values in that tag will actually be controlling the values in this Machine1_Current_Status tag. b. Set Point type to Digital c.
Select Digital set of Machine_State
9. Click the Save button on the toolbar:
174 of 458
10. Do the following step: a. Select the Data > Current Values tool in the SMT b. Search for and display the Machine1_Current_Status and …StorageDint2 tags c.
Click Start Updating
11. We now will manually change the value of the StorageDint2 tag in the SoftLogix processor to simulate values that will trigger different “States”. Open the Rockwell Software Data Client tool from Start > All Programs > Rockwell Software > FactoryTalk Tools
175 of 458
12. Select Network directory. 13. Select FactoryTalk, $Global > RA Foods and then OK.
14. Click OK on the following dialog:
15. Select the StorageDint2 tag in the BL1 > Online location and click OK:
16. Right-click on the tag and select Write Item(s) > Async Write…
176 of 458
17. Type in a value of 1 and then click OK.
18. Look at the SMT Current Values (be sure you’ve clicked Start Updating). You should see the StorageDint2 tag with a value of 1 and the Machine1_Current_Status of Auto.
19. Experiment with changing the value of the StoreageDint2 tag from 0 to 4. All 5 states you entered in the Machine_State Digital State Set should be able to be displayed. 20. Close System Management Tools and FactoryTalk Administration Console (if still open). Leave the Data Client open.
177 of 458
Part C - Displaying with VantagePoint 1. Open VantagePoint Manager.
2. Go to System > Sources > FactoryTalk > localhost > Historians > Production Historian. 3. Right-click and select Synchronize:
NOTE: We are synchronizing the Historian connection because we have added tags to Historian since the connector was created and/or last synchronized. 4. Close the Import successfully completed dialog and VantagePoint Manager. 5. Open Microsoft Excel and click on cell C3:
178 of 458
6. Select the VantagePoint tab and Insert function:
7. Select History and Next (Next button not shown below):
8. Do these steps: a. Go to System > Sources > FactoryTalk > localhost > Historians and expand Production Historian b. Under Production Historian select Tags c.
Click on the Machine1_Current_Status tag
d. Click the > button to move to the right e. Click Next
179 of 458
9. Select Last 20 minutes and click Next:
10. Select Skip advanced options and Click Finish.
11. Your Timestamp entries will be different, and maybe what states you've selected, but you should be seeing that last 20 minutes of "states" displayed in the Excel spreadsheet:
12. Close Excel. No need to save the spreadsheet unless you’d like to. 13. Close any other open applications.
This lab is complete
180 of 458
Lesson 8 - Configuring Event Framing and Using BatchView What you will learn:
Configure PIBaGen to populate batches
Configure a BatchView Group in ProcessBook
Compare a sub-batch phase against a golden batch
This lesson covers creating a PIUNIT in the module database. It can be configured to work with PIBaGen. The batch counter can be used as the batch active and batch label tag. The phase counter will be used as a sub-batch id and label. The PIBaGen service may need to be manually started.
Reference The PI Batch Generator Interface (PIBaGen) collects data from the Historian Server (from the Historian Data Archive and the PI Module Database), generates batch data and writes the batch data to the Historian Server in the Batch Database. PIBaGen is used when there is no native interface to generate and store batch data in the PI System. PIBaGen automatically generates PIUnitBatches, Batches and Sub Batches for each PIUnit that is configured and registered. The generated batch information can be accessed using tools like BatchView and PI Batch Database Editor. This interface is not UniInt based and does not support any Failover. It only populates the PI Batch Database based on PI Events and does populates only one PI Point which represents the status of the interface. A PIUnit represents a piece of equipment in which a product is processed in batches. The Aliases of the PIUnit define the PI Points associated with the equipment. Each time a product is processed through a PIUnit, a PIUnitBatch is created. Since there can be only one batch processed in a piece of equipment at any time, there can be only one PIUnitBatch associated with a PIUnit at any time A PIUnitBatch is the data object that encapsulates one ISA S88 concept of a batch. Here is the definition from S88: “The material that is being produced or that has been produced by a single execution of a batch process.” PIBaGen recognizes the start and end of the processing in a PIUnit, and therefore the start and end of the PIUnitBatch, by changes in values of a PI Point known as “Active Point.” Starting a PIUnitBatch includes writing the start time and other properties of PIUnitBatch like Batch ID, procedure name, product name etc., to the PI Batch Database. PIBaGen optionally also adds the PIUnitBatch to the collection of PIUnitBatches under an object called Batch.
181 of 458
A Batch is used to record the production of a specific “Batch”; in practice this usually involves one or more PIUnitBatches in one or more PI Units (one or more pieces of equipment). A Batch allows collecting related PIUnitBatches. All the Batches and properties associated with Batches, like Product Name, Batch Recipe, etc., are stored in the PI Batch Database. The SubBatch information is also written to the PI Batch Database by the PIBaGen interface. A SubBatch is a definable portion of a PIUnitBatch and is always associated with a PIUnitBatch. The start and end time for each of these definable portions is determined by a separate Active Point called “SubBatch Active Point.” Examples of S88 Sub-batches are Operations and Phases. Every SubBatch has a name, a Heading and a collection of Sub Batches associated with it. The SubBatch collection allows for a hierarchy of Sub Batches. Specifying the PI Points for Active Points and all other properties of Batches, PIUnitBatches and Sub Batches is called the “PIUnit Configuration.” PIUnit configuration is stored as Aliases and Properties in the PI Module Database. The creation and configuration of the PIUnit is done using the PI Batch Generator Plug-in for PI SMT.
Reference Manual
PI Batch Generator (PIBaGen) Interface to the PI System (.doc file), found on Historian Server install at C:\Program Files (x86)\Rockwell Software\FactoryTalk Historian\PIPC\Interfaces\PIBaGen
BatchView User Guide (PIBatchView.chm file), found on computer (image) when BatchView is installed at C:\Program Files (x86)\Rockwell Software\FactoryTalk Historian\PIPC\Help
182 of 458
Lab 1 – Using FactoryTalk Historian Event Framing and BatchView Before you begin:
FactoryTalk Historian and Interface configured as per Lesson 1
Tags exist in Historian from end of Lesson 7, or imported from Tags as of end of Lesson 7 Lab.xlsx file from C:\Class Files\FTH Tags on CLIENT image
Part A – MDB to AF Preparation Wizard The Module Database (MDB) Editor is a tool for working with the content in the Module Database on a FactoryTalk Historian Server. Each Historian Server includes a PI Module Database (MDB). The MDB stores information in a hierarchy that you can use to organize and classify resources according to your organization's needs. For example, you can store and view equipment type, office location, buildings names, and so on. You can also use the Module Database as a central registry for several Historian applications' settings, including ACE, ICU and BatchView. Future development plans are to replace MDB with Asset Framework (AF). Over time, MDB applications will be transitioned to be AF applications. New client applications will support AF only. In order to provide backward compatibility, the current product migrates everything in the Module Database to AF and then keeps the objects synchronized. This allows MDB-based clients to access the objects through MDB and AF clients to access the same objects through AF. Note that some key functionality of MDB and AF is “modeling” of equipment, machines, assets, etc. Rockwell Automation recommends using FactoryTalk VantagePoint for this type of modeling and asset organization.
1. Verify that you are on the SERVER image::
2. Select Start > All Programs > Rockwell Software > FactoryTalk Historian SE > MDB to AF Preparation Wizard
183 of 458
3. Read the Welcome dialog and click Next.
4. Do the following steps: a. Click Analyze. b. Verify …no issues found… message appears. c.
Click Next (Next button not shown below).
5. Click the AF Server Connect button.
6. Click the AF Database Browse button.
184 of 458
7. Click New Database.
8. Accept default name of Database1 and click OK.
9. First, click on the Database1 row to highlight (select), then click OK.
10. Click Next.
185 of 458
11. Read this message and click Yes.
12. Click Finish on below dialog and Congratulations!
13. Stop Historian by selecting Start > All Programs > FactoryTalk Historian SE > Stop FactoryTalk Historian SE
14. Wait patiently for all services to stop and command prompt to close.
186 of 458
15. Only after all services have stopped and dialog closes, select Start FactoryTalk Historian SE.
16. Only after all services have started and command prompt closes, start the SMT.
187 of 458
17. Go to Operation > MDB to AF Synchronization and verify green (good) indicator and Current Status of InSync.
18. Close the SMT.
Part B - Configuring PIBaGen 1. Verify that you are on the SERVER image.
2. Launch the Interface Configuration Utility (ICU).
188 of 458
3. Click the Import Existing Interface from .BAT file toolbar button.
4. Navigate to the PIBaGen subdirectory location: C:\Program Files (x86)\Rockwell Software\FactoryTalk Historian\PIPC\Interfaces\PIBaGen (be sure you are in (x86) version of Program Files!) 5. Open the file named PIBaGen.bat.
6. The Interface will be named: PIBaGen. 7. Change the type from none to other_non_uniint.
8. From the ICU toolbar click Save.
9. Click Yes to continue when warned that no point source has been specified.
189 of 458
10. In the Service area, set Startup Type to Auto and click the Apply button. Click Yes if you get the message “Do you wish to proceed without specifying a Point Source?”
11. Click the Start button on the toolbar. Click Yes if asked “Do you wish to proceed with interface startup without defining scan classes?”
12. Go to Start > All Programs > Administrative Tools > Services and check that the newly created PIBaGen service is Started (look for PI Batch Generator Interface).
13. Close the Services dialog and close the ICU.
190 of 458
14. Use Windows Explorer to navigate to the directory C:\Program Files\Rockwell Software\FactoryTalk Historian\Server\adm. Look closely for these three files which you will edit in the following steps.
pisitestart.bat
pisrvsitestart.bat
pisrvsitestop.bat
15. Right-click on pisitestart.bat and select Edit from the context menu. 16. Remove the rem statements from in front of the PI-Batch Generator Interface block (7 total lines near the bottom of this bat file – need to scroll down).
17. Save the file and Close Notepad. 18. Right-click on pisrvsitestart.bat and select Edit from the context menu. 19. Remove the rem statement from in front of net start pibagen.
20. Save the file and Close Notepad. 21. Right-click on pisrvsitestop.bat and select Edit from the context menu.
191 of 458
22. Remove the REM statement from in front of net stop pibagen.
23. Save and Close Notepad. 24. Close Windows Explorer.
Part C - Create a new PIUnit 1. Still on the SERVER image, launch the System Management Tools (SMT).
192 of 458
2. Do the following steps: a. Expand the Operation category and select Module Database. b. Under SERVER, right-click on Modules and select New
3. Name the Module BL1 (for Bread Line 1) and click OK (not shown).
4. Right-click on BL1 module and select New > PIUnit.
Ste 5. Enter Proof_Oven into the Module Name field and click OK (not shown).
193 of 458
6. Assign an alias to the Proof_Oven PIUnit…right-click on Proof_Oven and create a new Alias.
7. Enter TempZone1 into the Alias Name field and map it to the PI Server named SERVER and tag ending in …TempZone1 (use the Search button), and click OK.
8. Your Module Database should appear as follows:
Note: In the Module Database you have now created a structure to represent our application of a BreadLine 1 with a Proof_Oven and a temperature of TempZone1 to be monitored. We are working towards keeping track of Events where batches of product enter the Proof_Oven and the temperature of TempZone1 is kept track of for each event or “batch” of product. Next, you will add a tag to Historian in order to keep track of the event name, start and stop times. 9. Launch the FactoryTalk Administration Console (Start > All Programs > Rockwell Software > FactoryTalk Administration Console). 10. Click Network directory and OK.
194 of 458
11. In the FactoryTalk Administration Console, right-click RA Foods and click Add Individual Historian Points…
12. Select Browse Tags…
Continued…
195 of 458
13. Do the following steps: a. Browse RA Foods > BL1 > Online > Program:Proof_Oven > SimpleBatchID (full path or tree not able to be shown below) b. Select the tag SimpleBatchID on the right. c.
Click Add Tags(s) to List and the selected tag will be displayed in the lower window.
d. Click OK.
14. When you click OK on the above dialog, your screen should have the tag listed such as follows. Click OK on this dialog (OK button not shown).
15. Close Administration Console and switch back to System Management Tools (SMT).
196 of 458
16. Do the following steps: a. Expand the Batch category and select Batch Generator. b. Select SERVER in the middle pane under Registered Units Only tab (see below graphic). c.
Select the Interface tab in the right pane.
d. Set the Configuration Module Name to PIBaGen. e. In the middle pane, click the Save toolbar button.
17. Switch to the MDB View tab and click on the Proof_Oven PIUnit (SERVER > BL1 section).
197 of 458
18. Using Batch Generator, the right hand configuration view, select the PIUnitBatches tab and configure the following: a. Set the Active Point to use the …SimpleBatchID tag (use Browse button). b. ActivePoint Behavior of Pulse. c.
Strings indicating zeroth state of NOBATCHACT.
d. Set Unit Batch ID Point to use the same …SimpleBatchID tag. e. Change the Recovery Option to Do not recover anything.
Note: In the simulation running in the SoftLogix controller, a new “BatchID” is being created at the start of every “cycle” of machine steps. As you have seen in other labs, the machine steps increment 0, 1, 2, 3, 4 and 5, then reset to zero and start over again. When reset to zero, the BatchID value goes to “NOBATCHACT” until incrementing to step 1. In the above dialog, the BatchID being equal to NOBATCHACT is the indication of the end of one batch (or event) and the beginning of another.
198 of 458
Select the PISubBatches tab, right-click on SubBatch Hierarchy and click Add New SubBatch.
19. Do the following steps: a. Name the SubBatch OvenSteps. b. Set the Active Point to use the …SimpleMachineStep tag c.
ActivePoint Behavior to use Step and Include zeroth state.
d. Set SubBatch Name Point to Use ActivePoint value
199 of 458
20. Do the following steps: a. In the Batch Generator MDB View tab, click the Save icon. b. The PiBaGen interface will not monitor a PIUnit and generate batch data if the PIUnit is not registered. Registering a PIUnit is like turning the scan option ON for a Historian Tag or Point. Right-click on the Proof_Oven PIUnit and select Register.
21. Do the following steps: a. Click on Batch Database (see below graphic). b. Expand the tree until you can see the Proof_Oven unit in the center window. c.
Right-click Proof_Oven and select Search for PIUnitBatch…
200 of 458
22. Ensure that the PIUnitBatch search PIUnit field is populated with \\SERVER\BL1\Proof_Oven. If not, enter Proof_Oven. Note: if you starting the search from the top of the Batch database tree, then the PIUnit field would contain an ‘*’. Need to replace this with Proof_Oven. 23. Click OK.
Continued…
201 of 458
24. Expand the Batch database search results and verify that Unit Batches are being created by PIBaGen. 25. In the following example, there are 7 Unit Batches. The last unit batch in the list (M1Mix_3246) has PISubBatches 1 finished and 2 still running (you can tell because it is selected and on the right you see End Time is "Still Running"...finished SubBatches would have both Start and End times specified). If you do not see a “tree” with a “plus sign” (+) when you searched for PIUnitBatch, you may need to wait a minute or two and search again. Multiple search results will appear in the same window.
Note: Up to this point you have created a PIUnit and Historian is monitoring and archiving Batch or Event information. The Batch information you have configured is information such as:
What triggers the start and end of a Batch and Sub Batches – their "Active Points"
Where the value of the Batch ID will come from - the "Unit Batch ID Point"
A tag’s value to monitor during the Batch cycles, the "TempZone1 Alias" that you created within the PIUnit
You have also seen how to monitor basic information of the Batches and Sub Batches, such as Batch IDs and Start and End Times, from within the SMT. In the next section you will see how a BatchView add-on can be used to monitor batch information from within a ProcessBook display.
26. Close the SMT and Administration Console (if still open).
202 of 458
Part D - BatchView In this exercise, you are going to be looking at a couple of ways to visualize the batch information being generated by the results of the previous exercise, You will configure a simple BatchView Group trend of the batches in absolute time view. Then switch to a relative view and pick a batch to represent a golden batch. Align a phase of the golden batch for comparison against other sub-batches 1. Go to the CLIENT image.
2. The following steps will build a basic ProcessBook display for our BatchView. Launch ProcessBook.
3. Close the ProcessBook demo file that opens at default.
203 of 458
4. From the File menu select New.
5. Select new ProcessBook Display (.pdi) File, set the Display Name to BatchView, and click OK.
6. Change to build mode by selecting the Build button on the toolbar:
7. Select the Batch Group button on the toolbar:
8. Click and drag a Batch Group into the empty space which covers most of the work area.
204 of 458
9. In the Search Parameters area, change the following: a. Unit Name parameter from * to Proof_Oven b. Time Range and Duration to Between: *-10m and * 10. Click the Search button.
11. From the Available Aliases pane at the bottom of the Batch group definition dialog, select the TempZone1 alias and click the Add Alias -> button.
205 of 458
12. Select the Layout tab. 13. From the Visible Symbols pane, check the Results check box.
14. Select the Settings tab and from the Plot Time pane, set the Absolute radio-button. Then, click OK (OK button not shown).
15. Click OK. The display may take a moment to retrieve all the data. 16. When the display appears, select the Run button on the ProcessBook toolbar (it may automatically be selected). If you wish to resize the Batch object, you need to go to Build Mode (hammer icon) and then back to Run Mode once you are ready to view the batch information.
17. All the batches active during the last ten minutes are displayed in absolute time from the start of the first batch to the end of the last batch. Note: The most recently completed batch is dark red, while the still in-process batches are light green. The TempZone1 alias is the same color as the batch that it corresponds with.
206 of 458
18. In the Results Panel, select a Unit Batch and click the
symbol to show the Sub-Batches.
19. In the Batch Gantt Panel (upper right) select a Unit Batch show the Sub-Batches.
and click the
20. To display precise time information of a unit batch, right-clicking on Unit Batch the context menu select Properties…
21. Close the Properties dialog.
207 of 458
symbol to
and from
22. Change back to build mode by selecting the Build tool on the ProcessBook toolbar.
23. Double-click on the Batch Group object. 24. Select the Settings tab. 25. From the Plot Time pane, set the Relative - Start and End Time radio-button. Enter an Offset value of -60s for the Start time. Click OK (OK button not shown).
26. Select the Run button on the ProcessBook toolbar.
Note: The unit batches are aligned based on their start time. Times along the x-axis are now seconds into the batch. You should be able to see if some batches took slightly longer (or less time) than others.
208 of 458
27. Pick a Unit Batch that you would like to be the Golden Batch. 28. Click in the Anchor column
symbol in the results pane for that Unit Batch.
29. The batch turns yellow to indicate it is the Golden Batch. The batch will be prevented from expiring from the search results.
30. Select the Golden Batch in the Batch Gantt chart on the right, and then click the show the SubBatches.
symbol to
31. Suppose the 3rd phase of the unit batch is particularly critical for the process, you can align all the unit batches based on their 3rd phase of the golden batch. 32. Right-click on the 3rd phase of the golden batch and select Align to every PIUnitBatch\3 from the context-menu.
33. Expand some of the SubBatches and compare the 3rd phase against that of the golden batch.
34. Experiment with the Batch Group object as you wish. When done, close ProcessBook.
This lab is complete 209 of 458
This page intentionally left blank
210 of 458
Lesson 9 - Using Health Points and Performance Monitor Tags What you will learn:
Configure and use FactoryTalk Live Data (FTLD) Interface Health Points
Use FactoryTalk Historian Server Performance Monitor Tags
FTLD Interface Health Points A FactoryTalk Live Data Interface can have up to 64 Health Points created to monitor “health” of the Interface. In the lab this lesson, you will create the FTLD interface’s health points and review information available via these points (or tags). These points will give you a view into how long various functions of the interface are taking and/or provide other information. Note: Be aware that these points do not exist at default and if you create one or more of them they are considered Rockwell tags in your FactoryTalk Historian server. So, they count against your Rockwell Data Point license(s).
Historian Server Performance Monitor FactoryTalk Historian v2.1 (and later) includes 140 Performance Tags for monitoring the system's performance at no additional cost. Performance tags provide insights into a number of performance management problems, including memory, disk, and process management problems. For more information on these tags, refer to the Performance Monitor Interface to the PI System manual (PI_PerfMon.doc) on a computer (image) where FactoryTalk Historian Server is installed (in Program Files (x86) > Rockwell Software > FactoryTalk Historian > PIPC > Interfaces > PIPerfMon).
211 of 458
Lab 1 – Using FTLD Health Points and Historian Server Performance Monitor Tags Before you begin:
FactoryTalk Historian and Interface configured as per Lesson 1
1. Go to the DATA image:
2. Launch the Interface Configuration Utility (ICU):
3. Select the FTLD1 interface from the drop-down box. 4. Select the Health Points sub-category under UniInt in the left pane.
212 of 458
5. Right-click on one of the points and select Create All from the context-menu.
Note: None of these points exist at default and if you create one or more of them they are considered Rockwell tags in your FactoryTalk Historian server. So, they count against your Rockwell Data Point license(s). 6. The status of all health points should indicate Created.
7. Close the Interface Configuration Utility (ICU). 8. Launch the System Management Tools (SMT).
213 of 458
9. Do the following steps: a. Select SERVER if not already selected. b. Go to Data > Current Values. c.
Click Search.
10. Do the following steps: a. Enter a Tag Mask of sy* and then click the Search button. b. Click the Select All button. c.
Click OK.
214 of 458
11. Click on the Start Updating toolbar button.
12. Observe the Current Values for each FTLD Health Point. Be aware of the following items:
Not shown below, but if you scroll to the right (if your window is not wide enough) you should see Engineering Units and Descriptor for each of the Health Points.
Initially, several tags may show “Pt Created” and will stay that way until something causes the tag values to change. Restarting the Interface could cause at least some of these to update.
Additional information on Health Points can be found in UnInt Interface User Manual on FactoryTalk Historian Server computer (image) at Program Files (x86) > Rockwell Software > FactoryTalk Historian > PIPC > Interfaces > UniInt.
13. Still in the SMT, click the Remove All button (this is not “deleting” any tags, just removing them from the Current Values display).
14. Click Search button
Continued…
215 of 458
15. Do the following steps: a. Set Tag Mask back to * (wildcard – no filtering of tag names). b. Set Point Source to # (symbol for Performance Monitor Tag Point Source). c.
Click Search.
d. Click Select All. e. Click OK.
16. Click Start Updating.
17. Scan through list of Performance Monitor tags and their values. Note that it might be useful to display these tags in a Historian Client like FactoryTalk VantagePoint. You could also send them to a Controller or HMI via the use of Output tags. These tags DO NOT count towards your Rockwell Data Point license(s). 18. For more information on these tags, you could refer to the Performance Monitor Interface to the PI System manual (PI_PerfMon.doc) on a computer (image) where FactoryTalk Historian Server is installed (Program Files (x86) > Rockwell Software > FactoryTalk Historian > PIPC > Interfaces > PIPerfMon). 19. Close the SMT.
This lab is complete
216 of 458
Lesson 10 - Using and Displaying Audit Information What you will learn:
Use SMT to enable auditing of your PI Server
Use AuditViewer to examine activity
Historian Audit Database The Historian Audit Database records the data that is added, edited, or removed from specific Historian Server database files, as well as other events or changes to configuration that occur in the Historian Server. The Historian Audit Database satisfies FDA Title 21 CFR Part 11 auditing requirements. In addition to methods described in the Auditing the FactoryTalk Historian SE Server User’s Guide you can use to store, export, and review audit records, Rockwell Automation provides the Historian AuditViewer utility, which enables you to view and manage Audit Database records. Historian AuditViewer is available as a separate package with its own documentation.
Principles of Operation The Historian Audit Database contains records of changes made to Historian Server data. The following changes are recorded:
Editing and deleting time-series data, such as values in the Historian Archive.
Creating, deleting, and editing configuration information on time-series data. Examples include Historian point configuration data and access permissions for secure objects within the Historian Server.
The Historian Audit Database consists of three distinct files. Each file represents a Historian Subsystem:
Base Subsystem: pibasessAudit.dat
Archive Subsystem: piarchssAudit.dat
Snapshot Subsystem: pisnapssAudit.dat
All files for the online Audit Database are stored in the PI\log directory of the Historian Server.
217 of 458
Use Historian AuditViewer to Manage Historian Audit Records Historian AuditViewer is a Microsoft Windows-based application that allows you to view records from the Audit Database, select them, examine them, print them, or export them to a new file.
Note: Historian AuditViewer satisfies the Title 21 CFR Part 11 FDA regulatory requirements for generating accurate and complete copies of Audit Records in both human-readable and electronic form suitable for inspection, review, and copy. Historian AuditViewer allows you to search for and view audit records in the Historian Audit Database. It is an essential tool for analyzing and validating a FactoryTalk Historian System for compliance with an implementation of cGMP (Current Good Manufacturing Practice regulations enforced by the US Food and Drug Administration (FDA)). It facilitates the generation of selected reports in Windows file formats, to comply with FDA audit requests. Because AuditViewer can change auditing status and control the execution of FactoryTalk Historian System processes, certain restrictions are in place:
AuditViewer must run on the same computer as the Historian Server.
The user must be a member of the Windows Administrator User Group.
For FactoryTalk Historian 3.0 and later, the user must have read access to the PIAUDIT entry in the Historian DBSecurity table and read/write access to the PITUNING entry. For earlier versions of the Historian Server, the user must log on to the Historian Server as the piadmin user.
References:
Auditing the FactoryTalk Historian SE Server User’s Guide
AuditViewer Help
218 of 458
Note: This lesson uses AuditViewer to display audit information. This tool is not installed automatically, but included in Redist/AuditViewer in Historian 3.0 install media and/or downloaded from Knowledgebase article 64384 - FactoryTalk Historian Site Edition AuditViewer Also note that Audit Viewer has already been installed on the SERVER image.
219 of 458
Lab 1 – Auditing FactoryTalk Historian Before you begin:
FactoryTalk Historian and Interface configured as per Lesson 1
Part A - Enable Auditing of your PI Server 1. Go to the SERVER image:
2. Launch the System Management Tools (SMT).
220 of 458
3. Do the following steps: a. Expand the Operations category and select Tuning Parameters. b. Click the EnableAudit Tuning Parameter.
Note: The Auditing Mask entered value is a bit mask where each bit refers to a specific database. -1 enables the audit of all databases. Masked parameter (Point:1, Digital Sets:2, Attribute Sets:4, Point Class:16, User:32, Group:64, Trust:128, Module:256, Heading:512, TransferRecord:1024, Campaign:2048, Batch:4096, UnitBatch:8192, Server:16384, Collective:32768, Identity:65536, Identity Mapping:131072, Snapshot:268435456, Archive:536870912, DBsecurity:1073741824) Value units are in bitmask. Parameter takes effect at startup only.
221 of 458
4. Double-click on EnableAudit to display the properties window. Change the auditing Value to -1 and click OK
5. Close the SMT. 6. For the auditing entered value to take effect, FactoryTalk Historian must be stopped and restarted. Select Start > All Programs > Rockwell Software > FactoryTalk Historian SE > Stop FactoryTalk Historian SE. Wait for all services to stop and window to close.
222 of 458
7. Once all of the services have stopped and window has closed, select Start > All Programs > Rockwell Software > FactoryTalk Historian SE > Start FactoryTalk Historian SE. Wait for all services to start and window to close.
Part B - Make Changes and Use Audit Viewer to Examine the Activity With auditing enabled the audit database mechanism reports changes to all subsystems, all data added, edited or removed from the system including database configuration changes. In this exercise, you are going to substitute a tag value in the archive and also edit an attribute of a tag and view the change in the FactoryTalk Historian AuditViewer. 1. Open the SMT, expand the Data category and select Archive Editor.
223 of 458
2. From the archive editor, you need to search/select the tag value you wish to view/modify. Use the search button to select the tag BA:TEMP.1. The archive editor will display data for the time period specified in the lower window. Note you are displaying the last two hours of values in the archive at default (Start Time of *-2h and End Time of *)
Note: In our original configuration of Historian with the images you are using, we made our Administrator user a member of two Windows Groups that we then mapped to FTHAdministrators and FTHEngineers Groups in Historian. Be aware that there is also a Historian Group named FTHSupervisors. This is the only group that can edit archived values of FTLD tags. In this lab you are about to edit an archived value of an “internal” or “test” Historian tag (BA:TEMP.1). If you were going to edit the value of an FTLD tag, your logged in user would have to be mapped to the FTHSupervisors group, otherwise you would get an error and not be able to edit the value.
224 of 458
3. Scroll down “part-way” through the data so that you are not looking at the “beginning” of the last two hours of data. Otherwise, when you later look for your edits you might have to look “further back” than the last two hours you are currently displaying. From the archive editor select the value you want to change and note its date/timestamp (write it down). Type a new value (modified value of 99 in below example), press Enter, then click the Save icon . The modified value will be displayed and marked as substituted (scroll to your date/timestamp and look for checkmark in Substituted column after these steps).
225 of 458
4. Do the following steps: a. Go to Points > Point Builder b. Search for tag BA:LEVEL.1 c.
Go to Archive Tab
d. Change Span to 101
5. Save changes by clicking the Save icon and look for success message:
226 of 458
6. From the SMT Tools menu select Audit Viewer… to launch the application.
7. From the AuditViewer expand the Manage section. Verify the Archive 0 checkbox is checked (if not, check it) and then click the Manage link 8. Double-click the Archive 0 icon on the right to display the subsystems file details.
227 of 458
9. From the subsystem details page scan each of the files in turn by selecting the Scan File button from each of the three subsystem views. Do all three (only two shown below).
10. Confirm that the records are updated with current date/time (will not match below).
228 of 458
11. You can also view this in table form. Above the three Subsystems listed select the Table tab.
229 of 458
12. Change the search “Start Time” to past 5 minutes by specifying *-5m 13. Select Search to display and audit records for the time period specified. Note: If you don't see records, perhaps more than 5 minutes have gone by since your changes. Try Start Time of *-10m in that case.
14. To view more detailed information, click the + symbols on the entries. This will display detailed information about the tag attribute old and new value, modified archived values, etc. You should see entries such as: Configuration (Base) tab:
Timeseries (Snapshot/Archive) tab:
15. As time allows, make other FactoryTalk Historian edits/changes and detect them with Audit Viewer. 16. Close Audit Viewer and the SMT.
This lab is complete
230 of 458
Lesson 11 - Using Archive Management Tools What you will learn:
Create various sized archive files and register/unregister archives.
Managing archives in FactoryTalk Historian is a straight-forward task. You can use the Archives plug-in for SMT to create, register, and unregister most archives. If you want to create new archives smaller than your primary archive, you need to use the pi command line utilities which can sometimes be helpful in testing environments.
Three Archive files are created at default, each 128 MB in size.
231 of 458
An “Archive Shift” occurs automatically when an archive file becomes approximately 99% full. When an “Archive Shift” occurs, either a new archive file will be created or an existing file will be used. This is controlled by a Tuning Parameter called Archive_AutoArchiveFileRoot.
If there is a valid path specified in the Archive_AutoArchiveFileRoot parameter (path must exist), a new archive file will be created when an archive shift occurs. If the “Value” (path) in this parameter is empty or blank, when a file shift occurs an existing file will be used. The archive file must already exist and be registered in the FactoryTalk Historian Server. The selection of the specific file that will be used is:
If more than one empty archive files exists, the most recently created archive file will be used.
232 of 458
If there are no empty archive files, the oldest full file will be used. The archived data already in this file will be erased and new archive data be written to it.
Note: Differences in Archives from prior versions of FactoryTalk Historian The default archive file location has changed (the PI folder no longer exists):
In previous releases (x86): \Program Files\Rockwell Software\FactoryTalk Historian\Server\PI\dat
In v3.00 release (x64): \Program Files\Rockwell Software\FactoryTalk Historian\Server\dat
In addition, the tuning parameter Archive_AutoArchiveFileRoot is not the same as in previous releases and is likely undesirable because it results in new archives being created in an atypical location and with an atypical file name:
In previous releases (x86): \Program Files\Rockwell Software\FactoryTalk Historian\Server\PI\dat\piarch_
In v3.00 release (x64): \Program Files\Rockwell Software\FactoryTalk Historian\Server\dat
233 of 458
Lab 1 – Managing FactoryTalk Historian Archives Before you begin:
No special configurations need to be done prior to this lab
1. Go to the SERVER image:
2. Launch the System Management Tools (SMT):
3. Expand the Operation category and select the Archives plug-in:
4. Based on the value of a Tuning Parameter named Archive_AutoArchiveFileRoot, when an Archive Shift occurs either a new archive file will be created or an existing archive file will be used to archive new data. If you want to create new archive files manually, one way to do it would be to click the Create a new archive toolbar button (go ahead and click this button):
234 of 458
5. Normally, if the Archive_AutoArchiveFileRoot Tuning Parameter is set so that a new archive file is created when the Archive Shift occurs, it is automatically created the same size as the file that was actively archiving, what was considered the Primary archive file. If you want to have “larger” or “smaller” archive files, you would at least need to create a larger one “manually” as you are about to do so in this lab, have it become the Primary archive for at least some amount of time, then when an Archive Shift occurs new files created will be this new “larger” size. Leave the default Archive path and Archive name. Switch to the option to Create archive with a custom fixed size. Set the size to 192 MB and then click the OK button:
6. You should see the newly created archive file listed. Note: If the Archive_AutoArchiveFileRoot Tuning Parameter was set to use existing files rather than create new ones (it is not at default), if an Archive Shift occurred at this moment, as the “most recently created empty file”, this 192 MB file you just created would become the Primary archive.
235 of 458
7. Go to Operation > Tuning Parameters, click on the Archive tab and double-click on Archive_AutoArchiveFileRoot.
8. The Value of this property, at default, is set to C:\Program Files\Rockwell Software\FactoryTalk Historian\Server\dat. If desired, you could delete this value (leave it blank) and when Archive Shifts occur, existing archive files will be used. Or, you could change the contents of this value to a different drive and/or directory to change where archive files are created.
236 of 458
9. At the end of the Value setting of C:\Program Files\Rockwell Software\FactoryTalk Historian\Server\dat, add \piarch_. This will cause a new archive to be created in the …Server\dat directory with a file name starting with piarch_ Note: If you do not make this change (a future revision might change this behavior), the archive will be created in the “…Server” directory and the name of the archive file start with “dat”. When done, click OK.
10. Go back to Operation > Archives. Click the Force an archive shift button.
237 of 458
11. Note that normally you would like archives to shift “automatically” and as a best practice you should not force a shift while “in production” if possible (wait until down time). For testing purposes as in this case you can manually force a shift to occur. Click Yes to continue.
12. It will take several seconds, but soon you should see the new archive file appear. Note it has taken on Status of Primary. The file name starts with piarch_ and includes the date/time of when this file was created to give it a unique name. It is also 128 MB in size, the same as the file that was Primary when the Archive Shift occurred (piarch.001).
13. With a Status of Has Data, you can tell that piarch.001 was Primary at one time, so it does contain archived data. If you want to physically move this file from this computer you need to Unregister it first. Click on the file and select Unregister selected archive.
14. Select Yes.
15. If you click on another archive, notice the archive you Unregistered shows up as “grayed-out”. If you close and reopen the SMT it will not even appear on the list. However, there is a Display an unregistered archive button that you could use to select and display unregistered archives. They would still show up as grayed-out and you could not access their data until you Register them again.
238 of 458
16. With Windows Explorer, go to C:\Program Files\Rockwell Software\FactoryTalk Historian\Server\dat. You will see the original archives (.001, .002 and .003) as well as the two you created in this lab (.004 and the one with date/time in file name). Notice that each archive file has a corresponding .ann file. This file stores any annotations for the archived data and should always “go with” the archived files if you move and/or copy them.
17. Once you Unregister an archive, FactoryTalk Historian would not be able to access the data in that archived file unless you Register it again which can be done from the SMT in Operation > Archives. 18. When ready, close Windows Explorer and the SMT.
This lab is complete
239 of 458
This page intentionally left blank
240 of 458
Lesson 12 - Scheduling Backups of Historian Data What you will learn:
Procedure to schedule a daily backup of FactoryTalk Historian
It’s important to back up the FactoryTalk Historian Server at least once a day, so that you don't lose data and configuration information if something goes wrong with your equipment. All backups of Historian that are done while the Historian System is running are managed by the PI Backup Subsystem.
PIbackup.bat Batch file used to create backups to local hard drive or to create Windows Scheduled task to create backups automatically. Required parameter: Backup path – Complete drive letter and path to a directory with sufficient space for the entire backup. Optional parameters: -Install - Installs a scheduled task to run PIbackup.bat each day at 3:15am. -Incremental – An incremental backup will be performed. Number of archives – Number of archives to backup. Archive cutoff date – Specifies the cutoff date for archives to be backed up. The more restrictive of number of archives and archive cutoff date takes precedence.
PIsitebackup.bat This batch file does not exist at default. If created, it is called automatically at the end of the PIbackup.bat file. A version named pisitebackup.bat.example is created at default and can be edited to refer to an existing remote computer that can also be sent backup files in addition to the local backup created by PIbackup.bat. Note: See “FactoryTalk Historian SE System Management Guide” for details and additional information regarding Backups. In particular, there are sections describing:
How to Restore a Backup to an Existing Historian Server
Restore a Server Backup to a New Computer
Restore Archives from Backup
241 of 458
Lab 1 – FactoryTalk Historian Backups Part A - Create a Scheduled Task to Perform Backups Before you begin:
No special configurations need to be done prior to this lab
1. Go to the SERVER image:
2. One of the things you will do in this lab is run a file named pibackup.bat to create a Scheduled Task to automate backups of your FactoryTalk Historian Server. The pibackup.bat file calls another file named afbackup.bat that assumes your FactoryTalk Historian in using a default install of SQLServerExpress to store AF (Asset Framework). The default SQL instance is not the one being used in the images you are working with, but rather a Standard SQL Server. So, we need to edit the contents of this afbackup.bat file. Use Windows Explorer and go to C:\Program Files (x86)\Rockwell Software\FactoryTalk Historian\PIPC\AF\SQL. 3. Right-click on afbackup.bat and click Properties.
242 of 458
4. Turn off the Read-only property and click OK.
5. Right-click on the afbackup.bat file and select Edit.
6. At the bottom of this file, find this section.
7. Change the SET SQLINSTANCE from .\sqlexpress to SERVER
8. Save the file and exit Notepad. 9. Change the file attribute back to Read-only. 10. Now that this afbackup.bat file has the necessary corrections because our AF install is not using the default of SQLServerExpress, we can continue. Open a Command Prompt and change directory to the location: C:\Program Files\Rockwell Software\FactoryTalk Historian\Server\adm
243 of 458
11. Type pibackup and press Enter. You should get the following. Please read through the information, including descriptions of the “backup path”, “number of archives”, “archive cutoff date” and “-install” parameters:
12. To create a Scheduled Task that will backup Historian in C:\Backup, including the 5 most recent archives, enter the command: pibackup C:\Backup –install 5 13. Examine the end of the text output and verify that the script completed successfully. Note: A backup has not actually “occurred”, but by using the –install flag a Scheduled Task to create backups has been created.
244 of 458
14. Go to Start > Administrative Tools > Services.
15. Verify that the Task Scheduler service has a Status of Started:
16. Close the Services window and open Control Panel.
17. Go to System and Security.
245 of 458
18. Go to Administrative Tools.
19. Double-click on Task Scheduler.
20. Click Task Schedule Library and verify that the PI Server Backup task has been created and has a Next Run Time of 3:15 AM on tomorrow’s date (the day after the date that you created this task). Note that 3:15 AM is the default for this task controlled by settings within the pibackup.bat file:
21. Since we don’t want to wait until 3:15 AM tomorrow morning, right-click on the task and select Properties:
22. Go to the Triggers tab and click Edit.
246 of 458
23. On the Schedule tab, enter a start time of two minutes past your computer’s current time (“future time” of 2:00 PM in below example). Be sure to pay attention to AM versus PM. Click OK and OK (not shown):
24. Wait for the time to go by. You may need to close and reopen Task Scheduler to refresh, but look for Last Run Time to show when your task ran.
25. On the C: drive you should now have a “Backup” folder with contents such as the below. The subfolders store the backup configuration files and archives. The .txt file is a log file that stores information about the backup that you have just completed.
247 of 458
26. Open and look through the backup log (.txt) file. Check at the end that the backup script completed successfully:
27. Note the “WARNING!! WARNING!! WARNING!!” in this log file. This is because “No pisitebackup.bat was found”. The pibackup.bat file is only backing up to your local hard drive. You should also back up to a separate computer in order to recover from a hard disk crash of the computer running Historian Server. A pisitebackup.bat file is used to accomplish this (next part in this lab).
248 of 458
Part B - Creating a pisitebackup.bat file to Backup to Remote Computer 1. Still on the Server image, open Windows Explorer, navigate to the directory specified below and find a file by the name of pisitebackup.bat.example.
2. Right-click on this file, select Properties and change to non-read only (un-select checkbox):
3. After clicking OK on Properties dialog box, right click on pistiebackup.bat.example file and rename to pisitebackup.bat (delete the .example portion). 4. Now, right-click on the pisitebackup.bat file and select Edit. Notepad should open and you should be seeing the contents of this file. Find the following excerpt from this file.
5. In the UNCROOTPATH1 line in this area, remove the REM statement at the beginning of the line and change as follows:
6. Save the file and exit Notepad.
249 of 458
7. Go back to the Task Scheduler. Right-click on the task and select Properties.
8. On the General tab, click Change User or Group…
9. Enter Administrator and click Check Names.
10. Click OK.
11. Click OK to close the Properties dialog.
250 of 458
12. When asked to log in, enter password of rockwell and click OK.
13. Right-click on the task and select Run.
14. Wait for one minute for the task to run. 15. If you didn’t wait one minute, please keep waiting. If a full minute has gone by, in the C:\Backup folder you should see a second txt file and if you open it you should see “…completed successfully” at the bottom.
16. Go to the Client image.
251 of 458
17. In Windows Explorer, go to C:\Temp\SERVER and open whatever folder is in that directory (should be one there with today’s date as name). There was already a shared Temp folder on the C: drive. The scheduled task created a SERVER folder and then one with today’s date. In the folder of today’s date you should see backup files such as the following safely backed up on this “separate” computer from the FactoryTalk Historian Server.
18. Close Windows Explorer on the CLIENT image. 19. Close any open applications/windows on the SERVER image.
Note: You can review the “FactoryTalk Historian SE Management Guide” for more information regarding creating and restoring backups.
This lab is complete
252 of 458
Lesson 13 - Using FactoryTalk View SE Trend and ActiveView to Display Historian Data What you will learn:
Use Trend object in FactoryTalk View SE to display FactoryTalk Historian data
Extract individual ProcessBook displays from a ProcessBook workbook and embed them inside a FactoryTalk View SE display
Using FactoryTalk View TrendX Object The FactoryTalk View TrendX display object supports FactoryTalk Historian SE Server as a data source. The lab in this lesson shows the configuration required for FactoryTalk View TrendX to trend the data points (tags) from FactoryTalk Historian SE Server. A trend is a visual representation or chart, of a real-time or historical data. It provides you a way to track plant activity as it is happening.
Using FactoryTalk Historian ActiveView FactoryTalk Historian ActiveView is a tool for viewing live and historical data from a variety of data sources. It presents displays of live data from the Historian Server as well as information from ODBC sources (via ADO or VBA). Using Microsoft Internet Explorer you can view these displays with FactoryTalk Historian ActiveView on the Internet or within a corporate intranet. You can insert FactoryTalk Historian ActiveView displays as ActiveX controls in existing Microsoft Excel spreadsheets or other reporting tools used in your environment such as FactoryView SE displays. The live data displays, called Display Documents, are prepared from displays built in FactoryTalk Historian ProcessBook. When you open a Display Document in Internet Explorer, the display automatically updates with new data from the Historian Server. Dynamic symbols—such as trends, bars, or values—update just as they would in FactoryTalk Historian ProcessBook. Certain VBA scripting in a display is also available in FactoryTalk Historian ActiveView. ActiveView is not “included” with FactoryTalk Historian, but can be purchased as an option. ActiveView would be installed on the FactoryTalk Historian SE Server itself as well as the “client” computer where you might be displaying ActiveView using Internet Explorer, a FactoryTalk View SE Client Display, or other client that would support the ActiveView ActiveX.
253 of 458
Lab 1 – Using FactoryTalk View SE Trend to Display Historian Data Before you begin:
FactoryTalk Historian, FTLD Interface, and Client image should be configured and tags added as per Lessons 1 and 2.
1. Select the CLIENT image.
2. Launch FactoryTalk View Studio by selecting Start > All Programs > Rockwell Software > FactoryTalk View > FactoryTalk View Studio.
3. When prompted, select the Site Edition (Network) application type and click Continue.
254 of 458
4. Open the RA Foods application.
5. When the application fully opens, go to RA Foods > Graphics, right-click on Displays and click New.
6. Use the Trend object to draw a box in some empty space.
255 of 458
7. Double-click on the Trend object to get the configuration dialog.
8. On the General tab, change the Data Server to Poll historical data:
9. On the Pens tab, change the Pen Source to Historian Server and then click the Add Pen(s)… button. Please note that the Pen Source selection only controls the action that will be taken when the Add Pen(s)… button is clicked. It does not have any effect on existing pens, and should it switch back to the default value after a pen is added this does not indicate that the pen is no longer using the Historian Server source.
256 of 458
10. On the Add Pen Configuration dialog, click the Browse button to launch the tag search dialog.
11. On the Tag Search dialog Basic Search tab, change the Tag Mask to *TempZone* and then click the Search button.
12. Use Ctrl-clicks to select both the …TempZone1 and …TempZone3 tags. Click the OK button. Note: Depending on what labs you’ve done prior to this lab, you may or may not have the other tags listed below in your system.
13. Click on the Add button.
257 of 458
14. Click on the OK button.
15. Change the Width on both pens to 3.
258 of 458
16. On the Display tab, change the Maximum pen caption length to 80.
17. Do the following steps: a. On the X-Axis tab, change the Time span to 5 Minute(s). b. Click the OK button to finish (not shown).
259 of 458
18. Verify that the pens have been added to the trend.
19. Click Test Display button.
20. Experiment with and explore the trend. Note that the data is coming from the FactoryTalk Historian archive and is not being updated from the snapshot table. This means that updates will only be displayed when events pass the compression test.
21. Close FactoryTalk View Studio, saving your display if desired (not needed in future labs).
This lab is complete
260 of 458
Lab 2 - Using FactoryTalk Historian ActiveView Before you begin:
FactoryTalk Historian, FTLD Interface, and Client image should be configured and tags added as per Lessons 1 and 2.
FactoryTalk Historian ActiveView provides the ability to embed fully interactive ProcessBook displays in an ActiveX container. ActiveView provides a utility to extract individual displays from a ProcessBook workbook. It also produces an HTML file which attempts to recreate the general structure of the original workbook file.
Part A – FactoryTalk Historian ActiveView Configuration Note: ActiveView must be installed on the computer where FactoryTalk Historian SE Server is installed (image named SERVER in our case) and on computers where clients will connect via ActiveView (CLIENT in our case). These installs have already been done on these images.
1. Select the SERVER image.
2. Launch Internet Information Services (IIS) Manager by selecting Start > Administrative Tools > Internet Information Services (IIS) Manager.
261 of 458
3. Click on SERVER (SERVER\Administrator) and double-click on MIME types (MIME is an acronym for Multipurpose Internet Mail Extensions).
4. Right-click in the MIME Types area and select Add…
5. Fill in the following and then click OK:
Extension:
MIME type: application/octet-stream
.pdi
6. Verify MIME type added.
7. Close IIS Manger.
262 of 458
8. Open the FactoryTalk Administration Console by going to Start > All Programs > Rockwell Software > FactoryTalk Administration Console. Select Network directory. Right-click on Production Historian and select Properties:
9. On the Licensing tab, assign an activation to AVIEW (ActiveView)
10. After clicking OK, close the FactoryTalk Administration Console.
263 of 458
11. Stop Historian by selecting Start > All Programs > Rockwell Software > FactoryTalk Historian SE > Stop FactoryTalk Historian SE. Please wait patiently for all services to stop.
12. After all services have stopped and the command window closes, YOU MUST REBOOT THE SERVER IMAGE by selecting Start > Restart.
13. Close or click OK on any dialogs that appear during startup and wait until SoftLogix Chassis appears and controller Run indicators are green.
264 of 458
Part B – Using ActiveView via Internet Explorer 1. Select the CLIENT image.
2. Launch ProcessBook by going to Start > All Programs > Rockwell Software > FactoryTalk Historian SE > FactoryTalk Historian SE System > ProcessBook.
3. Notice that a ProcessBook demo file by the name of PIDEMO.PIW will open at default. We will use displays from this ProcessBook file in the remainder of this lab. If you have other ProcessBook files/displays you would like to try this functionality with, simply open that ProcessBook file and substitute names, etc., as needed in the following steps.
265 of 458
4. With the PIDEMO.PIW ProcessBook file open, select File > Open and open the EXPORT.PDI file located in: C:\Program Files (x86)\Rockwell Software\FactoryTalk Historian\PIPC\ACVIEW\WebDev 5. Specify an Export Path of C:\Temp and then click the OK button.
Note: This Temp folder on the C:\ drive has been created ahead of time and is a "shared folder". This will allow you to access these files from the SERVER image a bit later in this exercise. 6. If you get these and/or similar “error” messages, just click OK (if a “real application”, you may want to investigate…but for our testing purposes, OK to ignore these issues).
7. If you scroll to the bottom when the exporting stops you should see Export successful. Click the Close button.
266 of 458
8. Close the EXPORT.PDI dialog, the PIDEMO.PIW file and ProcessBook itself. 9. Go to the SERVER image:
10. Do the following steps: a. Open Wiindows Explorer. b. Go to Network > CLIENT > Temp (the shared Temp folder on the CLIENT image) c.
Select all files, but not the SERVER folder (this folder was created in a previous exercise for another purpose…you may not even have this folder and that is OK if you don’t)
d. Right-click and select Copy.
11. Go to C:\Inetpub\wwwroot, right-click and select Paste.
267 of 458
12. The copied files (more files than shown in below graphic) should now appear in this directory along with some others that were already there. These files will be used by the ActiveView Server to provide the ProcessBook displays to ActiveView clients.
13. Close Windows Explorer. 14. Return to the CLIENT image:
15. Open Internet Explorer. 16. Set the address to http://server/PBhome.htm (the “htt” beginning cut off in below graphic)
268 of 458
17. Click on the Main Column Bottom display. Note that the first time you use ActiveView you may see a blank white box or one containing “connecting” message while it tries to connect to the Historian Server. This is normal. Just wait several seconds while the connection is established.
18. After the connection is established, the ProcessBook display will appear, and, depending on the objects used, be interactive. You can select other displays and should not experience the initial connection delay. 19. Close Internet Explorer.
269 of 458
Part C – Using ActiveView in a FactoryTalk View SE Display Still on the CLIENT image, we will use ActiveView to embed a ProcessBook display in a FactoryTalk View SE display. 1. Launch FactoryTalk View Studio by selecting Start > All Programs > Rockwell Software > FactoryTalk View > FactoryTalk View Studio.
2. When prompted, select the Site Edition (Network) application type and click Continue.
270 of 458
3. Open the RA Foods application.
4. When the application fully opens, go to RA Foods > Graphics, right-click on Displays and click New.
5. Use the ActiveX Control object to draw a box in some empty space.
271 of 458
6. Select the PI ActiveView Control from the list and click the OK button.
7. Double-click on the “blank” ActiveX to bring up the configuration dialog.
8. Do the following steps: a. Important: Leave the entry on the Server Ini tab blank. b. Go to the Display URL tab and enter a Display URL of http://SERVER/Pulp Prep.PDI c.
Click the OK button (not shown).
272 of 458
9. Switch the FactoryTalk View display to test mode by clicking the Test Display toolbar button.
10. You now have an interactive ProcessBook display embedded in FactoryTalk View SE.
11. After you have experimented with the display, close all the applications. You can save your View SE display if you’d like, but not needed for future labs.
This lab is complete
273 of 458
This page intentionally left blank
274 of 458
Lesson 14 - FactoryTalk Historian SE High Availability What you will learn:
Observe the effect of Interface Buffering in a FactoryTalk Historian system
Understand concepts and advantages of Interface Redundancy
Understand concepts and advantages of Collectives
Interface Buffering FactoryTalk Historian provides a buffering service that can save your data if the Interface Node loses its connection to the Historian Server. When an Interface Node is running the buffering service (Pibufss), data flows from the data source, through the interface to the buffering service and from there to the Snapshot subsystem on the Historian Server.
Data Flow with Buffering If the Historian Server is not available for some reason (such as an upgrade on the Server) then Pibufss stores the data in one or more file buffers on the Interface Node. When the Historian Server becomes available again, Pibufss sends all the stored data from the buffer, in chronological order, back to the Historian Server. At this point, if you look at the data in VantagePoint or any other client, you see a continuous flow of data, with no gaps.
275 of 458
Impact on the Historian Server On the Historian Server side, all data from the Buffer Subsystem comes directly to the Snapshot Subsystem. The Buffer Subsystem runs the compression algorithm before all time-series data is sent to the Historian Servers. This guarantees identical data in the archive records of all Historian Servers when a Collection is used, and also brings another reduction of CPU usage for the Snapshot Subsystem. Overall, the more distributed CPU load translates into a higher scalability of your Historian System. Note: While the Buffer Subsystem performs the swinging-door compression on the remote node, all data from the Historian Interface is sent to the Historian Server. Values are marked as snapshot only or snapshot and archive values before they are stored in buffer queues and sent to the Historian Servers. As a result, real-time updates are delivered to Client Applications, Analyses, or Calculations as if compression was performed by the Historian Server itself.
Buffer Files The Buffer Subsystem creates fixed-size event queues named PIBUFQ_*.DAT to store all time-series data. The asterisk (*) in the file name is substituted by the host name of the corresponding Historian Server. By default, these queue files are found in the …PIPC\DAT directory, but their location is configurable in the ICU. Default size for these queue files is 32 MB, configurable from a minimum of 8 MB to a maximum of 128 GB. In most cases, choose a large enough size for the PIbufss queue as it guarantees a reserved space for buffered events. Use Performance Counters or the pibufss -qs option to estimate the correct size based on data rate and desired capacity. One buffer file is initially created. When buffering is actually taking place, additional files will be created as required until there is not enough available disk space to create any other files. As new files are created, a sequence number is appended to the file names.
Continued…
276 of 458
Buffer Settings in the ICU In this course, buffering was configured for the FTLD Interface on the Data image during the Lesson 1 Lab. The FTLD interface can be opened with the ICU.
Select Tools > Buffering to configure or view buffering settings.
Pibufss buffering is enabled with this setting.
277 of 458
Which Server to buffer for is identified in Buffered Servers.
Pibufss buffer file size, path, and other settings can be changed in Buffering Settings.
Interface Redundancy and Collectives High Availability At Rockwell we understand that uninterrupted access to data is a serious concern for our users. That's why we've expanded our products to provide a feature called High Availability (HA). This offering enhances the reliability of Historian Servers by providing you with an alternate source of timeseries data without requiring special hardware or clustered environments.
Here's how it works. In the traditional Historian System data is collected at an interface node and transmitted to a listening Historian Server where the user community can access it. Even in this simple configuration there are a number of possible scenarios, both planned and unplanned, that could trigger data loss or render data inaccessible. Planned Maintenance
Operating System Updates
Software Upgrades
278 of 458
Hardware Upgrades
Reconfiguration
Unplanned Failure
Software Failure
Hardware Failure
Network Failure
Human Error
Planned Maintenance So what happens when an administrator takes down a Historian System for planned maintenance without having an HA system? Taking an interface node down for service prevents data from being gathered from its source and creates a gap in data stored that may not be acceptable. Although Rockwell interfaces buffer data collected when a Historian Server is unavailable, that data is not available to clients while the Historian Server is down for maintenance. While the circumstances of planned maintenance can be controlled, the impact can be minimized but not eliminated entirely.
Unplanned Failure While occurring infrequently, unplanned downtime represents a greater risk. Even under the best circumstances there are times when hardware, software, or networks fail. Any of these scenarios can bring down a system momentarily or until such time as the failure is detected and repaired. This downtime could last several hours. Generally, exposure is similar to that of planned maintenance, with a couple of exceptions. Any failure bringing down an interface node can cause a loss of data. A failure of the Historian Server could also result in loss of any data that had not been previously backed up. There may be permutations of either or both of these failure modes that can also have serious impact on the system's ability to store and recover data for users.
High Availability Architecture The Historian System already includes features that facilitate making data highly available. These include the ability to conduct online backups, compatibility with Microsoft Clustering technology, the distributed nature of data collection within the Historian System, and the availability of fault-tolerant third-party solutions that provide redundant hardware solutions. Now, with our HA Historian System, a new architecture with built-in features is introduced that specifically address the issue of data availability during planned and unplanned downtime. These features are visible at three levels, as described in the following sections.
Historian Servers
Interfaces
Historian SDK
279 of 458
Historian Servers The HA design provides multiple Historian Servers that each act as independent storage and a source for time-series data. These Historian Servers function as a unit described as a collective. A collective has two types of servers:
Primary - The main server in a collective where configuration changes are made. By default, this is the only server that accepts non-buffered data.
Secondary - The remaining servers in a collective. These servers automatically adopt configuration changes made on the primary.
Within a collective, configuration changes are allowed on only the Historian Server designated the primary. The other Historian Servers in the collective are designated as secondary and do not allow configuration changes, but do receive changes from the primary. Historian Replication keeps the configuration databases consistent on the servers. Any change made to the primary Historian Server configuration is moved to the secondary Historian Servers in real time, according to a fixed schedule, or on demand. The figure below shows this overall architecture of a collective consisting of two member servers.
HA Architecture Historian Server Replication Historian Server replication is one of the core concepts behind High Availability. It allows redundant Historian Servers, including a primary and one secondary server, which together are referred to as a Collective. The Historian Server point database, module database, user database, trust table, and most of the configuration tables are replicated across the collective. Additionally,
Interface buffering service writes time-series data directly to all members of the collective, buffering data temporarily for those unable to receive data for a period of time and assuring that time-series data stored in each archive is an exact duplicate of the others.
Any SDK-based Historian client (for example, FactoryTalk VantagePoint, FactoryTalk Historian ProcessBook, FactoryTalk Historian DataLink) can automatically switch from the primary Historian Server to any of the replicated servers in the event connection to the primary is unavailable, assuring that all clients always have read-access to Historian data.
280 of 458
Interfaces Interface-level failover allows you to install redundant copies of an interface on separate interface computers. This provides uninterrupted collection of process data even when one of the interfaces is unable to collect data for any reason. Interface node maintenance—such as hardware upgrades, security updates, and software installs—can occur without loss of data because the redundant node automatically collects and sends data to the Historian Server. Moreover, in the event of a hardware, network, or software fault, interface level failover prevents the loss of data, as the redundant node detects when the primary nodes fail and begins to send data to the Historian Server. Interface nodes are configured to make use of a buffering service. All interfaces that write data to the Historian System can make use of this service. The buffering service queues the data independently to each Historian Server in a process called n-Way buffering. Each Historian Server receives the same data from the interfaces and performs its functions independently.
Historian SDK The Historian SDK, the data access layer used by Rockwell applications as a programmatic interface to the Historian Server, is enhanced to treat the collective as one logical data source. When the Historian Server is shut down normally through the pisrvstop.bat batch file or shutting down the OS, the Historian SDK receives an early notification of shutdown and immediately connects to a secondary Historian Server. When the Historian Server providing data becomes unresponsive because of hardware or software problems, or unreachable because of network problems, the Historian SDK connects to an alternate Historian Server after a short timeout period. Applications that use the Historian SDK can take advantage of the failover behavior on any computer where the new Historian SDK is installed. The new Historian SDK is backward compatible with older versions of the Historian SDK. Once you install an HA-aware Historian SDK (typically when you upgrade to an HA-aware version of a client application) you get failover behavior against any collective, regardless of whether you are using an HA-aware version of an application. Applications using previous versions of the Historian SDK do not benefit from the failover behavior and continue to function as before. Normal Data Flow
281 of 458
Key Points regarding Collectives
A collective consists of two servers, where one is identified as Primary and the other as Secondary. Any edits must be done to the Primary. The Primary sends any configuration changes to the Secondary automatically.
Support for Collectives is limited to one Secondary server. Capability of having multiple Secondary servers planned for future releases.
Only the Primary server is displayed in the FactoryTalk Administration Console. In "Properties" of the Primary server, it is assigned the appropriate number of licenses that it needs based on RA and/or 3rd Party tag counts. A second "duplicate" set of licenses must be purchased and installed. The Secondary server requires and will use the duplicate activations, although you do not manually "assign them" to the Secondary server as you assign licenses to the Primary.
Collectives rely on Interface nodes configured for buffering. These interface nodes collect data from data sources and provide identical values/timestamps to each server. When one server is down it will buffer the data for that server while continuing to send "current" data to the server that is available.
If a client such as VantagePoint, ProcessBook or DataLink tries to obtain data from one of the servers and that server is not available, the client will automatically switch to obtain the data it needs from the other server in the Collective.
"Internal values", such as Performance Equations and Totalizers, are not synchronized between Primary and Secondary servers. Such tags could contain different values.
The Primary and Secondary servers would have their own Event-triggered input tags (tags read based on other tags changing) and Output tags (values sent "outside" of the server), and those tags would work independently of each other. Configuration changes of such tags will automatically be sent from Primary to Secondary servers, but actual content/values of such tags are not synchronized. For example, both servers could be sending values to the same Output tag, such as a tag in a CLX controller, and the values may or may not be identical.
More Information For more details on HA concepts and features, see the following manuals:
FactoryTalk Historian SE High Availability Administration Guide
FactoryTalk Historian SE Buffering User Guide
282 of 458
Lab 1 - Interface Buffering Before you begin:
FactoryTalk Historian and Interface configured, and tags added as done in Lesson 1
VantagePoint configured and Historian tags imported as done in Lesson 3
1. Select the CLIENT image.
2. Launch VantagePoint Trend by going to Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Trend.
283 of 458
3. Go to System > Sources > FactoryTalk > localhost > Historians > Production Historian > Tags and click and drag the …TempZone1 tag to the trend surface.
4. Click the Live Mode button and you should see the trend scrolling from right to left, continuously updating.
5. In order to “monitor” the buffering subsystem, there are “queue statistics” we can monitor on the computer with the Interface that is doing the buffering. The FTLD Interface FactoryTalk Historian Server is using is installed on the DATA image. 6. Switch to the DATA image.
284 of 458
7. Open the Interface Configuration Utility (ICU) from Start > All Programs > Rockwell Software > FactoryTalk Historian SE > Interface Configuration Utility.
8. From the drop-down Interface selection box, pick the FTLD1 interface.
9. Once selected, pick Tools > Buffering.
10. Notice that this interface is configured to use the PI Buffer Subsystem.
11. Select Buffered Servers and notice this interface is configured to buffer data for the historian server we are using, named SERVER.
12. Click OK on the Buffering dialog and close the ICU.
285 of 458
13. Open a command prompt and change to the path of: C:\Program Files (x86)\Rockwell Software\FactoryTalk Historian\PIPC\BIN
14. Enter the command: pibufss -qs Note: “pibufss” is the buffer service, then there needs to be a space, a “-“ (dash) followed by “qs” for queue statistics. 15. The result of this command should be similar to the following. The first column of numbers is the “count” at that moment. The second column is “change since last update”. Note that you should be accumulating Total Event Writes and Total Event Reads, but no Current Queue Events at this time.
16. Leave the Command Prompt open and return to the CLIENT image.
17. Verify that your VantagePoint Trend is still displayed and the …TempZone1 tag is still changing. 18. Go to the SERVER image.
286 of 458
19. We will simulate a Historian Server outage by manually stopping Historian. Stop your Historian Server by selecting Start > All Programs > Rockwell Software > FactoryTalk Historian SE > Stop FactoryTalk Historian SE
20. Wait for all of the services to stop and the dialog to close itself before proceeding. 21. After Historian if fully stopped, go back to the CLIENT image and look at your VantagePoint Trend. When the Historian Server is shut down, you will see a “break” and apparent “loss of data".
22. Go back to the DATA image.
287 of 458
23. Since the Historian Server is not available, the FTLD Interface is buffering data. You should see Current Queue Events accumulating (may take several “updates”).
24. Return to the SERVER image.
25. Restart the Historian Server by selecting Start > All Programs > Rockwell Software > FactoryTalk Historian SE > Start FactoryTalk Historian SE 26. While the Server is restarting (may take several minutes), return to the DATA image.
27. See if you can “catch” when the server finishes restarting and the pibufss buffer “empties”. Current Queue Events value should go to 0 (zero) and the “change since last” value should be negative. This may take several minutes.
28. Return to the CLIENT image.
288 of 458
29. Your trend should now be updating with values.
30. If you see a gap, to fully refresh the trend, turn Live Mode off and back on again. The trend should be displaying data with “no gaps”.
31. Leave VantagePoint Trend open and in Live Mode for the next Lab. 32. Go to the DATA image. Make sure the command window has focus and select Ctrl-C to stop the queue statistics. Close the command window.
This lab is complete
289 of 458
Lab 2 - Interface Redundancy Before you begin:
FactoryTalk Historian and Interface configured, and tags added as done in Lesson 1 and 2
VantagePoint configured and Historian tags imported as done in Lesson 3
Note: In the VMware images being used in this training, the FTLD Interface we have been using is on the DATA image. To demonstrate Interface Redundancy, another FTLD Interface has been installed on the CLIENT image. It is NOT recommended in real applications that Interfaces be run on “client machines”, but for the purposes of this lab we will use an interface on the CLIENT image as a redundant interface to the one on the DATA image.
Part A – Configuring Buffering and Initial CLIENT Interface Configuration 1. Go to the DATA image.
2. Open the Interface Configuration Utility (ICU).
290 of 458
3. Use the ICU on this image to confirm the interface is running (select FTLD1 Interface from dropdown list and look for "Running" at the bottom of the dialog)…
…and configured for Buffering.
4. Close the Buffering dialog but leave the ICU open. 5. Go to the CLIENT image.
291 of 458
6. On the CLIENT image, we want to verify the connection to the Historian Server named SERVER. Launch the AboutPI-SDK utility.
7. Click on the Connections entry, the SERVER checkbox and confirm SERVER connected dialog appears at bottom.
292 of 458
8. Select File > Exit PISDKUtility to close the AboutPI-SDK.
9. Launch the Interface Configuration Utility (ICU).
10. Click the Create new Interface Instance from .BAT file toolbar button.
11. Navigate to the LDInterface directory and select the FTLDInt_FTLD.bat.bak file. Click the Open button.
293 of 458
12. You will be prompted to select the Host PI Server. Select SERVER from the drop-down box and click the OK button.
13. Note that the Interface ID is set to the default value of 1 and will be the same ID as that of our primary interface on DATA, Interface ID of 1.
14. Do the following steps: a. Select the Service category. b. Change the Display name to FTLD1. c.
Click the service Create button.
294 of 458
15. Select Tools > Buffering….
16. Change the radio button to Enable buffering with PI Buffer Subsystem.
17. Read the messages and click OK (you will not start the service YET!)
18. You should be taken to the Buffered Servers dialog. Select SERVER from the drop-down box. Click the OK button.
295 of 458
19. First, click General and then click Service on the left. Click Yes make the PIBufss service a dependency. This dialog would come up later when you start the interface, but since we are finishing the configuration for Buffering we “forced” it to appear now to get out of the way.
20. One of the configurations of the Interface on the DATA image that was done on Lesson 1 was to delete some Scan Classes and enable Disconnected Startup. To make this interface “match”, first go to the General tab, click on them one at a time and use the Remove selected scan class button to delete scan classes 0.05, 0.1 and 0.25.
21. You scan classes should now appear as follows.
296 of 458
22. Click on Disconnected Startup category and select Enable disconnected startup (with point caching).
23. Leave the ICU open.
Part B - Create Shared Folder 1. We need to create a “shared folder” to store a “handshaking file” that the two redundant interfaces will use to control their redundancy. Go to the SERVER image.
Note: A computer running a Historian Server is NOT a recommended place for this shared "handshaking" folder. However, since it is the only image that will not be running an Interface, we will use it for training purposes in this lab. 2. Go to Start > Administrative Tools > Share and Storage Management.
3. Click on Provision Share… on right side of dialog
297 of 458
4. Click the Browse… button
5. Click the c$ drive and then Make New Folder button
6. Name the folder FTH_Shared (press Enter after typing name) and then click OK
298 of 458
7. Click Next > several times to accept defaults until this screen. Select the second option and then Next >
Note: In a “real application”, you may wish to adjust these permissions for a different user name or group of users. 8. Click Next > on dialog that follows and then Create on this dialog.
9. Click Close and then close the Share and Storage Management dialog.
299 of 458
Part C – Configuring Interfaces for Failover 1. Change to the DATA image which should still have its ICU open.
2. Do the following steps: a. Select the Failover sub-category under UniInt in the left pane. b. Check the box to Enable UniInt Failover. c.
Select Phase 2.
d. For Synchronization File Path, browse to the FTH_Shared folder on Server (Network > SERVER > FTH_Shared) and click Open. The file FTLDInt_FTLD_1.dat will be created in this folder. e. Select UFO (Universal FailOver) Type of HOT. f.
Carefully confirm all following selections. When confirmed (are you sure?), select Apply.
3. Read this message (we will come back later to finish the configuration) and click OK
300 of 458
4. Read and click Yes.
5. Read and click OK (we will stop and restart the interface later)
6. Go to the CLIENT image
7. Make the same Failover selections on this interface as you did on the other. HOWEVER - Select Failover ID # 2 for this instance and Failover ID # 1 for the other instance IMPORTANT! Verify all below selections CAREFULLY!
8. Are you sure the settings match – especially Failover ID# for “this instance” of 2 and “other instance” of 1? If so, click Apply on above dialog
301 of 458
9. Read and click OK.
Part D – Modifying FTLD Service Properties 1. Still on the CLIENT image, go to Services by selecting Start > Control Panel > System and Security > Administrative Tools > Services 2. Double-click the FTLD1 Service
3. Select the Log On tab, and specify to use Administrator account with password of rockwell. Click OK
302 of 458
4. Read and click OK
5. Close Services, Administrative Tools and System and Security dialogs 6. Go to the DATA image
7. Go to Services (Start > Administrative Tools > Services) and make the same changes to the FTLD1 interface on this image. Use Administrator with password of rockwell. Click OK.
8. Read and click OK.
303 of 458
9. Read and click OK. You will not stop and restart the service YET!
10. Close the Services dialog.
Part E – Finishing up and Testing the Interface Redundancy 1. Go to the DATA image.
2. In the ICU, click the Browse button to select the “other instance”.
3. Click the FTLDInt1 interface on the CLIENT image and click OK.
304 of 458
4. In the “tag area”, below where you identified the UFO Type and Synchronization File Path, right-click on the tags and select Create UFO_State Digital Set on Server SERVER…:
5. Read and click OK on this dialog.
6. Right-click on the “tag area” again and select Create all points (UFO Phase 2).
7. Click the Apply button at the bottom-right of the dialog box and click OK on the Interface Changes Require Restart dialog box that will appear. 8. Restart the interface. Look for Stopping Service, then Starting Service and then Ready and Running at the bottom-left of the dialog box. Leave the ICU open.
9. Return to the CLIENT image.
10. Select the Browse button.
305 of 458
11. Click the interface on DATA image and click OK
12. Click the Apply button at the bottom of the dialog box and then start this interface by clicking Start Interface service.
13. Click Yes if asked if you would like the ICU to start the PIBufss Service.
14. Switch over to the SERVER image.
306 of 458
15. Launch the System Management Tools (SMT).
16. Expand the Data category and select the Current Values plug-in.
17. Use the search button to add all of the FTLDInt1_* tags to the current values monitor and click the Start Updating toolbar button.
You should be seeing:
ActiveID = 1 – Interface Node with Failover ID#1 is currently "Primary" and sending data to Historian Server
DeviceStatus = 0 – Zero is “good” status
Heartbeats = Incrementing numbers indicate Interface Nodes #1 and #2 are responsive
States = Current “Primary” or “Backup” state of Interface Nodes #1 and #2. Under certain conditions could also indicate “Off” or “Transition”
307 of 458
18. Leaving the SMT open, go to the CLIENT image and the VantagePoint Trend application, which should still be running from the previous lab. You may see a gap or loss of data from interface configuration changes and restarts. If not running, start VantagePoint Trend and create a display with a trend of the tag ending in …TempZone1. See Lab 1 in this Lesson for steps if needed.
Note: Since the Interface on the DATA image is currently Primary (you should have seen that with the SMT on the SERVER image), this tag being trended is coming from the Interface on the DATA image to the Historian Server. 19. On the DATA image, use the ICU to stop the Interface by clicking Stop interface service.
308 of 458
20. Back on the CLIENT image, there could be a short delay but then the backup interface should take over. You may need to stop and start Live Mode, but data collection will continue and no data should be “lost”.
21. Start the Interface again on the DATA image.
22. Switch back to the SERVER image.
23. Did the Interfaces “switch roles”? The Interface on CLIENT (Failover ID #2) is now “Primary” and the Interface on DATA (Failover ID #1) is “Backup”?
24. Experiment with stopping a “Primary” interface to verify the “Secondary” Interface takes over, with no data loss. Just be sure you don’t end up with both Interfaces stopped. You WILL FOR SURE lose data then!
309 of 458
25. When you are finished experimenting, revert back to non-redundant conditions by: a. Make sure the Interface Node on DATA (ID#1) is Primary b. On the CLIENT image, stop the Interface with the ICU, then close the ICU. c.
Use the ICU on DATA image to de-select Enable UniInt Failover, click Apply and Restart the Interface Node.
26. On all three images, close any open applications (SMT, VantagePoint Trend, ICU, etc).
This lab is complete.
310 of 458
Lab 3 – Using a Collective Before you begin:
FactoryTalk Historian and Interface configured, and tags added as done in Lesson 1
Note: At the end of this lab, you will have a system with a single FTLD interface sending identical data to two FactoryTalk Historian Servers, a Primary and a Secondary Server in a Collective. It may not be easy to “un-do” the configurations you are making to create this Collective. So, be aware if you will be doing additional testing/training with these images, it will assume the Collective will still be in effect. If you want to “revert” to configurations prior to making the Collective, you may want to take VMware snapshots of the DATA and SERVER images prior to starting this lab. Recommended procedure to take snapshots and restart images: a. Stop FactoryTalk Historian on the SERVER image b. Shut down both DATA and SERVER images c. Take VMware snapshots of each image d. Start SERVER image and wait until completely running e. Start DATA image until completely running
Part A – Confirming and Adding Security Mappings 1. In VMware Workstation, in addition to the DATA, SERVER and CLIENT images that should already be running, open and power on the SERVER2 image.
2. Wait until following dialog appears, and then at least one minute to make sure everything is fully running. Then, close this dialog.
3. A few changes regarding security have been made from the “default” Operating System and FactoryTalk Historian Server install. Right-click on Computer and select Manage.
311 of 458
4. Note that under Server Manager (SERVER2) > Configuration > Local Users and Groups > Groups, Windows Groups of WIN_FTHAdministrators and WIN_FTHEngineers have been pre-created in preparation of this lab.
5. Under Users, right-click on Administrator and click Properties.
312 of 458
6. On the Member Of tab, note that the Administrator user is a member of both WIN_FTHAdministrators and WIN_FTHEngineers Windows Groups. The Administrator user is the default logged in user on this image, so you currently have the privileges/rights of the Administrator user.
7. Close Administrator Properties and the Server Manager dialogs. 8. Go to Start > All Programs > Rockwell Software > FactoryTalk Historian > System Management Tools.
313 of 458
9. Do the following steps: a. Verify SERVER2 is checked b. Go to Security > Mappings & Trusts c.
Note that the WIN_FTHAdministrators and WIN_FTHEngineers Windows Groups have been mapped to the FTHAdministrators and FTHEngineers FactoryTalk Historian Server Groups. These are also additions to this image that have been made from the default (no Mappings exist at default). This is that so the Windows Administrator user (currently, “you”) will have permissions/rights that are given to these built-in FactoryTalk Historian “Identities”.
10. Close the SMT. 11. Go to the SERVER image.
314 of 458
12. Do the following steps: a. Open the SMT. b. Go to Security > Mappings & Trusts. c.
With the Mappings tab selected, click the New… button.
13. Select Windows Account Browse button.
14. Enter Administrator, click Check Names (“Administrator” should change to SERVER\Administrator”) and then OK.
15. Click PI Identity Browse button.
315 of 458
16. Select Type of PI Groups, the FTHSupervisors group and OK.
17. Click OK.
18. At this time you have mapped the Administrator Windows User (logged in User on each image) to the FTHSupervisors group in FactoryTalk Historian Server. This Mapping will be replicated to the Secondary Server when you make the Collective.
Note: To be more consistent with your other Mappings, a “better practice” might have been to create a Windows Group named WIN_FTHSupervisors, make the Administrator user a member of that Windows Group, and then map that Windows Group to the FTHSupervisors Group in FactoryTalk Historian. This would need to have been done on both the SERVER and SERVER2 images. In order to save a few steps in this lab, directly mapping the Administrator to the FTHSupervisors group on the SERVER image is all that is needed. 19. Close the SMT.
316 of 458
Part B – Creating Collective Preparation 1. Go to the DATA image:
2. On the DATA image, open the ICU, select the FTLD1 interface from the drop-down list and STOP the FTLD1 interface.
3. Close the ICU. 4. Start AboutPI-SDK from Start > All Programs > Rockwell Software > FactoryTalk Historian SE > FactoryTalk Historian SE System > AboutPI-SDK
5. Select Connections > Add Server…
317 of 458
6. Enter server of SERVER2, uncheck Confirm and click OK.
Note: If you don’t uncheck Confirm, when you click OK the AboutPI-SDK will automatically try to connect to the new Server. In this case we want to wait until the next step to connect “manually” just to separate these activities (separate “accepting the above dialog” from “making an actual connection”). 7. Check both server boxes and verify you can connect to both from this image with no errors:
8. Since the logged in user on all images is Administrator, based on Windows Group assignments and Mappings in the SERVER2 Historian Server, note that you are currently connecting to SERVER2 as FTHAdministrators, FTHEngineers and PIWorld (everyone).
9. Close the AboutPI-SDK. 10. Go to the SERVER image.
11. Repeat steps 4-9 on the SERVER image, adding SERVER2, so that this image can connect to both servers. You should end up with both servers found and no errors as you did from the DATA image:
12. Close AboutPI_SDK.
318 of 458
Part C - Creating the Collective 1. Still on the SERVER image, open the Collective Manager from Start > All Programs > Rockwell Software > FactoryTalk Historian SE > FactoryTalk Historian SE System > Collective Manager:
2. Select File > Create New Collective…
3. Read the following dialog. We have not made a recent backup, and for the purpose of this lab will not do so, but in a “real application” you would for sure want to do that before proceeding. In the previous section you verified the FTLD Interface could connect to both Servers. Select both checkboxes and click Next.
319 of 458
4. Select that the primary server of the new collective is “existing” and click Next.
5. Select SERVER as the Collective Primary from the drop-down list. Note: When an existing server is used as Primary, the Collective Name will automatically be the same as the Primary Server’s name. If you would have selected to create a collective from a “newly installed PI server” on the previous dialog, you would have been able to give the Collective a name of your choice. Click Next:
320 of 458
6. Do the following steps: a. Select SERVER2 as Secondary Server. b. Click Add. c.
Click Next.
7. Select number of archives to copy to Secondary Server (yours may differ from below) and click Next.
321 of 458
8. Click Next to accept default location to store backup of Primary Server (in a “real application” you may want to change).
9. Review information listed and click Next.
10. Watch and read through the steps as the wizard creates the Collective. When the Collective is successfully created (congratulations!), click Finish.
322 of 458
11. On the Collective Manager, click the “Collective” of SERVER. You should see the Primary and Secondary Servers of SERVER and SERVER2 displayed with green check marks. If you don’t see green checkmarks on both, wait one minute and then refresh (either right-click on SERVER Collective and click Refresh or else us the Refresh button above the two Servers)
12. Close the Collective Manager. 13. Go to the DATA image.
14. On the DATA image, open the AboutPI-SDK
15. You should see the two Historian Servers that were listed earlier:
323 of 458
16. Click on SERVER and the display should update to show a single “Collective” named SERVER. Notice the different icon -
17. Close About PI-SDK. 18. Open the ICU and select the FTLD1 interface:
19. Select Tools > Buffering and Buffered Servers. You should see both Primary and Secondary servers listed as servers that this interface will buffer data for using a Collective name of SERVER.
Note: These images are configured in a Workgroup, rather than a Domain. However, the Historian Collective does require Fully Qualified Domain Names (FQDN) for the Servers. So, these images have been configured with “Lab” as a Primary DNS suffix. You will notice in the above that Server.Lab and Server2.Lab are their “full computer names” or FQDN. 20. Select OK on the Buffering dialog and click the Start interface service button.
21. Look for “Ready” and “Running” to be displayed at the bottom of the ICU.
22. Close the ICU.
324 of 458
Part D - Testing and Using the Collective 1. Still on the DATA image, open the SMT.
2. In the SMT, click on the Primary Server named Server (if not already checked) and use Data > Current Values to display the tag ending in …TempZone1. Verify you have occasionally changing values (be sure to click the Start Updating button).
3. Notice that the SMT has an area to select either the Primary or Secondary server. It is possible to select both servers at once, but many times you would only want to select only one or the other. 4. On the SMT, uncheck the box for SERVER and check the box for SERVER2. Open up a couple of different editors, like Point Builder, Performance Equations, Totalizers, etc. Confirm that the fields you have normally used to edit tags are “grayed out”…you cannot edit configurations on the Secondary server. 5. Change the SMT to look at the Primary server instead of the Secondary. Confirm that the editing fields for things like Point Builder, Performance Equations and Totalizers are NOT “grayed out”. The Primary server is the one that must be used for any editing of tags and most configuration changes. It will “replicate” such changes to the Secondary server.
325 of 458
6. Confirm the previous statement is true by making some small change on a tag on the Primary server (like slightly modifying Zero or Span) and confirming that change “appears” on the Secondary server. 7. Go back to showing the value of the …TempZone1 tag in the Primary Server and verify it is still occasionally changing.
8. Minimize the SMT for now. 9. Open a command prompt and go to the path of c:\program files (x86)\rockwell software\factorytalk historian\pipc\bin
10. Type pibufss -qs and press Enter. This command is to monitor “queue statistics” of the Buffer Subsystem. Since the interface will now be able to buffer data to two historian servers, you should be getting a choice to monitor one or the other buffer as follows:
326 of 458
11. Press 1 and Enter to monitor the buffer to the Primary server. You should see a screen similar to the following, updating every few seconds, indicating buffer status. As long as the “Current Queue Events” value is zero, the interface is not buffering to this server.
12. Go to the SERVER image and stop Historian.
327 of 458
13. Go back to the DATA image. It may take several minutes, but eventually you will see data being buffered for this image.
14. Go back to the SMT. You should see the changing of data for this tag has stopped. Write down the Timestamp of this “last record” before buffering data…3:54:23 PM in below example.
15. Do the following steps: a. Uncheck Server b. Check Server2 c.
Add the …TempZone1 tag to Current Values and click Start Updating. The value should be updating in this server.
328 of 458
16. Go to the SERVER image and restart the Historian Server.
17. On the DATA image, wait until the Current Queue Events goes to zero.
329 of 458
18. Do the following steps: a. Go to the SMT b. Unselect Server2 and select Server. c.
Go to Data > Archive Editor and search for the …TempZone1 tag.
d. Scroll to find the Timestamp you had written down earlier. Although the Historian Server was shut down for many minutes, data was still being collected by the FTLD Interface and buffered. Now that the Interface has “reconnected” to the Server, there should not be a large gap in time between archived values following this Timestamp (buffered data was “filled in”).
19. Close all open dialogs/applications/windows.
Note: As mentioned at the beginning of this lab, you system is now configured to use a Collective. If you have additional testing/training you would like to do with these images unrelated to having the Collective, you can either… 1. Continue with all these images running as they currently are. – or – 2. Shut down the SERVER2 image and continue with the other images you’ve used throughout this training. Be aware that the FTLD interface on the DATA image will continuously collect and buffer data for the SERVER2 Server. You are probably not likely to notice any negative effects from this behavior. – or – 3. As mentioned at the beginning of this lab, if you made VMware snapshots you can revert to those snapshots and start up the DATA and SERVER images again (as described in that section) before continuing.
This lab is complete
330 of 458
Appendix A - Installing FactoryTalk Historian SE What you will learn:
Recognize Pre-Installation Tasks and Windows File System Concerns
Steps to Install FactoryTalk Historian SE Server
Steps to Install FactoryTalk Historian SE Interface
Pre-Installation Tasks and Windows File System Concerns Synchronize Time Settings on FactoryTalk Historian System Computers For all machines that are part of the FactoryTalk Historian system, you must ensure that the time is set correctly and synchronized to the FactoryTalk Historian Server. In addition, make sure that all Windows machines have the proper time-zone settings and that they are set to automatically adjust for daylight-saving changes. The FactoryTalk Historian Server computer and client computers clocks should all be synchronized. This is typically done through the domain controller. The domain controller's time is synchronized first by an NTP source. Then, the domain controller synchronizes all the other computers that are a part of the FactoryTalk Historian system.
Disable the Windows Time Zone (TZ) Environment Variable The Windows TZ environment variable adversely affects Historian Server. You must ensure that TZ is not set on the Historian Server computer. To confirm the TZ variable is not set on Windows Server 2008 and 2008 R2: 1. Select Start > My Computer. 2. Right-click and select Properties. 3. Click the Advanced system settings link. 4. Click Environment Variables. 5. If the TZ variable is present, delete it. 6. If necessary, restart the computer. Do Not Use Windows File Compression Rockwell Automation recommends that you do not Windows File System Compression. Although compression may save disk space, it requires more CPU resources each time data arrives at the Archive and clients access database files. Time Specifications and Considerations You can slow access to archive files and degrade performance of the entire FactoryTalk Historian System if you use compressed files. This is especially true for files that change constantly, such as the primary archive and event queue files, and the current message log file.
331 of 458
Configure Antivirus Software Rockwell Automation recommends that you configure anti-virus software on production systems to exclude scans of the Server\dat directory and any directories containing Historian Server database and archive files. The Server\dat directory does not contain any executable programs or scripts. Anti-virus software immediately scans files with contents that change. The contents of the Historian Server archive files change constantly as archive cache records are regularly flushed from memory to disk. Archive files tend to be large, and thus the time required to scan can be quite long. In addition, if any random bit pattern in an archive file happens to match a known virus signature, the anti-virus software can lock or otherwise quarantine the archive file. Such a corruption of the archive file system would result in the unrecoverable loss of production data. The same situation can occur for other Historian Server database files.
Installing FactoryTalk Historian Server Note: FactoryTalk Historian Server and Interface are already installed on images used with this Training Manual. The following steps are intended as a reference to show the install steps/procedures.
Prior to installing FactoryTalk Historian Site Edition Server, the following core components should be installed. See FTHistorian SE Installation and Configuration Guide for details.
Microsoft SQL Server
FactoryTalk Services Platform
FactoryTalk Activation Manager
RSLinx Enterprise
1. From installation media, run setup.exe
332 of 458
2. Select Install FactoryTalk Historian Site Edition
3. Select Install FactoryTalk Historian Asset Framework
333 of 458
4. Asset Framework is a requirement for installing a FactoryTalk Historian Server and requires a SQL Server database. The below dialog will let you install Microsoft SQL Server 2008 Express on the local computer. See the FTHistorian SE Installation and Configuration Guide for more details. Assuming you have a SQL Server for Asset Framework to use, select Install FactoryTalk Historian AF Server.
5. This wizard will guide you through installing Asset Framework. Select Next.
334 of 458
6. Read and select I accept the terms… (if you do) and click Next.
7. The dialog shows what items need to be installed and if they currently are or not. Select Next.
335 of 458
8. Select destination drive and then Next.
9. See the FTHistorian SE Installation and Configuration Guide for more options/details on the next dialog. The below example is selecting the default local instance of SQL Server Express (.\sqlexpress) and installing both the AF Application Service and AF SQL Database. Select Next.
336 of 458
10. This dialog shows what will be installed. Select Install.
11. When install completes, select Finish.
337 of 458
12. Select BACK to return to prior dialog.
13. Select Install FactoryTalk Historian Server.
338 of 458
14. Read dialog and select Next.
15. Read and select I accept the terms… (if you do) and click Next.
339 of 458
16. Specify User Name, Organization and valid Serial Number (below number is not). Click Next.
17. The next dialog will list what is and isn’t currently installed. Click Next.
340 of 458
18. Select Next.
19. This lists what will be installed. Click Install.
341 of 458
20. When Release Notes appear you can take the time to read them. You may need to close to proceed with the installation.
21. Click the Browse button to select the computer hosting the FactoryTalk Directory that this Historian Server will be a part of (if not already listed). Click OK to continue.
22. Click Finish.
342 of 458
23. Click Yes to reboot computer now, or No if you want to reboot later (but be sure and reboot before trying to use FactoryTalk Historian).
Installing FactoryTalk Historian Live Data Interface A FactoryTalk Historian Live Data Interface will not require an install of MS SQL Server or Asset Framework, as a FactoryTalk Historian Server does. The install is very similar to installing a Server, except Install FactoryTalk Historian Live Data Interface on the below dialog will be selected.
This appendix is complete
343 of 458
This page intentionally left blank
344 of 458
Appendix B - FactoryTalk Historian Time Format What you will learn: After completing this lesson, you should be able to:
Understand and use different versions of time syntax with FactoryTalk Historian
Relative Time Relative time is some number of days, hours, minutes, or seconds. The leading sign (+ or -) is required. +/- d | h | m | s The default starting point for relative time is usually the current time. Therefore, a time of -8h is eight hours before the current time. Fractional times may be entered. For example, use - 1.5d for one and one-half days. Only a single operator is supported, + or -. For example, this is not supported: -1d+1h
Absolute Time Absolute times have one of the following formats:
DD-MMM-YY hh:mm:ss.ssss - day-month-year hour:minute:second
* - current time.
T - 00:00:00 on the current day (TODAY)
Y - 00:00:00on the previous day (YESTERDAY)
Monday - 00:00:00 on the most recent Monday
Sun,Mon,Tue,Wed,Thu,Fri,Sat - 00:00:00 on the most recent Sunday, Monday, ..., Saturday
For the DD-MMM-YY hh:mm:ss.ssss format, if any of the date fields are left out, they default to the current date. Time fields default to 00.
Examples
25 - 00:00:00 on the 25th of the current month
25-Aug-86 - 00:00:00 on that date
8: - 08:00:00 on the current date
25 8 - 08:00:00 on the 25th of the current month
21:30:01.02 - 9:30:01.0200 PM on the current date
345 of 458
Caution should be used with the default settings. Here are some examples of timestamps that may be confusing.
8: - 08:00:00 on the current date
:8 - 08:00:00 on the current date
::8 - 00:08:00 on the current date
:::8 - 00:00:08 on the current date
0:8 - 00:08:00 on the current date
The confusion comes from the ambiguity in the first two examples above. Following this theme, when minutes are added to the next examples, the time stamps are still similar.
8:01 - 08:01:00 on the current date
:8:01 - 08:01:00 on the current date
The difference in the two notations is evident when a date is added to the time. When a date is added to the front of the time the default notation is hh:mm:ss.ssss not :hh:mm:ss.ssss.
2 8: - 08:00:00 on the 2nd of the current month
2 :8 - 00:08:00 on the 2nd of the current month
2 ::8 - 00:00:08 on the 2nd of the current month
If extra colons and times are added that is greater than the given DD-MMM-YY hh:mm:ss.ssss format the last part of the time will be disregarded.
2 :::8 - 00:00:00 on the 2nd of the current month
2 :::8 - 00:00:00 on the 2nd of the current month
2 8:01:30 - 08:01:30 on the 2nd of the current month
2 :8:01:30 - 00:08:01 on the 2nd of the current month
A value for the seconds must be used if sub-seconds are used. Hence caution should also be used when considering timestamps containing sub-seconds.
8::30.01 - 08:00:30.0100 on the current date
:8::30.01 - 08:00:30.0100 on the current date
14 :8::30.01 - 00:08:00 on the 14th of the current month
Here are examples of timestamps that do not work.
8:30.01 - Ambiguous, 8 could be minutes or hours
:8:30.01 - Ambiguous, 8 could be minutes or hours
Combined Formats Combined time scales use both an absolute and a relative time. The absolute part of the time can be *, T, Y, or a day of the week. Examples
T + 8h - 08:00:00 AM on the current day (today)
Y - 8h - 04:00:00 PM on the day before yesterday
Mon + 14.5h - 02:30:00 PM on the most recent Monday
- 1h - One hour ago 346 of 458
Appendix C - Using FactoryTalk Historian DataLink What you will learn:
Use DataLink to display Historian Data in Excel
Understand the difference between Compressed and Sampled data
FactoryTalk Historian DataLink provides many different methods to retrieve data. A fundamental difference in many of the functions is whether you are retrieving sampled or compressed data. Sampled data is regularly spaced data where interpolated values are returned if there is not a recorded value at a particular timestamp. Compressed data is simply the actual recorded values that were archived. This exercise demonstrates the difference, but begins with an introduction to displaying data from FactoryTalk Historian in an Excel spreadsheet using DataLink.
Lab 1 – Using FactoryTalk Historian DataLink Before you begin:
FactoryTalk Historian and Interface configured and tags added as done in Lesson 1
Tags added as done in Lesson 2
Part A – DataLink Introduction 1. Verify that you are on the CLIENT image:
2. Launch Excel 2010 by selecting Start > All Programs > Microsoft Office > Microsoft Excel 2010. 3. Enter text into the spreadsheet and “widen” rows as appropriate to create a spreadsheet similar to the following:
347 of 458
4. Click in the cell under the text Temperature, then select PI > Current Value:
5. In the dialog box that appears, click the Search button to the right of the Tagnames(s) field:
348 of 458
6. Do the following steps: a. Enter Tag Mask of *TempZone1 b. Click Search c.
Pick …TempZone1 tag
d. Click OK
7. Click time at left. Then, click OK.
8. You should have the Current Value of the …TempZone1 tag with timestamp displayed such as the following. Note: If one or more of your cells filled with hash marks (##########), widen out the column(s) to make more room for the information to fit.
349 of 458
9. This Current Value will not dynamically update, but notice if you press F9, whether this cell is selected or not, the “current value” link will update (try it). Note that at times the tag’s value may not be changing for many seconds in a row, so if the value doesn’t change when you press F9, please wait several seconds and try again. 10. You can also click the Update button on the toolbar to cause the value to update automatically.
11. Click the Update button to stop or deselect automatic updates (Temperature value and timestamp should stop updating). 12. Now, select the cell under the Last Minute: text and select the Compressed Data button. Note: The “bottom half” of the button will give “preconfigured” options of “Values for yesterday”, “Values for today” and “Values for past day”. We want to configure start and end times ourselves, so click the “top half” of the button:
350 of 458
13. Make the following entries: a. Search and select the same …TempZone1 tag b. Start Time of * c.
End Time of *-1m
d. Hide count e. Show timestamps f.
Click OK
351 of 458
14. Your spreadsheet should now be showing the last minute’s worth of data from the archive. Note: Although this tag might be configured with a 1 second scan class, based on times when the tag’s value isn’t changing and also exception and compressions settings, there is not likely to be data archived every second (below graphic only showing partial data).
15. Notice that pressing F9 will continue to update the single Current Value on the spreadsheet, but seems to have no effect on updating the Compressed Data (Start Time / End Time) array. A special key combination of Ctrl – Alt – Shift – F9 will update this and other arrays you might add, as well as the single Current Value field. Please try this key combination to verify. 16. Like the F9 key, the Update button you used earlier will only update the Current Value field. However, if you click Settings to the right of the Update Button, you can change to Full Calculate and also specify a time interval if desired (minimum of 5 seconds).
17. Turn “off” automatic update (click Update button if selected to “de-select”).
352 of 458
18. Select the cell under the cell containing Last 10 Values Archived and select PI > Compressed Data.
353 of 458
19. Make the following choices: a. Select Number of Values b. Select same …TempZone1 tag c.
Start time of *
d. Number of Values of 10 e. Select backwards in time f.
Show timestamps
g. Click OK
354 of 458
20. You should see the last 10 values archived displayed. This new series of data, as well as the other data on your spreadsheet, should update with Ctrl – Alt – Shift – F9.
Note: In the last dialog you selected a Start Time of *, which specifies “now” or “current time”. You also selected backwards in time. This was necessary because otherwise the entry would try to show data “ahead” of the Start Time, instead of data archived prior to the Start Time. Perhaps fine if the start time was at some point in the past. However, by Start Time of “current” or “now”, data “ahead” of that time would have to be data archived in the future, “predicted” by FactoryTalk Historian. FactoryTalk Historian is good, but not that good! 21. When satisfied with the spreadsheet results, close the spreadsheet and save to My Documents as Temperature Report.xlsx.
Part B – DataLink Sampled vs. Compressed Data 1. Verify that you are on the CLIENT image:
2. If not already running, launch Excel 2010 by selecting Start > All Programs > Microsoft Office > Microsoft Excel 2010.
355 of 458
3. Open the file DL Samp Data.xls located in C:\Class Files.
4. Note the “preloaded” Start and End times in cells B3 and B4 (yours will not exactly match the below). Rather than “static” date/times, this spreadsheet is using a formula to enter yesterday (TODAY – 1) at 9:00am as the start time and yesterday at 9:01am as the end time. For the remainder of this lab to work correctly, this exercise assumes your Historian Server was up and running and archiving data between 9:00am and 9:01am the day before you are actually doing this exercise. If you do not think data was being archived yesterday between these times, please modify the formula to sometime when data was being archived and/or consult with your instructor for assistance. A simple option would be to use Start time of *-1m to select one minute ago, and end time of * which would mean current time or "now".
356 of 458
5. Do the following steps: a. Enter *-1m in cell B3. b. Enter * in cell B4. c.
Select cell B2 and then use the Tag Search… command on the PI menu.
6. Set the Tag Mask to *TempZone1 and then click the Search button. Select the tag …TempZone1 then click the OK button.
357 of 458
7. Select cell “D26” and then use the Sampled Data button on the PI menu. Note: If you click the “bottom half” of the button it will give you a list of pre-configured options. Click the top half to fill-in choices yourself.
358 of 458
8. Begin filling in the required parameters by clicking in the Tagname(s) field.
9. Click on cell B2 and you should see the address of that cell “fill in” the Tagname(s) field.
359 of 458
10. Check the show timestamps box, and then use the same technique detailed in steps 8 & 9 to pick the following cells: Start Time End Time Time Interval
B3 B4 B5
Your dialog should appear as follows. After confirming, click OK.
360 of 458
11. After you clicked the OK button, the “Sampled Data” columns should be filled in with equally spaced data points between the start and end times.
12. Now click in cell G26 and then select the Compressed Data button on the PI menu.
361 of 458
13. Select both the hide count and show timestamps checkboxes. Next, click in the desired field in the “Compressed Data” dialog box and click the corresponding cell in your spreadsheet to fill in the dialog as follows: Tagname(s)
B2
Start Time End Time
B3 B4
You dialog should appear as follows. Click OK.
362 of 458
14. The chart is now updated with both regularly sampled and archived (compressed) data points. Although your graph and number/frequency of points may differ from the below, you should be able to notice that you may see small discrepancies that can appear in the sampled data when a peak happens between samples. The archived (compressed) data provides a more accurate representation of what actually occurred than what you see with periodically interpolated data points. Also notice the actual number of points in the archives (from Compressed Data) are much less than the one second intervals used to display the Sampled Data. Less data in the archives to still show accurate information about data collected is a key feature of FactoryTalk Historian. Note: If your chart is “drastically different” than the following example, you may need to “refresh” as specified in the next step.
15. Also note the difference in quantity of source data points. If you want to refresh the data and update the chart, you can right-click within the Compressed Data set and choose Recalculate (Resize) Function off the context menu. You can do the same with the Sampled Data to refresh both of them.
16. Close Microsoft Excel and save your spreadsheet if you wish (it is not used later in this lab).
363 of 458
Part C - Archived data and Digital tags In the previous lab we explored the difference in sampled versus compressed retrieval of a timeseries process value. In this exercise we use the compressed data function to retrieve state changes of a digital tag. By employing some Excel logic functions we can quickly calculate some very basic metrics. In this lab we will be looking at the tag BA:Active.2 to determine the operating time percentage for a batch pump.
1. Verify that you are on the CLIENT image:
2. If not already running, launch Excel 2010 by selecting Start > All Programs > Microsoft Office > Microsoft Excel 2010. 3. Open the file DL Comp Data.xls located in C:\Class Files.
4. Select cell B2 and then type BA:Active.2 in the cell.
364 of 458
5. Select cell A7 and then choose the Compressed Data button on the PI menu.
365 of 458
6. Select the option button for Number of Values and checkbox show timestamps. Next, click in the desired field in the “Compressed Data” dialog box and click the corresponding cell in your spreadsheet to fill in the dialog as follows: Tagname(s) Start Time Number of Values
B2 B3 B4
366 of 458
7. After you click the OK button, the Time and Status columns should have been populated with state transition data. Select cell C8 and enter the formula: =IF(B7=”Active”,A8-A7,0)
8. Copy the formula in C8 to cells C9 through C23. If status is going from "Inactive" to "Active", the cell in Column C will contain zeros (0:00:00). If instead, status is going from "Active" to "Inactive", the cell in Column C indicates how long the value was "Active". The simple summation and division formulas on the right will automatically calculate a running time percentage.
9. Close Excel.
367 of 458
Part D - DataLink Trend Object FactroyTalk Historian DataLink provides a Trend Object for Excel that has the capability of charting data within Excel as well as data directly from FactoryTalk Historian. This exercise will give you experience using that object with both kinds of data.
1. Verify that you are on the CLIENT image.
2. Launch Excel 2010 by selecting Start > All Programs > Microsoft Office > Microsoft Excel 2010. 3. Open the file DL Trend.xls located in C:\Class Files.
4. Begin by selecting cell C6 and then choose the Insert Trend command on the PI menu.
368 of 458
5. On the Trend Add-in Wizard dialog, first switch the radio-button to Data from PI. Next, use the cell picker
button to select cell B5 for the Tag name.
After clicking cell B5 you need to click the
button in the Trend Add-in Wizard) .
Finally, click the Add - > button.
369 of 458
6. Now switch the radio-button back to Data on worksheet. Select the checkbox for First element is trace name. Use the cell picker
button to select a data range of cells A8 through B17.
Click the Add - > button and then the Next > button.
7. Select the Enable updates checkbox. Next, click the reference worksheet buttons for both the Start Time and End Time.
370 of 458
8. Use the cell picker buttons to select cell B2 for the Start Time and cell B3 for the End Time. Click the Next > button.
9. Set the optional Trend title to Tank Levels and then click the Format… button.
371 of 458
10. Select the Vertical Scale property. On the Options tab, change the Format to General and the Position to Outside Left. Click the OK button:
11. Click the Finish button on the Trend Add-in Wizard. 12. Enjoy your interactive trend. Trend Cursors are available just like in ProcessBook ("pull" Trend Cursor from left edge of trend not shown in below graphic). Mouse-over data point pop-ups are also available (as shown below).
372 of 458
13. Unlike a regular Excel chart, the DataLink Trend is fixed to a specific location on the worksheet. You can move or resize the trend by selecting the appropriate option on the trend’s right-click context menu. Once you click Move/Resize, you need to click and drag over all of the cells you want to "cover" with the moved and/or resized trend, then click OK.
14. Close Excel.
Part E - Time Filtered Function In this lab you are going to use the Excel PI DataLink “Time Filtered” function to view the status changes of a digital tag to determine over the last day and how much time in each hour was spent in the active state. This method performs the calculation in a single step. You will be using the tag “BA:ACTIVE.2” to determine the active state time. Function: PITimeFilter - Retrieves the amount of time where an expression is true 1. Verify that you are on the CLIENT image.
2. Launch Excel.
373 of 458
3. Open the file DataLink Time Filtered _Template.xls located in C:\Class Files.
4. Set the various time options… a. Enter a Start Time of *-1d in cell B6 (one day ago). b. Enter an End Time of * in cell B7 (current time starting now). c.
Enter a Time Interval of 1h in cell B10 (interval period for the calculation data).
d. To configure the Time Unit, on the worksheet, select Cell B11. 5. From the Excel Data menu, select Validation.
6. For the validation criteria set Allow field to List. 7. In the Source field enter: seconds, minutes, hours, days and click OK.
374 of 458
8. Select Cell B11 and click the drop down list selector icon
and select minutes
9. Next, add the expression that will be used in the Time Filtered function. Select cell B12 and enter the below expression. Important Note: The first two characters are two Single Quotations, ’’. Then, there is a single quotation after the tag name and Double Quotations before and after Active. After st you enter the expressions, the cell view only displays the 1 single quotation character. Two single quotations are required at the beginning because the first single quote tells Excel that what follows is not a “formula”. The second single quote is part of the “pair” that needs to surround the tag name BA:ACTIVE.2. Tag names have to be within single quotes, same syntax used in Performance Equations.
10. Verify the settings which will return 24 time filtered values, one value per hour in a day. These values will be the number of minutes per hour that the expression was true. Note: When you press ENTER, the first single-quote character will not be displayed. Excel is expecting that the first single-quote is indicating what follows is not a number or formula, which it is not in our case.
11. In the data output area, select Cell A15 under Date / Time.
12. From the Excel PI menu, select Time Filtered.
375 of 458
13. For each parameter click in the appropriate field and select the required cell reference as detailed below: a. Expression(s)
Cell B12
b. Start Time:
Cell B6
c.
Cell B7
End Time:
d. Time Interval (optional):
Cell B10
e. Time Units:
Cell B11
Note: To be able to select the Time Units from a selected cell rather than from the drop down list, click the cell icon then click in the field before clicking Cell B11. f.
Check show start time checkbox
14. Verify the following options and then click OK.
376 of 458
15. Review the Time Filtered data. Note: The 24 listed items are the number of minutes per hour over a 24-hour period when the expression being evaluated is true. If your Historian has not been running for very long, perhaps only the “most recent” hour or two (bottom of the list) might be considered “valid”. Times when Historian was not actively archiving might have the tag 100% of the time (60 minutes of the hour) in an “Active” state (you would see 60's listed) or 100% of the time in an “Inactive” state (you would see 0's listed)
16. Modify one or more of the time parameters (i.e. Start Time, End Time, Time Interval, and/or Time Unit) and review the data. Right-click on cell A15 and select Recalculate (Resize) Function on the context menu
Note: If the time parameters modified result in increases in size of the output data area, (more returned rows), then you may need to Recalculate (resize) Function.
377 of 458
17. A Time Filtered expression can contain multiple conditions using the logical operators OR and AND Modify the expression to use the AND operator by entering (remember first two characters are single quotations): '’BA.ACTIVE.2’=”Active” AND 'Sinusoid'>30 Note the difference in the calculation of time when this condition was met. 18. Modify the expression to use the OR operator by entering: '’BA.ACTIVE.2’=”Active” OR 'Sinusoid'>30
19. Save your work and close Excel.
This lab is complete
378 of 458
Appendix D - Using FactoryTalk Historian ProcessBook What you will learn:
Create ProcessBook files
Insert and configure Trends in ProcessBook displays
Lab 1 – Using FactoryTalk Historian ProcessBook Before you begin:
FactoryTalk Historian, Interface and other configurations made and tags added as done in Lessons 1 and 2
Part A – Single-page ProcessBook 1. Select the CLIENT image.
2. Launch ProcessBook by going to Start > Programs > Rockwell Software > FactoryTalk Historian SE > FactoryTalk Historian SE System > ProcessBook.
379 of 458
3. Close the ProcessBook demo file that opens at default.
4. From the File menu select New.
5. Select the ProcessBook (.piw) File type. Give your new ProcessBook workbook the name of Trends and click OK.
6. Again, click on the File > New option.
7. Select the ProcessBook Entry type and then click the OK button.
380 of 458
8. Set the entry Label to Basic Trends and select an entry Type of Text. Click the OK button.
9. Again, click on File > New.
10. Select the ProcessBook Entry type and then click the OK button.
11. Set the entry Label to Simple Trend and select an entry Type of Display. Set the Level to 2 and click the OK button:
381 of 458
12. You should now have a ProcessBook workbook that looks similar to the following.
13. Change to build mode by selecting the Build button on the toolbar.
14. Select the Trend button on the toolbar.
15. Drag a box in some empty space to create a trend.
16. On the General tab, click the Tag Search… button:
382 of 458
17. Set the Point Source to ftld and click the Search button:
18. Select the …TempZone1 tag (your list of tags may not exactly match the below) and click OK.
383 of 458
19. Set the Start time to *-5 Minutes and then click OK.
20. You should now have a simple interactive trend. Note: If the tag name is not appearing on the right side of your trend as in the below, you may need to go back to “Build” mode to widen out your window and the trend object itself. Finishing the trend automatically put it in “Run” mode.
384 of 458
Part B - Multi-Trend Layout Now that you have some experience building a basic trend, we will use these skills to create multiple trends arranged together. 1. Again, click on File > New.
2. Select the ProcessBook Entry type and then click the OK button.
3. Set the entry Label to Multi-Trends and select an entry Type of Display. Set the Level to 2 and click the OK button.
4. Change to build mode (if not in already) by selecting the Build button on the toolbar.
5. Select the Trend button on the toolbar.
385 of 458
6. Drag a box in some empty space to create a trend.
7. Do the following steps in this order: a. Set the Plot name to Level. b. Use the Tag Search… button to select the tag …SimpleMachineStep (refer to previous section for detailed steps). c.
Set Plot Time Start to *-5 Minutes.
d. Do NOT click the OK button. e. Last, click the New Plot button.
386 of 458
8. Do the following steps: a. Set the Plot Name to Temp. b. Use the Tag Search… button to select the tag …TempZone3 c.
Set Plot Time Start to *-3 Minutes.
d. Do NOT click the OK button. e. Last, click the New Plot button.
387 of 458
9. Do the following steps: a. Set the Plot Name to Ovens. b. Use the Tag Search… button to select both tags …TempZone2 and …TempZone4 c.
Set Plot Time Start to *-50 Seconds.
d. Do NOT click the OK button.
388 of 458
10. On the Display Format tab, select Level from the drop-down and uncheck the Value Scale Inside Axis option. Do NOT click the OK button.
389 of 458
11. On the Layout tab, fill in the following values:
Row:
1
Col:
2
ExRow:
1
ExCol:
1
These settings will cause the first (bottom) row to contain two columns (trends) and the additional second row to contain one column (trend). It is now safe to click the OK button. The only time you can access the Layout tab is during the initial creation of a new trend. Once the trend is completed, you cannot go back and edit the layout. The end result will be three “separate” trends which can be edited individually.
390 of 458
12. You should now have a lovely multi-trend.
13. Click on the Save toolbar button.
14. Save the Processbook as Trends.PIW.
15. Close the Displays and Trends.PIW processbook file (you can leave ProcessBook itself open).
391 of 458
Part C – Multi-Page ProcessBook 1. Create a new ProcessBook (.piw) File and give it the name of Production Data. Click OK.
2. With the Production Data ProcessBook open, select Tools > Preferences...
392 of 458
3. On the General tab, uncheck the Prefer Run Mode option (if not already unchecked). This will keep the processbook from going into “Run mode” as items are added. Click OK when finished.
4. Your processbook may have entered Run mode if your Run Mode Bias option was on prior to step 3 above. Put the processbook in Build mode by clicking on the build icon in the tool bar.
5. In the last section, you always used the New button to add entries to the processbook. This time, select the Insert menu and then Text.
393 of 458
6. Enter Label of Tank Levels and click OK.
7. Again, select Insert > Text and this time enter a Label of Oven Temps. 8. One more time, select Insert > Text and enter a Label of Misc 9. When finished, your processbook should appear as follows. Note the three tabs creating individual “pages” of your processbook. This is because all of the Text items you entered were at “Level 1”.
394 of 458
10. Click on the Tank Levels tab to bring that page forward.
11. Select Insert > Display
12. Enter a Label of Tank 1 and change the Level to 3 which will result in indenting the display name on the page a couple of times. Then, click OK.
395 of 458
13. A “blank” processbook display will appear.
14. As you did in Part A of this exercise, add a Trend to this display the tag that ends in …TempZone1. Use a Start Time of *-2 Minutes. Your display should appear similar to the following (may need to “widen” your trend for the long tag name to appear on the right side such as in the below example):
15. Close the Tank 1 display. It will ask you if you want to save changes, be sure to click Yes: You will actually be saving your entire processbook .PIW file (the display is embedded in it). Save to Desktop.
396 of 458
16. Your processbook should now appear as follows, with a Display named Tank 1 under the Text of Tank Levels:
17. Select Insert > Display again and name the new display Tank 2. Do not bother putting a trend or anything else on the display for now. Close and save it. Your processbook should appear as follows, with Tank 2 above Tank 1:
397 of 458
18. Obviously, if that is what you intended and prefer, no need to change anything. However, if you want to change the order you could select View > Outline. Instead of Book mode, your processbook would then appear as follows:
19. If your processbook appears in this way, with Tank 2 above Tank 1, first select Tank1 and then click the arrow up button. The order should be changed.
20. If you go back to View > Book mode, your processbook should appear as follows (you may need to click the Tank Levels tab to bring that page forward):
398 of 458
21. You may have noticed that the tabs on the right-hand side of the processbook are appearing in reverse order of how we entered them, with Miscellaneous on top and Tank Levels on the bottom. To reverse that order, go back to View > Outline mode. Select the individual lines of text that you added and use the arrow up and arrow down buttons to move the order to match the following:
22. When you go back to View > Book mode, the tabs will now be in the order you’ve specified:
23. Click on the Misc tab and select Insert > Link / OS Command. Configure the dialog box as follows. Use the Browse… button to select notepad.exe from the directory C:\Windows\System32 (be sure to look for “all files”, not just .piw or .pdi files!) Set Level to 3. Click OK when all other settings are made. Notepad will automatically open. You can close it.
399 of 458
24. When your processbook is in Run mode, you now have a link to open Notepad in case you wanted to enter some notes and save them, or open previously written notes that were saved as .txt files in case you want to read them (try it!). 25. Add another link on your Misc processbook page to launch Microsoft Excel. The path to Excel on your computer should be C:\Program Files (x86)\Microsoft Office\Office14\EXCEL.EXE. Note: As a possible enhancement, when Excel opens you could have it automatically open a particular workbook if your link is configured similar to the following (this example assumes C:\Production Report.xlsx actually exists – it does not at this time - and is a valid Excel workbook – is not at this time): C:\Program Files\Microsoft Office\OFFICE12\EXCEL.EXE" "C:\Production Report.xlsx" 26. As time allows, experiment with your processbook file adding items such as:
Add one or more displays to the Oven Temps page
Additional lines of Text as “headings” or “section dividers” on the pages
Change order tabs are displayed and/or order of items on pages
Launch additional applications from your processbook, such as the Windows Calculator, Paint, etc.
27. Save your processbook file and close ProcessBook. Also close any other applications that might have opened during this exercise, such as Excel or Notepad.
This lab is complete
400 of 458
Appendix E - Introduction to SQC Charts in ProcessBook What you will learn:
Use the SQC tool to configure control charts in ProcessBook and perform common SQC calculations.
The SQC (Statistical Quality Control) tool for ProcessBook provides a client side SQC mechanism for FactoryTalk Historian. With the add-in, users can flexibly configure SQC control charts. These charts can have advanced filtering, perform SQC statistical calculations, and even check data points against SQC alarm conditions.
Lab 1 - SQC Charting in ProcessBook Before you begin:
FactoryTalk Historian, Interface and other configurations made and tags added as done in Lessons 1 and 2
The SQC (Statistical Quality Control) tool for ProcessBook provides a client side SQC mechanism for FactoryTalk Historian. With the add-in, users can flexibly configure SQC control charts. These charts can have advanced filtering, perform SQC statistical calculations, and even check data points against SQC alarm conditions.
1. Verify that you are on the CLIENT image:
2. Launch Microsoft Excel 2010. 3. Select File > Open and open the file ProcessBook SQC Setup.xls located in the class files folder C:\Class Files 4. Choose the Export Tags… entry on the PI-SMT menu under Add-Ins.
401 of 458
5. On the Export PI Tags dialog, verify that the Mode is set to Create and then click the OK button.
6. Acknowledge the results dialog by clicking the OK button.
Note: We have exported some tags from a provided spreadsheet to serve as “simulator” tags to give us “quality-type” data that will make sense with the SQC feature of ProcessBook. In a “real application”, you would have your own tags to be used with this feature/functionality. 7. Close Excel and don’t save workbook. 8. Launch ProcessBook by going to Start > All Programs > Rockwell Software > FactoryTalk Historian SE > FactoryTalk Historian SE System > ProcessBook. 9. Close the ProcessBook demo file that opens at default. 10. Open the file SQC.PDI located in C:\Class Files
402 of 458
11. Click OK to select the SERVER Server:
12. Verify that you are in Run mode and then explore the interactive SQC chart. If you are getting a message in the middle of the chart indicating “Not enough samples”, just wait 2-3 minutes until it goes away and the SQC charts have "data":
13. Click and drag a rectangle on the data plot to zoom in to the selected area.
14. Click the Revert Time Ranges toolbar button to undo the zoom.
403 of 458
15. Double-click on the chart control to maximize it. Double-click on it again to return it to its original size and location.
16. Use the One Time Period Back and One Time Period Forward toolbar buttons to scroll through the data (may have to wait a few minutes if you get a No or not enough data points or Not enough samples message).
17. Use the Scroll Time bar to free scroll through the data.
18. Use the set time range button to look at a specific period of data.
19. Set the time span from *-4 Hour to * and click the OK button.
20. Revert back to previous time.
404 of 458
21. Use the Trend Cursor to explore the data values. Once you click the Trend Cursor tool, you may need to click and drag the cursor (like a vertical bar) from the right edge of the trend area.
405 of 458
22. Double-click on the Exercise 1: [Individuals] title bar to bring up the Statistics Window. Note that this will only work if there are enough values for a “bell curve” to be drawn such as shown below…if this won’t work for you, wait a minute or so and watch for the curve to appear:
23. Examine the various statistics and information available, eventually selecting the Plotted Data option and click on the Save Data To File button:
406 of 458
24. Save the data as sqcdata.txt to the Desktop: 25. Close the Statistics Window and open the sqcdata.txt file in Notepad.
26. When you are done examining the available statistics, close Notepad and close the ProcessBook display file and save changes (DO NOT close ProcessBook itself). 27. Click on the New toolbar button:
28. Select ProcessBook Display (.pdi) File, set the Display Name to XBar, and click OK.
407 of 458
29. Switch to Build mode and then click on the SQC Chart toolbar button.
30. Drag a rectangle on the background to create an SQC Chart.
31. On the General tab, set the following fields.
Chart Title:
X-Bar Control Chart
Chart Type:
X - Bar
Chart Tag:
stationary1
408 of 458
32. After clicking OK on the above dialog, click the Save toolbar button.
33. Save this display to Desktop as XBar.PDI. 34. Take some time to explore your recently created SQC chart. 35. When you are ready, use File > Save As… and save under a new name of Moving Avg.PDI. Remember, you already saved it as XBar.PDI so we can return to it later. For now you are giving it a different name so we can have “different versions”. 36. After saved as Moving Avg.PDI, double-click the chart to return to the configuration dialog (must be in Build mode):
409 of 458
37. On the General tab, set the Chart Title to Moving Avg Control Chart. 38. Next change the Chart Type to Moving Average. DO NOT click OK or Apply yet!
39. On the Sample tab, set the Sample Size to 5 and then click OK:
40. Click the Save toolbar button. 41. Take some time to experiment with the SQC chart. Be sure to go to Run mode to see any updates. 42. When ready, first close the current PDI (Moving Avg.PDI). Then, reopen the XBar.PDI file you saved earlier. 43. Use File > Save As… and save as the new name of XBar Time Sampled.PDI.
410 of 458
44. Double-click the chart to return to the configuration dialog (must be in Build mode).
45. We want to change the sampling algorithm. We want to take two samples every ten minutes starting on 5 and 6 minutes after the hour. On the Sample tab, make the following changes: a. Calculation Basis to “Time” b. Calculation Period to “00:10:00” c.
Sample Period to “00:01:00”
d. Start Time of Sample to “00:05:00” e. Finally, click the OK button:
46. Put the display in Run mode. Initially you may not have enough samples and it may take some time for the chart to start showing data. Experiment with the chart as desired...you may want to "come back later" (if time permits) to view data in the chart. When ready to proceed, click the Save button on the toolbar and close Processbook.
This appendix is complete
411 of 458
This page intentionally left blank
412 of 458
Appendix F - Accessing FactoryTalk Historian SE Data via OLEDB What you will learn:
Understand capabilities of using PIOLEDB Provider
Configure Reporting Services to display a report based on FactoryTalk Historian data
In this lab, you will examine some of the built-in capabilities of the FactoryTalk Historian OLEDB layer. The OLEDB layer provides convenient access to archive data, a mechanism for performing system configuration, and the ability to perform complex performance equation calculation. You will learn how to use the PI-OLEDB Tester to examine some sophisticated functionality provided by the OLEDB layer. Note: OLEDB Provider is a feature available in the Advanced Server option of FactoryTalk Historian SE. References: PI OLEDB exposes PI data in form of tables which are grouped into catalogs as listed below: piarchive pibatch pids pifunction piheading pilog pimodule pipoint piuser
contains archive related tables contains batch data tables contains PI digital state tables contains tables representing PE functions contains heading tables contains the pimessagelog table contains a set of tables representing the Module Database contains tag configuration tables (one per point class) contains user database tables
Documentation on computer with FactoryTalk Historian Server and OLDB Provider installed
C:\Program Files (x86)\Rockwell Software\FactoryTalk Historian\PIPC\OLEDB\Doc\PI OLEDB Provider 2010 R3_EN.pdf
C:\Program Files (x86)\Rockwell Software\FactoryTalk Historian\PIPC\OLEDB\Doc\PI OLEDB Provider 2010 R3 Release Notes.pdf
C:\Program Files (x86)\Rockwell Software\FactoryTalk Historian\PIPC\OLEDB\Tools\PI OLEDB Tester\ SampleStatements.txt
This lab will involve examining functionality provided by the OLEDB layer. Not only do the tables provide easy access to some PI calculations, but there are also some custom SQL functions provided to ease calculations and translations of states. 413 of 458
Lab 1 – Accessing FactoryTalk Historian SE Data via OLEDB Before you begin:
FactoryTalk Historian, Interface and other configurations made and tags added as done in Lesson 1.
Part A – FactoryTalk Historian OLEDB Basics 1. Go to the SERVER image.
2. Launch the PI-OLEDB tester application by starting the following executable… C:\Program Files (x86)\Rockwell Software\FactoryTalk Historian\PIPC\OLEDB\Tools\PI OLEDB Tester\PIOLEDBTester.exe 3. If prompted to login, select the Use Windows NT Integrated security checkbox and then click OK.
4. Select Sample Statements >>
414 of 458
5. In the Archive Statements category, there are 34 sample queries. To help understand the statement functionality, each statement is accompanied with a short comment. Review entries to see how to handle the following types of situations:
Translating a digital state or status
Retrieve snapshot data
Count archive entries
Work with annotations
Work with timestep interpolated data
Use SQL CASE statement
6. Click on various Sample SQL Statements and click Execute. Review results displayed at the bottom of the dialog. 7. If you like you can try editing one of the SQL Statements or try entering one of your own, executing and reviewing results. 8. Close PI-OLEDB Tester and any open dialogs or windows (except SoftLogix Chassis Monitor if open).
415 of 458
Part B - Using Microsoft Reporting Services SQL Server 2008 Reporting Services SQL Server 2008 Reporting Services is a server-based reporting platform that can be used to create and manage tabular, matrix, graphical, and free-form reports that contain data from relational and multidimensional data sources. The reports can be viewed and managed over a World Wide Webbased connection. Reporting Services includes the following core components: Complete set of tools that you can use to create, manage, and view reports Report Server (NT Service) component that hosts and processes reports in a variety of formats. These (output) formats include HTML, PDF, TIFF, Excel, CSV, and more. One of the sources of data that Reporting Services can work with is OLEDB Providers. The PI OLEDB is pre-installed on the SERVER image.
1. Verify that you are on the SERVER image.
2. From the Start Menu, launch the SQL Server Business Intelligence Development Studio by selecting Start > All Programs > Microsoft SQL Server 2008 R2 > SQL Server Business Intelligence Development Studio.
3. On the File menu, point to New, and then click Project…
416 of 458
4. In the Project types list, click Business Intelligence Projects (see below graphic). 5. In the Templates list, click Report Server Project. 6. In the Name field, enter FTH MSReport. 7. Click OK to create the project.
8. The FTH MSReport solution will be displayed momentarily in Visual Studio (VS) Solution Explorer view (a window on the right side).
9. You need to specify the target Server URL for the project. If the properties page is not automatically displayed when creating the report, in the Solution Explorer, right-click FTH MSReport and click Properties.
417 of 458
10. Set the Target Server URL to http://localhost/ReportServer (see below). 11. Click OK.
Note: In order to collect data from the Historian server, you need to create a connection to the Historian server. In this lab, you will add a shared data source via PI OLEDB. 12. Right-click the Shared Data Sources folder and select Add New Data Source
13. The Shared Data Source dialog box appears. 14. Enter PIOLEDB in the Name field. 15. Select OLE DB from the Type: drop-down list. 16. Click the Edit… button to fill in the PI OLEDB connection properties (you will do in following steps).
418 of 458
17. Select OLE Provider to PI OLE DB Provider from the drop-down list 18. Enter SERVER into Server or file name field. 19. Specify Use Windows NT Integrated Security. 20. Verify that the following options are selected and entered correctly in the image below.
21. Click Test Connection. 22. Verify that the connection succeeded and click OK, and OK again
419 of 458
23. Add the following to the Connection string: ;Integrated Security = SSPI
24. Verify the above configuration options and click OK. 25. After the data source is defined, Report Designer creates a dataset (you named it PIOLEDB). 26. To create a report definition file, in the Solution Explorer right-click Reports, point to Add, and click New Item...
27. Select Report Wizard. 28. In Name field, leave the default name Report1.rdl. 29. Click Add.
420 of 458
30. The Report Wizard welcome page will be displayed. Click Next.
31. Verify the shared data source is set to PIOLEDB.
32. Click Next.
421 of 458
33. In the design query type the following: SELECT tag, time, value, status FROM piarchive..picomp WHERE tag LIKE ? AND time >= ? AND time button to move “tag” into the page display field. 38. Select time and click Group > to move “time” into the Group display field. 39. Select Value and Status and click Details > to move “value” and “status” into the details display field. 40. Verify that the following groups have been configured.
41. Click Next. 42. Select the default Stepped.
43. Click Next. 44. Select the default Slate.
45. Click Next.
423 of 458
46. In Report Name field, leave the default report name Report1.
47. Click Finish. 48. A view opens that contains Design and Preview tabs; the report opens in Design view (may need to click on Design to give it focus).
424 of 458
49. From the Report Data window on the left, double-click on Parameter1
50. Configure the Parameter1 properties with the following settings: a. Prompt:
Tag Mask
b. Data type: Text c.
Click OK
51. Repeat the parameter configuration steps for Parameter2 with the following settings a. Prompt:
Start Time
b. Data type: Date/Time 52. Repeat the parameter configuration steps for Parameter3 with the following settings a. Prompt:
End Time
b. Data type: Date/Time
425 of 458
53. From the Visual Studio design view window select the Preview tab to preview Report1.
54. Set the parameters to the following: a. Tag Mask: *TempZone1 b. Start Time: Date and Time of 5 minutes ago (for example, 9/24/2012 6:01:00 PM) c.
End Time: Date of tomorrow
55. Click View Report and observe the results.
56. In the Solution Explorer on the right side of Visual Studio, right-click on FTH MSReport and select Deploy. 57. Lower-left corner of Visual Studio should say Deploy started…and then watch for succeeded messages.
58. Right-click on the Report1.rdl report and select Deploy.
426 of 458
59. Watch for succeeded messages.
60. Close Visual Studio. 61. Start Internet Explorer by going to Start > All Programs > Internet Explorer
62. Type in address of http://server/Reports. 63. Click FTH MSReport.
427 of 458
64. Click Report1.
65. Set the parameters to the following: a. Tag Mask: *TempZone1 b. Start Time: Date and Time of 5 minutes ago (for example, 9/24/2012 6:01:00 PM) c.
End Time: Date of tomorrow
d. Click View Report
66. Enjoy your Internet Explorer report based on FactoryTalk Historian data!! 67. Close Internet Explorer.
This lab is complete
428 of 458
Appendix G - VantagePoint Dashboards with Historian Data What you will learn:
Create a simple VantagePoint Dashboard
Display Dashboard in VantagePoint Portal
Lab 1 – VantagePoint Dashboards with Historian Data Before you begin:
FactoryTalk Historian, Interface and other configurations made and tags added as done in Lesson 1.
FactoryTalk VantagePoint configured and Historian Tags imported as done in Lesson 3.
Part A - Creating a Dashboard Report from a Template 1. Go to the CLIENT Image.
2. Start Xcelcius 2008 from the desktop icon or Start > All Programs > Xcelsius > Xcelsius 2008.
3. Click Continue when prompted. 4. Wait until all of the Xcelsius windows open, including an instance of Microsoft Excel in the lower-center of the screen. 5. We will use a partially completed template and add functionality to connect to Historian tags via VantagePoint. In the Xcelsius menu at the top of the screen, select File > Open and open C:\Class Files\Dashboard Template.xlf.
429 of 458
6. In the Microsoft Excel window in the middle of the screen, click on cell C3 (red cell). Select VantagePoint tab, Insert button.
7. Select History and click Next (Next button is not shown below):
430 of 458
8. In the VantagePoint Model, navigate to System > Sources > FactoryTalk > localhost > Historians > Production Historian and click on Tags. Select the …TempZone1 tag and move it to the right with the > button. Click Next.
9. Select Use this Range and then click New….
431 of 458
10. Browse to MyEnterprise > Samples v4 > Support > Report Library > Time Periods, select the Last 1 minute time period and move it to the right with the > button. Click Next (not shown).
11. Be sure the Skip advanced options is NOT selected or “unchecked”, and click Next.
432 of 458
12. Select Average and number of samples of 1. Click Finish (not shown) and wait for the spreadsheet to populate with data.
13. Click on cell C12 (green cell).
433 of 458
14. Select the VantagePoint tab > Insert function again. Select History and after clicking Next you will see this screen. We are using the same tag, so just click Next.
15. We are using the same time range, so select Use this Range and click Next.
434 of 458
16. Do NOT select Skip advanced options and click Next.
17. This time click the Count option, number of samples at 1 and then Finish.
18. On the canvas area, click on Label 1.
19. On the right side of the screen in the General area (may need to click on it to give it focus), click the Link to Cell option and click the “cell picker” button (may need to widen this window for the "cell picker" to appear).
435 of 458
20. Select cell D6 and click OK.
21. Select Gauge1. On the right of the screen click the General area. Specify the Title to be Average Temperature. Browse to select Data By Range from cell D9 and set Maximum limit to 400.
436 of 458
22. Also on Gauge1, go to Appearance > Text tab and click on Value (make sure it remains "checked"). Below in the Number Format area, change to Numeric and select 2 Decimal Places.
437 of 458
23. Select Gauge2 on the canvas in the center of the screen. On the right, in the General area, specify the Title to be Number of Values and browse to set Data By Range to cell D18 and change Maximum Limit to 1000.
24. Resize your objects as desired and add color or other options of your choice.
438 of 458
25. Select View > Canvas Sizing > Fit Canvas to Components.
26. From the Data menu in Xcelsius (not the Excel menu) select Connections…
27. Click Add and then Excel XML Maps.
439 of 458
28. Click Add and then Flash Variables.
29. Click Connection 1 Flash Variables.
30. Click Import Named Ranges. Items will be added.
440 of 458
31. Click the first ExcelXML Map.
32. Select the Usage tab. Turn on Refresh Before Components Are Loaded and Refresh every 30 seconds.
33. On the Definition tab, select the “cell picker” button.
34. Select cell C3 (red cell) and click OK.
441 of 458
35. Select the second ExcelXML Map and set the Usage tab as follows:
36. On the Definition tab, use the “cell picker” button and select cell C12 (green cell).
37. Close the Data Manager dialog. 38. Select File > Save As on the Xcelsius menu and save your dashboard as C:\Class Files\MyTemperatureReport.xlf.
39. Select File > Export > Flash (SWF)…
442 of 458
40. Save to C:\Class Files directory as MyTemperatureReport.swf. Note: You will see the following dialog while the SWF file is being generated.
Part B - Publish and View the Dashboard from the VantagePoint Portal 1. From the Excel VantagePoint ribbon bar, Publish.
2. Use the icons to browse to the SWF and XLF files. Click Next.
3. Check the TimePeriods box to allow users change the TimePeriod as a Parameter in the report (you will see what this means when you view your report). Click Next (not shown).
443 of 458
4. Browse to the Reports folder under MyEnterprise > MyPlant and name the report MyTemperatureReport. Click Next (not shown).
5. Check the box for Browse to published dashboard and click Finish (not shown).
6. The report should soon appear, similar to the following. Approximately every 30 seconds you should see the two values update.
444 of 458
7. Note that you can select a different relative time period and click Generate Report and the gauges will reflect that average and count.
8. Note that you can select any Absolute Time Period and the report will reflect your choice when you click Generate Report.
9. Close VantagePoint Portal and Xcelsius.
This lab is complete
445 of 458
This page intentionally left blank
446 of 458
Appendix H – FactoryTalk Historian Advanced Calculation Engine (ACE) Overview What you will learn:
Overview of ACE, its Features and Components
Introduction Historian Advanced Computing Engine (ACE) allows programming of complex calculations (for example, heat and material balances, data reconciliation, real-time cost accounting, and batch summary); communication applications (for example, alarming, emailing, and paging); data transfer programs; and any other application that does not require user intervention. ACE consists of the following components: ACE Wizard, ACE Manager, and ACE Scheduler. The functionalities and requirements for each component differ and are discussed in detail later. ACE can be used in either the Microsoft Visual Basic 6 (VB6) or the Microsoft Visual Basic .NET (VB.NET) development environment. Because of the significant differences in the integrated development environments (IDEs) for VB6 and VB.NET 2005/2008/2010, Rockwell Automation provides two versions of ACE: ACE for VB6 (ACE 1.x) and ACE for VB.NET (ACE 2.x). The 1.x and 2.x nomenclature is retained for consistency with usage in earlier releases of ACE. For more information, see “Differences Between ACE for VB6 and ACE for VB.NET” in FT Historian ACE User Guide for Visual Basic .NET.pdf. Note: ACE is a feature available in the Advanced Server option of FactoryTalk Historian SE.
Features The main features for the Historian Advanced Computing Engine (ACE) are as follows:
To implement complex calculations (for example, iterative solutions, data and time manipulation, and numerically solving ordinary or partial differential equations)
To provide a fault-tolerant and redundant architecture.
To retrieve data from, and send results to, Historian tags or to other systems.
To apply one set of equations to multiple units or processes.
To provide various scheduling features: clock, natural, event, equation ordering, and graceful degradation under resource limitations (CPU loading).
To use multiple Historian tags from multiple Historian Servers in calculations.
To provide the ability to use the previous snapshot value for a Historian tag (instead of the previous archive value) in calculations.
To allow documentation or comments with a set of equations.
To allow clamping and bad-value substitution of inputs and outputs.
To provide the ability to call COM and .NET objects and a library of user-written functions. 447 of 458
To provide the ability to test and debug equations.
To provide the ability to make different users responsible for different groups of equations.
To provide the ability to migrate from Historian 2 and Historian 3 performance equations.
To provide the ability to monitor performance of individual equations.
To provide robustness, including trapping floating-point errors and avoiding repetitive message logs.
To expose calculations via a Web service.
To allow automatic recalculation when past data are changed.
To manually recalculate an ACE Context.
Components A set of calculations or instructions is implemented in a VB.NET class, which is referred to as an ACE Module. The components of ACE that develop, monitor, manipulate, and execute ACE Modules are as follows:
ACE Wizard
ACE Manager
ACE Scheduler
ACE Components and Their Common Data:
The ACE Wizard is a Visual Basic Add-In to help users build and test ACE Modules quickly, the ACE Manager lets users monitor and change various properties of ACE Modules, and the ACE Scheduler executes ACE Modules in a timely manner and handles updates and abnormal behavior. The structural information for ACE Modules is stored in the Historian Module Database. While the ACE Scheduler and the class library files (.dll files) for all ACE Modules need to be on the same computer, 448 of 458
the ACE Wizard, the ACE Manager, the ACE Scheduler, and the Historian Server that stores the ACE structural information may be on different computers.
Structure of ACE Modules The overall structure of the ACE Modules is shown below. All the ACE Modules developed with VB.NET are listed under the ACEClassLibraries tree in the Historian Module Database (Historian MDB).
Each ACE Module developed with ACE for VB.NET corresponds to a class in a VB.NET Class Library project. The project is referred to as ACE Executable (even though the .NET Class Library project is actually a .dll assembly). ACE Executables can be developed and maintained by different users. Each ACE Executable can contain multiple ACE Modules. Each ACE Module can perform calculations for different modules in Historian Module Database (that is, on different ACE Contexts). For example, if identical calculations need to be carried out for reactor #1 and reactor #2, then only one set of equations needs to be developed and maintained, but can be run on different ACE Contexts. This greatly facilitates the development and maintenance of calculations for similar units or processes. The maximum number of ACE Executables may be limited by the computer resources. Each ACE Executable runs in its own process and thus is independent of other ACE Executables. One advantage of putting multiple ACE Modules in one ACE Executable is that only one set of .dll files needs to be loaded, reducing the overall memory usage.
449 of 458
Configuration and System Requirements ACE consists of the following components: ACE Wizard, ACE Manager, and ACE Scheduler. The components of ACE can be installed on different computers. To develop and run ACE Modules, a Historian Server version 2.0 and later is required to store the structural information of ACE Modules in the Historian Module Database (MDB). This server is referred to as the ACE Data Server. The actual Historian tags used in calculations or for archiving results in an ACE Module could come from either the ACE Data Server or other Historian Servers .
ACE Scheduler The ACE Scheduler can be installed on an ACE Data Server or on a client computer. The computer must have:
Windows XP, Windows Server 2003, Windows 7, Windows 7, or Windows Server 2008 with latest service pack Note: We recommend running ACE Scheduler on server operating systems (for example, Windows Server 2003 and Windows Server 2008) in production environments.
Microsoft .NET Framework 2.0 or higher
PI SDK 1.3.8.387 or higher for 64-bit and PI SDK 1.3.8.388 or higher for 32-bit
PI API 1.6.2.4 or higher
Connection to a Historian Server 2.0 and later with read/write privileges
Where the ACE Scheduler should be installed depends on many factors. The most important consideration is the tradeoff between the CPU load and the network load. If the ACE Scheduler is installed on the ACE Data Server, it would increase the CPU load on the server but it would have minimal impact on the network. If the ACE Scheduler is installed on a client computer, executing ACE Modules would not impact the ACE Data Server CPU load (other than the normal data retrieval calls to the server) but the frequent communication between the ACE Scheduler and the server might affect the network load. To run the ACE Scheduler, appropriate security should be set up for the ACE Scheduler to access the ACE structural information on the ACE Data Server. For details on how to set up a trust relationship between the ACE Scheduler and the ACE Data Server, see Security (page 28). While ACE Schedulers for both versions can be run simultaneously, only one instance of the ACE Scheduler for each version can be run on a computer.
ACE Manager The ACE Manager can be installed on any computer. Different access levels (for example, no access, read-only, and read/write) to a Historian Server can be set up through the Trust table. The requirements are the following:
Windows XP, Windows Server 2003, Windows 7, Windows 7, or Windows Server 2008 with latest service pack
PI SDK 1.3.8.388 or higher
450 of 458
ACE Wizard The requirements for ACE Wizard are the following:
Windows XP, Windows Server 2003, Windows 7, Windows 7, or Windows Server 2008 with latest service pack
Microsoft Visual Studio 2005, 2008, or 2010 (either Enterprise or Professional Edition)
Microsoft .NET Framework 2.0 or higher
PI SDK 1.3.8.388 or higher
Connection to a Historian Server 2.0 and later with read/write privileges
Installation The installation program is called Setup and contains both ACE for VB6 (ACE 1.x) and ACE for VB.NET (ACE 2.x). Before running Setup, verify that the target platform meets the requirements specified in Configuration and System Requirements. Setup automatically installs PI SDK, Microsoft .NET Framework, and other components if they are not already installed. Because Setup might write entries to shared portions of the registry, it is necessary to log in as a user with Administrator privileges on the system. It is advisable to close other applications while running Setup. If a FactoryTalk Historian System is running on the target machine, you need not stop the system. By default, ACE is installed under the pipc directory (that is, pipc\ACE). Follow the instructions of the Setup program to install appropriate components on the target machine. You may choose to install ACE Wizard, ACE Manager, and/or ACE Scheduler. Upon successful installation, ACE registers its Uninstall, which enables you to uninstall by clicking Start > Control Panel > Add/Remove Programs. To install all features silently, the command is: msiexec /i piace.msi /q To install selected features silently, the command is: msiexec /i piace.msi ADDDEFAULT="FeatureList" /q where FeatureList is a list of features to be installed, separated by commas. piace.msi consists of these features: Core, ACEManager, ACE1.x_Wizard, ACE2.x_Wizard, ACE1.x_Scheduler, and ACE2.x_Scheduler. The Core feature must be installed for any other ACE component to function. For example, the following installs ACE Manager and ACE for VB.NET (ACE 2.x) Wizard: msiexec /i piace.msi ADDDEFAULT="Core,ACEManager,ACE2.x_Wizard" /q In a silent installation, piace.msi does not check for component requirements, nor does it install any required components (for example, .NET Framework and PI SDK). To install the whole package silently, modify the silent.ini file delivered in the install kit. See Historian Server Installation and Upgrade Guide for details on how to do this.
Types of Scheduling The type of scheduling determines when a calculation will be performed. There are two types of scheduling, clock and natural, available in ACE. The scheduling information applies to an ACE Context (that is, an instance of ACE Module).
451 of 458
Clock Scheduling With clock scheduling, an ACE Context is evaluated at fixed intervals. Two attributes, period and offset, determine when to evaluate the ACE Context. The period specifies the interval between calculations and the offset specifies the time since midnight. While the period can use fractional seconds, the offset should be an integer between 0 and 86399 seconds. When specifying a small period (the smallest period allowed is 0.001 second), make sure that the resources (for example, CPU and network) are adequate. The clock for the Historian Server specified in the ACE Context (for example, aceserver2k3 for an ACE Context of \\aceserver2k3 and MyPIServer for \\MyPIServer\MyPIModule\Controllers\PID) is used to generate the calculation times.
Natural Scheduling Natural scheduling means that an ACE Context is evaluated whenever one of its trigger Historian tags receives a new snapshot event. The trigger tags must be a subset of input tags or aliases used in the ACE Module. Tags or aliases used as both input and output cannot be used as trigger tags, because this can easily result in an infinite loop if not handled properly. By default, the calculation result has the same timestamp as the trigger tag event. Natural scheduling is highly accurate; it has the same effect as if the calculation were performed continuously.
Event Scheduling There is another type of scheduling in the Performance Equation subsystem (PIPE) called event scheduling (that is, evaluate an equation when certain conditions are met). This has been eliminated in ACE since any condition can be directly specified programmatically within an ACE Module. For example, suppose we would like to evaluate an ACE Module (and send results to Historian Server) only when the Historian tag pumpstatus is ON. This can be accomplished by specifying the tag pumpstatus as a trigger tag and by including the following condition in the ACE Module: : If UCase(pumpstatus.Value) "ON" Then mblnSendDataToPI = False Exit Sub End If ' Code for carrying out actual calculations : Equation Ordering
Equation Ordering Unlike the PIPE Subsystem where each tag consists of its own calculations and does not depend on calculations for other tags, an ACE Module can contain calculations for many tags. Thus, it is a simple task to programmatically order the calculations within the ACE Module. However, calculations in different ACE Modules may be executed in an arbitrary order.
452 of 458
Message Logs ACE messages are logged to the central log file for the Message Subsystem and can be retrieved using the pigetmsg utility. See the Historian Server System Management Guide for details. Different levels of message logging are available for each ACE Context (that is, ACE Module performing calculations on a specific Historian Module) and the ACE Scheduler.
Scaling ACE Schedulers to Multiple Machines You can configure multiple ACE Schedulers on multiple machines to simultaneously run different ACE class libraries stored on Historian MDB. However, one class library must belong to one and only one scheduler. The default ACE Scheduler is responsible for all the class libraries created using the ACE Wizard. You would need to use the ACE Manager to change the ACE Scheduler for each class library. The ability to simultaneously run different sets of class libraries using multiple ACE Schedulers allows you to distribute resource intensive calculations across multiple machines.
High Availability In addition to simultaneously running different sets of ACE class libraries on multiple machines (scaling), you can also configure redundant ACE Schedulers on multiple machines against these sets of class libraries. Only one of these ACE Schedulers (the master ACE Scheduler) would actually run the calculations while the rest are in a standby mode. When the master Scheduler stops either gracefully or ungracefully, one of the standby ACE Schedulers becomes the master and runs the calculations. With proper buffering setup, ACE automatically sends data to all members in a server collective. Since the HA buffering is not currently supported on a Historian Server, you should not run the ACE Scheduler on a Historian Server if you need to send data to all members of a server collective. When retrieving data from a Historian Server collective, ACE Scheduler automatically connects to the available collective member. For more information, see the High Availability Administrator Guide.
References For additional details and information, see FT Historian ACE User’s Guide for Visual Basic.NET.pdf.
453 of 458
This page intentionally left blank
454 of 458
Appendix I – FactoryTalk Historian to Historian Interface Overview What you will learn:
Understand Concepts of Using FactoryTalk Historian To Historian (H2H) Interface
Recognize Supported Architectures and Licensing Requirements of H2H Interfaces
Introduction The Rockwell FactoryTalk Historian to Historian interface copies tag data from one Historian Server to another. Data is moved in one direction, meaning data is copied from the source to the receiving Historian Server (also referred to as target Historian Server). The interface must run on a Windows Intel-based operating system. Note: The Rockwell FactoryTalk Historian to Historian interface functions and is configured the same as the standard Rockwell Automation PItoPI interface, with the exception that this interface can only connect to FT Historians. Interface tags are created on the receiving Historian Server. Each interface tag is configured to receive data for a unique source tag. Tags receive either archive or exception data updates from the source tag. Exception data is data that has not yet been subjected to compression. The type of data collection, exception or archive, is configured through scan class assignment. By default, all tags belonging to the first scan class receive exception data. Tags assigned to any other defined scan class receive archive data. The interface supports history recovery. History recovery enables users to recover data for time periods when the interface was not running or otherwise unable to collect data. The history recovery period is configurable; the default is 8 hours. Users have the option of performing time-range specific history recovery by specifying a start and end time. In this configuration the interface collects data for the specified time period then exits. Both source Historian Server-level failover and UniInt Phase 2 interface level failover are supported. When running in source Historian Server-level failover mode, the interface obtains data from one of two available source Historian Servers. The source Historian Servers must have identical tag definitions and data streams for each interface source tag. This requirement ensures the interface will obtain the same data regardless of which source server is active. When running in UniInt Failover mode, two copies of the interface are connected to the source Historian Server at the same time. When the primary interface stops collecting data, the backup interface assumes the primary role and continues data collection. Source Historian Server-level failover and UniInt Phase 2 interface level failover modes can be run simultaneously. Failover maximizes interface data availability on the receiving Historian Server(s).
455 of 458
Interface Limitations The FactoryTalk Historian to Historian interface is not a true data replication tool. It does not synchronize Historian Server data or perform data validation. It simply provides a method for copying data from one Historian Server to another in an incremental, time forward manner. There is no guarantee that an exact archive data match will exist between the source and receiving Historian Servers. If the goal is to achieve data matching (replication) Rockwell Automation recommends using n-way buffering which is supported with PI API v1.6.x and later. Please see the PI API installation manual for details. The Historian Archive subsystem may temporarily queue data in memory prior to it being committed to disk. This can lead to data gaps when using Historian to Historian for real-time data collection with history recovery enabled. To avoid data gaps the recommended configuration is to run in history recovery only mode without snapshot updates. Note that this means current real-time data from the source Historian Server will not be available on the target Historian Server. The interface is a PI API based application. It does not currently support tag annotations, which are only available through the PI SDK. This means it cannot be used to copy Batch Database data between Historian Servers. The interface is a single threaded process. This design increases performance dependencies on the responsiveness of the source and receiving Historian Servers and dependencies on network quality. It is highly recommended that users use tools such as Rockwell Automation’s Performance Monitor interface and Historian Ping interface to monitor these interface dependencies. These interfaces are distributed by default with the latest Historian Server setup kit. This information will be invaluable for troubleshooting Historian to Historian interface issues if they should arise. Using these tools to monitor system health is also part of Rockwell Automation’s Best Practices Recommendations for FactoryTalk Historian System Mangers.
Supported Architectures The FactoryTalk Historian To Historian Interface is used to transfer data from a Rockwell Historian Server (Source Server) to another Rockwell Historian Server (Target Server). This includes a Rockwell FactoryTalk Historian ME module, a FactoryTalk Historian SE server or a collective of FactoryTalk Historian SE 3.0 servers being transferred to another Rockwell FactoryTalk Historian SE 3.0 server or a collective of FactoryTalk Historian SE 3.0 servers.
Continued…
456 of 458
The diagram below presents a typical architecture topology for the FactoryTalk Historian To Historian Interface:
The H2H Interface can be installed on the following architectures:
In all the architectures only a FactoryTalk Historian SE 3.0 server may function as the Target Server. If the Target Server is an OSI PI Server, you need to install the OSI PItoPI Interface, rather than the Rockwell H2H Interface.
Continued…
457 of 458
Licensing To use the FactoryTalk Historian To Historian Interface, you need to purchase an H2H license activation file, activate the interface using FactoryTalk Activation Manager, and assign the license activation to the Target Server using the FactoryTalk Administration Console. Assign FHSE activation to the target FactoryTalk Historian SE Server in properties.
After you have assigned the activation file to the server, a point source FTSS has been created and set to unlimited. You can check it in the Point Sources tab.
You need to restart the server for the changes to take effect.
Prior to using the Historian To Historian (H2H) Interface, steps must be completed related to the following. See FactoryTalk Historian To Historian Interface Installation and Configuration Guide for details.
Installing FactoryTalk Historian To Historian Interface
Configuring FactoryTalk Historian To Historian Interface o
Create an Interface Instance in the ICU
o
Create a Target Point on the Target Server
o
Configure a Trust on the Target Server
o
Configure a Trust on the Source Server
o
Start the H2H Interface
o
Verify the H2H Interface
References For more information and details related to the FactoryTalk Historian To Historian Interface, see the following:
FactoryTalk Historian To Historian Interface Installation and Configuration Guide
FactoryTalk Historian To Historian Interface User Guide
458 of 458
View more...
Comments
