You are on page 1of 112

FactoryTalk Historian Site Edition: Advanced Lab

For Classroom Use Only!

Important User Information


This documentation, whether, illustrative, printed, online or electronic (hereinafter Documentation) is intended for use only as
a learning aid when using Rockwell Automation approved demonstration hardware, software and firmware. The Documentation
should only be used as a learning tool by qualified professionals.
The variety of uses for the hardware, software and firmware (hereinafter Products) described in this Documentation, mandates
that those responsible for the application and use of those Products must satisfy themselves that all necessary steps have been
taken to ensure that each application and actual use meets all performance and safety requirements, including any applicable
laws, regulations, codes and standards in addition to any applicable technical documents.
In no event will Rockwell Automation, Inc., or any of its affiliate or subsidiary companies (hereinafter Rockwell Automation) be
responsible or liable for any indirect or consequential damages resulting from the use or application of the Products described in
this Documentation. Rockwell Automation does not assume responsibility or liability for damages of any kind based on the
alleged use of, or reliance on, this Documentation.
No patent liability is assumed by Rockwell Automation with respect to use of information, circuits, equipment, or software
described in the Documentation.
Except as specifically agreed in writing as part of a maintenance or support contract, equipment users are responsible for:

properly using, calibrating, operating, monitoring and maintaining all Products consistent with all Rockwell Automation
or third-party provided instructions, warnings, recommendations and documentation;

ensuring that only properly trained personnel use, operate and maintain the Products at all times;

staying informed of all Product updates and alerts and implementing all updates and fixes; and

all other factors affecting the Products that are outside of the direct control of Rockwell Automation.
Reproduction of the contents of the Documentation, in whole or in part, without written permission of Rockwell Automation is
prohibited.
Throughout this manual we use the following notes to make you aware of safety considerations:
Identifies information about practices or circumstances
that can cause an explosion in a hazardous environment,
which may lead to personal injury or death, property damage, or economic loss.

Identifies information that is critical for successful application and understanding of the product.

Identifies information about practices or circumstances that can lead to personal injury or death, property
damage, or economic loss. Attentions help you:
identify a hazard
avoid a hazard
recognize the consequence

Labels may be located on or inside the drive to alert people that dangerous voltage may be present.

Labels may be located on or inside the drive to alert people that surfaces may be dangerous temperatures.

FactoryTalk Historian Site Edition: Advanced Lab

Contents
Before you begin ........................................................................................................................................... 4
About this lab .................................................................................................................................................................................... 4
Tools & prerequisites ........................................................................................................................................................................ 4
Lab 1 - Understanding and Using Exception and Compression ................................................................... 6
Lab 2 - FactoryTalk Historian Tag Types .................................................................................................... 14
Lab 3 - Using Performance Equations and Totalizers ................................................................................ 21
Section 1 Performance Equations ............................................................................................................................................... 21
Section 2 - Totalizers ...................................................................................................................................................................... 30
Lab 4 FTLD Interface Buffering and Redundancy ................................................................................... 35
Section 1 - Interface Buffering ........................................................................................................................................................ 35
Section 2 - Interface Redundancy................................................................................................................................................... 42
Lab 5 - Using and Displaying Audit Information .......................................................................................... 60
Lab 6 - Backfilling Data into a FactoryTalk Historian SE Server................................................................. 68
Lab 7 FactoryTalk Historian SE Archive Management ............................................................................ 88
Lab 8 Viewing FactoryTalk Historian Data using VantagePoint Mobile ................................................... 96

3 of 112

Before you begin


If not already done, the following steps must be completed before starting the lab exercise:

1. Set VMware images (DATA, SERVER and CLIENT) to Start snapshots.


2. Start the VMware images for the labfirst SERVER until fully running, then DATA until fully running and finally
CLIENT until fully running.
About this lab
Welcome to the FactoryTalk Historian Site Edition Advanced Lab! This session provides you with an opportunity to explore more
advanced features of FactoryTalk Historian Site Edition. The following sections explain what youll be doing in this lab session,
and what you will need to do to complete the hands-on exercises.
FactoryTalk Historian Site Edition is a solution for optimizing your manufacturing process through the analysis of historical data.
Historian provides the capability to collect, store, analyze, and visualize data using a powerful capturing engine and a powerful
set of reporting tools such as time-series trends and easily generate reports using Microsoft Excel.
This lab is a pick and choose lab, with eight (8) different labs to choose from. Each lab will take about 30-45 minutes, so it is not
expected that you will finish all eight labs. You will be able to download this manual after Rockwell Automation TechED, for
further learning later.

Tools & prerequisites


Software
This hands-on lab uses the following software:
Microsoft Windows Server 2012 R2
Microsoft Windows 8.1 Enterprise
Microsoft Internet Explorer, version 11
Microsoft Excel 2010 32-bit SP2 and 2013 32-bit
Microsoft SQL Server 2012 64-bit
FactoryTalk Historian Site Edition, version 4.0
FactoryTalk VantagePoint, version 6.1
FactoryTalk Services Platform, version CPR 9 SR 7.1
RSLogix Emulate 5000, version 21.03.00 (CPR 9 SR 5.1)
Studio 5000, version 21.03.00 (CPR 9 SR 5.1)
RSLinx Classic, version 3.51.01 (CPR 9 SR 5.1)
RSLinx Enterprise, version 5.71.00 (CPR 9 SR 7.1)

4 of 112

Image configuration/content
One (1) host computer with VMware virtualization software will host three guest operating systems for a total of three virtual
computers in a workgroup. The VMware images are named and basic contents are as follows:

DATA: A Windows 2012 R2 Server computer to act as a data collector using a FactoryTalk Live Data Interface.

SERVER: A Windows 2012 R2 Server computer to act as a FactoryTalk Directory and FactoryTalk Historian Site
Edition and VantagePoint Servers. Internet Information Server (IIS), Microsoft SQL Server 2012 Standard Edition have
also been pre-installed. RSLogix Emulate 5000 controllers and RSLinx Enterprise are on this image as well.

CLIENT: A Windows 8.1 Enterprise computer to act as a client for FactoryTalk VantagePoint.

Communications Overview:

Host PC
Virtual Ethernet

DATA
(FactoryTalk Live Data
Interface)

SERVER
(FTDirectory,
FTHistorian SE and
FTVantagePoint
Servers, Emulate 5000
and RSLinx)

5 of 112

CLIENT

(FTVantagePoint Clients)

Lab 1 - 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

Part A - Filter Less with Exception/Compression

1. Start on the Client image.

2. Start System Management Tools (SMT) by clicking on the taskbar.

6 of 112

3. Do these steps in this order:

Select Points > Point Builder.

Search for and display the tag ending in *MachineStep.

Click on this tag in the upper pane to make sure it has focus.

Click the Archive tab.

4. Note that this tag currently has default Exception and Compression attributes, unchanged since this tag was
added to Historian from the FactoryTalk Administration Console using Add Individual Historian Points. Verify
these attributes are currently set as follows:

Exception Deviation: 0.25 Eng. Units

Compressing: On

Compression Deviation:0.5 Eng. Units

5. Do the following steps in this order:

Select Data > Current Values.

Search for and display the tag ending in *MachineStep.

Click Start Updating.

7 of 112

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:

Go to Data > Archive Editor.

Search for the tag that ends in *MachineStep.

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

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:

Exception Deviation: 0

Compression Deviation: 0

Compressing: Off

8 of 112

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, please 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 bottomthe 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 (no skipping values):

14. Close the SMT.

Part B - Filter More with Exception/Compression

1. Start on the Client image.


2. Start System Management Tools from the taskbar.

3. Do the following steps in this order:

Select Data > Current Values.

Search for and select the tag ending in *SimpleTempZone1.

Click Start Updating.

9 of 112

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".
5. In System Management Tools (SMT), do the following steps in this order:

Go to Data > Archive Editor.

Search for the tag ending in *SimpleTempZone1.

Change Start time to *-1m to get last one minute of data from archives.

Click Get events.

Note that in below graphic the window size is reduced so you don't see all values returned, but you should be getting
around 17-25 events every minute from the archive for this tag.

6. Minimize the SMT and start VantagePoint Trend from the taskbar.

7. In the Model, navigate to System > Sources > FactoryTalk > localhost > Historians > Production Historian
> Tags and double-click on or drag the tag ending in SimpleTempZone1 to the plot surface.

10 of 112

8. In thisTrend 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.
10. Do the following steps in this order:

Go to Points > Point Builder.

Search for the tag ending in *SimpleTempZone1.

Click on the Archive tab.

11. When this tag was originally brought into Historian with the FactoryTalk Administration Console, the default
Exception Deviation was 0.25 and Compression Deviation was 0.5. You should still be seeing these default
settings:

Exception Deviation: 0.25

Compression Deviation: 0.5

12. Change the compression setting to the following:

Compression Deviation: 20

13. Note that this setting is in no way "recommended" or necessarily "typical" settings to be used in any other case
except for purposes of this training lab. Your setting should now appear as follows:

14. Click the Save button and look for "Successfully edited" message in the Session Record:

11 of 112

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 8-12 events in a one minute period. Earlier you were getting 17-25 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.

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:

12 of 112

20. Turn on Point markers and click OK.

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. In Point Builder, set the attribute on the TempZone1 tag back to the following:

Compression Deviation: 0.5

23. Be sure to Save your changes.


24. Close the SMT and Trend applications (no need to save the trend).

13 of 112

Lab 2 - FactoryTalk Historian Tag Types


What you will learn:
Compare Polled against Advised data collection modes
Use Event tag to read tags 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

Part A - Polled versus Advised Collection Modes

1. Start on the Client image.

2. Do the following steps in this order:

Start System Management Tools from taskbar.

Go to Data > Archive Editor.

Search for and display the tag ending in *SimpleTempZone1.

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.

14 of 112

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:

In System Management Tools, go to Points > Point Builder.

Search for the tag ending in *SimpleTempZone1.

Go to the Archive Tab.

Change Compressing to Off.

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

15 of 112

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.
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 (could be more often). 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.
Note: It can take up to two minutes for an Interface to put changes in tag configurations into effect. So, if you
do not see data such as the below, wait a minute or so and click Get events again.

10. When done confirming/observing the above results. so that the archiving functionality of this tag performs similar
to "other" Proof_Oven TempZone tags (if/when added), in Point Builder, change the attributes of the BL1
TempZone1 tag back to the following:

Change Compressing to On

Change ExcMax to Minutes: 10 and Seconds: 0

Location3 to a 1

Be sure to Save your changes

11. Close the SMT.

16 of 112

Part B - Event Tags

1. Start on the Client image.


2. Start System Management Tools.
3. Do these steps in this order:

Go to Data > Current Values.

Search for and select the tag ending in *Shift_Timer.ACC.

Click Start Updating.

Notice the value of this tag changing approximately every second.

4. Do the following steps in this order:

Select Points > Point Builder.

Search for and display tag ending in *Shift_Timer.ACC.

Click on Classic Tab.

17 of 112

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:

Go to the General tab.

In the Exdesc field, enter the following (Note that "EVENT" must be uppercase!):
EVENT='RA Foods:RSLE:BL1.Program:Proof_Oven.SimpleMachineStep' Nonzero

Note in the above there should be spaces between RA and Foods, and between MachineStep' and Nonzero.

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.

Note: Besides Nonzero, event modes of Increment, Decrement and Anychange are also available.

18 of 112

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 Live Data Test
Client from the taskbar.

8. Select FactoryTalk and then Network directory.


9. Under $Global, select RA Foods and click OK.

10. Select OK to create Group1.

19 of 112

11. Select BL1 > Online, then StorageDint1 and finally click OK.

12. Position the Live Data Test 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 FactoryTalk Live Data Test Client.

20 of 112

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

Section 1 Performance Equations


Part A Simple Conversion Calculation

1. Verify that you are on the CLIENT image.

2. Launch the System Management Tools (SMT) from the taskbar.

3. Expand the Points category and select the Performance Equations plug-in. Then, click the New button.

21 of 112

4. Our first Performance Equation is going to be a Fahrenheit to Celsius conversion. On the General tab, do the
following steps:

Enter Name of TempZone1 Deg C.

Description of TempZone 1 Temperature converted to Celsius.

Point type of Float32.

Eng Units of Deg C.

5. Do the following steps:

On the Equation tab, set the Equation to the following (Hint: Use the Tag Search button to fill in the tag name. It will
automatically enclose the tag name in single quotes ('), required syntax at the beginning and end of tag names)

('RA Foods:RSLE:BL1.Program:Proof_Oven.SimpleTempZone1' - 32) * 5/9

Click the Evaluate button just to make sure you dont get an error. If you do get an error, check your syntax carefully.
Your actual evaluated data value will likely differ:

6. On the Scheduling tab, do the following steps:

Change the radio button to Event-based scheduling.

Use the Tag Search button to select the tag SimpleTempZone1.

Change the timestamp assignment option to The timestamp of the triggering event.

22 of 112

Note: FactoryTalk Historian tag name length is typically limited to 256 characters. However, when a tag
name is used with event-based scheduling with a Totalizer or Performance Equation, the event tags length
cannot exceed 73 characters. This would be when used as part of an event expression in a Totalizer, or
the Event tag in a Performance Equation.

7. On the Archive tab, set the following fields:

Exception Deviation to 0

Compressing to Off

Note: The above settings are totally dependent on the situation and may be different in real applications. In
this case we are doing a calculation on a source tag that has already gone through exception and
compression before going into the archive. This performance equation is doing a calculation based on that
value and for purposes of this lab we want to archive all results. So, we are using zero exception and no
compression.

8. Click the Save toolbar button and check for a success message in the session record:

23 of 112

9. Do the following steps in the SMT:

Go to Data > Current Values.

Search for and display the two TempZone1 tags (hint: In the Search dialog, do not specify Point Source of FTLD, as
one tag you are looking for is a Performance Equation with Point Source C. You could use Tag Mask of *TempZone1*
for this Search.).

Select Start Updating (if values dont change, please wait 20-30 seconds).

You should see the TempZone 1 Deg C Performance Equation tag display calculated Celsius values from the source
SimpleTempZone1 tags Fahrenheit values.

Part B Using a Performance Equation Function

1. Go back to Points > Performance Equations and click the New button.

24 of 112

2. Lets 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:

Specify name of TempZone1 GT 200.

Descriptor of Minutes in last hour TempZone1 greater than 200 degrees Fahrenheit.

Point type Float32.

Eng Units of Minutes.

3. On the Equation tab, do the following steps:

Enter following Equation (Hint: Use Tag Search button to fill in tag name rather than type in!). Note that in the following
equation, the *-1h is the Starttime (1 hour ago) and the * is the Endtime (current time)both of these entries need to be
enclosed in single quotes ('):

TimeGT('RA Foods:RSLE:BL1.Program:Proof_Oven.SimpleTempZone1','*-1h','*',200) /60

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.

25 of 112

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:

Exception Deviation of 0

Compressing Off

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.

26 of 112

9. Start the Interface Configuration Utility (ICU).

10. Click the Create New Interface Instance from .BAT file button.

11. Open the pipeschd.bat file located in C:\Program Files\Rockwell Software\FactoryTalk


Historian\Server\bin. Note: NOT in Program Files (x86)!

12. As you can see, this interface is set at default to have three scan classes1, 2, and 3at 1 minute, 2 minutes
and 30 seconds respectively.

27 of 112

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.

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 (have to close and re-open to see this change go into effect) and do the following steps:

Go to Points > Performance Equations.

Click Search (the binoculars icon) to list existing Performance Equation tags.

Click on the TempZone1 GT 200 tag.

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

28 of 112

18. Do the following steps:

Go to Data > Current Values.

Search for and display tag TempZone1 GT 200.

Click Start Updating.

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.

29 of 112

Section 2 - Totalizers
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.

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:

Name of TempZone1 Average Temp

Source tag of SimpleTempZone1 (see full tag name below)

Summary calculation of Moving Time Weighted Average

30 of 112

5. On Sampling tab, specify Whenever a new source tag event occurs (Natural).

6. On the Results tab, do the following:

Select Write final results After a time period elapses

Results every 1 Minute

Write interim results At source time (ramp)

7. On the Archive tab, do the following:

Exception Deviation of 0

Compressing Off

8. Click Save and look for Successfully created totalizer message.

31 of 112

9. Do the following steps:

Go to Data > Current Values.

Search for and monitor the tags SimpleTempZone1 and TempZone1 Average Temp.

Click Start Updating.


Note: For the first minute or so, the Totalizer tag might contain the text Pt Created or 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 tag remains Configure, there may be something wrong in its configuration (please
check your previous steps).

Part B Count Events Totalizer Example

1. In the SMT, go to Points > Totalizers and click the New button.

32 of 112

2. On the Name & Type tab, enter the following:

Name of BL1 Proof_Oven Machine Cycles

Source Tag of SimpleMachineStep

Count Events

Events where value changes

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)

3. On the Results tab, verify/set the following:

Start schedule at 0 Hour(s) after midnight

Results every 1 Hour.

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.

33 of 112

4. On Archive tab, set Exception Deviation to 0 and Compressing to Off.

5. Save the Totalizer and look for Successfully created totalizer message.
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.

34 of 112

Lab 4 FTLD Interface Buffering and Redundancy


What you will learn:
Observe the effect of Interface Buffering in a FactoryTalk Historian system
Understand concepts and advantages of Interface Redundancy

Section 1 - Interface Buffering


1. Select the CLIENT image.

2. Launch VantagePoint Trend from the taskbar.

3. Go to System > Sources > FactoryTalk > localhost > Historians > Production Historian > Tags and click
and drag the SimpleTempZone1 tag to the trend surface.

35 of 112

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.

7. Open the Interface Configuration Utility (ICU) from the taskbar.

8. From the drop-down Interface selection box, pick the FTLD1 interface.

9. Once selected, pick Tools > Buffering.

36 of 112

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.


13. Right-click on the Windows icon in the lower-left corner and open a Command Prompt.

14. Change to the path of:


C:\Program Files (x86)\Rockwell Software\FactoryTalk Historian\PIPC\BIN

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

37 of 112

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

17. Leave the Command Prompt open and return to the CLIENT image.

18. Verify that your VantagePoint Trend is still displayed and the TempZone1 tag is still changing.
19. Go to the SERVER image.

20. We will simulate a Historian Server outage by manually stopping Historian.


Stop your Historian Server by left-clicking the Windows icon in the lower-left corner to go to the Start page, then
the Stop FactoryTalk Historian SE tile:

21. Wait for all of the services to stop and the dialog to close itself before proceeding.

38 of 112

22. After Historian is 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".

23. Go back to the DATA image.

24. Since the Historian Server is not available, the FTLD Interface is buffering data. You should see Current
Queue Events accumulating (may take several updates).

25. Return to the SERVER image.

26. Restart the Historian Server by clicking the Windows icon and selecting the Start FactoryTalk Historian SE
tile.
27. While the Server is restarting (may take several minutes), return to the DATA image.

39 of 112

28. 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
minuteseven when the Historian Server is fully running, it may take a couple of minutes for the Interface to
notice and send that buffered data to the server. Please be patient!

29. Return to the CLIENT image.

30. Your trend should now be updating with values (may need to wait several seconds).

40 of 112

31. 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. There was no data loss while the Historian Server was stopped because the
Interface was buffering.

32. Leave VantagePoint Trend open and in Live Mode for the next Lab.
33. 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.

41 of 112

Section 2 - Interface Redundancy


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

3. Use the ICU on this image to confirm the interface is running (select FTLD1 Interface from drop-down list and
look for "Running" at the bottom of the dialog)

42 of 112

4. and configured for Buffering.

5. Close the Buffering dialog but leave the ICU open.


6. Go to the CLIENT image.

7. On the CLIENT image, we want to verify the connection to the Historian Server named SERVER. Launch the
SMT.

8. Click on File > Connections.

9. Check the SERVER checkbox and verify you get SERVER connected message.

43 of 112

10. Close the PI Connection Manager dialog and the SMT.


11. Launch the Interface Configuration Utility (ICU).

12. Click the Create new Interface Instance from .BAT file toolbar button.

13. Navigate to the LDInterface directory and select the FTLDInt_FTLD.bat.bak file. Click the Open button.

14. You will be prompted to select the Host PI Server. Select SERVER from the drop-down box and click the OK
button.

44 of 112

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

16. Do the following steps:

Select the Service category.

Change the Display name to FTLD1.

Click the service Create button.

17. Select Tools > Buffering.

18. Change the radio button to Enable buffering with PI Buffer Subsystem.

45 of 112

19. Read the messages and click OK (you will not start the service YET!).

20. You should be taken to the Buffered Servers dialog. Select SERVER from the drop-down box. Click the OK
button.

21. Read the following and click Yes.

46 of 112

22. 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 prompted it to appear now to get out of the way.

23. Some of the settings made when configuring the FTLD Interface on the DATA image (prior to this lab) was to
delete some unneeded Scan Classes and enable Disconnected Startup. Disconnected Startup is a
recommended feature to allow an Interface to start collecting data when it starts, even if it doesnt have a
connection to a Historian Server (it will collect and buffer). 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.

24. Your scan classes should now appear as follows.

47 of 112

25. Click on Disconnected Startup category and select Enable disconnected startup (with point caching).

26. 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. Open File Explorer.

3. Go to the C: drive, right-click in a blank area and select New > Folder.

4. Name the folder FTH_Shared.

48 of 112

5. Right-click on the new folder and select Share with > Specific people.

6. Select Everyone from the drop-down list (you may want to use more restrictive sharing in a real application),
and then click Share.

7. Click Done.

49 of 112

Part C Configuring Interfaces for Failover

1. Change to the DATA image which should still have its ICU open.

2. Do the following steps:

Select the Failover sub-category under UniInt in the left pane.

Check the box to Enable UniInt Failover.

Select Phase 2.

On this next step, if you get a Windows Security dialog, you can disregard on these images and click Cancel - For
Synchronization File Path, browse to the FTH_Shared folder on Server (Network > SERVER > FTH_Shared) and
click Open. If you get a Windows Security dialog, you can disregard on these images and click Cancel. The file
FTLDInt_FTLD_1.dat will be created in this folder. If for some reason you cannot Browse, type
\\SERVER\FTH_Shared\FTLDInt_FTLD_1.dat into this field.

Select UFO (Universal FailOver) Type of HOT.

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.

50 of 112

4. Read and click OK (we will stop and restart the interface later).

5. Go to the CLIENT image.

6. Make the same Failover selections on this interface as you did on the other. Again, if you try browsing to the
shared folder on the SERVER image and get a Windows Security message, you can Cancel.
7. 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
9. Read and click OK.

51 of 112

Part D Modifying FTLD Service Properties

1. Still on the CLIENT image, right-click on Windows icon and select Control Panel.

2. Go to System and Security > Administrative Tools > Services.


3. Double-click the FTLD1 Service.

4. Select the Log On tab, and specify to use Administrator account with password of rockwell. Click OK.

52 of 112

5. Read and click OK.

6. Close Services, Administrative Tools and System and Security dialogs.


7. Go to the DATA image.

8. Go to Control Panel > System and Security > Administrative Tools > Services, similar to how you did on the
CLIENT image, and make the same changes to the FTLD1 service on this image. Use Administrator with
password of rockwell. Click OK.

9. Read and click OK.

53 of 112

10. Read and click OK. You will not stop and restart the service YET!

11. Close the Services, Administrative Tools and System and Security dialogs.

Part E Finishing up and Testing the Interface Redundancy

1. Go to the DATA image if you are not there already.

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.

54 of 112

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 interface service by clicking below icon. 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 below Browse button.

55 of 112

11. Click the interface on DATA image and click OK

12. Click the Apply button at the bottom of the dialog box.

13. Start this interface by clicking Start Interface service.

14. Switch over to the SERVER image.

15. Launch System Management Tools (SMT).

16. Expand the Data category and select the Current Values plug-in.

56 of 112

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

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

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.

57 of 112

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 dont end up with both Interfaces stopped. You WILL FOR SURE lose data then!

58 of 112

25. When you are finished experimenting, revert back to non-redundant conditions by:

Make sure the Interface Node on DATA (ID#1) is Primary

On the CLIENT image, stop the Interface with the ICU, then close the ICU.

Use the ICU on DATA image to de-select Enable UniInt Failover, click Apply and Restart interface service.

26. On all three images, close any open applications (SMT, VantagePoint Trend, ICU, etc).

59 of 112

Lab 5 - Using and Displaying Audit Information


What you will learn:
Use SMT to enable auditing of your FactoryTalk Historian SE Server
Use AuditViewer to examine activity

Note: This lab uses AuditViewer to display audit information. This tool is not installed automatically, but
included in Redist/AuditViewer folder in Historian 3.0 and newer install media and/or downloaded from
Knowledgebase article 64384 - FactoryTalk Historian Site Edition AuditViewer.
Also note that AuditViewer has already been installed on the SERVER image.

Part A - Enable Auditing of your PI Server

1. Go to the SERVER image:

2. Launch the System Management Tools (SMT).

3. Do the following steps:

Expand the Operations category and select Tuning Parameters.

Click the EnableAudit Tuning Parameter.

60 of 112

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.

4. Double-click on EnableAudit to display the dialog 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.
Stop your Historian Server by left-clicking the Windows icon in the lower-left corner, then the Stop FactoryTalk
Historian SE tile:

7. Wait for all of the services to stop and the dialog to close itself before proceeding.
8. Once all of the services have stopped and window has closed, select the Windows icon again and click the
Start FactoryTalk Historian SE tile. Wait for all services to start and window to close.

61 of 112

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.

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

62 of 112

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

4. Do the following steps:

Go to Points > Point Builder.

Search for tag BA:LEVEL.1.

Go to Archive Tab.

Change Span to 101.

63 of 112

5. Save changes by clicking the Save icon and look for success message:

6. From the SMT Tools menu select Audit Viewer to launch the application.

7. Do the following steps:

From the AuditViewer, expand the Manage section. Verify the Archive 0 checkbox is checked (if not, check it) and
then click the Manage link

Double-click the Archive 0 icon on the right to display the subsystems file details.

64 of 112

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

9. Confirm that the records are updated with current date/time (will not match below).

65 of 112

10. You can also view this in table form. Above the three Subsystems listed select the Table tab.

66 of 112

11. Do these steps:

Change the search Start Time to past 5 minutes by specifying *-5m.

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.

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

13. As time allows, make other FactoryTalk Historian edits/changes and detect them with AuditViewer.
14. Close AuditViewer and the SMT.

67 of 112

Lab 6 - Backfilling Data into a FactoryTalk Historian SE Server


What you will learn:
Understand configurations necessary before backfilling data
Use example of UFL Interface to backfill data from a CSV file

Part A - Overview of Data to Backfill and Historian SE Configuration


In this lab you will create a new tag in FactoryTalk Historian, and FactoryTalk Historian will start collecting values and
timestamps for that tag from that time forward. However, we will assume you previously had collected values and timestamps
from that very same tag from another method, and have a CSV file of this previously collected data to backfill into the
FactoryTalk Historian archives.

1. Go to the SERVER image.

2. Click the Windows icon in the lower-left corner and then the FactoryTalk Administration Console tile.

3. After selecting Network directory, right-click on RA Foods and select Add Individual Historian Points.

4. Click Browse Tags.

68 of 112

5. Do the following steps:

In the left pane, navigate to RA Foods > BL1 > Online > Program:Proof_Oven and click on OvenUDT.

Click on TempZone1 in the right pane.

Click Add Tag(s) to List.

6. After confirming this tag is in the lower pane, click OK.

7. Click OK again on Add Historian Points dialog and close FactoryTalk Administration Console.

69 of 112

8. Now we will take a look at a couple of CSV files that will be used to backfill data for this new tag. Do the
following steps:

Use File Explorer and go to C:\Class Files\Backfill Lab.

Right-click on Data to Backfill.csv.

Select Open with > Notepad.

9. Scroll through this CSV file and note that it contains over 4000 entries (dont bother counting!) of timestamps
(date followed by time) and values between May 1 and May 31, 2012, for a tag by the name of:
RA Foods:RSLE:BL1.Program:Proof_Oven.OvenUDT.TempZone1
This is a CSV (comma delimited) file, with each line formatted as:
Tagname,Timestamp,Value

10. We will use the data in the Data to Backfill.csv file to backfill data in a FactoryTalk Historian archive. Later in
this lab, when you configure a Universal File and Stream Loading (UFL) interface, you will specify this file as the
source of the data. However, we will also need a reference file to show how the data to be backfilled is
formatted. We could use the same file, but a reference file is limited to 50KB in size, so we will use a different
file instead.

Back in File Explorer, right click on the Backfill File Reference.csv.

Select Open with > Notepad.

70 of 112

11. Note that this file has only one line in it, and the formatting of the line matches the lines in the Data to
Backfill.csv file. This Backfill File Reference.csv file will be used when configuring an INI file needed for the
UFL interface (you will see all of this as you continue with the lab).

12. Do the following steps:

Close both csv files and DO NOT save any changes if asked.

Minimize File Explorer.

13. Open System Management Tools (SMT).

14. The first thing we will do is look to see if there is already data in the Historian archives for this tag within the
timeframe of the data in the CSV file (May 1 31, 2012). There shouldnt be, because you just created that tag!

Go to Data > Archive Editor.

Click the Tag search button.

71 of 112

15. Do the following steps in this order:

Enter Tag Mask of *TempZone1.

Click Search.

Select the tag that has OvenUDT as part of its name and ends in TempZone1.

Click OK.

16. You should now be seeing that last two hours of archived data for this tag, as the default Start Time is *-2h (two
hours ago) and End time is * (now).

17. Do these steps in this order:

Enter Start Time of 5/1/2012.

Leave End Time set to *, which means current time.

Click Get Events (green right-arrow button).

Note that in the below example, 173 records were retrieved from within this time period. In your case, depending on
how long ago you added the tag and the FTLD Interface started collecting data for that tag, you are not likely to have
exactly 173 records but probably somewhere between 20 and 200 values. Your Pt Created value and timestamp
should be just from a few minutes ago.

72 of 112

18. If we are going to backfill data from the CSV file, which contains values and timestamps from May 1 31, 2012,
we need to make sure one or more archives exist that will be able to hold such data. Go to Operation >
Archives. The list of your archive(s) should be similar to the below (date in the file name(s) will likely differ).
You could have more than one archive file (only one shown below), but if you look at the Start and End Time(s),
you currently do not have an archive able to contain data from May of 2012.

19. Since the required archive does not exist, lets create it. Do these steps in this order:

Click the Create a new archive button (dialog shown below will then appear).

Give it a name of BackfilledArchive (nothing special about this name, could be any name you like).

Select Create archive with fixed start and end time.

Enter Start time of 5/1/2012 12:00:00 AM (we could pick a date further in the past, like 1/1/2012 if we want to use this
archive for even older data, but for the purpose of this lab we will make it start at 5/1/2012).

Enter End time of 12/31/2012 11:59:59 PM (this archive can now contain data up to the end of 2012 in case we want
to backfill additional data later).

Select archive Type of Dynamic.

After confirming below settings, click OK.

73 of 112

20. You should see your archive was created to contain data within the timeframe specified. Also, note the
successfully created message.

21. Now we will create two Trusts for the FactoryTalk Historian Server to allow the UFL interface to interact with the
Server/Archives.

Go to Security > Mappings & Trusts

Click the Trusts tab (note that you currently may have more than the three trusts shown below)

22. Do the following steps:

Click the down-arrow next to the New button.

Click Advanced.

74 of 112

23. Do the following steps in this order:

Enter Trust Name of PI_UFL (could actually name whatever you want).

Enter Application Name of PI_UFL.exe (this is the PI-SDK Application for this interface).

Click PI Identity browse button.

24. You would normally use a different existing Identity, Group or PI User with more restrictive privileges, or even
create a special one for this interface to use (see documentation), but for the purpose of this lab, do the
following:

Select Type of PI Users.

Select piadmin.

Click OK.

75 of 112

25. Your dialog should now look like this. Click OK.

26. You should see your trust added as follows:

27. Repeat previous steps to create another trust named PI_UE (could be whatever you want), trusting application
PI_UE (this is the PI-API Application for this interface does not have .exe extension) and PI Identity of piadmin.

Enter Trust Name of PI_UE.

Application Name of PI_UE.

PI Identity of piadmin.

Click OK.

76 of 112

28. You should now have these two Trusts in your Historian Server.

29. Minimize the SMT for later use.

Part B - Configure, Run and See Results of UFL Interface

1. Open Interface Configuration Utility (ICU) from the taskbar.

2. Select Interface > New Windows Interface Instance from EXE

3. Click Browse

4. Go to C:\Program Files (x86) > Rockwell Software > FactoryTalk Historian > PIPC > Interfaces > PI_UFL.

Select PI_UFL.exe.

Click Open (not shown below).

77 of 112

5. Do the following steps in this order:

Select SERVER from the drop-down list.

Specify Point Source of FTLD.

Click Add.

You will see a message that the interface is ready to be configured (not shown below) click OK on that message).

6. Click UFL tab and browse button for the Configuration File.

7. You are identifying an INI file that the UFL interface will use to store its configuration. If you had an existing one
you wanted to use, you could select it. We do not, so are going to create a new file and configure it in the next
several steps.

Go to the INI folder in the PI_UFL directory.

Enter name of MyBackfill.

Click Open.

78 of 112

8. Click the Launch UFLDesigner.exe button to step through configuration of our INI file.

9. Read message and click Yes.

10. Do the following steps in this order:

Leave default Plug-in of AsciiFiles.dll selected. This is because we are going to backfill from an ASCII (CSV) text file.

Use browse button and select the reference file of C:\Class Files\Backfill Lab\Backfill File Reference.csv.
Remember from earlier in this lab, this file contains one line of text that matches the formatting in the data file we will
use to backfill from and will be used as a reference as we continue with this configuration.

Click OK.

11. You will see three panes in this editor. Configurations are done in the left-pane, the center-pane displays our
reference file contents, and the right-pane shows the actual INI file contents as it is being created.

79 of 112

12. In the configuration pane, notice we are on tab 1 General and the Input File Mask is defaulting to the same
Backfill File Reference.csv file that we picked in a previous step. This would be OK if our actual data to import
is the same file we used for a reference. However, reference files have a 50KB maximum size and our file of
data for backfilling is much larger than that, so in the next step we will have to pick the actual data file.

13. Click in the Input File Mask field so that the browse button will appear. Click the browse button.

14. Go to C:\Class Files\Backfill Lab\

Select Data to Backfill.csv.

Click Save.

15. Click Yes.

80 of 112

16. The top of your configuration pane should now have the Data to Backfill.csv file specified for Input File Mask.

Click the blue right-arrow to go to tab 2 Variables.

17. This tab is used to define the variables or parts to be extracted from the csv file. Click the green + button to
add the first variable.

18. You will identify the first variable in the data file, which in our case is the tagname.

Enter name of Tagname.

Enter Data Type of String.

Click the green + to add a second variable.

81 of 112

19. Do the following steps in this order:

For the second variable, enter name of Timestamp.

For the Data Type, use drop-down list to pick DateTime.

For the Date Format, use drop-down list to pick the following. Needs to be EXACT and it is Case Sensitive!!
MM/dd/yyyy hh:mm:ss

Make sure your second variable is configured exactly as below.

Click the green + sign to add a third variable.

20. Do the following steps:

Enter Name of Value.

Select Data Type (using drop-down arrow) of Number.

When done with above, click blue right-arrow to go to tab 3 Message Types.

21. Click the green + sign to add a Message Type. Leave this configuration as it is. It basically is indicating that
any first character in a line is the beginning of the data for that row. C1==* is interpreted as the first
character in a row (Character 1 or C1) can be anything (wildcard of *) to indicate the start of data for that row.

82 of 112

22. Go to tab 4 Data Extraction by clicking blue right-arrow.

23. This tab is used to assign data extraction to specific variables. Click the green + button.

24. The data in our CSV file is delimited, so select Delimited and Next.

25. The data in our CSV file is delimited with commas, so check Comma. Notice in the Data preview window you
can see the data is properly delimited (you can tell by the black vertical lines), separated by the commas
between Tagname, Timestamp and Value.
Click Next.

83 of 112

26. Read the blue text in this dialog carefully.

One at a time, drag the Tagname, Timestamp and Value variables to the appropriate columns in the Data preview.

When the three variables are in the proper columns as shown below (review carefully!), click Finish.

27. Click blue right-arrow to go to tab 5 Actions.

28. On the 5 Actions tab, click the green + sign.

84 of 112

29. Read the blue text. Leave the StoreInPI option selected. Similar to the previous steps, drag the three variables
to the appropriate place in the Result field (you will be dragging and dropping on top of).

Tagname to <*Tag>

Timestamp to <*Time>

Value to <*Value>

30. After above step, the Result field should appear as follows:

31. Click Validate and you should get a green shield.

32. Do the following steps:

First, click Add.

Second, click Close.

33. Click the Save icon and then select File > Exit to close the UFLDesigner.

85 of 112

34. Back on the ICU, go to the General tab

Click the Add a scan class button.

Specify a 30 second scan class by entering 00:00:30 (in a real application this may differ).

35. Do the following steps in this order:

Go to Service tab.

Click Apply.

Click Create (will take a few seconds).

Click Start interface service.

36. In a few seconds you should see Ready and Running in the lower left-hand corner.

86 of 112

37. Restore the File Explorer you minimized earlier. When all 4000+ values and timestamps are finished being
transferred to the FactoryTalk Historian Server, the current date, time and a ._OK extension will be appended to
the name of the source data file.

38. Restore the SMT that you minimized earlier.

Go to Data > Archive Editor.

Click Get Events (green arrow).

With 5/1/2012 and * as Start and End times, you should now be able to see all of the data youve backfilled into
the Historian archives. We originally had 20-200 or so events for this tag within this time frame. Now, you
should be seeing 4000-5000 eventsthe 4000+ you backfilled, plus the more current values that Historian has
been collecting. Congratulations!!

39. Scroll through and briefly review the data collected from May 1, 2012 to May 31, 2012, now in the Historian
archive. You will have a large gap from May 31, 2012 to whatever the current date is (the date you are doing
this lab), but youve successfully backfilled data into a Historian archive.
40. On the ICU, stop the UFL interface.

41. Close ICU, SMT and any open dialogs/windows.

87 of 112

Lab 7 FactoryTalk Historian SE Archive Management


What you will learn:
How to use the SMT to Manage Archives
Procedures to follow to unregister, move and then re-register archives

1. Go to the SERVER image.

2. Click on Windows icon in taskbar and then VantagePoint Trend tile.

3. In the Model, navigate to System > Sources > FactoryTalk > localhost > Historians > Production Historian
and click on Tags.
Double-click on or drag and drop this tag to the plot surface:
RA Foods:RSLE:BL1.Program:Proof_Oven.SimpleTempZone1

88 of 112

4. The default relative time period your trend should have used is Last 5 minutes. Change the relative time period
used for the trend to a longer period of time, like Last 30 minutes, Last 1 hour or Last 6 hours until you see
where new, changing data started to be collected, such as the following:

5. Open System Management Tools from the taskbar.

6. Go to Operation > Archives. Based on what other labs you might have done before this one, you could have
either one or two archive files The one that currently has Primary in the Status column should be the default
archive created when this FactoryTalk Historian SE server was installed, using these defaults:

Path of folder C:\Program Files\Rockwell Software\FactoryTalk Historian\Server\dat

File name including name of server, date and time of midnight - SERVER_2015-03-02_00-00-00

File extension of .arc

89 of 112

7. Scroll to the right and notice other information about this archive, such as:

Status is Primary, meaning this is the current archive being written to

End Time is Current Time, also indicating this is the current archive

% Full and other helpful information is specified

8. Do the following steps:

Go to Operation > Tuning Parameters

Go to Archive tab

Scroll down to and double-click on Archive_AutoArchiveFileRoot

9. Note the path in the Value field. This patch indicates where new archive files will automatically be created when
an Archive Shift occurs and is also identifying a prefix that will be used on the file name, piarch_. This path and
prefix could be modified as desired by the user, but for the purpose of this lab please do not make any changes.
Click Cancel.

90 of 112

10. Go back to Operation > Archives and click the Force an archive shift button.
Note: It is not recommended to force an archive shift while in production. Archive shifts should be
done automatically by Historian when a current archive is almost full. We are forcing it here for
training purposes.

11. Click Yes.

12. After several seconds, you should see results similar to the following:

The original archive file with SERVER in its name is now identified as Status of Has Data (so you know it is not current
or Primary)

The new file was created in the location and with the prefix of piarch_ as identified in the
Archive_AutoArchiveFileRoot setting you looked at earlier, and is currently Primary

In addition to the prefix of piarch_, the file name contains the date/time and extension of .arc

You should see two entries in the Session Record such as in the below

91 of 112

14. Go back to the VantagePoint trend and click Refresh. You should see the trend update and shift to the left a bit
(to reflect the data collected since you last updated the trend). But, there is no loss of data or anything like that
due to the data used to display the trend coming from different archive files. No issues with Historian spanning
multiple archives to get data!

15. Now, lets go through a process that a customer might do to remove archives that are no longer needed.
Rather than deleting them, which would lose that data forever, a process to unregister the archives is what they
should do. This would let them move the archives off of the local drive, but the data would still be there so you
could get it back again in case the data is needed sometime in the future. Go back to the SMT and do the
following:

Click on the archive with old data (the one that is NOT Primary)

Click the Unregister the selected archive button

16. Click Yes.

17. Click Refresh.

92 of 112

18. The archive seems to be gone, doesnt it? Dont get nervousat least in this case, the SMT is just not
showing the archive file as it has been unregistered.

19. Go to VantagePoint trend and click Refresh. Now you might be a little more nervous that your old data is
gone, but dont worry. At the moment, since you have unregistered the archive in Historian, FactoryTalk
Historian is simply not getting the data. Exactly what you told it to do (not get the data) by unregistering it.

20. Open File Explorer.

21. Go to C:\Program Files\Rockwell Software\FactoryTalk Historian\Server\dat. Scroll down to the bottom and
here you should see the actual arc file that you have unregistered, along with its partner file ending with an
.ann extension. This file would store any annotations related to the data in the arc file.

93 of 112

23. Lets copy these files to a new location, to simulate maybe moving the old archive to a storage drive for
safekeeping.

Use Ctrl-clicks to select both files.

Right-click and select Copy

24. Go to C:\Class Files, right-click in the blank area and select Paste.

25. Verify files pasted.

26. Go back to the SMT and click Register an archive.

27. Go to C:\Class Files, select the .arc file and click Open.

94 of 112

28. You should see the file appear and a couple of registration messages in the Session Record.

29. Go back to VantagePoint Trend and click Refresh. All of the data should be displayed again. WOW, that was
easy!!

30. Close SMT, VantagePoint Trend (no need to save trend) and File Explorer if still open.

95 of 112

Lab 8 Viewing FactoryTalk Historian Data using VantagePoint Mobile


What you will learn:
How to insert an instance of a type in VantagePoint and map properties to tags in FactoryTalk Historian
Use VantagePoint Mobile site to create a basic display using data from FactoryTalk Historian

Part A Inserting an instance of a type in VantagePoint


Modeling in VantagePoint is basically creating and inserting instanced of types. A type can be created to represent objects,
like pumps, motors, valves, conveyors, etc. Properties of these types can then be mapped to a variety of data sources, such as
FactoryTalk Historian.

1.

Go to the CLIENT image.

2. Start FactoryTalk VantagePoint Manager from the taskbar.

3. Right-click on MyEnterprise and select New > Folder.

4. Enter MyExtruder and click Create.

5. Right-click on MyExtruder and click New > Item.

96 of 112

6. Click in this order:

Base Equipment

Base.Extruder.Sample.Extruder

Create

7. At this point youve created an instance of the Extruder type in your VantagePoint Model. Enter name of
MyExtruder1.

97 of 112

8. As you can see, this sample Extruder type has 8 different properties defined. VantagePoint is able to connect to
a wide variety of data sources, including FactoryTalk Metrics, FactoryTalk EnergyMetrics, FactoryTalk Live Data
(such as direct from ControlLogix controllers), Microsoft SQL Databases as well as FactoryTalk Historian SE or
ME. For the sake of this lab, we will define a couple of the properties as getting their values from existing tags in
FactoryTalk Historian SE.

Click the browse button to the right of Hydraulic Pressure

9. A dialog will appear to let you map tags in VantagePoint to the properties of this Extruder. Do these steps in this
order:

Navigate to System > Sources > FactoryTalk > localhost > Historians > Production Historian and click on Tags

Drag and drop the SimpleTempZone1 tag to the Hydraulic Pressure property

Drag and drop the SimpleMachineStep tag to the Reservoir Level property

When you are sure correct tags are dropped in the correct properties, click Create

98 of 112

10. You should now see that the MyExtruder1 instance has these two properties defined. The others are greyed
out as they are undefined.

11. Close VantagePoint Manager.

Part B Create a basic mobile display in Google Chrome


Google Chrome acts as a Mobile device when connected to the VantagePoint Mobile Site and can be used to create and/or test
displays intended for Mobile devices.

1. Start Google Chrome from the taskbar.

2. In this install of Google Chrome, a Window Resizer app has been installed from the Google Store. Click the
Window Resizer and select iPad size.

99 of 112

3. Enter URL of http://server.

4. This is the FactoryTalk VantagePoint Mobile Site Home page. Click Favorites.

5. At this time you will see that No favorites exist. Click the Back arrow.

100 of 112

6. Click the Model button.

7. Click MyEnterprise.

8. Click MyExtruder. This is the folder that you created earlier.

9. Click MyExtruder1. This is the instance of the Extruder type that you created earlier and then mapped two tags
from FactoryTalk Historian to Hydraulic Pressure and Reservoir Level properties.

101 of 112

10. You will see No displays found. None have been created yet. Click the Add button (plus sign) at the bottom
to add a new display.

11. Click the Widgets tab, and then click and drag two Gauges, one at a time, to the display surface. You may
have to click and hold the Gauge object for a few seconds to activate it in order to drag and drop it.

102 of 112

12. Click on the Settings icon in the upper-right corner and click Properties.

13. With Gauge 1 selected on the left, click the model browser button on the right.

14. Select the Hydraulic Pressure option and then OK.

103 of 112

15. Enter Minimum of 0 and Maximum of 400 for this Gauge.

16. Do these steps:

Click Gauge 2 on the left

Use model browser to pick Reservoir Level

Enter Minimum of 0

Enter Maximum of 5

Click OK

17. Click Save icon in lower-left.

104 of 112

18. Do the following steps:

Enter name of MyExtruderDisplay

Change Favorite to YES

Click OK checkmark

19. Change Favorite name to MyExtruderDisplay and click OK checkmark again.

105 of 112

20. Lets add a little more to your display. Click the Settings icon and select Split Horizontally.

21. Click, hold and drag-drop a Trend Widget to the new part of the display.

106 of 112

22. Do the following steps:

Click the Model tab

Click, hold, drag and drop Hydraulic Pressure and Reservoir Level (one at a time) to the trend

Click the Save icon

23. Click OK.

107 of 112

24. Click the Back button in the lower-left.

25. Congratulations! You have an awesome mobile display as it would be viewed on your iPad. You can click the
down-arrow icon just above the trend on the far right to either Refresh or click Properties and change the time
period or even change the trend to Live Mode and refresh at some specified rate. Feel free to experiment!

Part C Viewing mobile displays on other mobile devices

1. Open a new instance of Google Chrome by right-clicking on the Google Chrome icon in the taskbar and
selecting New window.

108 of 112

2. Use the Window Resizer button to size this instance like an old iPhone or small Android device.

3. Enter URL of http://server.

4. This is how the VantagePoint Mobile Site looks on an old iPhone or small Android device. Click Favorites.

5. You have added this favorite. Click MyExtruderDisplay.

109 of 112

6. Enjoy your display on this smaller mobile device! Due to the smaller size, you will have to scroll up and down to
see everything.

7. When finished, close the two instances of Google Chrome.

110 of 112

Notes

111 of 112

112 of 112