Вы находитесь на странице: 1из 878

FactoryTalk VantagePoint

Student Manual
Version: March 29, 2013
For Rockwell and Partner Use Only!

Copyright 2012 Rockwell Automation, Inc.

Table of Contents
Lesson 1 - Introduction to FactoryTalk VantagePoint ................................................................................. 11
Discussion ............................................................................................................................................... 11
What is VantagePoint? ........................................................................................................................ 11
VantagePoint: A Quick Overview......................................................................................................... 12
What can you do with VantagePoint? .................................................................................................. 15
Who uses VantagePoint? .................................................................................................................... 16
Typical VantagePoint Systems ............................................................................................................ 17
VantagePoint Key Features ................................................................................................................. 19
Ordering Information ............................................................................................................................ 20
System Requirements - VantagePoint version 4.5 .............................................................................. 22
The Virtual Machine Setup for This Training ....................................................................................... 24
Lab 1 Exploring VantagePoint Portal ................................................................................................... 25
Explore VantagePoint Help and Diagnostic Content ........................................................................... 25
Explore Existing VantagePoint EMI Reports ....................................................................................... 28
Introduction to the Content Viewer ...................................................................................................... 29
Lab 2 FactoryTalk Directory and Application......................................................................................... 30
Lab 3 Starting the FactoryTalk Transaction Manager to Collect & Store data to Be Used by Various
Labs ......................................................................................................................................................... 31
Lesson 2 - Configuring Simple FT Data Sources........................................................................................ 33
Discussion ............................................................................................................................................... 34
Logical Model ....................................................................................................................................... 34
Physical Model ..................................................................................................................................... 34
Configuring FactoryTalk Data Sources ................................................................................................ 35
Lab 1 - Extending the FTVP Model ......................................................................................................... 36
Lab 2 - Configuring FactoryTalk VantagePoint Server ............................................................................ 39
Lab 3 Adding FactoryTalk Live Data (FTLD) Points ............................................................................. 42
Part A - Review ControlLogix Program ................................................................................................ 42
Part B - Importing Simple (Non-Structured) FactoryTalk Live Data .................................................... 45
Lab 4 Adding FT Historian Tags to FT VantagePoint .......................................................................... 54
Lab 5 Importing FactoryTalk Alarms and Events ................................................................................. 62
Lesson 3 - Creating and Publishing Trends ................................................................................................ 69
Discussion ............................................................................................................................................... 69
Lab 1 - Creating and Publishing Trends .................................................................................................. 77
Lab 2 - Creating an AbsoluteTime Periods ............................................................................................. 88
Lab 3 Trending With Multiple Time Periods ......................................................................................... 90
Lab 4 Misc. Trending Functions ........................................................................................................... 93
2 of 878

Using Shapes ....................................................................................................................................... 93


Discrete Shading .................................................................................................................................. 97
Create a Golden Batch ........................................................................................................................ 99
Lesson 4 Creating and Publishing XY Plotter ........................................................................................ 103
Discussion ............................................................................................................................................. 103
XY Plotter ........................................................................................................................................... 103
Lab 1 Create Simulators ..................................................................................................................... 104
Lab 2 Creating and Publishing XY Plotter Chart ................................................................................ 107
Basic Plotting ..................................................................................................................................... 108
Using Shapes for Live Process Shift Analysis ................................................................................... 110
Using Background Images ................................................................................................................. 115
Lesson 5 - Creating a Basic Excel Report ................................................................................................ 121
Discussion ............................................................................................................................................. 122
The Excel Office Add-In ..................................................................................................................... 122
Overview ............................................................................................................................................ 123
Menu Items ........................................................................................................................................ 125
VantagePoint Excel Add-In Insert function ...................................................................................... 126
Using Names in Excel ........................................................................................................................ 127
Excel Worksheets (Tabs) Created ..................................................................................................... 127
Lab 1 Get the needed data onto the Excel Report ............................................................................. 128
Lab 2 Create the Temperature Min & Max Report ............................................................................. 139
Lesson 6 - Using an Incuity Tag for Data Entry ........................................................................................ 147
Discussion ............................................................................................................................................. 147
Incuity Tags ........................................................................................................................................ 147
Lab 1 Create Incuity Tags ................................................................................................................... 149
Lab 2 Enable Storage Services .......................................................................................................... 152
Lab 3 Operator Log Data Entry .......................................................................................................... 153
Lab 4 Offline Data Entry ..................................................................................................................... 155
Lab 5 Utilize the Incuity Tag Data ...................................................................................................... 158
Lesson 7 - Using a Calculate Tag to Evaluate Expressions ..................................................................... 161
Discussion ............................................................................................................................................. 161
Calculated Tags ................................................................................................................................. 161
Typical Application Examples ............................................................................................................ 163
Lab 1 Creating a Discrete Calculate Tag ........................................................................................... 165
Lab 2 Create an Enumerated String (lookup) Tag ............................................................................. 170
Lesson 8 Retrieving Data from External Database ................................................................................ 177
Discussion ............................................................................................................................................. 178
Add a Microsoft SQL Server Connector ............................................................................................ 178
Creating Tag Provider ........................................................................................................................ 179

3 of 878

Lab 1 Creating a MSSQL Server Connection .................................................................................... 186


Lab 2 - Using Queries in Reports .......................................................................................................... 188
Lab 3 Creating an Excel Report Using DB queries ............................................................................ 192
Lab 4 Creating Tag Providers ............................................................................................................ 198
Lab 5 Verifying the Tags Provided By TagProvider ........................................................................... 223
Lesson 9 Modeling, Types and Type Reports ....................................................................................... 227
Discussion ............................................................................................................................................. 227
Modeling ............................................................................................................................................ 227
Type Packages .................................................................................................................................. 228
The VantagePoint Type Builder ......................................................................................................... 229
Instance Packages............................................................................................................................. 230
Types and Instances .......................................................................................................................... 230
Application Example .......................................................................................................................... 231
Importing/Exporting Sections of the Model ........................................................................................ 231
Lab 1 Why Type? - Parameterized (typed) Report ........................................................................... 232
Lab 2 Creating a Type Package ......................................................................................................... 237
Lab 3 Create a Type Report ............................................................................................................... 257
Lab 4 Create an Instance from another Instance ............................................................................... 274
Lab 5 Type Report Test with Multiple Instances ................................................................................ 283
Lab 6 Importing a Package ................................................................................................................ 290
Lab 7 Building Enterprise Model ........................................................................................................ 293
Part A - Creating a Model Type using the FTVP Type Builder .......................................................... 294
Part B - Import the MyModel into FTVP Server ................................................................................. 299
Part C - Import Existing Types into the FTVP Model ......................................................................... 301
Part D - Creating an Enterprise Model Based on MyModel .............................................................. 302
Lab 8 - Using the Model Builder to Create Models ............................................................................... 310
Background: ....................................................................................................................................... 310
Model Builder SQL Script Syntax ...................................................................................................... 311
Part A - Using the Model Builder with Hard Coded SQL Scripts ....................................................... 312
Part B - Using the Model Builder with SQL Scripts that use Database Tables ................................. 329
Part C - Adding Type Items to an Existing Model .............................................................................. 339
Lesson 10 Importing Logix Controller Structures as VantagePoint Items ............................................. 347
Discussion ............................................................................................................................................. 347
Lab 1 - Review ControlLogix Structures ................................................................................................ 349
Lab 2 -Importing CLX UDT from Bread Line 1 ...................................................................................... 354
Lab 3 -Importing CLX UDT from Bread Line 2 ...................................................................................... 366
Lab 4 Quick Trend Test of the Imported CLX UDT Instances ........................................................... 374
Lab 5 Addressing the Import Structured Tags Unique Type Name Issue ......................................... 379
Lesson 11 Excel Cascading Reports ..................................................................................................... 389

4 of 878

Discussion ............................................................................................................................................. 389


Excel Office Add-In ............................................................................................................................ 389
Link to an Existing Report .................................................................................................................. 389
Lab 1 Create a dynamic Excel Report linked to a dynamic trend report ............................................ 391
Part A Create the trend template report for zone temperatures ................................................... 392
Part B Create a dynamic Excel report with selectable line and drill through capability to zone
temperature detail trend ..................................................................................................................... 395
Lab 2 Create a dynamic Excel Report linked to another dynamic Excel report ................................. 406
Part A Create the child report BL Batch Temperature Profile ...................................................... 409
Part B Create the parent report BL Batch List .............................................................................. 425
Part C- Refine the reports .................................................................................................................. 455
Lesson 12 - Creating Composite Reports and Viewing in the Portal ........................................................ 471
Discussion ............................................................................................................................................. 471
Creating Composite Reports ............................................................................................................. 471
Lab 1 Use Portal.CompositeReportTemplate to Create dynamic (type mapped or parameterized)
trend reports .......................................................................................................................................... 474
Part A Configure the Composite Reports Type .............................................................................. 475
Part B Configure Row 1 .................................................................................................................. 479
Part C Configure Row 2 .................................................................................................................. 485
Part D Map Parameters .................................................................................................................. 488
Part E - View the composite Report in the VantagePoint Portal ....................................................... 493
Lab 2 Display Multiple Trends using Composite Report ..................................................................... 495
Part A Configure the type for the target report ............................................................................... 496
Part B Configure the Composite Reports Type .............................................................................. 497
Part C Configure Row 1 Column 1 ................................................................................................. 501
Part D Configure Row 1 Column 2 ................................................................................................. 507
Part E - View the composite Report in the VantagePoint Portal ....................................................... 513
Lesson 13 - Creating Dashboards ............................................................................................................ 515
Discussion ............................................................................................................................................. 515
Introduction to Dashboards ................................................................................................................ 515
The Steps in brief ............................................................................................................................... 516
About using Xcelsius ......................................................................................................................... 517
The Source Files ................................................................................................................................ 518
Lab 1 Create Plant Overview Dashboard for ..................................................................................... 519
Part A Get the data need for the report .......................................................................................... 520
Part B Wire the data to their corresponding graphics object .......................................................... 529
Part C Configure and Expose Parameters for flash report ............................................................. 540
Part D Compile and publish the dashboard .................................................................................... 544
Lesson 14 Charts and Grids .................................................................................................................. 551
Discussion ............................................................................................................................................. 551
5 of 878

Overview ............................................................................................................................................ 551


License and Support .......................................................................................................................... 551
Installation .......................................................................................................................................... 552
Lab 1 Quick Tour of Charts and Grids ................................................................................................ 554
Lab 2 Create Data Grids .................................................................................................................... 556
Part A Create Data Grids using a Time Series Query .................................................................... 556
Part B Create Data Grids using a Data Base Query ...................................................................... 562
Lab 3 Create a Chart using a Time Series Query .............................................................................. 566
Lesson 15 Portal Type Rules and Status Item ...................................................................................... 577
Discussion ............................................................................................................................................. 577
Enhancing Model Views with ContentTypes and ContentContainers ............................................... 577
StatusItem Overview .......................................................................................................................... 578
Components of a StatusItem Solution ............................................................................................... 578
StatusItem Sample Content ............................................................................................................... 579
Lab 1 - VantagePoint Portal Type Rules ............................................................................................... 580
Lab 2 Status Item ............................................................................................................................... 588
Part A- Create the needed calculated tag ......................................................................................... 589
Part B Create the Status Item hierarchy ......................................................................................... 594
Part C View Status Item in the Portal ............................................................................................. 604
Lesson 16 SQL CLR .............................................................................................................................. 607
Discussion ............................................................................................................................................. 608
SQL CLR Overview............................................................................................................................ 608
SQL CLR and SQL Server Reporting Services ................................................................................. 609
SQL CLR or SQLCLR ........................................................................................................................ 609
SQL Server Reporting Services ......................................................................................................... 609
Lab 1 Get Familiar with the VP CLR queries ..................................................................................... 613
Part A Configure / Setup a Project Folder and Datasource ............................................................ 613
Part B Configure a few Test Datasets to get familiar with few of the VantagePoint queries .......... 617
Lab 2 Create a SSRS Parameterized Report .................................................................................... 624
Part A Get familiar with the data source ......................................................................................... 625
Part B Configure the DataSet for the Production Lines .................................................................. 627
Part C Configure the DataSet for the Lines Control Loops ............................................................ 631
Part D Create Line Control Loop Report and add the DataSets .................................................... 636
Part E Configure the Reports Parameters ..................................................................................... 642
Part F Configure a Dataset within the report called ControlLoopHist to return the ProcessVariable
and Setpoint history for the selected control loop .............................................................................. 648
Part G Configure Report Output ..................................................................................................... 655
Part H Run the Report You Just Created ....................................................................................... 659
Lab 3 Link SSRS Report to VantagePoint Report .............................................................................. 660

6 of 878

Part A Get the URL Link to the SSRS report we just created ........................................................ 660
Part B Create a single link to the report .......................................................................................... 662
Part C Create a link for each instance of the Line type (Base.Sample.Line) ................................. 665
Lesson 17 Excel Macro .......................................................................................................................... 671
Discussion ............................................................................................................................................. 672
Excel macro ....................................................................................................................................... 672
Lab 1 Using Excel Macro for VantagePoint Reports .......................................................................... 673
Part A Set up the Excel environment for Macro development ........................................................ 673
Part B Create a simple Excel Report showing the last 10min zone temperatures for a selected line
........................................................................................................................................................... 676
Part C Create a simple Excel Macro............................................................................................... 682
Lesson 18 - Model View and Content Rotator .......................................................................................... 689
Discussion ............................................................................................................................................. 690
Creating a Model View ....................................................................................................................... 690
Content Rotator.................................................................................................................................. 690
Themes .............................................................................................................................................. 690
Portal Application Setting ................................................................................................................... 691
Lab 1 Creating a Model View ............................................................................................................. 693
Part A Creating a Model View via VantagePoint Portal .................................................................. 693
Part B Creating a Model View via VantagePoint Manager ............................................................. 699
Lab 2 Content Rotator ........................................................................................................................ 703
Lesson 19 FTVP Eventing ..................................................................................................................... 715
Discussion ............................................................................................................................................. 715
Creating Report Sets ......................................................................................................................... 715
Eventing ............................................................................................................................................. 715
StreamInsight Instances .................................................................................................................... 716
Event Definitions ................................................................................................................................ 716
Starting Event Definitions .................................................................................................................. 718
Stopping Event Definitions ................................................................................................................. 719
Advanced Editing Options ................................................................................................................. 720
Lab 1 Creating a Report Set ............................................................................................................... 721
Part A Create a Report Set to Run A Single Report ....................................................................... 721
Part B Create a Report Set to Run Reports in a folder.................................................................... 727
Part C Create a Report Set to Run a Parameterized Report .......................................................... 735
Information about the Report Editor Options ..................................................................................... 742
Lab 2 - Creating Event Definitions ......................................................................................................... 745
Part A Create a Tag Trigger Event .................................................................................................. 745
Part B Create a Schedule Event ...................................................................................................... 751
Lesson 20 - FactoryTalk VantagePoint Security Specifying Named Users and Securing the Model .... 757

7 of 878

Discussion ............................................................................................................................................. 757


Understanding Users and Roles ........................................................................................................ 757
Differences Between Users and Roles .............................................................................................. 759
FactoryTalk VantagePoint Accounts.................................................................................................. 760
Security Defaults ................................................................................................................................ 761
Lab 1 Add Windows Users to VantagePoint Users ............................................................................ 766
Lab 2 Add Windows User to Named User list .................................................................................... 769
Lab 3 Assign VantagePoint Users to VantagePoint Roles................................................................. 771
Lab 4 Add a VantagePoint (VP) Role to VP Security ......................................................................... 775
Lab 5 Test VantagePoint Security in the VantagePoint Portal ........................................................... 779
Lesson 21 FactoryTalk VantagePoint Backup ....................................................................................... 783
Discussion ............................................................................................................................................. 783
Lab 1 Backup and Restore IncuityStore Database ............................................................................ 785
Part A Backup the IncuityStore Database ...................................................................................... 785
Part B Deleting the IncuityStore Database ..................................................................................... 788
Part C Restoring the IncuityStore Database ................................................................................... 791

Appendix A: FactoryTalk VantagePoint Getting Results Guide ............................................................. 795


Preface ............................................................................................................................................... 795
System Requirements ........................................................................................................................... 796
Installing FactoryTalk VantagePoint ...................................................................................................... 799
Installing the VantagePoint Server .................................................................................................... 800
Activating the FactoryTalk License .................................................................................................... 809
Configuring Connectors ..................................................................................................................... 815
Installing Client Applications .............................................................................................................. 823
(Optional) Installing the Dashboard Builder ....................................................................................... 826
Upgrading VantagePoint .................................................................................................................... 827
Uninstalling VantagePoint .................................................................................................................. 829
VantagePoint Features .......................................................................................................................... 830
Portal .................................................................................................................................................. 830
Trend .................................................................................................................................................. 831
XY Plotter ........................................................................................................................................... 832
Excel Add-In ....................................................................................................................................... 834
Dashboard Builder ............................................................................................................................. 835
Appendix B - FTVP EMI ModelBuilder and DbBuilder Script Files ........................................................... 837
TagProvider Queries for the EquipmentData table Float data .............................................................. 837
History Command .............................................................................................................................. 837
Live Data Command .......................................................................................................................... 838
Point In Time Command .................................................................................................................... 838
Tag Population Query ........................................................................................................................ 839

8 of 878

TagProvider Queries for the EquipmentData table String data ............................................................. 840
History Command .............................................................................................................................. 840
Live Data Command .......................................................................................................................... 841
Point In Time Command .................................................................................................................... 841
Tag Population Query ........................................................................................................................ 842
Model Builder Queries ........................................................................................................................... 843
MyTrainingEnterprise Hard Coded Scripts ........................................................................................ 843
MyTrainingEnterpriseTable Scripts .................................................................................................... 846
EquipmentMachineMap ..................................................................................................................... 847
EquipmentMachineMap ..................................................................................................................... 848
MyTblEnterprise Entire model ........................................................................................................... 849
MyMbEnterprise Entire model .......................................................................................................... 851
Appendix C Charts and Grids Misc. Info ................................................................................................ 855
Time Series Plugin ................................................................................................................................ 855
Creating new Time Series Requests ................................................................................................. 856
SQL Post Processing ......................................................................................................................... 863
Accessing the GetChartAndGridElements.aspx page .......................................................................... 864
Creating Drill Down Links ...................................................................................................................... 866
Key Words ......................................................................................................................................... 866
Configuring Content Rules .................................................................................................................... 867
Appendix D Excel VB Macro Sample for VP Excel Report to calculate 4 temperature Zones .............. 875
Appendix E - VMWare Images .................................................................................................................. 877
The Virtual Machines ............................................................................................................................. 877
Startup Sequence .................................................................................................................................. 878

9 of 878

This page intentionally left blank

10 of 878

Lesson 1 - Introduction to FactoryTalk VantagePoint

What you will learn:

What is FactoryTalk VantagePoint EMI (VantagePoint)


What Can be done with VantagePoint
Who are the typical users of VantagePoint
What are typical VantagePoint system
Ordering Information
Exploring VantagePoint Portal
Getting familiar, verifying and setting up the initial configurations for this training

Prerequisite:

This trainings VMWare image

Discussion
What is VantagePoint?
FactoryTalk VantagePoint EMI (VantagePoint) is a business intelligence solution for manufacturing.
Built upon standards and platform technologies that make it a truly open architecture, VantagePoint is
capable of interfacing to and interacting tightly with Rockwell FactoryTalk products. VantagePoint
brings data from these sources into an organized model, and allows users to build a portal containing
powerful reports, trends, dashboard displays and other content using familiar Microsoft office tools
like Excel. VantagePoint is built upon .Net and SQL Server. VantagePoint's service orientated
architecture (SOA) provides extensibility, connectivity and security unique in the market.
By leveraging new technologies and recognizing the need to provide data from multiple sources while
hiding the complexity, VantagePoint is the manufacturing data integration application that delivers.
VantagePoint integrates data from diverse systems such as sensors, control equipment, manmachine interfaces, maintenance management systems, custom databases, manufacturing execution
systems and business applications. The integration of this data makes it appear as though these
diverse and often unrelated systems are part of a single, coherent application.

11 of 878

VantagePoint allows browser-based users to immediately derive value from manufacturing data
through built-in reports, displays and analytical tools without any engineering beyond setting up the
data connectors.
VantagePoint provides powerful tools to build a large variety of reporting and information
management applications that are virtually unlimited in scope. Examples of such applications include:

Real time executive dashboards


Automated Production reporting
Key Performance Indicator (KPI) monitoring and alerting
Downtime and OEE analysis
Process verification
Process optimization

VantagePoint is tightly integrated with Microsoft Office. Users with no other computing skills other
than how to use Office can create sophisticated reports and web application content. Users are
empowered to collaborate easily using the information available through the VantagePoint Server.

VantagePoint: A Quick Overview


A Manufacturing Model
The foundation of the VantagePoint server is the manufacturing model (the "Model"). The Model
marries the best of relational technology - the core of databases and data warehouses - with the best
of object orientated code, the essence of client applications. The VantagePoint Model is the central
nervous system of VantagePoint. It houses system data, knowledge of data relationships and
mappings, plug-ins, data connectors, and user-defined content. The VantagePoint Model is
extensible: users can add new types of objects without having to write code, but they can also add
intelligence to objects by writing code. Best of all, end users can interact with the Model, store objects
in the Model, customize how it appears for them, and write powerful reports drawing data directly
from the Model using familiar tools like Microsoft Excel.
Open, Secure and Portable.
VantagePoint is a web based application built on a Service-Orientated Architecture. There are many
significant technical advantages to this approach, but the basic concepts of inter-operable code with
intrinsic backwards compatibility, language independent development, and bridging differences
between operating systems, data bases and existing code bases, are compelling reasons to migrate
to this type of environment. And because the architecture is not purely object orientated nor purely
procedural, but rather is a natural complement to each, web services, which are based on a service
orientated architecture, offer an openness and portability that professionals are recognizing as key to
responsiveness to new technology demands. Furthermore, the very nature of the interaction between
a web service request and the response requires built in security and provides for failure protection.
The end result: secure code that doesn't break.

12 of 878

Complementing the SOA architecture, VantagePoint is built on Microsoft .Net technology. This
provides significant advantages for the developer and end user alike. Examples of these are:

Enhanced user experience - The desktop and browser experiences become closer.
Ease of deployment - The client side deployment does not require an install program. In
many cases the user experience is browser-based and the desktop applications can be
deployed using No Touch installation from the browser.
Security enforcement - The common language runtime (CLR) gracefully manages security,
and other programmatic tasks such as memory management, thread management and
versioning conflicts.
Rapid development of reusable code - Developers can write code for .Net in any one of the
many predominant programming languages.

How does VantagePoint Work?


VantagePoint can either relay queries to real-time or historical data sources and pass back requested
data, or store real time data and data that has been rolled up, aggregated, and dimensioned.
VantagePoint consists of four main elements: the VantagePoint Data Server, VantagePoint System
Server, VantagePoint Portal Server, and the VantagePoint Clients.
1. The VantagePoint Data Server, or Data Store, is the VantagePoint Servers data repository. The
Data Store is a Microsoft SQL server, and it is deployed with the VantagePoint System. Users
can elect to use an existing Microsoft SQL Server installation as the VantagePoint Data Store, if
capacity exists, or they can install an embedded MS SQL Server that comes with VantagePoint.
The Data Server can be installed on the same machine as the VantagePoint Server, or it may be
installed on a separate machine.

Connectors allow access to many different data sources, such as historians and control
systems.

2. The VantagePoint System Server provides core system functionality and access to the Data
Server via XML web services. Clients of the VantagePoint Server utilizing these functions and
services are provided with an abstract view of the underlying data that is much easier to work
with.

Models allow one to impose order upon the data, establish relationships, and bring the
information that they contain to life. For example, the included Manufacturing Model
organizes data in typical manufacturing fashion, permitting items to be found via established
relationships. Models are virtual constructs that allow the real master of the data to be the
master. VantagePoint does not need to own the data.

Services provide common access-related task, such as to enforce and manage security.

3. The VantagePoint Portal Server provides web-application functionality and access to the
System Server. The VantagePoint Portal web browser client is the primary consumer of Portal
Server services, but other web application platforms such as Microsofts SharePoint Portal
Services or custom in-house applications can also easily access the provided content.
VantagePoint Portals provide true no-touch deployment of powerful applications capable of
displaying manufacturing data in trends, graphs, dashboard displays, and powerful interactive
reports developed in Microsoft Excel. Only the .Net framework need be installed on a client
machine to enable this rich, and personalize and customizable user experience. Because the
Portal employs Microsoft Web Parts technology as a framework, end users can customize their
13 of 878

Portal and develop custom enterprise interfaces and content right alongside of VantagePoint's
rich no-touch clients.
The VantagePoint Clients are Capable of providing the ability for deep data analysis. They are
built as either web browser clients (for the Internet Explorer platform) or as rich desktop clients
(for the Windows platform). It is not necessary to explicitly install any VantagePoint software on
client workstations other than the Microsoft Office Add-In, should one wishes to create Excel
based reports. Some of the commonly used VantagePoint Clients are as follows:

a. The VantagePoint Portal web browser client, which supports:

Highly flexible end user interaction when generating on-demand Reports, Trends, Plots,
and Database Queries;

Rendering of executive dashboards that provide intuitive graphical displays of any data in
VantagePoint, using the elegance of traditional man machine interface techniques (such
as gauges, range indicators, interactive maps, bar graphs, charts, and LEDs ) in a web
environment;

Built-in administration tools;

End user customization and personalization of the portal, using state-of-the-art web part
technologies;

Flexible collaboration between users

b. A full featured zero-install Trend application which creates web reports that:

c.

Allows real time and historical access to all data in the VantagePoint Server
Supports multiple time axes.
Provides Batch trending tools
Supports Independent Y axes

A full featured zero install XY plotting application which creates web reports that:

Allows real time and history access to all data in the VantagePoint Server

Provides the ability to plot one tag against another over time

Allows sophisticated shape definition to determine the allowable values of a tag pair.

Provides alarming when values are outside of the defined shape (even when the plotting
application is not executing)

d. The Office Add-In for Excel combines the very powerful and accessible report writing
capabilities of Excel with the rich Model-centric offering of data from VantagePoint. Users can
select and combine data from sources throughout their enterprise and present that data in
reports that can be published to VantagePoint Portals for consumption by anyone in the
organization with access to a browser The add-in allows one to:

Create content directly for the web application. In fact, the built-in reports in VantagePoint
are developed using the Office add-in.

Build real-time reports and displays that are automatically refreshed in the end users
browser after publishing.

Fetch and then modify or build upon existing published reports.


14 of 878

What can you do with VantagePoint?


VantagePoint is a platform for developing manufacturing applications.
A Production Reporting System
With VantagePoint you can build a system that lets you see exactly what your production process has
done over different production report periods. This includes what have you produced, the cost of that
production, what did you waste, how much down time did you have, what did you make. What were
the deviations between targets and actual production.
By definition it is a rich production reporting environment; you can get directly to the data from
physical processes, historians, and calculations. You can have sophisticated presentations, drawing
together data from various sources. It is easy to make wide range of reports that might cover down
time reporting, quality analytics, production reporting, and deviation reports.
A Manufacturing Portal
A manufacturing portal is typically somewhere to go to look for the key production indicators for your
business. Here you should be able to see if something is out of normal, and if something really
important to performance of business is out of order, you need to see a quick graphical indication of
what that something is and be able to drill down to the cause and be able to react to it.
An effective portal needs to be personalized; a production manager's current focus may be on
increasing line through-put. That person needs to see information and data that is relative to her and
her job whenever, and from wherever, she browses to her portal.
The power of a portal is its ability to disseminate data to people that need it, including:

Suppliers so they can supply materials you need when you need them.
Order Processing so when a customer calls in to know how an order is doing they can
answer immediately.
Plant Operators so they can see how well equipment is operating, or where bottlenecks or
other problems may be coming from.

The VantagePoint Portal is designed to be flexible, customizable, and dynamic.


An Analytical Platform
If you are busy commissioning a new production line, you want to be able to determine that it is
running properly. Are the control algorithms that you have implemented achieving the effect you want
to see? The plant tripped: what was the root cause of the event so you can determine how to stop it
from happening the next time? How does performance really vary as a function of the speed at which
you run the line? You know intuitively that you get more rejects, more failures, and more quality
problems as you run the line faster, but you also get more stuff out. As you take all of those things
and look at them, what is the optimal speed at which to run the line, given that lots of things vary as a
function of line speed? What is the cause and effect between different things? Do you see a
correlation between the operators on duty and the efficiency of the line? Can you find a correlation
between a particular material thats being provided by a vendor and the quality of product you
produce, compared to the same material being supplied by a different vendor? VantagePoint can
assist you in finding the hidden meaning in the wealth of the data that you can access.

15 of 878

Who uses VantagePoint?


VantagePoint comes with 5 pre-configured user-categories based on system usage and security
requirements:
Non-Technical Users
Non-technical Users of VantagePoint are those persons who consume data, reports and other
VantagePoint content, and they most often interact with VantagePoint through the VantagePoint
Portal. This user will launch reports, view and interact with Portal dashboard displays, analyze
Trends, and perhaps author company notice boards for use in the Portal. This type of user may range
from a Maintenance Manager checking on equipment performance, to a Secretary editing the
department newsletter, to a Vice President reviewing sales data.
Power Users
A Power User is someone who knows how the plant is wired together and knows where the data is
and wants to create content that the casual, Non-Technical User is going to use. He can do much of
this inside Excel, and he doesn't need to be a programmer to create sophisticated reports that he can
save into the VantagePoint Model or publish to the Portal. This user will also use his Excel skills to
create powerful animated executive dashboard displays that relate important information at a glance.
Furthermore, some power users will concentrate on developing Trends and XY Plots that can be
accessed through the Portal and analyzed away from the plant itself. Some of these "reports" will
become very sophisticated as scaled background graphics, shapes, batches and other application
properties are employed when analyzing plant performance.
Much of the output created by Power Users can be shared when sister plants install VantagePoint
and employ VantagePoint Models that mirror one another.
Application/System Engineer or "Modeler"
The System Engineer is a business specialist who understands the nature and structure of the
business enterprise, where all of the information about the business is located, and how that
information inter relates. This is the person who will design and deploy the VantagePoint Model,
along with the System Administrator. She will have a deep understanding of the requirements for
information about the business processes, and will appreciate the redundant qualities of many
reporting tasks. As such, many of the aspects of the Model that she designs will be portable, and can
either be reused with her own system or at a sister plant, where the same processes take place.
She will be able to model related business information and simplify the structure of that information in
order to make access and report creation intuitive.
System Administrator
The System Administrator may install and set up the VantagePoint system, and also manages issues
with regards to physical topology, data sources, portals and client connectivity. This person is very
technical and knowledgeable about different software, networking and internet usage. She manages
user security and maintains the Model content.
System Operator
The System Operator is the person who maintains overall system health. He performs backups,
monitors disk space and performs database maintenance duties.

16 of 878

Typical VantagePoint Systems


In a typical VantagePoint System the VantagePoint Server, VantagePoint Portal Server and the
System Data Server are installed on the same machine. Existing data sources to which VantagePoint
will connect usually exist on separate machines. Portal clients and desktop clients will connect to the
server over the network.
Note: On each of the three following diagrams, Microsoft SQL Server 2008 and Office 2010
(32-bit) should also be listed as compatible software when using VantagePoint version
3.1.5 or higher.
Small System Recommended Architecture:

17 of 878

Medium System Recommended Architecture:

Large System Recommended Architecture:

18 of 878

VantagePoint Key Features

The Unified Production Model (UPM) allows plants, equipment, and other resources to be
logically represented along with their real-time and historical data. The UPM provides the
context by associating relevant data from numerous sources, and removes the need to care
where the data physically resides. This information can then be populated into web-based
trends, reports and dashboards then shared across the organization through the FactoryTalk
VantagePoint EMI Portal to empower users at every level of an enterprise to better manage
their operation in real time.

Manufacturing data is accessible in real time.

Thin client architecture only requires a web browser to view published reports, dashboards,
and real-time KPIs.

Pre-configured reports, trends and dashboards provides simplified development


environment.

Published reports provide a single version of the truth to the whole organization maximizing
productivity and minimizing cost.

Connectivity to real-time data via FactoryTalk Live Data (Logix,PLC/SLC, FactoryTalk


View, 3rd-party controllers, etc.) and historical data via FactoryTalk Historian PLUS
connectivity to other real-time and historical data sources.

Drag-and-drop functionality lets you overlay equipment, line and plant trends for comparison
and optimization.

You can manage who has access to view reporting content in the model by defining user
roles.

Integrate VantagePoint EMI reporting content as Web Parts on a SharePoint page


leveraging other collaboration tools from Microsoft.

19 of 878

Ordering Information
FactoryTalk VantagePoint
FactoryTalk VantagePoint is a powerful web-based manufacturing business intelligence solution that
integrates all data into a single information management and decision support system.
FactoryTalk VantagePoint EMI Server
FactoryTalk VantagePoint EMI Server, a license for VantagePoint database connector (e.g. SQL
Server), a license for (3) VantagePoint Named Users Client (which includes a Microsoft SQL
Server2008 R2 Standard Edition, Runtime-Restricted Use Software, (CAL) Client Access License),
a 30-day trial of the optional Dashboard Builder Software and Connectors for FactoryTalk Live Data,
Historian SE, Metrics, and Alarm and Events.
FactoryTalk VantagePoint EMI Client Licenses
A Client User License is required when data is accessed from the VantagePoint Server using the
Portal, one of the Analysis Tools or by 3rd Party Application that can retrieve data from the server.
VantagePoint and VantagePoint EMI support both Named and Concurrent User Clients.
Special Instructions for FactoryTalk VantagePoint Concurrent User CPU License (9521VPCPPENE)
This charge applies if the customer purchases concurrent users and uses the SQL Server license
included with VantagePoint. If the customer has their own license for SQL Server this charge will
not apply. A separate license is required for each physical processor on the server running the
SQL Server used by VantagePoint (the SQL Server identified during the install of VantagePoint).
Configuration Example
A VantagePoint System with 3 Named User and 3 Concurrent Users along with SQL DB
Connector. The customer does not have MS SQL Server 2008 R2 license and has a 2-CPU
(physical) server machine.
FTVP Server (includes SQL Connector & 3 Named Users)

9521-VPSERVENE

FTVP 3 Concurrent Users

9521-VPCL03ENE

FTVP Concurrent User CPU License (per CPU)

2 X 9521-VPCPPENE

20 of 878

FactoryTalk VantagePoint EMI Named User Clients


FactoryTalk VantagePoint 1 Named User

9521-VPNL01ENE

FactoryTalk VantagePoint 3 Named Users

952-1VPNL03ENE

FactoryTalk VantagePoint 5 Named Users

9521-VPNL05ENE

FactoryTalk VantagePoint 10 Named Users

9521-VPNL010ENE

FactoryTalk VantagePoint 25 Named Users

9521-VPNL025ENE

FactoryTalk VantagePoint 50 Named Users

9521-VPNL050ENE

FactoryTalk VantagePoint EMI Concurrent User Clients


FactoryTalk VantagePoint 1 Concurrent User

9521-VPCL01ENE

FactoryTalk VantagePoint 3 Concurrent Users

9521-VPCL03ENE

FactoryTalk VantagePoint 5 Concurrent Users

9521-VPCL05ENE

FactoryTalk VantagePoint 10 Concurrent Users

9521-VPCL010ENE

FactoryTalk VantagePoint 25 Concurrent Users

9521-VPCL025ENE

FactoryTalk VantagePoint 50 Concurrent Users

9521-VPCL050ENE

FactoryTalk VantagePoint Concurrent User CPU License (Per CPU)

9521-VPCPPENE

FactoryTalk VantagePoint EMI Connectors


FactoryTalk VantagePoint EMI Servers support the addition of additional connectors.
FactoryTalk VantagePoint EMI 3rd-party Real-time Connector (Licensed per connector instance)
(Available Connectors: OPC-DA)

9521-VPRTCENE

FactoryTalk VantagePoint 3rd-Party Historian Connector (Licensed per connector instance)


(Available Connectors: OPC -HDA, IndustrialSQL Server, OSI PI)

9521-VPHSCENE

FactoryTalk VantagePoint Database Connector (Licensed per connector instance)


(Available Connectors: MS SQL Server, Oracle, OLEDB, ODBC)

9521-VPEMDBCENE

FactoryTalk VantagePoint EMI Optional Add-Ons


The Dashboard Builder is an optional software solution used to develop dashboard elements and
reports in the VantagePoint system. It is NOT required for users/consumers of dashboard reports.
Systems where the Dashboard Builder is to be installed require Microsoft Office (Excel) 2007.
FactoryTalk VantagePoint Dashboard Builder (Per User)

9521-VPDSHENE

FactoryTalk Integration with Microsoft SharePoint


To display VantagePoint content as a Web Part in a SharePoint web page, you must purchase and
install this component on your SharePoint server (licensed on a per server basis). Any client machine
displaying a SharePoint web page that has VantagePoint content will consume a VantagePoint client
license. If one is not available, the VantagePoint content will not be displayed
FactoryTalk VantagePoint SharePoint Web parts

21 of 878

9521-SHRPNTENE

System Requirements - VantagePoint version 4.5


System Server Requirements
Operating System options:

Microsoft Windows Server 2008 R2 with SP1 (only available in 64-bit); Also requires IIS, part
of the Web Server Role, with IIS version 6 compatibility. Note that IIS is set to 32-bit mode
only.

Software

Microsoft SQL Server 2008 R2 Standard (32 & 64 bit) SP1


Microsoft Office 2010 (32-bit only)
Microsoft Internet Explorer 8, or 9
Microsoft .Net Framework version 4.0 full version (included with install)

NOTE: The .NET Framework 4.0 Client Profile is not supported.

Microsoft StreamInsight 1.2 (for Eventing)

NOTE: FactoryTalk VantagePoint uses a StreamInsight instance named VantagePoint. If no


StreamInsight instance with this name exists on your computer, you need to install
Microsoft StreamInsight during the installation of FactoryTalk VantagePoint. If a
StreamInsight instance with such a name already exists, the installation is not required.
See StreamInsight Instances in the online help for more information.
Hardware (minimum)

2.5 GHz CPU, 2 GB Hard Drive Space, 2048 MB RAM

Full Client Requirements


Operating System

Microsoft Windows XP Professional with SP3 (32-bit or 64-bit)


Microsoft Windows Vista Business with SP2 (32-bit or 64-bit)
Microsoft Windows 7 Professional with SP2 (32-bit or 64-bit)
Microsoft Windows Server 2008 with SP2 (32-bit), Server 2008 R2 with SP1 (64-bit)

Note: Embedded versions are not supported.


Software

Microsoft Office 2007 with SP2 (32-bit only) or Office 2010 (32-bit only)

NOTE: For Dashboard Development only, the Professional Edition or higher is required.
NOTE: Any Microsoft Office edition that does not support XML maps (such as Microsoft
Office Small Business Edition) is not supported.

Microsoft Internet Explorer 8, or 9


Microsoft .Net Framework 4.0
Xcelsius 2008 SP4 (for Dashboard development)
Adobe Flash Player (for Dashboard viewing)
Adobe Reader (for viewing Eventing/ReportSet Reports)

Hardware (minimum)

1.5 GHz CPU, 100 MB Hard Drive Space, 512 MB RAM

22 of 878

Browser Client
Operating System

MS Windows XP Professional with SP3 (32-bit or 64-bit)


MS Windows Vista Business with SP2 (32-bit or 64-bit)
Microsoft Windows 7 Professional with SP2 (32-bit or 64-bit)
Microsoft Windows Server 2008 with SP2 (32-bit or 64-bit), Server 2008 R2 with SP1 (64-bit)

Note: Embedded versions are not supported.


Software

Microsoft Internet Explorer 8 or 9


Microsoft .Net Framework 4.0
Adobe Flash Player (for Dashboard viewing)
Adobe Reader (for viewing Eventing/ReportSet Reports)

Hardware (minimum)

1.5 GHz CPU, 100 MB Hard Drive Space, 512 MB RAM

23 of 878

The Virtual Machine Setup for This Training


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 is an OPTIONAL image for this training. It 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

NOTE: Images need to be fully runningServer is started first until running (started
dialog appears), Data is next until running and finally Client until running

24 of 878

Lab 1 Exploring VantagePoint Portal


The VantagePoint EMI Portal has many of the same characteristics as other commonly known
portals. It is web based and users browse to it using a standard web browser. It can be fully
customized to suit your business, and individual users can personalize parts of the portal for their own
use. The Portal is extensible; it can reach out to other sources of data beyond VantagePoint EMI
data: other web based objects and content can be incorporated into the portal that VantagePoint EMI
may not know about at all. The VantagePoint EMI Portal can easily link to other sites for content such
as weather or news.
What makes the VantagePoint EMI Portal especially powerful, however, is its ability to find data that
is already inside VantagePoint EMI - with only a browser. This includes enterprise data that
VantagePoint EMI can access via data connectors as well as any items created in the VantagePoint
EMI Model

Explore VantagePoint Help and Diagnostic Content


1. Verify that you are on the Server Image (Server tab is selected).

2. Start the VantagePoint Portal by going to


Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Portal.
The VantagePoint Portal could also have been accessed by opening an Internet Explorer and
browsing to: http://server/VantagePointPortal/Home.aspx.
3. On the home page some key valuable information, including what is new on this release, is
immediately available for the user. Feel free to view them by following the hyperlinks. As you go
through this training you will learn more about the terminology, and concepts mentioned in these
related areas.

25 of 878

4. Click on Help and then About

5. The key support as well as other important user and installation information are provided on this
page.

6. On the About window, Click on Log File Locations to see where the log files are located. These
log files play a critical role in diagnostic and troubleshooting operations.

7. On the About window, click on Event Log to open the EventLogViewer page. You may also get
to this page by going to: http://server/Incuity/EventLogViewer.aspx.

The Windows Event Log window provides a comprehensive tool to view the various logged
data. In addition to the search engine, it also provides an extensive filtering capability to narrow
the search to the area of interest.

26 of 878

8. Click on Select on one of the entries to view more detailed information on the window below:

9. Click on Event Log Filter, Event Type Filter, and Source Filter to view the comprehensive
filtering options available.

10. Feel free to experiment with the filters and observe their effect on the reported items. For
example click on Event Log Filter, and select AF (Asset Framework) to view the immediate
impact on the displayed report.

11. Click on Help and then Contents.

12. You will note that the entire VantagePoint manual in an indexed searchable format is available
electronically. Feel free to browse through this material.

27 of 878

Explore Existing VantagePoint EMI Reports


The images contain a completely installed VantagePoint without any configuration. This is done
intentionally to create an environment as close as possible to a real one, where software is installed
and an application is about to be created. The base VantagePoint installation however does contain
a large number of very useful sample reports. In this section we will take a quick look at this content.
1. Select Reports and then My Enterprise from the Portal menu. The model view items listed under
reports are customized views of the VantagePoint model reporting content. MyEnterprise,
ChartsAndGrids, and Samples are default Model Views which were created by the
VantagePoint EMI system. Later when we configure the FactoryTalk Connector, another entry
called FactoryTalk will be added to this menu list. The menu system along with the entire look
and feel of portal is customizable and can be modified to meet project requirements. We will see
how to do this in future lesson.

2. You will notice quite a few folders under the My Enterprise folder. They are all part of Sample V4
folder which itself contains 4 additional folders. As their name suggests, they contain reports at
various level of complexity (Basic, Intermediate, and Advanced) as well as set of support reports.
This extensive set of sample reports is an excellent place to learn more about whats possible
with VantagePoint as well as using the reports to see how they are made and configured.

3. Feel free to expand the various folders, and explore the reports within the Samples v4 as well as
the ChartsAndGrids sample reports. You will soon learn how to create and organize similar
content.

28 of 878

Introduction to the Content Viewer


VantagePoint EMI Reports are accessed from the Reports tab in the Portal menu. Individual reports
and other VantagePoint EMI Model items are hosted in a container called a Content Viewer. The
Content Viewer is a tool to help users locate content in the VantagePoint EMI Model. Content in this
context is anything that the Content Viewer can display, and includes reports, trends, plots and
dashboards that are stored in the Model. It also includes hyperlinks to web pages, and custom built
items that result in report displays.
The Content Viewer makes it easy to locate content that has been stored together in the
VantagePoint EMI Model by browsing to the same location, or folder name, in the Viewer. The
Content Viewer provides a tree-view of the VantagePoint EMI Model, but, for performance reasons,
only displays VantagePoint EMI "content" - reports, dashboards, etc. - that it finds inside Model
folders. The content type is identified by its icon in the tree.

This lab is complete

29 of 878

Lab 2 FactoryTalk Directory and Application


The Server image you are using in this training has a FactoryTalk Historian SE Server already
installed. A local Historian FactoryTalk Live Data Interface is also installed on this image.
Separately, another FactoryTalk Historian Live Data Interface is also installed on the Data VMWare
image is. Although the Server and Interfaces have already been installed, no VantagePoint
configurations have been done. Before continuing, if you havent already done so, please review
Appendix A for examples of the installation process/procedure.
1. Verify that you are on the SERVER image:

2. Open the FactoryTalk Administration Console by going to


Start > All Programs > Rockwell Software > FactoryTalk Administration Console.
3. Select Network directory.
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). Historian SE is one of the data sources
that we use in this training. IT has already been configured to collect a few data point from
the controller which we will use for various exercises.

5. Observe and verify the Device Shortcut s(analogues to OPC topic) by:
a. Expand RA Food application
NOTE: Notice the Data Server named RSLE. This is an instance of RSlinx Enterprise
installed on the server image.
b. Double click on Communication Setup under RSLE
c.

If you click on BL1, you will see that BL1 is a shortcut for the Controller in Slot2 of the
SoftLogix Chassis. In the same manner BL2 is the shortcut for the Controller in Slot3.

NOTE: In this training you will be connecting to data coming from FactoryTalk, with
application of RA Foods, Data Server of RSLE, and shortcuts of BL1, and BL2

This lab is complete


30 of 878

Lab 3 Starting the FactoryTalk Transaction Manager


to Collect & Store data to Be Used by Various Labs
For future lessons we are using FactoryTalk Transaction Manager (FTTM) software to collect and
store time-series data in the ProductionData database. PLEASE NOTE that FactoryTalk
Transaction Manger IS NOT needed for a VantagePoint Application. This has been done solely for
the purpose of populating current time-series data from the Line 1 and Line2 simulation
programs into a ProductionData database table named dbo.EquipmentData, so we have data to
demonstrate and learn VantagePoint features.
The programs or tools used to collect and store the data in the database has no direct bearing on any
of the following lessons. The data could come from a variety of sources that could include both
Rockwell Automation products as well as third party products
1. Verify that you are on the Server Image (Server tab is selected).

2. Start FactoryTalk Transaction Manager configuration called FactoryTalk by following the steps
below:
a. From the Start menu select
All Programs > Rockwell Software > FactoryTalk Transaction Manager > FactoryTalk
Transaction Manager
b. Select the FactoryTalk application
c.

Click the Start icon

3. Click Yes.

31 of 878

4. From the View menu select Transaction Monitor.

5. Verify that transactions are occurring and passing and there are not excessive numbers of
failures (i.e. more that about 10). It should be zero, but sometimes there are a few during the
initialization process.

6. From the Configuration menu select Exit.


Transaction Manger runs as a service.

This lab and lesson is complete.

32 of 878

Lesson 2 - Configuring Simple FT Data Sources

What you will learn:

Logical vs. Physical Model


How to configure FactoryTalk VantagePoint (FTVP) Server
How to connect to a Simple FactoryTalk Live Data source (See Note)
How to connect to FactoryTalk Historian SE
How to connect to FactoryTalk Alarm&Event Database

Prerequisite:

This trainings VMWare image

NOTE: Setting up connection to structured tag sources (UDT) will be discussed in future
lessons in this training
To view and analyze your manufacturing data, you will need to configure the VantagePoint Server to
connect to your production data sources. This configuration is done using VantagePoint Manager.
(Manager is used to manage the entire VantagePoint System including configuration of the model
and security.)
FactoryTalk VantagePoint EMI offers out-of-the-box, direct connections to FactoryTalk Live Data
sources. Connectors can be configured to access data from:

FactoryTalk Live Data Sources (Logix controllers, PLC, SLC, etc.)


FactoryTalk Historian
FactoryTalk Alarm & Events History
FactoryTalk Metrics
SQL Server Database
And with Optional Connectors, to:
o 3rd Party Real-time Sources (through FactoryTalk Live Data-OPC DA
connector)
o 3rd Party Historian Sources (through OPC HDA, Industrial SQL Server, GE
Proficy Historian, OSI PI)
o Database Connectors ( Oracle, OLEDB, ODBC, and additional SQL Server)

Additionally, a special data source is VantagePoint Simulator. A simulator is installed with


VantagePoint so that you can begin learning the product before you have it attached to your plant
data sources. Several instances of the simulator are created during the installation. Additional
instances can be created by right-clicking the Simulator node (under the System > Sources node),
and selecting Create Instance.
FactoryTalk connectors install automatically, and once configured accesse FactoryTalk Directory
services to locate sources of data. In this lesson we will learn how to establish connection to multiple
FactoryTalk data sources.

33 of 878

Discussion
Logical Model
The top portion of the Model is referred to as Logical area and named MyEnterprise. By default it
contains an empty folder named Public and another folder full of sample content called Samples.
This logical area is intended for users to create their own structure based on their facilities,
applications, machines, processes, etc. This could be totally up to their preferences and what makes
sense to them in how they want to organize things.

Physical Model
The bottom portion of the model under System folder is referred to as Physical area. This data is
internal information about how VantagePoint is configured and wired together. The information
reflects the physical topology of VantagePoint, and how it is configured including the connector
information, Portal, Users, Groups and Security configuration.

34 of 878

Configuring FactoryTalk Data Sources


FactoryTalk VantagePoint supports connection to FactoryTalk Live Data, FactoryTalk Historian, and
FactoryTalk Alarm and Event data sources. FactoryTalk data sources must be configured
appropriately prior to referencing the data in VantagePoint.
The flow chart below illustrates how to configure FactoryTalk data sources such that the data can be
referenced by VantagePoint. This example uses Linx Enterprise which is the recommended and
preferred data server for communicating with Rockwell Automation controllers (Control Logix, PLC-5,
SLC-5 etc.).
Configuring FactoryTalk Data Sources Flowchart
ROCKWELL AUTOMATION CONTROLLERS
(ControlLogix, PLC-5, SLC-5, ETC)
o
o
Begin
o

Does your environment


contain an existing
FactoryTalk Directory?

NO

Connecting Rockwell
Automation data
sources to
VantagePoint that
are not associated
with a FactoryTalk
Directory.

YES

NO

Does your environment contain


more that one FactoryTalk
Directory?

YES

To learn more about creating a


Device Shortcut using RSLinx
Enterprise, please review the
RSLinx Enterprise Getting
Results Guide located in the
Resources folder on the
VantagePoint installation DVD.

FACTORYTALK HISTORIAN
Use the VantagePoint
Standalone FactoryTalk
Historian connector to
reference data items from a
FactoryTalk Historian.

If your environment contains


one FactoryTalk Directory, set
the Directory name in
VantagePoint to join the
existing FT Directory.

For additional information, please


review the VantagePoint Help
topic <Add a FactoryTalk
Historian Connector>.

If necessary, you may need to


use the FactoryTalk Directory
Server Location Utility to
ensure that VantagePoint
points to the correct FT
Directory.
For additional information,
please review the
VantagePoint Help topic <Add
a FactoryTalk Connector>

If your environment contains more than


one Factory Talk Directory you have 2
options for VantagePoint connectivity.

OPTION 1

Install RSLinx Enterprise


Using RSLinx Enterprise,
create a Device Shortcut that
links directly to the underlying
control devices.
Reference the data item via the
Device Shortcut in
VantagePoint Manager.

OPTION 2

Using RSLinx Enterprise, create


Device Shortcuts that links directly
to underlying control devices.
Reference these data items via the
Device Shortcut in the
VantagePoint Manger.

Create a new application on one of


the existing directories that contains
all Resources, PLCs, Historians,
Alarm & Events etc.
Set the Directory name in
VantagePoint to join the existing FT
Directory that contains the
application created above.

Use the VantagePoint Standalone


FactoryTalk Historian connector to
reference data items from a
FactoryTalk Historian.

End

NOTE: FactoryTalk VantagePoint does not support browsing the online folder of RSLinx
Classic or connectivity to a PI collective.
NOTE: When using the VantagePoint FactoryTalk Historian connector, the following two
conditions must be met:

A Trust needs to exist between the VantagePoint Server and the machine hosting the
Historian before creating this connector.
The machine hosting the target Historian must be added to the PI-SDK on the VantagePoint
Sever machine.
If your environment requires RSLinx Classic, please consult the product documentation or
contact Rockwell Technical Support at (440) 646-3434 for further assistance.
35 of 878

In this lesson we will create a FactoryTalk connector. Information defined in the FactoryTalk Directory
is exposed as potential data sources for VantagePoint to use. The lesson goes through the steps of
creating the connector and browsing the directory namespace for known FactoryTalk Historian, Live
Data, and Alarms and Events data sources. We will learn how a connection is made to FactoryTalk
sources in VantagePoint Manager.

Lab 1 - Extending the FTVP Model


In this lab, we will create the initial folder structure which we use to house all the content we will
create in this training. We will create the following structure under the Enterprise folder:

1. Verify that you are on the Server Image (Server tab is selected).

2. Open FactoryTalk VantagePoint Manager by going:


Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Manager

36 of 878

3. Create a folder called MyPlant and additional subfolders under it where we will save our project
contents:
a. From the FTVP Manager right mouse click on MyEnterprise and select New > Folder

4. In the Folder name textbox enter MyPlant (no spaces).


a. Click OK

5. Repeat the above two steps to create a folder structure as shown below (Reports, Tags, and
TimePeriods under MyPlant and BL1, BL2, and Hist under Tags folder.

6. Open MyEnterprise folder in the Portal by following the steps below:


a. Open VantagePoint Portal from Start>All Programs>Rockwell Software>FactoryTalk
VantagePoint>Portal
b. Select MyEnterprise under Reports

37 of 878

7. Notice that none of the folders we just created under MyEnterprise, show up in the portal. This is
because only folders which have viewable content will show up in the portal.

This lab is complete

38 of 878

Lab 2 - Configuring FactoryTalk VantagePoint Server


1. Verify that you are on the Server Image (Server tab is selected).

2. Make sure the correct FactoryTalk Directory Location is selected. THIS STEP IS ALREADY
DONE FOR YOU. To ensure that VantagePoint selects the correct FactoryTalk Directory, you
must use the Rockwell Software > FactoryTalk Tools>Specify FactoryTalk Directory Location to
change directories prior to creating a data source connection in VantagePoint. See the
FactoryTalk Connector topic in the online help for more information.
3. Open FactoryTalk VantagePoint Manager by selecting from the Start menu:
All Programs > Rockwell Software > FactoryTalk VantagePoint > Manager
4. Create an instance of FactoryTalk Connector by following the steps below:
a. Expand the System > Sources folders.
NOTE: Each item listed under Sources is a connector to a different data source for
FactoryTalk VantagePoint EMI, some of which require additional licensing.
b. Expand the FactoryTalk Folder, and note that it is empty.
c.

Right click on FactoryTalk, then Select New > Item.

39 of 878

5. You are presented with a dialog box that allows you to configure your FactoryTalk Directory data
source for VantagePoint EMI to access FactoryTalk Live Data, Historian Data and Alarm &
Events Information. FactoryTalk VantagePoint EMI is capable of connecting to a single
FactoryTalk Directory at a time. An existing FactoryTalk user can be used or a new account can
be created.
a. Verify that the User name is VantagePoint
b. In the Password text box enter rockwell (all lower case), and click Next

6. When the configuration has completed the following dialog box will appear.
a. Select the No, thank you option, as we will do the import later, and click Finish

NOTE: The above steps created an instance of the FactoryTalk connector called localhost.
Since the FactoryTalk Directory is hosted on the same machine as VantagePoint EMI, the
server reference defaults to localhost. If the directory was hosted on another machine,
then that machine name would have been used instead of localhost.
40 of 878

7. Verify and observe the created instance of the FactoryTalk connector by following the steps
below:
a. Navigate to System>Sources>FactoryTalk>localhost
b. Right-click on the localhost node and select Expand All
NOTE: Notice the various connectors (live data, Historian, etc.) created by the instance of
the FactoryTalk connector. We will configure them individually in upcoming labs.

This lab is complete

41 of 878

Lab 3 Adding FactoryTalk Live Data (FTLD) Points


Now that an instance of the FactoryTalk connector has been created, VantagePoint EMI is ready to
be configured to use the individual FactoryTalk data sources.
In the following steps, we will import some FactoryTalk Live Data. FactoryTalk Live Data is part of the
FactoryTalk Services Platform. It allows FactoryTalk-enabled products to discover, connect, and
share real-time data in a secure, scalable manner. The basic services provided by FactoryTalk Live
Data are: Read, Write, Browse and Subscribe to data items. The overall benefit is a consistent,
standard architecture for communicating real-time values between clients and data servers that
embraces OPC standards and provides extended benefits to any FactoryTalk Services-enabled
products.
In addition to references to simple tags (whether member of a structure, array or individual tag),
VantagePoint EMI allows you to import User-defined Data Type (UDT) and System-defined Data
Type (SDT) structures from your controllers into the Model. This maintains the structural relationship
of tags to be used in VantagePoint EMI when creating template reports.
In this lab we will:

Take a look at the Controller tags for this lab


Import simple FactoryTalk Live Data tags into VantagePoint EMI

Part A - Review ControlLogix Program


Two controller applications are 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.
1. Verify that you are on the Server Image (Server tab is selected).

2. Go online with the controller in Slot 3 by following the steps below:


a. Open the RSLogix 5000 Program C:\Class Files\CLX Programs\
CLX_Hott_2012_BL2_v16.ACD by double clicking on it.

42 of 878

b. In RSLogix5000, Go online with the controller in Slot 3 by selecting Communications > Go


Online

c.

If the Connected To Go Online dialog box appear, click on Download

d. If the above step did occur, click on Download on the Download confirmation dialog box

e. Once download is complete, change controller mode back to Remote Run by clicking on Yes

43 of 878

f.

This program is a simulated plant consisting of three main areas: Mixing, Proof Ovens, and
Packaging.

3. Browse through the Program Tags section of each program/task. They are of various data types
(string, DINT, Timer, etc.). For example take a look at SimpleTempZone temperatures in
Proof_Oven Program tag area, and note how the temperatures in various zone starts to change
as batch goes through various steps.

The Breadline 1 program runs in the SoftLogix engine in Slot 2 and is similar to what we just saw
for Breadline 2. We will establish connection to some of these from the VantagePoint shortly.

44 of 878

Part B - Importing Simple (Non-Structured) FactoryTalk Live Data


1. Verify that you are on the Server Image (Server tab is selected).

1. Open FactorTalk VantagePoint Manager by going:


Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Manager
2. From the FTVP Manager expand the System > Sources > FactoryTalk folder and all
subsequent folders. Note that all folders are empty. After the connector configurations each
folder will get populated by the information related to associate connector.

3. Right-click on localhost and select Import.

45 of 878

4. Verify that the I would like to import FactoryTalk Live Data tags option is selected, and click
Next.

5. Select the I would like to import simple tags from Logix controllers and other data servers
option and click Next.

The left pane of this dialog is browsing the FactoryTalk Directory for Live Data sources. As you
note, these are the shortcuts to the controllers which we reviewed in Lesson 1, and earlier in this
lesson. This is so, because all these application are in the same FactoryTalk directory. The user
has the ability to select individual data sources for importing and to specify whether all subfolders
should also be imported and/or certain tags based on a filter rule to be imported.

46 of 878

6. Import all the tags in the Proof_Oven program in both line 1 & 2 which contain the text Simple
in their name by following the steps below:
a. Drill down to RA Foods > BL1 > Online > Program:Proof_Oven
b. Click on > button to move the folder to be imported
c.

Verify the Sub Folders check box is checked as we want to import all sub folders as well

d. Repeat the above steps for RA Foods > BL2 > Online > Program:Proof_Oven to have both
lines Proof Oven tags for importing consideration
e. Click Next

47 of 878

f.

Select Bread Line 1 Proof Oven (top one also noted in the Folder Location on the lower left
part of the dialog box)

g. Select the Import all tags whose names match any of these conditions: option
h. Verify that Contains is selected from the Or Condition combo box
i.

In the Value textbox enter Simple

j.

Repeat the above steps for Bread Line 2 Proof Oven (BL2)

k.

Click Finish

7. The following dialog box may appear while the import is taking place. Do not close it.

48 of 878

8. Click OK on the window confirming the completion of the Import process.

NOTE: A new entry named FactoryTalk is created under the Reports menu in the portal.
There is also a new entry called FactoryTalk containing the Application folder is created in
the Logical side of the model under MyEnterprise folder

9. Verify the import process in the VantagePoint Manager by following the steps below:
a. Expand the System > Sources > FactoryTalk > localhost > Applications and note that
the RA Foods application and the two Bread Lines (BL1 & BL2) are now under the
Applications folder (it has been imported)
b. Expand further to > RA Foods > BL1> Online > Program:Proof_Oven and note that all the
folders under the Proof_Oven are also imported
c.

All the tags containing Simple in the root folder of the Proof_Oven program are imported.

d. If you wish, browse through the folders under Program:Proof_Oven. You will find most of
them to be empty unless they contain a tag which has Simple as part of its name (i.e.
SimpleBatchID further down the folder list)

e. Repeat the above step to verify BL2 tag import as well


NOTE: If an item in the tree contains tags, reports, or time periods, they will be displayed
in the list view under the tree when that item is selected
49 of 878

10. Observe the General information about the tags you just imported by examining
SimpleTempZone1 following the steps below:
a. Click on SimpleTempZone1 under the BL1 > Online > Program:Proof_Oven
b. Click on General Tab
NOTE: The type (float) is properly corresponding to the tag type in the Controller
NOTE: The VantagePoint Fully Qualified Name (FQN) for this tag which is a shortcut to the
actual tag in the controller

11. Observer the Security features for the imported tags by following the steps below:
a. Click on Security Tab
NOTE: Notice the various groups/roles privileges and authorization regarding the
selected tag.

NOTE: This same Security tab applies to other items (i.e. reports) in the VantagePoint
which provides a granular role based security for the entire system. Security will be
discussed later in this training.

50 of 878

12. Observe the tag Properties by following the steps below:


a. Click on Properties Tab, and note the various information about the tag including the Fully
Qualified Name (FQN) and the source of the tag

b. Click on Edit, and note that Description, Min/Max, Engineering Units and the current Value
(in this case read form SoftLogix) can be modified, but the rest are not editable.
NOTE: In this case, the value if edited will be overwritten in the next read form SoftLogix)
13. Click on Cancel without modifying anything to get out of the Edit window.

51 of 878

14. You probably noticed that navigating through the physical model (under System folder) to get to
the tag was cumbersome. This task can become quite challenging as more and more content is
added to the model. A good modeling practice which also makes the navigation and finding data
easier is to create a shortcut in Logical model pointing at target data in the Physical model. We
will create a shortcut in MyPlant which we created in the previous lab to point at Proof_Oven
data by following the steps below:
a. Right-click on Program:Proof_Oven and select Copy

b. Navigate to MyEnterprise > MyPlant > Tags >BL1, Right-click on BL1, and select Paste
Shortcut.

52 of 878

Shortcuts as their name suggest are simply a reference to the source of information. As such
deleting a shortcut will have no impact on the source of data. The reverse however is not true. If
an information source is deleted, all referring shortcuts will also be deleted.
You will note that a shortcut to the Proof_Oven is now created which we can easily access. As
you can see shortcuts make the data access easier. They can also facilitate the understanding of
the organizational structure of data by abstracting out the physical layer which is typically of little
value to an end user.

NOTE: We could have made the shortcuts even shorter or more granular by simply
creating the shortcuts to the tags directly bypassing the whole SoftLogix folder structure.
The decision on the granularity of the shortcut is for the most part application dependent,
and is mainly depend on the importance of the information that the path to data conveys.
15. While we are here, repeat the above steps to do the same thing for BL2

This lesson is complete. You have just finished importing Non-structured factory live data tag. In
upcoming lessons, you will use these tags to create various reports, and learn more about various
VantagePoint features.

This lab is complete

53 of 878

Lab 4 Adding FT Historian Tags to FT VantagePoint


FactoryTalk Historian collects time-series data which can be used as a basis for various calculations,
estimations, statistical processes and quality controls throughout the processes and applications in
the enterprise.
In this lab, Historian SE tags will be imported into FactoryTalk VantagePoint EMI. It will also be shown
that VantagePoint EMI is able to automatically create an association between Live Data and Historian
SE tags when they are located in the same FactoryTalk Directory.
The Historian SE configured for this FactoryTalk directory is called Production Historian. It is
configured to historize (log) a select number of tags from the two SoftLogix engine that are referenced
by the BL1, and BL2 shortcuts in the Linx Enterprise. Some of these SoftLogix tags historized by
Historian are the same tags which VantagePoint is directly connected to via FactoryTalk Live Data
connection (configured in the previous lab).
1. Verify that you are on the Server Image (Server tab is selected)

2. Select FactoryTalk Historian as the source of tag import by following the steps below:
a. Launch VantagePoint Manager from the Start menu by going
All Programs>Rockwell Software>FactoryTalk VantagePoint>Manager
b. Expand the System > Sources > FactorTalk folder
c.

Right-click on localhost and select Import

54 of 878

d. Select the I would like to import FactoryTalk Historian tags option


e. Click Next

NOTE: The FactoryTalk Import tool interrogates the FactoryTalk directory which this
VantagePoint Server is a member of and presents the configured Historian SE server
connection for this FactoryTalk Directory.
3. Select the Historian Server Connection (named Production Historian in this lab) by following the
steps below:
a. Check the Production Historian check box
b. Click Next

NOTE: Currently there is no selection criteria (filter) capability similar to what we used to
filter the imported tags for Live Data import. As such reference to ALL Historian tags will
be imported to the VantagePoint Server

55 of 878

4. The next dialog allows you to configure any FactoryTalk Historian ME modules in the system.
This lab is not using an Historian ME module, so select Finish.

FactoryTalk Historian Machine Edition (ME) provides high-speed, reliable data capture,
mitigating the risk of downtime and helping manufacturers to reach continuous process
improvement goals.
FactoryTalk Historian ME achieves its excellent reliability through a solid-state design hardened
for on-machine use and with no moving parts. Its limited software footprint requires no server or
PC, significantly reducing the risk of data loss due to network or other system interruption and
making the unit ideal for remote or difficult locations.
5. The following two dialog box will appear in sequence to confirm the importing as well as
completion of the task.
a. Click OK on the Import Successfully Completed message window

NOTE: It may take several minutes for the FTVP Manager to refresh

56 of 878

6. Verify that the Historian tags are imported by following the steps below:
a. Expand the System > Sources > FactoryTalk > localhost > Historians > Production
Historian folders and click on Tags
NOTE: It may take a few minutes for the Item Names table to populate
b. Verify that the SoftLogix tags (starting with BL1, and BL2) were imported (scroll down the
Item Name list)
NOTE: There are other tags which may not be familiar to you (i.e. BA:Active.1,
Server_Errors System, etc...) These are internal Historian SE tags

57 of 878

7. Verify the powerful point correlation mentioned earlier where VantagePoint automatically
correlates various connections to the same source of data by following the steps below:
NOTE: Remember that in the previous lab we imported Live data tags in Bread Line 1
(BL1) SoftLogix which contained Simple in their name.
a. Drill to System>Sources>FactoryTalk>Localhost>Historian>Production Historian
b. Select Tags and then BL1.Program:Proof_Oven.SimpleTempZone1 in item list
c.

Click on Properties tab to see this tags properties

d. Review the various properties and in particular note that the tag is aware of both the LiveData
connection imported earlier, and the current Historian connection.

8. Check other imported Historian tags. You will note that this correlation only exists for the tags
from SoftLogix that contain the word Simple (that was the import filter applied to LiveData
import). All other tags have a blank value for their LiveDataTag parameter as the LiveData
version of these tags were not imported.
NOTE: The ability to correlate various connections to the same source of data is one of
the powerful features of VantagePoint. For example it manifests itself visually when
trending a tag as it would know to pick the best source to display information for a given
tag (i.e. historized or live)

58 of 878

9. Verify and modify Production Historian parameters by following the steps below:
a. Click on Production Historian just created a few steps ago
b. Click on Properties tab to see the Production Historian properties
c.

Review the various properties, some of which can be edited

d. Click on Edit

NOTE: Some of the Production Historian parameters can be modified.

59 of 878

10. For the training purposes, we like to see the non-aggregated version of the data form the
Historian. In an upcoming lab when trending the data, we will see the impact of this selection. Set
the connector such that the Historian aggregation would not pass through by following the steps
below:
a. Deselect the AreAggrsPassedThrough so the Historian aggregation would not be passed
through
b. Click on OK

60 of 878

You probably noticed the FactoryTalk Historian node under the Sources which is obviously not the
one we have been working with in this lab. As you note the FactoryTalk Historian node is not under
the FactoryTalk Directory folder. This is to indicate that it is a Stand Alone Historian SE. Since
VantagePoint can only connect to one FactoryTalk Historian SE, the Standalone Historian connector
enables VantagePoint to connect to other Historian SEs enabling it to be a powerful data aggregator
for multiple FactoryTalk Historian SEs.

The list view will show all the tags belonging to a particular item folder. To make it easier to find a
specific tag, select the Filter option highlighted below (1) then enter the string you are interested in
(2), which will filter the tags to show only the tags that contain the typed string (3).
In the example below, we are interested in tags that have Batch_Id as part of their name.

DO NOT FORGET to disable filter by clicking on the filter again. Otherwise you will only see the
filtered list of tags.
This lesson is complete. You have just finished importing FactoryTalk Historian tags. In upcoming
lessons, you will use these tags to create various reports, and learn more about various VantagePoint
features.

This lab is complete

61 of 878

Lab 5 Importing FactoryTalk Alarms and Events


FactoryTalk Alarms and Events allow multiple FactoryTalk products to participate together in a
common, consistent view of alarms and events occurring throughout an entire FactoryTalk system.
When using FactoryTalk Alarms and Events, it can optionally be configured to log data to a historical
database.
FactoryTalk VantagePoint EMI provides access to the historical Alarms and Events data through the
FactoryTalk connector. This is done by creating a connection from VantagePoint EMI to the historical
Alarms and Events database and providing basic reports for viewing the historical data.
NOTE: There is one Alarm and Events database configured for this FactoryTalk directory
and it is called AlarmEventHistory.
1. Verify that you are on the Server Image (Server tab is selected).

2. Open VantagePoint Manager, if not already open by going to


a. Start>All Programs>Rockwell Software>FactoryTalk VantagePoint>Manager
3. Open the FactoryTalk Import tool by following the steps below:
a. Expand the System > Sources > FactorTalk folder
b. Right-click on localhost and select Import

62 of 878

4. Select FactoryTalk Alarm and Events as the source information to be imported by following the
steps below:
a. Select the I would like to import FactoryTalk Alarms and Events option
b. Click Next

NOTE: The FactoryTalk Import tool interrogates the FactoryTalk directory which this
VantagePoint Server is a member of, and presents all the configured Alarm and Event
database/server connection for this FactoryTalk Directory.
NOTE: that the number of event count is ZERO, because this is our first ever import as
noted with Never under last Import
5. Select the desired Alarm and Event connection (in this lab there is only one, and it is called
AlarmEventHistory) by following the steps below:
a. Check the AlarmEventHistory check box
b. Click Next

63 of 878

6. Read the confirmation request message, and click Yes to deploy the necessary Stored
Procedure.

7. VantagePoint now deploys all the stored procedures to the database which is necessary to
retrieve the Alarm and Event information, and shows you the following two dialog box in
sequence to confirm the importing as well as completion of the task.
a. Click OK on the Deployment was Successfully Completed message window

NOTE: It may take several minutes for the FTVP Manager to refresh
The FactoryTalk Alarm and Events connector creates a rich set of queries which provides you the
ability to interrogate the Alarm and Events database and create powerful reports.
In the future lessons you will learn how to execute these queries to provide data and/or embed
them in your reports
The Connector also automatically creates FactoryTalk Alarm and Event entry under the
FactoryTalk menu which itself contains default reporting content for FactoryTalk. All of the content
in this model view is auto-generated. Users have the ability to add additional content or use this
content anywhere in the model.

64 of 878

8. In VantagePoint Manager, verify the content generated by the Alarm & Event connector by
following the steps below:
a. Expand the System > Sources > FactoryTalk> Localhost > AlarmAndEvents
b. Right-click on AlarmAndEvents and select Expand All
Notice all the Queries, and Reports generated by the Alarm and Events Connector

65 of 878

9. To get a feel for what these queries can do, lets test one of them by following the steps below:
a. Right-click on the GetSourceNameList item instance
b. Click Edit

Note that this query returns a list of unique source names in Alarm and Event Database. Also
note that this particular query has no parameters. We will learn much more about queries, and
how they can be used in various contexts later in this training. For now let simply test this query
by clicking Test.

10. The Alarm and Event database unique source names are returned. Review and click Close.

66 of 878

11. View the Alarm and Event connectors automatically generated reports by following the steps
below:
a. Open VantagePoint Portal from the Start menu by going
All Programs > Rockwell Software > FactoryTalk VantagePoint > Portal
b. From the menu bar Select Reports > FactoryTalk

12. Expand the FactoryTalk menu tree to see the automatically generated reports. Depending on the
state of the alarms at this point in the lab, these reports may not look very exciting.

NOTE: The first time rendering of the Alarm & Event report may take a long time.
NOTE: There is a free and much more graphically appealing Alarm and Event report
package with navigation capability on Rockwell Automation Knowledgebase (KB ID 68296)
which can be downloaded and used.

This lab and lesson is complete

67 of 878

This page intentionally left blank

68 of 878

Lesson 3 - Creating and Publishing Trends

What you will learn:

Become familiar with the Trend properties and options


Become familiar with Time Periods
Visualize FTLD and FTH date using the Trend object

Prerequisite:

Completion of Lesson 2

Discussion
Trends
Trend is a client application that runs in an Internet Browser and allows you to query data and plot
them on a graphical display. Trend relies on the VantagePoint Server to present data from multiple
sources in an orderly fashion, allowing you to navigate to specific data, and then plot that data.
Trend

Allows users to see the values of tags over a historical period of time, over a pre-set period of
time, and in real time.
Allows Users to easily identify the boundaries that define normal conditions for a trace, by
employing user-defined shapes.
Can determine that the value of a tag is outside of a defined boundary.
Can display and compare multiple tags concurrently.
Trends can be saved as time-periods, or batches, and used to compare trends over different
time periods.

Once you have selected a tag, or multiple tags, you can manipulate the data in a graph in a variety of
ways, including panning, zooming, and scaling. Trend graphs and their associated data can be
printed so that the data can be analyzed away from the client machine. You can customize any graph
by configuring display options, and set general options for use with all graphs.
Before this client application can be used to query tag information from the database, the
VantagePoint Server must be running and you must have access to the server.

69 of 878

Trends main user areas are as follows:

Tool Bar
Model Browser
Portal URL
Plot Surface
Time Bar
Data Retrieval Settings
Trace List

Tool Bar
The Trend Tool Bar provides tool tips to describe tool actions.

Portal URL
Double clicking Portal URL opens the VantagePoint Portal

70 of 878

Plot Surface
The plot surface itself has many attributes, such as the ability to move the axes, stack traces and
display background graphics. A right click on the plot surface will bring up a sub menu which allows
you to manage time-periods, axes, and to adjust trace properties.
Trend Plot Surface

The axes can be moved into the plot surface to highlight specific data
Properties of the plot surface, traces and axes can be customized
Multiple traces can be displayed at one time
Multiple windows can host multiple time-periods and each time-period can be comprised of
multiple traces
Traces can be "batched" which provides a way to compare traces over two or more different
time-periods
Right-clicking on the plot surface brings up a context menu for quickly accessing Trend
features.

71 of 878

Model Browser - Selecting Tags


The Model Browser is a common component of VantagePoint. It facilitates navigating the data
repositories via a tree structure, helping you drill down to the source of your data. You can drag tags
and saved traces onto the plot surface from the Model Tree or the Item List.
To select a tag to Trend, navigate to it and then

click the item and press enter,


double click the item or
grab the item and drag it onto the plot surface.

In this picture you can see that All Analog Tags folder is chosen in the Model Browser Tree. The
Item List pane displays all tags available for the selection. If a saved Trend definition file was selected
in the browser Tree, you could drag it onto the plot surface.
You can drag items from the Item List Pane onto the plot surface. Use conventional Microsoft shortcut
keys to select multiple items.

Ctrl-click to select non-adjacent tags.


Shift-Click to select adjacent tags.

Notice that the Trace List at the bottom of the plot surface displays all tags and details for tags
currently displayed on the plot surface.
NOTE: When using drag and drop, be sure to point your mouse over the text of the name
of the tag to ensure that the mouse actually grabs the tag. Grabbing anywhere except on
the tag name will not initiate a drag action.

72 of 878

Time Bar
Trend displays the value of a tag over a period of time and/or in real time. The X axis of Trend always
represents time. The time period plotted is changed using the Time-Period Selector. There are two
time modes: Absolute and Relative. In Absolute mode, the user selects specific dates and times for
the start and end of the time period. In Relative mode, the user selects a typical time period from a
drop down box, such as the Last 5 minutes, or Last 1 hour. When a trace saved in Relative mode is
opened and redrawn, it will retrieve data relative to the present time.
Only traces in Absolute mode can be viewed as Live data; its data is constantly updated in real time.
The Time-Period Selector at the top of the plot surface is where this parameter is set.

When you have chosen a custom date, note that the arrow between the dates converts to an
exclamation point. This is a refresh button that must be pressed to refresh the plot once you
completed the datetime changes.

The third drop down box provides quick picks for more typical time periods that you may want to
trace, such as Last minute, Last 5, 10 or 20 minutes, etc., up to and including typical periods of up to
the last 6 months. This is Relative Mode.

You can switch into Live Mode by toggling the Live Mode button on the toolbar, or by choosing
View->Live Mode via the menu

73 of 878

Trace List
The Trace List pane below the plot surface displays details of the current traces, and other data
applicable to the selected tags. Many aspects of the plot surface are controlled by the Trace List
pane, such as which traces are visible (you can "hide" traces) and which is the currently active -or
controlling- trace and thus will control the axes.
Each row represents a trace, and multiple traces are possible. If you click in the Trace List region, you
can use the keyboard arrow keys to toggle through the trace list.
The following chart describes the data provided for each trace. The columns on display can be
customized, sorted, or hidden all together by right-clicking in the Trace List pane.

The following table describes the data provided for each trace. You can customize, sort, or hide
columns by right-clicking the Trace List pane.
Type

Image representing the tag type.

Tag

Fully qualified name for the trace tag.

No.

Trace position from top to bottom when Y-axes are stacked.

Visible

To hide a selected trace on the trend chart without removing it from the list of traces, clear this
check box.

Description

Description for the trace tag.

Style

Color, width and style of the trace line. Click a style line to change its appearance.

Axis Min (A)

Minimum Y-axis value for the tag (in engineering units). The '(A)' indicates Auto Scale Mode,
a default feature of Trend and XY Plotter that causes the vertical axis of a trace to fill 90% of
the plot surface. This feature can be disabled using the Auto Scale toolbar button. .

Axis Max (A)

Maximum Y-axis value for the tag (in engineering units). The '(A)' indicates Auto Scale Mode,
a default feature of Trend and XY Plotter that causes the vertical axis of a trace to fill 90% of
the plot surface. This feature can be disabled using the Auto Scale toolbar button. .

Unit

Unit of measure of the tag value. Examples: seconds, psi, lbs.

Precision

Number of decimal points to the right of the period.

Format

How the values will be displayed. For example, decimal.

Source

Fully qualified IO address of the tag as provided by the connector.

74 of 878

Tag Min

Minimum value of the raw acquired value of the tag.

Tag Max

Maximum value of the raw acquired value of the tag.

Retrieval

Obsolete.

Date Created Date the trace tag was created.


X Cursor[1]

Left X cursor

X Cursor[2]

Right X cursor

X Delta

X cursor difference

Y Cursor[1]

Top Y cursor

Y Cursor[2]

Bottom Y cursor

Y Delta

Y cursor difference

Right clicking in the Trace List pane and then selecting Column lets you customize the columns
displayed:

75 of 878

Basic Trending
Refresh /
Live Mode

Autoscale /
Stack
Tags

X / Y Cursors

Zoom In /
Out

Rubberband
Zoom
Pan Left /
Right

Delta of X
Values

Values at Y
Cursors
Delta of Y
Values

76 of 878

Values at
X Cursors

Lab 1 - Creating and Publishing Trends


In this lab we will create a trend report charting the state of four temperature zones in the Bread Line
1s Proof Oven. Along the way we get familiar with some of the powerful features of the
VantagePoints Trend.
1. Verify that you are on the Server Image (Server tab is selected).

2. Open the VantagePoint Trend application using one of the following methods:
a. OPTION 1: From the Start menu select All Programs > Rockwell Software > FactoryTalk
VantagePoint > Trend
NOTE: On a client machine, this option is only available if the VantagePoint Clients has
been installed
b. OPTION 2: From the Start menu select All Programs > Rockwell Software > FactoryTalk
VantagePoint > Portal and navigate to Tools > Trend
NOTE: On a client machine, this option is only available if the VantagePoint Clients has
been installed

c.

OPTION 3: Open VantagePoint Portal in Internet Explorer


(http://server/VantagePointPortal /), and similar to Option 2 above, navigate to Tools > Trend

NOTE: This is the method you would use on a client which does not have any
VantagePoint software installed. You can then use the Install Client option under Tools
menu should it be needed.
NOTE: While we access most of the VantagePoint EMI tools from the Start Menu, they can
also be accessed by browsing to the VantagePoint Portal and using the Tools menu. This
allows VantagePoint EMI to be used from web clients without requiring any additional
software installation. The Start Menu web links can be added to FactoryTalk VantagePoint
clients if required.

77 of 878

3. Create a trend of the four temperature zones of the Proof Oven in Bread Line 1 by following the
steps below:
a. Expand the System > Sources > FactoryTalk > localhost > Applications > RA Foods >
BL1 > Online > Program:Proof_Oven folder
NOTE: It may take several seconds for the Item Names to populate
b. Select SimpleTempZone1 through SimpleTempZone4 tags (click on first tag, hold shift key,
and click on last tag) and drag them to the Plot Surface. Note: You must be sure to click on
the tag namessimply clicking and dragging on other areas of the rows may not work.
NOTE: You can drag them one at a time or double-click on them as well

78 of 878

4. You should have a trend report similar to the below diagram below

5. Close the Trend report created few steps ago by selecting File > Close. Select NO when
prompted to save the trend.
6. Click on New Icon to create a new trend display

7. Create the trend of the four temperature zones of the Proof Oven in Bread Line 1 again but this
time with the shortcuts by following the steps below:
a. Expand the MyEnterprise>MyPlant>Tags>Program:Proof_Oven folder
b. Select SimpleTempZone1 through SimpleTempZone4 as you did before and drag them to
the Trend window.

79 of 878

8. As expected the same trend report is created.

9. The trend by default is showing the last 5 minutes, view the last 30 minutes by selecting it from
the relative time period drop down selection

10. The graph is quite busy, so from the tool bar select the Stack Y axis icon to stack the points. Also
note that by default the default the Automatic Scale (toolbar icon left is active).

80 of 878

11. You can now see the relationship between the different data being plotted

NOTE: While we selected the tags from the Live Data connector, VantagePoint
automatically correlated the selected tags with the Historian tag to get the logged values
and trend them. In the absence of this correlation, we would only see the real time data, or
we have to specifically select historian tags.
NOTE: With automatically scaling selected, the minimum and maximum values from all
tags can be used for the Y axis.

81 of 878

12. Change the time period back to last 5 minutes to make the upcoming feature discussions easier
to see.

13. Read the trend values along X-Axis by turning on the X axis Cursor icon on the toolbar

14. Grab the cursors by clicking and holding and then move them along the x-axis to see the values
at any given time on any of the trend pens as well as the time delta between the two X-axis
cursor.

82 of 878

15. Right-click on trend and select Trace Data

16. The data represented by the trend is shown. You can view this date in Narrow, Wide, and Sparse
Wide format.

NarrowData for each individual tag displays in separate groups, in the order in which it was
retrieved.
WideData for all tags displays in one group, sorted by timestamp. Interpolation is used to
fill data gaps, and bad quality values are displayed as '<null>'
Sparse WideData for all tags displays in one group, sorted by timestamp. No interpolation
is done to fill gaps, and bad quality values are displayed as '<null>'.

Additionally you can select the Time Period for which you want to display trace data. This
information can be printed or saved to a CSV file.

83 of 878

17. Add a title to this trend by following the steps below:


a. Right mouse click on the plot area and select Properties > Chart. You can alternatively
from the Tools menu select Properties > Chart

b. Change the chart title to Bread Line 1 Proof Oven Temperatures as shown below
c.

Click OK

84 of 878

18. Activate the Live Mode by clicking on Live Mode Icon on tool bar. You will see the trend track the
live information and show the latest 5 minutes of the information (since you had the Last 5
Minutes selected).

19. Publish your trend report by following the steps below:


a. Select File > Publish from the trend menu bar

b. Navigate to MyEnterprise>MyPlant > Reports folder


c.

Change the Name to BL1 Proof Oven Temp Trend

d. Click Publish

85 of 878

20. Notice that the report now shows up in the Item list below Reports

21. Close the Trend application by selecting File > Exit.


22. View your trend report in VantagePoint Portal by following the steps below:
a. From the Start menu select All Programs > Rockwell Software > FactoryTalk
VantagePoint > Portal
b. Select Reports > Enterprise from the main menu bar

c.

Expand the MyEnterprise > MyPlant > Reports folder and select BL1 Proof Oven Temp
Trend (the trend which was published in previous steps)

NOTE: You now see the MyPlant folder because there is a viewable item in it now (the
trend you just published). Furthermore, only the branches which have viewable content
are shown (mainly the Reports folder).

86 of 878

You should see the trend report which you just created and published in the portal. Youll
note that the time selections above the trend are not available (greyed out) because the
trend was published in Live Mode.
Youll note that right from the web client you can have similar capabilities that you did in the
full Trend tool (i.e. Using X-Axis cursor, changing styles, turning pens on and off, etc.)
Clicking on Trend in the Upper right corner of the trend display will bring in the full blown
interactive trend client tool. This tool is available to any user with proper security credential. It
provides powerful interactive trend capability.
Experiment with the various features to get more familiar with the Trend tool, both the web as
well as the full client version

The trend will show up in the portal in whatever state and shape that was published from the trend
tool. For example we had activated the Live Mode, so the publish version is in live mode. We also
had the X-Axis cursor on the trend so it shows up in the Publish trend as well.
In this lab for example if the end user needed to control the trend time span, the trend should have
been published without the live mode being active.

This lab is complete

87 of 878

Lab 2 - Creating an AbsoluteTime Periods


As part of this lab, you will be analyzing data for various spans of time using Time Periods. A Time
Period is a VantagePoint object that contains a Start and End date and time. You can use absolute
time periods in Trends, Excel reports, dashboards, and Portal reports.
1. Verify that you are on the Server Image (Server tab is selected).

2. Create a 10 minute absolute time period in MyPlant > TimePeriods folder called Pr001 by
following the steps below:
a. If not already open, open VantagePoint Manager
b. Navigate to in the folder MyEnterprise.MyPlant.TimePeriods
c.

Right-click on TimePeriods folder

3. Select the Core.TimePeriod (you may need to cursor down to it), and then select
Core.TimePeriod.Absolute, and then click Create.

88 of 878

4. Enter PR-001 in the Name field. Enter Production Run 001 in the Description field. . Enter a
start date and time sometimes in the past and an end date and time keeping the start and end
times 10 minutes apart. (Choose a start time for a period that you know you have data i.e. 20
minutes ago.

5. Repeat the above step to create another Time Period PR002 of your own choosing to represent
another Production Run time period. Keep the time period and start and end times for the time
spans that you have data which is essentially between when training started and now. Your
TimePeriods folder should now contain two time periods as shown below:

This lab is complete

89 of 878

Lab 3 Trending With Multiple Time Periods


A Time Period defines an event that has a start and end date and time. Trend can respond to multiple
Time Periods simultaneously. These Time Periods can be used to analyze the process when a
certain batch is running or when a specific operator is on shift. They can be used to compare one
batch with another or to compare shifts.
1. Verify that you are on the Server Image (Server tab is selected).

2. Create a new trend for the Bread Line 1 Proof Oven Zone 1s temperature by following the steps
below:
a. If not already open, Open VantagePoint Trend by going
Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Trend
b. In Trend, close any open traces (select Window > Close All), and open a new one (select
File > New).

c.

Expand the MyEnterprise > MyPlant > Tags> BL1 > Program:Proof_Oven folder

d. Select SimpleTempZone1 and drag it to the trace area.

90 of 878

3. Observe the trend you just created which is similar to the ones you made in the earlier lab this
time with only one pen. Note the time which is based on the default last 5 minutes period.

4. Drag PR001 time period onto the trace area, and note how the trend is visually impacted. You
now have a bold trace (reflecting the time period shown above the trend) and a faint trace
representing other time period(s) which in this case is the default original trace. Also note that
how the time information now reflects the information in PR001 time period.

5. Click the Next Time Period button


on Trend menu bar to toggle between the two periods of
time. Youll note the time periods reflect the selected time periods.

91 of 878

6. Drag PR002 onto the trace area, and note how now we have two faint trace and one solid/bold
trace. Also note how the trace border color changes for each time period for a better visual cue.
7. Click on Display and Edit the Current Time Periods button (
) and note how in the drop
down all the selected time periods are presented where you can select and edit them.

NOTE: You can delete a time period from a trace by first making it the active trace (bold),
and then use Time Period > Delete Time Period
8. Discard or publish this report to MyEnterprise > MyPlant > Reports folder as you wish.

This lab is complete

92 of 878

Lab 4 Misc. Trending Functions


There are many features and properties for the Trend object. We will go through a few of them in this
lab using the VantagePoint Simulator as the source of data. Please review the Trend overview at the
beginning of this lesson. As time permits, try experimenting with the features and properties, and
publish them to see their effect on the published report.

Using Shapes
Shapes are used to indicate normal operating boundaries of a process and to detect when a process
deviates from those boundaries.
1. In VantagePoint Trend application close any open traces (Windows>Close All).
2. Drag the Sine tag from the System>Sources>Simulator>WellData1 simulator onto the trace
area.
3. Right-click in the trace area and select Shape > New from Trace.

93 of 878

4. Right-click in the shape and select Shape > Refine.

5. Repeat the above step a few times until the shape closely matches the trace.
6. Right-click in the trace area and select Properties > Shape.

94 of 878

7. Check the Show Outside Points option and click OK.

8. You will note that all points outside the shaped area is now highlighted.

95 of 878

9. Drag the PR001 Time Period that you created earlier in this lesson on to the trace, or if you wish
choose a different start and end time from the period bar, and analyze the process for deviation
as indicated by the points outside the shape.

10. Discard or publish this report to MyEnterprise > MyPlant > Reports folder as you wish.
NOTE: Using the combination of shading, highlighting the outlying points along with time
periods can be a useful tool to compare and contrast production environment and identify
in and out of control parameters.

96 of 878

Discrete Shading
Shading is used to represent the state of a discrete tag. It facilitates process analysis by simplifying
the trend area.
1. In Trend, close any open traces.
2. Drag the MachineRunning and Sine from the System > Sources > Simulator > WellData1
simulator.
3. Open the trace property for Machine Running tag by following the steps below:
a. Select the MachineRunning tag in the tag list view at the bottom of the trace window.
b. Right-click in the trace area.
c.

Select Properties > Trace.

97 of 878

4. In the Discrete tags section, check the Enable shading and Use trace color checkboxes, and
click OK.

5. You will note that the trace representing Machine Running tag is now shaded.

6. Discard or publish this report to MyEnterprise > MyPlant > Reports as you wish.
NOTE: The discrete shading juxtaposed with other production data could be a very useful
tool to visually get a better grasp of the operation. For example the digital state of a
machine (running or not) or a fault state (active or not) along with OEE trace can be a
simple but useful tool.
98 of 878

Create a Golden Batch


A golden batch is defined as the perfect production run against which all other batches will be
compared. Trend gives you the ability to publish a golden batch profile and compare it with the current
running batch.
1. In Trend, close any open traces and create a new one.
2. Trend the MachineSpeed tag from WellData1 simulator over the last minute.
3. Select the Golden Batch checkbox on the time bar.

4. Select File > Publish.


5. In the Publish dialog, create a new folder called GoldenBatch under MyEnterprise.MyPlant
folder by Right-clicking on MyPlant Folder and then New > Folder and finally typing in
GoldenBatch for the folder name.

99 of 878

6. Select the GoldenBatch folder and type in First Golden Batch for the report name, and click
Publish.

7. Close the trace window (Window > Close All).


8. Select the Golden Batch folder. Select the trend from the list view and drop it onto the trace
area. You should now have a watermark of the original golden batch and a time bar sitting at the
current time. Note that Live mode is automatically enabled.

100 of 878

9. If the live trace was not started at the correct point in the batch, Ctrl-Click (hold down the Ctrl key
and the mouse select button simultaneously) on the moving time bar then drag the active trace to
where you would like it to be.
NOTE: Sometimes a particular manufacturing "run" or "batch" can be identified as
representing ideal conditions or behaviors. These runs can be marked and saved as
Golden Batches. New Trend definitions can be defined incorporating the Golden Batch
time period, so anomalies in traces can easily be detected.
10. Discard or publish this report to MyEnterprise > MyPlant > Reports as you wish.

There are many features and properties for the Trend object. Please review the Trend overview at
the beginning of this lesson. As time permits, try experimenting with the features and properties, and
publish them to see their effect on the published report.

This lab and lesson is complete

101 of 878

This page intentionally left blank

102 of 878

Lesson 4 Creating and Publishing XY Plotter

What you will learn:

Create XY Plot
Add shapes to XY Plot
Using background images on XY Plots

Prerequisite:

This trainings VMWare image

Discussion
XY Plotter
You can use XY Plotter to query data and plot it on a graphical display. XY Plotter relies on the
VantagePoint Server to present data from multiple sources in an orderly fashion, allowing you to
navigate to specific data, and then plot that data.
You can use Trend and XY Plotter to:

See the relationship between the values of two tags (tag pair) over a historical period of time,
a pre-set period of time, and in real-time. When plotted, this relationship is referred to as a
trace.
Easily identify the boundaries that define normal conditions for a trace, by employing userdefined shapes.
Determine that the value of a tag is outside of a defined boundary.
Display and compare multiple tags or traces concurrently.
Save traces as time periods, or Golden Batches, and use them to compare trends or traces
over different time periods.

Once you have added tags, you can manipulate the data in a variety of ways, including panning,
zooming, and scaling. XY Plotter graphs and their associated data can be printed so that the data can
be analyzed away from the client machine.
Before you can use this client application, the VantagePoint Server must be running and you must
have access to the server.

103 of 878

Lab 1 Create Simulators


We will utilize simulator tags to learn about the VantagePoint XY Plotter. VantagePoint has several
simulators that are installed when the product is installed. You have the ability to create new
simulators should you choose to do so. We will create two simulators, one for X axis, and one for Y
axis, and then manipulate the values to learn about various features of XY Plotter.
1. Verify that you are on the Server Image (Server tab is selected).

2. In VantagePoint Manager, navigate to System.Sources.Simulator. Right-click on Simulator


and select Create Instance.

104 of 878

VantagePoint Simulator is a simple yet powerful tool to provide a simulated data source to
facilitate application development as well as testing, and training.
When you create a simulator, the following data tags are automatically created with it:

Each tag generates data that is dependent on other tags. For example, the MachineRunning tag
generates a discrete signal that indicates when a process starts and stops. When this tag is true,
the MachineSpeed tag will slowly ramp to a configurable maximum value and maintains until the
running bit goes false. Each tag has configurable properties that control the pattern of data
generated. All tags cycle, over a period, configured when you create the simulator instance. For
further information on individual tags and related configuration parameter, please refer to online
help.
3. Configure the instance called Sim60 as shown in the image below and click Execute.

4. Similarly, create a simulator called Sim60Noisy also with a MainPeriodSec value of 60.

105 of 878

5. Navigate to System.Sources.Simulator.Sim60Noisy.Tags, and in the items pane below, rightclick on the Sine tag and select Edit.

6. For the NoiseAmount field, enter a value of 0.2 and click OK.

This lab is complete

106 of 878

Lab 2 Creating and Publishing XY Plotter Chart


1. Verify that you are on the Server Image (Server tab is selected).

2. If not already open, launch VantagePoint Portal.


3. Open the VantagePoint Portal application using one of the following methods
a. OPTION 1: From the Start menu select All Programs > Rockwell Software > FactoryTalk
VantagePoint > XY Plotter
NOTE: On a client machine, this option is only available if the VantagePoint Clients has
been installed
b. Option 2: From the Start menu select All Programs > Rockwell Software > FactoryTalk
VantagePoint > Portal and navigate to Tools > XY Plotter
NOTE: On a client machine, this option is only available if the VantagePoint Clients has
been installed

c.

Option 3: Open VantagePoint Portal in Internet Explorer (http://server/VantagePointPortal /),


and similar to Option 2 above, navigate to Tools > XY Plotter

NOTE: This is the method you would use on a client which does not have any
VantagePoint software installed. You can then use the Install Client option under Tools
menu should it be needed.
Note: While we access most of the VantagePoint EMI tools from the Start Menu, they can
also be accessed by browsing to the VantagePoint Portal and using the Tools menu. This
allows VantagePoint EMI to be used from web clients without requiring any additional
software installation. The Start Menu web links can be added to FactoryTalk VantagePoint
clients if required.

107 of 878

4. Note the two zones where the X & Y points need to be dropped at.

Basic Plotting
1. In XY Plotter, navigate to System.Sources.Simulator.Sim60.Tags, and Drag the Sine tag onto
the Y axis in the plot area (where the Drop Y Item Here indication is).

108 of 878

2. Select the Sim60Noisy. Tags and drag the Sine tag onto the X axis (where the Drop X Item
Here indication was).

3. Set the time to Last minute and select the Live Mode button on the toolbar.

4. Observe the XY Plot behavior and feel free to experiment with various controls

109 of 878

Using Shapes for Live Process Shift Analysis


XY Plotter is an excellent tool for detecting small shifts in a process. With shapes, we can detect this
shift in real-time and adjust the process before it gets out of control.
1. Keep the existing plot but disable Live Mode by clicking the Live button
2. Right-click on the plot area and select Shape > New from Trace.

3. Right-click the plot area again and select Shape > Edit.

110 of 878

4. Grab the shape edit boxes and drag them so the plot is entirely enclosed within the shape area.
You can add a box to a point on the shape by right-clicking and selecting Add point. To delete a
point, move the mouse cursor over a point and push the Delete key. When you have completed
the edit, right-click and select Exit Edit.

5. Right-click in the plot area and select Properties > Shape.

111 of 878

6. Select the checkboxes Show outside points and Transparent, and then Click OK.

7. Enable Live Mode by clicking on

8. Red diversion markers will appear and disappear as the process moves through time. The fewer
the red markers the better the current process is performing.

112 of 878

9. Setup the X and Y axis labels by following the steps below:


a. Right-click in the plot area and select Properties > X Axis.
b. For the Label, uncheck Use default text and enter the text Process Value. Select the Apply
these x-axis settings to all new Trends checkbox.

c.

Select the Y Axis tab.

d. For the Label, uncheck Use default text and enter the text Process Setpoint. Select the
Apply these y-axis settings to all new Trends checkbox, and Click OK.

113 of 878

NOTE: If the process is under control, the plot generated between PV and SP should be a
diagonal with a well-defined distribution about the 45 degree line. Fewer points outside the
shape indicate a process in control. As the process drifts out of control, more points will
appear outside the shape.
10. Simulate a process shifting out of control by following the steps below:
a. Select the Sim60Noisy.Tags folder.
b. Right-click on the Sine tag and select Edit.
c.

Change the Phase value to 100 and click OK.

11. Observe the Plot for a few seconds. This represents a process shifting out of control.

12. Change the Phase value back to 0.

114 of 878

Using Background Images


In many cases, process equipment will have a manufacturers recommended performance curve.
This curve, or any other digitized image, can be placed in the plot area as a watermark against which
the equipment or process can be compared.
1. Close the existing trace (Discard or publish to MyEnterprise>MyPlant>Reports as you wish).
2. Create a new plot (File > New) and place the Sine tag from Sim60 on the X axis.
3. Place the Sine tag from Sim60Noisy on the Y axis.
4. Select the Last minute Time Period (from the time selection drop down list above the plot)
5. Right-click on the plot area and select Properties > Chart.
6. In the Background section of the dialog, click the browse icon next to the Image field and
browse for a background image, BackgroundGraphic.jpg, found in C:\Class Files\Misc Files.,
and click OK.

115 of 878

7. The plot should look as follows:

8. We will create a shape that matches the outline of the performance curve. To do this, right-click
in the plot area and select Shape > New Default.

116 of 878

9. Your display should look similar to diagram below:

10. Move existing points and add or delete points until the shape matches the curve. Right-click and
select Exit Edit when your changes are complete.

117 of 878

11. Right-click in the trace area and select Properties > Shape.

12. Select the checkboxes for Show outside points and Transparent, and click Apply then OK.

118 of 878

. Now you can easily see process points that


13. Enable Live Mode by clicking the Live button
are outside of the specifications defined by the desired operational graph.

14. Publish this report to MyEnterprise>MyPlant>Reports and call it Process 001 Plot by following
the steps below:
a. Select File > Publish from the trend menu bar

b. Navigate to MyEnterprise>MyPlant>Reports folder


c.

Change the name to Process 001 Plot

d. Click Publish

119 of 878

15. Verify your report in the portal.

This lab and lesson is complete

120 of 878

Lesson 5 - Creating a Basic Excel Report

What you will learn:

How to use the FTVP Excel add-in to create reports


Create an Excel report using FTLD and FTH tags
Publish the Excel report
View the published report in the FTVP Portal
Create the simple excel report to show the Maximum and Minimum temperature values in the
four zones of the Line 1 Proof Oven for a user selectable time period as shown below

Prerequisite:

Completion of Lesson 2

121 of 878

Discussion
The Excel Office Add-In
The Excel Office Add-In is the tool that end users will want to use to fully exploit the power of
VantagePoint.
Through Excel, users can

Connect to a huge variety of data sources and bring that data into Excel in an organized
manner
Create powerful reports that use data from anything in the VantagePoint Model
Share reports and spreadsheets, without requiring that others use the same version of Excel,
or even have Excel on their machine
Build content for the VantagePoint Portal, including dashboard displays, scheduled,
interactive and static reports, all available to anyone in your organization with access to a
browser

How is this accomplished?


The Power User - someone who understands how his plant is wired together and knows where the
data is - can bring the data directly into Excel using the Excel Add-In. The sole requirement for
locating data is an understanding of the VantagePoint Model Logical structure that relates data that
resides in disparate locations and systems in order to provide a coherent inter-related view of a
system. The Model, which is a logical representation of the enterprise, brings together information
about the organization into an orderly configuration, marrying together data that belongs together, but
until now has been extremely difficult to relate together. An example of this union would be data
defining a pump, where the pressure and flow and speed of that pump may come from one data
source, and the parts list and manufacturing information come from a second source, while the
maintenance log resides on yet a third data source. The Model integrates this data and makes it
available to the Power User.
No knowledge of SQL is required; the user doesnt even need to understand how the data gets into
the Model. VantagePoint wizards in Excel guide the user in selecting data and any other parameters
necessary for the report. The only skill this Power user needs is the ability to drive Excel.
Reports created using the Excel Add-In can be used in a variety of ways and for several different
purposes. The reports can be saved locally to the user's hard drive, perhaps for further development
or even as an email attachment to another Excel user. The report can be saved into the VantagePoint
Model and thus made available to other VantagePoint users as a normal Excel spreadsheet. The
report can be published to the VantagePoint Portal, and finally, the report can be used as the basis
for a live dashboard display inside the Portal.
Being able to save a VantagePoint spreadsheet report and email it to another user will become
especially useful when organizations begin to standardize on VantagePoint. When a Model is
developed and mature, it is possible to create reports that deal with higher level items of abstraction
in the Model than tags, such as pumps or production lines or people or production statements. With
this higher level of abstraction comes portability: the same comprehensive Pump Report that details
the pump speed, flow and pressure, combined with detailed information on that pump's start-ups,
specific maintenance history, and manufacturing information, can now be used to report on other
pumps. And when sister plants share portions of their Model design, intricate reports developed with
122 of 878

Excel can also be shared.


Once the report is created, it can be published to the VantagePoint Portal, where it will be available to
anyone in the organization with access to a browser. Reports published to the Portal fall into two
categories: Static and Dynamic.

Static reports provide information at a point in time and do not change. Certain conditions of
the plant at a Start Up point may be the basis for a static report.
Dynamic reports come in two forms.
The first is a report that runs with "fresh" data when the user evokes the report. The user
requests the report and the latest version of the report is delivered. This may be the Last
15 Minutes of Plant Operation report. This report has no external user-changeable
parameters. It is produced on demand, however, with the most recent data available.
The second type of dynamic report contains elements, or parameters, which end users
can adjust in order to run the report for slightly differing purposes. The Pump Report, for
example, may be run against Pump X on Line 1, and then again for a different pump on
the same or another line, depending on the definition of the report. This is really a type of
report template, with defined user-configurable variables.

Reports can also be developed as the basis for live executive dashboard displays published into the
Portal. Gauges, sliders, and key production indicators can be developed which draw their data from
sources using Add-In wizards for developing the underlying spreadsheet. As the data in VantagePoint
changes, spreadsheet values change, which in turn update the dashboard displays on the Portal.
Why is all of this important?
Disseminating data in the form of organized reports to the people who need them is the goal of all
reporting engines. The VantagePoint Office Add-In for Excel makes getting at the data relatively easy
for the Excel power user, and the reports this user creates can easily be published in a format that
anyone in the organization with access to a browser can view and interact with. The casual users who
consume these reports do not need to have Excel on their machines. They do not need any software
other than an internet browser. Excel becomes a premier content creation tool for power users who
do not need to be developers to create dynamic, dimensional, recyclable reports.

Overview
Microsoft Excel is a broad-reaching and capable product, and the VantagePoint Office Add-In for
Excel leverages its capabilities to allow users to produce powerful reports and impressive dashboards
based on VantagePoint-sourced data.
The VantagePoint Function Wizard provides a wizard-based interface and leads users through the
sometimes complex process of connecting to data sources, selecting specific items of interest, and
building a function to return that data into a spreadsheet.
VantagePoint functions behave a lot like native Excel functions. They are based on Excel control
arrays and obey the same rules. They can be built or changed directly in the formula bar or using
Excel's own function editor. As data is refreshed, formatting of VantagePoint functions remains
persistent. Excel's F-9 button for refreshing data will refresh data coming from VantagePoint-sourced
data. And you can use all of Excel's charts, internal functions and formatting features to operate on
VantagePoint data.
VantagePoint makes extensive use of Excel's named ranges for parameters, allowing for easy access

123 of 878

to data in specific cells, and making the creation of VantagePoint reports friendlier. Furthermore, any
VantagePoint function can make parameters external to the function - a technique used extensively
with published reports.
Building dashboards for display in the VantagePoint Portal is also powered by VantagePoint wizards this time by a powerful Add-In built into the capable Xcelsius 2008 product. Xcelsius 2008 provides an
embedded spreadsheet which is a fully functional Excel workbook. VantagePoint provides wizards
launched from this spreadsheet for building queries that provide data to the dashboard objects. These
wizards operate in a very similar fashion to the Function Wizards, and in most cases use nearly
identical steps for compiling specific data. It, too, employs named ranges and enables users to create
external parameters for dashboard objects. This means that dashboards can be re-configured from
within the Portal, using the same graphical elements, but displaying different data - all without the
need for programming knowledge, and without the need for Excel on the end-users machine.
VantagePoint leverages the extensive collection of graphical objects and the ease of use of Xcelsius
to create visually stunning displays that quickly relate information in a clear and captivating style. It is
the power behind the VantagePoint Wizards, however, that enables live data feeds to dashboard
objects and the capability to re-bind objects to new data sources on the fly from within the Portal, as
described above.
Important notes about Published Excel Reports

Typically reports only perform read access. However, in cases where reports modify sensitive
data the report's permissions need to be set up so that only the appropriate people have
access to the report. See Setting Security on Model Items.
The VantagePoint Portal cannot render reports written with one version of Office if the Server
is not also running the same or later version of Office
Excel reports are rendered in the time zone of the VantagePoint Server.
Excel reports viewed in the Portal do not support Pivot Tables, Excel Named Ranges, VBA
and Controls.

124 of 878

Menu Items
Opening the Add-In menu
The VantagePoint Excel Add-in adds the tab menu as depicted below to Excel which provides a set
of functionality described below.

Open [Report Definition] - Opens a published report.


Publish - Publishes the current book to the Model via the Publish Wizard.
Insert [Function] - The easiest way to add functions to the current workbook. You can also use the
toolbar button, manually enter a function into the formula bar, or use Excel's generic built-in function
wizard.
Edit - Opens the VantagePoint Manger editor for the selected item to be edited.
Refresh [Workbooks] - Update Values is applied to every VantagePoint function contained in all open
workbooks.
Refresh [Sheet] - Update Values is applied to every VantagePoint function contained on the active
sheet.
Refresh [Function] - Removes the function from the cells, inserts it into a single cell to determine the
size of the results, then re-inserts it into the correct size range. Applies to VantagePointTagDetails
and VantagePointLive. Note: data is obtained only once during this process.
Convert to Values [Function] - Select a cell that is part of a VantagePoint function. After selecting
this menu item the function will be replaced with values and can no longer be updated.
Convert to Values [Sheet] - Converts the entire sheet to values. All functions are converted (Excel +
VantagePoint)

125 of 878

VantagePoint Excel Add-In Insert function


The VantagePoint Excel Add-in Insert function provides the following capabilities:

Current Value - Enables the selection of current values of any tag items in the system.
History - Enables the selection of raw data, sophisticated re-sampling of the data according to
engineering and analysis requirements, and post-processing of the data using a Query Filter to build
SQL statements.
Value at Time - Enables the selection of values of any tag items in the system at a certain point in
time.
SQL Query Function - Allows the creation and execution of a SQL query against any connector in
the system that supports it. For example, InSQL and MS SQL Server support SQL queries.
Get Item Properties - Returns the Properties of selected items.
Set Item Properties - Allows changing the writeable property values of selected items.
Link to a Report - Creates a hyperlink to an existing VantagePoint report.
We will discuss the use advanced Type Mapping feature later in this training where we use it
extensively for type mapped reports.

126 of 878

Using Names in Excel


Microsoft Excel Names
Excel provides a feature that makes it very easy to refer to cells, ranges of cells, formulas and
constants when building a worksheet. Usually, one uses cell labels in formulas to reference the
contents of a cell: C20, or cells: C20:C30. By defining a Name in Excel, you can refer to a group of
cells using a recognizable term, such as FirstQuarterSales, which can make it easier to understand
the purpose of a formula. For example, the formula =SUM(FirstQuarterSales) might be easier to
identify than =SUM(C20:C30).
Names are available to any sheet in a workbook. For example, if the name ProjectedSales refers to
the range A20:A30 on the first worksheet in a workbook, you can use the name ProjectedSales on
any other sheet in the same workbook to refer to range A20:A30 on the first worksheet. Likewise,
names can linked to another workbook. The formula =SUM(Sales.xls!ProjectedSales), for example,
refers to the named range ProjectedSales in the workbook named Sales.
You can define/view a name in Excel using Formulas Name Manager.
VantagePoint Named Ranges
VantagePoint uses the Excel name feature extensively, and has adopted the term Named Range to
mean a specific, named group of cells. Named ranges form the foundation of VantagePoint's Type
Mapping capabilities. By marrying named ranges with VantagePoint Types, it is possible to build
powerful reports that essentially become templates. Using these template, end users can generate
reports by simply changing the report parameters, that is, the named range(s) associated with the
report, new, identical, reports can be created that report on totally different items.

Excel Worksheets (Tabs) Created

Parameters (should be hidden before Publishing)


IncuityInfo (default is hidden can unhide to view contents)

127 of 878

Lab 1 Get the needed data onto the Excel Report


In this lab, we will get the historical data needed for our report. By the end of this lab, the report will
look as follows which will be used in the next lab to create the report needed for this lesson.

1. Verify that you are on the Server Image (Server tab is selected).

2. Open Excel by going Start > All Programs > Microsoft Office > Microsoft Office Excel 2010.
3. Right click on the Sheet1 tab, select Rename, and change the name to ReportData.

4. Repeat the above steps and rename Sheet2 to ReportChart.

128 of 878

5. Start the process to insert VantagePoint History function into cell C3 by following the steps
below:
a. Select ReportData sheet
b. Select cell C3
c.

Select the VantagePoint tab (this add-in is installed as part of VantagePoint Installation)

d. Select Insert Function (note that as soon as you click on Insert, parameter sheet is created)

NOTE: There is no significance to the selection of this particular cell. It is however a


best practice to leave some room around this initial function insertion location in case
header or other items need to be added to the report.
e. Select the History option, and click Next

129 of 878

6. Since we have asked for historical information, VantagePoint will ask us history of what tags.
Select the four Zone temperatures (BL1 Proof Oven SimpleTempZone1-4) required for this report
by following the steps below:
a. Navigate to MyPlant > Tags > BL1 > Program:Proof_Oven
b. From the Item Name table select SimpleTempZone1 SimpleTempZone4 tags
c.

Click the > icon to move the tags to the right window

d. Click Next

130 of 878

7. Now that we know what tags, VantagePoint needs to know the time period for the historical
information which needs to be retrieved. Since this report requires a user selectable time period,
we will NOT use the default time period selection, and set the report up so the user can select
time periods from the model by following the steps below:
a. Select the Use this Range option
b. Ensure that the range uses the Modelbrowser
c.

Click New

131 of 878

d. Expand the MyEnterprise > Samples v4 > Support > Report Library folders and select the
Time Periods folder
e. From the Item Names table select Last 15 minutes
f.

Click the > icon to move the selected item to the right window

g. Click Next

132 of 878

8. Next we are presented with a series of options. Since the function request is a historical ones,
here we get an opportunity to setup time and value deadbands as well as other parameters. The
full list of these options and their descriptions are on the next page For now, we will setup the
options as follows:
a. Select the Wide option
b. Select Skip advanced options
c.

Leave all other options alone (as shown)

d. Click Next

Data Options
Time Deadband - A time span value (e.g., 1 sec). If omitted, no time deadband is applied.
Use the time deadband to define absolute spacing of rows in time; that is, when you dont want
rows more closely spaced in time than the time you define: e.g. even if a value changes 50 times
in one second, you still want only one row every second.
Value Deadband - Any data values that change less than the specified deadband will not be
returned. The value is a percentage of full scale, in engineering units. If omitted, no deadband will
be applied.
Use the value deadband to limit the number of rows returned by only considering a value to have
changed if it has changed by at least "this much". The engineering unit of the tag determines how
the value deadband is evaluated. For example, if the engineering unit is in cubic feet/second, 5
would represent 5 cubic feet/second. If the engineering unit is in percentage, it would be 5
percent, etc.

133 of 878

Data overload protection - Sets the number of rows to return. If the check box is cleared, all
rows are returned. Some data sets can be so large that they cause a time-out. This setting can
alleviate that problem.
Quality - Select whether to include all quality properties stored with a tag on most historians or
certain types of quality properties in this set of check boxes.
Version - Select whether you want the Latest data values or the Original values stored with the
item. Some historians allow User Specified versions such as "Third Revision". If the connector
provides this option, it will be available.
Data Formats - Select the format to use for data. A wide format displays a column for DateTime
and a column for each tag in the function.
Skip advanced options - Enables or disables the option to apply aggregation sampling (advance
options).
9. Finally, you get a chance to manage the look and feel of the returned data. Here you can use the
default format, or setup your own format. You can also configure what information gets displayed
and whether the function or the result of the function (value) is used. The full list of these
functions and their descriptions are on the next page. For now, we will setup the options as
follows:
a. Take all the defaults as shown below
b. Click Finish

134 of 878

Function Options
Default Formatting Range - The default range is the same as the cells that contain the data.
Choose Formatting Range - Choose Formatting Range text box and select a range. You can select
a location on any open worksheet, even the result sheet. Select columns and rows as needed to
achieve the desired formatting effect.
Apply Default Formatting - Use standard formatting for results.
Show shortened item names - Checking this option places only shortened names in your
worksheet, such as BatchNumber, instead of the fully qualified name, such as
MyEnterprise.Documentation Examples.Intermediate.Extruders.Extruder001.BatchNumber. Select
from the following options:

Show common part as comments in HeadingInserts a comment into the column heading to
allow referencing the fully qualified name.
Show common part as comments in Item NamesInserts a comment into the cell containing
the item name to allow referencing the fully qualified name.
Show comments all the timeMakes comments visible at all times.

Convert to values when function is inserted - Selecting this option replaces the function with
values when the function is inserted and it will no longer be updated.
Transpose function output - Selecting this option performs a simple row/column transposition on
the result set. It is not a wide/narrow conversion in the history-data sense. This option is useful for
property functions and SQL results more than for history queries.
Resolve Reference items to their values - Specifies that the wizard should return the actual value
of the item referenced when selected. If cleared, the Fully Qualified Name of the item is returned.
Columns to display / Properties to display - The items listed here depend on the function you are
building. Select or clear items as needed.
10. Your report should look as follows:

Columns D, E, F & G contain the Zone 1 Zone 4 values


The number of rows will vary with the time period and the machine activity
In later lessons, we will learn formatting techniques to see information in a desired format

135 of 878

11. Save your work in the root directory of C:\ drive as Basic Report.xlsx by following the steps
below:
a. In Excel select File > Save As
b. Select C: Drive
c.

In the File name textbox enter Basic Report (Excel Workbook (*.xlsx) type)

d. Click Save

NOTE: It is not necessary to save an Excel report, if it is going to be published, as it will


be saved in the VantagePoint DB, once it is published. It is done here for the sake of this
lab.
12. Although the report is not finished yet, lets publish it to get an idea of the look and feel of the
report up to this point by following the steps below:
a. From the ribbon bar select the VantagePoint tab, if not already selected.
b. Select Publish

136 of 878

c.

Select A report with no parameters. This will mean that the users will not be given an
option such as changing the Time Period, but the report will update with most recent last 15
minutes (the time period we selected during the creation of the report). We will explore
reports with parameters in later labs. Click Next.

d. Navigate to MyEnterprise > MyPlant and open Reports folder


e. In the Name textbox enter Basic Report (should already be there since you save it under
that name), and Click Next

137 of 878

f.

Check the Browse to published report check box

g. Click Finish
NOTE: It may take several seconds for the FTVP Portal to open

13. The Portal should open with your Basic Report displayed.
a. If asked for credentials, use Administrator for username, and rockwell for password, and
select the Remember my credentials.
b. Scroll up and down to see all the data
c.

Click Refresh to get new list of last 15 minutes of data

d. Try one of many auto refresh rates from the Refresh drop down list (note that due to image
speed you may not be able to get very fast refresh rates)
Note that all sheets on this excel workbook is published, since we did not hide them. In fact you
can click on these other worksheets and see their content. This is a convenient feature, if so
desired, to publish many reports via one excel workbook.

14. Close the Portal and return to your Excel spreadsheet.

This lab is complete


138 of 878

Lab 2 Create the Temperature Min & Max Report


1. In the Basic Report excel spread sheet, go to ReportChart sheet and create a table similar to the
one shown below at the same row and column locations. (Note: These locations have no
particular significance; we just want to use the same locations, so they can be easily referenced
for the rest of this lab).

2. Assuming that you used the same row and column locations as shown in the previous steps, as
well as the same row and column in the ReportData sheet where data was retrieved for the
published report, please enter the formula to find the min and max value for each zone:

PLEASE NOTE THAT YOU CAN USE Excel function entry and point and drag to enter all these
functions quickly. Simply make the entries for C7, and C8, and then drag the cells across to F
Column. If you are not familiar with this process, please ask the instructor.

C7 (Max Zone1) = MAX(ReportData!D:D)


D7 (Max Zone2) = MAX(ReportData!E:E)
E7 (Max Zone2) = MAX(ReportData!F:F)
F7 (Max Zone2) = MAX(ReportData!G:G)

C8 (Min Zone1)
D8 (Min Zone2)
E8 (Min Zone2)
F8 (Min Zone2)

= MIN(ReportData!D:D)
= MIN(ReportData!E:E)
= MIN(ReportData!F:F)
= MIN(ReportData!G:G)

139 of 878

3. When done, your table would look like something similar to diagram below (your numbers would
be different of course). If you wish, format the numerical area to show up to only two decimals.
We will discuss better ways of formatting data in later labs.
4. You just created the Min and Max Report which was the intent of this lesson. We will add the final
touches in the next few steps.

5. Create a Cylinder chart based on the tabular data just created by following the steps below:
a. In the ReportChart sheet select a cell below the table just created (i.e. cell B11)
b. On the tool bar select the Insert tab
c.

Open the Column combo box

d. Select Cylinder

140 of 878

e. Select the chart and move it as indicated below (upper left corner around B10)
f.

In the chart area Right-click and the Click Select Data

g. Select the range of cells for the chart of B6 to F8


h. Your chart should populate with Zone1 Zone4 data. Click OK.

141 of 878

i.

Your ReportChart sheet should look as follows:

6. Congratulations . You just created the required report. We just need to publish it. As you recall
however, when we published our interim work, all sheets were showing. For our final report, we
just want the Chart data to be on the report, so we are going to hide the sheets which we do not
wish to show on the published report, and then publish our report by following the steps below:
a. Hide all sheets except ReportChart (Right-Click on ReportData, Parameters, and any
default sheets i.e. sheet3 one by one, and select hide)

b. Select Publish under VantagePoint tab to publish the newly created chart

142 of 878

c.

Verify that the A report with parameters option is selected, as we now want the user be
able to select times from our list of time periods

d. Click Next

e. Note that two parameters show up. One is the Core.Tag which is the type for the Zone
temperatures, and the other is TimePeriods which is the type for the time that we selected
when we were creating the report. Since the report requirement is for the user to be able to
select time periods, we will make that an external parameter so Check the TimePeriods
check box
f.

Click Next

143 of 878

g. Expand the MyEnterprise > MyPlant folders and select the Reports folder
h. In the Name textbox enter BL1 Min and Max Zone Temp
i.

Click Next

j.

Check the Browse to published report check box (Show parameters will also be checked)

k.

Click Finish

NOTE: It may take several seconds for the FTVP Portal to open

144 of 878

7. Your published report should look as follow


NOTE: Because we checked the TimePeriods as external parameters, we can select
different time periods for the report
a. Select a new TimePeriod (the last 5 minutes)
b. Click Generate Report
NOTE: The hidden sheets are no longer showing.

8. Try Absolute Period selection in the TimePeriod drop down, and pick a time period of interest
and click Generate Report to see the report for selected time period.

145 of 878

Types play a critical role in VantagePoint. In the above example, only the parameters of type
TimePeriod appeared in the drop down list, because that is the type which was selected for the time
period. Had we for example made the temperatures (in this case Core.Tag) external as well, we
would have another drop down list but its content would be every single tag in the VantagePoint
Database of type Core.Tag.
What if we wanted to have this report to be for multiple lines, so one of the parameters would be
bread line selection? While we can make all temperatures external, so desired zones can be
selected; the operation would be extremely cumbersome, since every tag of core.tag type would be
presented to the operator.
A better approach would be to create a type for Proof Oven (i.e. Oven type) and then use that type in
the report. The Parameter drop down then would only show variables of the type Oven.
We will have much more discussions and lessons on this very core subject later in this training.
9. Close Excel and the VantagePoint Portal.

This lab and lesson is complete

146 of 878

Lesson 6 - Using an Incuity Tag for Data Entry

What you will learn:

How to create and use Incuity Tags for Data Entry and Storage
Log manual data such as Operator Log
Use text file to log multiple entries at once

Prerequisite:

This trainings VMWare image

Discussion
Incuity Tags
The concept of a connector in VantagePoint has typically been associated with an underlying datasource. A connector, in the general sense, establishes a connection to an underlying data-source
with the purpose of retrieving data from that source. In many cases, it does this via items called Tags
(Analog, Discrete, String, etc.) whose attributes (including the tags Value) are determined by the
underlying data-source.
An Incuity Tag connector differs from other connectors in that it allows users to define tags without
specifying an underlying data source. This makes it possible for users to configure tags, for example,
where the value of the tag can be set by the user. A common usage for Incuity Tags would be to
handle manual data entry. Someone might have gauges in the field that aren't wired up to any
electronic data acquisition, but they still record pressure, temperature, and flow. Operators walk the
plant once an hour and record the non-instrumented readings using a Rounds sheet, and later enter
the readings manually into a log. By creating Incuity tags, this data can be entered directly into
VantagePoint. Once the tag is in the VantagePoint model, any application that wants to write to the
value of the tag can do so, any script can write to it, and it can be Trended and used in Excel reports.
When created, all Incuity Tags are immediately added to the Default Storage Handler. Note that when
VantagePoint Tags are created they are not created with initial values. New values for Incuity Tags
can be entered into VantagePoint via the Tag Manual Data Entry page in the Portal, using the Store
Manual Data option directly in Storage, via script, or by using a client tool such Excel.

147 of 878

Typical Application of Incuity Tags


There are still a number of data points within your facility that require manual data entry or the
integration of data existing within text files, such as:

Systems, meters and instruments not connected to your control system


Operator logs and comments
Remote monitoring systems
Test samples

In this scenario, there is a requirement for operators to log comments on equipment performance
hourly as well as to import data collected from an offline sampling system. You need to provide users
with an easy method to enter the data and utilize it in reports. These requirements can be met with
Incuity Tags.
Incuity Tags are VantagePoint-specific tags that can be used to store logs, comments, etc. These
tags can be consumed like any other tag in VantagePoint clients like Trend and the Excel Add-In with
which reports can be created.
Adding Incuity Tag Values to Storage
Only authorized users can add Incuity tag values to storage. Values for Incuity tags can be entered
into VantagePoint storage using the following methods

Single Entry via VantagePoint Manager


The operator can enter data into a single tag one at a time

Bulk Entry via VantagePoint Manager


The user can enter multiple data points for multiple tags into the associated dialog box, or
simply copy the contents of a CSV file into the provided space to upload data into storage
from a .csv style file.

Manual Single Entry via the Portal


Similar to Single Entry via VantagePoint Manager, but from the Portal Interface

148 of 878

Lab 1 Create Incuity Tags


1. Verify that you are on the Server Image (Server tab is selected).

2. Navigate to Incuity Tags sources by following the steps below:


a. Open VantagePoint Manager
b. Navigate to System > Sources > Incuity and select Tags.
c.

Create a new Incuity tag by right-clicking the Tags folder and select New > Item.

d. Select Connector.Tags.FloatTag and click Create.

149 of 878

e. Configure the instance as shown in the image below, using Name and Description of Offline
Data Sample. Min of 0 and Max of 200. Click Create.

f.

Repeat the above steps but this time choose a Connector.Tags.StringTag type and create
another Incuity tag called Operator Log, with Max length of zero (0)

NOTE: Source field is not used as this is a user defined tag (Essentially, user/operator is
the source)
3. Confirm the creation of the above two tags by verifying them under Incuity Tags Item list

150 of 878

4. Double-click on Offline Data Sample Incuity tag, and note that you can change the value through
a dialog box. Type in 14.52 in the Value field, and click OK

5. Click on Properties tab, and note that the value we just entered is now the default value for the
Offline Data Sample tag.

This lab is complete

151 of 878

Lab 2 Enable Storage Services


In order for VantagePoint to store data, the Storage service (System > Services > Storage) needs to
be turned on. You can view whether the service is running by viewing its Status property

If it is not On, right-click on the Storage item and select Start Storage.

This lab is complete

152 of 878

Lab 3 Operator Log Data Entry


VantagePoint allows us to write data back to an Incuity tag. This functionality can be quite powerful
for application where an operator may need to write a value to a Tag where there is no
instrumentation or process to capture data. The following steps are an example of how Manual Data
Entry can be used as an input from a process.
1. Launch VantagePoint Portal.
2. Under the Tools menu, select Tag Manual Data Entry.

3. In the drop down for Select Tag FQN, select System.Sources.Incuity.Tags.Operator Log.

153 of 878

4. Configure the input fields as shown below using the exact same time stamp (5/1/2008 8:07 AM),
and click Save. Note the data Uploaded. (1) Confirmation message in the lower left corner of
the dialog box.

NOTE: The reasons for the specific date requested in this step is so you can see this
information along with some other data which you will bulk upload later in this lesson.

This lab is complete

154 of 878

Lab 4 Offline Data Entry


Data can also be imported into the VantagePoint system through the use of a comma-separated
(CSV) file.
1. Double-click on C:\Class Files\Misc Files\Data.txt to open the Data.txt file.
2. Note that it is a Comma Separated Value (CSV) file containing multiple entries for an Incuity tag
called offline Data Sample which is the name of the string tag you created earlier. The format of
the file is as follows:
<Tag Name >, <Time Stamp>, <Tag Value>, <Tag Quality>
This is the required format for the bulk upload of data which we will perform shortly.
3. Copy all the entries into clipboard by selecting all the text (Ctrl-A) and then selecting copy (Ctrl-C)
or use the menu.

The time stamp in this example file is an arbitrary one, which is setup to be around the same time
as the manual entry we did through the portal. When we look at this information later in this
lesson, we should see all our entries whether bulk, or single item in the same time span, because
of the close proximity of the time stamps.
NOTE: Tag quality has the value of 192 which is the OPC code for Good quality (hex 0xC0)

155 of 878

4. Invoke Store Manual Data by following the steps below:


a. Launch VantagePoint Manager
b. Navigate to System.Services.Storage.
c.

Right-click on the Storage node and select Store Manual Data.

Note that this tool provides a way to store (load) data into a tag.
NOTE: Aside from the data entry method discussed in this class, data can also be entered
into Incuity tags by placing them on custom user interface using tools like the dashboard
builder. Doing so will allow the user to customize their data entry interface.
5. Bulk download the data by following the steps below:
a. Select the Bulk tab (note that the Single Tag tab provides yet another way to enter single tag
information)
b. Right-click in the tag data area and select Paste (to paste the information we copied from the
data.txt file earlier).

156 of 878

c.

The bulk data is now ready to be stored, click on Store and note the Data stored confirmation
in the lower corner of the window, and then Close.

This lab is complete

157 of 878

Lab 5 Utilize the Incuity Tag Data


In this section, we will use VantagePoint Trend to visualize the data in the Incuity tags created in this
lesson.
1. Launch VantagePoint Trend.
2. In the model browser, navigate to System.Sources.Incuity.Tags and select the two tags we
created above: Offline Data Sample and Operator Log. Drag them onto the trace area.
3. Change the time period to 5/1/2008 8:00 AM to 5/1/2008 8:20 AM. Click the refresh icon
between the start and end date times.
NOTE: Refresh icon will appear here after editing date/time fields

4. Your Trend should look similar to the diagram below

158 of 878

5. Note the small triangle. This is the string entry. To see it better, stack the charts along y-axes by
clicking on Stack Y-Axes icon.

6. Your trend should now look similar to the diagram below

7. Hover the mouse pointer over the plot and see the values at different times. Below you see the
manual string entry we made for Operator Log tag a few steps ago. You are also seeing the bulk
data entered for Offline Data Sample tag

8. Discard or publish this report to MyEnterprise > MyPlant > Reports folder as you wish.

This lesson is complete


159 of 878

This page left intentionally blank

160 of 878

Lesson 7 - Using a Calculate Tag to Evaluate


Expressions

What you will learn:

How to configure a calculation tag


How to use expressions

Prerequisite:

This trainings VMWare image

In this lab we will create two examples of a calculation tag, one discrete evaluation, and another using
functionality build in math expression to be used as a lookup value to an integer source.

Discussion
Calculated Tags
Calculated tags are tags whose value is the result of evaluating an expression. The expression can
include references to other tags, as well as constants and functions in shared libraries. Since
Calculated Tag types implement the Core.Tag type, they can be used anywhere the underlying
Core.Tag type can be used, including any client that can make Live, PointInTime, and/or History
requests, such as Trend/XY Plotter and Excel. In all respects, they can be used as normal tags, since
they are, in effect, normal tags.
Calculated Tags support the following tag types:

Floating Point (double precision)


Integer (32-bit)
Discrete (Boolean)
String

Calculated Tags also support the use of literals in expressions. These literals include:

Single characters in quotes.


String literals.
TRUE or FALSE in Boolean expressions.
Floating point numbers.
Integer or Whole numbers without a decimal point, as either Arabic numerals or hexadecimal
notation.
Avoiding Potential Problems with Calculated Tags

161 of 878

Avoiding Potential Problems with Calculated Tags


Calculated tags provide powerful techniques for analyzing data, but deeply nested calculated tags
can create performance problems and potentially lock up a system.
For example, when a time series request - a history request -is made that contains calculation tags,
the calculation connector must check to see what tags are used in the expressions of all the
calculation tags in the request. It gets the list of all dependent tags, and makes another request for
those tags. It then uses the results of that sub-query to perform the calculations for the calculation
tags.
A potential problem occurs when calculation tags contain other calculation tags in the expression.
Each calculated tag used in the expression of another calculated tag will generate another subrequest. All sub-requests must complete before the top request made will finish. If the nesting is very
deep, requests might time out.
For instance, if tag1s expression has tag2 in it, and tag2 has tag3 in it, and tag3 has tag4 in it
(assume tags 1, 2, 3, & 4 are all calculation tags), then each tag would generate a separate time
series request. If the expressions also reference tags from other sources, this could cause the
penultimate request to take a long time, potentially timing out.
Another potential problem is circular references:
If tag1 references tag2, and tag2 references tag3, and tag3 references tag1, any request for any of
those tags will never complete, as it will loop forever.
Performance Considerations

No performance hit if the expression contains a single tag reference


If >1 tag references in the expression
And an aggregation is performed on the calc tag
The sources tags will have a raw request for every value for the time period
Takes longer than if they were aggregated at the source
For example, given the expression

A request for an hourly average aggregation

Value(tag1) * Value(tag2)
Returns the hourly average of the product of tag1 and tag2

That is, the calc engine

Gets the raw data for tag1 and tag2 for the time period

Performs the calculation (e.g., gets the product)

Then averages the result for each hour in the time period

162 of 878

Typical Application Examples


1. How well is my Line performing?

Calc Tag Name


Performance KPI
Expression
(Current Rate / Target Rate) * 100
Resolved Expression Example
(49/50)*100
Result Example
98%

2. Was this item created in 2010?

Calc Tag Name


CreatedIn2010
Expression
FindFirst(value("MyEnterprise.Public.Calc Tags.OfItems.CreatedOn") , "2010")
Resolved Expression
FindFirst(2/6/2010 4:10:15 PM , 2010)
Result
4

3. How can I concatenate string values?

Calc Tag Name


NameAndDescription
Expression
value("MyEnterprise.Samples.Extruders.Extruder001.Name") + ": " +
value("MyEnterprise.Samples.Extruders.Extruder001.Description")
Resolved Expression
Extruder001 + : + Sample Machine Used To Demonstrate Vantage Point Features
Result
Extruder001: Sample Machine Used To Demonstrate Vantage Point Features

4. How to give an imported tag a different name in the model?

Calc Tag Name


NewTagProperty
Expression
Tag A FQN
Resolved Expression
Tag A FQN
Result
Value of Tag A

NOTE: If the expression contains only one tag and aggregated data is requested from the
Calc Tag, the aggregation request will be passed to the data source, i.e., no performance
hit

163 of 878

5. How to use a constant for a target value?

Calc Tag Name


TargetProduction
Expression
1500
Resolved Expression
1500
Result
1500
Note
Can track target changes, if Calc Tag is archived

6. Has a process point exceed a threshold?

Calc Tag Name


HiAlarm
Expression
If (value("MyEnterprise.Samples.Extruders.Extruder001.Reservoir Level") > 95, True,
False)
Resolved Expression
If (17.8371520723822 > 95, True, False)
Result
False

7. How to automatically determine appropriate energy rate to use based on time of day?

Calc Tag Name


TimeOfDayEnergyRate
Expression
If( (HoursPastMidnight("2/6/2010 8 AM") > 7) and (HoursPastMidnight("2/6/2010 8 AM")
< 20), TagA , TagB)
Resolved Expression

Result
Value of TagA if between 8 AM and 8 PM (peak hours) else Value of TagB

164 of 878

Lab 1 Creating a Discrete Calculate Tag


In this lab we will create two states based on the state of an Extruder pump. When it is on, we like to
have a state called Pump is Running, and when off, a state called Pump is Stopped.
1. Verify that you are on the Server Image (Server tab is selected).

2. Launch VantagePoint Manager.


3. Navigate to the MyEnterprise > MyPlant > Tags folder, and create a new folder called
Calculated.
4. Right-click the Calculated folder and select New > Item.

5. Create a discrete calculate tag by following the steps below:


a. In the Types tab at the bottom of the dialog, select the Core.Tag shortcut.
b. Expand Core.Tag and then Connector.Incuity.Calculation.Tag. and select
Connector.Incuity.Calculation.DiscreteTag
c.

Click Create.

165 of 878

6. Click on Properties tag and configure it as shown: DO NOT CLICK ON CREATE YET

7.

Click on General tab and enter PumpIsRunning for the tag name and the optional description as
shown below: DO NOT CLICK ON CREATE YET

8. Enter the following expression into the Tag Expression area either manually or using the
expression editor by following the steps below the expression:
If( Value("MyEnterprise.Samples v4.Intermediate.Extruders.Extruder001.Start
Command")

, TRUE, FALSE)

a. Click on Edit Expression

166 of 878

b. Click the If button.


c.

Highlight the text condition in the expression. Then click Item Value.

d. In the model browser dialog, navigate to:


MyEnterprise.Samples V4.Intermediate.Extruders.Extruder001
e. Select the Start Command item then click OK.

167 of 878

f.

The Expression Editor should resemble the following image. Click Test Expression to
evaluate the expression

g. After verifying, click on Close.

h. After testing the Expression, click OK on the Expression Editor to get back to the New
Discrete Calculated Tag dialog box.

168 of 878

9. Click Create to create the PumpIsRunning calculate tag.

NOTE: The above Discrete Calculated tag configuration simply states that if the
Extruder001 Start Command is on, set the PumpIsRunning tag to Pump is running, and
if not, set it to Pump is stopped.
10. Verify the operation of the calculated tag by visualizing its state following the steps below:
a. Launch VantagePoint Trend.
b. Navigate to MyEnterprise > MyPlant > Tags > Calculated
c.

Select the PumpIsRunning tag and drag it onto the trace area. You can also double click the
tag to place it on the trace area.

d. You should see a trend similar to diagram below.

11. If you like, drag the Extruderr001s Start Command on this same trace area, and stack the trace
along Y-axis to verify that our newly calculated tag tracks the state of the Start Command.
12. Discard or publish this report to My Enterprise > MyPlant> Reports as you wish

This lab is complete


169 of 878

Lab 2 Create an Enumerated String (lookup) Tag


In this lab we will create a calculate tag which returns the downtime reason based on a downtime
code according to the following table:
Code

Reason

Off

Running

Fault

Motor Failure

Light Curtain Broken

E-Stop

Starved

Break

No Raw Material

Maintenance

10

No Operator

1. Verify that you are on the Server Image (Server tab is selected).

2. Launch VantagePoint Manager.


3. Navigate to the MyEnterprise > MyPlant > Tags folder, and right-click the Calculated folder and
select New > Item

170 of 878

4. Create a string calculate tag by following the steps below:


a. In the Types tab at the bottom of the dialog, select the Core.Tag shortcut.
b. Expand Core.Tag and then Connector.Incuity.Calculation.Tag. and select
Connector.Incuity.Calculation.StringTag
c.

Click Create.

5. On the General tab enter MyDownTimeReason for the tag name as shown below: DO NOT
CLICK ON CREATE YET.

171 of 878

6. Enter the following expression into the Tag Expression area either manually or using the
expression editor by following the steps below the expression:
MapValue(Value("System.Sources.Simulator.Line 1.Tags.Downtime") , "unknown",
"0", "Off", "1", "Running", "2", "Fault", "3", "Motor Failure", "4", "Light
Curtain Broken", "5", "E-Stop", "6", "Starved", "7", "Break", "8", "No Raw
Material", "9", "Maintenance", "10", "No Operator")

a. Click on Edit Expression

b. Click on Function

172 of 878

c.

Select ListHeplers form the Library drop down list

d. Select MapValue from the function list


e. Click OK

7. Select the Downtime tag in Line1 simulator as the evaluation tag to be enumerated by following
the steps below:
a. In the expression box, highlight Value, and then click on Item Value button.

173 of 878

b. Browse to System > Sources > Simulator > Line 1 > Tags and select Downtime
c.

Click OK

8. Select the text unknown to be the Default Value by highlighting Default Value and typing
unknown. Your expression should look as follows:

174 of 878

9. Define the enumeration list by replacing the Values portion of the function with a valuation string
following the steps below:
a. Highlight Values

b. Type the following


0", "Off", "1", "Running", "2", "Fault", "3", "Motor Failure", "4", "Light
Curtain Broken", "5", "E-Stop", "6", "Starved", "7", "Break", "8", "No Raw
Material", "9", "Maintenance", "10", "No Operator"

c.

Your expression editor should now look as follows. Click OK, and then Create in the parent
window to create the new tag

175 of 878

10. As we did in the previous lab, lets verify the operation of this new calculated tag by visualizing its
various values by following the steps below:
a. Launch VantagePoint Trend, or open a new trend trace
b. Navigate to MyEnterprise > MyPlant > Tags > Calculated
c.

Select the MyDownTimeReason tag and drag it onto the trace area.

d. Navigate to System > Sources > Simulator > Line 1 > Tags
e. Select the Downtime tag and drag it onto the trace area
f.

If the trace is too busy, select the Last Minute for your time period

g. You should see a trend similar to diagram below.

h. As shown in the diagram, the down time reason of Faut is correctly depicted for for the
downtime code of 2.
i.

Hover your pointer over othe text tags to see the down time reason and the correponding
down time code.

j.

Put the trend in live mode and observe the same behaviour.

11. Discard or publish this report to My Enterprise > MyPlant> Reports > DownTime Reason
Trend as you wish.

This lab is complete

176 of 878

Lesson 8 Retrieving Data from External Database

What you will learn:

How to use the VantagePoint built-in connector to MS SQL Server


Configure a connection to MSSQL Server
Connect to a Database that will allow data to be retrieved for Tag Providers, Mapped Types
and Queries
Create a Tag Provider Templates
Create Tags using the Tag Provider Templates
Use the DB Builder Add-In

Prerequisites:

Completion of Lesson 2

VantagePoint Database Connectors enables it to connect to different types of databases. One


Database connector is required to connect to EACH database. Please note that this is to each
database and not an instance of a database. So if an instance of SQLServer has four databases, and
you need to connect to all of them individually, you would need four licenses. Please refer to
installation and licensing requirement documentations for more details. In this lesson, we use SQL
Server as the target database to learn about the database connectivity capabilities of the
VantagePoint. The methodology learned here can be applied to other ODBC compliant databases.

177 of 878

Discussion
Add a Microsoft SQL Server Connector
VantagePoint provides a native connector for accessing data in a Microsoft SQL Server. Creating the
connector requires the name of the machine on which the SQL Server resides, a Security setting
option, and a Database name.
Once the connector exists, there are three possible ways to access the data within the database:
1.

It is possible to directly query data in the SQL Server using the Excel SQL Query wizard or by
creating VantagePoint Query Items.

2. You can extend the VantagePoint model of your data, by creating database mappings. Database
Mappings make it possible to build a useful model - a data structuring and abstraction tool - by
leveraging data you already have in sources such as your SQL Server.
3. You may have data in a SQL Server that, properly structured, could be useful to display in a
Trend or XY Plotter. In this case, a tag provider would be employed. Tag Providers are essentially
techniques for extracting data from a database and structuring it in a time-series fashion so that it
can be rendered in a Trend.
A database connector can simultaneously employ queries, database mappings and tag providers. In
the following labs we will explore these methods of accessing and data retrievals.
The SQL Server Connector parameters are as follows:

Connector name: A common, recognizable name for the data source. This name will appear
in the Model Browser.
MS SQL Server: The machine name on which the SQL Server database resides. If multiple
SQL Server instances exist on the machine, add the instance as well. Example: machine
name\named instance.
Connection parameters: Not usually required for MS SQL Server connections.
Security setting options
Server authentication: Sets a user name and password for all users who connect to this
data source
Integrated: Uses the incoming user's domain, user name and password
Advanced: Select an existing database Security Mapping Strategy or create a new
strategy.
Database: Database name on the above SQL Server that this connector will connect to. A
drop-down box will be populated with database names that exist on the SQL Server.

178 of 878

Creating Tag Provider


Overview
When using database data for displaying in Trends, Plots, and certain Excel functions, the data must
be structured in such a way that these applications can understand it: it needs to be in "time-series"
format. Time-series data is data that is ordered, or sequenced by a Data/Time stamp. VantagePoint
uses Tag Providers to define the way to extract both "Live" (real time) and Historical data from
database sources.
Tag Providers are used to define a way to extract and expose Live and Historical data from a
database. A Tag Provider is defined by supplying two main pieces of information:
1. A set of SQL queries used to extract database information, and
2. A list of data points, or Tags, that applications (Trend, XY-Plotter) use to display retrieved data.

The set of SQL queries in a Tag Provider is collectively known as a tag provider Template. The
template contains SQL queries that will extract the following data:

History data Used to retrieve historical information bound by a start and end date. The
History Command query is most commonly used by the Trend and XY-Plotter applications to
obtain data to display.
Point In Time Used to retrieve database information associated with a specific date and
time. The Point In Time Command query is most commonly used by the VantagePoint Excel
Add-In.
Live data Used to retrieve the most current database information. The Live Command
query is most commonly used by the VantagePoint Excel Add-In.
Maximum Row Count Optional. Used to set the maximum number of rows to return when
executing the other three queries (History, Point In Time, and Live Command).
Current Server UTC Time - Optional. Used to determine how data requested using a
Relative Time Period will synchronize machine time settings. The Current Server UTC Time
Command query has no substitution tokens.

This command applies when data is requested using a Relative Time Period.
When a client machine requests data for the Last 5 Minutes, for example, the request is sent to the
VantagePoint Server which in turn will fetch the data via the Tag Provider. The VantagePoint Server
must first convert the request into an Absolute Time request, so it can send a serviceable request
through the Tag Provider to the data source.
The question the VantagePoint Server must first consider is what is the current time? If the Current
Server UTC Time command query in the Tag Provider is empty, VantagePoint will use the UTC time
of the VantagePoint Server. This is sufficient in 99% of cases.
If a UTC Time command exists in the Tag Provider, VantagePoint will fetch the Current UTC Time
using the command query provided. When the data source is a SQL Server database or other source
that can provide a UTC time, the Current Server UTC Time command query provides the method for
querying the source for the time. For data sources that cannot provide a UTC time, such as ODBC
sources, the Current Server UTC Time command can be left blank, and VantagePoint will use the
UTC time of the VantagePoint Server.

179 of 878

The default behavior for Tag Providers is to execute the SQL queries for a set of tags concurrently.
That is, one query is passed to the data source to serve up the requested data. This is the most
efficient approach, and in most cases it is the best approach. In rare instances, however, this
approach is especially onerous on the person trying to create the SQL query. There is a way to
cause the Tag Provider to fire off separate queries for each Tag in the Tag Provider list. To do this,
insert the comment
--<SingleTagQuery>
anywhere in the SQL query. This will cause the Tag Provider to fire off separate queries to the data
source for each tag in the Tag Provider template. This is an expensive SQL operation, but useful in
some cases. Insert the comment as shown below:

When the -- <SingleTagQuery> is used

The line will be removed from the query at execution time; so it will not be passed through to
the destination database server
Then the query will be executed once for each tag - with each tag's externalkey being passed
into {0} when its query is executed.

Writing Template Queries


Template queries are used to retrieve time-based database information to be exposed via tag
provider tags. These template queries must be defined in a generic way so that, at runtime, they
could be used to retrieve data for an arbitrary number of tags and for an arbitrary period of time. In
order to achieve this, these queries must be parameterized and include well known substitution
tokens. The number of substitution tokens and their significance varies according to the query type.
Additionally, the data returned from these queries (if any) must provide all relevant Tag information in
the following order:

tag external key,


tag value,
value creation time
value quality.

The order in which these tag fields are returned in a record set matters because the VantagePoint
runtime maps them to an internal value structure based on their location in the resulting data set.

180 of 878

History Command Substitution Tokens


The History Command query must have three substitution tokens:
{0}- Replaced with a list of tag external keys for which to retrieve historical data.
{1} - Replaced with a start date and time for data retrieval.
{2} - Replaced with an end date and time for data retrieval.
A History Command sample query for SQL Server:
SELECT TagName, TagValue, DateTime, Quality FROM HistoricalData
WHERE TagName IN ({0}) AND DateTime >= '{1}' AND DateTime <= '{2}'
ORDER BY DateTime
Point In Time Command Substitution Tokens
The Point In Time Command query must have two substitution tokens:
{0}- Replaced with a list of tag external keys for which to retrieve timed data.
{1} - Replaced with a date and time for data retrieval.
A Point In Time Command sample query for SQL Server:
SELECT TOP 1 TagName, TagValue, DateTime, Quality FROM TimedData
WHERE TagName IN ({0}) AND DateTime <= '{1}'
ORDER BY DateTime DESC
Live Command Substitution Tokens
The Live Command query must have one substitution token:
{0}- Replaced with a list of tag external keys for which to retrieve live data.
A Live Command sample query for SQL Server:
SELECT TOP 1 TagName, TagValue, DateTime, Quality FROM LiveData
WHERE TagName in ({0})
ORDER BY DateTime DESC
Maximum Row Count Substitution Tokens
The Maximum Row Count statement must have one substitution token:
{0} - Replaced with a maximum number of data rows to retrieve.
A Maximum Row Count sample statement for SQL Server:
SET ROWCOUNT {0}

181 of 878

Current Server UTC Time


The Current Server UTC Time Command query has no substitution tokens.
This command applies when data is requested using a Relative Time Period.
When a client machine requests data for the Last 5 Minutes, for example, the request is sent to the
VantagePoint Server which in turn will fetch the data via the Tag Provider. The VantagePoint Server
must first convert the request into an Absolute Time request, so it can send a serviceable request
through the Tag Provider to the data source.
The question the VantagePoint Server must first consider is what is the current time? If the Current
Server UTC Time command query in the Tag Provider is empty, VantagePoint will use the UTC time
of the VantagePoint Server. This is sufficient in 99% of cases.
If a UTC Time command exists in the Tag Provider, VantagePoint will fetch the Current UTC Time
using the command query provided.
When the data source is a SQL Server, or other source that can provide a UTC time, the Current
Server UTC Time command query provides the method for querying the source for the time. For data
sources that cannot provide a UTC time, such as ODBC sources, the Current Server UTC Time
command can be left blank, and VantagePoint will use the UTC time of the VantagePoint Server.
Tag Provider Parameters
The Tag Provider has 3 parameters

Parameter {0} equals a list of the tag names whose value you want to return from column3.
In the example below parameter {0} would contain name of the tag stored in the Machine
column like Machine_1. If you use the IN operator in your query then parameter {0} can
contain a comma delimited list of tag names like Machine_1, Machine_2, Machine_3.
Parameter {1} contains the start time for the record set and must be passed as a string value
Parameter {2} contains the end time for the record set and must be passed as a string value

NOTE: Both the start and end times are run against column3 in the query

182 of 878

Historical Data Template Examples


There are many ways to write the History query required by the tag provider template. In its simplest
form it must contain the following:
SELECT Column1, Column2, Column3, Column4
FROM (Table or View)
WHERE Column1 IN (Parameter 0) -- list of tag names passed to the template
AND Column3 >= (Parameter 1) Start time passed to the template
AND Column3 <= (Parameter 2) End time passed to the template
ORDER BY ASC
Query example using the Production_Data_Wide table

SELECT Machine, Value_1, TimeValue, Quality = 192


FROM dbo.Production_Data_Wide
WHERE Machine IN ({0}) list of tags like Machine_1, Machine_2 that are passed to the query
AND TimeValue >= '{1}'
AND TimeValue <= '{2}'
ORDER BY TimeValue ASC
Test data returned from the VP Manager

183 of 878

Test Results

Creating Tags

Name - The Name (first column) can be any string value but in most cases it is the same as
the External Key
Type - The Data Type of the value returned in the second column of the Tag Provider query
External Key - The External Key must match the value returned in the first column of the Tag
Provider query.
Description - The Description is optional

Creating a Tag Provider Template


VantagePoint is very flexible and can adapt to a wide differences in the way the data is stored.
As an example, the table below has the EquipmentTypeName in one column and the TagName in a
different column. It also has the float values in one column and the string values in a different
column. In addition the Date/Time is in one column and the Milliseconds are in another column.

To view the data from M1Oven, TempZone2 as opposed to M2Oven, TempZone2 we will have to
use both the EquipmentTypeName column and the TagName column or a new column name that
combines the two column names in the WHERE clause of any TagProvider query. We will have to
do the same if we want to use both the Date/Time and the Milliseconds as our TimeValue.

184 of 878

The following examples provide two ways this can be accomplished


1. Create a View
Create a view that combines the EquipmentTypeName column values and the TagName
column values into a new column. Use the DATEADD function to add the TranstimeMS to the
TransTime as a new column that contains the new Time/Date. When you create your tag
provider templates use that view in the FROM clause of the TagProvider query and the new
column names in the SELECT and WHERE clauses of any TagProvider query.
2. Create a temporary table
Create a #Temp table that combines the EquipmentTypeName column and the TagName
column in to a new column and use the DATEADD function to add the TranstimeMS to the
TransTime as a new column and then use the #Temp table in the FROM clause of the
TagProvider query and the new column names in the SELECT and WHERE clauses of any
TagProvider query. The TagProvider query MUST include a DROP TABLE statement

Using DbBuilder to create Tag Providers


The tag provider can be created via a manual process sometimes referred to by hand. However,
manually creating tag providers in any numbers can be a considerable burden. A VantagePoint addin called DbBuilder significantly reduces this burden. The purpose of the DbBuilder is to generate any
quantity of tag providers automatically by running a series of provider template files (Tag Definitions)
against a series of database locations. A new Tag Provider is then generated for each Tag Definition
/ DBLocation pair. Each Tag Provider in turn yields one or more Tags whose qualities are based on
the SQL queries contained in the Tag Definition.
Tag Definition files can be exported as XML and reimported to facilitate reuse.

See Appendix B for coding examples

185 of 878

Lab 1 Creating a MSSQL Server Connection


In this lab we create an MsSql connection to ProductionData base. As you may recall this is the
same database which we started populating by starting the Transaction Manger at the beginning of
this training
1. Verify that you are on the Server Image (Server tab is selected).

2. Create a MsSql connector to ProductionData database by following the steps below:


a. Launch VantagePoint Manager.
b. Navigate to System > Sources > Db > MsSql
c.

Right-click on MsSql and select Add MsSql Connector

d. In the Connector name textbox enter ProductionData


e. In the MS SQL Server textbox enter Server
f.

From the Database combo box select ProductionData

g. Click Test Connection

186 of 878

h. Verify that the connection was successful


i.

Click OK

Note that we are now going to have two MsSql connection. One is the one we just created (will
show up on the list after clicking Finish, and returning to this dialog box), and the other is the one
created through the installation process establishing connection to the IncuitySample database
used by the sample projects.
j.

Click Finish

3. Note the new connection you just created.

This lab is complete

187 of 878

Lab 2 - Using Queries in Reports


In this lab we will learn how to directly query data in the SQL Server using the Excel SQL Query
wizard or by creating VantagePoint Query Items. We will create a sample query in the SQL Server
environment using the SQL Server Management Studio, and once happy with the result, copy and
paste it into the VantagePoint environment.
1. Verify that you are on the Server Image (Server tab is selected).

2. Create a simple query to return all rows from the in_Production table form Incuity_Sample
database by following the steps below:
a. Launch SQL Server Management Studio by going:
Start > All Programs > Microsoft SQL Server 2008 R2 > SQL Server Management
Studio
b. Make sure that the selection boxes look as follow, and click Connect

c.

Click New Query

d. Select ProductionData database in drop-down list box


e. Enter the Query as shown below
Select Top 100 * From dbo.EquipmentData

188 of 878

3. Click Execute and verify results appear as shown below:

4. Create a VantagePoint Query by following the steps below:


a.

Copy Query text to clipboard (Select All, Right-click, Copy):

b. Launch VantagePoint Manager


c.

Navigate to System > Sources > Db > MsSql > ProductionData > Queries

d. Right-click on Queries and select New > Item

189 of 878

e. Name the Query EquipmentData


f.

Paste in the Query script from the clipboard into the Query field:, and click Test

g. Verify result is table data. It should be similar to what you saw in the Sql Server environment,
and click Close

h. Click OK on New Query dialog

190 of 878

i.

You should now have a new query called EquipmentData as shown below.

j.

Select Query item of the EquipmentData and click on Parameters tab to see that the
QueryString parameter actually shows the query that we entered a few steps ago

This lab is complete

191 of 878

Lab 3 Creating an Excel Report Using DB queries


1. Verify that you are on the Server Image (Server tab is selected).

2. Open Excel by going:


Start > All Programs > Microsoft Office > Microsoft Office Excel 2010
3. Initiate the process of inserting the EquipmentData query which we just created into an Excel
report by following the steps below:
a. Select cell C3
b. Select the VantagePoint tab
c.

Select Insert Function

NOTE: There is no significance to the selection of this particular cell. It is however a best
practice to leave some room around this initial function insertion location in case header
or other items need to be added to the report.

192 of 878

d. Select Database Query


e. Verify Use query stored in the model... is selected
f.

Click Next

4. Navigate to System > Sources > Db > MsSql > ProductionData > Queries where we created
the query in the last lab, select the EquipmentData query, and use > button to select it. Then,
click Next.

193 of 878

5. Note that you get an opportunity to see the query, and even edit it, if you wish.

6. Click on Test Query to check it one final time before inserting it into the Excel report. You should
see similar looking results as you saw when you created the query. After reviewing the results,
click Close.

7. Click Next on Insert Query window to insert the query results into the Excel report.

194 of 878

8. Here you get an opportunity to format, convert the function to value or transpose the results. We
will leave everything as default, and click Finish.

9. Click Finish and you should get the Query results in the Excel spreadsheet.

10. Publish your report under the name EquipmentData with no Parameters to MyEnterprise >
MyPlant > Report by following the steps below:
a. From the ribbon bar select the VantagePoint tab, if not already selected.
b. Select Publish

195 of 878

c.

Select A report with no parameters. This will mean that the users will not be given an
option such as changing the Time Period, but the report will update with most recent last 15
minutes (the time period we selected during the creation of the report). We will explore
reports with parameters in later labs. Click Next.

d. Navigate to MyEnterprise > MyPlant and open Reports folder


e. In the Name textbox enter Equipment Data, and Click Next

196 of 878

f.

Check the Browse to published report check box

g. Click Finish
NOTE: It may take several seconds for the FTVP Portal to open

11. The Portal should open with your EquipmentData displayed.


a. If asked for credentials, use Administrator for username, and rockwell for password, and
select the Remember my credentials.
b. Scroll up and down to see all the data
c.

Note that you can setup a desired auto refresh rates from the Refresh drop down list

d. Every time that a refresh request is made, VantagePoint executes the query and retrieves the
data from the target database.

This lab is complete

197 of 878

Lab 4 Creating Tag Providers


In the previous lab, we created a excel report based on the information in the EquipmentData
database. What if you wanted to trend some of this information like the zone temperatures? As you
may recall, the trend function requires a tag in VantagePoint to be trended, so we need to have a tag
representing the data in the database to be used by the trend. This tag needs to have a series of time
stamps, and values. The Tag provider provides exactly what is needed for this task, and much more
as it was explained in the introduction to this lesson.
In this lab we will utilize DbBuilder to configure Tag Providers which in turn creates tags representing
the data entries in the EquipmentData table in the ProductionData database.
The EquipmentData table looks as follows. In the process of creating the tag provider we will be
primarily concerned with the following columns:

EquipmentTypeName
TagName
TagValueString
TagValueFloat
TransTime
TransTimeMs

Since this particular table has two types of data values, float and string, we will need to create two
data collections for this tag provider. We will call these BL_FloatTags, and BL_StringTags.

198 of 878

1. Verify that you are on the Server Image (Server tab is selected).

2. Create a new DbBuilder source called ProductionData by following the steps below:
a. Launch VantagePoint Manager
b. Navigate to Sources > DbBuilder
c.

Right-click on DbBuilder and select Create New Source

3. In the Name textbox enter BL_Tags. In the Description textbox enter Bread Line Tag Builder
Tags. Click Execute

4. Configure the database location for the DbBuilder by following the steps below:
a. Expand the DbBuilder and BL_Tags folders
b. Right-click on DbLocations and select New > Item

199 of 878

5. In the Name textbox enter DbProductionData


a. From the Time Zone combo box select Eastern Time (US and Canada)
b. Click the Database browse icon

6. Expand the Db > MsSql folder and select ProductionData. Click OK.

200 of 878

7. Verify that the Production Database was selected, then click the browse RootPath browse
button.

Root Path: A DbLocation is specified with a RootPath property. Any tags created by the
connector's tag definitions will be copied to a subfolder under this root path. The specific
subfolder to be used is specified in the tag definition which is created with a Path property. The
tags that each tag definition creates are, therefore, copied to their own Path (subfolder) beneath
the RootPath value of the DbLocation item. Also: each node in the Path you specify must be a
Core.Folder item.
8. Navigate to MyEnterprise > MyPlant and select Tags folder. Click OK.

201 of 878

9. Verify that your setting are as indicated below. Click Finish.

10. Start the tag definition creation by following the steps below:
a. Expand the DbBuilder folder and select BL_Tags
b. Right-click and select Edit

202 of 878

11. Click Edit Tag Definitions.

12. As you can see there are no definitions. In the remaining part of this lab, we will configure two tag
definition collections. One for the string type tags which we will call BL_StringTags, and one for
the non-string tags which we will call BL_FloatTags
a. Click Add

203 of 878

13. Configure the non-string tag definition collection called BL_FloatTags by following the steps
below
a. In the Definition Name textbox enter BL_FloatTags
b. Click OK

c.

In the Delimiter Character text box enter a comma (

, ) character.

d. In the Quote Character textbox enter a single quote (

) character.

e. In the Date Format Mask enter: yyyy-MM-ddTHH:mm:ss.fff


f.

In the Path textbox enter: BL_FloatTags

14. We will now need to enter the SQL scripts which was discussed in the introduction of this lesson
for the following queries

UTC Time query (optional): Used to resolve relative time period data requests with respect
to the server and the local machine.
Live query: Tells each tag how to fetch the most recent data.
History query: Tells each tag how to fetch a sorted series of data bounded by a start and
end date time.
Point-In-Time query: Tells each tag how to fetch data for a particular date time.
Max Row-Count query (optional): Defines maximum number of rows returned.
Tag Population query: Defines all of the Tags that will be created by this provider

204 of 878

15. Enter the History Query by following the steps below:


a. For the sake of time, we will copy and paste the scripts instead of typing them into the fields
b. Double-click to open C:\Class Files\TagProviderFiles\FloatHistoryCommand.txt

While there are many ways to write the History query required by the tag provider template. It
essentially tries to get the values for a list of tags for a given time period, which what the above
query does. The minor twist in this particular script is to actually create the display tag list (first
Select statement). That is because, as can be seen in the diagram below, the target table
(EquipmentData) has the identifying tag name in two columns (EquipmentTypeName and
TagName). They needs to be combined to make a tag name which would make sense to the
target user i.e.
M2Oven+ _ + TempZone2 = M2Oven_TempZone2

205 of 878

16. Copy all the text in the file (using <Ctrl><A> + <Ctrl><C> key strokes or Edit > Select All then
Edit > Copy file menu approach).

17. Paste the script into History Query field of the Tag Definition Editor by putting your cursor inside
the field and <Ctrl><V>Place your cursor in the History Query textbox and paste in the Float
HistoryCommand text (Ctrl-V).

206 of 878

18. Follow the same procedure as the previous step and copy the content of the C:\Class
Files\TagProviderFiles\FloatLiveDataCommand.txt file into the Live Query field.

The script structure is similar to the Historian one, which we discussed in detail. The main
differences are somewhat obvious. As this is the live data query, there is no End time; and Start
Time has a different meaning. Where the Start Time was passed in to the Historian query, here
the Start Time is retrieved by executing the GetDate function which would give us the current time
(maybe CurrentTime would have been better choice for the variable name here, but for the sake
of consistency between all the queries StartTime was used). The rest of the script is very similar
to the Historian except the fact that there is no Union and no data retrieval between two give time
stamps.

207 of 878

19. Follow the same procedure as the previous step and copy the content of the C:\Class
Files\TagProviderFiles\FloatPointInTimeCommand.txt file into the Point in time Query field.

The script structure is similar to the Historian one, which we discussed in detail. The main
differences are somewhat obvious. As this is the Point in Time query, there is no End time; and
Start Time has a different meaning. Where the Start Time was the beginning of the time period
where the historical data needed to be retrieved, here the StartTime indicates the time where the
data for the particular point needs to be retrieved, (maybe TargetTime would have been better
choice for the variable name here, but for the sake of consistency between all the queries
StartTime was used), The rest of the script is very similar to the Historian except the fact that
there is no Union and no data retrieval between two give time stamps.

208 of 878

20. Follow the same procedure as the previous step and copy the content of the C:\Class
Files\TagProviderFiles\FloatTagPopulation.txt file into the Tag Population Query field.

This script defines all of the individual Tags that will be created by this provider and puts limit on
the number of tags created.

209 of 878

21. Congratulations you just completed the configuration of the BL_FloatTags tag provider
collection. You should have all of the highlighted fields configured. The remaining fields are
optional ones which were discussed in the introduction to this lesson.
a. Click on Save to save the BL_FloatTags tag
b. Click on Test to start testing the scripts we just entered. We will check few of the queries to
make sure they work properly, and in the process we will see how the scripts work as well by
following the steps below

210 of 878

22. Test the Tag Population Query by following the steps below:
a. Deselect all queries except Tag Population Query under 1.Test these Queries
b. Leave all other fields at their default state which should look as below
c.

Click Test

d. See the results under Test Results tab


e. Click on TagName heading to sort it by name

23. You should get all the 28 tags (note the count in the lower left corner) that are not of String type
(as this is the tag population collection for the non-string type tags, BL_FloatTags) from the
EquipmentData table. If you are interested, launch SQL Server Management Studio, and check
out the table. You can also launch the transaction manager and see the tag list that the
Transaction Manger is populating.
24. Write down the name of one of these tags (i.e. M1Oven_TempZone1) as we need a tag name to
test the remaining queries.

211 of 878

25. Test the History Query by following the same procedure as the previous step, but this time you
also need to enter a start and end date as well as at least one tag name:
a. Deselect all queries except History Query
b. Enter a Start Date (i.e. some times before the End Date an hour ago)
c.

Enter an End Date (i.e. sometimes after the Start Date)

d. Enter a tag name which you wrote down from the last step in both TagName and
ExternalKey field (i.e. M1Oven_TempZone1)
e. Click Test

f.

As expected all the entries for the provided date range of the given tag name is returned.

g. When tags from the tag provider is used in various VantagePoint applications, they provide
the information that you typed in. For example in Trend application, the selected tag dragged
onto the plot surface is passed to this script, to provide the tag name which you entered in
manually to test it. The same thing goes with the date information.
h. PLEASE LEAVE THINGS THE WAY THEY ARE HERE (DO NOT CLOSE, etc.) and go to
next step for further information on the scripts

212 of 878

26. In this step we are going to take a look at how the information that you entered for the test, gets
translated into the query. This is to help us get a better understanding of the tag provider scripts.
a. Assuming that you came directly from the previous step, click on Test Query tab to see how
the information you entered shows up in the Test Query

Referring to the annotated version of this script when we entered it a few steps ago, in
conjunction with how the variables gets substituted should give you a good idea of how the tag
provider function provides a powerful capability to bring in information from a transactional
database into VantagePoint for reporting and analysis.

213 of 878

27. We will next configure the string tag collection BL_StringTags for the tag provider, but this time
we will use the import function instead of entering all the scripts one at a time. The use case for
this might be that the String Tag provider has already been configured before and exported to an
XML file and now we simply want to use it.
NOTE: The Import Definition function is NOT an incremental or additive one. It completely
overwrites the exiting definition in the given tag provider collection set. In this case it will
over write the BL_FloatTags that we just created. For this reason, we need to export the
current definition set, then edit the resulting XML file to add the new definitions and then
reimport everything back
28. Export BL_FloatTags definition by following the steps below:
a. Click Export Definitions in the lower left corner of the Tag Definition Editor

b. Save the export file in C:\ root folder and call it BL_FloatTags.xml as shown below

29. Duplicate BL_FloatTags.XML file by copying it onto a new file and call it BL_Tags.XML.

214 of 878

30. Open BL_Tags.XML (the file that you just created by copying the export file) with XML Notepad
2007 (drag C:\BL_Tags.XML file onto the XML Notepad 2007 shortcut on desktop). The
TagProvider node seen here is what we will be adding on. There is only one now, as the
definition file we exported only has one definition (BL_FloatsTag). In coming step, we will copy
and paste new TagProvider node from other XML file onto this file.

31. Click on XSL Output Tab to see all the queries that you entered one by one in the previous step,
all in this export file.

NOTE: The area between the <DocumentElement> tags is what we are interested in. This
is the area which we need to copy from various exported XML files, consolidate them into
one file, and reimport it back in. This area is represented by the TagProvider node in the
TreeView tab. The copying and pasting discussed here is all done on the TreeView tab.

215 of 878

32. Copy the BL_StringTags TagProvider definition from C:\Class


Files\TagProviderFiles\BL_StringTags.XML and paste it into the BL_Tags.XML file so all the
definitions can be reimported back into VantagePoint by following the steps below:
a. Open another session of the XML editor by dragging C:\Class
Files\TagProviderFiles\BL_StringTags.XML file onto the XML Notepad 2007 shortcut)
b. Click on XSL Output to review the BL_StringTags definition

33. As you note the string definition looks very similar to the float one we created earlier. The main
difference is that these queries deal with string types which is reflected in the difference between
the two sets of scripts (highlighted areas).
a. Click on Tree View tab, and Right-click on the TagProvider node and select Copy

216 of 878

b. Go to the BL_Tag.XML file


c.

Make sure to be in Tree View

d. Right-click on DocumentElement, and select Paste

e. You should now have two tag definition collection in the BL_Tags.XML file as shown below
by the two TagProvider nodes under DocumentElement

f.

Click on XSL Output tab to review both tag definition collection

g. Save the C:\BL_Tags.XML file (File > Save)


h. Close all XML files.
34. Import the definition file we just created by following the steps below:
a. Back in Tag Definition Editor, Click on Import Definitions (on the lower left corner)

217 of 878

b. Browse to C:\BL_Tags and click Open

c.

This is the warning reflecting what we discussed earlier. The import operation is not an
additive one, and that is the reason we went through the whole export, edit, and import
process. Click Yes to accept

218 of 878

35. Congratulations, you should now have two tag definition collection: BL_FloatTags, and
BL_StringTags

36. If you like, and have time, Test the new definition like you did for the BL_FloatTags by clicking on
Test Definitions.
37. Save and close the Tag Definition Editor.

219 of 878

38. Click Finish to complete the creation of an instance of the Tag Provider built via DbBuilder.

39. Remember that we put the tags provided by the tag provider under
MyEnterprise > Myplant > Tags folder. If you go there, there are no BL_FloatTags or
BL_StringTags folders as of yet, because the Tag Provider has not been synchronized yet.

220 of 878

40. Synchronize the tag created by the DbBuilder by following the steps below:
a. Navigate to System > Sources > DbBuilder and select BL_Tags
b. Right-Click BL_Tags and select Manual Sync

c.

Leave the default selection to continue the sync from the bookmarked tag definition.
Click Execute

d. Verify that the sync is completed


e. Click Close

221 of 878

41. Verify the creation of the tag provider tags by following the steps below:
a. Navigate to MyEnterprise > MyPlant > Tags
b. Click Refresh
c.

You should see the two folders for the string and float type tags we and their respective tags
we created

This lab is complete

222 of 878

Lab 5 Verifying the Tags Provided By TagProvider


This is a simple lab to quickly verify the operation of the tags we just created by the TagProvider
process. Along the way we also observe simple example of how VantagePoint can act as an
aggregating agent.
1. Verify that you are on the Server Image (Server tab is selected).

2. Launch VantagePoint either via the windows Menu system (Start > All Programs > Rockwell
Software > FactoryTalk VantagePoint > Portal and navigate to Tools > Trend or from
VantagePoint Portal menu (Tools > Trend).
3. Create a trend of the first machines (M1Oven) four temperatures zones logged into SQL Server
by FT Transaction Manager and now referenced by the tags created by the TagProvider process
by following the steps below:
a. Navigate to MyEnterprise > MyPlant > Tags and select BL_FLoatTags
b. Select M1Oven_TempZone1, through M1Oven_TempZone4 and drag them to the Plot
Surface

223 of 878

c.

Select Live Mode to start getting live data from the SQL Server data base.

d. Select Stack Y-Axis to get a better view of the trend activity.

You are retrieving data from an external database and in this case trending it. All the activity
behind the scene (passing external keys into the database, time periods, executing query, etc.) is
all abstracted away from the user. The user simply picks a tag which is a reference to a field in
the database, and simply uses it to create meaningful reports.
In this particular case, not because it was necessary or needed by VantagePoint, but simply to
populate the database, we used FactoryTalk Transaction Manger to populate the
EquipmentData table which we used to create our TagProvider Tags. While we did this to create
an environment to show TagProvider concept, it certainly has real life application. Combining
TransactionManager as a transactional data logging engine to store critical control data into a
target database, and then use VantagePoint to analyze that stored data and turn it into actionable
information via reports is an important application aspect of the Rockwells Manufacturing
Intelligent Story.

4. Discard or Save this trend to report MyEnterprise > MyPlant > Reports as you wish.

224 of 878

5.

Create a second trend to show the first zone temperature of the first machine
(M1Oven_TempZone1) form SQLServer database and the first zone temperature of the first
bread line from HistorianSE database on the same trend by following the steps below:
a. Click on New Icon on Trends tool bar or use File > New to get a new trend on the Plot
Surface

b. Navigate to MyEnterprise > MyPlant > Tags and select BL_FLoatTags


c.

Select M1Oven_TempZone1, and drag it to the Plot Surface

d. Navigate to MyEnterprise > MyPlant > Tags > BL1 > Program:Proof_Oven
e. Select SimpleTempZone1 and drag It to the Plot Surface

f.

Select Live Mode to start getting live data from the SQL Server data base.

g. Select Stack Y-Axis to get a better view of the trend activity.

225 of 878

You are now trending live data from two disparate databases onto one trend!
You should have a trend similar to what is shown below. Youll note that the two trends are nearly
identical. This is because they both look at the same register in the SoftLogix. One is based on
the logged temperature information into the SQL Server, and the other is based on the logged
temperature information into the Historian SE.
Additionally both the Transaction Manger and the Historian SE were configured to only log data
when there was a change, but not at an exact similar evaluation frequency. This explains the
more granular look and feel of the Historian SE based trend (SimpleTempZone1) vs. the SQL
Server based on (M1Oven_TemperatureZone2)

NOTE: Using two different methodology, tag provider for the SQL Server database, and
the FT Historian Connector for Historian SE, VantagePoint was able to act as a powerful
aggregator to while leaving the data at source, establish reference to desired data points,
and provide analytical and presentation capability to transform the data from these
disparate sources into useful information.

This lesson is complete

226 of 878

Lesson 9 Modeling, Types and Type Reports

What you will learn:

VantagePoint Modeling Concept


Create and Import Type Packages and manually assign tags as Items in a Type
Export a portion of the VantagePoint Model to an Instance Package, and edit and import that
Package to create a new section in the VantagePoint Model
Create and publish dynamic Excel report using types in the logical model

Prerequisite:

Completion of Lesson 5, and 8

In this lab we will learn about Modeling, Type and their critical role in VantagePoint. We will learn how
to create types, and use instance of these types in various reports.

Discussion
Modeling
Central to VantagePoint is the ability to integrate information from business and manufacturing
systems scattered across the enterprise into a single unified view. In VantagePoint, this view is
known as the Unified Production Model, or "model". The model lets users access, combine, correlate
and interpret information from multiple sources without knowledge of application-specific interfaces or
data locations.
Creating access to the information stored throughout an Enterprise and bringing it into the unified
view that VantagePoint hosts does require some bit of configuring. Initially, simply creating
connectors to data sources and giving users access to them is enough. Users can create their own
reports in Excel, trend data, and publish content to the Portal. Within the Portal itself users can create
and save personal content. But to truly leverage the tool that the Model can become, it is necessary
to create useful objects that end users can easily use, objects that encapsulate all of the data about
themselves. And furthermore, the Model should represent these objects in ways that reflect the
existing relationships between the objects.
For example, consider a common item in a manufacturing environment: a pump. From a process
perspective, a pump has several measurements associated with it; i.e. Speed, Flow Rate, Pressure.
The real time values of these measurements would typically come from the control system and the
historical record of the values would typically come from a process historian.
The pump may also have some operations that can be performed on it through the control system
such as: Start and Stop.
When considered as an asset the pump has several other characteristics that may include:

227 of 878

Manufacturer Information, Purchase date, Purchase cost, Replacement Value, and Deployed
location. This asset data is often found in the ERP system or a dedicated asset management
application.
From a maintenance perspective the same pump may have: a parts list, a parts list of spares in stock,
Maintenance records.
Production information about the pump would typically be: Batch operations, Material pumped in a
batch, Total volume pumped in a batch.
And, finally from engineering view point the pump might have: Performance curves, an associated
motor, upstream and downstream equipment items.
VantagePoint allows one to define a Pump as being something with all of the above information: this
is called creating a Type similar to the software concept of a Class definition. Once the type exists
in VantagePoint, you can create instances of this definition for every pump in the enterprise and wire
up each instance to the actual data in the source systems. By using Database Mapping, you can
automate some or all of the creation of these pump items in the VantagePoint Model.

Type Packages
Type Packages are extensions to VantagePoint that define types which are often specific to an
industry, business, or public sector entity.
VantagePoint ships with a few pre-defined sample type packages which are installed with the
VantagePoint software (unless a custom installation excludes the Sample Content). The sample
packages are found on the same machine as the VantagePoint Server under C:\Program
Files\Incuity\Packages. In this location are also other Type Packages which are currently in use by
VantagePoint. They are here as samples for building Type Packages, and as packages that can be
used to create custom packages.
You can create your own Type Packages for extending the VantagePoint system. These packages
can be created by directly editing an XML file, or by employing the VantagePoint Type Builder. The
Type Builder is designed to abstract the user from the details of the XML structure and presents the
data in a more logical context.
You use VantagePoint Manager to import Type Packages and build your model. By importing a Type
Package, you will have added new types to VantagePoint. In building the Model, you create instances
of these types and map them to actual data sources. Keep in mind items defined in a Type Package
can be composite; they can be composed of several other items, such as specific tags.
What can you do with a package file?
A package file is an XML (Extensible Markup Language) file that is used to model a system in
VantagePoint. It defines the items that exist in the system such as equipment, material, and time
dimensions, and the properties of these items, and how these items are related to each other.
Once a package file has been imported into VantagePoint, the user can build a Model using items
defined in the package file. Individual items are then mapped to data, thus abstracting the specifics of
where the data comes from and where it is stored. The resulting Model provides a coherent and
unified view of the data using real-world constructs such as pumps, tanks and Production Lines.

228 of 878

The key benefits


Package files and the models they create have several key benefits:
Data organization: A model implemented using a VantagePoint package file provides a
more structured way to visualize available system data.
Robustness: Systems of various complexities can be modeled.
Efficiency: Reusable item definitions allows for faster modeling of a system. Also, one or
more systems can be configured using the same package file.

The VantagePoint Type Builder


The VantagePoint Type Builder is an application for creating and editing VantagePoint package files
(*.itp). Package files contain information about base types in the model, allowing the user to
customize a specific model. Package files contents are XML based. The Type Builder abstracts the
user from the details of the XML structure and presents the data in a logical context.
The work flow using the Type Builder is as follows:
1. Create a new or load an existing package file
2. Optionally load additional required Base Package (Type package that is included with the
VantagePoint System)
3. Edit the Base Types (a type in the VantagePoint System from which other types are derived). For
instance, specifying derivation and properties
4. Save the package file
5. Import the package file into the VantagePoint Model

With the Type Builder the effort of creating and editing package files is significantly reduced and
syntax errors in the XML file are eliminated.

229 of 878

Instance Packages
Instance packages are usually built by exporting VantagePoint model elements into packages that
can later be installed onto other VantagePoint systems.
VantagePoint consists of many built-in types, and the VantagePoint Type System can be extended by
importing new type packages that introduce new types into VantagePoint. See type packages
explained earlier or more information.
Once types exist in VantagePoint, you can begin to build a model of your business or process based
on these types, or items. For example, type packages can include definitions of equipment items such
as pumps, and tanks, material items such as solvents and polymers, resource items such as
employees. When building a model, you create instances of these types and map them to actual data
sources. Some items defined by the type package can also be composite types; they can consist of
other items, which in turn may consist of even more items.
Each time you create an item in the model, you are creating an instance - an actual thing that
represents a real world object. These items often have properties - attributes that describe the item:
pump flow, speed, and pressure, for instance. In building the model, you create your items and define
the relationships that govern that item. Keep in mind that the type package not only determines what
item types can be created, it also defines what information - what properties or attributes - an item
requires. In creating an item of some type, you are following the design dictated by the item's type.
Once you have created a model that accurately describes your business or process, you can share it
with other business units that operate using the same structure. In this case, you can export your
model structure - your collection of instances, including associated reports, trends, and dashboard
displays - into a VantagePoint Composite Package. This "package" will consist of several files
compressed into one "*.icp" file. Included in the collection would be:

Any type packages and definitions required by the package items

One or more iip files (a collection of items)

Possibly several related dat files (reports, etc.)

Importing this package will create your structure and instances on the new server. By wiring the
instances on the new system to the correct data sources, you can immediately start to trend data, use
reports that were built and configured for the instance package, and build new reports that you can
share with others.

Types and Instances


The FactoryTalk VantagePoint Model is made up of Types and Instances of those Types.
In software, a Type is like a Class and an Instance is like an Instance of a Class. Each instance
will have its own individual Properties.
Other comparisons:
If a Type was Employee, an Instance might be Joe Butterfield, employee ID#7654
If a Type was Automobile, an Instance might be a black Ford Explorer, with a specific VIN #

230 of 878

Application Example
Consider a TANK object. A TANK might have Properties like Level, Temperature, Mix Rate, etc.
If created as a Type in VantagePoint, you could create Instances of that Type to represent the
Tanks in the applicationTank1, Tank2, Tank3, etceach with their own individual Properties
An advantage of doing this in VantagePoint is that you can have Type Reports. One report can be
used to display information from each object in the Model of that same Type (in this example a TANK
type)
This is similar to advantages of passing parameters to graphics in FactoryTalk View
Mapping Tags to Instances of Types to Create Type Reports

Importing/Exporting Sections of the Model


The VantagePoint Model is made up of instances that have been created from types. Types are
defined using a type package, which is an XML document with an .ITP file extension. Instances can
also be defined using an XML file but with an .IIP file extension. The .IIP extension stands for
Incuity Instance Package. Both type and instance packages can be imported into a VantagePoint
system.
Instance packages can be exported, edited, and re-imported.
Export the Instance Structure
As an example, we have an existing plant model defined and an instance created for our Chicago
facility. We want to bring another plant on line in Cleveland that is a replica of the existing plant. We
will use the Export tool to extract part of the model then make changes to the external file before reimporting back into the model.

231 of 878

Lab 1 Why Type? - Parameterized (typed) Report


While type and instances of the type are the foundation blocks of Model which in turn is the
fundamental concept of the VantagePoint, perhaps the easiest way to see their role is through a
visual example. In this lab we will revisit the Excel report we create in Lesson 5, which as you may
recall reported the Minimum and Maximum temperature values for Line Proof Oven.
What if we wanted to have this report for other Ovens or Lines?
Since we got introduced to the concept of parameter in that same lesson, and parameterized the time
period, it is reasonable that we can parameterize the other information as well, and as such have this
report for as many different lines as we wish. That is exactly what we are going to do in this lab.
1. Verify that you are on the Server Image (Server tab is selected).

2. To get a refresher on what the BL1 Min and Max Zone Temp report looked like open it in the
portal by following the steps below:
a. Open VantagePoint portal by going Start > All Programs > FactoryTalk VantagePoint >
Portal
b. Click on MyEnterprise under Reports

c.

Navigate to MyEnterprise > MyPlant > Reports, and click on Bl1 Min and Max Zone Temp

d. Click on Parameters tab to see the parameter list

232 of 878

3. As you can see we created a report displaying the min and max values of Bread Line 1 zone
temperatures for a selectable time period

4. In the above report the time period is selectable or in another word time period is a parameter. As
you may recall when we published this report, we simply selected time period to be a parameter.
Since we now would like to be able to see this same information for other zones in other lines as
well, it is reasonable to think that we can also parameterize those variables as well. So we
publish it again and this time we parameterize the temperature zones as well following the steps
below:
a. Launch Excel by going Start > All Programs > Microsoft Office > Microsoft Office Excel
2010
b. Retrieve the BL1 Min and Max Zone Temp report which you completed in Lesson 5 from
VantagePoint server into Excel by Clicking Open under VantagePoint Add-in ribbon

c.

Navigate to MyEnterprise > MyPlant > Reports

d. Double-click on BL1 Min and Max Zone Temp, to open it

233 of 878

NOTE: VantagePoint can be treated as a repository for reports. Where master copies can
reside within VantagePoints Unified Production Model (UPM) and reports that have not
been commissioned can be extracted later and worked on. In this scenario we extracted
our report from Lab5 to continue developing it.
e. Click Publish under VantagePoint menu to republish the report

f.

Select A Report with parameters option, and click Next

234 of 878

g. This as well as the previous recent steps should all look familiar. Last time round we selected
the TimePeriods to be external parameter. This time we will select Tags to be external
parameter as well and click Next

NOTE: The Tags type is Core.Tag. We will discuss the importance of this type shortly.
h. Navigate to MyEnterprise > MyPlant > Reports , and enter BL1 Min and Max Zone Temp
v2, and click Next

235 of 878

i.

Check Browse to published report and Show parameters options and click Finish

5. The new version of the report should appear in the portal with new Tag parameter field. As you
note, this is not exactly what we were hoping for. You can click on the tag picker to the right of the
Tags entry fields and navigate through the maze of data sources. But this is neither practical, nor
user friendly.

The reason for the content of the list not being in a desired format is that the Tags parameter is of
type Core.Tag which essentially includes all the tags in VantagePoint database. For this function
to work properly, we need to narrow down the list to a specific type needed for the drop down list.
This type selection process is driven by project requirement and customer User Interface criteria,
and in summary is the essence of the project modeling. In this case, for example, we need a type
that would provide us a drop down where the user can select Line1, Line2, or Oven1, Oven2, etc.
The remainder of this lesson concentrates on the subject of type, and how it addresses the issue we
discussed here as well as other critical reasons for type and modeling in VantagePoint.

This lab is complete


236 of 878

Lab 2 Creating a Type Package


In this lab we will learn how to create a type package representing an Oven. We will also create
properties of Oven Type and associate the property to tags. Once the Type package has been
created we will import the type package into VantagePoint EMI and create instances of the Oven
type.
An oven may have attributes or properties such as instrumentation that measures its temperatures or
presence of material in different zones. It may also have process attributes like temperature setpoints
in various zones. If an oven were to be created as a Type within VantagePoint EMI, you would be
able to create instances of that Type (Oven) in any application; each Oven having their own
properties. This is advantageous in the respect that if you were to need a report that gives details of a
specific Oven type, the report can be reused against any Oven of the same type. The type or
OvenSimple object in this case can also be used within any of the other reporting tools within
VantagePoint EMI such as Trend.
In this part of the lesson we will be adding a new Type called OvenSimple to the Logical Model. It will
introduce us to the type report. Once a type report is created and additional instances of the same
type are created the new instances will be able to use the same report. FTVP will automatically pass
the correct parameters to the report based on the instance selected from the parameter combo box.
1. Verify that you are on the Server Image (Server tab is selected).

2. Launch Type Builder by going:


Start Menu select All Programs > Rockwell Software > FactoryTalk VantagePoint >
Type Builder
3. Create a new type called OvenSimple by following the steps below:
a. From the File menu select New

b. In the Package name field, enter MyPlant.Oven (overwrite MyCorp.NewPackage)

237 of 878

It is a good practice to enter the Package name in a format like:


<company name><package name>
This information is used in creating the Fully Qualified Name of the package file. The Package file
text box automatically updates when the package file is saved for the first time.
By default, new packages are saved on the local machine in C:\Program Files\Incuity\Packages\.
When creating a new package file, the Type Builder refers to the above folder for the creation of
the list of possible required packages. These packages are copied when you install VantagePoint
Clients from the Portal. If you want to use your new package as a basis for the development of
further type packages, you need to save the package to this location.
For now the only required package for the Oven type is Core.Package which by default is
already added; so we dont need to add any additional packages to this type.

NOTE: Required packages are type packages that contain types which the current
package would like to implement or inherit from. By inheriting from existing types, it
avoids the need to repeat or build new sections of a package. Inherited types can be used
as is, or modified to fit new needs. Furthermore, new types that you create in a package
can inherit properties from more than one existing type.
When a package is included in the Required Packages list, all of its types display in the
Implements list.

238 of 878

c.

In the Types window click Add

d. In the New Type Name textbox enter OvenSimple


e. Click OK

4. This will create the new type MyPlant.Oven.OvenSimple. As you note the package name has
been prefixed to the type name. This ensures that the type will be unique within VantagePoint.
Next we need to configure the OvenSimple parameters.

239 of 878

NOTE: There are already a few properties in the list. These properties are in the list
because the Core.Object has been implemented by default which is required for all objects
in the model. In fact, if you try to remove Core.Package, you will get a message to this
effect.

240 of 878

5. Add new parameters by following the steps below:


a. Click Add in the Type Details section of the window right below the Parameter list, which will
add a new property to the list.

b. Select the Prop1 Property Name


c.

Click Edit

d. Set or verify that the properties are as shown, and then click OK

e. Repeat the above steps and add the following:


Property Name

Data Type

Sub Data Type

InZone2
InZone3
InZone4

Reference
Reference
Reference

Core.DiscreteTag
Core.DiscreteTag
Core.DiscreteTag

TIP:
o

Stretch the TypeBuilder window to give you more space so you can see all the properties

You can Right-click on a property, then Create Property Copy, and then edit the name
241 of 878

The following two tables indicates how the data types map between a Logix controller and the FTVP
types, and the description of each field
Native Logix Data Types
STRING
INT, SINT, DINT
REAL
BOOL
Field
Property
Name
Data Type

VP Subdata Types
Core.StringTag
Core.IntegerTag
Core.FloatTag
Core.DiscreteTag

Description
Name of property against type to be displayed.

The type of property in terms of class or category.


The choices are:
Reference - the property will reference - point to - another item or type
Collection - the property represents a collection of other items or types
Simple Value - the property is a simple, scalar value (e.g.: Int32, String, DateTime)
Enum - Enumeration type: the value can be one of a specific set of pre-defined values

Sub Data
Type

The data type of the item depending on which class the Property Type falls into

Default Value

Default value for the Property

Description

Sets a property description

Read

These attributes specify the security access rights of the associated Property Type.

Write

The Read attribute specifies whether or not the property is visible

Default
Property

The Write attribute specifies whether this property value is able to be changed. Effective
write access is also dependent on Role security.
The Default attribute specifies whether this property is the Default Property for the new
Type.

242 of 878

6. Your Type up to this point should look as follows:

243 of 878

7. After the In Zone indicator properties ( InZonex) are completed, we will next add the Zone
Temperatures (TempZonex) using the same procedure as the previous step but with a different
Sub Data Type, by following the steps below:
a. In the Type details window in the lower right click Add

b. Select the Prop1 Property Name


c.

Click Edit

d. In the Property Name textbox enter TempZone1


e. Verify that the Data Type is Reference
f.

From the Sub Data Type combo select Core.FloatTag

g. Click OK

244 of 878

h. Repeat the previous steps and add the following


Property Name

Data Type

Sub Data Type

TempZone2
TempZone3
TempZone4

Reference
Reference
Reference

Core.FloatTag
Core.FloatTag
Core.FloatTag

8. Our Type details should look as follows:

245 of 878

9. Our type now has the In Zone Indicator properties (InZonex) as well as the Zone Temperature
properties (TempZonex). We will finally add the Zone Temperature Set point properties
(TempSetPtZonex) using the same procedure as the previous step by following the steps below:
a. In the lower right of the Type details section of the window click Add

b. Select the Prop1 Property Name


c.

Click Edit

246 of 878

d. In the Property Name textbox enter TempSetPtZone1


e. Verify that the Data Type is Reference
f.

From the Sub Data Type combo select Core.FloatTag

g. Click OK

h. Repeat the above steps and add the following


Property Name

Data Type

Sub Data Type

TempSetPtZone2

Reference

Core.FloatTag

TempSetPtZone3
TempSetPtZone4

Reference
Reference

Core.FloatTag
Core.FloatTag

10. From the Icon combo box select Core.Cogs. This is an optional step; the Icon selected here will
show up next to the type. Now you know where all the icons come from. The icons reside in
C:\inetpub\wwwroot\IncuityPortal\Images where you can see what they look like

247 of 878

11. The type package is complete, and it should look as follows:

12. Save the type package to root C:\ directory by following the steps below:
a. From the Type Builder File menu select Save As

248 of 878

b. Select Local Disk (C:). Note that the default file name is the name of the package name (in
this case MyPlant.Oven)
c.

Click Save

You can choose to save custom type packages wherever you want to, but the Type Builder looks
in the folder C:\Program Files\Incuity\Packages on the local machine when creating new
package files. This is where the list of required packages is derived from. If you want to use your
new package as a basis for the development of further type packages, you need to save the
package to this location.
Once a type package is imported into VantagePoint, the types are created in the VantagePoint
Server and will be backed up when the VantagePoint Server database is backed up. Even so,
custom type packages that you create should be stored in a place where they will be backed up.

249 of 878

13. Import the type we just created into the VantagePoint by following the steps below
a. Open VantagePoint Manager
b. Select File > Import

c.

In the Import window open the file browser

NOTE: Importing a type package introduces new types to the VantagePoint system that
can then be used to build your model. These types are derivatives of existing types in
VantagePoint - that is, they inherit certain characteristics from existing types, and then
add new characteristics of their own.
d. Browse to C:\
e. Select MyPlant.Oven.itp
f.

Click Open

250 of 878

g. Verify the selection and click on Next

h. Verify the successful import message and click Finish to complete the import process

14. View the new package in the VantagePoint Manager by following the steps below:
a. From VantagePoint Manager, select Packages from the View drop down list

251 of 878

b. Cursor down the list of packages, to find MyPlant.Oven.Package and expand it. And click on
MyPlant.Oven.OvenSimple type. On the Right pane, click on Properties and note all the
information for the type. Notice that there are no values, as this is a type. Once it gets
instantiated, the instance of this type will have value.

15. Create an instance of the OvenSimple Type by following the steps below:
a. In VantagePoint Manager switch the view back to Items

252 of 878

b. Navigate to MyEnterprise>MyPlant>Tags>BL1
c.

Right-click on BL1 and select New > Item

d. Select the MyPlant.OvenSimple.OvenSimple Type under Core.Object


e. Click Create

253 of 878

16. Once the new instance is created, the reference to this new instant needs to be configured by
following the steps below
a. In the Name textbox enter Line1OvenSimple
b. Click the InZone1 browse button

c.

Navigate to MyEnterprise > MyPlant > Tags > BL1 > Program:Proof_Oven

d. Drag SimpleInZone1 tag to the InZone1 property field

254 of 878

e. Now, drag and drop the rest of the Item Names, one at a time, to the Item Types to match the
following table (first one already done):
Item Type
InZone1
InZone2
InZone3
InZone4
TempZone1
TempZone2
TempZone3
TempZone4
TempSetPtZone1
TempSetPtZone2
TempSetPtZone3
TempSetPtZone4
f.

Item Name
SimpleInZone1
SimpleInZone2
SimpleInZone3
SimpleInZone4
SimpleTempZone1
SimpleTempZone2
SimpleTempZone3
SimpleTempZone4
SimpleTempSetPtZone1
SimpleTempSetPtZone2
SimpleTempSetPtZone3
SimpleTempSetPtZone4

Verify that your Item instance is as indicated below

g. Note that the Scope entry at the top contains the common part of all the tags which we just
assigned. Had these tags had different FQN (i.e. different source), then each tags would
have their full FQN in each field
h. Click Create

255 of 878

17. Verify that the configured Line1 OvenSimple instance was added
a. Verify that the Item Names are as indicated below
b. This is an instance of the MyPlant.Oven.OvenSimple type

This lab is complete

256 of 878

Lab 3 Create a Type Report


In this lab we will modify the report we created earlier in this training (BL1 Min and Max Zone Temp)
to turn it into a Typed Report, or essentially make it such that we can use the same report for any
oven of the type Ovensimple. To do so, we will open the report we created earlier, delete all the
references to data source as those were not of the Ovensimple type reference, and republish the
report with a version 3
NOTE: We will discuss the content of these sheets later when more advanced Excel
concepts are discussed. For now suffice to say that the IncuityInfo sheet contains the
information about parameters, and Parameters sheet contain information about tag names
used in the report.
1. Retrieve the BL1 Min and Max Zone Temp report from VantagePoint into Excel by following the
steps below:
a. Launch Excel: Start > All Programs > Microsoft Office > Microsoft Office Excel 2010
b. Click Open under VantagePoint Add-in ribbon

c.

Navigate to MyEnterprise > MyPlant > Reports, double-click on BL1 Min and Max Zone
Temp, to open it

2. Delete any name references related to the old report by following the steps below:
a. Select Name Manager in the Formula ribbon bar

257 of 878

b. Select all the names related to the VantagePoint report we are updating (in this case all of
them), and click Delete

3. If you hid the working sheets (IncuityInfo, Parameters, and ReportData) unhide them by following
the steps below (if you did not hide, go to next step):
a. Right-Click ReportChart tab, and select unhide.

b. Select IncuityInfo sheet and click OK to unhide it.

c.

Repeat the above steps to unhide ReportData as well as Parameters sheets

d. You should now see all the relevant sheets tabs at the bottom of the report.

258 of 878

4. Delete IncuityInfo, and Parameters sheets by following the steps below:


a. Right-Click on IncuityInfo tab, and select Delete, and Delete again to confirm.

b. Repeat the above step for Parameters sheet. You should now only have two sheets:
ReportData and ReportChart
5. Delete the content of the ReportData sheet by following the steps below:
a. Select ReportData Sheet, and click on Select All button to select all the cells in this sheet.

b. Right-click on the work sheet, and select Delete

259 of 878

We now essentially have a template report that we can use for our new typed report. The Report
in ReportChart sheet is all there, but needs source of data to convey the expected information.
6. Start inserting VantagePoint History function into cell C3 by following the steps below:
NOTE: Up to now the cell selected to insert the VantagePoint has been arbitrary. In this
case however the C3 selection is critical since that is the location where ReportChart
sheet looks for its needed data which was defined when we first created this report in an
earlier lesson.
a. Select ReportData sheet
b. Select cell C3
c.

Select the VantagePoint tab (this add-in is installed as part of VantagePoint Installation)

d. Select Insert Function (NOTE: that as soon as you click on Insert, the parameter sheet and
Incuity sheet (hidden) are created)

260 of 878

e. Select History option


f.

Click the Use advanced Type Mapping features check box. Checking this box tells
VantagePoint that we will be selecting a type within the model to create a report against.

g. Click Next

261 of 878

7. The Type Selection view is presented. VantagePoint wants to know what we want to pass to the
History function which we selected in the previous item. We can do this either by selecting the
type of the desired item or select an example of the type using the items view. We select an
example or instance of our desired type (MyPlant.Oven.OvenSimple) by following the steps
below:
a. Select the Items that contain Core.Tags option
b. Navigate to MyEnterprise>MyPlant>Tags>Bl1 and select Line1OvenSimple which is an
instance of the MyPlant.Oven.OvenSimple type
c.

NOTE that the MyPlant.Oven.OvenSimple now shows up in the selected type field. This
is what we are interested to get out of this step.

d. Click Next

262 of 878

8. The Item Selection view is now presented. VantagePoints reporting wizard is essentially
showing all instances of the type MyPlant.Oven.Ovensimple in case we wish to select them (in
this case there is only one and it has already been selected). Since we will be building a report
that reports against all instances of the MyPlant.Oven.Ovensimple type, (even if there were
more instances of this type), we leave the current selection to one and click the Next button (not
shown) to continue.

9. Note that the Chosen Type, a Sample Item and Required Type for our selection is shown.
Furthermore there is an informative message providing details of what we have chosen, and what
we need to do next. Click Next (not shown).

263 of 878

10. From the Item Name window move TempZone1, TempZone2, TempZone3 and TempZone4 to
the Type: Core.Tag window (be careful not to select the SetPt tags) and Click Next

264 of 878

11. The Parameter Creation view is now presented. Configure the parameters as follows:
a. Check the box labeled Make this an External Parameter when Published. Checking the
box will indicate to VantagePoint that the report accepts parameters of the Type
MyPlant.Oven.Ovensimple
b. Change the Name to Oven from Ovensimples to make the name a little user friendlier and
also give the indication to the user that they can only select one Oven (needless to say this is
an optional change and will depend on your project requirements)
NOTE 1: The constraints on the parameter, with a max range of one parameter for the type
at a time are selectable.
NOTE 2: The Range containing Mapped Items fields indicates where in the report the
fields of the type will be located. This field, if referenced at the end of the Wizard, will
contain the tags being used by the report itself.
c.

Click Next

265 of 878

12. The Time Selection view is now presented. There are several options on this view that can be
selected. We will implement a relative time period of type Core.TimePeriod.Relative with an
initial last 30 minutes selection by following the steps below which involves similar steps as the
ones we just went through for the temperatures:
There are several options for time selections:
Option 1 - Select a Relative time period, for example last hour, last day, last month, etc.
Option 2 - Select an Absolute range, such as January 1 2011 to January 22 2011 3:30 PM.
Option 3 - Select a place within the worksheet containing the dates to be used by the report. This
would be typically two cells, one containing the Start and the other the End of the reporting
period.
Option 4 - Use a Range. The range selection allows the use of the type Core.TimePeriod. This
would allow the user to select time periods within the model. This is the option that we will use
following the steps below:

a. Select the Use this Range option


b. Click New

266 of 878

c.

Browse to MyEnterprise > Samples V4 > Support > Report Library > TimePeriods

d. Select Last 30 Minutes


e. Click Next

f.

The relative time is already selected. Click Next.

267 of 878

g. Check the Make this an External Parameter when published check box. Note some of the
similar fields as the one we saw for the oven temperature selection.
h. Click Next

13. Click Next

268 of 878

14. The parameter configuration (temperature and time) is now complete. Next we need to configure
the Data option which will be identical to what we did in lesson 5 by following the steps below:
a. MAKE SURE that the Wide Data Format is selected
b. Click Finish

15. The data for the four zones of Line 1 Oven for the past 30 minutes should show up in our report.

NOTE: The formatting may not be correct for some of the columns, as it may be assuming
the format is date/time instead of a number, or vice versa. You could change the format if
you wanted to, but since we dont intend our users to see this worksheet we can leave it
as is. The format being displayed will not affect the aggregation of the data.

269 of 878

16. Select ReportChart sheet and you should see a similar report as you did in Lesson 5 which
should look as follows:

17. Publish the report with Parameter selection to our report folder by following the steps below:
a. Click Publish in VantagePoint ribbon menu

b. Select A report with parameters option, and click Next

270 of 878

c.

Youll note that both parameters used in this report are selected by default which is what we
want. Click Next

d. Navigate to MyEnterprise > MyPlant > Reports and type in BL Min and Max Zone Temp
for the report name, and click Next
NOTE that we took the number after the BL off the name as this report being a typed
report will be able to show the report for any selected line, and as a good practice the
name should reflect that.

271 of 878

e. Select both options of Browse to published report and Show parameters and click Finish

18. Your report should look as follow, with the Oven drop down properly only showing the relevant
information and not the whole database as we saw earlier.
CONGRATULATIONS. You have created your very first Typed Report. It needs some more
cosmetics tweaks, but the important parts are done

272 of 878

The Oven selection now is only limted to Ovens and is not presenting the entire database like it did
earlier in this lesson. Currently there is only one oven selection because we only made one instance
of the Oven simple type. As more instanced of this type is added to the sytem, they will be added to
the drop down list.
This is the hallmark of the typed report. As more ovens are added to the system, they simply show up
to the drop down list, and their related information can be seen via this report without any need to
modify this report.
In the next lab, we will create another instance of Ovensimple, this time for line 2, and see how it will
show up on this report

This lab is complete

273 of 878

Lab 4 Create an Instance from another Instance


In this lab we will learn how to create an instance of a type from another instance by exporting the
source instance, editing it to reflect the new instance name and source data, and then import it back
to create a new instance of the type. A new instance can certainly be created without doing the
import and export process. In fact that is how we created an instance of Line1OvenSimple from the
Oven type, but the export and import provides a quicker way to create new instances.
In this lab we will export Line1OvenSimple instance to a XML file and edit the exported file to replace
all Line1 references to Line2. We will import the edited file back into the Logical Model to create a
second instance of this Type, one that has been modified to point at Line2 instead of Line1. By rerunning our Bread line Min and Max report (BL Min and Max Zone Temp) report, we will verify that
we can select either the Line1 or Line2 Oven Simple report.
1. Open VantagePoint Manager and navigate to MyEnterprise>MyPlant>Tags>BL2 and note that
there is no instance of Line2OvenSimple like the one that exists for BL1.
2. Export Line1OvenSimple instance by following the steps below:
a. Click on File, and then Export

b. Navigate to MyEnterprise > MyPlant > Tags > BL1 and select Line1OvenSimple
c.

Click on > to move it to the selected items to be exported, and click Next

274 of 878

d. Enter C:\LineOvenSimple in the file name field


e. Click Import Options

NOTE: The Import Options may seem a bit strange since we are in an exporting
process. This option is defining the default setting in the export file for when it is going to
be imported. These are the default options for the future import of the exported file and
they can be modified if needed
f.

Note the various options. Select Add

g. Click OK

h. Click Next to export items

275 of 878

i.

Click Finish

3. The LineOvenSimple.ICP file should now be in the root C:\ directory. This is a compressed file
(i.e. ZIP) contains all the relevant type information for the Line1OvenSimple instance. We will
open the ICP file and the Instance package in it by following the steps below:
a. Copy LineOvenSimple.ICP to LineOvenSimple-Save.ICP to keep the original
b. Rename the LineOvenSimple.ICP to LineOvenSimple.Zip, and click yes to the file rename
warning message
c.

Right-click on LineOvenSimple and select Open With > Windows Explorer

NOTE: Both InstantPackage(s) and the required TypePackage(s) are bundled in to create a
single self-containing package for both type and instance of the type.
d. Click on InstantPackage folder to see its content where InstancePackage.iip resides

e. The iip file contains the information about the Line1 instance of the OvenSimple type
f.

Drag the InstancePackage.iip file onto desktop

276 of 878

g. Drag the InstancePackage.iip file onto XML Notepad 2007 shortcut on the desktop

4. Click the XSL Output tab to briefly review the code in this file:

a. Note the name of the Type Package, and information about various Fully Qualified Names
(FQN) are all related to BL1

277 of 878

5. Modify the XML file to replace the BL1 with BL2, and Line 1 with Line2
a.

Click back on the Tree View tab

b. From the XML Notepad menu select Edit > Replace


c.

In the Find what textbox enter BL1

d. In the Replace with textbox enter BL2


e. Make sure other options are set as shown
f.

Click Replace All

g. The above replacement was for organizational purpose so the instance would be placed
under the BL2 folder and the tags in the instance get pointed to the correct data source which
is BL2. We also need to change the name of the instance so in the same way as previous
step, replace Line1 with Line2
NOTE: In case you get a message that nothing is found, you may need to change the
search direction or close the field and open it again.

278 of 878

h. When the replace process is completed close the Replace dialog box
i.

Click on XSL Output again, and note that all reference s to BL1 are now changed to BL2

j.

Click on Tree View and navigate to Items > item > name and notice that the instance name
is also changed from Line1OvenSimple to Line2OvenSimple

k.

From the XML Notepad menu, select File > Save

l.

Close the XML Notepad

m. Move the modified InstancePackage.iip file back into the Zip file explore folder where it
came from, and select the Copy and Replace option so the file in the zip file gets updated.

n. Close the Zip file windows explores


o. Rename the LineOvenSimple.Zip file back to LineOvenSimple.icp file, and click yes to the
file rename warning message
The ICP file is now updated, and now can be imported back into VantagePoint to create the new
instance we just created in the XML file.
279 of 878

NOTE: A good programming structure with good naming convention allowed us to do the
mass search and replace to create the new instance rapidly. While even if we did not have
this luxury, the import/export process would still save us time (editing XML, instead of
going through various configuration screens), an importance of good programming
practices can not be over stated.
6. Import the ICP package we just modified into VantagePoint Manager following the steps below:
a. In VantagePoint Manager click on File, and then Import

b. Click on the ellipses button to search for the import files

c.

Select the just modified ICP file in the root C: folder (C:\LineOvenSimple.icp), and click
Open

280 of 878

d. Verify the Item that is about to be imported. Note that it is in fact the Line2OvenSimple
instance located in the proper BL2 folder which is what we wanted.
e. Click Next

f.

Leave the default option as the same setting when we exported the package. Essentially only
add the new items, and do not modify any of the existing properties.

g. Click Next

281 of 878

h. Verify the successful import indication message, and then click Finish

7. Verify that the instance is correct and properly imported by following the steps below
a. Open VantagePoint Manager
b. Navigate to MyEnterprise>MyPlant>Tags>BL2
c.

We should have a new instance called Line2OvenSimple

NOTE: You may have to do a refresh on the MyEnterprise folder to see the
Line2OvenSimple instance
d. Because we replaced every occurrence of BL1 in the .iip file with BL2, all of the tags mapped
in this Line2OvenSimple instance will be from BL2 tags.
e. Just as a verification, select one of the items (i.e. InZone1) and look at its properties where
BL2 will be shown as the source of the tag

Congratulations, you just created a new instance of a type by simply exporting the source instance,
modifying it, and importing it back to create a new instance. This eliminated all the steps of creating
an instance, and then mapping all the elements one by one to their target source.

This lab is complete


282 of 878

Lab 5 Type Report Test with Multiple Instances


Now that we have two instances of our Oven (Line 1 & Line 2), we can test our Type report by
following the steps below:
1. Open the type report we created earlier in this lesson by following the steps below:
a. Open the VantagePoint Portal
b. Navigate to MyEnterprise > MyPlant > Reports

c.

Select the BL Min and Max Zone Temp report

d. Select the Parameter tab


e. Click on the drop down list and note that now both Line 1 and Line2 ovens are available
f.

From the Oven combo box select Line2OvenSimple

g. From the time combo box select last 5 minutes


h. Click Generate Report

283 of 878

2. As you note, we did not change anything in the report. The line 2 simply appeared as a new
parameter because it was of the type that has been configured for this report. VantagePoint type
and type report feature provides a powerful method to organize information and use a single
report template to display information for many similar objects.
Now that we have delivered the typed report we were targeting for, there are some
aesthetics/cosmetics issues that needs attention. For example the report has a header (Bread
Line 1) from the original report which is misleading when Bread Line 2 is selected. In the
remainder of this lab, we will modify the Excel report so it would reflect the correct line
designation and along the way get a little familiar with the sheets generated by the VantagePoint
Add-In.
3. We will look at the parameter sheet in the Typed Report we just created and observe the
behaviors of the Parameters sheet (hopefully you did not hide it, if you did, unhide and republish
the report) by following the steps below:
a. In the published report from previous step, click on Parameters sheet.

b. Assuming that you did generate report using BL2.Line2OventSimple a few steps ago, you
should see something similar to the diagram below. Note the references to Line 2

c.

Select BL1.Line1OvenSimple in the parameter selection drop down, and click Generate
Report

284 of 878

d. As you did before, click on Parameters sheet and note that all the references are now
changed to point to Line 1

4. As you saw in previous step, in this report, the information in Parameters sheet can help us
identify the bread line being displayed. Following the steps below, we will examine this
information to find a pattern that can be used in modifing the report to display the correct header.
a. Launch Excel
b. Retrieve the BL Min and Max Zone Temp report which you completed earlier in this lesson
into Excel by Clicking Open under VantagePoint Add-in ribbon

c.

Navigate to MyEnterprise > MyPlant > Reports, double-click on BL Min and Max Zone
Temp, to open it

d. If you hid the working sheet Parameters, unhide it by following the two steps below:

Right-click ReportChart tab, and select unhide

Select Parameters sheet and click OK to unhide it.

285 of 878

e. Open the Parameters sheet, and note the information that it provides. The information on
Column A and B is what was changing based on the line selection in the portal report which
we observed a few steps ago.
f.

th

Further notice that the line number is the 29 character of the tag name in Column B. We will
use Excels MID function to extract this number and show it on our report

5. Modify the Excel report by following the steps below:


a. Click on ReportChart sheet to open it

b. Select the cell that contain the text Bread Line 1 (in the example below it is in a merged and
centered cell of B3 across the columns from B to F)

c.

Replace the text Bread Line 1 with ="Bread Line " & MID(Parameters!B1,29,1) as shown
below:

NOTE: Excels MID function returns the characters from the middle of a text string (in this
th
case tag name), given a starting position (in this case the 29 character), and length of the
returned string needed (in this case, one character)
286 of 878

6. Publish the report with Parameter selection to our report folder by following the steps below:
a. Click Publish in VantagePoint ribbon menu

b. Select A report with parameters option, and click Next

c.

Youll note that both parameters used in this report are selected by default which is what we
want. Click Next

287 of 878

d. Navigate to MyEnterprise > MyPlant > Reports and type in BL Min and Max Zone Temp
V2 for the report name, and click Next

e. Select both options of Browse to published report and Show parameters and click Finish

288 of 878

7. Your report should look as follow

8. Select BL2.Line1OvenSimple, and Last 5 Minutes in their respective drop down list and click
Generate Report.
NOTE: The report title correctly reflects the bread line report being displayed

CONGRATULATIONS! You are done with this lab.

This lab is complete

289 of 878

Lab 6 Importing a Package


This is a short lab to re-emphasize the utility of the type and instance package which might have been
lost in between all the steps doing the previous labs. We will import an already created package that
while simple, emphasizes the self-contain nature of these packages. Aside from the learning
perspective, the type (LineInfo), and its instances (Line1Info, and Line2Info) will be used later in the
composite report lesson.
1. Launch VantagePoint Manager.
2. Change View to Types and browse through the type and note that the there is NO LineInfo
(MyPlant.Line.Info) type.

3. Change the View back to Item, browse to MyEnterprise>MyPlant>Tags and expand BL1, and
BL2 and note that there are NO instances of Lin1Info or Line2Info

290 of 878

4. Import the LineInfo package following the steps below:


a. From the File menu select Import (File > Import)

b. Click on the ellipsis, browse to C:\Class Files\Types, and select LineInfo.CIP


NOTE: This package includes two instances of whatever type that it includes
c.

Click Next

d. Select the Add option and click Next

e. Verify the successful import indication message, and then click Finish

291 of 878

5. Now check the types (View > Types) and you should have a new type called MyPlant.Line.Info
added to your system which you can use.

6. Change view back to items (View > Items)


7. Navigate to MyEnterprise>MyPlant>Tags and expand BL1 and BL2
8. Note the new Line1Info, and Line2Info with all their defined elements and properties

As you note, you did not have to create tags, or import things in a particular sequence. The ICP file
contains all the needed information to create the tags and instance of those tags. Having said that
you must note that the structure in which the instances are to be attached to needs to exist (in this
case MyEnterprise>MyPlant>Tags>BL1)

This lab is complete

292 of 878

Lab 7 Building Enterprise Model


In a mature VantagePoint system, the Model will graphically represent the enterprise manufacturing
model in such a way that finding information about a system component - a pump, for instance - is
intuitive and comprehensive. It is the Model that facilitates the joining of data from disparate systems
to render a complete view of an object. Sometimes that object is a pump, sometimes it is a
Production Line, and sometimes it is a single tag. Sometimes the data is all in one place, but more
often, related data resides in different sources. It is the job of the Model to expose relationships
between data objects, and present them as understandable things, such as pumps.
Through the Model, connections are made to data sources, and those data sources are exposed for
use by end users in applications like Excel, Trend and XY Plotter. These applications access the
Model through the Model Browser, an intuitive tree structure that users traverse, filter and search for
Model items.
Users who create custom reports and web content will publish these items into the Model. And
System Administrators and Architects will manage users, add connectors, plug-ins, and packages,
using the Model.
The Model is built, maintained and managed using VantagePoint Manager, but users with appropriate
permissions can edit the Model using the Model Browser in most VantagePoint applications.
This lab we will reuse types already created and enhance the type adding more complex attributes
and rules to our type.

293 of 878

Part A - Creating a Model Type using the FTVP Type Builder


1. Create a new type package called MyModel by following the steps below:
a. Launch Type Builder by going Start > Rockwell Software > FactoryTalk VantagePoint >
Type Builder
b. From the File menu select New

c.

In the Package name textbox enter MyModel

2. In the package we just created, add a new type called MySite by following the steps below:
a. In the Types window click Add

b. In the New Type Name dialog enter MySite


c.

Click OK

294 of 878

3. Repeat the above step to create three more types called MyArea, MyLine, and MyWorkcell.
Once done, you should have a package with four types as shown below

295 of 878

4. Next, we will configure one by one the types we just added to our package starting with MySite by
following the steps below:
a. Select MyModel.MySite in the Types section of the Type Builder
b. In the Type details section, click Add to add a new property to the MySite type

c.

Double-click on the newly created MySite property (Prop1) (you may have to scroll down to
in the Property table to see it)

d. Configure the property as shown below, and click OK


e. Property Name = Areas
f.

Data Type

= Collection

g. Sub Data Type= MyModel.MyArea

296 of 878

5. Repeat the above step to add a single parameter to each of the other three types, and configure
them as follows:
MyModel.MyArea added property Configuration:

Property Name = Lines


Data Type
= Collection
Sub Data Type = MyModel.MyLine

MyModel.MyLine added property Configuration:

Property Name = Workcells


Data Type
= Collection
Sub Data Type = MyModel.MyWorkcell

297 of 878

MyModel.MyWorkcell added property Configuration:

Property Name = Equipment


Data Type
= Collection
Sub Data Type = Core.Object

6. Save your new package to C:\MyModel.itp and exit the Type Builder by following the steps
below:
a. From the File menu select Save As

b. Save in Root of C:\


c.

Take the default file name MyModel.itp

d. Click Save
e. From the File menu select Exit to close the Type Builder

298 of 878

Part B - Import the MyModel into FTVP Server


1. Import the type we just created into the VantagePoint by following the steps below
a. Launch VantagePoint Manager
b. Select File > Import

c.

In the Import window click on ellipses button to open the file browser

NOTE: Importing a type package introduces new types to the VantagePoint system that
can then be used to build your model. These types are derivatives of existing types in
VantagePoint - that is, they inherit certain characteristics from existing types, and then
add new characteristics of their own.
d. Browse to C:\
e. Select MyModel.itp
f.

Click Open

299 of 878

g. Verify the selection and click on Next

h. Verify the successful import message and click Finish to complete the import process

300 of 878

Part C - Import Existing Types into the FTVP Model


We are going to add two more types to our model where they will be added under the Equipment type
which we just created in the previous part. Since these two types do not introduce any new concepts,
and creating them would involve the exact steps which you have already done twice in this class, and
in the interest of time, they are already made for you. They are called MyOven and MyMachine, and
can be found at c:\ClassFiles\Types folder. Please take a look at them using the type builder to get
familiar with them, but essentially the type constructs they represent are very simple and are as
follows:
MyOven:
Four elements: Zone1 -4 temperatures with Reference data type, and Core.FloatTag sub data
type
MyMachine
Three elements: BatchID, ProductCode, MachineID, all of Reference type and
Core.StringTag sub data type
1. Import MyOven type by following the steps below:
NOTE: The MyOven and MyMachine types will be used as the types that will be added
under the Equipment type in the model
a. Launch VantagePoint Manager
b. From the File menu select Import

c.

Browse to C:\ Class Files\Types

d. Select MyOven.itp
e. Click Open, Next and then Finish on confirmation window
f.

Click OK after verifying the successful Import message

2. Repeat the import procedure in the previous step to import MyMachine type
3. As you have done a few time before, change the view to Package, and verify that two packages
have been imported properly

301 of 878

Part D - Creating an Enterprise Model Based on MyModel


In this lab we will create the enterprise model depicted in the diagram below:

1. Create a new folder called MyTestEnterprise under MyEnterprise folder following the steps
below:
a. Launch VantagePoint Manager
b. If the view is still in Packages mode from previous step, change it to Items View
c.

Right-click on MyEnterprise folder and select New > Folder

d. In the Folder name textbox enter MyTestEnterprise


e. Click Create

302 of 878

2. Under this MyTestEnterprise folder, build the enterprise model


Site1 > Area 1 > Line1 > Workcell1
by creating an instance of the MyModel which you configured earlier in this class, following the
steps below:
a. Right-click on MyTestEnterprise and select New > Item

b. Select MyModel.MySite
c.

Click Create

d. In the Name textbox enter Site1


e. Click Create

303 of 878

f.

Expand the Site1 folder

g. Right-click Areas and select New > Item

h. In the Name textbox enter Area1


i.

Click Create

j.

Expand Area1 folder

k.

Right-click Lines and select New > Item

l.

In the Name textbox enter Line1

m. Click Create

304 of 878

n. Expand Line1 folder


o. Right-click Workcells and select New > Item

p. In the Name textbox enter Workcell1


q. Click Create

r.

Your MyTestEnterprise model should now look as follows:

NOTE: Because of the structure of the type you created, the process of creating an
instance of the type walked you through the creation process to adhere strictly to the type
structure. i.e. when you first created the instance of MyTestEnteprise, the only item you
could make was site, then area, then line, etc.
3. Create one more workcell under Line1 and call it Workcell2 by following the steps below:
a. Right-click Workcells and select New > Item

305 of 878

b. In the Name textbox enter Workcell2


c.

Click Create

Your Model should look as follows:

We have now created an instance of MyModel which has a single site with a single area containing a
single line which has two workcells. We will next further expand our model by adding equipment
types to our model by creating instances of the two additional types we imported earlier.(MyMachine,
and MyOven) under the Equipment item
4. Create an instance of an MyOven (called M1Oven), and MyMachine (called Machine1) under
Workcell1 by following the steps below:
a. Right-click the Equipment under Workcell1 and select New > Item

306 of 878

b. Select MyOven.Oven
c.

Click Create

d. In the Name Textbox enter M1Oven


e. Click Create
NOTE: The specific zone temperatures tags can be defined later

f.

We will repeat the above steps to create Machine1 of the type MyMachine under
Workcell1>Equipment by Right-clicking the Equipment under Workcell1 and select New >
Item

307 of 878

g. Select MyMachine.Machine
h. Click Create

i.

In the Name Textbox enter Machine1

j.

Click Create

NOTE: The machine properties can be added/defined later

308 of 878

5. Repeat the previous step to create M2Oven, and Machine2 under Workcell2. When done with
this step, your model should look as follows:

This lab is complete

309 of 878

Lab 8 - Using the Model Builder to Create Models


In the previous lab, you learned how to create a model in a fairly manual step by step process. This
can be a cumbersome process particularly if you have large or many models to create, and/or if the
model requires any editing or modifications. The ModelBuilder plug-in is intended to address some of
these challenges.
In this lab we will learn how to use the Model Builder Plug-in to create model. It is a free add-on to
VantagePoint; and a great tool for rapid development of your model in the unified production model.
The intention of this lab is not to make you SQL savvy but to illustrate other available techniques to
Modeling. The SQL scripts used in this exercise have been done for you. This lab will illustrate how to
use the ModelBuilder with the completed SQL scripts with brief explanations of the scripts
themselves.
We will use hard-coded queries, as well as flexible queries that extract data from a database
NOTE: While the entire model can be scripted in one SQL script, and then imported, we
will first learn how to use the tool to create the model one level at the time. To save time
(and this is not a typing class anyways!), we will copy and paste the short scripts instead
of typing them all in. Once we get familiar with this process, we will use a full script import
in later part of the lab.

Background:
Creating large VantagePoint models by hand can be inefficient particularly if the data required is
already available in a database elsewhere and can be extracted by writing a series of SQL queries.
Model Builder was created to facilitate this and also as a way to recreate an existing model in short
order should changes be needed.
Example Scenario
1. The user wants to create a model in VantagePoint but quickly realizes that a handmade solution
will require a prohibitive amount of time. The user has access to a database describing most of
what he needs to create and the SQL skills to extract it.
2. The user brainstorms a new logical model for VantagePoint. It will approximate the physical
reality (at least to start) but will be optimized to serve the particular business needs that are
driving development reporting, dashboard construction, process modeling, etc.
3. Based on these general concepts the user will start creating new custom types using Type
Builder. These are the classes (entities) that the new logical model will be built with. Typically
these will be saved together as a new type package and imported into the Model.
4. With the new types designed and imported the user can now start to create individual instances
of them. After installing Model Builder the user creates one or more DbLocations pointing to the
databases containing the data holding the information he needs.

310 of 878

5. Using the Model Builder Editor the user then creates a script that will create instances of each
custom type that he has defined. He starts at the top of his list with the first type and writes a SQL
script that will populate the model with an instance. He then tests it to see that it works as
intended. When it does, he proceeds to the next type and then the next.
6. This is an iterative process and the user will quickly find that something has been overlooked and
that the new model needs to be adjusted in some way. If this process was being done by hand
then this would require the scrapping of all instanced and represent a considerable waste. Since
it is automated using scripts though it only takes a minute to discard and recreate everything. If a
new type needs to be introduced or the property of a type changed this can be done in Type
Builder and then the Model Builder script updated and rerun. The entire logical model can be
deleted and recreated if needed with just a few mouse clicks.

Model Builder SQL Script Syntax


/* The query should return item and property information in the following columns: Note that the column
ordering is important.
<ItemName>,<ItemType>,<ParentItemType>,<ParentItemName>,<ParentPropertyName>,<PropertyNam
e1>,<PropertyValue1>,<PropertyNamae2>,<PropertyValue2>..,<PropertyNamen>,<PropertyValuen>*/
ItemName = Name of Item to add to the model
The ItemName can be a hard coded name of a collection of types or a type to add
The ItemName can be queried from a table containing a list of a collection of types or types to
add
ItemType = VantagePoint Type of the item to add
The ItemType can be a hard coded name of the type to add
The ItemType can be queried from a table containing a list of types to add
ParentItemType = always is NULL
ParentItemName = FQN of the location in the Model where the item will be added
The ParentItemName can be a hard coded string
The ParentItemName can be a combination of hard coded strings and results of queries on
columns in database
ParentPropertyName = always is NULL
PropertyName1 = Item Name from the types property list
PropertyValue1 = FQN of the location where the Item Name will get its value from

311 of 878

Part A - Using the Model Builder with Hard Coded SQL Scripts
In the previous lab, you manually created a MyTestEnterprise folder made up of Sites, the Sites
made up of Areas, the Areas made up of Lines, etc. You created and imported Types and then with
the VantagePoint Manager you manually added Instances of those Types to create your model.
Verify this part of your model exists:

NOTE: In this lab, you are going to use a feature of VantagePoint called Model Builder to
automate the model building process. SQL Queries will be used to build the model. An
advantage is that you can edit the queries and rebuild the model multiple times if desired.
Also, you can "reuse" the queries to build similar models in completely different
VantagePoint applications

312 of 878

1. Create an instance of the ModelBuilder called MbModel following the steps below:
a. Launch VantagePoint Manager
b. Navigate to System > Sources > ModelBuilder
c.

Right-click ModelBuilder and select Create Instance

d. In the Name textbox enter MbModel


e. Click Execute

313 of 878

2. Configure the new instance by following the steps below


NOTE: Each Model Builder instance requires a Database connection
a. Expand MbModel, Right-click on DbLocations, select New > Item

b. In the Name textbox enter ProductionData


c.

From the Time Zone combo box select Local Time

d. Click the Browse icon

e. Browse to System > Sources > Db > MsSql > ProductionData


f.

Click OK

314 of 878

g. Click Close

3. Start to configure the queries which will build the model following the steps below
a. Right-click on MbModel (the ModelBuilder instance that you just created)
b. Select Edit

c.

Click Edit Queries

315 of 878

4. Add the script for the root of the model following the steps below
a. Click Add

b. In the Query Name textbox enter Root


c.

Click OK

316 of 878

NOTE: As the order in which the types are made is critical in the model structure, we need
to make sure to add the scripts in proper order (i.e. site before area; area before line, etc.
The Add Before Selected item check box defines where the location of the script in
reference to the current location of the Add request
Note that the Root script place holder is created for us to enter the appropriate script to create
the root part of our model. The place holder also provides information for the format of the script.
d. To save time, instead of typing in the script, we will copy the content of C:\Class
Files\ModelHardCoded\HardcodeRoot.txt and paste it into the editing area.
e. Click Save to save the script.
f.

The Root script should look as follows:

NOTE:
-- Root
Select 'MyMbEnterprise','Core.Folder',NULL,'MyEnterprise','Children'
As it is indicated in the script comment the ordering is important and in this case
<ItemName>: Name of the object to be created in the model= MyMbEnterprise
<itemType>: Name of the Type to create an instance from = Core.Folder <ParentItemType>:Name of the Parent type-Not Required= NULL
<ParentPropertyName>:FQN of the Position in the Model to create the <ItemName>
Translation: Create an instance of Core.Folder type named MyMbEnterprise located right
under MyEnterprise

317 of 878

5. Add the script for the Site part of the model following the steps below
a. Click Add, and in the Query Name textbox enter Site
b. Uncheck the Add Before Selected Item check box
c.

Click OK

NOTE: The site definition needs to be after the Root definition, since the Add operation
started with Root highlighted, we need to uncheck the Add before Selected Item
d. As we did for the root, we will copy and paste the script, this time using the content of the
C:\Class Files\ModelHardCoded\HardCodeSite.txt file
e. Click Save
f.

The Site Query should look as follows:

6. Add the script for the Area part of the model following the steps below
a. Click Add, and in the Query Name textbox enter Area
b. Uncheck the Add Before Selected Item check box
c.

Click OK

318 of 878

d. Copy and paste the script from C:\Class Files\ModelHardCoded\HardCodeArea.txt file


e. Click Save
f.

The Area Query should look as follows:

NOTE: Created an instance of type MyModel.MyArea called Area1 located under


MyEnterprise.MyMbEnterprise.Site1.Areas
The importance of order should be very apparent now. The Site has to be defined
(MyEnterprise.MyMbEnterprise.Site1.Areas) first for this definition to use it in its
configuration.
7. Add the script for the Line part of the model following the steps below
a. Click Add, and in the Query Name textbox enter Line
b. Uncheck the Add Before Selected Item check box
c.

Click OK

319 of 878

d. Copy and paste the script from C:\Class Files\ModelHardCoded\HardCodeLine.txt file


e. Click Save
f.

The Line Query should look as follows:

NOTE: Created an instance of type MyModel.MyLine called Line1 located under


MyEnterprise.MyMbEnterprise.Site1.Areas.Area1.Lines

320 of 878

8. Add the script for the Workcell part of the model following the steps below
a. Click Add, and in the Query Name textbox enter Workcell
b. Uncheck the Add Before Selected Item check box
c.

Click OK

d. Copy and paste the script from C:\Class Files\ModelHardCoded\ HardCodeWorkcell.txt


file
e. Click Save
f.

The Workcell Query should look as follows:

NOTE: Created two instances of type MyModel.MyWorkcell called


Workcell1 and Workcell2 located under
MyEnterprise.MyMbEnterprise.Site1.Areas.Area1.Lines.Line1.Workcells

321 of 878

9. Add the script for the Equipment part of the model following the steps below
a. Click Add, and in the Query Name textbox enter EquipmentOvenType
b. Uncheck the Add Before Selected Item check box
c.

Click OK

d. Copy and paste the script from C:\Class Files\ModelHardCoded\


HardCodeEquipmentOvenType.txt file
e. Click Save
f.

The Workcell Query should look as follows:

NOTE 1:
Created two instances of type MyOven.Oven called M1Oven, and M2Oven located under
MyEnterprise.MyMbEnterprise.Site1.Areas.Area1.Lines.Line1.Workcells.
Workcell1.Equipment
and
MyEnterprise.MyMbEnterprise.Site1.Areas.Area1.Lines.Line1.Workcells.
Workcell2.Equipment

NOTE 2: The respective Zone1Temp through Zone4Temp for each of the two ovens
(M1Oven and M2Oven) are defined and in this case we just happen to choose the ones
reference by the Tag Provider. Depending on your application you might have chosen the
Live Data, or the Historian referenced ones.

322 of 878

10. Add the script for the Machine part of the model following the steps below
a. Click Add, and in the Query Name textbox enter EquipmentMachineType
b. Uncheck the Add Before Selected Item check box
c.

Click OK

d. Copy and paste the script from C:\Class Files\ModelHardCoded\


HardCodeEquipmentMachineType.txt file
e. Click Save
f.

The Workcell Query should look as follows:

NOTE 1:
Created two instances of type MyMachine.Machine called Machine1, and Machine2 located
under
MyEnterprise.MyMbEnterprise.Site1.Areas.Area1.Lines.Line1.Workcells.
Workcell1.Equipment
and
MyEnterprise.MyMbEnterprise.Site1.Areas.Area1.Lines.Line1.Workcells.
Workcell2.Equipment

323 of 878

NOTE 2: The respective BatchID, MachineID, and ProductCode of each of the two
Machines under their created instance (Machine1, and Machine2) are added. We just
happen to choose the ones reference by the Tag Provider. Depending on your application
you might have chosen a different source.
11. The Query Collection should look as follows. The order is critical. If the queries are not in proper
order, select the query that is not in the right place and use the Move Up, and Move Down
buttons to place it in the right location.
While the Move Up and Move Down buttons move queries up, and down, their position is not
saved, until the Save button is clicked on. The Save button however does not get activated
unless something inside the script is changed, so change something in the script, and change it
back to force the Save button to become active, and then click on it to save the location of the
query.

12. Click Close to close the Query Collection Editor

13. Click Build Model

324 of 878

14. If all goes well, you should get a Completed or Idle message after the progress bar is complete
indicating a successful build of the model. Click Close

15. In case, you get build errors, check out C:\inetpub\wwwroot\Incuity\Logging\incuit.log to get
information about possible causes. Another good tool is the query test. . Before we move on lets
take a look at the Test Query feature of the Model Builder. This is particularly handy if your build
did not complete successfully.
a. Click On Edit Queries
b. Click on Test Queries

c.

While all queries are selected, click on Check Syntax, and verify that all selected queries
executed against all selected DBLocations

325 of 878

d. Next run the queries one by one against all the databases (only one in this case). As an
example we are showing the one for Workcell. Hopefully you had no errors, but if you did this
is a useful tool to find the cause of error

16. Verify the Model build operation by following the steps below:
a. In VantagePoint Manager, right-click MyEnterprise and select Refresh
b. You should see MyMbEnterprise. Right-click on it and select Expand All

326 of 878

c.

Verify that when you select the M1Oven, Machine1, M2Oven and Machine2 types that the
Item names are assigned

17. Verify you can return to MbModel in ModelBuilder and rebuild this part of the model again by
following the steps below:
a. Right-click on MyMbEnterprise and select Delete Item

b. Confirm the delete operation by selecting Yes in the subsequent window.


c.

Navigate to System > Sources > ModelBuilder > MbModel

d. Right-click on MbModel and select Build

e. Click Execute in the subsequent window. (the two options do not apply here so leave them
unchecked)
f.

You should see MyMbEnterprise under MyEnterprise again (may need to refresh
MyEnterprise folder

327 of 878

18. Now that we have verified our model builder operation, let save it (or back it up) by exporting all
the queries we entered into a single file by following the steps below:
NOTE: Since we copied and pasted the scripts, this step may not make much sense, but
remember had it not been a class environment, you would have probably typed these
scripts in, and you certainly dont want to type them all back in should anything happen to
the model you just built, or if you have to create a similar model somewhere else.
a. Right-click on MbModel and select Edit

b. Click Edit Queries

c.

Click on Export Queries

d. Save the file in the root C:\ in both TXT and SQL version as MbModel

19. Review the MbModel.txt, and MbModel.sql file which should reflect all the entries that you made
in this lab in two different formats.

Either of these files can be imported to recreate the query collection we created in this lab. We will
show this feature in the next part.

This part is complete


328 of 878

Part B - Using the Model Builder with SQL Scripts that use Database
Tables
In the last lab, you manually created and enterprise model called MyTestEnterprise. In the first part
of this lab we learned an alternate and more enhanced method to achieve the same goal by manually
hard coding the SQL script into Model Builder fields to create the same enterprise model called
MyMbEnterprise. In doing so, we provided a much more flexible environment to create and modify a
desired model.
In this part we will learn yet another way to create the same model (we call it MyTblEnterprise) which
depending on the application can provide a better approach to create a model. For example if you
have many elements, complex relationships, needing a common streamline approach to create a
model, or simply wanting a have a better relational view of what is going on in your model, this
method of building the model might be more appealing.
As we did in the first part, we will use the Model Builder, but this time we will actually run the scripts
against tables in a database. These tables contain all the names which we were manually creating
inside the scripts in the previous approach (first part of this lab).
In this new approach, the tables contain the information about the model elements and their
relationship together defines the structure. For example Site table has all the site names, Area table
has all the area names, and the relationship between the two is defined by its one-to-many construct.
The one table that looks a bit different than the other ones is the one at the bottom of the model,
which is the Equipment under the Workcell. All other tables have their types implicitly defined
because of their position in the model (i.e. Area is of Area type but it was not needed to be stated in
the table as it sits between Site, and Line). The Equipment table however can have many different
types. In our case, for example, we may have Oven types or Machine types. For these reasons, the
Equipment table also contains the equipment type for each equipment entry.
The next two pages provide the relational diagram as well as the table design. Feel free to launch the
Sql Server to take a look at these tables. They are all under the ProductionData database, which by
now, you probably have noticed we have setup for this training. We refer to its various tables for
different part of this training.

329 of 878

Review Tables and Database Diagram (all tables are in ProductionData DB):
These are the tables discussed in the introduction to this part of the lab

330 of 878

Review Tables (all tables are in ProductionData DB):


These are the tables discussed in the introduction to this part of the lab

SiteTable

AreaTable

LineTable

WorkcellTable

EquipmentTypeTable

331 of 878

The next few steps where we create a new instance of the Model Builder is identical to the previous
part.
1. Create an instance of the ModelBuilder called TblModel following the steps below:
a. Launch VantagePoint Manager
b. Navigate to System > Sources > ModelBuilder
c.

Right-click ModelBuilder and select Create Instance

d. In the Name textbox enter TblModel


e. Click Execute

332 of 878

2. Configure the new instance by following the steps below


NOTE: Each Model Builder instance requires a Database connection
a. Expand TblModel, right-click on DbLocations, select New > Item

b. In the Name textbox enter ProductionData


c.

From the Time Zone combo box select Local Time

d. Click the Browse icon

e. Browse to System > Sources > Db > MsSql > ProductionData


f.

Click OK

333 of 878

g. Click Close

3. Start to configure the queries which will build the model following the steps below
a. Right-click on TblModel (the ModelBuilder instance that you just created)
b. Select Edit

c.

Click Edit Queries

334 of 878

4. In the previous lab, this is where we started to put the scripts in one by one. These scripts are
available both in individual file as well as the all in one exported version in the C:\Class
Files\ModelTable folder. Since we did the one by one approach in the previous lab, we will use
the all in one import approach this time. First we will examine the file in Windows to get familiar
with its query content to see how they build the entire model by querying the table discussed at
the beginning of this part of lab.and then will import the queries.
a. In Windows Browse to C:\Class Files\ModelTable and select TblModel.txt (double click or
click on Open)
b. Note that how the scripts are building the entire model
c.

THERE IS A SIMPLE INTENTIONAL MISTAKE in this script. Can you find and correct it?

d. Did you find the mistake? If not, remember what we have emphasized in this lesson which is
the critical role of the order in which the model is built. You note that the Area and Line script
block are out of order, please put the Area block before the Line block and save the file.
e. Back in the Editor, Click Import Queries

f.

Browse to C:\Class Files\ModelTable and double click TblModel.txt

335 of 878

g. You should have all the scripts imported and in proper order. As you note they look very
similar to the ones we did in the previous part. Upon closer inspection however you notice
that all the scripts here are against the tables we discussed at the beginning of this part

NOTE: Inspect these scripts with the table structure and diagrams we discussed at the
beginning of this part in mind and see how simply this tool builds the entire model. While
simple however, you also note how it can very rapidly build complex model by simply
adding more content to the respected tables.

336 of 878

5. Close the Query Collection Editor and build the model by following the steps below:
a. Click Build Model

b. Verify the Model was successfully built and completed (if not as we discussed earlier test the
queries, and check the information in the C:\inetpub\wwwroot\Incuity\Logging\incuit.log)
c.

Click Close

337 of 878

6. Verify the Model build operation by following the steps below:


a. In VantagePoint Manager, right-click MyEnterprise and select Refresh
b. You should see MyTblEnterprise.
c.

Right-click on it, select Expand All, and verify that the model was built as indicated below

As you note the entire model, some branches more, some branches less (depending on the
content of the tables in the DB) is all created
Also Note that at this point, the Ovens and Machines in each Workcell have Not Specified
identified for their tags. This is because the Equipment Type is expecting tags as properties, but
the tags for these properties have not been defined yet (you will in next section).

338 of 878

Part C - Adding Type Items to an Existing Model


In the previous part, you noted that the Ovens and Machines were not defined. This is in contrast with
the two earlier methods when we created the model, and these equipment were defined.
This is because the expected tag properties for these equipment were defined as part of the model in
the earlier two methods of model creation (refer to Equipment definition for example in Part A of this
lab).
We intentionally did not do this in this part to introduce another concept which is adding types to and
existing model. We will be use ModelBuilder to add the Items to the Equipment Type we added to the
model in the previous part of this lab.
The next few steps where we create a new instance of the Model Builder are identical to the previous
part.
1. Create an instance of the ModelBuilder called MapItem following the steps below:
a. Launch VantagePoint Manager
b. Navigate to System > Sources > ModelBuilder
c.

Right-click ModelBuilder and select Create Instance

d. In the Name textbox enter MapItem


e. Click Execute

339 of 878

2. Configure the new instance by following the steps below:


NOTE: Each Model Builder instance requires a Database connection
a. Expand MapItem, right-click on DbLocations, select New > Item

b. In the Name textbox enter ProductionData


c.

From the Time Zone combo box select Local Time

d. Click the Browse icon

e. Browse to System > Sources > Db > MsSql > ProductionData


f.

Click OK

340 of 878

g. Click Close

3. Start to configure the queries which will map the needed items following the steps below
a. Right-click on MapItem (the ModelBuilder instance that you just created)
b. Select Edit

c.

Click Edit Queries

341 of 878

4. Add the mapping queries for the Oven and Machine equipment type following the steps below:
a. Click Add

b. In the Query Name textbox enter MachineMap


c.

Click OK

342 of 878

d. Copy the content of C:\Class Files\MapTagProperties\EquipmentMachineMap.txt


e. Paste it into the definition field of the MachineMap

The select line defines the type of item to be added (in this case Machine), and the point of
attachment to an existing model which in this case is below the Equipment in the Model
hierarchy. Please note that that functionally this is the same thing we have been doing all along.
In the other case, it just so happened that we attached the model to the very top (i.e.
MyEnterprise)
The three items under each machine provides the FQN for the data source. In this case we chose
the Tag provider path to the target data. Depending on your application and available path, this
could have very well been a live data or a historian path to the same data.

f.

Click Save to save the query

g. Click Add to add the next query

343 of 878

h. In the Query Name textbox enter OvenMap


i.

Click OK

j.

Copy the content of C:\Class Files\MapTagProperties\EquipmentOvenMap.txt

k.

Paste it into the definition field of the OvenMap

l.

Click Save to save the definition

The select line defines the type of item to be added (in this case Oven), and the point of
attachment to an existing model which in this case is below the Equipment in the Model
hierarchy. Please note that that functionally this is the same thing we have been doing all along.
In the other case, it just so happened that we attached the model to the very top (i.e.
MyEnterprise)
The four items under each oven provides the FQN for the data source. In this case we chose the
Tag provider path to the target data. Depending on your application and available path, this could
have very well been a live data or a historian path to the same data.

344 of 878

5. Click Build Model.

a. Verify that the Build Process was successfully completed (if not, as we discussed in the
previous part, test the queries, and check the information in the
C:\inetpub\wwwroot\Incuity\Logging\incuit.log)
b. Click Close

345 of 878

6. Verify the addition of the Oven and Machine tag information to the MyTblEnterprise model by
following the steps below:
a. Right-click on My Enterprise and select refresh
b. Navigate all the way to Equipment folder under either of Line 1 Workcells
c.

Check M1Oven, Machine1, M2Oven, and Machine2. They should all now have tag
information. Check out their properties and see how their FQN matches what he had entered
for their corresponding scripts.

As we have added a bunch types to the system, it is a good idea to reset the IIS by running
IISRESET (Start > Run and then type IISRESET)

This lab and lesson is complete

346 of 878

Lesson 10 Importing Logix Controller Structures


as VantagePoint Items

What you will learn:

Import CLX User-Defined Data Types (UDT) to VantagePoint


Learn one way to address the unique type name requirement in the import process should it
be needed.
Highlight the significance of how a well-structured design on the controller side can ease the
VantagePoint Implementation

Prerequisite:

Completion of Lesson 2
Understanding of the concepts discussed in Lesson 9 (types)

Having learned the critical and fundamental role that model, and types play in VantagePoint, in this
lesson we will learn how ControlLogix powerful User Defined Table (UDT) feature is leveraged by
VantagePoint to automatically create types matching the UDTs in the ControlLogix during the import
process. In doing so, the entire process of creating types, instances, etc., is eliminated when it comes
to ControlLogix UDTs.

Discussion
In VantagePoint, Logix controller structures can be imported as VantagePoint items. This is a very
powerful feature, as not only types matching both the systems as well as user defined structures are
automatically generated, but also all the instances of the these structures are imported as instances
of the newly created types in the VantagePoint. In the absence of this feature, types and mapping
rule as well as instances of these types have to all be manually created (using one of many methods
we learned in the previous lesson).
To find the data type and instance definitions of the OPC tags, VantagePoint uses the controller
programs ACD file. In that file there is an XML string that gets extracted and parsed to find the
definitions. The mapping rules are then applied and the OPC structures become VantagePoint
instances in the model.
Logix controller structures can be imported as known items, local items, or legacy content.

347 of 878

Importing Logix Controller structure as known items


For Logix controller structures imported as known items, standard definitions already exist in
VantagePoint under System.Common.Connectors.FactoryTalk.ImportRules. The controller
structures are imported using existing types and mapping rules. They are mapped onto VantagePoint
standard types. The advantage of this type of import is that VantagePoint built-in reports work
automatically against these types.
Importing Logix controller structure as local items
For Logix controller structures imported as local items, no standard definitions exist in VantagePoint.
Local types and mapping rules are created in VantagePoint to create the mapping rules. The import
process is performed dynamically. There is a 1:1 relationship between the Logix controller structure
and the VantagePoint type. Each structure is mapped onto a unique type created by VantagePoint.
Importing Logix controller structure as legacy content
Some Logix controller structures that had no standard definitions existing in VantagePoint used to be
imported to VantagePoint versions lower than 4.0 as the generic user-defined type (Logical.UDT).
These structures can still be reimported to VantagePoint using the Logical.UDT type.
NOTE: Mapping rules are set of predefined relationships between VantagePoint types
and Logix controller data types. VantagePoint includes some built-in controller mapping
rules. Users can create additional rules.

348 of 878

Lab 1 - Review ControlLogix Structures


In this lab we will look at few of the ControlLogix structures and their instances to get a better
understanding of what takes place during the import process.
1. Verify that you are on the Server Image (Server tab is selected).

2. Go online with the controller in Slot 2 by following the steps below:


a. Open the RSLogix 5000 Program C:\Class Files\CLX Programs\
CLX_Hott_2012_BL1_v16.ACD by double clicking on it

b. In RSLogix5000, Go online with the controller in Slot 2 by selecting Communications>Go


Online

349 of 878

c.

If the Connected To Go Online dialog box appear, click on Download

d. If the above step did occur, click on Download on the Download confirmation dialog box

e. Once download is complete, change controller mode back to Remote Run by clicking on Yes

350 of 878

3. Take a look at User-Defined types in this program by navigating to Data Types > User-Defined.
These are all the UDTs defined in this particular program. They are functionally analogues to the
types we created in VantagePoint in the previous lesson. As you note the words UDT have no
significance in the name (some have it, some dont) but more of a good naming convention to use
to identify these types.

4. Observe the structure for a few of these UDTs by following the steps below:
a. Observe PumpUDT structure by double clicking on it. Note how similar conceptually this is to
what we were doing when creating types. This is a data type consisting of four members
each of float type.

351 of 878

b. Observe MachineUDT structure by double clicking on it. Youll note that this is a type
consisting of six elements with varying string, Real, DINT and Boolean types.

5. Take a look at system or predefined types (part of the package and not user defined) by
navigating to Data Type > Predefined.
You will note that there is a rich set of data types for various structures (i.e. alarms, PID, Function
Block Diagrams, Motion, Safety, etc.).

As we did for UDTs, take a look at few of these. Youll note that structurally there is no difference
between these and the UDTs (they both have Name, Data Type, Style, Description and External
Access parameter). These just happen to be predefined whereas the UDTs are user defined

NOTE: These data structures will be exposed during the structure import process, and if
selected, Types of same name and structure will be automatically created on the
VantagePoint side.

352 of 878

6. Before going back to VantagePoint lets observe an instance of a type as well by following the
steps below:
a. Navigate to Tasks > MainTask > Mixer > Program Tags and expand a variable called
Mixer_Machine which is of a type MachineUDT (the type we just observed).

b. Please note that Mixer_Machine is an instance of MachineUDT type and this particular
instance has the highlighted value. As you note, this is a very similar paradigm as Type and
instance of a type in VantagePoint which we explored in the previous lesson.
c.

Please further note, that if we do not do a structure import, Mixer_Machine.MachineID and


other member of this Mixer_Machine instance will be imported as non-structured or simple
live data information in the same way the zone temperatures were imported in earlier part of
this training. In another word they will be tread as individual tag of their respected type (i.e.
Mixer_Machine.MachineID of type string) and not as a member of an instance of a
MachineUDT type. As such the rich context of this type will be lost and has to be created
again on the VantagePoint side. As you will see in the rest of this lab, the structure import will
address this very concern.

NOTE: For the rest of this lesson we will use another instance of the MachineUDT which
happens to have the same name as the type (i.e. MachineUDT). Naming an instance of a
type the same as the type is not a very good programming or configuration not to mention
a confusimg practice. We have only chosen to do so here for the sake of the training as a
reminder that this variable and few more that we will use here in this training are instances
of CLX User-Defined data Types.

7. Close Logix 5000.

This lab is complete


353 of 878

Lab 2 -Importing CLX UDT from Bread Line 1


In this lab we will import all the instances of OvenUDT, and MachineUDT User-Defined data Types
(UDT) from Bread Line 1 processor.
1. Verify that you are on the Server Image (Server tab is selected)

2. Examine the current state of types and their instances before the structure import, following the
steps below:
a. Launch VantagePoint Manager
b. Change the View to Type by selecting Types from the View menu

c.

Observe that there are none of the data types which we just observed in the ControlLogix (i.e.
MachineUDT, PumpUDT, Alarm, etc.)

d. Verify and observe the same thing for Packages view


e. Finally, also look at the instance of the data in the Item View, and note that only
Program:Proof_Oven currently exists as this is the program we imported earlier in this
training. And even within the Proof_Oven only tags containing the string Simple in their
name exist.

354 of 878

3. Select the Live data Structure import option by following the steps below
a. Switch back to Items View ( View > Item )
b. Navigate to System > Sources > FactoryTalk folders
c.

Right mouse click on localhost and select Import

d. Select the I would like to import FactoryTalk Live Data tags


e. Click Next

355 of 878

f.

Select/verify that the I would like to import Logix controller structures as VantagePoint
Items option is selected

g. Click Next

4. Select the controller path, and associated project file for import process by following the steps
below:
a. Expand RA Foods and select BL1
NOTE: To import structures, you must stop at the device shortcut
b. Click Next

356 of 878

c.

Note the information that is conveyed on this dialog box


i. A Logix project file (*.acd) is used to determine the various structures defined in the
controller. As such we need the .ACD file that is running in the controller that we are
importing from
ii. The .ACD file should be located in a network directory accessible from the
VantagePoint server
iii. A unique name is generated for the type package which will be created for this
controller. The name is very cryptic, but you can change it if you wish. If you do, you
need to make sure that it is a unique name.

d. Click the file browser (ellipses) to browse for the .ACD file

e. Browse to C:\Class Files\ CLX Programs


f.

Select CLX_Hott_2012_BL1_v16.ACD, and click Open

357 of 878

g. Change the package name to MyBreadLine


h. Verify pertinent information with diagram below, and click Next

5. Select the structure types to be imported by following the steps below:


a. The first page shows all the standard definitions that already exist in the VantagePoint Model
(the type list is shown on the right in this manual as a reference point). And the dialog box is
asking if we wish to import any instances of these types from the controller.
i. Click on Unselect All as we dont need any of them for the purposes of this lesson
ii. Click Next

358 of 878

b. The next page shows all the data type structures that are in the BL1 ControlLogix but not in
the VantagePoint.

As it is indicated in the text descriptions No standard definition exists in the


VantagePoint model for the following Logix structures in the selected controller. Local
types will be created and used.
Here you get a chance to select the Logix structures that you like to import using local
types and mappings that are limited to this controller. Local types and mappings will be
created if necessary. All INSTANCES of the SELECTED structures will be
imported

NOTE: You can select any of the structures and click on Member Settings to see their
structure.

i. Click Unselect All


ii. For now, we are only interested in instances of MachineUDT, OvenUDT, and
PartHistoryUDT so we just select them
iii. Click Next

359 of 878

c.

Select the No, thank you option

d. Click Finish

6. An Importing Live Data tags dialog will appear during the import

7. Verify that the import was successful and click OK

360 of 878

8. Verify the import process by following the steps below:


a. Remember that up to now we only had a few tag containing simple in their name which
should still be the case for BL2 as a reference point
b. Expand the System > Sources > FactoryTalk > localhost > Applications > RA Foods >
BL1 > Online, and compare it to BL2 > OnLine. As you note the import process have
brought in what we had requested along with their associated hierarchy

361 of 878

c.

Expand the folders under BL1 and note how every instance of the three types that we
selected (MachineUDT, OvenUDT, and PartHistoryUDT) has been imported from all
programs in the BL1 CLX

d. Since instances of MachineUDT are one set of instances we imported, lets look at an
instance of MachineUDT in the Mixer Program. Expand Program:Mixer and select
Mixer_Machine which is one of the instances of MachineUDT

362 of 878

NOTE: Mixer_Machine is of type MyBreadlLine.MachineUDT which is automatically


generated through the import process eliminating the task of creating this type which a
user would have to do otherwise
e. All the element of Mixer_Machine is imported as well, since this is an instance of
MachineUDT type in the ControlLogix, and the instantiation is automatically duplicated
through the import process. This feature eliminates the tasks of creating mapping rule, and
instance of the type which a user would have to do in the absence of this import feature.

363 of 878

9. Aside from automatic creation of the type, and instance of the type, the import process had to
create mapping rules to accomplish what you just observed. These mapping rules would also
have to be created in the absence of this ControlLogix structure import feature.
a. Navigate to

Sources > FactoryTalk > localhost> System > Import Rules > Applications > Ra
Foods

b. Expand both BL1 and BL2 and compare the two folders to see what was created through the
CLX Structure Import process

364 of 878

c.

Expand the MachineUDT Import Rule to see how it was configured.

d. Select one of the members (i.e. BatchID) to see how it is mapped.

10. Now that all the ControlLogix Types and instances of the types are all automatically generated,
we can leverage them in all the various ways which we discussed in Lesson 9.
Note: The ControlLogix Structure import feature is a tremendous time saver in creating
type, Mapping Rules, and instantiation of selected CLX instances in VantagePoint.
Currently however, there is one caveat in this automated type and instance generation. For
example, If you have identical types in multiple controllers which you wish to leverage in
typed reports, this feature right out of the box will not help you, since the types that it
generates are tied to the individual ControlLogix (as you might have noticed by the unique
name that it generated). Hence even for an identical UDT in two different controllers,
VantagePoint will generate two types. This will hinder the process of a typed report for
example.
Having said that, with minor modifications (i.e. exporting, modifying, and reimporting of
the types/instances this issue can be addressed, so even with this caveat, the feature
provides a very valuable time saving service
In the latter part of this lesson, after we import Line 2 UDT instances, we will explore one
of the ways that this caveat can be addressed so this great feature can be leveraged to
create instances for type mapped reports.
11. By the way, remember we made a shortcut to Program:Proof_Oven folder up in the Logical
model. Check it out and note that all the new entries under the Proof_Oven after the import is
reflected up there.

This lab is complete

365 of 878

Lab 3 -Importing CLX UDT from Bread Line 2


In this lab we repeat the exact steps in the previous lab to import all the instances of OvenUDT, and
MachineUDT User-Defined data Types from Bread Line 2 processor.
1.

Verify that you are on the Server Image (Server tab is selected)

2. Select the Live data Structure import option by following the steps below
a. Launch VantagePoint Manager
b. Navigate to System > Sources > FactoryTalk folders
c.

Right mouse click on localhost and select Import

d. Select the I would like to import FactoryTalk Live Data tags


e. Click Next

366 of 878

f.

Select/verify that the I would like to import Logix controller structures as VantagePoint
Items option is selected

g. Click Next

3. Select the controller path , and associated project file for import process by following the steps
below:
a. Expand RA Foods and select BL2
NOTE: To import structures, you must stop at the device shortcut
b. Click Next

367 of 878

c.

As we did in the previous lab, click on File Browser button (ellipsis), and select

C:\Class Files\CLX Programs\CLX_Hott_2012_BL _v16.ACD

d. Rename the Package File to MyBL2


e. Click Next
NOTE: You might be tempted to keep the same name as we did for BL1 (MyBreadLine) to
address the potential caveat in the import process we discussed in previous lab when we
have identical programs in various CLX (which is the case here). This will not however
work, as the import process requires a unique package name

368 of 878

4. Select the structure types to be imported by following the steps below:


a. The first page shows all the standard definitions that already exist in the VantagePoint Model
b. As we did for previous lab, click on Unselect All since none are needed for this lesson.
c.

Click Next

369 of 878

d. The next page shows all the data type structures that are in the BL2 ControlLogix but not in
the VantagePoint.
i. Click Unselect All
ii. For now, we are only interested in instances of MachineUDT,
PartHistoryUDT so we just select them
iii. Click Next

e. Select the No, thank you option


f.

Click Finish

370 of 878

OvenUDT, and

5. An Importing Live Data tags dialog will appear during the import

6. Verify that the import was successful and click OK

7. Note that now just like BL1, BL2 is populated with all the data points created by the import
process. All the instances of MachineUDT, OvenUDT, and PartHistoryUDT but his time from
BL2 are all imported
Since the two programs in BL1, and BL2 are structurally identical, with same number of UDT
instances of the three UDTs selected, the two folder should look identical

371 of 878

8. Create a shortcut to BL2 Program:Proof_Oven under BL2 in the logical part of the model
(similar to what we did for BL1 earlier in the training)
a. Navigate to System>Source>FactoryTalk>Localhost>Applications>RA
Foods>BL2>Online
b. Right-click on Program:Proof_Oven, and select Copy

c.

Navigate to Enterprise>MyPlant>Tags>BL2

d. Right-click on BL2, and select Paste Shortcut

372 of 878

e. Tags folder under MyPlant should look as follows which makes accessing the tags for the
various lab a little easier.
f.

Also as it was mentioned earlier, the BL1 shortcut to Program:Proof_oven created earlier in
this training, being a shortcut, reflects all the changes that was just made to this folder
because of the structures import activity.

Congratulations! Using the Import structure process, you rapidly imported all the instances of
requested UDTs without having to manually creating mapping rules, types, and instantiating them.

This lab is complete

373 of 878

Lab 4 Quick Trend Test of the Imported CLX UDT


Instances
In this lab, we use the trend tool to make sure all the UDT instances we just imported are working
properly. We will trend MachineUDT from Line 1 and Line 2 in the same trend plot
1. Verify that you are on the Server Image (Server tab is selected).

2. Launch VantagePoint Trend.


3. Trend the element of Line1s Proof_Oven MachineUDT (BatchID, MachineActive, etc,) on a
single plot by following the steps below:
a. Navigate to MyEnterprise>MyPlant>Tags>BL1>Program:Proof_Oven
b. Grab MachineUDT and drag in onto plot surface

NOTE: By dragging the instance of the type, all it sub-elements were dragged onto the
plot automatically.

374 of 878

4. Trend the element of Line2s Proof_Oven MachineUDT (BatchID, MachineActive, etc,.) on the
same plot as Line 1 by following the steps below:
a. Navigate to MyEnterprise>MyPlant>Tags>BL2>Program:Proof_Oven
b. Grab MachineUDT and drag in onto plot surface

c.

Activate Live Mode, and select Stack Y-axis

375 of 878

5. Your trend should look as follows. Numerical elements are trended, and string ones are
represented by small triangles. Hovering over the triangle provide the information for that
particular time stamp as shown in the diagram below:

a. As a final check to make sure all the wirings are properly done through the import process
put BL2 processor into program mode and observe the trend behavior by following the steps
below:
NOTE: Obviously we are doing this for training purposes. We would not have this type of
luxury in the field!
b. Launch the SoftLogix 5800 Chassis monitor by clicking on its icon in systray

376 of 878

c.

Right-click on the SoftLogix Processor in slot 3 (BL2) and select Program mode

d. Click Yes on the confirmation window

e. You BL2 related points should not change anymore.

377 of 878

6. Since we are going to use this trend again soon, save / publish it by following the steps below :
a. Click File > Publish

b. Navigate to MyEnterprise > MyPlant > Reports


c.

In the Name field type in Proof Oven Machine UDT Trend

d. Click Publish

This lab is complete

378 of 878

Lab 5 Addressing the Import Structured Tags


Unique Type Name Issue
This lab discusses a possible concern in cases that one wishes to leverage identical UDT types in
multiple controllers.
In this lessons previous labs previous labs, we saw how the ControlLogix Structure import feature
facilitates the process of creating mapping rules, types, and instantiation of these types. We also
observed that for any given Controller, the import tool creates a unique type package.
The unique type package should not have any consequences unless you have identical structure in
multiple controllers, AND you wish to leverage those identical structures in your application
development i.e. typed map reports.
For example let say that you wish to create an oven temperature reports for all the ovens in your
project. This might be an approach that you would follow:
1. Create a UDT in CLX, which contains all the needed temperature information
2. Instantiate the created UDT for all the ovens.
3. Perform a Structure Import which would create the VantagePoint version of the UDT and all the
instances of that type.
4. Create a typed map report based on the type which was just generated
The above process would work so long as all the instances of the oven are in the same controller. If
not, because of the way the import utility creates a unique type, the VantagePoint version of the type
would be different for each PLC, even though the UDT in each PLC might be the same. Needless to
say, once the names of the types are different, even if their structure is identical, the typed map report
cannot be created (as the name suggest these reports are mapped to a type).
Fortunately the premise of this issue, which is the identical UDT, provides few relatively simple
solutions to get around it. Since the assumption is that the UDTs are identical, all we need to do is to
re-type the types of the variables (tags) that we are interested in. This can for example be done by
exporting the structures of interest, change their type affiliation and reimport them back in. It has to be
emphasized that the solution is this simple, solely because of the assumption (identical UDTs). In
doing so, we still take advantage of all the time saving that the tool provides us (Instantiation,
Mapping Rules, etc.) and then we just simply change the type.
In this lab, we will walk through the process just outlined to make the type associated with the Line2
Proof Oven UDT (MyBL2) the same as the type associated with the Line1 Proof Oven UDT
(MyBreadLine). In doing so, we can then take advantage of the capabilities associated with good
modeling discussed in lesson 9 and further explored in subsequent and upcoming lessons.

379 of 878

1. Verify that you are on the Server Image (Server tab is selected).

2. Verify the current type configuration for MachineUDT, OvenUDT, and PartHistoryUDT
instances in BL1 which we imported in earlier labs by following the steps below:
a. Launch VantagePoint Manager
b. Navigate to System>Sources>FactoryTalk>LocalHost>Applications>RA
Foods>BL1>Online>Program:Proof_Oven
c.

Click on MachineUDT, OvenUDT, and any of the elements under PartHistoryUDT one at a
time and observer their type under Properties tab as shown below

NOTE: The type as expected for all three is MyBreadLine since this is the type we entered
when a unique type name was requested during the import process.
NOTE: Verify the FullyQualifiedName (highlighted in yellow) by expanding the Value
column and do note that all three, again as expected, are pointing to tags in Bread Line 1
(BL1)

380 of 878

3. Repeat the above step but this time for Bread Line 2. Verify the current type configuration for
MachineUDT, OvenUDT, and PartHistoryUDT instances in BL2 which we imported in earlier
labs by following the steps below:
a. Navigate to System>Sources>FactoryTalk>LocalHost>Applications>RA
Foods>BL2>Online>Program:Proof_Oven
b. Click on MachineUDT, OvenUDT, and any of the elements under PartHistoryUDT one at a
time and observer their type under Properties tab as shown below
NOTE: The type as expected for all three is MyBL2 since this is the type we entered when a
unique type name was requested during the import process.
NOTE: Verify the FullyQualifiedName (highlighted in yellow) by expanding the Value
column and do note that all three, again as expected, are pointing to tags in Bread Line 2
(BL2)

381 of 878

4. Export Bread Line 2s Proof Oven structure by following the steps below:
a. In VantagePoint Manager, select Export under the File Menu (File > Export)

b. Navigate to System>Sources>FactoryTalk>LocalHost>Applications>RA
Foods>BL2>Online and select Program:Proof_Oven
c.

Click on > to select BL2s Program:Proof_Oven type information to be exported

d. Click Next

e. Type in C:\BL2_ProofOven in the export file field (arbitrary name and location)
f.

Click Next

382 of 878

g. Verify the successful completion and observe the export file name and location.

5. Modify the exported file to change the Type cast of the Proof Oven instances from MyBL2 to
MyBreadLine by following the steps below
a. Rename the just exported file from C:\BL2_ProofOven.ICP to C:\BL2_ProofOven.ZIP and
click Yes on the Rename warning window.
b. Right click on C:\BL2_ProofOven.ZIP, select Open With and click on Windows Explorer

c.

The content should look as follows which includes not only the instances we exported but
also the supporting type(s) needed for the exported instance. Explore the folders to see the
included instance package(s) (.IIP), and the type package(s) (.ITP).

NOTE: Observe the content of the exported file. There is not only the instance which we
exported (in the InstancePackage folder) but also the needed type for the exported
instances (in the TypePackages folder. The inclusion of the type package makes the
entire export package very portable, as it can be imported into the other systems, and
should the type be needed the type is also in the package to be imported.
NOTE: In the next few steps we will modify the InstancePackage.iip. To do this we have to
extract the file from the compressed file (just renamed to zip), edit it and put it back into
the zip file to be imported in the next step. There are many ways to do this. The following
procedure is what we have decided to use; it can certainly be done in other ways as well.

383 of 878

d. Open InstancePackage folder and Drag InstancePackage.iip file onto the desktop.
e. Drag InstancePackage.iip onto the XML Notepad 2007 shortcut to open it.

f.

Before getting on with renaming the file lets take a look at few items of interest in this file.

g. Expand the folders under the Tree View tab and note the type packages required for the
instances included in this instance package file, one of which is MyBL2.Package

h. Click on XSL Output tab

384 of 878

NOTE: The information that you saw in the property tab of each instance in VantagePoint
Manager is all outlined in this XML file (FQN, member properties, required types, etc.),
some of which is highlighted in the diagram below:

i.

Click on TreeView tab.

j.

Select Replace under Edit menu ( Edit > Replace )

k.

Fill out the fields as shown and click on Replace ALL to replace all instances of MyBL2 with
MyBreadLine

l.

Close the Replace window (there is no OK/Close button so the X in the upper right corner
must be used!!)

m. Inspect the same area of the file we did earlier and note that all the type castings are now
redirected to MyBreadLine
n. Save the file (File > Save), and close it

385 of 878

o. Move the InstancePackage.iip file which we just modified back into the folder
(InstancePackage) in the compressed file (BL2_ProofOven.zip) which we extracted it from.
p. Select Copy and Replace in the confirmation window.

q. Close Windows Explorer which is showing the content of the BL2_ProofOven.Zip file
NOTE: Since we changed the type in this instance package, we would typically include the
supporting type in the package as well which in this case would be MyBreadLine. To do
that we would include the MyBreadLine.itp file in the TypePackages folder of the ICP file).
In this particular case, however, since MyBreadLine already exist and we did not modify it,
we do not need to include the MyBreadLine.itp file in the package.
6. Import the modified Type and instance package (.ICP) file back into VantagePoint following the
steps below
a. Rename BL2_ProofOven.ZIP file back to BL2_ProofOven.ICP
b. In VantagePoint Manager navigate to Breadline #2 Proof Oven area
System>Sources>FactoryTalk>LocalHost>Applications>RA
Foods>BL2>Online>Program:Proof_Oven
c.

Make sure you are under BL2 branch and Delete MachineUDT, OvenUDT, and
PartHistoryUDT instances

d. Select Import under the File Menu ( File > Import )

386 of 878

e. Browse and select C:\BL2_ProofOven.ICP file


Note the item list included in the package that the tool is informing us about.
f.

Click Next

g. Read the four available options which dictates how the import request would be processed.
Since we want to recast these variable and essentially overwrite any old instances, we need
the Add option.
h. Make sure it is ADD, if not uncheck the Keep the and select Add

7. Repeat the first few steps of this lab to make sure that the MachineUDT, OvenUDT, and
PartHistoryUDT under BL2 are all now of the same type as BL1 which is MyBreadLine
8. If interested, check out MachineUDT and PartHistoryUDT under BL2s Program:Mixer and
Program:Packaging folders. You will note that those are still of type MyBL2 which is what we
should expect as we only change the types in the proof Oven area
As a reminder, the purpose of this lab was to show you one way to address a possible concern about
the unique type requirement of the structured tag import. The unique type package should not have
any consequences unless you have identical structure in multiple controllers, AND you wish to
leverage those identical structures in your application development i.e. typed map reports.
This lab showed how we could still take advantage of the tool and with minor modification leverage
what a good structured environment can offer.

This lab and lesson is complete


387 of 878

This page intentionally left blank

388 of 878

Lesson 11 Excel Cascading Reports

What you will learn:

How to cascade from one report to another report


How to pass parameters to Excel and Trend reports using the Linked Report function in
FTVP
Create a Trend report to pass Excel report data into
Add a hyperlink to an existing Excel report
Review and use advanced parameter passing including start and end times and passing
values between Excel reports

Prerequisite:

Understanding of Lessons 5 and 9. We also use reports generated in lesson 9, but if you did
not complete Lesson 9, you can use the report from the completed folder.

Discussion
Excel Office Add-In
Please refer to the discussion section of lesson 5 for refresher on the VantagePoint add-in for Excel

Link to an Existing Report


One of the VantagePoint Excel Add-In Functions is Link to a Report. This function puts a hyperlink in
an Excel spreadsheet intended to launch a separate report and and potentially pass parameters to it.
Once this Function is selected, a wizard walks you through the following process:

Determine the Target Report for the hyperlink.


Determine the text for the hyperlink. This can be a text or a content of a cell
When linking to an existing report, the Function Options page allows you to configure any
parameters that may exist in the target report using one of the following methods:
1. Use a parameter that exists in this workbook. This option displays when the function
determines there are possible values on an existing workbook sheet. Selecting this option
will open an Existing parameters dialog with a drop-down list for selecting a parameter:
2. Browse the model. This option will open the Model Browser for navigating to a valid
parameter.
3. Use the default values. Use the values provided when the original report was built.

389 of 878

4. Select cells containing one item. This option displays when the function determines there
are possible values on an existing workbook sheet. Selecting this option will open a field
with a browse button for selecting a cell in the worksheet. If the function detects that more
than one item can be selected, you will be prompted to select a range of cells.
When finished, the link on the Excel spreadsheet will appear similar to the following:

In this lesson we create few reports to explore cascading possibilities.


Regardless of the complexity of the reports, It is a best practice to have a top to bottom view of the
report progression when DESIGNING the reports but to IMPLEMENTE them from bottom to top. This
is to create cascading reports in a reverse hierarchical order, creating the last target report first, and
build reports in reverse order until building the very first calling report last.
Creating the reports in this order will define the parameters needed for each report that needs to be
satisfied by the calling report. The simple diagram below illustrates this concept:

In this case, Report 3 has to be created first so its external parameter requirements (parameters d, e,
and f) can be identified. Once parameter d, e, and f are defined, then report 2 can be created to
provide the needed parameters to report 3. Obviously Report 2 could not be fully created if the
report3 requirements were not known. This same concept is cascaded upward.
In short, while the design in this case is top down from Report 1 to 3, the implementation is bottom up
from 3 to 1.

390 of 878

Lab 1 Create a dynamic Excel Report linked to a


dynamic trend report
In this lab we will create an excel report which display the Min and Max temperature information for
the four oven zone for a user selectable Line. The user can then get further details on the four zones
temperatures for the selected line by drilling through a hyperlink to a trend which provides zone
temperature profile for the selected line
The diagram below depicts the final intent of this lab:

391 of 878

Part A Create the trend template report for zone temperatures


As discussed in the introduction of this lesson, we are going to implement this project form bottom up.
As such we will create the trend report which will be called by the excel report.
1. Verify that you are on the Server Image (Server tab is selected)

2. Create a template trend report by following the steps below:


a. Launch VantagePoint Trend

Start>All Program>Rockwell Software>FactoryTalk VantagePoint >Trend

b. Navigate to MyEnterprise>MyPlant>Tags>BL1>Program:Proof_Oven
c.

Drag SimpleTempZone1 and SimpleTempZone2 Items onto the plot surface

NOTE: It is not important which tags you use. We need to add tags to configure the trend.
We will be passing the trend a different set of tags using parameters

392 of 878

3. Configure the trend to activate X-axis cursor, and stack the Y-Axis following the steps below:
a. Select the X-axis Cursor icon
b. Select the Stack Y-axis icon

4. Publish the trend to a report called Zone Temp Trend in MyEnterprise>Myplant>Reports


folder, following the steps below:
a. Select Publish under File menu: File > Publish

393 of 878

b. Navigate to Browse from the MyEnterprise folder to the Report folder


c.

In the Name textbox enter Zone Temp Trend

d. Click Publish

5. Close VantagePoint Trend

394 of 878

Part B Create a dynamic Excel report with selectable line and drill
through capability to zone temperature detail trend
We will continue on with our bottom up implementation approach, and in this part, create a type
mapped report (also called dynamic, or parameterized report) to show Min and Max temperature
information of the four oven zones for a user selectable line. We further add a hyperlink which will
pass the tags for the four temperature zones to the trend template report we created earlier to get
further details on the Zone temperature profile.
1. Retrieve the BL Min and Max Zone Temp V2 report from VantagePoint into Excel by following
the steps below:
NOTE: If you did not get a chance to create this report in Lesson 9, get the report from the
C:\Class Files\VP Completed\Excel Completed Report
a. Launch Excel: Start > All Programs > Microsoft Office > Microsoft Office Excel 2010
b. Click Open under VantagePoint Add-in ribbon

c.

Navigate to MyEnterprise > MyPlant > Reports, Double-click on BL Min and Max Zone
Temp V2, to open it

395 of 878

2. Setup a hyperlink to the Trend Report we created in the previous part, following the steps below:
a. Select the ReportChart sheet
b. Select cell H6
c.

Select Insert Function from the VantagePoint Ribbon

396 of 878

d.

In the Options window select Link to a Report

e. Click Next

f.

Click the Target report browse button

397 of 878

g. Navigate through MyEnterprise> MyPlant >Reports


h. In the Item name list select Zone Temp Trend
i.

Click OK

TIP: You could have also pick this report directly from the Target report drop down list
j.

For the Text to Display type in Temperature Profile

k.

Click Next

398 of 878

3. Configure the parameter passing by following the steps below:


NOTE: The two tags that we configure for the trend show up under the Current values of
the selected parameter. This information is retrieved from the trend report which we
selected in previous steps of this wizard.
a. Select the Tags Parameters Modify button

NOTE: In the next few substeps, we are going to pass the zone temperature being shown in
the excel report to the trend. We will do this by modifying (replacing the two tags with the four
being shown in the model.) Since we wish these tags themselves to be dynamic (depending
on the line selected by the parameter list) we will get them from the parameter sheet of the
report. If we use the browse the model option, the tags would be fixed to whatever we
selected and not dynamic.
b. Select the Select cells containing Items option
c.

Click the Cells containing Items browse () button

399 of 878

d. Select the Parameter sheet


e. Select rows B1 to B4
NOTE: These rows contain the parameter (addresses) we will pass to the Zone Temp
Trend report
f.

Click OK

g. The Specify Values window should look as follows. Click OK

400 of 878

4. The Function Option window should look as follows. Click Finish

5. You should now have a hyperlink called Temperature Profile (what we typed I a few steps ago) in
your report

6. We can click on the link to test it, but lets publish it to save it and test it from the portal. Publish
the report following the steps below:
a. From the VantagePoint ribbon, select Publish to publish the report to portal

401 of 878

b. Verify that the A report with parameters option is selected


c.

Click Next

d. These parameters are the same as before and are set the way we want them, so click Next

402 of 878

e.

Navigate to MyEnterprise >MyPlant>Reports

f.

Type in BL Min and Max Zone Temp V3 for the file name

g. Click Next

h. Check the Browse to published report check box


i.

Click Finish

NOTE: It may take several seconds for the portal to open

403 of 878

7. Your brand new report will appear.


a. Select the line of interest ( default line 1 is already showing)
b. If you changed line, Click Generate Report
c.

Note the Line indication change

d. Click on Temperature Profile hyperlink to go to the trend report


NOTE: It may take several second for the trend to open

404 of 878

NOTE: That the zone temperature tags for the selected Line (in this case line 1) are
passed to the trend to be displayed

8. Test your report by selecting another line from the excel report parameter list, following the steps
below:
a. Click on previous page button of your browser

b. You should be back to your excel report


c.

Select another line

d. Click Generate Report


e. Observe Excel report reflecting new line selection
f.

Click on Temperature Profile hyperlink

g. Observe the tags trending, reflecting the new line selection.

This lab is complete

405 of 878

Lab 2 Create a dynamic Excel Report linked to


another dynamic Excel report
In this lab we will create two excel report with a parent-child relationship. The parent report calls the
child report, or stated differently the parent report cascades to the child report.
The parent report will provide a list of completed Batch names. Clicking on a hyperlink associated
with each Batch name will launch the second (child) report which will show the temperature
information for that particular batch. Diagram below depicts this cascading relationship:

406 of 878

The final report pair functionality will look similar to the diagram below:

This lab has real life application for batch or any event framed application where information for a
particular batch (or vent framed set of data) is needed.
NOTE: We will do this lab in an iterative process to improve reports as we go along, so
you get a better idea of what is taking place. As such, you will note that certain steps are
intentionally not done perfectly the first time round.
NOTE: Many steps in this lab are similar to what you have been doing in the previous
Excel labs. Throughout this training course, we have been trying to minimize duplicate
tasks by for example modifying the same report and creating new version of it. In this
particular lab however at a cost of doing some tasks which you have done already, we
think it is beneficial to see and do the entire task from scratch to highlight intricacies
which might be lost by opening an existing report.

407 of 878

Implementation Process:
1. Create and publish the child report called BL Batch Temperature Profile to show the zone
temperature information in a tabular as well as a line chart for a given batch with external
parameters (Bread Line #, time frame)
a. Note that in this implementation, BatchID is NOT the external parameter, as one would
suspect. This is for two reasons
i. You have already seen how to setup external tags, so there is no point repeating it
here.
ii. We want to demonstrate a more common application where we want to get information
for a specific batch, or part number from a times series data source (not a relational
database). In these cases, since the data source is a timed series one, we essentially
need to get data from a specific time period associated with a part or batch. This is why
this process is sometimes referred to as time framing the information.
The parent report task is to find the time frame associated with a given part/batch/etc. and pass
that time frame to this child report so it could show the needed information (in this case the
temperature profile)
2. Create the parent report called BL Batch List to show all the parts made within the selected time
period
3. Refine the reports, to make them more accurate, appealing and user friendly

NOTE: As it is always the case in VantagePoint, having an appropriate type/model for a


given task can greatly ease the development process. In this case we need a model which
represents the oven temperatures as well as the BatchID information.
Creating this type is simple enough but fortunately we already have made one in the
previous lessons. MyPlant.Line.Info and its instances provide the exact information we
need to accomplish the stated goal of this lab.

408 of 878

Part A Create the child report BL Batch Temperature Profile


We will create a simple dynamic excel report showing the temperature history of the fours zones for a
given line in both tabular and line chart format
1. Verify that you are on the Server Image (Server tab is selected).

2. Launch Excel.
3. Start the process to insert VantagePoint History function into cell C7 by following the steps
below:
a. Select sheet1
b. Select cell C7
c.

Select the VantagePoint tab (this add-in is installed as part of VantagePoint Installation)

d. Select Insert Function (note that as soon as you click on Insert parameter sheet is created)

NOTE: There is no significance to the selection of this particular cell. It is however a best
practice to leave some room around this initial function insertion location in case header
or other items need to be added to the report.

409 of 878

e. Select History option


f.

Click the Use advanced Type Mapping features check box. Checking this box tells
VantagePoint that we will be selecting a type within the model to create a report against.

g. Click Next

410 of 878

4. The Type Selection view is presented. VantagePoint wants to know what we want to pass to the
History function which we selected in the previous item. We can do this either by selecting the
type of the desired item or select an example of the type using the items view. We select an
example or instance of our desired type (MyPlant.Line.Info) by following the steps below:
a. Select the Items that contain Core.Tags option
b. Navigate to MyEnterprise>MyPlant>Tags>BL1 and Select Line1Info which is an instance
of the MyPlant.Line.Info type
NOTE: The MyPlant.Line.Info now shows up in the selected type field. This is what we are
interested to get out of this step.
c.

Click Next

411 of 878

5. The Item Selection view is now presented. VantagePoints reporting wizard is essentially
showing all instances of the type MyPlant.Line.Info in case we wish to select them (in this case
there is only one and it has already been selected) Because we will be building a report that
reports against all instances of the MyPlant.Line.Info type, (even if there were more instances of
this type), we leave the current selection to one and click the Next button to continue.

412 of 878

6. Note that the Chosen Type, a Sample Item and Required Type for our selection are shown.
Furthermore there are messages providing details of what we have chosen, and what we need to
do next. Click Next.

7. From the Item Name window move TempZone1, TempZone2, TempZone3 and TempZone4 to
the Type: Core.Tag window Click Next.

413 of 878

8. The Parameter Creation view is now presented. Configure the parameters as follows:
a. Check the box labeled Make this an External Parameter when Published. Checking the
box will indicate to VantagePoint that the report accepts parameters of the Type
MyPlant.Line.Info
b. Change the Name to Line to make the name a little user friendlier and also give the
indication to the user that they can only select one Line (needless to say this is an optional
change and will depend on your project requirements)
NOTE 1: The constraints on the parameter, with a max range of one parameter for the
type at a time are selectable.
NOTE 2: The Range containing Mapped Items fields indicate where in the report the
fields of the type will be located. This field, if referenced at the end of the Wizard, will
contain the tags being used by the report itself.
c.

Click Next

414 of 878

9. The Time Selection view is now presented. There are several options on this view that can be
selected. We will implement a relative time period of type Core.TimePeriod.Relative with an
initial Last 30 minutes selection by following the steps below which involves similar steps as the
ones we just went through for the temperatures:

NOTE 1: There are several options for time selections:

Option 1 - Select a Relative time period, for example last hour, last day, last month, etc.
Option 2 - Select an Absolute range, such as January 1 2011 to January 22 2011 3:30 PM.
Option 3 - Select a place within the worksheet containing the dates to be used by the report.
This would be typically two cells, one containing the Start and the other the End of the
reporting period.
Option 4 - Use a Range. The range selection allows the use of the Core.TimePeriod type.

a. Select the Use this Range option


b. Click New

415 of 878

c.

Browse to MyEnterprise > Samples V4 > Support > Report Library > TimePeriods

d. Select Last 30 Minutes


e. Click Next

f.

The relative time is already selected. Click Next

416 of 878

g. Check the Make this an External Parameter when published check box. Note some of the
similar entries as the one we saw for temperature selection.
h. Click Next

i.

Click Next

417 of 878

10. The parameter configuration (temperature and time) is now complete. Next we need to configure
the Data option by following the steps below:
a. Select Narrow for the data format.
b. Click Finish

418 of 878

11. Youll note that the data returned to the Excel spreadsheet is displayed in a Narrow format (table
truncated in the diagram to display all data). In this format with multiple tags in the returned data
set, it is quite difficult to find the start and end of each of the tags and its corresponding data
points. The First time stamp and the Zone 1 sample data have been highlighted, the rest was not
so the diagram would not get too cluttered.

12. For the purposes of this lab, we need to change the format to Wide by following the step below:
a. Select C7 or any of the cells where the returned data array was created by the VantagePoint
History function (any cell with data in columns C through F below row 6 in this case)
b. Youll note that the Edit function in the VantagePoint ribbon becomes active
c.

Click on Edit in the VantagePoint ribbon

419 of 878

d. Click Next twice until you get to the Data Options page.
e. Change the Data format to Wide
f.

Click Finish

13. The data for the four zones of Line 1 Oven for the past 30 minutes should show up in our report.

NOTE: If data is displayed in an incorrect format such as date/time instead of an integer


value in the columns, use standard Excel procedure to change format (select column, right
click, format cells, select Number tab, change the format to what you wish.
NOTE: Our child report is almost done. We just need to add the line chart graph. That
should be simple enough?!

We just use the Excel Line Char function... right?


Well, you can see the challenge right?
The line chart needs data boundaries as in cell D7 to G50, but in our case this range is
dynamic and would depend on the number of samples requested which is driven by this
reports external time and date parameter
So while it is easy to fix, it is not quite as easy as just dropping a line chart.

420 of 878

14. For now lets not worry about the look and feel stuff and concentrate on our cascading report.
We just pick an arbitrary range like the first 30 samples for our line chart and create a line chart
following the steps below:
a. Select Cells D7 to G38 so these cells are highlighted
b. Select Insert from Excel Menu
c.

Select Line category

d. Select Line Chart

e. Position the Chart next to the data table


f.

Our preliminary child report is now complete and should look similar to diagram below:

421 of 878

15. Publish the child report, since the parent report which we will create next, needs a published
report to cascade to. We also need to test the report and make sure that the external parameters
are working properly. So publish the child report to MyPlant>Reports folder and name it BL
Batch Temperature Profile following the steps below:
a. Click Publish in VantagePoint ribbon menu

b. Select A report with parameters option, and click Next

c.

Youll note that both parameters used in this report, one identifying the line, and the other the
needed time period are selected by default which is what we want. Click Next

422 of 878

d. Navigate to MyEnterprise > MyPlant > Reports and type in BL Batch Temperature
Profile for the report name, and click Next

e. Select both options of Browse to published report and Show parameters and click Finish

423 of 878

16. Your report should look as follow, with the Line drop down allowing the selection of line and the
time drop down allowing the selection of the time period. Select different time periods, and line
combination to make sure your preliminary child report works fine.

Congratulations! The preliminary version of our child report is complete. It needs some cosmetic
work but well do them later. Lets keep on going with our cascading report project

17. Close Excel, so we can open a fresh session in next part

424 of 878

Part B Create the parent report BL Batch List


In this part of lab, we will create a simple report showing the list of completed batches within a
selected time period. We will make the report parameterized so both line and time period are
selectable, so the user can see the list of completed batches for a given line within a time period.
For each completed batch, we create a hyperlink to the BL Batch Temperature Profile report we
just completed to see the temperature profile for that given batch
1. Launch Excel (if it was still open from previous part, shutdown Excel, and start it again to make
sure what you see is in sync with the steps in this lab)
2. Start the process to insert VantagePoint History function into cell C7 by following the steps
below:
a. Select sheet1
b. Select cell C7
c.

Select the VantagePoint tab (this add-in is installed as part of VantagePoint Installation)

d. Select the Insert function (note that as soon as you click on Insert the parameter sheet is
created)

NOTE: There is no significance to the selection of this particular cell. It is however a best
practice to leave some room around this initial function insertion location in case header
or other items need to be added to the report.

425 of 878

e. Select History option


f.

Click the Use advanced Type Mapping features check box. Checking this box tells
VantagePoint that we will be selecting a type within the model to create a report against.

g. Click Next

426 of 878

3. The Type Selection view is presented. VantagePoint wants to know what we want to pass to the
History function which we selected in the previous item. We can do this either by selecting the
type of the desired item or select an example of the type using the items view. We select an
example or instance of our desired type (MyPlant.Line.Info) by following the steps below:
a. Select the Items that contain Core.Tags option
b. Navigate to MyEnterprise>MyPlant>Tags>Bl1 and select Line1Info which is an instance of
the MyPlant.Line.Info type
NOTE: The MyPlant.Line.Info now shows up in the selected type field. This is what we are
interested to get out of this step.
c.

Click Next

427 of 878

4. The Item Selection view is now presented. VantagePoints reporting wizard is essentially
showing all instances of the type MyPlant.Line.Info in case we wish to select them (in this case
there is only one and it has already been selected). Because we will be building a report that
reports against all instances of the MyPlant.Line.Info type, (even if there were more instances of
this type), we leave the current selection to one and click the Next button to continue.

428 of 878

5. Note that the Chosen Type, a Sample Item and Required Type for our selection are shown.
Furthermore there are messages providing details of what we have chosen, and what we need to
do next. Click Next

6. From the Item Name window move BatchID to the Type: Core.Tag window Click Next

429 of 878

7. The Parameter Creation view is now presented. Configure the parameters as follows:
a. Check the box labeled Make this an External Parameter when Published. Checking the
box will indicate to VantagePoint that the report accepts parameters of the Type
MyPlant.Line.Info
b. Change the Name to Line to make the name a little user friendlier and also give the
indication to the user that they can only select one Line (needless to say this is an optional
change and will depend on your project requirements)
NOTE 1: The constraints on the parameter, with a max range of one parameter for the type
at a time are selectable.
NOTE 2: The Range containing Mapped Items fields indicate where in the report the fields
of the type will be located. This field, if referenced at the end of the Wizard, will contain the
tags being used by the report itself.

430 of 878

8. The Time Selection view is now presented. There are several options on this view that can be
selected. We will implement a relative time period of type Core.TimePeriod.Relative with an
initial Last 30 minutes selection by following the steps below which involves similar steps as the
ones we just went through for the temperatures:
NOTE 1: There are several options for time selections:

Option 1 - Select a Relative time period, for example last hour, last day, last month, etc.
Option 2 - Select an Absolute range, such as January 1 2011 to January 22 2011 3:30 PM.
Option 3 - Select a place within the worksheet containing the dates to be used by the report.
This would be typically two cells, one containing the Start and the other the End of the
reporting period.
Option 4 - Use a Range. The range selection allows the use of the type Core.TimePeriod.

a. Select the Use this Range option


b. Click New

431 of 878

c.

Browse to MyEnterprise > Samples V4 > Support > Report Library > TimePeriods

d. Select Last 30 Minutes


e. Click Next

f.

The relative time is already selected. Click Next

432 of 878

g. Check the Make this an External Parameter when published check box. Note some of the
similar entries as the one we saw for temperature selection.
h. Change the Name to DateTime from Relatives to make the label more user friendly
i.

Click Next

j.

Click Next

433 of 878

9. The parameter configuration (BatchID and time) is now complete. Next we need to configure the
Data Options by following the steps below:
a. Leave default selections as they are (Wide data format, and everything else as shown)
b. Click Finish

434 of 878

10. You will note that while the data provided is what we are looking for, it is not in a very useful
format. As you recall our child report need a time range, so what we have to do here, is to send
the time stamp for the desired batch and then the time stamp for the next batch and keep on
doing this for each batch.
For example the time period for match M1Mix_8056 would be
11/30/12 17:55:43

to 11/30/12 17:58:43

This may not be too bad, but you note that in this example we had a period of No Active batch
designated NOBATCHACT , so in our calculations we have to compensate for these periods as
well.

NOTE: VantagePoint offers much better solution to perform this type of analysis and
present the report in a much more useful format for subsequent task (setting up link to the
child report in our case). For example, there is a SQL Post Processing Script called Time
In State which delivers how long a given state had lasted as well as its beginning and end
time stamp. This is exactly what we need for this report.
11. Modify the report and use Time In State query to find out how long each batch has taken to get
a better representation for the time periods for each batch period following the steps below:
a. Select C7 or any of the cells where the returned data array was created by the VantagePoint
History function (any cell with data in columns C or D below row 6 in this case)
b. Youll note that the Edit function in the VantagePoint ribbon becomes active
c.

Click on Edit in the VantagePoint ribbon

435 of 878

d. Click Next on the Range Selection window


e. Click Next on the Time Selection window as well
f.

In the Data Options, make sure that the skip advanced options is NOT set

g. Click Next

h. Click Next on the Sampling Option window as we do not need any aggregation for this
particular task.
NOTE: The Sampling Options window provides many Aggregating Sampling possibilities
for the data returned from the source. Aside from many statistical aggregations that you
would expect from a sampling analysis, it also provides functions like Sample and Hold to
filter out unwanted or redundant data within a sample
Each sampling type is described in the window below the aggregation list

436 of 878

i.

In the SQL Post Processing window, select the Apply SQL Post Processing option

j.

Click on the drop down list for Query Templates to pick Time In State query

k.

As you note the Time In State is not available. Available queries are based on Data Format
selected for the data. In this case, we selected Wide format, and the analysis we are looking
for requires narrow format

l.

Click Back twice to go back to Data Options

m. Change the Data Format to Narrow, and click Next

437 of 878

n. Click Next on the Sampling Options Window


o. We are now back in In the SQL Post Processing window, select the Apply SQL Post
Processing option
p. Click on the drop down list for Query and note that you have a totally different set of queries
q. From their title alone, you can see some interesting possibilities
r.

Select Time In State, returns Start, End Duration query

s.

Click Test

t.

Note the result set. This is exactly what we were looking for. It returns the batch name, start
and end time of the batch as well as the duration of the batch.

438 of 878

NOTE: The SQL Post Processing provides yet another way to process the data retrieved
from a source. This powerful tool allows us to write SQL scripts against the data retrieved
from a source. In this case, we applied a built-in script, but you can certainly write your
own. Whats important to note is that in this particular example, the retrieved data came
from a time series database (Historian SE) and the applied script put this data into a
proper context for our reporting and analysis purposes

u. Click Finish to get the result set into our Excel report
v.

The report is now in the format that we need. If the Start time and End time are not in time
format, use standard Excel procedure to reformat them to mm/md/yyyy hh:mm:ss (select
the two columns, right click, select Format Cells, select Number tab, select custom, enter
mm/dd/yyyy hh:mm:ss, click OK).

12. While the report can use some cosmetic work, we will worry about them later. We will setup the
hyperlink to BL Batch Temperature Profile for each Batch following the steps below:
a. Select cell I8
b. From the VantagePoint Ribbon, select Insert

439 of 878

c.

Select Link To Report

d. Click Next

e. Click on the drop down list and pick BL Batch Temperature Profile (our child report we
created in the previous part)
f.

Select Use contents of this cell

g. Click on ellipsis and select the cell which holds the Batch ID for this hyperlink
'Sheet1'!$F$8
h. Click Next

440 of 878

i.

As it is stated in the top of the dialog box, The Function Options now presents the parameters
that are needed by the Target report (BL Batch Temperature Profile) which are the line and
time. We need to tell the dialog box where to get this information by clicking on Modify on
the Line row

j.

As the dialog box specifically states, it needs a parameter of MyPlant.Line.Info type, as this
is the type of the line information we used in the child report. Since we used the same type in
the parent report, all we have to do is to point it to a location identifying the line selection.

441 of 878

As you recall from the previous lessons involving Excel report, the parameter sheet contains the
type of information we need here. In fact , cell A1 of the parameter sheet contains the current
FQN of the currently selected line so we just need to point to parameter sheet cell A1 to pass it to
the child report.
k.

Select the option for Select cells containing one Item.

l.

Click on ellipsis

m. Browse to Parameter sheet, and select cell A1


n. Click OK to accept the browse and the OK again to accept the Line parameter

o. Youll note the current value for the line parameter is now properly configured with the Valid
verification
p. Now we need to do the same for the time, so click on Modify for the time parameter

442 of 878

q. Select the option for Select cells containing one time period definition.
r.

For the Start and End time, browse to the respective cells (Shee1 C8, and C9)

s.

Click OK

t.

The current selected START and END time will show up in the field and we get the valid
verification.

u. Click Finish

Congratulations! You have your first hyperlink!!!

443 of 878

13. Test your hyperlink by clicking on it!


a. YOU GOT AN ERROR, didnt you?
b. Dont get discouraged, it was all planned!
c.

Read the error message. It is essentially saying that the current time requirement in the BL
Batch Temperature Profile cannot accept a second time parameter which makes sense,
since we had set it ups using a relative time (last so many minutes, hours, etc.) and not for
absolute (from time1 to time 2) We obviously need the absolute time frame, so we need to
correct the BL Batch Temperature Profile

d. Clicking OK in the dialog box above reveals more information about what we just discussed

14. Open the BL Batch Temperature Profile report to correct the time period issue following the
steps below:
a. From VantagePoint Ribbon, select Open

444 of 878

b. Navigate to My Enterprise > My Plant > Reports


c.

Select BL Batch Temperature Profile

d. Click Open

15. Well learn a quick technique to change the time type following the steps below:
a. In BL Batch Temperature Profile Unhide the IncuityInfo sheet by right clicking on one of
the sheets, and selecting unhide

b.

Select IncuityInfo

c.

Click OK

445 of 878

d. In IncuityInfo sheet in BL Batch Temperature Profile, change the


Core.TimePeriod.Relative to Core.TimePeriod

NOTE: While our particular task requires Absolute time periods, by selecting
Core.TimePeriod we are in fact configuring the time parameter for all children types too,
which includes Core.TimePeriod.Relative and Core.TimePeriod.Absolute.

e. Right click IncuityInfo sheet and hide it.

f.

From VantagePoint Ribbon, click on Publish to republish the BL Batch Temperature


Profile

446 of 878

g. Select A report with parameters option, and click Next

h. Note the change in the Parameter. Click Next

447 of 878

i.

Navigate to MyEnterprise > MyPlant > Reports and the name BL Batch Temperature
Profile for the report name should already be there, and click Next

j.

Confirm Yes for the file overwrite

k.

Select both options of Browse to published report and Show parameters and click Finish

448 of 878

16. Your report should now have the Absolute Period option. Click on the drop down list under Use
this TimePeriod Value and select Absolute Period.

17. The absolute period selection is now available for this report

NOTE: The time selection plays a critical role in almost all VantagePoint reports, we
wanted to go through this exercise to correct the intentional mistake to drive this point
across
18. Close BL Batch Temperature Profile

449 of 878

19. OK, now that we fixed the time issue, lets try our hyperlink again.by following the steps below:
a. On our parent report (BL Batch List), single click on the hyperlink you created in Cell

I8

b. Things should look much better now. Check to see that the Start and End time has been
transferred from the parent to child report and as such the main mission which is to show the
temperature information for the given batch is accomplished.

20. We now want to duplicate the batch hyperlink for the remaining batches, so lets take a look at
that cell and see how we can duplicate it. The content of the cell I8 is as follows:
=IncuityHyperlink("MyEnterprise.MyPlant.Reports.BL Batch Temperature
Profile","",Sheet1!F8,"&Line='Parameters'!%24A%241&Relatives=period2&st
art2="&Sheet1!C8&"&end2="&Sheet1!D8&"",,PortalRoot)
It includes the name of the report that it is linked to as well as the start and end periods which are
retrieved from the same row as the batch name as well as the Line information which is retrieved
from the Parameter sheet.

450 of 878

21. So it seems that using the standard Excel Grabbing the lower right corner of the box and
dragging it down would to do the trick. The problem however is that while this would work for the
start and end time parameters (in red text) as we do want the row reference to increment, it would
NOT work for the line reference( in red text and highlighted in yellow) which is pointing to
Parameter sheet A1. We want that to be fixed, so it would send the selected line information to
the child report. We will do that by editing the hyperlink before propagating it , following the steps
below:
a. While cell I8 is selected (you may find it easier to use the cursor keys to get to this cell, as
clicking on it will launch the corresponding report), press the F2 key. This will put the Excel
Array Formula into an Edit Mode.
b. Find the following ( earlier shown in red text and highlighted in yellow):
'Parameters'!%24A%241
c.

Replace it with:
'Parameters'!$A$1

d. Press Ctrl+Shift+Enter to complete the changes and refresh the Excel Array Formula
e. Try the link again to make sure it works
22. Before grabbing the lower right corner and dragging it down, a question should rise: how far
down should we drag. Remember that this list is dynamic and depending on the line and length of
time period the number of entries can vary. To handle error in the array size for our Hyperlink, we
can check to see if there is a table entry before executing the IncuityHyperlink. We will do just that
following the steps below:
a. As previous step, while cell I8 is selected press the F2 key to go into Edit mode
b. Modify the cell entry as follows which essentially states that if BatchID field is not blank
execute the IncuityHyperlink command, otherwise do nothing:
=if(F8<>,IncuityHyperlink("MyEnterprise.MyPlant.Reports.BL Batch Temperature
Profile","",Sheet1!F8,"&Line='Parameters'!$A$1&Relatives=period2&start2="&Shee
t1!C8&"&end2="&Sheet1!D8&"",,PortalRoot),)
c.

Press Ctrl+Shift+Enter to complete the changes and refresh the Excel Array Formula

23. We are now ready to populate the batch ID hyperlinks for the rest of the entries following the
steps below:
a. Select cell I8
b. Click and hold the small square on the lower left corner of the selection box
c.

While holding the left mouse key, drag down to as many rows as you anticipate to have
information for various line and time period selection. For this lab go to row 200

All batchs hyperlinks should populate.


451 of 878

24. Publish your parent report to MyEnterprise>MyPlant>Reports folder and call it BL Batch List
following the steps below:
a. Select Publish under VantagePoint ribbon

b. Select A report with parameters option, and click Next

c.

Youll note that both parameters used in this report, one identifying the line, and the other the
needed time period are selected by default which is what we want. Click Next

452 of 878

d. Navigate to MyEnterprise > MyPlant > Reports and type in BL Batch List for the report
name, and click Next

e. Select both options of Browse to published report and Show parameters and click Finish

453 of 878

25. Try different line or time periods to get various batch lists and then pick a batch to drill through to
make sure everything is working properly.

Congratulations you have completed the fundamental part of this lesson which was to establish a
parameterized hyper link between two dynamic excel reports. The remainder of this lab is really to
leverage various excel tools and technique to address cosmetic as well as some reporting issues.
The last lab in this lesson will address these issues.

This lab is complete

454 of 878

Part C- Refine the reports


In the previous sections, you completed the functional part of the task we had set out to do in this lab.
There are however a few basic things that in a real world application you would probably be required
to do. Some are cosmetic, but some if not done, would provide erroneous information. Some of these
are as follows:

Parent Report (BL Batch List) Minimum Refinement:


i.

A label or title indicating the currently selected line

ii.

Helpful titles for the hyperlinks

Child Report (BL Batch Temperature Profile) Minimum refinements


iii.

A label or title indicating the selected line and batch name

iv.

The most critical on this list is to correct the line chart as it is currently showing a fixed
arbitrary number of entries which needs to be changed to a dynamic one

In this part of the lab we will address the items on above list. Since you have done most of the
procedural steps needed to do the modifications in the prior labs and lessons, screen snap shots
will be kept at minimum
26. Add a Title to the BL Batch List to indicate the current selected line following the steps below:
a. Retrieve BL Batch List report form VantagePoint repository by :
i.
ii.
iii.

VantagePoint Ribbon > Open


Navigate to MyEnterprise>MyPlant>Reports
Double click on BL Batch List

b. In cell C4 enter Selected Line


c.

In Cell D4 enter =MID(Line,31,5)

NOTE: Line in the above formula is the Name of the range containing the FQN of the
parameter passed into this report which is the cell A1 in the parameter sheet (go to
parameter sheet and select A1. You will see the range name line in the upper left corner).
The name Line comes from the fact that we called this parameter Line when we were
creating the parameters
As we select different line, this parameter changes which in turn change the return value
for our formula indicating the proper line

d. In Cell I7, enter the text Links to Batch Temperature Profile


e. You should now have a minimal line indicating title as well as a helpful title for your
hyperlinks. Needless to say you can make these much more appealing but that is not the
intent of this lesson

f.

Publish Your report to update the report and save it


455 of 878

27. Add a title to the BL Batch Profile List to indicate the current selected line following the steps
below. Since we kept our naming, type, parameter names, etc., consistent, the steps to do this is
identical to the previous one.
a. Retrieve BL Batch Temperature Profile List report form VantagePoint repository by :
i.
ii.
iii.

VantagePoint Ribbon > Open


Navigate to MyEnterprise>MyPlant>Reports
Double click on BL Batch Temperature Profile
b. In cell C4 enter Selected Line
c.

In Cell D4 enter =MID(Line,31,5)

NOTE: Line in the above formula is the Name of the range containing the FQN of the
parameter passed into this report which is the cell A1 in the parameter sheet (go to
parameter sheet and select A1. You will see the range name line in the upper left corner).
The name Line comes from the fact that we called this parameter Line when we were
creating the parameters
As we select different line, this parameter changes which in turn change the return value
for our formula indicating the proper line
28. You should now have the Selected Line indication in your report.

29. Publish or save your report but do not close it as we have a few more things to take care of.
30. Add a title to the BL Batch Profile List to indicate the current selected batch.
We will do this by retrieving the batch ID for the currently selected time period and line utilizing
the VantagePoint Value at Time function.
31. In Cell C5 enter Selected Batch.
32. Select cell D5.
33. Under VantagePoint Ribbon, select Insert.

456 of 878

34. Select Value at Time.


35. Select Use advanced Type Mapping features.
36. Click Next.

37. Select Modelbrowser.


38. Click on New Map.

457 of 878

39. The type mapping explanation should be very familiar to you by now. Review, and click Next.

40. Select Batch ID


41. Click Next

458 of 878

42. A new range for the newly mapped tag is created. Click Next

43. Select workbook cells


44. Click on Time Cell browser (ellipsis)
45. Browse to first Time Stamp cell in our report (C8)

459 of 878

46. In the function option, for the columns to display, ONLY select the value item, and do NOT show
anything else (as configured in the diagram below)

The batch name associated with the time stamp in cell C8 show up in the cell D5. As different
batches are selected in the parent report, their associated time stamp will show up in the cell C8
which in turn change the Batch name in the cell D5.
NOTE: There are other techniques like setting up a string parameter which gets loaded by
the parent routine and is retrieved by the child routine. We just demonstrated one of those
techniques in this section
You should now have a dynamic Line and Batch indicator heading on top of your report

47. Publish or save your report but do not close it as we have a few more things to take care of.

460 of 878

The last modification we need to make to our report is to configure the line chart to show the proper
time range. As you know, when you insert an excel line chart, it asks you for data and time range.
The data range is typically not an issue. In this case it is the 4 temperature values. Time range
however creates a bit of a challenge, since in our lab, this range will vary depending on the length of
the selected batch. In another word, it can be a short batch which may entail for example 30 data
entries, or it can be a long batch having 100s of data entries, and everything in between.
To address this issue, we will leverage Excel calculation function as well as Name range feature to
dynamically change the data and x-axis (time) range of the line chart depending on the number of
temperature entries for a given batch, following the steps below:
48. Delete the line chart as we will recreate it using our new dynamic ranges
49. Enter the following information into the indicated cells. Everything after the arrow needs to be
typed in to the cell i.e. cell K1 should hold the string =COUNTA(G:G)+6
a. Calculate the number of entries and add 6 to compensate the table offset needed for the
upcoming calculations
K1--> =COUNTA(G:G)+6
b. Enter the following documentation labels for each of the 5 pertinent data sets (time, and the
four zones) that we are about to create
i.
ii.
iii.
iv.
v.
c.

K2-->
K3-->
K4-->
K5-->
K6-->

S_Time
S_Zone1
S_Zone2
S_Zone3
S_Zone4

Enter the following formulas for each of the above labels. You will note that in each case we
will concatenate the starting cell of the give data series with the value in K1 to find the
complete range.
Example: if we have a table with 4 data entry, the range we would be interested is C8-C11
(assuming the table starts in cell C8)
The CountA would return 5 (4 entries+the header)
K1 would be 11 (5+6),
The formula in L2 ="'Sheet1'!$c$8:$c$"&$K$1 would return C8-C11 which is exactly what
we want.

L2-->
L3-->
L4-->
L5-->
L6-->

="'Sheet1'!$c$8:$c$"&$K$1
="'Sheet1'!$d$8:$d$"&$K$1
="'Sheet1'!$e$8:$e$"&$K$1
="'Sheet1'!$f$8:$f$"&$K$1
="'Sheet1'!$g$8:$g$"&$K$1

461 of 878

d. Your K1 through L6 should look as follows(the last row was 1215)

50. Save the excel file, but keep it open.


51. From the Excel menu bar select Formulas > Name Manager.

52. Click New

462 of 878

53. Type in xAxis for the name and enter the following for the reference to indirectly refer to the
Time range calculation we just did
=indirect(Sheet1!$L$2)

54. Repeat the above step (click New, enter Name and Refer To string for the four zones creating
the following name and reference string
Zone1

=indirect(Sheet1!$L$3)

Zone2

=indirect(Sheet1!$L$4)

Zone3

=indirect(Sheet1!$L$5)

Zone4

=indirect(Sheet1!$L$6)

Your Name manager should have the five definitions we just created with indirect references to
our four zone temperatures and the time stamps (xAxis) and should look as follows:

463 of 878

55. Before going further we need to test our data ranges in our Name manager:
a. In the Name Manager, select any of the name ranges you just created, and click on the
Excel button. This will dynamically wrap around the range of data for the selected name. The
diagram shows an example of testing xAxis (Time Stamp)

As you can see, now our ranges are completely dynamic driven by the simple row calculation and
the indirect address within the name range

464 of 878

56. Insert a line chart at about the same location as we did before from H7 to N30 by
a. Click Insert Ribbon on Excel menu
b. Click Line
c.

Select Line chart (upper left chart under 2-D line)

d. Position the chart, roughly between H7 and N30


e. Right click on the chart and click on Select Data
f.

In the Legend Entries (Series), remove the 4 TempZones if they are selected

57. In the Select Data Source window, click Add


58. Configure the entry as below:
a. Series Name

="TempZone1"

b. Series Value ='BL Batch Temperature Profile.xlsx'!Zone1

NOTE: The Series value requires the full work book name (in this case BL Batch
Temperature Profile.xlsx and the name of the range (the ones we just created). We had to
put the name in single quotes because there are spaces in the name

465 of 878

59. Repeat the above step to add the other three temperature with the following configuration:

Series Name ="TempZone2"


Series Value ='BL Batch Temperature Profile.xlsx'!Zone2

Series Name ="TempZone3"


Series Value ='BL Batch Temperature Profile.xlsx'!Zone3

Series Name ="TempZone4"


Series Value ='BL Batch Temperature Profile.xlsx'!Zone4

60. Your Data source should now have the 4 temp zones. Now we will add our time series (xAxis) to
the chart by clicking on Edit under the Horizontal (Category) Axis Labels

61. Enter the following into the Axis label range


='BL Batch Temperature Profile.xlsx'!xAxis

466 of 878

62. Your Data source selection is complete and should look similar to the diagram below. Click OK
to complete the Data Source selection.

63. The chart now appears as a single line and point on the X Axis. This is because the X axis is not
formatted properly. Format the x-axis following the steps below:
a. Right-click on X Axis and select Format Axis

467 of 878

b. Select Axis Options


c.

Select Text Axis for Axis type

d. Click Close

64. The chart should be displaying the time and date correctly across the time (X) axis.

468 of 878

Your report is now complete. Obviously we did not spent too much time on aesthetics unless in those
cases where we learned a useful technique in the process. In a real world application, you probably
would do all your intermediately work in a scratch pad sheets and hide them, leaving only the final
result for the presentation.
You did learn a few cascading techniques which should have common applications. You also learned
some valuable excel techniques which have general useful application
Dont forget to publish/save the various reports you worked on in this lesson.

Congratulations! You just completed this lab and lesson.

469 of 878

This page intentionally left blank

470 of 878

Lesson 12 - Creating Composite Reports and


Viewing in the Portal

What you will learn:

How to use Composite Reports to view Typed Data using Trends.


Create a Composite Report that views trend data using a Type Instances
Create a Composite Report with 2 Trends viewing the same Type Instances

Prerequisite:

Completion of Lesson 2
Completion of Lesson 9 (if you have not, the files needed can be retrieved from the
Completed folder)

Discussion
Creating Composite Reports
A Composite Report is a report consisting of two or more report elements. These elements may
include:

Excel reports
Dashboard displays
Trends and Plots
Html markup
Web links to other sites

Composite reports can be created anywhere in the Model where reports are allowed. They are
created using the Model Browser, usually within VantagePoint Manager. Essentially, composite
reports are built in a tabular fashion employing Rows and Cells. Experimenting can yield interesting
results, but a good guideline is to restrict each row to one or two cell components in order to build
visually useful displays.

471 of 878

The image below displays the Extruder Composite Report as it appears in the Model Browser. The
ParameterTypes and OwnedItems nodes are maintained by the report itself and are not of interest
here. The Rows node contains 2 rows, R1 and R2.
R1 - Row 1 of the report - has one Cell, C1. The content inside this cell is a Multi Tag Report. Notice
that three parameters - three tags - are passed into the report. How parameters should be mapped is
a function of the way the report was originally designed. The "Report" property is maintained by the
report itself and is not of interest here.
R2 - Row 2 of the report - has two Cells, C1 and C2. The content inside C1 is a Dashboard. The
content inside C2 is a Trend. Notice that no parameters are passed into the Trend. Trends can
display all items of an Extruder item automatically. One could restrict the tags displayed by creating
ParameterMappings, as was done for the Multi Tag Report.

472 of 878

The resulting report in the Portal looks like this:

The report can be changed at any time simply by adding more rows and cells in the Model Browser
structure. Text and images can be added using the built-in HTML editor, or by using custom HTML
markup. Links to web pages can be added. Multiple dashboard displays can be inserted. Reports and
dashboards can host links to other reports for a drill-down effect.
Some report elements - Excel reports and Dashboard displays - should be pre-existing in the Model.
Trend and XY Plotter displays can be included as existing reports drawn from the model in the same
way Excel report are, or, designed while building the Composite report, as is described in Creating
Viewable Trend Content in VantagePoint Help.

473 of 878

Lab 1 Use Portal.CompositeReportTemplate to


Create dynamic (type mapped or parameterized)
trend reports
In the past lessons, we created several type mapped report (also called dynamic or parameterized
report). As you probably noted when we published trend reports, there was no option for parameter
selection (as there are for excel reports). In fact, if you recall we had to use an excel report to drive
the parameter into a trend to have a parameterized trend report.
In this lab, we will see how we can use Portal.CompositeReportTemplate to create parameterized
trend reports. By the end of this lab you will create a trend report where the user can see the different
temperature zones for the selected line as shown below:

474 of 878

Part A Configure the Composite Reports Type


In this part of the lesson we will create a Composite Report using the Line1OvenSimple instances of
the MyPlant.Oven.OvenSimple type.
1. Verify that you are on the Server Image (Server tab is selected)

2. Create an instance of the Portal.CompositeReportTemplate


a. Launch VantagePoint Manager
b. Navigate to MyEnterprise>MyPlant>Reports
c.

Right-click and select New > Item

475 of 878

d. Select the Core.TemplateReport at the bottom of the New Item dialog box
e. Expand the Core.Template.Report tree
Note: There are various Report Templates. We use the Composite one here. These
templates provide plenty of opportunity for you to explore them and the reporting
possibilities they provide.
f.

Select the Portal.CompositeReportTemplate

g. Click Create

3. Name the Instance BL Comp Temp Trend and configure its parameters to be of
MyPlant.Oven.ovenSimple type following the step below:
a. In the Name textbox enter BL Comp Temp Trend
b. Click Add

476 of 878

c.

In the Name textbox enter Oven Trends

d. Click the Default Value (item) browse icon (ellipsis)

We want to select an item of type OvenSimple, so this type becomes the parameter type. In
doing so, any oven can be passed into the report and the report will display data for that oven
(line associated with that oven)
e. Navigate to MyEnterprise>MyPlant>Tags>BL1
f.

Select the Line1OvenSimple instances

g. Click OK

477 of 878

NOTE: The Composite Report is a Type Report and must reference an instance of a Type.
As such we could have chosen Line2OvenSimple as well, since it is the type, and not
necessary the instance that we are interested in at this time
h. Note that the Item type is filled and as said before, this is now going to be the type of this
report
i.

Click OK

j.

The template is now created. We will next add the items to this template

k.

The Click OK

NOTE: The Composite Report can reference only one instance of a Type

478 of 878

Part B Configure Row 1


Now that the template is created, we will add the items needed for the report. Remember that a
composite report consist of one or more rows, each of which can contain one or more cells, or
columns. This composite report has only two rows and each row has only one column. It is
essentially a 2 X 1 table. So we only have two cell to configure: Row1, Cell 1 (R1C1), and Row 2,
Cell 1 (R2C1). We will configure the R1C1 which is the title, and then R2C1 which is the trend.
To setup the title in Row 1 we use the VantagePoint HTML editor
1. Setup the report environment for Composite report creation by following the steps below:
a. Navigate to MyEnterprise>MyPlant and select Reports folder
b. Click the All Items In Tree icon on the menu (wrench)
NOTE: This is required to configure the rows and cells of the Composite Report

2. .Configure the Row 1 (Title Row), following the steps below:


a. Navigate to MyEnterprise>MyPlant>Reports and expand BL Comp Temp Trend (this is
the template report we just created earlier in this lab)
b. Right-click on Rows, and Select New > Item

479 of 878

NOTE: The first two items under the composite report template (Parameter Types, and
OwnedItems) are maintained by the report itself. As such we always deal with the third
item which is Rows. That is where the report is configured
c.

In the Name textbox enter Title Row

d. In the DisplaySequence textbox enter 1


e. In the HeightPixels textbox enter 100
f.

Click Create

NOTE:

Name - You can give the row a meaningful name, or a generic name, like R1 or Row 1. Once
created, this name can NOT be changed.
Description - The Description is optional and appears only in the VantagePoint Manger. It is
not visible anywhere in the report
DisplaySequence - A DisplaySequence can be used to alter the default ordering of the rows
in report (which is alphabetical by Name), and can be changed at any time during or after
creation of the report to change its appearance.
As a general rule, it makes sense to start your sequence from 1, and increment each
subsequent row by 1, but this is not a requirement. When the report is displayed, the order is
determined by the relative numbering of the rows, so for example 100, 150, 12 works as
well as 1,2,3.
HeightPixels - The row height can be specified as an integer, corresponding to number of
pixels. It is not possible to specify height by percentage. 300 is the default

480 of 878

Now that Row 1 is created, we will create cell 1 within Row 1. This is the cell that is going to house
the title of the report.
3. Configure the first cell in the row we just created (Title Row) following the steps below:
a. Right-click on Cells under Title Row and select New > Item
b. Youll note that the dialog box that appears is much like the one for creating rows. As with
rows, you can give your cell a meaningful name, or a more generic name like C1. (Once
created, this name cannot be changed).

c.

In the Name textbox enter Cell1

d. In the Description textbox enter Contains the HTML content


e. In the DisplaySequence textbox enter 1
f.

Un-check the ShowBorder and ShowFullScreenIcon check boxes

g. Click Create

NOTE:

DisplaySequence - A DisplaySequence can be used to alter the default ordering of cells in


the row (which is alphabetical by Name), and can be changed at any time during or after
creation of the report to change its appearance.
The same general sequence rule for Rows applies to Cell as well.
ShowBorder will place a border around the report item.
ShowFullScreenIcon will place an icon in the top right corner of the report that when clicked,
will open the report item individually in Full Screen Mode.

481 of 878

The Row 1 Cell 1 characteristic is now configured, now we need to define its content. Which in this
case is a simple HTML page displaying the title of the report. You will find the process to be the same
as row, and cell where you create an item (this time content vs. the row and cell in previous steps)
and insert the content.
4. Configure the content of Cell 1 in Row1(Title Row) following the steps below:
a. Right-click on Content below Cell1 that was just created, and select New > Item

b. Select Portal.ViewableHtmlContent
c.

Click Create

482 of 878

d. In the Name textbox enter Report Title


e. In the Description textbox enter Title of Report
f.

In the DisplaySequence textbox enter 1

g. Uncheck ShowActionBar
h. DO NOT click Create
i.

We are going to create the HTML code needed for our title to be inserted into the
HtmlMarkup fiend first

5. Open the HTML editor following the steps below:


a. Launch VantagePoint Portal
b. Navigate to MyEnterprise>Sample V4>Support>Utilities
c.

Click on HTML Editor

483 of 878

6. Configure the header for the title row following the steps below:
a. Click in the large blank area below the icons, and enter Oven Temperatures
b. Set size to 5
c.

Set font to Verdana

d. Center text
e. Click on the HTML tab in the lower left hand corner

f.

Copy the HTML text (<ctrl><A>, <ctrl><c>)

g. Paste the HTML text box you just copied in to the HtmlMarkup field
h. Click Create

NOTE: Your Row 1 Cell 1 configuration is complete.


484 of 878

Part C Configure Row 2


We completed Row 1 in the previous part, now we will move on to configure row 2 and its single cell
You will find the creation of the Row 2 and Cell 1 within it, is procedurally identical to what we just did
for Row 1 and Cell 1.
1. Configure the Row 2 (Trend Row), following the steps below:
a. Right-click on Rows, and Select New > Item

b. In the Name textbox enter Trend Row


c.

In the DisplaySequence textbox enter 2

d. In the HeightPixels textbox enter 400


e. Click Create

2. Row 2 is created, next we will create cell 1 within Row 2. This is the cell that is going to house the
trend report.

485 of 878

3. Configure the first cell in the row we just created (Trend Row) following the steps below
a. Select Cells
b. Right mouse click and select New > Item

c.

In the Name textbox enter Oven Trend

d. In the DisplaySequence textbox enter 1


e. Click Create

The Row 2 Cell 1 is now configured, now we need to define its content which in this case is the
trend report.
4. Configure the content of Cell 1 (Oven Trend) in Row2(Trend Row) following the steps below:
a. Right-click Content (under Oven Trend) and select New > Item

486 of 878

b. Select Portal.ViewableTrendContent
c.

Click Create

d. Configure the new item as shown


e. Click Create

The content which in this case is a trend container is created. Next we are going to map the items of
the type that we are interested in.

487 of 878

Part D Map Parameters


If no parameters are created the trend would display all the items of the type
1. Map the first parameter (Zone1) following the steps below:
a. Right-click ParameterMapping and select New > Item

b. In the Name textbox enter Zone1


c.

In the TargetParameterName text box enter param

NOTE: param is the parameter collection for the type items


d. In the SourceName text box enter TempZone1
NOTE: There is a period in front of the source name entry by default. Do not delete the
period.
e. Click Create

NOTE: This SourceName must EXACTLY MATCH the name of the tag or property that is
part of the Type, this report is based on. For this and future SourceName entries, spelling
and use of punctuation marks and underscores count!

488 of 878

2. Map the second parameter (Zone2) following the steps below:


a. Right-click ParameterMapping and select New > Item

b. In the Name textbox enter Zone2


c.

In the TargetParameterName text box enter param

d. In the SourceName text box enter TempZone2


NOTE: There is a period in front of the source name entry by default. Do not delete the
period.
e. Click Create

489 of 878

3. Map the third parameter (Zone3) following the steps below:


a. Right-click ParameterMapping and select New > Item

b. In the Name textbox enter Zone3


c.

In the TargetParameterName text box enter param

d. In the SourceName text box enter TempZone3


NOTE: There is a period in front of the source name entry by default. Do not delete the
period.
e. Click Create

490 of 878

4. Map the fourth parameter (Zone4) following the steps below:


a. Right-click ParameterMapping and select New > Item

b. In the Name textbox enter Zone4


c.

In the TargetParameterName text box enter param

d. In the SourceName text box enter TempZone4


NOTE: There is a period in front of the source name entry by default. Do not delete the
period.
e. Click Create

A Row 2 (Trend Row) configuration is complete. We will next go into portal to see our brand new
composite report

491 of 878

5. Your composite report configuration should look as follows. Note the hierarchical nature of the
row and columns configuration

492 of 878

Part E - View the composite Report in the VantagePoint Portal


1. View the just created Composite report ( BL Comp Temp Trend), following the steps below:
a. Launch VantagePoint Portal
b. Click Reports > MyEnterprise
c.

Navigate to MyEnterprise>MyPlant>Reports and click on BL Comp Temp Trend

d. Select the Parameters tab


e. In the Oven Trends combo box verify that the BL1.Line1OvenSimple instances is selected
f.

Click the Tag List at the bottom left of the trend window

493 of 878

g. Expand the Tag column to full width


h. Verify that the BL1.Line1OvenSimple tags are being displayed
i.

From the Oven Trends combo box select BL2.Line2OvenSimple

NOTE: Because the Composite Report is a type report all the instances of the type
MyPlant.Oven.OvenSimple are in the Oven Trends combo box
j.

Click Generate Report

NOTE: Depending on the feature you select when you are setting up the trend, you can
have the full trend capabilities in the portal the same as you do in the trend client when
you create the trend. In this case for example, we checked the show Toolbar option, and
we have the full toolbar. If these capabilities are needed for your project, composite
reporting approach offers more options than the simple trend publishing.

Congratulations! You have created a type mapped trend report that shows four zone temperature
profiles for a user selectable line

This lab is complete

494 of 878

Lab 2 Display Multiple Trends using Composite


Report
In this lab we will expand on what we learned in the previous lab and create a Composite Report that
will display two trends: Machine Status Trend and an Oven Zone Temperature Trend
The Machine Status will display

BatchID
MachineStep

Oven Zone Temperature Zone will display

TempZone1
TempZone2

The target report should look as follows, where the operator can select a line to get the above line
information in the following format:

495 of 878

Part A Configure the type for the target report


As we learned in the previous lab, we need to associate the composite report to a type (hence the
world type mapped) so as it is the case with any composite report we need to make sure that we
have a type which its instances can accommodate all the data needed for the purposes of the report.
In this case, then, we need a type that at least has the items needed by the Machine Status (BatchID,
ProductCode, etc.), and the items needed by the Zone Temperature trend (TempZone1, TempZone2,
etc.)
MyPlant.Line.Info type which you imported as part of the LineInfo.ICP package in lesson 9 is
exactly what we need for this purpose. The type contains all he element required for the purposes of
this lab.
1. Verify that you are on the Server Image (Server tab is selected)

2. IF YOU DID NOT IMPORT LineInfo.ICP in lesson 9, import it following the steps below:
Otherwise go to Part B
a. From the File menu select Import (File > Import)

b. Click on ellipsis, browse to C:\Class Files\Types, and select LineInfo.CIP


c.

Click Next

d. Select the Add in import option and click Next


e. Verify the successful import indication message, and then click Finish

496 of 878

Part B Configure the Composite Reports Type


In this part of the lesson we will create a Composite Report using the Line1Info instances of the
MyPlant.Line.Info type
1. Create an instance of the Portal.CompositeReportTemplate
a. Launch VantagePoint Manager
b. Navigate to MyEnterprise>MyPlant>Reports
c.

Right-click and select New > Item

d. Select the Core.Template.Report at the bottom of the New Item dialog box
e. Expand the Core.Template.Report tree
f.

Select the Portal.CompositeReportTemplate

g. Click Create

497 of 878

2. Name the Instance BL Comp Overview Trend and configure its parameters to be of
MyPlant.Line.Info type following the step below:
a. In the Name textbox enter BL Comp Overview Trend
b. Click Add

c.

In the Name textbox enter Line Info

d. Click the Default Value (item) browse icon (ellipsis)

498 of 878

3. We want to select an item of type MyPlant.Line.Info, so this type becomes the parameter type.
In doing so, any line can be passed into the report and the report will display data for that oven
(line associated with that oven)
a. Navigate to MyEnterprise>MyPlant>Tags>BL1
b. Select the Line1Info instances
c.

Click OK

NOTE: The Composite Report is a Type Report and must reference an instance of a Type.
As such we could have chosen Line2Info as well, since it is the type, and not necessary
the instance that we are interested in at this time
d. Note that the Item type is filled and as said before, this is now going to be the type of this
report. Click OK

499 of 878

e. The template is now created. We will next add the items to this template
f.

The Click OK

NOTE: The Composite Report can reference only one instance of a Type

Now that the template is created, we will add the items needed for the report. Remember that a
composite report consist of one or more rows, each of which can contain one or more cells, or
columns. This composite report has only one row and this row has two columns. It is essentially a 1
X 2 table. So we only have two cells to configure: Row1, Cell 1 (R1C1), and Row 1, Cell 2 (R1C2).
We will configure the R1C1 which will contain Machine Status Trend and R1C2 which will contain the
Temperature Trend.

500 of 878

Part C Configure Row 1 Column 1


In this part, we will configure the Row 1 Column 1 (R1C1) which will contain Machine Status Trend
1. Setup the report environment for Composite report creation by following the steps below:
a. Navigate to MyEnterprise>MyPlant and select Reports folder
b. Click the All Items In Tree icon on the menu (wrench)
NOTE: This is required to configure the rows and cells of the Composite Report

2. Configure the Row 1 (Trend Row), following the steps below:


a. Navigate to MyEnterprise>MyPlant>Reports and expand BL Comp Overview Trend (this
is the template report we just created earlier in this lab)
b. Right-click on Rows, and select New > Item

c.

In the Name textbox enter Trend Row

d. In the DisplaySequence textbox enter 1


e. Un the HeightPixels textbox enter 500
f.

Click Create

501 of 878

Now that Row 1 is created, we will create cell 1 within Row 1. This is the cell that is going to house
the Machine Status trend.
3. Configure the first cell in the row we just created (Trend Row) following the steps below:
a. Right-click on Cells under Trend Row and select New > Item
b. Youll note that the dialog box that appears is much like the one for creating rows. As with
rows, you can give your cell a meaningful name, or a more generic name like C1. (Once
created, this name cannot be changed).

c.

In the Name textbox enter MachineStatus

d. In the DisplaySequence textbox enter 1


e. Check ShowBorder and ShowFullScreenIcon.
f.

Click Create

502 of 878

The Row 1 Cell 1 characteristic is now configured, now we need to define its content.
1. Configure the content of Cell 1 in Row1(Trend Row, Machine Status Column) following the steps
below:
a. Right-click on Content below MachineStatus that was just created, and select New > Item

b. Select Portal.ViewableTrendContent
c.

Click Create

503 of 878

d. In the Name textbox enter Status


e. In the DisplayName textbox enter Machine Status
f.

In the DisplaySequence textbox enter 1

g. Check the selection boxes as shown


h. Click Create

The content which in this case is a trend container is created. Next we are going to map the items
of the type that we are interested in.
If no parameters are created the trend would display all the items of the type

504 of 878

2. Map the first parameter (PartID) following the steps below:


a. Right-click ParameterMapping and select New > Item

b. In the Name textbox enter PartID


c.

In the TargetParameterName text box enter param

d. In the SourceName text box enter BatchID


NOTE: There is a period in front of the source name entry by default. Do not delete the
period.
e. Click Create

3. Map the second parameter (Step) following the steps below:


a. Select ParameterMapping for MachineStatus
b. Right mouse click and select New > Item

505 of 878

c.

In the Name textbox enter Step

d. In the TargetParameterName text box enter param


e. In the SourceName text box enter MachineStep
NOTE: There is a period in front of the source name entry by default. Do not delete the
period.
f.

Click Create

Configuration of Row 1 Column 1 cell of the composite report is complete.

506 of 878

Part D Configure Row 1 Column 2


In this part, we will configure the Row 1 Column 2 (R1C2) which will contain Temperature Trend
We completed Row 1 Column 1 in the previous part, now we will move on to configure Row 1 Column
2.
You will find the creation of the Row 1 Cell 2 is procedurally identical to what we just did for Row 1
and Cell 1.
1. Configure the Row 1 and cell 2 (Trend Row, Temperature Trend column), following the steps
below:
a. Right-click on Cells (right under Trend Row), and Select New > Item

b. In the Name textbox enter Oven Temps


c.

In the DisplaySequence textbox enter 2

d. Check the selection boxes as shown


e. Click Create

The Row 1 Cell 2 is now configured, now we need to define its content which in this case is the
temperature trend report.

507 of 878

2. Configure the content of Cell 2 (Temperature Trend) in Row1(Trend Row) following the steps
below:
a. Right-click on Content (under the Oven Temps) and select New > Item

b. Select Portal.ViewableTrendContent
c.

Click Create

508 of 878

d. In the Name textbox enter Ovens


e. In the DisplayName textbox enter Oven Temp
f.

In the DisplaySequence textbox enter 2

g. Check the Show TagList check box


h. Configure the rest as shown
i.

Click Create

The content which in this case is a trend container is created. Next we are going to map the items
of the type that we are interested in.
If no parameters are created the trend would display all the items of the type

509 of 878

3. Map the first parameter (Zone1) following the steps below:


a. Right-click ParameterMapping (under Ovens)and select New > Item

b. In the Name textbox enter Zone1


c.

In the TargetParameterName text box enter param

NOTE: param is the parameter collection for the type items


d. In the SourceName text box enter TempZone1
NOTE: There is a period in front of the source name entry by default. Do not delete the
period.
e. Click Create

NOTE: This SourceName must EXACTLY MATCH the name of the tag or property that is
part of the Type this report is based on. For this and future SourceName entries, spelling
and use of punctuation marks and underscores count!

510 of 878

4. Map the second parameter (Zone2) following the steps below:


a. Right-click ParameterMapping (under Ovens)and select New > Item

b. In the Name textbox enter Zone2


c.

In the TargetParameterName text box enter param

d. In the SourceName text box enter TempZone2


NOTE: There is a period in front of the source name entry by default. Do not delete the
period.
e. Click Create

511 of 878

5. Your configuration should look as follows. As you note we did not use all the elements of the type
which is why we defined the parameters otherwise every item would show up

512 of 878

Part E - View the composite Report in the VantagePoint Portal


1. View the just created Composite report ( BL Comp Overview Trend), following the steps below:
a. Launch VantagePoint Portal
b. Click Reports > MyEnterprise
c.

Navigate to MyEnterprise>MyPlant>Reports and click on BL Comp Overview Trend

d. Select the Parameters tab


e. In the Line Info combo box verify that the BL1.Line1Info instance is selected
f.

Click the Tag List at the bottom left of each trend window

513 of 878

g. Expand the Tag column to full width


h. Verify that the BL1.Line1Info tags are being displayed
i.

From the Oven Trends combo box select BL2.Line2Info

NOTE: Because the Composite Report is a type report, all the instances of the type
MyPlant.Line.Info are in the Line Info combo box
j.

Click Generate Report

NOTE: Depending on the feature you select when you are setting up the trend, you can
have the full trend capabilities in the portal the same as you do in the trend client when
you create trend. In this case for example, we checked the show Toolbar option, and we
have the full toolbar. If these capabilities are needed for your project, composite reporting
approach offers more options than the simple trend publishing.
Congratulations... You have created a type mapped trend report that shows four zone temperature
profiles for a user selectable line

This lab and lesson is complete

514 of 878

Lesson 13 - Creating Dashboards

What you will learn:

How to create a FTVP dashboard using Xcelsius 2008


Creating a dashboard from a template
Using the VantagePoint add-in to add FTLD
Configure and Publish the dashboard

Prerequisite:

Understanding of Lessons 5 and 9.

Discussion
Introduction to Dashboards
VantagePoint users add dashboard displays to VantagePoint by creating them in Xcelsius and
publishing them into the VantagePoint Portal. VantagePoint wizards guide the user in selecting data
that is placed into an Excel spreadsheet. As dashboard displays are built, spreadsheet cells are
associated with dashboard objects. Once published into the Portal, the dashboards can be lively,
interactive displays animated by live data from within the host system.
Combining the power of the VantagePoint Model with the Xcelsius what if functionality, process
engineers can create displays for determining the optimal performance speed of a production line,
planning engineers can determine the most favorable inventory levels and the shift supervisor can
discover the best possible production path. Utilizing the diverse data sources of VantagePoint in
combination with report drill-down capability, quality engineers can quickly determine the root cause
of product rejects, the VP of Sales can publish a report identifying which products are earning the
most profit per region or season, or, the VP of Finance can publish a dynamic report that shows a
traditional Statements of Income, however when a user clicks on an account, the model shows the
historical data organized by region or as a comparison against competitors.
VantagePoint users drive the dashboard building process from a Microsoft Excel spreadsheet
embedded within Xcelsius using custom VantagePoint wizards. These wizards are designed to create
the data sets (XML queries) that deliver the data needed to power the dashboard. Within the
integrated Xcelsius environment, users link graphical objects to underlying data by pointing to cells in
the Excel spreadsheet. Once the dashboard design is complete, the dashboard is exported and the
VantagePoint Publish wizard is used to publish the dashboard into the VantagePoint Model where it
is immediately made available to the VantagePoint Portal.

515 of 878

VantagePoint dashboards are especially powerful because they can be built using VantagePoint
Advanced Type Mapping features. Advanced Type Mapping enables users to build high-level
dashboards on composite VantagePoint Model items, and publish them with the intrinsic ability to
point the dashboard at other VantagePoint Model items of the same Type. For instance, a dashboard
displaying Pump operational information such as flow, speed and state can be designed once, and by
modifying the parameter that determines which Pump is being addressed - using a Model Browser
type pick list only - the dashboard can begin to display data from a different Pump. And in the
VantagePoint Portal, pages can be designed that display several dashboard displays at the same
time.
Dashboard building is an optional license feature of VantagePoint. In order to build dashboards, users
must install the Xcelsius product on their local machines and activate it with a license key. This key
can be obtained from Rockwell Automation, Inc. as an additional license component, or users can
purchase the product directly from the vendor.
The Dashboard wizards operate in the same manner as other VantagePoint functions in Excel, using
many of the same steps. The Common VantagePoint Function Steps apply in much the same order,
and the Type Mapping works the same way. If you are not familiar with these concepts already, you
can review Common VantagePoint Function Steps and Using Type Mapping in VantagePoint Help.

The Steps in brief


1. Open Xcelsius and insert data in the embedded spreadsheet using the VantagePoint Add-In
Wizards.
2. Create the dashboard display and associate objects in the dashboard with data in the embedded
.xls file.
3. Configure the Data settings in Xcelsius using the Data->Connections menu item. These settings
include:

Selecting the Excel XML Map option and setting the data URL
Setting the refresh rate for the display data
Adding Flash Variables by importing NamedRanges

4. Save the Xcelsius project file locally.


5. Export the dashboard to a local folder using File > Export menu item. This will create the SWF
file.
6. Publish the dashboard to the Portal using the VantagePoint menu.

516 of 878

About using Xcelsius


VantagePoint feeds live data to Xcelsius and brings dashboard displays to life.
What is Xcelsius?
Xcelsius combines the power of Excel with Macromedias Flash Player to generate stunning data
presentations. Report generation is performed using simple point and click techniques and since the
underlying technology of Xcelsius is Excel, it requires no more knowledge than the average Excel
user already has.
Who uses Xcelsius?
VantagePoint Power Users and Modelers are the users most likely to build dashboard displays.
Conceiving of a useful display can fall to anyone familiar with the nature of the source data.
How does Xcelsius fit into VantagePoint?
VantagePoint brings live data into Excel from diverse sources, bringing the Xcelsius dashboards to
life. Combining these two products yields the best possible presentation against the most possible
data in an easy to use point and click environment.
How do I use Xcelsius?
Xcelsius 2008 is a rich product and will enable building exciting, eye-catching dashboards that can be
displayed in the VantagePoint Portal. The product comes with its own extensive documentation and
tutorials. Exposing VantagePoint data with Xcelsius is aided by VantagePoint wizards within Xcelsius.
The wizards guide you in building the queries that feed data to the Xcelsius display. See Dashboard
Building in VantagePoint Help for more information.

Special note about using Xcelsius on VantagePoint Server computers


On computers running VantagePoint Server, VantagePoint runs an instance of Microsoft Excel in
the background. When Xcelsius runs, it needs to open an instance of Excel also, and will not be
able to if Excel is already running. So, prior to starting up Xcelsius, you would need to open Windows
Task Manager and kill the instance of Excel that VantagePoint is using. Note that this may impact
VantagePoint's ability to render reports. It is recommended to run Xcelsius on computers other
than the one running the VantagePoint Server.

517 of 878

The Source Files


.swf
The file used by Flash Player to animate the dashboard in the Portal. This file is created when you
Export your dashboard object in Xcelsius. This file needs to be exported to a local folder before it can
be published to the Portal using dashboard wizard tools.
.xlf
A saved Xcelsius project file. This is a source file that Xcelsius generates and can re-open. It includes
the dashboard objects and the embedded Excel file (.xls) used to create the dashboards. This file
needs to be saved locally before it can be saved into the VantagePoint Model. Saving the Project file
into the Model is a required when publishing the dashboard to the Portal
NOTE: In the interest of time, the graphic part of this lesson is already done for you. This
is the diagram below which essentially involves dragging 4 gauges and few labels onto the
canvas. Aside from this minor part all the data connection and configuration will be done
in this lesson.

518 of 878

Lab 1 Create Plant Overview Dashboard for


In this lab we will create a dynamic dashboard to display the line overview information for a selected
production line.
The end goal is to deliver the following dashboard where the user can select a line and see the
information shown for the selected line

519 of 878

Part A Get the data need for the report


In this part we go through an identical exercise as you would creating an excel report to retrieve the
needed data into our excel sheet
1. Verify that you are on the Server Image (Server tab is selected).

2. Close any open applications.


3. Use Ctrl-Alt-Insert to bring up Task Manager and End EXCEL.EXE Process.
NOTE: Since we are running the Xcelsius on the same image as VantagePoint Server, it is
necessary to end the instance of EXCEL before launching Xcelsius. Be aware that in
"actual applications" you may not want to have Xcelsius on the same computer as the
VantagePoint Server since it may be undesirable to stop the EXCEL instance on the
VantagePoint Server machine. This configuration is for training purposes.

520 of 878

4. Launch Xcelsius 2008


a. Start> All Programs > Xcelsius > Xcelsius 2008
b. Click Continue on the Trial evaluation notification screen

NOTE: While Xcelsius 2008 is opening you may get the following dialog box. Wait 30
seconds and click Retry

5. Open the template Xcelsius file following the steps below:


a. From the File menu (the Xcelsius menu, not the Excel menu) select Open

b. Browse to the C:\Class Files\Templates folder


c.

Select Line Dashboard Template.xlf

d. Click Open
6. Save the template file to Line Dashboard.xlf on the C:\ root folder following the steps below:
a. From the File menu (the Xcelsius menu, not the Excel menu) select Save As

521 of 878

b. Browse to the C:\ folder


c.

Type Line Dashboard.xlf

d. Click Save

7. Initiate the process of retrieving current Line over view data (LineInfo) and inserting them into the
selected Excel cells following the steps below:
a. In the Excel area of the interface, Select cell C3 (red cell)
b. Select the VantagePoint ribbon
c.

Click Insert

522 of 878

d. Select Current Value


e. Click the Use advanced Type Mapping features check box. Checking this box tells
VantagePoint that we will be selecting a type within the model to create a report against
f.

Click Next

Tip: It is a Good Practice to describe and document each VantagePoint query name and
descriptions fields.

523 of 878

8. The Type Selection view is presented. VantagePoint wants to know what we want to pass to the
History function which we selected in the previous item. We can do this either by selecting the
type of the desired item or select an example of the type using the items view. We select an
example or instance of our desired type (MyPlant.Line.Info) by following the steps below:
a. Select the Items that contain Core.Tags option
b. Navigate to MyEnterprise>MyPlant>Tags>Bl1 and select Line1Info which is an instance of
the MyPlant.Line.Info type
NOTE: The MyPlant.Line.Info now shows up in the selected type field. This is what we are
interested to get out of this step.
c.

Click Next

524 of 878

9. The Item Selection view is now presented. VantagePoints reporting wizard is essentially
showing all instances of the type MyPlant.Line.Info in case we wish to select them (in this case
there is only one and it has already been selected) Because we will be building a report that
reports against all instances of the MyPlant.Line.Info type, (even if there were more instances of
this type), we leave the current selection to one and click the Next button to continue.

525 of 878

10. Note that the Chosen Type, a Sample Item and Required Type for our selection are shown.
Furthermore there are messages providing details of what we have chosen, and what we need to
do next. Click Next

11. From the Item Name window select all the tags and move them to the Type: Core.Tag window
and Click Next

526 of 878

12. The Parameter Creation view is now presented. Configure the parameters as follows:
a. Check the box labeled Make this an External Parameter when Published. Checking the
box will indicate to VantagePoint that the report accepts parameters of the Type
MyPlant.Line.Info
b. Change the Name to Line from Infos to make the name a little user friendlier and also give
the indication to the user that they can only select one Line (needless to say this is an
optional change and sill depend on your project requirements)
NOTE 1: The constraints on the parameter, with a max range of one parameter for the type
at a time are selectable.
NOTE 2: The Range containing Mapped Items fields indicate where in the report the fields
of the type will be located. This field, if referenced at the end of the Wizard, will contain the
tags being used by the report itself.

527 of 878

13. Leave the default columns to be displayed as they are


a. Click Finish
NOTE: It may take several seconds for the data to populate the excel workbook

b. Verify that you have data


NOTE: You will most likely have different data than what is shown here

528 of 878

Part B Wire the data to their corresponding graphics object


In this part we connect the objects on the canvas to the data which we just configured to retrieve.
1. Configure Label 6 to display the Batch ID which is in cell F5 following the steps below:
a. Select Label 6
b. Verify/Select the General icon
c.

Select the Link to Cell option

d. Click the browse to cell icon

e. Select cell F5
f.

Click OK

NOTE: The Batch ID now show up on the dashboard

2. Configure Label 7 to display the Product Code which is in cell F8 following the steps below:
a. Select Label 7
b. Verify/Select the General icon
c.

Select the Link to Cell option

d. Click the browse to cell icon

529 of 878

e. Select cell F8
f.

Click OK

NOTE: The Product Code now shows up on the dashboard

3. Configure Label 8 to display the Machine Active which is in cell F6 following the steps below:
a. Select Label 8
b. Verify/Select the General icon
c.

Select the Link to Cell option

d. Click the Browse to cell icon

e. Select cell F6
f.

Click OK

NOTE: The Machine Step now shows up on the dashboard

530 of 878

4. Configure Label 9 to display the Machine Step which is in cell F7 following the steps below:
a. Select Label 9
b. Verify/Select the General icon
c.

Select the Link to Cell option

d. Click the browse to cell icon

e. Select cell F7
f.

Click OK

NOTE: The Machine Step now shows up on the dashboard

531 of 878

5. Configure Zone 1 Gauge to display Zone 1 Temperature which is in cell F9 following the steps
below:
a. Select the Zone1 gauge
b. Verify/Select the General icon
c.

Change the Maximum Limit to 200

d. Click the Data By Range option button


e. Click the Data browse to cell icon

f.

Select cell F9

g. Click OK
NOTE: The Zone 1 Temperature now shows up on the dashboard

532 of 878

6. Configure Zone 2 Gauge to display Zone 2 Temperature which is in cell F10 following the steps
below
a. Select the Zone2 gauge
b. Verify/Select the General icon
c.

Change the Maximum Limit to 200

d. Click the Data By Range option button


e. Click the Data browse to cell icon

f.

Select cell F10

g. Click OK
NOTE: The Zone 2 Temperature now shows up on the dashboard

533 of 878

7. Configure Zone 3 Gauge to display Zone 3 Temperature which is in cell F11 following the steps
below
a. Select the Zone3 gauge
b. Verify/Select the General icon
c.

Change the Maximum Limit to 200

d. Click the Data By Range option button


e. Click the Data browse to cell icon

f.

Select cell F11

g. Click OK
NOTE: The Zone 2 Temperature now shows up on the dashboard

534 of 878

8. Configure Zone 4 Gauge to display Zone 4 Temperature which is in cell F12 following the steps
below
a. Select the Zone4 gauge
b. Verify/Select the General icon
c.

Change the Maximum Limit to 200

d. Click the Data By Range option button


e. Click the Data browse to cell icon

f.

Select cell F12

g. Click OK
NOTE: The Zone 2 Temperature now shows up on the dashboard

535 of 878

9. As can be seen the temperature values for each zone needs to be reformatted
a. Select Zone1
b. Select the Appearance icon
c.

Select Value

d. From the number format combo box select Numeric


NOTE: The value will now have just 2 decimal places

10. Repeat the previous step and verify that all your gauges have proper format similar to whats
shown below

536 of 878

11. We now need to add the title to our report We like label 10 to display the currently selected line
by following the steps below:
a. In Excel Cell C15 enter the text Machine for documentation purposes.
b. In Cell D15 enter the formula =MID(D5,31,5)
NOTE: When you enter this formula the text Line1 will appear in cell D15 from the string
st
in cell D5, 5 characters starting with the 31 character)

c.

We now have a value to reference to for our report title

537 of 878

12. Configure Label 10 to display the Line Number which is calculated in cell D15 following the
steps below:
a. Select Label 10
b. Verify/select the General icon
c.

Select the Link to Cell option

d. Click the data browse to cell icon

e. Select cell D15


f.

Click OK

NOTE: The Line number will appear in the title

538 of 878

13. As a final touch, lets add some color to our very bland dashboard by adding Alarm bands to our
gauges following the steps below:
a. Select Zone1 gauge
b. Select the Alerts icon
c.

Check the box Enable Alerts

d. Under Color Order set the option High Values are good

14. Repeat the above step for the remaining gauges.

You may want to save your work just in case


We are done with this part which was to create a graphic user interface and wire" the objects on the
canvas to corresponding data sources. There are many objects and many formats to make
impressive dashboards. Even with our simple dashboard here, you can add alarms and other
properties to make them more interesting. Aside from the visuals, Xcelsius can also be a powerful
Business Intelligent (BI) platform. As Xcelsius is not the main focus of this training, please refer to
online help and many commercially available books to learn more about Xcelsius.
539 of 878

Part C Configure and Expose Parameters for flash report


When we finally compile the dashboard as a swf file (Flash) document, we will need to expose
parameters to the flash file that VantagePoint can write to. First well import the xml maps in the
workbook to Xcelsius; well then import the named ranges from the Workbook to Xcelsius, so these
named ranges can be exposed as parameters to the flash report.
1. Add Connection following the steps below:
a. From the Data menu in Xcelsius (not the Excel menu) select Connections

b. Click Add, and select Excel XM Maps

540 of 878

c.

Click Add again and select Flash Variables

2. Import Named Ranges following the steps below:


a. Click on Connection 1 Flash Variables
b. Click Import Named Ranges
NOTE: This action imports the named ranges from the Excel workbook; so unless you
changed the name of a named range, at minimum you should see the ranges shown in the
diagram below. If you happen to have added other named ranges you will see them as
well.

541 of 878

3. Configure the XMLDataURL Map Excel XML Map following the steps below
a. Click on XMLDataURL Map Excel XML Map
b. Select the Usage tab

c.

Check the Refresh Before Components Are Loaded checkbox

d. Check the Refresh Every checkbox


e. Set the refresh time to 2 seconds
f.

Finally, select the Definition tab

g. Notice that the name of the XML map that Xcelsius found is the name we gave our map in
the beginning of this lab, which in this case was the default XMLDataURL_Map. Select it and
ensure you are on the Definition tab.
h. Select the Excel button next to XML Data URL.

i.

Select cell C3 (red cell)

NOTE: This cell is the starting point for the Insert Current Value function
j.

Click OK

542 of 878

k.

XMLDataURL Map Excel XML Map is configured

l.

Click Close

543 of 878

Part D Compile and publish the dashboard


The dashboard is designed, and how it communicates with VantagePoint is defined. In this part we
will compile the dashboard and publish it to VantagePoint Portal
1. Save the file as LineDashboard in the root C:\ directory following the steps below:
a. From the Xcelsius (not the Excel) File menu select Save As

b. Browse to the root of C:\


c.

Change the file name to LineDashboard.xlf

d. Click Save
NOTE: You must save the file before you can publish the dashboard

544 of 878

2. Export the file to Flash following the steps below:


a. From the file menu select Export > Flash (SWF)

b. Browse to the root of C:\


c.

In the file name textbox enter LineDashboard.swf

NOTE: It is a best practice to have a same name for both the saved and export file
d. Click Save
NOTE: You must export the file before you can publish the dashboard

NOTE: You will see the following dialog while the SWF file is being generated

545 of 878

3. Publish the Dashboard to VantagePoint portal following the steps below:


a. From the VantagePoint Ribbon in the Excel window of Xcelsius, select Publish.

b. Click the Flash files icon to select the SWF file

c.

Browse to the root of C:\

d. Select the LineDashboard.swf file


e. Click Open

546 of 878

f.

Click the Project files icon to select the project file

g. Browse to the root of C:\


h. Select the LineDashboard.xlf file
i.

Click Open

j.

Files are now selected

k.

Click Next

547 of 878

l.

This dialog box reminds us that the dashboard has an external parameter called Line

m. Click Next
NOTE: It may take several seconds for the Report Folder Selection dialog to appear

n. Browse from the MyEnterprise > MyPlant > Reports


o. In the Name textbox enter LineDashboard
p. Click Next

548 of 878

q. Check the Browse to published dashboard check box


r.

Click Finish

NOTE: It may take several seconds for the Line1 Dashboard to open

4. Your dashboard report should now appear in the portal. Verify that information is changing. Also
verify the line change operation.

Congratulations, you just completed this lab and lesson

This lab and lesson is complete

549 of 878

This page intentionally left blank

550 of 878

Lesson 14 Charts and Grids

What you will learn:

How to Create Data Grid and Charts using Time series Query
How to Create Data Grids and Charts using Database Query
How to Configure Content Rules

Prerequisite:

Completion of Lesson 2 (if you did not, you can use tags from Sample DB)
Completion of Lesson 8 (If you did not, you can use queries from IncuitySample DB)

Additional Info

Appendix C provides additional Information about the Charts & Grids Application

Discussion
Overview
The Charts and Grids Application has been created to offer FTVantagePoint users an easy to use
means of creating simple Chart and Grid style Web based reports. The target audience for this
toolset is users who want to take the results of either a database query or a Time Series (History)
request and show that data on a web page in either tabular (grid) or chart formats. This application
does not require the use of any report designer interfaces and does not rely on Excel. Rather, items
are configured in the FTVantagePoint model which specifies both the definition of the data to be
retrieved as well as the rules to format that data.

License and Support


This application is provided As Is without license and is free for RA customers to use. It is the
intention of the FTVantagePoint Product Management team to provide similar functionality in future
releases of the product, as a result the functionality in this application may be superseded.
Furthermore, it should be assumed that there is no guarantee that this application will upgrade to
any new features in future versions of FTVantagePoint.

551 of 878

Installation
The installation of Charts & Grids application affects the following VantagePoint areas: Portal.
Manager, Types, and Primary Files as follows:
Portal
A new menu item under reports called ChartsAndGrids take you to the list of sample reports.

Manager
The following items are added to the model.

552 of 878

Types
The following package is added.

Primary Files
The following files, added to C:\inetpub\wwwroot\IncuityPortal, are used to display the various
types of reports.

553 of 878

Lab 1 Quick Tour of Charts and Grids


In this very short lab, well browse through a few sample screens to get a flavor of the Charts and
Grids application. We will create our own Charts and Grids reports in the upcoming labs.
1. Verify that you are on the Server Image (Server tab is selected).

2. Launch VantagePoint Portal.


3. Select ChartsAndGrids from the Reports on the menu bar.

4. Select Downtime Duration Doughnut Chart.

554 of 878

5. Clicking on the Line Pressure Low slice will produce the following report:

6. Click on Browsers previous screen to get back to the Doughnut report


7. Try other charts and grids reports to get an idea for the possibilities

This lab is complete

555 of 878

Lab 2 Create Data Grids


One of the goals of this application is to make it easy for users to display tabular data in a grid within
the FTVantagePoint Portal (or other web applications). This section of the document will walk you
through the process of creating Data Grid output from both Database Linked Queries and Queried
Time Series Requests.

Part A Create Data Grids using a Time Series Query


In this part, we will use the RA.CE.ChartAndGridElements.TimeSeriesQuery to create a data grid
report to display the temperature information for the last 30 minutes for the Bread Line 1.
1. Create a new Grid Format following the steps below:
a. Launch VantagePoint Manager
b. Navigate to MyEnterprise>MyPlant>Reports
c.

Right-click on Reports, and select New > Item

d. Select RA.CE.ChartAndGridElements.GridFormat.
e. Click Create

556 of 878

f.

Configure the new grid format a s below:


i. Name:

BL1 Zone Temperature - 30 Min

ii. Title:

Line 1 Zone Temperatures

iii. Sub Title:

30 Minute Raw Data

iv. Leave the other properties (all style related) with their default settings and click Create.

2. Create a new TimeSeriesQuery (30 minute wide) request itme for the grid format we just created
following the steps below:
a. On the newly formed RequestItem, Right-click and select New Item

557 of 878

b. Select RA.CE.ChartAndGridElements.TimeSeriesQuery and click on Create

NOTE: There are two different types of Request Items. The TimeSeriesQuery is used to
return historical data from a historical data source. The DatabaseQuery request item to
fetch data from a database.
c.

Cick on the browse button (ellipsis) for the QueriedTimeSEriesRetrievalSpec

d. Browse to System > Solutions >ModelDrivenContent > ChartsAndGrid >


TimeSeriesRequestSamples and select Raw Request 30 min Wide
e. Click on Assign.

558 of 878

NOTE: There are a number of Sample Request Items in the Solution.Model Driven
Content folder.

f.

The configured RA.CE.ChartAndGridElements.TimeSeriesQuery should look as follows;


click Create to complete the item creation

g. We should now have this construct under the Reports folder. Next we will add the tags
which this report is suppose to show.

559 of 878

3. Add the the 4 temperature Zones from Bread line 1 to be shown by this grid report by adding a
shortcut to them in the Tags folder of the newly generated Grid report, follwing the steps below:
a. Navigate to MyEnterprise>MyPlant>Tags>Program:Proof_Oven and select the four
temperatures SimpleTempZone1 through 4
b. Right-click on the 4 selected tags, and select copy

c.

Navigate back to MyPlant>Reports>BL1 Zone Temperature 30 Min>RequestedItem

d. Right-click on Tags, and select Paste Shortcuts

560 of 878

e. The tag configuration for newly created grid report should look as follows:

f.

The report setup is completed

4. View the report in the portal following the steps below:


a. Launch VantagePoint Portal (if it was already open refresh using F5)
b. Navigate to MyEnterprise>MyPlant>Reports
c.

Select the BL1 Zone Temperature 30 Min

5. Note the first and the last rows time stamp which should be 30 minutes apart. Also note the
column titles which provide the FQN for the four selected temperature zones.
Congradulation you created your very first grid report using a time series query.

561 of 878

Part B Create Data Grids using a Data Base Query


In this part, we will use the RA.CE.ChartAndGridElements.DatabaseQuery to create a data grid
which would display the data retrieved by the Equipment Database query we created in the External
Database connectivity lesson. If you did not finish that lesson, you can use one of the queries from
the IncuitySample database.
1. Create a new Grid Format following the steps below:
a. Launch VantagePoint Manager
b. Navigate to MyEnterprise>MyPlant>Reports
c.

Right-click on Reports, and select New > Item

d. Select RA.CE.ChartAndGridElements.GridFormat. Click Create

562 of 878

e. Enter the following for the new Grid Format Item:


i. Name:

Equipment Data

ii. Title:

Equipment Data

iii. Sub Title:

State and Temperature Information

iv. Leave the other properties (all style related) with their default settings and click Create.

2. Create a new DataBase Query for the newly formed RequestItem, following the steps below:
a. Right-click on RequestedItem and select New Item

563 of 878

b. Select RA.CE.ChartAndGridElements.DatabaseQuery and click on Create

c.

Cick on the browse button (ellipsis) for the DatabaseLinkedQuery

d. Browse to System > Sources >Db > MsSql > ProductionData > Queries and select
EquipmentData
e. Click on Assign

564 of 878

f.

The configured RA.CE.ChartAndGridElements.DatabaseQuery should look as follows;


click Create to complete the item creation.

g. We should now have this construct for the equipment Data report under the Reports folder.

3. View the report in the portal following the steps below:


a. Launch VantagePoint portal (if it was already open refresh using F5)
b. Navigate to MyEnterprise>MyPlant>Reports
c.

Select Equipment Data

Congratulations you created your very first grid report using a DB query

This lab is complete

565 of 878

Lab 3 Create a Chart using a Time Series Query


In addition to grids, the Charts and Grids application also provides the ability to represent data from
database queries and time series requests in a number of different chart formats. This section will
walk through the basics of creating Charts from both time series requests and database queries.
The process is basically the same as creating Data Grids (shown above) however the formatting
options change a bit to cater for the specific requirements associated with building charts. All of the
Charts in this application assume at least two series of data: One X Series and one or more Y data
series. In both cases data series are mapped to columns of data returned by the request (either DB
or Time Series). As a result it is necessary to understand what the resulting data set will look like
(minimally know the column names) so that data series can be properly created.
In this slab we create a chart report for four zone temperatures for Bread Line 1
1. Create a new Chart Format following the steps below:
a. Launch VantagePoint Manager
b. Navigate to MyEnterprise>MyPlant>Reports
c.

Right-click on Public, and select New > Item

d. Select RA.CE.ChartAndGridElements.ChartFormat.
e. Click Create

566 of 878

f.

Enter the following for the new ChartFormat Item:


i. Name:

BL1 Zone Temperature Profile

ii. Title:

Bread Line 1 Zone Temperature Profile

iii. Sub Title:

30 Min of Raw Data

iv. Leave the other properties (all style related) with their default settings and click
Create.

2. Create a new TimeSeriesQuery (30 minute wide) request itme for the grid format we just created
following the steps below:
a. On the newly formed RequestItem, right-click and select New Item

567 of 878

b. Select RA.CE.ChartAndGridElements.TimeSeriesQuery and click on Create

c.

Cick on the browse button (ellipsis) for the QueriedTimeSEriesRetrievalSpec

d. Browse to System > Solutions >ModelDrivenContent > ChartsAndGrid >


TimeSeriesRequestSamples and select Raw Request 30 min Wide
e. Click on Assign.

NOTE: Any RA.CE.ChartAndGridElements.Request item could be used for the chart,


including request items already used for grids.
568 of 878

f.

The configured RA.CE.ChartAndGridElements.TimeSeriesQuery should look as follows;


click Create to complete the item creation.

g. We should now have this construct under the Reports folder. Next we will add the tags which
this report is suppose to show.

569 of 878

3. Add the the 4 temperature Zones from Bread line 1 to be shown by this grid report by adding a
shortcut to them in the Tags folder of the newly generated Grid report, follwing the steps below:
a. Navigate to MyEnterprise>MyPlant>Tags>Program:Proof_Oven and select the four
temperatures SimpleTempZone1 through 4
b. Right-click on the 4 selected tags, and select copy

c.

Navigate back to MyPlant>Reports>BL1 Zone Temperature Profile>RequestedItem

d. Right-click on Tags, and select Paste Shortcuts

570 of 878

4. The tag slection is done. We will next configure the X-axis to be the TimeStamp by following the
steps below:
a. Right-click on XSeries and select New Item

b. Enter the following for the new ChartXSeries:


i. ColumnName:

TimeStamp

ii. DateType:

DateTime

iii. Leave the other properties with their default settings and click Create.
NOTE: The ColumnName entry needs to match the associate column name returned in the
Data Set.

5. Create a new ChartSeries (YSeries) for each column in the Data Set (in this case Zone1-4
temperatures) that needs to be represented in the chart by following the steps below:
a. Right click on the YSeries collection and select New -> Item.

571 of 878

b. The first series we configure is Zone1 temperature. The Name property is somewhat
arbitrary but the ColumnName property is critical. It must match a column returned in the
Data Set. We will do this by copying the FQN of each needed tag from the RequestItem list
that we just created, and paste it into the ColumnName field.

c.

Navigate to the Tags folder within the report that we are configuring (BL1 Zone Temperature
Profile) and copy the FQN of the SimpleTempZone1
MyEnterprise.MyPlant.Reports.BL1 Zone Temperature
Profile.RequestItem.Tags.SimpleTempZone1

572 of 878

6. For the SimpeTempZone1 Series enter the following properties:


a. Name:

Zone1

b. ColumnName:

MyEnterprise.MyPlant.Reports.BL1 Zone Temperature


Profile.RequestItem.Tags.SimpleTempZone1

c.

DisplayName:

Ramp

d. DataType:

Number

e. ChartType:

Line

f.

PointMaker:

Circle

g. Repeat this process for the remaining 3 temperature zones, configuring them the exact same
way, with the only difference being the name, display name, and the ColumnName reflecting
Zone2, 3, and 4 as shown below:

573 of 878

574 of 878

7. Once complete the BL1 Zone Temperature profile should look as follows:

8. View the report in the portal following the steps below:


a. Launch VantagePoint Portal (if it was already open refresh using F5)
b. Navigate to MyEnterprise>MyPlant>Reports
c.

Select the BL1 Zone Temperature 30 Min

Congradulations you just created your very first chartreport using a Time Series query.

This lab and Lesson is complete

575 of 878

This page intentionally left blank

576 of 878

Lesson 15 Portal Type Rules and Status Item

What you will learn:

Portal Type Rules


Status Item
ContentTypes
ContentContainers

Prerequisite:

Completion of Lesson 9 for MyPlant.Line.Info and its instances

Content rule leveraging MyPlant.Line.Info type and its instances are used to demonstrate the
automatic hyperlink creation of the Status Item. The MyPlant.Line.Info type is also used for the
ContentTypes and ContentContainers lab and discussion.

Discussion
As you will learn in this lesson, StatusItem can leverage the ContentType and ContentContainer offers.
As such these there topics are all presented in this same lesson.

Enhancing Model Views with ContentTypes and ContentContainers


Items that are not reports (traditional content), do not display in the portal. To display these items in
the portal, you need to define these items as ContentTypes, and then link them to reports and other
viewable content. Viewable content is content that the Portal can render; It includes reports, trends,
html, dashboards and links to external web-accessible content.
Most of the time, reports are published into folders and, for performance reasons, the Portal is
designed to search only folder structures in the model looking for published content to display.
However, VantagePoint allows publication of reports into item types other than folders. For this
reason, it is necessary to specify additional item types that the Portal should search (in addition to
Core.Folders) looking for content items.
ContentContainerTypes allow you to identify new types that are capable of containing content. This
new container indicates to the Portal that it should be searched when looking for content. For
example, a Lines item displays in VantagePoint Manager under MyEnterprise > Documentation
Examples > Advanced > Production > Chicago Plant. Although Lines has reports associated with
it, users cannot see the reports in the Portal because Lines is not a folder.
The solution is to create a container type and associate Line items with it. Once created, the Portal
will discover and display the content.

577 of 878

StatusItem Overview
StatusItem presents an excellent example of Model Driven Content, as it can show the current
status of a collection of items in the VantagePoint Model while leveraging instances of VantagePoint
Types.
StatusItems are simple types that allow users to determine if a given (defined by the user) condition is
good or bad. While this is basically the same functionality that can be derived from a discrete tag (true
= good, false = bad), the overall type design of the StatusItem allows for a generic reporting solution
to be created on user definable types.
StatusItems can be used on their own or implemented in other types.
There are several ways that one can use StatusItems. In Green Field implementations it is often
desirable to design new types that implement either StatusItems or StatusItemColleciton types.
However, this is not always an option or even desirable. There can be project implementations where
some of the types in the model do implement the StatusItemCollection type and others do not.
Fortunately StatusItem is flexible enough to be created and associated with existing items in the
model.
In general Status Items create an overview screen of your application without having to build a
report or dashboard. Based on the idea that almost every interesting data point can be defined as
either being in or out of an acceptable state, Status Items provide VantagePoint users with an out of
the box way to create an Overview that can display increasingly detailed content.
Benefits Include:

Required types and display pages are already created.


No development of reports or dashboards is required for status items.
Can be used with new and existing VantagePoint solutions.
StatusItems can be used stand-alone or implemented in other types.

Components of a StatusItem Solution


StatusItems at the simplest level are a new type introduced into the VantagePoint server, but a more
complete examination shows that they along with the supporting web interface and other
VantagePoint components provide building blocks that can be used in almost every VantagePoint
solution.

Base.Common.Package - This new type package introduces the StatusItem and


StatusItemCollection types.
Program Engine - New in VantagePoint 4.0, the Program Engine provides users with the
ability to create ProgramTags, Tasks and TypeHandlers. All of which are used in the Sample
content. Specific details of this functionality can be found in the various Sample Content
Descriptions.
Portal Content Rules - Rules that associate Item Types with content in order to display that
data in the VantagePoint Portal
Calculated Tags and Calculated Tag Templates - Provide a framework for providing logical
tests of various data types that return a discrete (Boolean) value.
GetStatusItemViewer.aspx - New Web Interface used to display data from
StatusItemCollections.

578 of 878

StatusItem Sample Content


The following section provides a breakdown of the functionality in each of the StatusItem Samples
under the MyStatusItems folder. All examples can be found in
MyEnterprise.Samples.MyStatusItems. In the descriptions below a detailed breakdown of each
sample is provided. A list of all instances and their related VantagePoint Type is provided. When
appropriate other VantagePoint components are listed as well to provide users with a better
understanding of how to build a complete solution. Additionally, with each description a section is
provided with steps users would go through to configure such an application with their own data.
SimpleTagExample
In this simplest of examples, tags are "wired up" to status items in a variety of ways to indicate how
simple it is configure StatusItems
KPI Example
This example makes use of a rich type that is intended to provide realtime indication of business
performance. By implementing the StatusItem Type, KPIs objects automatically gain the benefit of
having an overview screen associated with the already rich KPI object.
VantagePointSystemStatus
While still leveraging Tag Data, this example is intended to show how StatusItems can be used to
reflect the operational state of server.
Production Example
Integrating StatusItems into hierarchical model provides users with the ability to have StatusItems that
reflect child and grandchild collections of nested status items.
NOTE: As part of the VP 4.0 Sample Content development the existing KPI types along
with types in the FTVP.Samples package have been modified so that they now implement
StatusItems and StatusItemCollections. These changes are intended to add additional
functionality to the existing types, and serve as an example to users who might use
StatusItems in their own solutions.

579 of 878

Lab 1 - VantagePoint Portal Type Rules


1. Verify that you are on the Server Image (Server tab is selected)

2. In VantagePoint Manager, note that in previous lessons you have created two instances of two
different Types (MyPlant.Line.Info, and MyPlant.Oven.OvenSimple) as can be seen in the
diagram below

3. Notice that in VantagePoint Portal however, there is nothing displayed regarding these
Instances at this time. Only the folder structure and reports within folders are listed:

ContentContainerTypes allow you to identify new types that are capable of containing content.
This new container indicates to the Portal that it should be searched when looking for content. For
example, a Lines item displays in VantagePoint Manager under MyEnterprise > Documentation
Examples > Advanced > Production > Chicago Plant.
As you just noted, although these two type (MyPlant.Line.Info, and MyPlant.Oven.OvenSimple)
have reports associated with them, we cannot see the reports in the Portal because neither of the
two are folder.
In the remainder of this lab, we will create a container type rule for LineInfo and associate it with
the MyPlant.Line.Info type. Once created, the Portal will discover and display the content.

580 of 878

4. Close the VantagePoint Portal.


5. Create a LineInfo Type rule following the steps below:
a. Launch VantagePoint Manager
b. Navigate to System > Applications > Portal > Settings > ContentViewer
c.

Right-click on ContentTypes

d. Select New > item

e. Configure the content type item as below:

f.

i. Name:

LineInfo Type Rule

ii. ItemType Name:

MyPlant.Line.Info

Click Create

NOTE: MyPlant.Line.Info is the fully qualified Type name that was used to create the two
MyPlant.Line.Info instances (Line1Info and Line2Info in your model

581 of 878

6. Configure the newly created Type rule to associate it with a viewable content of its type (BL
Comp Overview Trend) following the steps below:
a. Navigate to the newly created LineInfoType Rule (System > Applications > Portal >
Settings > ContentViewer>LineInfoType)
b. Right-click ViewableContent and select New > Item

c.

Select Portal.ViewableReportContent

d. Click Create

582 of 878

e. Configure the ViewableReport Content as follows:


i. Name :

BL Comp Overview Trend

ii. DisplayName:

BL Comp Overview Trend

iii. DisplaySequence:

Default 0

iv. Show Activity bar:

(Checked)

v. Do Not Show Full Screen (Unchecked)


f.

Click the ellipsis button to the right of Report:

g. Navigate to your Reports folder (MyEnterprise>MyPlant>Reports) and select BL Comp


Overview Trend report. This is a report that was created based on the MyPlant.Line.Info
Type. Click Assign:

583 of 878

h. The selected reports FQN (split between the scope and report field) completes the
configuration.
i.

Click Create

j.

You should see this report listed under LineInfo Type Rule > ViewableContent

7. Create one more viewablecontent for LineInfo Type rule, this time for LineDashboard following
the steps below
a. Navigate to LineInfoType Rule (System > Applications > Portal > Settings >
ContentViewer>LineInfoTypeRule)
b. Right-click ViewableContent and select New > Item

584 of 878

c.

Select Portal.ViewableReportContent

d. Click Create

e. Configure the ViewableReport Content as follows:


i. Name :

LineDashboard

ii. DisplayName:

LineDashboard

iii. DisplaySequence:

iv. Show Activity bar:

(Checked)

v. Do Not Show Full Screen (Unchecked)


vi. In the same manner as previous step, use the ellipsis button to the right of Report
and browse through the model to your Report folder
(MyEnterprise>MyPlant>Reports) and select your LineDashboard report. This is
another report that was created based on the MyPlant.Line.Info Type
f.

Click Create

NOTE: For the report name, you cant simply type in .LineDashboard as this is not the
entire FQN (Note the scope field which contains the parent part of the FQN). So you either
need to type in the entire FQN (in this case MyEnterprise.MyPlant.Reports.LineDashboard)
or simply browse for the file.

585 of 878

8. Launch VantagePoint Portal and navigate to the MyPlant. Notice that the rules you created have
caused the BL COMP Overview Trend and LineDashboard reports to be displayed. Since
these type were under the Tag folder, the parent folder needed to get to these reports are also
exposed ( things to consider when naming folders and where to place type content)

9. Click on the BL Comp Overview Trend reports under both BL1 and BL2 folders and verify they
are showing trends based on either BL1 or BL2 data. If you wish, expand the Tag List at the
bottom of the trends to verify they are indeed showing the correct BL1 or BL2 tags.

586 of 878

10. Click on the LineDashboard reports under both BL1 and BL2 folders. Note that they are
displaying realtime data for either Line, depending on which location you selected from.

NOTE: The Content rule automatically generated all the reports configured for the
selected type. These generated reports, being type mapped reports, are automatically
associated with the correct instance of the type eliminating the need to get through
parameter list.
The combination of type mapped report and content type rule can translate into very rapid
and consistent content development.

This lab is complete

587 of 878

Lab 2 Status Item


In this lab well create a status item hierarchy from the Plant to line and to the workcell. Since much of this
work is repetitive, well keep the hierarchy to three levels as shown below

The requirement for this status indication is simple:


For Machine, Active is normal (green), Inactive is abnormal (red)
For Oven, Zone 1 temperature below 210 is normal (green) Otherwise it is abnormal (red)
At Line Level, it is the logical AND of the cell status (all cells have to be OK for the line to be OK)
At Plant level it is the logical AND of all the line status (all lines have to be OK for the lines to be
OK)

588 of 878

Part A- Create the needed calculated tag


1. Since the temperature being under 210 is the normal state and we plan to show all the good state
as true and visually indicate it with green color, we will create a calculated tag to be true (normal
condition) whenever the temperature is below 210 following the steps below
Please note that we can certainly do this check at the source, and in a real life application we
probably should, but here, we are trying to show the concept.
a. Launch VantagePoint
b. Navigate to MyEnterprise > MyPlant > Tags
c.

Right-click on Calculated folder

d. Select New > Item

589 of 878

e. Under Types Tab browse to and select Core.Tag


f.

Expand Connector.Incuity.Calculation.Tag

g. Select Connector.Incuity.Calculation.DiscreteTag
h. Click Create

i.

Enter the following for the Name


Line1 Zone1 Under 210

j.

Click Edit Expression

590 of 878

k.

Click If

l.

Double click on Condition to select it (it gets highlighted)

m. Click Item Value

n. Browse to MyEnterprise > MyPlant > Reports > Tags > Line1Info and select TempZone1

591 of 878

o. Modify the tag expression to check for the temperature being under 210 (highlighted in
yellow)
If( Value("MyEnterprise.MyPlant.Tags.BL1.Line1Info.TempZone1") <
210 , TRUE, FALSE)
p. Click Test Expression to make sure the calculate tag is configured correctly.
q. Click OK

r.

Your calculated tag should look as follows.

s.

Click Create

592 of 878

2. Repeat the previous step, and create another calculate tag called Line2 Zone 1 Under 210
doing the same calculation but this time with the Zone1 temperature tag in line 2. The tag
configuration should look the same as follows:
If( Value("MyEnterprise.MyPlant.Tags.BL2.Line2Info.TempZone1") <

3. You should now have two new calculated tags.

593 of 878

210 , TRUE, FALSE)

Part B Create the Status Item hierarchy


The Status Items can be configured by referencing any Discrete (Boolean) tag in the model. In this
lab, Calculated Tags (for zone temperature check) as well as discrete tags from the Livedata
(MachineActive) are being used to create the target status item hierarchy.
The procedure is fairly straight forward. We will first create an instance of StatusItemCollection called
Plant Overview which will be a collection of Line statuses.
We will then create an instance of StatusItemCollection called Line 1 Overview which will be a
collection of equipment statuses.
Finally we will create two instances of StatusItem, one representing the Machine Status, and the
other Oven Status.
We will then repeat the previous two steps to create a second line and equipment under it.

594 of 878

1. Create an instance of StatusItemCollection called Plant Overview following the steps below:
a. Launch VantagePoint Manager
b. Navigate to MyEnterprise > MyPlant
c.

Right-click on Reports

d. Select New > Item

e. Select Base.Common.StatusItemCollection
f.

Click Create

595 of 878

g. Configure the Plant Overview status Item as follow


i. Name:

Plant Overview

ii. Description:

Collection of Status Items representing the status of the Plant

iii. Display Name:

Plant Overview

iv. Definition:

This collection will have a red indicator anytime the status of a


line is in red condition

NOTE: The Description and the Definition field will show up in the Portal when the user
clicks on the status item information icon

2. Create an instance of StatusItemCollection called Line 1 Overview following the steps below:
a. Right-click on StatusItems under the Plant Overview status we just created.
b. Select New > Status

596 of 878

c.

Select Base.Common.StatusItemCollection

d. Click Create

e. Configure the Line 1 Overview status Item as follow


i. Name:

Line 1 Overview

ii. Description:

Collection of Status Items representing the status of the Line 1

iii. Display Name:

Line 1 Overview

iv. Definition:

This collection will have a red indicator anytime the status of a


equipment in Line 1 is in red condition

597 of 878

3. Create an instance of StatusItem called Line 1 Machine Status following the steps below:
a. Under the Line 1 Overview Statust Item just created, Right-click on StatusItems
b. Select New > Item

c.

Select Base.Common.StatusItem

d. Click Create

598 of 878

e. Configure the Line 1 Machine Status Item as follow


i. Name:

Line 1 Machine Status

ii. Description:

Status of the Line 1 Machine

iii. Display Name:

Line 1 Machine Status

iv. Definition:

This status will have a red indicator anytime Line 1 Machine


is not Active

v. ContentItemFQN:

MyEnterprise.MyPlant.Tags.BL1.Line1Info

NOTE: The description in the ContentItemFQN will cause any content (dashboard, etc.)
that are associated with the item to show their links on the status items.

f.

Browse to MyEnterprise > MyPlant > Tags > BL1 > Line1Info

g. Select MachineAcitive
h. Click Assign

599 of 878

i.

Your configuration for Line 1 Machine Status should look as follow

j.

Click Create

4. Under the Line 1 Overview Statust Item, create another instance of StatusItem called Line 1
Oven Status following the steps below:
a. Right-click on StatusItems
b. Select New > Item

c.

Select Base.Common.StatusItem

600 of 878

d. Configure the Line 1 Oven Status Item as follow


i. Name:

Line 1 Oven Status

ii. Description:

Status of the Line 1 Oven

iii. Display Name:

Line 1 Oven Status

iv. Definition:

This status will have a red indicator anytime Line 1 Oven Zone1
is above 210 degrees

v. ContenItemFQN:

MyEnterprise.MyPlant.Tags.BL1.Line1Info

e. Browse to MyEnterprise > MyPlant > Tags > Calculated


f.

Select Line1 Line1 Zone1 Under 210

g. Click Assign

601 of 878

h. Your configuration for Line 1 Oven Status should look as follow


i.

Click Create

5. Congratulations, you just finished the first line of your Plant.

6. Repeat steps 2 through 4 to create the second line and its associated Machine and Oven status.
In doing so, use BL2.Line2Info whenever BL1.Line1Info was used, as well as the appropriate
calculated tag. Also document your references to Line 2 instead of Line 1.

602 of 878

7. When done, your Plant Overview Status item and the hierarchy underneath it should look as
follows:

603 of 878

Part C View Status Item in the Portal


In this part we will verify the operation of the status items we just created and get familiar with the
automatic content it generates.
1. Launch Vantage Portal.
2. Navigate to MyEnterprise > MyPlants > Reports.
3. Browse to and click on your brand new Status Item report, Plant Overview.
4. The Plant Overview status is displayed. Note how the Line 1 and 2 overview status is
correlated to the Plant Overview status
a. Click on Line 1 Overview

5. Note how the Machine and Oven Status is correlated to the Line 1 Overview status.
6. Note how the hyperlink to Composite Overview Trend and the Line Dashboard is automatically
placed on the status line. This is because we entered the item FQN during the configuration, and
all the reports complying with the content rule for this particular type will automatically appear.

7. Click on LineDashboard and note that it does in fact show the Line 1 instance of the dashboard.

604 of 878

8. Get back to the Plant Overview Status Item report and click on the Information icon for Line 1

9. Note how all your documentation appears in the items information dialog window. Also note the
detailed explanation of the tag that was calculated

10. Back in Plant Overview Status display , click on the Trend icon

11. Note that this is yet another automatic feature of the Status item, providing a realtime as well as
a historical profile of the status item

Congratulations, you just completed this lab and lesson. By wiring a discrete tag to the Status
Indicator, the StatusItem feature allows us to monitor the state of a machine in a dashboard overview.
We also learned that StatusItems adheres to ContentType rules allowing us to automatically wire
items in a collection to reports that utilize known types. The StatusItem types allow us to flatten a view
of a complex model in an easy to view dashboard without the need of building custom reports.
Please note that as it is the case with almost everything in VantagePoint you can leverage
StatusItems and StatusItemCollection with custom type packages to enhance, improve and speedup
the StatusItem development process.

This lab and lesson is complete

605 of 878

This page intentionally left blank

606 of 878

Lesson 16 SQL CLR

What you will learn:

How to connect to VantagePoint model via SQL Calls to stored procedures and functions
Combine datasets into a single reporting services report
Create reports that use cascading parameters (Line > Machine > etc.)
Also learn about
VantagePoint SQL CLR Projects
SQL Server Reporting Services
SQL Server Reporting Services Report Builder
Portal Content Type Rules

Prerequisite:
Completion of Lessons 9 & 10 Types and instances created in these two lessons are used in Lab1
of this lesson. If you did not however finish these lessons you can substitute another type and
instance that you do have (in sample or simulator section or something that you have created)
Understanding of SQL Server Reporting Services will be helpful.
Although all attempts have been made to explain the steps related to SQL Server Reporting Services,
any detailed discussions of these steps are out of the scope of this training. While you do not need to
know SSRS to complete this lesson, a working knowledge of SSRS is highly recommended should
you wish to utilize this feature in your projects.

607 of 878

Discussion
SQL CLR Overview
The VantagePoint SQL CLR feature provides you with the ability to talk to the VantagePoint model
via SQL calls to stored procedures and functions. The SQL CLR feature adds flexibility to the
reporting capabilities of VantagePoint through the support of SQL Server Reporting Services.
Consider using the SQL CLR feature with SQL Server Reporting Services to:

Combine datasets from multiple VantagePoint servers into a single Reporting Services
report.
Create reports that use cascading parameters. For example, a user selects a Line from the
model, and the list of Equipment is then filtered by the line which was selected.
Create lengthy, paginated reports such as a Batch report that are designed to be printed
easily.
Utilize features of Reporting Services with the VantagePoint model, including the following:
Sparklines and Data Bars
Charts and Gauges
Tables and Matrixes

608 of 878

SQL CLR and SQL Server Reporting Services


New to FactoryTalk VantagePoint EMI 4.5, SQL CLR objects allow users to call into the same web
services used by FactoryTalk VantagePoint EMI by making SQL calls. The result is a new interface
that allows users to leverage traditional database style reporting tools such as SQL Server Reporting
Services to retrieve and report on data that may or may not have been accessible to those reporting
tools natively.
Further, when using FactoryTalk VantagePoint EMI as a data source, the SQL calls used to fetch
history, execute queries, or get item properties is virtually the same regardless of what the underlying
data source may be. As a result report writers do not need to be experts in disparate data sources
such as MSSQL, Oracle, OPC and OPCHDA, rather they simply learn to make calls against
FactoryTalk VantagePoint EMI which will in turn fetch the data from the remote sources.

SQL CLR or SQLCLR


It is a technology for hosting of the Microsoft .NET common language runtime engine within SQL
Server. The SQLCLR allows managed code to be hosted by, and run in, the Microsoft SQL Server
environment.
This technology, introduced in Microsoft SQL Server 2005, allows users for example to create
managed code (Code that runs within the Common Language Runtime) objects like Stored Procedures
or Triggers in SQL Server.
Managed code uses Code Access Security (CAS), code links, and application domains to prevent
assemblies from performing certain operations. SQL Server 2005 uses CAS to help secure the
managed code and prevent compromise of the operating system or database server.

NOTE: If you want to use the SQL CLR feature in VantagePoint, you must install SQL
Server Reporting Services before installing this feature.
This feature can only be installed using the Custom Setup option during VantagePoint
server installation, and is disabled by default.

SQL Server Reporting Services


SSRS is Microsoft's answer to business reporting. It provides a unified, server-based, extensible, and

609 of 878

scalable platform from which to deliver and present information. Its scope extends from traditional
paper reports to web-based delivery and interactive content. SSRS can also be configured to deliver
reports to people's inboxes, file shares, and so on. SSRS is capable of generating reports in various
formats, such as the web-oriented Hypertext Markup Language (HTML) and desktop application
(Microsoft Excel and CSV) formats, thus allowing users to manipulate their data in whatever format is
required. In addition, SharePoint can be used as a front end for SSRS, allowing reports to be
presented directly in corporate portals.
SSRS is just one of the components in the Microsoft Business Intelligence (BI) platform. Combined,
these components provide an excellent platform for enterprise data analysis. The Microsoft BI
platform includes the following:

SQL Server: The traditional database engine, which also stores SSRS catalog data.
SQL Server Analysis Services (SSAS): A component for online analytical processing
(OLAP) and data mining. OLAP performs data aggregation and allows users to traverse from
aggregations to details looking through the dimensions (such as geography or time) of data.
Data mining helps users to discover patterns in data.
SQL Server Integration Services (SSIS): A component for extracting, transforming, and
loading (ETL) data.

SQL Server 2005, 2008 and 2008 R2 all come packaged with SQL Server Reporting Services
(SSRS) - an enterprise-level reporting solution. As mentioned, with SSRS, you can create, schedule,
publish, and manage a multitude of reports using a variety of data sources. SSRS leverages the
Business Intelligence Development Studio (BIDS) developer tool for all aspects of authoring and
deploying reports. BIDS is included with SQL Server 2008.

610 of 878

Although not necessary for this lab, there are a number of topics that you need to understand to
successfully build a report. A high level outline is as follows:

Reporting Services Components


Install Reporting Services
Business Intelligence Development Studio (BIDS)
Install Database
Create Report with Wizard
Create Report with Report Designer
Deploy Reports
Configure Report Manager Security

Reporting Services has a quite a few components that work together seamlessly to provide a
complete reporting solution. The full Reporting Services architecture includes development tools,
administration tools, and report viewers. There are a number of ways to get to Reporting Services
programmatically, including URL, SOAP and WMI interfaces.
The figure below shows a simplified diagram of the main Reporting Services components, some of
which we will be using in this lab.

A data source identifies the database (or other data object, such as an XML file) from which you wish
to pull data, and the connection properties used to connect to it - such as server name and login
credentials.
A dataset is the specific set of data requested - via a query or stored procedure execution - from the
data source. The dataset defines what data is available to display in the report.

611 of 878

Reporting Services provides two authoring environments to create report definition (RDL) files. A
report definition is a file in XML format that contains information about the data sources, report data,
and the report layout. A report definition does not contain data. When the report is processed, data
and layout are combined and passed to a report renderer that determines which data and layout
elements fit on each page.

Report Builder is a report authoring environment for business users who prefer to work in
the Microsoft Office environment. You work with one report at a time. You can modify a
published report directly from a report server. You can quickly build a report by adding items
from the Report Part Gallery provided by report designers from your organization.
Report Designer in Business Intelligence Development Studio is a report authoring
environment that is hosted in Microsoft Visual Studio. Use Report Designer project and
solution files to organize and maintain a master copy of report definitions, report parts, shared
data sources, shared datasets, and resource files such as images and ESRI shape files for
maps.

Report Manager is a Web-based report access and management tool that you use to administer a
single report server instance from a remote location over an HTTP connection. You can also use
Report Manager for its report viewer and navigation features.

612 of 878

Lab 1 Get Familiar with the VP CLR queries


In this lab we will configure the initial environment for the VP SQL CLR development, and also get
familiar with a few of the queries. For the complete list of Stored Procedures, Table-Valued Functions,
and Scalar-Valued Functions, please refer to the VantagePoint online help (index search for SQL
CLR)

Part A Configure / Setup a Project Folder and Datasource


A data source identifies the database (or other data object, such as an XML file) from which you wish
to pull data, and the connection properties used to connect to it - such as server name and login
credentials. In this part we will set the FactoryTalk VantagePoint CLR (FTVPCLR) database as a new
data source in the SQL Server Reporting Services (SSRS).
NOTE: The FactoryTalk VantagePoint CLR database is the default database created by the
VantagePoint SQL CLR installation process.
1. Verify that you are on the Server Image (Server tab is selected)

2. Open Report Manager. Using Internet Explorer, browse to http://Server/Reports (it will
redirect to http://Server/Reports/Pages/Folder.aspx)
NOTE: Server in the above URL is the name of the server which the SSRS is installed on,
which in this case happen to be called server (the image that you have been spending
most of your time in during this training)

613 of 878

3. Create a New SSRS Folder called RAFoods (arbitrary name) following the steps below
a. Click on New Folder.

b. Type in RAFoods for the name


c.

Click OK.

d. You should have a folder called RAFoods.

614 of 878

4. Create a New DataSource to FTVPCLR Database and name it FTVPVLR following the steps
below:
a. Click on New Data Source

b. Configure the new Data Source as follow


i. Name the DataSource FTVPCLR
ii. Make sure Enable this data source is checked
iii. Use the following Connection String:

Data Source=server;Initial Catalog=VantagePointCLR


iv. Set the user name to server\administrator ( arbitrary setup for this lesson)
v. Set the Password to rockwell
vi. Make sure the box for Use Windows Credentials is checked
c.

Click the Test Connection button

615 of 878

d. The Connection created successfully message should appear


e. Click OK to close the dialog.

f.

You should have a Datasource called FTVPCLR

616 of 878

Part B Configure a few Test Datasets to get familiar with few of the
VantagePoint queries
A dataset is the specific set of data requested - via a query or stored procedure execution - from the
data source. The dataset defines what data is available to display in the report. In this section we
write a simple query to get the number of lines and their names from VantagePoint.
1. Select FTVPCLR as a new data set following the steps below:
a. Click on the Report Builder button.

b. Click on New DataSet tab


c.

If FTVPCLR is not in the list,


i. click Browse other data source hyperlink near the bottom of the window

617 of 878

ii. Select FTVPCLR


iii. Click Open

iv. Choose FTVPCLR


v. Click Create

d. If challenged for credentials, enter the following, and then click the OK button.
i. User name:

server\administrator

ii. Password:

rockwell

618 of 878

You should now be in the SQL Server Report Builder. In the next few step, we will take a look at
the SQL CLR store procedures and functions that are available by looking at the VantagePoint
online help. We then try some of them in the SQL Server Report Builder against the model which
we will be looking at via VantagePoint Manager, to verify the SQL CLR operation against our
model.
2. Keep the SQL Server Report Builder open and do the following
a. Launch VantagePoint Portal
b. Launch VantagePoint Manager
c.

Arrange the three applications so you can see all three. Something like the below diagram, or
whatever you find convenient as we go through this section

619 of 878

3. In the VantagePoint Portal get information on SQL CLR by following the steps below:
a. From portal menu select Help > Content
b. Click on Index
c.

Type SQL CLR in the keyword window

4. The first query we will try is a Table-valued function called QueryItemsForItemTypeNames. If


you look it up in the online help, youll note that it simply returns all instances of the specified
type. So lets give it a try, following the steps below:
a. To find a type to try, you can either use a t type view or just navigate using item view to an
area of interest. Just navigate to any object that you like, and note its type. For example lets
navigate to MyEnterprise>MyPlant>Tags>BL1>Line1Info and note its Item type which is
MyPlant.Line.Info
NOTE: If you did not complete the lesson which created this type and instance, just try
another type and instance that you do have (in sample or simulator section or something
that you have created), and use the related information for the remaining steps

620 of 878

5. We now have the type that we are interested in (from VP Manager) as well as the syntax that we
need to use (from VP online help) to find all the instance of the MyPlant.Line.Info following the
steps below:
a. In the ReportBuilder, click on the Edit as Text button.

b. Enter the following text into the Editor:

Select * from
dbo.QueryItemsForItemTypeNames('MyPlant.Line.Info','server')
c.

Click on the Run (red exclamation) button:

d. As expected, all the instance of the MyPlant.Line.Info concurring with VantagePoint


Manager is returned. This information can be used for a report and/or used as parameter to
get further information for each line.

621 of 878

6. Lets try another query. This time we will try the History which again if you look it up in the online
help, youll note that it simply returns the history data for the specified item(s). As noted in the
online help, the History query needs the FQN for the scope and then all the needed subelements. We will try it on the Bread Line 1s Proof Oven Machine UDT and run a query to get
some historical information on various parameters associated with this machine, following the
steps below:
a. To get the FQN and sub-elements info for Bread Line 1 MachineUDT, browse to
MyEnterprise>MyPlant>Tags>BL1> Program:Proof_Oven and select MachineUDT
b. We note that that the FQN is
MyEnterprise.MyPlant.Tags.BL1.Program:Proof_Oven.MachineUDT
c.

We also note the item names (sub-elements) are BatchID, MachineActive, etc.

d. We will utilize the Table-valued function dbo.History to write a query to get the last 10
minutes worth of entries for the Batch ID, MachineID, and the ProductCode for the Bread
Line 1s MachineUDT by entering the following into the query field (you can either save or
delete the previous query. We will not use it again)

Select * From
dbo.History('MyEnterprise.MyPlant.Tags.BL1.Program:Proof_Ov
en.MachineUDT','.BatchID,.MachineID,.ProductCode',DateAdd(m
i,-10,GetDate()),GetDate(),'server')
NOTE: DateAdd function returns a date with a number of a given interval added to it. In
this case it returns the last 10 (because it is negative 10) minutes (because the datepart is
mi) from now which is retrieved by GetDate function.
TIP: To minimize typos, use copy/past extensively by copying the needed info from the
General tab of the needed items from VantagePoint Manager.
622 of 878

e. Click Run (red Exclamation)

f.

You should have something similar to result set below concurring with VantagePoint
Manager, with target data highlighted. You can of course modify the query to only get the
columns that you are interested in.

g. As you note, while the source of this information is HistorianSE and LiveData form the
ControlLogix, we were completely abstracted away from the underlying source of the data by
SQL CLR. We simply used a query to get the data we were looking for without needing to
know how to get it and where it comes from. That is in short one of the key value propositions
of the VantagePoint EMI and VantagePoint SQL CLR.
h. In the next lab, we will expand on what we learned here and get a more detailed
understanding of how to use the queries to create parameterized reports.

The queries we sampled in this lab were intentionally simple to not get bogged down in writing SQL
Script but to highlight the real power of the VP SQL CLR. It allows you to call into the same web
services used by FactoryTalk VantagePoint EMI by making SQL calls. The result is a new interface
that allows you to leverage traditional database style reporting tools such as SQL Server Reporting
Services to retrieve and report on data that may or may not have been accessible to those reporting
tools natively.
Further, when using FactoryTalk VantagePoint EMI as a data source, the SQL calls used to fetch
history, execute queries, or get item properties is virtually the same regardless of what the underlying
data source may be. As a result you do not need to be experts in disparate data sources. For
example when we retrieved the historical information, we really did not need to have an intimate
knowledge of the ControlLogix UDT structure, or the HistorianSE, or the LiveData communication.
The VantagePoint EMI took care of it all for us, and the SQLCLR feature leveraged it, and provided
all the information from various sources with a simple call.

This lab is complete

623 of 878

Lab 2 Create a SSRS Parameterized Report


This lab uses FactoryTalk VantagePoint EMIs new SQL CLR objects in SQL Server Reporting
Services (SSRS). We will make the necessary SSRS connection and data sets to create a
parameterized history report. Then using VantagePoint Manager, a link to this report will be created
to make this report accessible in the VantagePoint Portal. Finally a content rule will be created to
associate this report with all instances of the type used in the parameter selection.
The objective of the lab is to create a report showing the last 10 minute history of Process Variable
and Set point values for a user selectable control loop within a user selectable production line in our
sample Chicago Plant under Sample v4>Advanced
Report should accept the following parameters:

Line (dynamically based on Lines in the model)


Loop Control (based on loops associated with the selected line).

The report should look something similar to the diagram below:

624 of 878

Part A Get familiar with the data source


In this part we will take a quick look at the source of data which we will be using for the remainder of
this lab.
1. In VantagePoint Manager review the Chicago Plant Line structure, following the steps below:
a. Navigate to MyEnterprise>Sample V4>Advanced>Production>Chicago Plant
b. Expand the Lines item to see the two lines, Line 1 and Line 2
c.

Expand the Line 1 and Line 2 to see Control Loops items

d. Expand the Control Loops item in each line to see the associated control loops
e. Note the items within each loop (i.e. Process Variable, Mode, etc.)
Note the Item Types for Line 1 and Line 2 which is Base.Sample.Line
Note that the control Loops are all of the type Base.StandardTypes.PID

625 of 878

We will query the Chicago plant to find how many lines it has and make the line to be a user
selectable parameter. We will do the same thing for the control loops. We will find out the number of
loops within each line and make the control loop a user selectable parameter as well. In doing so, the
operator picks up the line of interest and then the control loop within that line. Finally we will query the
control loop parameter for the selected control loop and display it in a report.

626 of 878

Part B Configure the DataSet for the Production Lines


A dataset is a specific set of data requested - via a query or stored procedure execution - from the
data source. The dataset defines what data is available to display in the report. In this section we
write a simple query to get a list of production lines with the desired type from VantagePoint.
1. If you are still in SQL Server Report Builder from the previous lab close it following the steps
below:
a. Click on Report Builder Icon
b. Select Exit Report Builder

c.

Click No for Do you want to save changes.. question as we will not use the datasets
created in the previous lab.

627 of 878

2. Select FTVPCLR as a new data set following the steps below:


a. Launch or switch to Report Manager ( http://server/reports)
b. Click on the Report Builder button.

c.

Click on New DataSet tab

d. Choose FTVPCLR
e. Click Create

f.

If challenged for credentials, enter the following, and then click the OK button.
i. User name:

server\administrator

ii. Password:

Rockwell

628 of 878

3. You should now be in the SQL Server Report Builder. Enter the query which would return the
number of lines and their names following the steps below:
a. Click on the Edit as Text button.

b. Enter the following query into the Editor:

Select * from
dbo.QueryItemsForItemTypeNames('Base.Sample.Line','server')
NOTE: That the Base.Sample.Line is the Type for the lines we are interested in as was
seen when we took a look at the Chicao plant in the previous part of this lab.
TIP: To minimize typing and typos, copy and past information for the needed item from
the general tab of that item in VantagePoint Manger.
c.

Click on the Run (Red Exclamation Icon) button:

d. The result set which should concur with VantagePoint Manager is a list of lines in Chicago
plant

e. Since we only need the Lines Name and FQN, refine the query to only get these two items
as follows:
Select Name, FQN from
dbo.QueryItemsForItemTypeNames('Base.Sample.Line','server')
f.

Run the query again to get the refined result set:

NOTE: These two items will be used to pass parameters to the end target report

Name will be used to display a list of available choices to the user running the report.
FQN corresponding to the Name will be passed to the report so data can be fetched for that
item
629 of 878

4. Save the Dataset as Lines in our SSRS folder we created earlier (RAFoods) following the steps
below:
a. Click the Save button to save this DataSet:

b. Select the RAFoods folder

c.

Type in Lines.rsd in the Name field

d. Click OK to accept and close the dialog box

630 of 878

Part C Configure the DataSet for the Lines Control Loops


As we did for the production line, we will now create a dataset for the Control Loops within a line. We
write a simple query to get a list of Control Loops for a given production line with a slight twist. Since
the query returns the control loops for a given line, the line has to be a parameter. So we first write a
query for a given line, but then parameterize the line portion of the query.
1. Assuming that we are still in the SQL Server Report Builder, create a new Dataset following the
steps below:
a. Click on the Reporting Services Icon:

b. Select New.

c.

Select New DataSet

d. Choose FTVPCLR
e. Click Create

631 of 878

2. You should now be in the SQL Server Report Builder. Enter the query which would return the
number of lines and their names following the steps below:
a. Click on the Edit as Text button.

b. Enter the following query into the Editor:


Select Name, FQN From dbo.QueryItemsForItemTypeNamesStartsWithFqn(
'Base.StandardTypes.PID','MyEnterprise.Samples
v4.Advanced.Production.Chicago Plant.Lines.Line 1','server')

NOTE: As the queries name suggest, this query returns all instances of a type, in this
case Base.StandardTypes.PID, which their FQN starts with a specific string, in this
case, MyEnterprise.Samples v4.Advanced.Production.Chicago Plant.Lines.Line 1
We are doing this query to get the control loops for each line, and if you recall from
Part A, the control loops are of type Base.StandardTypes.PID and the FQN for a
specific instances of them in Line 1 (Speed Control, and Temp Control) starts with
MyEnterprise.Samples v4.Advanced.Production.Chicago Plant.Lines.Line 1

c.

Click on the Run (Red Exclamation Icon) button:

632 of 878

d. The result set which should concur with VantagePoint Manager is a list of control loops in line
1

NOTE: Unlike the Lines DataSet Query where all instances of the Base.Simple.Line type
were returned, this query will only return instances of the Base.StandardTypes.PID that
include MyEnterprise.Samples v4.Advanced.Production.Chicago Plant.Lines.Line 1 in their
FQN.
3. The above query as it is written would only work for line1, we wish however to be able to use it for
any line. We will refine the query so the line selection can be parameterized. We modify the
query and replace 'MyEnterprise.Samples v4.Advanced.Production.Chicago
Plant.Lines.Line 1' with a parameter called LineFQN (arbiterary name)as
shown below:
Select Name, FQN From dbo.QueryItemsForItemTypeNamesStartsWithFqn
('Base.StandardTypes.PID',@LineFQN,'server')
NOTE: The @ character lets the parser know that this is a parameter that will be passed
into the query at runtime.
a. Click on the Run (Red Exclamation Icon) button:

b. You are now presented with a dialog box asking for the information needed to execute the
query. In this case it is the starting part of the target lines FQN

c.

To test the parameter, click in the Parameter Value field, and enter the exact same string
that you had in the query before replacing it with @LineFQN
MyEnterprise.Samples v4.Advanced.Production.Chicago Plant.Lines.Line 1

633 of 878

d. Click OK

e. You should get the same result set as you did when you had the line hard coded into the
query string

f.

Run the query again and this time use the starting part of the 2

nd

lines FQN

MyEnterprise.Samples v4.Advanced.Production.Chicago Plant.Lines.Line 2


g. This time you should get the control loops for the second line, which is a single Temperature
control

4. Save the Dataset as ControlLoops in our SSRS folder, RAFoods, following the steps below:
a. Click the Save button to save this DataSet:

b. Select the RAFoods folder

634 of 878

c.

Type in ControlLoops.rsd in the Name field

d. Click OK to accept and close the dialog box

635 of 878

Part D Create Line Control Loop Report and add the DataSets
We have created the data set needed for the report. We will now create the report which uses these
datasets to deliver the target report.
1. Create a new blank report following the steps below:
a. Assuming that we are still in the SQL Server Report Builder, click on the Reporting
Services Icon:

b. Select New

c.

Select New Report, then click the Blank Report.

636 of 878

2. Add the title Line Control Loop Report to the report, following the steps below
a. Click in the area where Click to add title is showing
b. Replace the current text with Line Control Loop Report

3. Add Lines DataSet to the report following the steps below:


a. Right click on the Datasets collection in the tree and select Add Dataset

637 of 878

b. Click the Browse button in the Dataset Properties dialog:

c.

Double-click on RAFoods to select it

d. Select Lines and click Open:

638 of 878

e. With the Lines dataset highlighted change the Name field to Lines and click OK.

f.

The Lines Dataset is now available for use in the Report:

4. We will repeat the previous step to Add ControlLoops DataSet to the report following the steps
below
a. Right click on the Datasets collection in the tree and select Add Dataset.

639 of 878

b. Click the Browse button in the Dataset Properties dialog:

c.

Double-click on RAFoods to select it

d. Select ControlLoops and click Open:

640 of 878

e. With the ControlLoops dataset highlighted change the Name field to ControlLoops and
click OK.

f.

The ControlLoops Dataset is now also available for use in the Report:

641 of 878

Part E Configure the Reports Parameters


In the previous parts we created the report template, and added the needed data sets. We will now
configure the parameters that are needed for this report. Remember that in the target report, both line
and the control loops are selectable, so both have to be parameterized.
1. Expand Parameters, and note that the LineFQN is created automatically because we configured
it in the ControlLoops dataset

2. Configure the Lines, to be a user selectable parameter following the steps below:
a. Right click on Parameters and select Add Parameter

642 of 878

b. Set the Name to Line


c.

Set the Prompt to Select Line

d. Set rest of the parameters as shown

e. Click on the Available Values tab


f.

Select the Get values from a query radio button.

g. Select the Lines from the Dataset dropdown list.


h. Set the Value field to FQN,
i.

Set the Label Field to Name.

j.

Click OK

643 of 878

k.

The new line parameter, @Line, is now added to the Parameters collection in the tree.

3. Before going to setup the ControlLoops parameter, and before we forget let set the parameter
setting for the ControlLoops to the newly created parameter (it is currently setup to the test
parameter LineFQN which we used during the creation of the Dataset to test parameter passing)
following the steps below:
a. Right-click ControlLoops under the Datasets, and select Dataset Properties.

b. Select the Parameters tab


c.

Click the dropdown menu for Parameter Value and select [@Line]

d. Click OK
This will associate the FQN of the selected line with the LineFQN parameter of the
ControlLoops Dataset.

644 of 878

4. Configure the ControlLoops to be user selectable parameter following the steps below
a. Right click on Parameters and select Add Parameter.

b. Set the Name to ControlLoopsFQN


c.

Set the Prompt to Select Control Loop

d. Set rest of parameters as shown

645 of 878

e. Click on the Available Values tab


f.

Select the Get values from a query radio button.

g. Select the ControlLoops from the Dataset dropdown list.


h. Set the Value field to FQN,
i.

Set the Label Field to Name.

j.

Click OK

k.

The new line parameter, @ControlLoops, is now added to the Parameters collection in the
tree.

646 of 878

5. The LineFQN which we created during DataSet creation to test the data set is no longer needed
and should be deleted , following the steps below:
a. Right click on the @LineFQN and select Delete

b. Click OK to confirm.

647 of 878

Part F Configure a Dataset within the report called ControlLoopHist


to return the ProcessVariable and Setpoint history for the selected
control loop
In the previous parts we created dataset to find the line and the control loops within the line. We then
setup parameters allowing the user to select the line of interest and the control loop of interest within
that line. Once there, the report needs to show the Process Variable and Setpoint history of the
selected Control Loop. In this section we configure a data set to perform this task
1. Add ControlLoopHist DataSet to the report following the steps below
a. Right click on the Datasets collection in the tree and select Add Dataset.

NOTE: You are going to note that we will add this data set differently than the Line and
ControlLoops which we did earlier. In those cases, we picked data sets which we had
created earlier and put in RAFoods.
In this case we are going to configure the data source in line using the parameters which
we just configured. In doing so, the query would dynamically return the appropriate data
depending on the parameters passed into it.

648 of 878

b. Change the Name from Dataset1 to ControlLoopHist


c.

Select the radio button Use a dataset embedded in my report

d. Click the New button in the center of the dialog to create a new Data source

e. Change the Name from DataSource1 to FTVPCLR,


f.

Select the FTVPCLR data source from the list

g. Click the OK button to close the dialog.

649 of 878

h. Enter the following SQL Statement into the Query text box:
Select * From
dbo.History(@fqn,'.ProcessVariable,.SetPoint',DateAdd(mi,10,GetDate()),GetDate(),'server')
The querys intent is to return the last 10 minutes worth of process information for the
selected Control Loop. Note the @FQN parameter (an arbitrary name we selected for the
parameter during design of datasets) which will be used to pass the ControlLoops FQN is
the front part of the FQN of the parameters we wish to retrieve (ProcessVariable, and
SetPoint). As a reminder take a look at the control loops in the VantagePoint Manager and
note that the .ProcessVariable and .SetPoint are the parameters of the ControlLoops. Also
take a note of the related FQNs.
2. Test the query, following the steps below
a. Click Query Designer

650 of 878

b. The query shows up in the Query Designer. Click Run (red exclamation mark)

c.

Since there is a parameter in the query, a window requesting the pertinent information will
popup.

d. Looking at the property of one of the control loops in line 1 (i.e. Speed Control), the following
is the Speed Control FQN.
MyEnterprise.Samples v4.Advanced.Production.Chicago Plant.Lines.Line 1.Control
Loops.Speed Control
e. To test the query type the above FQN into the Parameter Value field and click OK.

f.

The result is a tabular narrow format history of the Process Variable and Setpoints for line 1s
Speed Control loop

NOTE: The running of the query also causes the Dataset to Refresh Fields, making the
columns returned by the query available in the SQL Server Report Builder

651 of 878

g. Click OK to close the Query designer

h. Click OK to close the Dataset Properties dialog.

652 of 878

3. The ControlLoopHist Dataset along with all of the columns returned by the query is now
available in the tree for use in the report.
Note that we now have all the data sets to create our report: Lines, ControlLoops, and the
ControlLoopHist. We are now ready to create our report.

653 of 878

4. Before starting to create a report, there is one more thing to do to the ControlLoopHist Dataset.
We need to associate the FQN parameter in the dataset we just created with the
ControlLoopFQN, so when user picks a ControllLoop it, it gets correlated to the parameter in
the history query we just created.
a. Right click on the ControlLoopHist Dataset and select Dataset Properties

b. Select the Parameters tab


c.

Change the Parameter Value to [@ControlLoopsFQN].

654 of 878

Part G Configure Report Output


1. Insert and configure a Matrix following the steps below:
a. Click the Insert tab at the top of SQL Server Report Builder.
b. Click the Matrix and select Insert Matrix

c.

Click (and hold down the left mouse button) in the upper left corner of the report area
(Pointed with the arrow) and drag the mouse to the lower right of the report area to create a
matrix similar to what is shown in the diagram. Release the button when approximately even
with the right edge of the Report Title as shown below:

655 of 878

2. From the ControlLoopHist Dataset drag the following parameters to the fields mentioned:
a. Drag localTimeStamp to the Rows box.
b. Drag shortName to the Columns box.
c.

Drag valueAsString to the Data box.

d. The report area should now look as follow

656 of 878

3. Click the Run button at the top of the screen

4. Note that the Select Control Loop drop down is not enabled as no line has yet been selected.
a. Select a Line (i.e. Line 1) from the Select Line dropdown list:

5. Note that selecting a Line enabled Control Loop selection drop box and populates it with all the
control loops within that line.
a. Select a Control Loop (i.e. Temp Control) and click View Report.

6. The result set is the last 10 minutes of PV and SP values for the selected control loop in the
selected line

7. Try other combination of Line and ControlLoops. Compare the report results against the
VantagePoint Manger to verify the reports operation. For example that for line 2, there is only 1
control loop.
657 of 878

8. Congratulations you completed your first SQL CLR based report. Save your work as
ControlLoopsHist.rdl in RAFoods SSRS folder following the steps below:
a. Click the Save on top of the menu bar

b. Double-click on RAFoods to select it

c.

Type in ControlLoopsHist.rdl in the Name field and click Save.

9. Close SQL Server Report Builder by clicking the Close window button (X) in the upper right
corner of the Report Builder window

NOTE: SSRS provides powerful capabilities to format and manipulate data. As Learning
SSRS capabilities is not the focus of this lesson we did not spend any time on formatting
the report)

658 of 878

Part H Run the Report You Just Created


You can now run your report right from the SSRS home page like any other Reporting Service report
1. In the SSRS Home screen (Report Manager), double-click the RAFoods folder to open it

2. You should see your brand new SSRS report (ControlLoopHist).If you were already in
Reporting Services\RAFoods folder and do not see the ControlLoopsHist report, refresh your
browser by pressing F5 on your keyboard.

3. Double-click the ControlLoopHist to run it. You should have the same experience as when you
tested it in the previous part (selecting line, control loops, and viewing the report)Run the
ControlLoopHist Report by double clicking on it and selecting parameter as before.

659 of 878

Lab 3 Link SSRS Report to VantagePoint Report


Now that we have completed our SQL CLR based SSRS report, we want to bring it into the
VantagePoint Portal. While this is not necessary for the report to function (as you noted in various
testing of the reports in previous lab), in most application it is much more advantageous to have a
single portal to information. This in fact is one of the key value propositions of VantagePoint. By
combining content from various reporting tools into a single portal, VantagePoint minimizes the
number of places a user would have to go get relevant information.
In this lab, we will setup a couple of different ways to link to the SSRS report as well as setup content
rules to associate the SSRS report with types in the model. Doing so will allow the user to take
advantage of the hierarchical context of the VantagePoint model when selecting their parameters.
NOTE: Points discussed in this lab (linking to reports, setting up content rule, etc.) has
general application and unless there is something specific to SSR report, can be applied
to any web or report application

Part A Get the URL Link to the SSRS report we just created
For the tasks that we are about to complete, we need the URL for the SSRS report we just created
1. Get the link to the SSRS report we just created, following the steps below:
a. There are various ways of doing this, but one of the easiest is to open the ReportServer root
directory which in our setup is
http://server/ReportServer
b. Click on RAFoods

660 of 878

c.

We should be in RAFoods folder, Right-click on ControlLoopsHist and select Copy


Shortcut.

d. Paste the URL into notepad for future use. For reference the URL should be:
http://server/reportserver?%2fRAFoods%2fControlLoopsHist&rs:Command=Render

661 of 878

Part B Create a single link to the report


In this part we show one of the ways we can setup a link to the SSRS report which is essentially a
simple hyperlink to the report.
1. In VantagePoint Manager navigate to MyEnterprise>MyPlant
2. Right click on Reports and select New->Item.

3. Select the Portal.Hyperlink item.

662 of 878

4. Configure Portal hyper link as follows:


a. Name:

Control Loops Report

b. LinkURL:
http://server/reportserver?%2fRAFoods%2fControlLoopsHist&rs:Command=Render
c.

Click Create

5. A report named Control Loops Report is now created

6. Launch VantagePoint Portal, navigate to MyEnterprise>MyPlant>Reports and click Control


Loops Control to open it.

663 of 878

7. You should see the same report and interface experience as you did in the previous lab

664 of 878

Part C Create a link for each instance of the Line type


(Base.Sample.Line)
In this last part we will create a link for each instance of the Base.Sample.Line type under the
Chicago Plant > line folder where not only the link to the report becomes available wherever there is
an instance to the Base.Sample.Line type, but also the report would automatically default to that
particular line (No need to select it from the drop down list).
1. In VantagePoint Manager navigate to
System > Solutions > Samples > PortalSettings > ContentType > Base.Sample.Line
2. Right-click on Viewable Content and select New > Item

665 of 878

3. Select Portal.ViewableSqlServerContent, then click Create.

4. Configure the content item as follows:


a. Name: Line Control Loop Report
b. ReportingServiceUrl:
http://server/reportserver?%2fRAFoods%2fControlLoopsHist&rs:Command=Render
c.

Click Create

666 of 878

5. Right click on the ParameterMappings collection under the newly created Line Control Loop
Report and select New > Item.

6. Configure the ParameterMapping item as follows (remember Line is the line selection parameter
in the SSRS report we created) :
a. Name: Line
b. TargetParameterName: Line
c.

SourceName: .FullyQualifiedName

d. Click Create

7. Click the Create button.

667 of 878

8. Launch VantagePoint Portal and navigate to


MyEnterprise>Samples v4 > Advanced > Production > Chicago Plant > Lines> Line1

Note that there is the new report Line Control Loop Report. It is there because Line 1 (right
above it is of type Base.Sample.Line, and the viewable configuration process we went through in
the previous step creates a report anywhere there is an instance of the type Base.Sample.Line
Note that for these very reasons there is also a Line Control Loop Report under Line 2
Although not the focus of this lab, this notion of setting up the content view where reports are
automatically generated for any instance of a type is a powerful feature to rapidly create useful
content.

668 of 878

9. Click on Line Control Loop Report under Line 1.


Note that the header text reflect the correct line, and more importantly the line selection is
automatically loaded (not a huge issue when you have a few item, but can be a significant if you
have complex selection criteria and want to narrow the selection focus)

10. Select a Control Loop from the drop down menu and click View Report.

11. You should see a similar report as before.


12. Try the Line Control Loop Report under Line 2. This time the line selection should be defaulted
to Line 2
Congratulations, you just completed this lesson. You learned about the new interface that allowed
you to leverage traditional database style reporting tools such as SQL Server Reporting Services to
retrieve and report on data that may or may not have been accessible to those reporting tools
natively.
Since we were using FactoryTalk VantagePoint EMI as a data source, the SQL calls that you used to
fetch history, execute queries, or get item properties were virtually the same regardless of whether
you were getting data from Live Data interface, Historian, or SQL Server. As a result when we were
creating our report, the underlying data sources were not of much concern. We simply made calls
against FactoryTalk VantagePoint EMI which in turn fetched the data from the remote sources.

This lab and lesson is complete

669 of 878

This page intentionally left blank

670 of 878

Lesson 17 Excel Macro

What you will learn:

How to Configure a Report for an Embedded Macro


Write VBA code in a Module to support a macro
Render an Excel embedded macro report in the VantagePoint Portal

Prerequisite:

Completion of Lesson 9
If you did not complete lesson 9, assuming that you have completed Lesson 2, then the type
and the instance of the type needed for this report can be imported from the Completed
folder: Import C:\Class Files\VP Completed\Types\LineInfo.icp

671 of 878

Discussion
Excel macro
An added functionality of VantagePoint is its ability to support Macro embedded reports. Many
customers leverage Excel Macros in their reports to automate repetitive functionality or do advanced
calculations. VantagePoint can support the execution of the Macros before the report is rendered to
the VantagePoint Portal as HTML.
In this lab we will do an example of the steps required for VantagePoint to execute the macros in an
Excel report before the report is rendered to the VantagePoint Portal. The lab will build a Report
against an item type in the model, do a summation calculation, hide unused worksheets; and title the
report.
The final report would look something similar to the diagram below where the user can select the line
and then the zone temperatures for that line along with their average temperature values would show:

672 of 878

Lab 1 Using Excel Macro for VantagePoint Reports


This lab illustrated how you can take advantage of the power of Excels macros. The macros in this
lab use a formula that determines how many records are returned from a query, loops through the
data and calculates the average of four columns (temperatures). Before the code is finished and the
report is rendered to the VantagePoint Portal, worksheets are hidden, data is reformatted and titles
are placed in the document.

Part A Set up the Excel environment for Macro development


1. Verify that you are on the Server Image (Server tab is selected).

2. Enable All Macros, turn developer option on, and setup trusts in the Excel following the steps
below:
a. Launch Microsoft Excel.
b. Select the Excel Options button, located under File.

673 of 878

c.

Select Customize Ribbon

d. Check to select Developer Option

e. From the Excel Options dialog, select the Trust Center option.
f.

Click the button labeled Trust Center Settings.

674 of 878

g. From the Trust Center dialog, select Macro Settings


h. Check the Enable all Macros option
i.

Select Trust access to the VBA project object model options.

j.

Click OK to accept the configuration.

k.

Click OK on the Excel Option dialog to return to the spreadsheet. At this point, Excel is now
configured to support Macros in the VantagePoint environment.

l.

Note: that you will now see the developer option on the Menu bar.

675 of 878

Part B Create a simple Excel Report showing the last 10min zone
temperatures for a selected line
We are creating this simple report to have something to use to demonstrate the Macro capability.
1. On Sheet1 Initiate a History query insertion for the four temperatures to be inserted into cell C4 (
this is the start of the cell range where we will return the raw data from the VantagePoint Query)
by following the steps below:.
a. In the Excel menu bar select VantagePoint and the Insert button on the ribbon bar.

b. In the VantagePoint Function Selection dialog, select History.


c.

Check the box for Use Advanced Mapping Features.

d. Click Next to continue.

676 of 878

2. Select Line1Info as an instance of our target type (MyPlant.Line.Info) data to be retrieved


following the steps below:
a. Select Items that contain Core.tag
b. Navigate to MyPlant>Tags>Bl1 and select Line1Info. Note that the selected type is
MyPlant.Line.Info
c.

Click Next to continue

677 of 878

d. Select Next on the Item Selection dialog as the item we need is already selected.

e. Note the text providing details of what we have done as well as the descriptive instruction of
what takes place next.
f.

Click Next

678 of 878

g. Select TempZone1 to TempZone4 and add it to the item selection list. Click Next to
continue.

679 of 878

3. Make the Line Info an external parameter and change the name to a more user friendly text like
Line by following the steps below
a. Select the check box for Make this an External Parameter when Finished
b. Enter the text Line into the Name field
c.

Click Next

4. On the Time Selection dialog select the Last 10 Minutes. Click Next to continue.

680 of 878

5. On the Data Options dialog select Wide Format. Click Finish to exit the Wizard.

6. The temperature zones may come in with some other format (i.e. time and date). Format them to
be numeric with 2 decimals points. (Select Columns C-G, Right-click, Format Cell, Number, 2
decimal). Your report should look as follows:

681 of 878

Part C Create a simple Excel Macro


The vantage point functionality took care of the data retrieval. We will now use Excel Macro to take
care of the data manipulation and formatting to deliver the following objectives:

Determines how many records are returned from a query,


Loops through the data and calculates the average of four columns (temperatures).
Reformat data and along with Titles, place them in in the document.
Hide worksheets before rendering the report to the portal

1. Save the Excel spread sheet you have been working on as a macro enable workbook onto the
root C:\root directory and name it c:\ Zone Temperature Average.xlsm following the steps
below:
a. From Excel menu select File > Save As

b. Navigate to C:\ directory


c.

Type in BL Zone Temperature Average in the file name

d. Select Excel Macro-Enabled Workbook (*.xlsm) for the file type


e. Click Save

682 of 878

2. On Sheet 1, select Cell H1. Enter the following formula. This formula will calculate the last row
containing data (indication of number of rows returned) =COUNTA(D:D)+3

3. Open VisualBasic editor following the steps below:


a. From the Excel Menu Bar, select the Developer tab.
b. Select Visual Basic. This will open the Visual Basic editor.

4. From the Visual Basic menu bar, select Insert > Module.

683 of 878

5. Type the following code. Note that the code can be copied and pasted into the Macro. The code
is located in C:\Class Files\Excel Macro\VBAMacro-Zone Avg.txt. Select the entire code copy
and paste it into the blank Macro.
a. Review the inline documentation to get a better understanding of this very simple macro.
Sub auto_close()
'Call into the Total code
Call CalcTotals
End Sub
Public Sub CalcTotals()
'Get the total rows found
Dim totalRows As Integer
Dim i As Integer
'Handle exceptions in the report preventing Excel Automation from hanging.
On Error Resume Next
i=5
'Note that all references to Sheet numbers are for what is referenced here in the VB environment
'Please do not confuse them with the sheet numbers in the Excel spread sheet.
'Looking at the Microsoft Excel Objects on the Project Pane, for this particular project, you note that:
'Sheet 1 here is the IncuityInfo sheet in the Excel
'Sheet 2 here is the Sheet1 in the Excel report
'Sheet 3 is sheet 2
' ....
'Label A1
'Construct title information for the report by extracting the line information from the
'parameter sheet (in this case the 29th character of the tag name in the parameter sheet) and add it
to the text "Selected Line"
Sheet2.Range("A1").Value = "Selected Line: " & Mid(Sheet5.Range("A1"), 29, 1)
'Label F4
Sheet2.Range("H4").Value = "Temperature Average"
'get the total row count
totalRows = Sheet2.Range("H1").Value
'only enter the loop if the data range is greater than zero
If totalRows > 0 Then
'loop through rows adding the 4 temperatures and dividing it by 4 to get the average
'temperature for the four zone for a given timestamp (we start from row 5 because that
'is the row where the data population starts, and continue looping for the total number of rows
For i = 5 To totalRows
Sheet2.Range("H" & i).Select
Sheet2.Range("H" & i).Value = (Sheet2.Range("D" & i) + Sheet2.Range("E" & i) +
Sheet2.Range("F" & i) + Sheet2.Range("G" & i)) / 4
Next
End If
Sheet2.Range("H4").Select

684 of 878

'Reformat the columns correctly


Sheet2.Range("D1:H" & totalRows).Select
Selection.NumberFormat = "0.00"
'Hide unused sheets
Sheet3.Visible = xlSheetHidden
Sheet4.Visible = xlSheetHidden
Sheet5.Visible = xlSheetHidden
End Sub

6. Save the macro you just entered, close VBA and return to Excel

7. Save your Excel Macro file to C:\BL Zone Temperature.XLSM


8. Publish your report following the steps below:
a. From the Excel VantagePoint Ribbon bar, select Publish

b. Select A report with parameters as we wish to be able to select line

685 of 878

c.

Check that the Line parameter is selected, and click Next

d. Navigate to MyEnterPrise>MyPlants>Reports
e. Leave the default name as the Excel File of BL Zone Temperature Average
f.

Click Next

686 of 878

g. Select Browse to published report, and Show Parameters options and click Finish

9. View the report in portal, and verify the report operation following the steps below:
a. The portal should be open now, and the report we just finished should be showing (since we
made the published report, and Show Parameters selection)
b. Note the following:
i. Data is retrieved by the VantagePoint Historian Add-in function
ii. The row calculation is done by the Excel Add function. It is off by a factor of four to
compensate for the first four rows with no data as it is used for the loop function in the
VBA, and we need to go from Row 5 to whatever this number is. For a cleaner look,
this calculation should probably be somewhere else on a hidden sheet, or the actual
row count should be shown here, and the compensation takes place in the VBA code
(something fun for you to try!)
iii. The temperature average title and the average temperatures are calculated , formatted
and placed in proper cell by VBA
iv. All sheets except the report one is hidden by the VBA

687 of 878

v. The selected line and the correct line number is generated by the Macro
vi. The line selection is showing because we set this report up as a typed mapped one,
and published it with parameter showing selected.

10. Select a different line and generate report to verify the operation of your macro generated report.
Congratulations, you just completed your macro assisted excel report. Needless to say, the averaging
operation shown here can be done in many different ways, but the intent here was not to create
complex VBA code, but to show you how Excels macro / VBA capability can provide you another
powerful tool to create useful reports

This lab and lesson is complete

688 of 878

Lesson 18 - Model View and Content Rotator

What you will learn:

Portal setting Configuration


Create Hidden Nodes
Customize The Portal
Create simple Content Rotator

Prerequisite:

This trainings VMWare image

NOTE: Reports and folders created in earlier lessons are used to explain model view
concepts and content rotation, but the built-in, or any of the completed reports, can be
used in place of the mentioned reports in this lesson.

689 of 878

Discussion
Creating a Model View
The FactoryTalk VantagePoint Portal and reporting views can be configured to meet corporations
specific requirements. There are many ways to configure the VantagePoint Portals look & feel
affecting the user experience. One of these methods is to create or modify a model. The model view
can involve hiding a part of the model, or setup default screens or modify the menu content.

Content Rotator
While content rotator is not in the same category of model view or theme, from a user perspective it
affects the visual experience, so it is included in this lesson. You can create a content rotator to
display a different report, trend, web page, or HTML content each time the page refreshes based on a
time interval you define.

Themes
You can create a new theme to customize the Portal display, including the logo and menu items.
The following items can all be configured and customized

Logo Image
Menu Color
Changing color bands and backgrounds
Removing server and version link
Path colors

For more details on Theme configuration, please refer to online documentation (search string
theme)

690 of 878

Portal Application Setting


Many portal setting configurations are disabled by default. The Portal Application settings are stored
in the VantagePoint model, and can be modified by authorized users.
To edit Portal application settings:
1. Browse to the System > Applications > Portal > Settings node in VantagePoint Manager, and
select the Properties tab.
2. Click Edit in the lower-right corner to open the Edit Settings dialog box and modify the
properties as needed:
Description

Default property that only displays in Manager.

Start Page

Determines the initial page to display upon opening the Portal.

Theme

Displays the name of the current Portal theme. See Creating


Themes in VantagePoint online help for information about creating
a new theme and customizing it.
Note: If you enter an invalid name for a theme, VantagePoint
applies the default theme.
Allows you to view content from external sources. This includes:

EnableExternalContentSources

EnableInternalHTMLEditor

Portal.MenuLink items
Portal.Hyperlink items
Portal.ViewableWebLinkContent items
Portal.ViewableSSRSContent items
Some Composite Report items
Some Content Rotator items

Note: If this check box is cleared, users will see an "External


Content Blocked" message, similar to the following, for any
external content.

Enables an internal HTML editor. You can paste HTML markup into
text boxes if this check box is cleared.
Enables authorized users to modify the Portal Home Page.

EnableHomePage
Modification

EnableClassicIQuery

Note: This feature requires that the EnableInternalHTMLEditor


check box above be selected. Otherwise, the Modify this page
link will not display. See Modifying the Portal Home Page for
more information.
Displays the Classic IQuery page if selected. This is useful for
Industrial SQL Server users only and requires an InSQL connector.

691 of 878

EnableControlFileAccess

Legacy setting to disable file access in the Trend control. If selected,


specifies whether to allow file system access from the Portal Trend
and XyPlotter controls.

EnablePDFGeneration

Renders Excel reports as PDF files if you click in the Portal.

AvailItemsMaxCount

Controls the number of items initially displayed in parameter lists.


Used to improve usability and performance if the possible number of
parameters displayed can be especially large.

TimeZoneId

Identifies the time zone to be used by Portal components that allow


time zone configuration. Defaults to the Local time zone.
You can also use any explicit time zone specified in http://<server
name>/VantagePointPortal/internal/ListTimeZones.aspx

692 of 878

Lab 1 Creating a Model View


Model Views are customized views of the VantagePoint model that can display specific collections or
groups of content that the Portal can display. This content includes reports, dashboards, html pages,
etc. You can create model views for specific purposes and link them to menu items.
A very simple way to do this is to create a Model View from within the Portal, and use the MenuLink
element to add the new view into the menu. We will do this in Part A of this lab.
A much more customizable environment is offered via the Portal settings contentviewer environment.
We will have a brief introduction to that in Part B of this lab.

Part A Creating a Model View via VantagePoint Portal


As mentioned in the introduction of this lesson, you need proper authorization and proper portal setup
to perform this task. If you get a message similar to the one below, your portal setting, specifically the
EnableExternalContentSources parameter is not set correctly.

The Portal application settings can be found in in the VantagePoint Managers


System>Application>Portal Setting folder and can be edited by authorized users.

In this part, we will


a. Add a new view called Lab Reporting point to the Chicago Plant under MyEnterprise >
Samples v4 > Intermediate > Status Items > Production Example which will add a new
item to the portal drop down list Reports called Lab Reporting as well as a tab which only
contains the Chicago Plant content (similar to what you have experienced with the other item
on the Reports drop down list in the portal
b. Make Actual vs. Target report within that view the default display
c.

Hide Equipment Trend within that view

1. Verify that you are on the Server Image (Server tab is selected).

2. Launch VantagePoint Portal.

693 of 878

3. Select Reports. There are currently 4 model views in the system. MyEnterprise,
ChartsAndGrids, FactoryTalk and Samples are all created by the VantagePoint system and
can be customized as required. None of the content we have been creating has been configured
to show up on the menu or drop down menus.

4. Select MyEnterprise

Unless it has been manually configured, MyEnterprise shows all of the reporting content available
in VantagePoint EMI.

694 of 878

5. Navigate to MyEnterprise > Samples v4 > Intermediate > Status Items > Production
Example. Right-click on the Chicago Plant folder and select Create New View.

6. Name the View Lab Reporting.


7. Click OK to create the new Model View.

695 of 878

8. You will note the new tab report called Lab Reporting

9. You will also see that the Lab Reporting View is now available under Reports in the VantagePoint
Portal.

10. When the Lab Reporting view is opened, you might have noticed that you have to select a report
before you see any reporting content. We can modify this, as well as other properties by rightclicking anywhere in the Lab Reporting report viewer pane and selecting Modify this View

696 of 878

11. First we want to select a report to display by default when the Lab Reporting view is opened.
Right-click on the Excel Icon next to the excel report Actual vs. Target and select Visibility >
Make this the default content item.

697 of 878

12. We also may decide that we dont want to see some of the reporting content that exists under the
Lab Reporting folder in this view. Individual reports or entire folders can be hidden in a Model
view. In this case, we dont want to see the Equipment trend report under Line 1 anymore in this
view. Right-click on the trend icon next to Equipment Trend under Line 1 and select Visibility >
Hide this content item.

13. You will notice that the Trend report is removed from the tree structure in the view. If you decide
you want to show content that has been hidden, you can right-click in the empty space in the left
pane while editing the model view and select Visibility Show hidden folders and items.

698 of 878

Part B Creating a Model View via VantagePoint Manager


In this part, we will perform similar task as Part A, but from within the VantagePoint Manger.
We will:

Add a new view called My Plant pointing to our very own My Plant folder under which will
add a new item to the portal drop down list Reports called MyPlant as well as a tab which
only contains the MyPlant content (similar to what you have experienced with the other item
on the Reports drop down list in the portal
Hide ChartsAndGrids sample reports

14. Hide ChartsAndGrids folder following the steps below


a. Launch VantagePoint Manager
b. Navigate to System > Applications > Portal > Settings > ContentViewer > ModelViews >
MyEnterprise
c.

Right-click on HiddenNodes

d. Select New > Item

e. In the Name textbox enter MyEnterprise.ChartsAndGrids


f.

In the Id textbox enter MyEnterprise.ChartsAndGrids

g. Click Create

699 of 878

15. Create a new view called MyPlant pointing to the MyPlant folder following the steps below
a. From the VantagePoint Manager navigate to System > Applications > Portal > Settings >
ContentViewer >
b. Right-click on ModelViews
c.

Select New > Item

d. In the Name textbox enter MyPlant


e. In the DisplayName textbox enter MyPlant
f.

In the AnchorNode textbox enter MyEnterprise.MyPlant

g. Click Create

700 of 878

16. Check your Model View changes following the steps below:
a. Launch VantagePoint Portal
b. Select Reports menu item
c.

Note that MyPlant is now one of the menu entries

d. Click on MyPlant, and note that only MyPlant content is showing

701 of 878

e. Click on Reports menu item on Portal menu bar.


NOTE: The ChartsAndGrids item is still there. This is because we only hid it in the My
Enterprise View.

f.

Click MyEnterprise

Note: that ChartsAndGrids entry is no longer showing under MyEnterprise view.

This lab is complete

702 of 878

Lab 2 Content Rotator


You can create a content rotator that displays a different report, trend, web page, or HTML content
each time the page refreshes based on a time interval you define.
You create a content rotator by creating a new item under Core.Template > Portal.ContentRotator
in the Model Browser.
As mentioned in the introduction of this lesson, you need proper authorization and proper portal setup
to perform this task. If you get a message similar to the one below, your portal setting, specifically the
EnableExternalContentSources parameter is not set correctly.

The Portal application settings can be found in in the VantagePoint Managers


System>Application>Portal Setting folder and can be edited by authorized users.
In this lab we will create a new content rotator in our Report folder under MyEnterprise > MyPlant
folder to rotate through a few of the reports in the model

1. Create a new ContentRotator item in our Reports folder following the steps below
a. Launch VantagePoint Manager
b. Navigate to MyEnterprise>MyPlant
c.

Right-click on Reports and select New Item

703 of 878

d. Cursor down the type list to Core.Template


e. Expand Core.Template, and select Portal.ContentRotator
f.

Click Create

g. Configure the new Portal Content Rotator as shown:


i. Name: Report Kiosk
ii. Enable: Rotation
iii. AutoRotationInterval: 10 Seconds
iv. Max Auto Rotation Before Page Recycle: 20 cycles
v. Disable Show Full Screen
h. Click Create

704 of 878

Content Rotator Configuration Field Descriptions

Name

Enter a name for the content rotator. This is the name that
displays in the Portal.

Description

Enter a description for the content rotator. This description does


not display in the generated report.

EnableAutoRotation

Select this check box to automatically rotate each piece of


content without user interaction. If selected, content rotates at
the interval specified in AutoRotationInterval.
Enter the number of seconds that elapse before displaying the
next piece of content.
If you want different pieces of content to display at different
times, enter comma separate values in this text box. You can
also enter 0 to skip a piece of content.
For example, if you want to display the following...

AutoRotationInterval

Excel report for 20 seconds


Trend report for 50 seconds
Dashboard for 30 seconds
HTML content that contains information about a
company holiday for 45 seconds

...you would enter the following in this text box:


20, 50, 30, 45
After the holiday, you could change the value of the HTML
content from 45 to 0 so the page no longer displays (e.g., 60,
50, 30, 0).

MaxAutoRotations
BeforePageRecycle

ShowFullScreen

Enter the number of times the content rotates before recreating


the page. Note that each time the content rotates, the content is
refreshed from the server. Also, a rotation means that all
associated viewable content displays one time.
Caution: Increasing the value for this option can result in
potential performance issues if left running for an extended
period of time.
Select this check box to resize the content to display the full size
of the screen.

2. Make sure All Items in Tree (the wrench icon in VantagePoint Manage tool bar) is active, so
you can see the content rotator

705 of 878

a. You should now see the content rotator item, Report Kiosk, in
MyEnterprise>MyPlant>Reports folder with ViewableContent node below it for defining the
content to use

3. Add a HTML content to the Kiosk Report Content Rotator following the steps below:
a. Right click on Viewable Content under Report Kiosk,
b. Select New > Item

c.

Select Portal.ViewableHTMLContent

d. Click Create

706 of 878

e. Configure the fields as


i. Name: Greetings
ii. Display Name: Greetings
iii. Display Sequence:

iv. Show Action Bar


v. Do Not Show Full Screen
vi. HtmlMarkup: Hello World !!
f.

Click Create

NOTE: As you can see we have put in a pretty impressive HTML code into this field. Use
your favorite HTML editor as well as the build in VantagePoint HTML editor to create HTM
content and paste it into this field

707 of 878

Portal Viewable HTML Content Configuration Field Descriptions

Name

Name of the HTML content.

Description

Optional description for the HTML content.

DisplayName

Name that users see when selecting the HTML content in the Portal.

DisplaySequence

Sequence in which to display the item. Use the DisplaySequence


property to force order of the items. The numbers do not have to be
consecutive, or begin with 1. They are evaluated only relative to each
other. For example, 100, 200, 300 are acceptable.

HTMLMarkup

Click to open an area to insert the text or HTML into. The Portal converts
any text into HTML, and also displays any HTML markup in the text box.
You can also add HTML tags to make content bold, italic, etc.
Tip: You can use the Portal HTM Editor to create this type of content.

4. Add a Report content to the Kiosk Report Content Rotator following the steps below:
a. Right click on Viewable Content under Report Kiosk,
b. Select New > Item

c.

Select Portal.ViewableReportContent

d. Click Create

708 of 878

e. Configure the fields as below.


NOTE: For the Report name, YOU CAN NOT simply type what is showing there, unless
you type in the FQN. Use the browse button and navigate through the model to select BL1
Min and Max Zone Temp from our Reports folder
i. Name: Bread Line 1 Min & Max Temp Report
ii. Display Name: Bread Line 1 Min & Max Temp Report
iii. Display Sequence: 2
iv. Show Action Bar
v. Do Not Show Full Screen
vi. Report: BL1 Min and Max Zone Temp
f.

Click Create

g. If you did not complete the lab where we created this report, select another report.

709 of 878

5. Repeat the previous step to add another ViewableReportContent with following configuration
a. Configure the fields as below.
NOTE: For the Report name, YOU CAN NOT simply type what is showing there, unless
you type in the FQN. Use the browse button and navigate through the model to select
Zone Temp Trend from our Reports folder
i. Name: Zone Temperature Trend
ii. Display Name: Zone Temperature Trend
iii. Display Sequence: 3
iv. Show Action Bar
v. Do Not Show Full Screen
vi. Report: .Zone Temp Trend
b. Click Create

c.

If you did not complete the lab where we created this report, select another report.

710 of 878

6. We will add one more report item and this time we select a Web Linked one. Add a Web Linked
content to the Kiosk Report Content Rotator following the steps below:
a. Right click on Viewable Content under Report Kiosk,
b. Select New > Item

c.

Select Portal.ViewableWebLinkedContent

d. Click Create

711 of 878

e. Configure the fields as below.


NOTE: For the Report name, YOU CAN NOT simply type what is showing there, unless
you type in the FQN. Use the browse button and navigate through the model to select BL1
Min and Max Zone Temp from our Reports folder
i. Name: Welcome
ii. Display Name: Welcome
iii. Display Sequence: 4
iv. Show Action Bar
v. Do Not Show Full Screen
vi. LinkUrl: http://server/Incuity/Documentation/WebHelp/Index.htm
f.

Click Create

7. Test your content rotator following the steps below:


a. Launch VantagePoint Portal
b. Navigate to MyEnterprise>MyPlant>Reports (or select your brand new MyPlant Model
view you created in the previous lab)
c.

Click on your brand new Report Kiosk report

d. Sit back and enjoy the report rotation.


e. It should go through the 4 reports one per 10 seconds
8. You probably noted that the trends report need a little more time, and perhaps the HTML ones
not as much, so lets adjust the Content Rotator rotation time so the rotation time for the reports
to be as follows(in seconds): Hello world = 5 , Excel report 15, Trend has 20, VantagePoint
Release Note Page 10
a. Launch VantagePoint Manger
b. Navigate to MyEnterprise>MyPlant
c.

Right-click on Report Kiosk, Select Edit

d. Change the AutoRotationInterval to 5, 15, 20, 10

712 of 878

NOTE: That the times entered will be assigned to the corresponding report based on their
location in the sequence list. In this case 5 is assigned to first report in the sequence, and
10 to the fourth.
e. Click OK

9. Test your content rotator again by following the same steps as before :
a. Launch VantagePoint Portal
b. Navigate to MyEnterprise>MyPlant>Reports (or select your brand new MyPlant Model
view you created in the previous lab)
c.

Click on your brand new Report Kiosk report

d. Note the new rotation times

10. Experiment with the various navigation video controls above the reports being rotated. Note
that the action bar corresponds to the report being shown and changes as the content rotates
through (i.e. Trend has a client trend button on the upper right corner and the others dont)
NOTE: When viewing the content rotator in the portal, you can click down arrow beside
the Full Screen selection box and lock the report so that each piece of content remains in
full screen mode. If you select Full Screen without locking it, full screen applies to the
initial content that displays, but returns to the browser view when switching to the next
content item.
Congratulations you have just completed this lab and lesson

This lab and lesson is complete


713 of 878

The page intentionally left blank

714 of 878

Lesson 19 FTVP Eventing


What you will learn:
In this lesson, we configure a few report set as well as few trigger events to execute the report
sets. In the process you will earn:

How to Configure a Reporting Event which can include Pre-rendered report by configuring
Reporting Set
Eventing Service
How to Schedule Pre-Rendered Reports to the Portal with Hyperlinks.
How to Schedule Reports to be created as PDF documents.

Prerequisite:

We use some of the reports we generated during this training class. If you did not finish a
related lab and do not have the mentioned report, you can get them C:\Class Files\VP
Completed\Excel Completed Report, or use another report you created in this training, or
use one from the sample content.

Discussion
Invariably, in just about every application there is a requirement for triggered based unattended report
generation. The trigger can be time or event based.

Creating Report Sets


You can create a report set that consists of one or more reports that can be executed at the same
time. You can also use report sets in conjunction with the Eventing plug-in. With Eventing, you can
schedule a report set to run on a specific day at a specific time, run daily, weekly, or monthly reports
etc., and can send an email containing the report to users.
Troubleshooting: If the generated report prints off the page when viewed, you will need to edit the
report in Excel, and use Excel's Page Layout tab to either change the orientation to Landscape or
change the margin size.

Eventing
The VantagePoint Eventing plug-in provides functionality for the triggering of actions based on
intelligent filtering of event streams from VantagePoint sources.
As the sources of events, you can use any tags with a historical data provider, or data read from a
text file. Live data sources are not supported.
The events acquired from these sources can be used to directly trigger actions, or they can be filtered
using standing queries written in LINQ before being used to trigger actions.

715 of 878

The actions triggered by the events include generating reports, sending emails, and logging event
data to a text file. If an item in the VantagePoint model supports an operation that performs a desired
function, an Eventing action can also invoke that operation.
Important: To ensure that the Eventing plug-in functions properly and the server operates with no
interruptions, you need to disable application recycling.

StreamInsight Instances
The VantagePoint Eventing service requires Microsoft StreamInsight, a platform for developing event
processing applications. The service is linked to a StreamInsight instance named VantagePoint. If no
StreamInsight instance with this name exists on your computer, you need to install Microsoft
StreamInsight during the installation of VantagePoint. If a StreamInsight instance with such a name
already exists, the installation is not required.

Event Definitions
Event definitions are user-specified objects in the Eventing plug-in. The following components are
related to event definitions:
Source
This is the source of an event that occurs. Events can have one or more sources specified. Sources
are the required components of event definitions. The Eventing plug-in supports the following source
types:
Scheduler
Events occur according to a configured schedule.
TextFile
Events occur based on the records in a specified text file.
VPTags
Events occur based on the values of one or more VantagePoint tags.

NOTE: The Scheduler and VPTags source types have built-in event data fields. For more
information please refer to the online help

716 of 878

Action
This is the action that is performed when an event occurs. Events can have one or more actions
specified. Actions are the required components of event definitions. The Eventing plug-in supports the
following action types:

OperationInvoker
Events invoke an operation on an item. Action type comprises three possible actions when
you create an event definition:

TextFile

Send an email.
Run a report.
Execute an operation.

Events are written to a text file.

Event Data
This is the data included in an event that occurs. Event data is created by sources and can be
accessed and used by actions. Event data can be custom or built-in. Event data is created by
sources. Source items populate built-in and custom event data fields with data from their respective
data sources. All source types in the Eventing plug-in support custom event data. Additionally, the
Scheduler and VantagePoint Tags source types have built-in event data fields.
Please refer to online help for more information on how to Create Custom Event and Create Custom
Event Definitions

717 of 878

Starting Event Definitions


In the Model Browser, right-click the event definition you want to start and select Start Event
Definition.
Tip: If you want to start all event definitions at the same time, right-click the Eventing
plug-in node and select Start All Event Definitions.
1. It may take up to 30 seconds until you can see that the event definition has been started. You can
verify its new status in the following ways:
2. Select the event definition you have started. In the View Container, select the Properties tab.
3. Verify whether the Status property value is Running.

4. Right-click the event definition you have started and select Properties. In the Properties tab,
verify whether the value of the Status property is Running.

718 of 878

5. When you select Start Event Definition or Start All Event Definitions, the definitions that
already are in the Running status are restarted.
6. If you have started an event definition, but its status has not changed to Running, check the
event definition data and correct it if necessary, or contact your system administrator.
7. You can edit an event definition that is in the Running status. When you finish editing and save
the changes, the event definition is automatically restarted by the system.
8. If the server is restarted, all event definitions in the Running status are restarted automatically.

Stopping Event Definitions


In the Model Browser, right-click the event definition you want to stop and select Stop Event
Definition.
Tip: If you want to stop all event definitions at the same time, right-click the Eventing
plug-in node and select Stop All Event Definitions.
1. It may take up to 30 seconds until you can see that the event definition has been stopped. You
can verify its new status in the following ways:
2. Select the event definition you have stopped. In the View Container, select the Properties tab.
Verify whether the Status property value is Stopped.

3. Right-click the event definition you have stopped and select Properties.

719 of 878

4. In the Properties tab, verify whether the value of the Status property is Stopped.

5. If you have stopped an event definition, but its status has not changed to Stopped, check the
event definition data and correct it if necessary, or contact your system administrator.

Advanced Editing Options


The Eventing plug-in provides advanced editing functionality. This functionality is aimed at power
users who want to access additional editing settings related to event definitions and their associated
queries.
The advanced editing includes:

Adding multiple sources and actions.


Enabling and disabling sources and actions.
Editing and deleting sources and actions.
Adding additional source event data (beyond the event data predefined by the source).
Deleting source event data.
Editing source criteria that are not critical to the use case.
Editing LINQ queries.
Accessing additional filtering settings.
Accessing monitoring options.
Event definitions chaining.

Please refer to online help for detail explanation of how to use Advance Editing Options.

720 of 878

Lab 1 Creating a Report Set


In this lab we will create three report sets. One to run a single report, the other to run a collection of
report, and one for parameterized report

Part A Create a Report Set to Run A Single Report


1. Verify that you are on the Server Image (Server tab is selected).

2. Launch VantagePoint Manager.


3. Create a new Report set following the steps below:
a. Navigate to System>Services>Reporting
b. Right-click ReportSets
c.

Select New > Item

d. Type in BL1 Basic Temp Report


e. Click OK

721 of 878

4. Configure the source of the report to be the Excel Basic Report we created in Lesson 5, print to
a PDF file, and have a link to the generated report in the Portal following the steps below:
Note the FQN for the report in the Name field
a. Select Run a single report
b. Select MyEnterprise.MyPlant.Reports.Basic Report from the drop down list (if you did not
complete the associated lab with the Basic Report in Lesson 5, get it from C:\Class
Files\VP Completed\Excel Completed Report or pick any report that is NOT parameterized
from the sample list)
NOTE: The report selection did not cause an entry in the Parameters with Values field.
This is because our Basic Report has no parameter
c.

Check Print automatically to

d. Select BroadGun pdfMachine


e. Empty Field because Basic Report has no External parameter(s)

722 of 878

f.

Click on Additional Settings

g. Select Make generated report


h. Use the default Location (MyEnterprise.Public) to store the Links to the report URLs

i.

While we are here lets take a look at the Email Notification tab

j.

This is where you get a chance to configure this report set to be emailed to a recipient list.

k.

As this image does not contain an email server, we leave this option alone

l.

Click Validate to determine if there are any configuration issues

m. Click OK to accept our BL1 Basic Temp Report report set

n. Click Yes on the confirmation message.

723 of 878

o. Note that the Report set you just generated appears under the ReportSets node

5. Verify and Test the BL1 Basic Temp Report ReportSets following the steps below
a. Navigate to System > Services > Reporting > ReportSets
b. Select BL1 Basic Temp Report
c.

Select Properties tab

NOTE: All the configuration information about this report are on this property page
NOTE: The LastRunResult field is empty as we have not ran this report yet

d. Right-click on BL 1 Basic Temp Report


e. Click Run Report

NOTE: The Copy selection, as it is the case with other objects allows you to create a
shortcut to this node in your logical model. You could have also created this item in your
logical model by creating an instance of Reporting.Plugin.ReportSet.
The Edit selection will bring up the same window you used to create this event set

724 of 878

f.

An information dialog box lets you know that a report is being generated. It may take 10
seconds or so.

g. Click OK when the Successfully completed message comes up

h. Note that the LastRunResult field now contains the information about this report generation.
It provides the report name, its location and whether it was successful or not. In this example:
i.
ii.
iii.

Report generation was successful


Location is: C:\inetpub\wwwroot\IncuityPortal\MyEnterprise\MyPlant\Reports
Name: Basic Report + Local Data&Time + GMT time.PDF

i.

.In the Window, browse to


C:\inetpub\wwwroot\IncuityPortal\MyEnterprise\MyPlant\Reports

j.

Note the generated report

725 of 878

k.

Open the PDF file which was just created. It should look exactly the same as when you
rendered it in the portal. Note that the report reflects the 15 minutes prior to the time of the
ReportSet run execution because the Basic Report was setup for the last 15 minutes

6. You just created your first ReportSet and tested it to be successful. In Lab 2 we will learn how to
create Event to run this report based on an event. For now we will create a few more ReportSet
to get familiar with some other ReportSet features.

726 of 878

Part B Create a Report Set to Run Reports in a folder


In this part, we will create a folder where we will put a shortcut to the reports we are interested in and
then use the ReportSet function to create a reportset to run these reports. Please note that we are
only creating this new folder because chances are that you do not wish every single report in your
Reports folder to be generated by an event, otherwise we could simple use the Reports folder in this
process as well and not create this new folder.
1. Create a folder called EventGenReports under MyEnterprise>MyPlant following the steps
below:
a. In VantagePoint Manager, expand MyEnterprise folder
b. Right Click on MyPlant
c.

Select New>Folder

d. Enter EventGenReports for the folder name


e. Click Create

727 of 878

2. Create a shortcut to Basic Report and Equipment Data reports and put them in the new
EventGenReports folder following the steps below:
a. Navigate to MyEnterprise > MyPlant > Reports
b. Select both Basic Report and EquipmentData reports (Holding Ctrl key, and left click)
c.

Right click on either selected reports

d. Select copy

e. Navigate to MyEnterprise > MyPLant


f.

Right-click on EventGenReports

g. Select Paste Shortcuts

728 of 878

h. You should now have the shortcut to the reports that you selected in your new folder
i.

We will use this folder in our new Reportset generation in the upcoming steps.

3. Create a new Report set following the steps below:


a. Navigate to System>Services>Reporting
b. Right-click ReportSets
c.

Select New > Item

729 of 878

d. Type in Equipment and Temp Reports


e. Click OK

4. Configure the source of the report to be the folder we just created, print to a PDF file, and have a
link to the generated report in the Portal following the steps below:
a. Note the FQN for the report in the Name field
b. Select Run all reports in a folder
c.

Click on ellipsis and navigate to MyEnterprise>MyPlant>EventGenReports, and select this


folder

d. Check Print automatically to


e. Select BroadGun pdfMachine

730 of 878

f.

Click on Additional Settings

g. Select Make generated report


h. Use the default Location (MyEnterprise.Public) to store the Links to the report URLs
i.

Click Validate to determine if there are any configuration issues

j.

Click OK to accept our Equipment and Temp Reports report set

k.

Click Yes on the confirmation message.

Note that the Report set you just generated appears under the ReportSets node

731 of 878

5. Verify and Test the Equipment and Temp Reports ReportSets following the steps below
a. Navigate to System > Services > Reporting > ReportSets
b. Select Equipment and Temp Reports
c.

Select Properties tab

Note all the configuration information about this report is on this property page
Note the LastRunResult field is empty as we have not ran this report yet

d. Right-click on Equipment and Temp Reports


e. Click Run Report

732 of 878

f.

An information dialog box lets you know that a report is being generated. It may take 10
seconds or so.

g. Click OK when the Successfully completed message comes up

h. Note that the LastRunResult field now contains the information about this report generation.
It provides the report name, its location and whether it was successful or not. In this example:

i.

Report generation was successful


Location is: C:\inetpub\wwwroot\IncuityPortal\MyEnterprise\MyPlant\Reports
Name: Basic Report + Local Data&Time + GMT time.PDF

In the Window, browse to C:\inetpub\wwwroot\IncuityPortal\MyEnterprise\MyPlant\Reports

Note the newly two generated report corresponding to the two reports we had put in the
folder

733 of 878

j.

Open the two PDF file which was just created. It should look exactly the same as when you
rendered it in the portal.

k.

Also note that EquipmentData as you may recall was a result set of a Linked Query, so all
that work is done behind the scene

NOTE: You might have noted that Equipment Data PDF report is not formatted very well.
This is because we did not configure print area in our excel report. You should use
standard Excel print area function to set the printing are correctly if you plan to print the
report.
4. You just created your second ReportSet and tested it to be successful. In Lab 2 we will learn how
to create Event to run this report based on an event. For now we will create a few more
ReportSet to get familiar with some other ReportSet features.

734 of 878

Part C Create a Report Set to Run a Parameterized Report


In this part, we will create a report set for a report that is parameterized. We will use the BL Min and
Max Zone Temp which as you may recall had two parameters, one was the oven selection, and the
other time period of interest. The utility of these parameterized reports is once again demonstrated
here. We are going to see that we can use the same report and simply pass a different parameter to it
to generate a report for the selected parameter.
1. Create a new Report set following the steps below:
a. Navigate to System>Services>Reporting
b. Right-click ReportSets
c.

Select New > Item

d. Type in BL 1 Min & Max Temp Report


e. Click OK

735 of 878

2. Configure the source of the report to be the Excel BL Min and Max Zone Temp, print to a PDF
file, and have a link to the generated report in the Portal following the steps below:
Note the FQN for the report in the Name field
a. Select Run a single report
b. Select MyEnterprise.MyPlant.Reports.Basic Report from the drop down list (if you did not
complete the associated lab with the Basic Report in Lesson 5, get it from C:\Class
Files\VP Completed\Excel Completed Report or pick any report that is parameterized from
the sample list)
NOTE: The report selection now contains the two parameters required by this report. One
being the Oven Selection and the other being the relative time period. These are the
parameters we had configured when we created this report Also Note that a default value
is selected for both parameters:

c.

Line1OvenSimple
Last 30 minutes

Check Print automatically to

d. Select BroadGun pdfMachine

736 of 878

3. Configure the parameters for the report to be generated following the steps below:
a. Right click on MyEnterprise.MyPlant.Tags.BL1.Line1OvenSimple
b. Select Edit Parameter Value

c.

Click on the ellipsis, and note that it is asking for the specific item reference e FQN to be
used for this report

d. At this point, we can use either of our lines:

e. We will keep the default, so click cancel and navigate back to the Report Editor
f.

Using the same process you can also select a different time period

NOTE: You can use a single parameterized report to generate many report sets for
various equipment, time periods, or whatever parameter that the report happens to
support.
g. Click on Additional Settings
h. Select Make generated report
i.

Use the default Location (MyEnterprise.Public) to store the Links to the report URLs

j.

Click Validate to determine if there are any configuration issues


737 of 878

k.

Click OK to accept our BL 1 Min & Max Temp Report report set

l.

Click Yes on the confirmation message.

m. Note that the Report set you just generated appears under the ReportSets node

738 of 878

4. Verify and Test the Equipment and Temp Reports ReportSets following the steps below
a. Navigate to System > Services > Reporting > ReportSets
b. Select Equipment and Temp Reports
c.

Select Properties tab

Note all the configuration information about this report is on this property page
Note the LastRunResult field is empty as we have not ran this report yet

d. Right-click on BL 1 Min & Max Temp Report


e. Click Run Report

739 of 878

f.

An information dialog box lets you know that a report is being generated. It may take 10
seconds or so.

g. Click OK when the Successfully completed message comes up

Note that the LastRunResult field now contains the information about this report
generation. It provides the report name, its location and whether it was successful or not.
In this example:

Report generation was successful


Location is: C:\inetpub\wwwroot\IncuityPortal\MyEnterprise\MyPlant\Reports
Name: Basic Report + Local Data&Time + GMT time.PDF

h. In the Window, browse to


C:\inetpub\wwwroot\IncuityPortal\MyEnterprise\MyPlant\Reports
Note the newly report corresponding to the Parameterized reports

740 of 878

i.

Open the two PDF file which was just created. It should look exactly the same as when you
rendered it in the portal.

j.

Cursor down to see the table and the chart.

k.

Note that the returned data is for the last 30 minutes which is the time period we had selected
for the time parameter

l.

Also Note that the selected oven is for Line 1 because that is what we had selected for the
oven parameter.

m. Feel free to create another report set using different parameter value and verify the operation
of these kinds of parameterized reportsets.
5. You just created your third ReportSet and tested it to be successful. In Lab 2 we will learn how to
create Event to run this report based on an event.

741 of 878

Information about the Report Editor Options


Name

Displays the fully-qualified name for the report set.

Description

Enter an optional description for this report set.

Select the following:


Run all Excel reports in folderSelect this option, click
ellipsisand select a folder. This option generates any Excel
reports that exist in the selected folder.
Run single Excel reportSelect this option, and either select a
report from the drop-down list or click ellipsis and select an
Excel report. If you select this option, and the report contains
parameters, you can add, edit, and delete those parameters in
the Parameters with Values list box.
Parameters with Values (Only available if you select Run single
Excel report)Right-click a parameter and select Add
Parameter Value to add a new value for the selected
parameter.

Report Set Source

You can also right-click a parameter value to edit the parameter


value or delete the selected value from the parameter:

742 of 878

Select the Print automatically to check box, and then select the
printer to use from the drop-down list to create a printed copy of
the report when the report runs.
Important: The list of available printers is the set of printers that
have been configured for the VantagePoint System User. If the
list is empty or does not contain the desired printer, it will be
necessary to perform the following steps:
On the VantagePoint server:
Log onto the VantagePoint server with a domain account. This
account will need to be set up as the System User using
Manager. See Changing System Users for more information.
From the Windows Start menu, select Devices and Printers,
and then add the printer. This can be a physically connected
printer or network printer.
From a client or on the VantagePoint server:
Printing

Launch Manager from the server configured above.


If the configured printer is a network printer, set the
VantagePoint System User to the domain account specified in
step 1 above. If the printer is directly attached to the server, this
step is not necessary.
Create or edit a reportset. While configuring the printing option,
the drop-down list of printers will now include the printers added
in step 2 above.
If the configured printer is a network printer, change the
OfficeUser to the same account as in step 1 above. This is done
to allow the Office Automation code to print reports to the
selected network printer. If the printer is directly attached to the
server, this step is not necessary, but the office user must not
be the local account.
Reports will now render and print to the configured printer.

Additional Settings
tab

743 of 878

Insert a Link to
report URL into
Model

Make generated report visible in Portal Model Browser


Select this check box to create a ReportingURL item in addition
to the ReportingTag created. The ReportingURL item ensures
that you can view the report in the Portal.
Store URL inWhere you want to store the viewable report.

Important: If you want to use this email feature, you must


configure the Email plugin under System > Services >
Communication. See Configuring Email Properties for more
information.
Complete the following:
Enable emailSelect this check box to begin sending
automated emails for this report set.
Email Notification
tab

FromDisplays the email address from which the report will be


sent. You can modify this if needed.
ToEnter the email address for the individual or distribution list
that you want to send the report to.
Note: Multiple email addresses are not supported.
SubjectEnter a subject name for the email.
TextEnter the body of the email.
PrioritySelect a priority for the email.

Tip: You can generate a PDF version of the report at any time by right-clicking the report
in the ReportSets node and selecting Run Report.

This lab is complete

744 of 878

Lab 2 - Creating Event Definitions


In this lab, we will create two events, one time based (time triggered) and one based on a change in a
tag value (tag triggered)

Part A Create a Tag Trigger Event


1. Create an event to run a report based on a change to a tag value following the steps below:
a. Navigate to System>Services>Eventing
Note: This path is only an example and is used when creating event definitions in the
System namespace of the VantagePoint model. You can create event definitions anywhere
else within the logical namespace of the VantagePoint model. To create a new event
definition, you need to create an instance of the DataWorks.MI.Eventing.EventDefinition.
b. Right-click EventDefinitions
c.

select New > Item

745 of 878

d. Select Run a report


e. Select A Change to a tag value
f.

Click Next

When creating an event definition, you can select one of the following supported source types:

A change to a tag value


Involves selecting one or more tags and specifying tag criteria to cause action performance.

A particular time or schedule


Involves specifying the frequency of event occurrence.

An event simulated by the contents of a text file


Involves specifying a text file whose contents will be used to simulate events.

When creating an event definition, you can select one of the following supported action types:

Send an email
Involves configuring and sending an email.

Run a report
Involves selecting a report set and generating a report.

Execute an operation
Involves configuring an operation invoked by an event.

Write out the event to a text file


Involves writing events to a text file.

746 of 878

g. Enter MachineActiveTrigger for the Event Definition Name (note the definition name cannot
contain spaces)
h. Click Next

i.

Click Add

j.

Navigate to MyEnterprise>MyPlant>Tags>BL1>Line1Info

k.

Select MachineActive

l.

Select When the tag changes value to True

m. Click Next

747 of 878

NOTE: The trigger can be based on multiple tags of any type, digital, analog as well as
string. And it can be based on change of state (digital) or value (string and analog)
n. Select one of your ReportSets you created in the previous lab (i.e. BL1 Basic Temp Report

o. Click Create to create the report

748 of 878

p. Select Yes, and Click Finish to create the Event Definition.

2. Verify the Event following the steps below


a. Select MachineActiveTrigger
b. Select Properties Tab
c.

Note all the settings

749 of 878

d. Right-click MachineActiveTrigger
Note that you can Start or Stop the Event Definition
e. Select Edit

f.

Here you get a chance to:

Go back and change the tag valuation definition


Run the report (overwrite the trigger condition)
Or switch to advance editing where you can modify Linked query items

g. Feel free to experiment with these options.


h. When the Machine Active bit goes true, or if you override it using the menu previous dialog
box, you will run the report set as defined in the previous lab, and will get a new report in the
report
NOTE: You can also manually change the status of the event definition any time after you
have created it. The current status of event definitions is displayed in their properties

750 of 878

Part B Create a Schedule Event


1. Create an event to run a report based on a time schedule following the steps below:
a. Navigate to System>Services>Eventing
NOTE: This path is only an example and is used when creating event definitions in the
System namespace of the VantagePoint model. You can create event definitions anywhere
else within the logical namespace of the VantagePoint model. To create a new event
definition, you need to create an instance of the DataWorks.MI.Eventing.EventDefinition.
b. Right-click EventDefinitions
c.

Select New > Item

751 of 878

d. Select Run a report


e. Select A particular time or schedule
f.

Click Next

When creating an event definition, you can select one of the following supported source types:

A change to a tag value


Involves selecting one or more tags and specifying tag criteria to cause action performance.

A particular time or schedule


Involves specifying the frequency of event occurrence.

An event simulated by the contents of a text file


Involves specifying a text file whose contents will be used to simulate events.

When creating an event definition, you can select one of the following supported action types:

Send an email
Involves configuring and sending an email.

Run a report
Involves selecting a report set and generating a report.

Execute an operation
Involves configuring an operation invoked by an event.

Write out the event to a text file


Involves writing events to a text file.

752 of 878

g. Enter HourlyReport for the Event Definition Name (note the definition name cannot contain
spaces)
h. Click Next

i.

Setup the scheduled source as follows:

j.

Click Next

753 of 878

k.

Select one of your ReportSets you created in the previous lab (i.e. BL1 Basic Temp Report)

l.

Click Create to create the report

754 of 878

m. Select Yes, and Click Finish to create the Event Definition.

2. Verify the Event following the steps below


a. Select HourlyReport
b. Select Properties Tab
c.

Note all the settings

755 of 878

d. Right-click HourlyReport
e. Note that you can Start or Stop the Event Definition
f.

Select Edit

g. Here you get a chance to:

Go back and change the tag valuation definition


Run the report (overwrite the trigger condition)
Or switch to advance editing where you can modify Linked query items

h. Feel free to experiment with these options.


i.

Every hour on the hour, or if you override it using the menu in previous dialog box, you will
run the report set as defined in the previous lab, and will get a new report in the report

NOTE: You can also manually change the status of the event definition any time after you
have created it. The current status of event definitions is displayed in their properties

Congratulations, you just completed this lab and lesson.

This lab and lesson is complete

756 of 878

Lesson 20 - FactoryTalk VantagePoint Security


Specifying Named Users and Securing the Model

What you will learn:

The parts of securing a FactoryTalk VantagePoint application


System and Office User accounts
Named and Concurrent users
Securing the Model

Prerequisite:

Completion of Lesson 2
Completion of Lesson 9 (if you have not the files needed can be retrieved from the
Completed folder)

In this lesson we will

Add 3 windows users to the VantagePoint Security system


Configure them as named users
Assign them to certain roles
Define security for the roles
Test user for their authorization and privileges
The three users are VPUser1, VPUser2, and VPUser3.
The password for all three is Rockwell1

Discussion
Understanding Users and Roles
VantagePoint offers a role-based security implementation that operates in conjunction with Microsoft
Windows and assumes Windows authentication of users/groups (using either Domain or Local
Windows security). A VantagePoint administrator uses VantagePoint Manager to maintain a list of
users or groups that have access to VantagePoint. VantagePoint users can be assigned to one or
more roles via a role membership association.
When the VantagePoint Server starts, it interrogates Windows for Domain and Local Users and
Groups security and correlates Windows users and groups with VantagePoint users and groups. This
only occurs during startup of the VantagePoint Server. At this time, members of the Windows
Administrators group are mapped to the BUILTIN\Administrators group, Windows Power users are
mapped to the BUILTIN\PowerUser group, and Users are mapped to the BUILTIN\Users group.

757 of 878

These users, in turn, are mapped to the following corresponding preconfigured roles in VantagePoint:
Administrator, PowerUser, and User.
As users and user groups are added to VantagePoint, the system employs Windows authentication to
impose security. Sometimes, even when authenticated, users or groups will not be activated in
VantagePoint until an IISRESET is run.
Important: Any changes to the domain Active Directory, or the Windows Local Users and Groups on
the VantagePoint Server require an IISRESET of the VantagePoint Server. This reinitializes the
security settings on the VantagePoint Server.

Action

IISRESET Required

Add a Domain group into VantagePoint

No

Add a Domain user into VantagePoint

No

Add a user/group to the Local Windows user/group

Yes

Add a group into the Active Directory

Yes

Add a user into the Active Directory

Add a user into an existing group into the Active Directory

758 of 878

Differences Between Users and Roles


The following table describes the differences between users and roles.
VantagePoint includes preconfigured users A group or individual who uses the
System. Each user must belong to a role in order to obtain permission to access
system items, or user groups, based on conventional system usage and security
requirements. These users are pre-assigned to roles. During initial installation, the
following Windows Local groups are defined as VantagePoint users, and assigned to
the described role:

Users

BUILTIN\AdministratorsAssigned to the VantagePoint administrator role.


BUILTIN\PowerUsersAssigned to the VantagePoint Power user role.
BUILTIN\UsersAssigned to the VantagePoint user role.

Any members of one of these Windows user groups will automatically be passed
through to the associated role in VantagePoint.
All BUILTIN users can be deleted. The permissions associated with each user and/or
user group are configurable. Use VantagePoint Manager to manage security on your
VantagePoint system.

VantagePoint implements a role-based security system assuming Windows


authentication of users/groups (using either Domain or Local Windows security).
VantagePoint comes with seven preconfigured roles, or user groups, based on
conventional system usage and security requirements. See Preconfigured Roles for
more information.

SysAdmin Role
All roles except for SysAdmin can be edited or deleted. For every item that exists in
the model there must be at least one role associated with it that has all permissions to
the item, can change permissions on the item, and has one or more users associated
with that role. The SysAdmin fulfills this function in the system. This role cannot be
deleted and will always have at least one user associated with it.

Roles

Upon installation of VantagePoint, the BUILTIN/Administrators user is mapped


onto the SysAdmin role.
This means that all persons in the local Administrators group will be in the
BUILTIN/Administrators group in VantagePoint, and therefore, in the SysAdmin role. It
is recommended that immediately after installation a qualified user be placed in the
SysAdmin role, and that the BUILTIN/Administrators user be removed from the
SysAdmin role.
All users in the BUILTIN/Administrators role retain the permissions to manage system
security, whether they are in the SysAdmin role or not.

Permissions
Permissions are set on VantagePoint items based on role membership. Authorized
users can view role permissions on items using the Security tab in VantagePoint
Manager or by opening the Properties context menu item in the Model Browser. Use
VantagePoint Manager to manage security on your VantagePoint system.

759 of 878

FactoryTalk VantagePoint Accounts


System User
The VantagePoint System needs a user account to operate under. Usually the Server machine will
belong to a Domain with a normal user name and password.

This user should be a normal Domain user with only the most basic permissions.
This user should not be added to any other local user groups such as PowerUser or
Administrator.
The password for this user should never expire.
This account also enables the Excel report-renderer to run. If the Excel application has never
been run on the machine onto which the VantagePoint Server is being installed, the install
will cause Excel to launch in order to create the user profile under which the Office
Automation will run.
The VantagePoint Server renders reports published to the Portal by running an automated
copy of MS Office. This installation of Office needs to run with a pre-existing, valid Windows
user name and password. User level permissions for this user are adequate. It is necessary
that this copy of Excel has been launched at least once prior to users generating any Excel
reports in the Portal.

The IncuityStore database credentials are used to create and access the IncuityStore SQL Server
database. When VantagePoint and the SQL Server that VantagePoint installs the IncuityStore
database onto resides on the same machine, the System User can deploy a Local Account.
Local Account also applies to persons who will run the complete VantagePoint System on their local
machine. Such a person might be a Systems Integrator or a developer.
Office User
Publishing Excel reports requires that the VantagePoint Server run an automated copy of Microsoft
Office under a valid user name. It is the Office User whose credentials are impersonated when the
server automates Excel for report generation in the VantagePoint Portal.
All Excel reports are executed as the Office User. Therefore, independent of the rights that the user
requesting the report has, the report can write to any property and execute any operation that the
Office User has access to.
Furthermore, the report can only read properties, write to properties, and invoke operations that the
Office User has access to. In rare cases this could result in a situation where the user that requests
the report could access an item / operation but the report execution logic cannot.
For these reasons, it is recommended that the Office User:

be configured to have minimal access rights


be configured to have a non-expiring password.

Typically reports only perform read access. However, in cases where reports modify sensitive data or
read from sensitive sources, the report's permissions need to be set up so that only the appropriate
people have access to the report. These permissions must be set on the Report item inside
VantagePoint Manager.

760 of 878

IncuityStore Database
The IncuityStore Database configuration provides for the following:

Specifying an account for use in creating the internal IncuityStore database


Dropping and re-creating the IncuityStore database

Security Mode:

Integrated -Use Windows-based security


SQL Server - Use SQL Server security
User Name: User name with privileges to create this database
Password: Password of this user

Security Defaults

761 of 878

762 of 878

763 of 878

Preconfigured Roles
The following table describes the roles that are preconfigured in VantagePoint.

User

Casual users of VantagePoint typically consume data, reports, and other


VantagePoint content, and they most often interact with VantagePoint through the
VantagePoint Portal. This user will launch reports, view and interact with Portal
dashboard displays, analyze Trends, and perhaps author company notice boards
for use in the Portal. A Casual user may range from a Maintenance Manager
checking on equipment performance, to a Secretary editing the department
newsletter, to a Vice President reviewing sales data. This user generally relies on
existing reports.
Power users know how the plant is wired together, know where the data is, and
want to create content that the Casual user can use. He can do much of this inside
Excel, and he does not need to be a programmer to create sophisticated reports
that he can publish to the Portal. This user will also be able to use his Excel skills
to create powerful animated executive dashboard displays that relate important
information at a glance.

PowerUser

Furthermore, some power users will concentrate on developing Trends and XY


Plots that can be accessed through the Portal and analyzed away from the plant
itself. Some of these "reports" will become very sophisticated as scaled
background graphics, shapes, batches and other application properties are
employed when analyzing plant performance.
Much of the output created by Power users can be shared when sister plants
install VantagePoint and employ VantagePoint models that mirror one another.

Modeler

Modelers, often Systems Engineers, are business specialists who understand the
nature and structure of the business enterprise, where all of the information about
the business is located, and how that information interrelates. This is the person
who will design and deploy the VantagePoint model, along with the System
Administrator. They have a deep understanding of the requirements for
information about the business processes, and will appreciate the redundant
qualities of many reporting tasks. As such, many of the aspects of the model that
they design will be portable, and can either be reused with their own system or at
a sister plant, where the same processes take place.
They will be able to model related business information and simplify the structure
of that information to make access and report creation intuitive.

Administrator

Administrators may install and set up VantagePoint, and manage issues with
regards to physical topology, data sources, portals, and client connectivity.
Administrators are very technical and knowledgeable about different software,
networking, and internet usage. They manage user security and maintain the
model content.

Operator

System operators maintain overall system health. He performs backups, monitors


disk space, and performs database maintenance duties.

Everyone

All users belong to the Everyone role by default and minimally have access rights
defined by the Everyone role. If users belong to roles other than Everyone, the
permissions are aggregated.
This role includes all users who can authenticate in the domain, including those
using the Windows Guest account. Typically, a user would be a domain user, but
can also be a workgroup user or even a local user.

764 of 878

SysAdmin

For every item that exists in the model, there must be at least one role associated
with it that has all permissions to the item, can change permissions on the item,
and has one or more users associated with that role. The SysAdmin fulfills this role
in the system. This role cannot be deleted and will always have at least one user
associated with it.
By default, the role is mapped to the local Windows Administrators group on the
server. This mapping can be changed, but the system enforces that at least one
Windows user or Windows user group is always mapped to this role.

765 of 878

Lab 1 Add Windows Users to VantagePoint Users


1. Verify that you are on the Server Image (Server tab is selected).

2. Add windows user VPUser1, VPUser2, and VPUser3 to the VantagePoint user list, following the
steps below
a. Launch VantagePoint Manager
b. Navigate to System > Security folder
c.

Expand the Security folder

d. Right- click on Users and select New > Item

e. Select Core.AuthenticatedUser
f.

Click Create

766 of 878

g. In the Windows user or group name textbox enter server\VPUser1


h. Click Check Name

i.

Verify that the user name was valid ( the name is underlined if valid)

j.

Click Create

k.

Repeat the above step (typing the name, checking the Name, and create) to add VPuser2
and VPUser3

NOTE: For FTVP Security to work correctly and for the FTVP Portal to use Local Internet
you must login into the local OS with each user before you open any FTVP components.

767 of 878

3. Verify the VPUser1, VPUser2 and VPUser3 have been added

This lab is complete

768 of 878

Lab 2 Add Windows User to Named User list


1. Launch VantagePointManager.
2. Navigate to System > License folder.
3. Add VantagePoint users VPUser1, VPUser2, and VPUser3 to the NamedUsers list following the
steps below:
a. Right-click on NamedUsers, and select New > Item

b. In the Windows user name textbox enter server\VPUser1


c.

Click Check Name

NOTE: If the name checks OK you will see the name underlined
d. Click OK

4. Repeat step 3 to add VPUser2 and VPUser3 to the NamedUser list

769 of 878

5. Verify that you have the three NamedUsers as indicated in the diagram below:

This lab is complete

770 of 878

Lab 3 Assign VantagePoint Users to VantagePoint


Roles
1. Assign an Administrator role to VPUser1, following the steps below:
a. Launch VantagePoint Manager
b. Navigate to System > Security > Roles
c.

Select Administrators from the Item Name windows

d. Select the General tab


e. Click Assign

f.

Select the server\VPUser1

g. Click Add

771 of 878

h. VPUser1 is moved and now is assigned to administrator role


i.

Click OK

2. Assign an Operator role to VPUser2, following the steps below:


a. While in System > Security > Roles
b. Select Operators from the Item Name windows
c.

Select the General tab

d. Click Assign

772 of 878

e. Select server\VPUser2
f.

Click Add

g. VPUser2 is moved and now is assigned to operator role


h. Click OK

773 of 878

3. The VPUser1 and VPuser2 now appear in their respective Administrator and Operator roles
(only the Administrator role is shown. Click on Operator tale to see that one as well)

This lab is complete

774 of 878

Lab 4 Add a VantagePoint (VP) Role to VP Security


1. Add the Operator role to the list of roles in MyPlant model, following the steps below:
a. Launch VantagePoint Manager
b. Navigate to MyEnterprise>MyPlant
c.

Select the Security tab

d. Uncheck Inherit Security settings so we can modify these settings


e. Click Add

f.

Select the Operator role

g. Click Add

775 of 878

h. Operator is now one of the selected roles for the Enterprise folder
i.

Click OK

2. Define MyPlant permissions for the Operator role following the steps below:
a. While MyPlant folder and the security tab is still selected from the previous, step check the
Read and Write check boxes for the Operator role
b. Click Save

776 of 878

3. Remove Everyone role form the BL Comp Temp Trend report role list, following the steps below
a. Navigate to MyEnterprise>MyPlant>Reports
b. Select BL Comp Temp Trend report
c.

Select the Security tab

NOTE: Since by default the Inherit Security settings is active, the changes we made to
MyPlant shows up for this report as well
d. Uncheck the Inherit security setting check box
e. Select Everyone
f.

Click Remove

g. Click Yes to confirm the removal

777 of 878

h. The BL Comp Temp Trend report permissions should now look as follow
i.

Click Save to save the permission list for the BL Comp Temp Trend report

NOTE: Since all OS Users are mapped to the Everyone role in the VantagePoint server,
removing it from this report permission list, essentially limits access to this report only to
the roles mentioned . We will test this in the next lab where we login as VPUser3 which
does not have any role assignment and observe the security behavior.

This lab is complete

778 of 878

Lab 5 Test VantagePoint Security in the


VantagePoint Portal
1. Verify that you are on the Server Image (Server tab is selected).

2. Log off
3. Since you are in VMWare, use <Ctrl><Alt><Ins> ( not <Del>) to Log on as VPUser3 (password
is Rockwell1)
4. Open VantagePoint Portal
Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Portal
a. Depending on your IE setting you may get the Phishing Filter
b. Select the Ask me later option
c.

Click OK

d. Depending on your IE setting you may also get the following dialog
e. Click Close

779 of 878

f.

Again, depending on your IE setting you may get a prompt on the tool bar or at the bottom of
the browser about Enabling the Intranet Setting (below is one example)

g. Select the Enable Intranet Setting

h. Click Yes

5. When the portal opens, it may ask you for credential, use the same credentials as the ones that
you logged in (VPUser3 / Rockwell1).
6. Depending on your IE setting you may get a security recommendation setup. For now, select
Dont use recommended settings
7. From the Portal menu navigate to Reports > MyEnterprise.

780 of 878

8. Navigate to MyEnterprise > MyPlant > Reports

NOTE: The BL Comp Temp Trend report is NOT visible to the VPUser3 because we
removed the Read property for that report from the Everyone role
9. Log Off as VPUser3, and log back on as VPUser2. Remember VPUser 2 is assigned an
Operator role which has a read write access to the BL Comp Temp Trend.
10. Open the VantagePoint Portal.
11. From the Portal menu navigate to Reports > MyEnterprise.

781 of 878

12. Navigate to MyEnterprise > MyPlant > Reports

Since the Operator role which is assigned VPUser2 has read and wrote access to the BL Comp
Temp Trend report, it is now visible.

This lab and lesson is complete

782 of 878

Lesson 21 FactoryTalk VantagePoint Backup

What you will learn:

How to back up your system

Prerequisite:

This trainings VMWare image

In this lab we will discuss the importance of the backup procedure and what and how different parts of
VantagePoint need to be backed up.

Discussion
As any other information system, not only it is a good practice, but a critical one to have a good
backup strategy which includes frequent backup of your VantagePoint system to a remote media.
To completely backup the VantagePoint system, so it can be restored to the point when it was backed
up, three areas of operation needs to be backed up:
1. The VantagePoint Databases
There are four VantagePoint Databases, one of which is critical to be backed up, one that is not
needed to be backed up, and two which are optional based on your application, and project
needs:

IncuityStore [CRITICAL TO BE BACKED UP] - This is the database where all items in the
model are stored. This includes all the reports, types, etc. Restoring this database completely
restores the system to the point where the backup was made.
IncuityHistory [OPTIONAL] This database contains any data that was historized by
VantagePoint (do not confuse this with any external historian data point that VantagePoint
references); as well as any internal tags such as Incuity tags. If you dont have any point
historized by VantagePoint, or internal tags which you need to be restored, you do not need
to back this database up.
IncuityDiagnostics [OPTIONAL] Unless there is some specific reason to maintain the
diagnostic information, there is really no need to back this database up.
IncuitySample [NOT NEEDED] The Incuity Sample is installed as part of the installation,
and should not have been modified so there is no reason to back this database.

Ensure that these backups are stored on a secure server other than the VantagePoint or
database server. The most efficient way to do this would be to automate the procedure using
Microsoft SQL Server.
These databases are created during installation, and the SQL Server Recovery model is set to
simple. This default choice provides enhanced performance and reduces the risk of consuming
unreasonable disk space. Note that this model does not store transaction logging information.
The best solution for managing these databases is for the SQL Server DBA to change the
783 of 878

Recovery model to Full, and then create an appropriate Maintenance plan for the databases.
The following Microsoft articles provide a start in understanding Recovery models and how to
apply them:

Recovery Model Overview


http://msdn.microsoft.com/en-us/library/ms189275.aspx
Backup under the Simple Recovery Model
http://msdn.microsoft.com/en-us/library/ms191164.aspx
Backup under the Full Recovery Model
http://msdn.microsoft.com/en-us/library/ms190217.aspx
Maintenance Plans
http://msdn.microsoft.com/en-us/library/ms187658.aspx

Additionally the following Rockwell Automation Knowledge base article (Answer ID 450828)
provides helpful information on how to setup a SQL Maintenance Backup Plan for IncuityStore
database.
https://rockwellautomation.custhelp.com/app/answers/detail/a_id/450828
2. Keep a file backup of all custom Type packages
Custom type packages that are generated with the Type Builder are usually saved on the local
machine in the folder C:\Program Files\Incuity\Packages\.
Keep a file backup of the Web Site and supporting files:

DRIVE:\inetpub\wwwroot\IncuityPortal\
DRIVE:\inetpub\wwwroot\Incuity\
DRIVE:\inetpub\wwwroot\IncuityOffice\

3. Keep a file backup of all scripts and utilities used


Be aware that any application work may add scripts and utilities to your VantagePoint system.
These files may include server-side scripts, instance, and type packages. These files are usually
placed on the VantagePoint Server machine in the folder:

DRIVE:\Inetpub\wwwroot\Incuity\Import\

Although they would not be updated often, folders and files in this directory should be backed up.
Important Note:
This lesson focuses on backing up the main VantagePoint Database. Other items that should be
backed up in a real application are things such as:

Network FactoryTalk Directory


Data Server configurations
Other VantagePoint database(s) and transaction log(s)
VantagePoint website and supporting files
VantagePoint scripts and utilities

See Rockwell Automation Knowledgebase Answer ID 62884 Backing up and Restoring a


FactoryTalk VantagePoint Configuration for additional information. Rockwell Automation
Knowledgebase is http://rockwellautomation.custhelp.com

784 of 878

Lab 1 Backup and Restore IncuityStore Database


In this lab we will walk through the backup and restore process for IncuityStore database. This lab is
not intended to be a comprehensive training discussion of a backup strategy and procedure which
was briefly discussed in the introduction of this lesson. It is intented to cover a backup procedure that
at minimum should be performed at every VantagePoint installation.

Part A Backup the IncuityStore Database


1. Verify that you are on the Server Image (Server tab is selected)

2. Close all VantagePoint applications (Manager, Trend, Portal, etc.)


3. Connect to the Database engine following the steps below:

Start SQL Server Management Studio by going to Start > All Programs > Microsoft SQL
Server 2008 R2 > SQL Server Management Studio
For the setup in this lab, make sure that your server type is Database Engine, Server Name
is Server, and Authentication is Windows Authentication (your application setup of course
might be different)
Click Connect

785 of 878

4. Backup the IncuityStore database by following the steps below:


a. Expand the Databases tree
b. Right-click on IncuityStore, click Tasks > Back Up...

786 of 878

c.

Review the default options and note the default Backup default location

d. Click OK

e. Verify that the Backup was successful


f.

Click OK

787 of 878

Part B Deleting the IncuityStore Database


1. Delete the IncuityStore Database by following the steps below:
a. From the Microsoft SQL Management Studio select the IncuityStore database
NOTE: Do not do this next step in a "real application", unless you are positive your one or
more backups are good or you feel "really lucky"! :-)
b. Right-click and select Delete

788 of 878

c.

Check the Close existing connections check box

d. Click OK

2. Start VantagePoint Manager and note all the error/warning/correction message which you would
expect as there is no Incuity Database.
a. Service Unavailable error . Click Close

789 of 878

b. Next you see a VantagePoint recovery dialog box soliciting information to configure a new
IncuityStore database (if you start the process by clicking on the Modify button). We do not
want to do this as we wish to restore our backed-up database. Click Close

c.

Finally you get a message telling you that your VantagePoint system will not work without the
IncuityStore database, and if you are sure about cancelling the process to create a new
IncuityStore database. Click Yes

3. Close VantagePoint Manager

790 of 878

Part C Restoring the IncuityStore Database


1. Select the file to be restore by following the steps below:
a. From the Microsoft SQL Management Studio select Databases
b. Right-click and select Restore Database...

c.

Select the From device option

d. Click the From device browse icon

791 of 878

e. Verify that the Backup media selected is File


f.

Click Add

g. Navigate to
C:\Program Files\Microsoft SQL Server\MSSQL10_50.MSSQLSERVER\MSSQL\Backup
h. Select IncuityStore.bak file
i.

Click OK

792 of 878

2. Configure where to Restore the Backup file following the steps below::
a. Verify that you have the IncuityStore.bak file selected
b. Click OK

c.

Check the Restore check box

d. From the To database combo box select IncuityStore


e. Click OK

793 of 878

f.

Verify that the restore was successful

g. Click OK

h. Close Microsoft SQL Server Management Studio


3. Verify the operation of the VantagePoint System after the database restore by following the
steps below:
a. Wait 2-3 minutes
b. Open the VantagePoint Manager (you waited 2-3 minutes first, correct?) and verify that you
can view the VantagePoint configuration and model
4. Open VantagePoint Portal and verify your reports exist and work as expected

This lab and lesson is complete

794 of 878

Appendix A: FactoryTalk VantagePoint Getting


Results Guide

FactoryTalk VantagePoint provides dashboards, trends, and reports that work with a broad range of
real-time and historian data sources.
VantagePoint software consists of server and client components. The server has three components:
the System Server, the Portal Server, and the Database Server (or IncuityStore). The client
components include the VantagePoint Portal, Trend, XY Plotter, VantagePoint Manager, and the
Office Excel Add-in.
Please check http://www.rockwellautomation.com/rockwellsoftware/performance/vantagepoint for
updates to this document.

Preface
Contact Rockwell

Customer Support Telephone 1.440.646.3434


Online Support http://www.rockwellautomation.com/support

Copyright Notice

2012 Rockwell Automation Technologies, Inc. All rights reserved.


This document and any accompanying products are copyrighted by Rockwell
Automation Technologies, Inc. Any reproduction and/or distribution without prior
written consent from Rockwell Automation Technologies, Inc. is strictly prohibited.
Please refer to the license agreement for details.

Trademark
Notices

FactoryTalk, Rockwell Automation, Rockwell Software, the Rockwell Software logo


are registered trademarks of Rockwell Automation, Inc.

Other Trademarks

Microsoft, SQL Server, Internet Explorer, Excel, SharePoint, Windows, and Windows
Server 2008 are either registered trademarks or trademarks of Microsoft Corporation
in the United States and/or other countries.
Adobe, Acrobat, and Reader are either registered trademarks or trademarks of
Adobe Systems Incorporated in the United States and/or other countries.
All other trademarks are the property of their respective holders and are hereby
acknowledged.

795 of 878

Warranty

This product is warranted in accordance with the product license. The products
performance may be affected by system configuration, the application being
performed, operator control, maintenance and other related factors. Rockwell
Automation, Inc. is not responsible for these intervening factors. The instructions in
this document do not cover all the details or variations in the equipment, procedure,
or process described, nor do they provide directions for meeting every possible
contingency during installation, operation, or maintenance. This products
implementation may vary among users.
This document is current as of the time of release of the product. However, the
accompanying software may have changed since the release. Rockwell
Automation, Inc. reserves the right to change any information contained in this
document or the software at any time without prior notice. It is your responsibility to
obtain the most current information available from Rockwell Automation, Inc. when
installing or using this product.

System Requirements
Before installing VantagePoint, ensure your system meets the following requirements.
System Server
Operating
System

Microsoft Windows Server 2008 R2 with SP1 (only available in 64-bit); Also requires IIS,
part of the Web Server Role, with IIS version 6 compatibility. Note that IIS is set to 32-bit
mode only.

Software

Microsoft SQL Server 2008 R2 SP1


Microsoft Office 2010 (32-bit only)
Microsoft Internet Explorer 8 or 9
Microsoft .Net Framework 4.0 full version (included with install)
Note: The .NET Framework 4.0 Client Profile is not supported.
Microsoft StreamInsight 1.2 (for Eventing)
Note: FactoryTalk VantagePoint uses a StreamInsight instance named
VantagePoint. If no StreamInsight instance with this name exists on your
computer, you need to install Microsoft StreamInsight during the installation of
FactoryTalk VantagePoint. If a StreamInsight instance with such a name already
exists, the installation is not required. See StreamInsight Instances in the online
help for more information.

Hardware
(minimum)

2.5 GHz CPU


2 GB Hard Drive Space
2048 MB RAM

Note: The VantagePoint server cannot be installed on the same machine where SharePoint is installed.

796 of 878

Full Client
Operating
System

Microsoft Windows XP Professional with SP3 (32-bit or 64-bit)


Microsoft Windows Vista Business with SP2 (32-bit or 64-bit)
Microsoft Windows 7 Professional with SP1 (32-bit or 64-bit)
Microsoft Windows Server 2008 with SP2 (32-bit or 64-bit), Server 2008 R2 with SP1
(64-bit)
Note: Embedded versions are not supported.

Software

Microsoft Office 2007 SP2 or 2010 (32-bit only)


Note: For Dashboard Development only, the Professional Edition or higher is required.
Any Microsoft Office edition that does not support XML maps (such as Microsoft Office
Small Business Edition) is not supported.
Microsoft Internet Explorer 8 or 9
Microsoft .Net Framework 4.0 Extended version (can be downloaded from the Portal if
not installed)
Note: The .NET Framework 4.0 Client Profile is not supported.
Xcelsius 2008 SP5 (for Dashboard development)
Adobe Flash Player (for Dashboard viewing)
Adobe Reader (for viewing Eventing/ReportSet reports)

Hardware
(minimum)

1.5 GHz CPU


100 MB Hard Drive Space
512 MB RAM

797 of 878

Browser Client
Operating
System

Microsoft Windows XP Professional with SP3 (32-bit or 64-bit)


Microsoft Windows Vista Business with SP2 (32-bit or 64-bit)
Microsoft Windows 7 Professional with SP2 (32-bit or 64-bit)
Microsoft Windows Server 2008 with SP2 (32-bit or 64-bit), Server 2008 R2 with SP1
(64-bit)
Note: Embedded versions are not supported.

Software

Microsoft Internet Explorer 8 or 9


Microsoft .Net Framework 4.0 Extended version (can be downloaded from the Portal if
not installed)
Note: The .NET Framework 4.0 Client Profile is not supported.
Adobe Flash Player (for Dashboard viewing)
Adobe Reader (for viewing Eventing/ReportSet reports)

Hardware
(minimum)

1.5 GHz CPU


100 MB Hard Drive Space
512 MB RAM

798 of 878

Installing FactoryTalk VantagePoint


To start using FactoryTalk VantagePoint, you will need to complete the following steps:
1. Install the FactoryTalk VantagePoint Server on a suitably configured machine. See Installing
the VantagePoint Server for more information.
NOTE: SQL Server must exist before installing the VantagePoint Server. You can use an
existing SQL Server installation, or the Standard Edition is available for VantagePoint
users. The Standard Edition requires an additional licensing cost and is recommended for
large application deployment.
2. Complete the FactoryTalk Activation process. See Activating the FactoryTalk License for more
information.
3. Configure connectors to the data sources that you want to use with VantagePoint. See
Configuring Connectors for more information.
4. From a client machine, browse to http://ServerMachineName/Incuity or http://
ServerMachineName/VantagePointPortal and install the VantagePoint Client Applications.
See Installing Client Applications for more information.
5. (Optional) Install the Dashboard Builder. See (Optional) Installing the Dashboard Builder for
more information.
This guide will help you with your initial configuration of VantagePoint. Detailed information about
VantagePoint can be found in the online help, which is installed with the server.

799 of 878

Installing the VantagePoint Server


NOTE: The VantagePoint server cannot be installed on the same machine where
SharePoint is installed.

Preparing the VantagePoint Server Machine


Network Considerations
The VantagePoint Server should be installed on a server that:

Has network access to the plant data sources (Control systems, HMI systems, and
historians) that VantagePoint will be configured to access data from.
Is accessible to the intended FactoryTalk VantagePoint users.

In environments where control networks have been separated from business networks, the Server will
require a network card attached to each network.
This figure shows a typical
architecture with the server
running VantagePoint having
access to several data sources.
VantagePoint users connect to the
VantagePoint Portal (which runs
on the server) to begin working
with the system.

Server Platform Considerations


Production installations of FactoryTalk VantagePoint Server require:

Windows Server 2008 R2 with SP1 (64-bit running IIS in 32-bit mode)
Note: The Windows Server should be configured as an Application Server and a member of
the domain (if applicable to your organization). If you are using a domain, it is recommended
that you be logged onto the server where you will be installing VantagePoint as a domain
user that has local administrator rights on the server.
SQL Server 2008 R2 SP1 Standard Edition
Microsoft Excel 2010 (32-bit only)

These products, in addition to all applicable service packs and updates, should be installed prior to
the installation of the VantagePoint Server.

800 of 878

Before You Begin


Ensuring that the Office User Account is Valid
The VantagePoint Server requires Microsoft Office to render reports created with the Excel Add-In,
and this copy of Excel needs to run under a valid Windows user account referred to in VantagePoint
as the System/Office user account. The account is required to enable running Excel in an automated
fashion. The user on this account must be a "real" Windows account user with normal user level
permissions. The Domain Name is expected to be the same as the Domain Name for the
VantagePoint Server. For more information, see Modifying VantagePoint Server Accounts in the
online help.
NOTE: This copy of Excel must be launched at least once prior to users generating any
Excel reports in the Portal. The installer launches Excel during the install process.
Installing and Configuring IIS
To avoid interruptions during the install process, please make sure that Internet Information Service
(IIS) is installed and configured as follows:
To install and configure IIS under Windows Server 2008 R2 SP1
1. In Server Manager, expand Roles, and then right-click Web Server (IIS) and select Add Role
Services.
2. Under Application Development, select ASP.NET.
3. Under Security, select Windows Authentication.
4. Under Management Tools > IIS 6 Management Compatibility, select IIS 6 Metabase
Compatibility.
If the above roles are not installed, the following message displays during the install process.

801 of 878

Installing the VantagePoint Server


Important: You can install recommended components listed on the Install FactoryTalk VantagePoint
page in the wizard at a later time; however, make sure you perform the following:

The FactoryTalk Services Platform must be installed before installing FactoryTalk


VantagePoint.
After installing a recommended component at a later time, you must open the command
prompt on the target machine and execute the following command:
C:\Inetpub\wwwroot\Incuity\Download\IncuityManager.exe /IsConfigMode
Beginning in version 4.5, VantagePoint now includes an optional SQL CLR feature. This
feature is not installed by default, and can only be installed using the Custom Setup option
described in Step 9 below. SQL CLR lets you query the VantagePoint model using T-SQL
commands, uses SQL Server Reporting Services to author and publish reports to a report
server, integrates Reporting Services reports to the VantagePoint model/Portal, integrates
Reporting Services reports into Composite reports, and launches Report Builder from the
Portal. For more information, see SQL CLR in the online help.

802 of 878

To install the VantagePoint server:


1. Run the setup program (setup.exe) from the VantagePoint installation DVD. The FactoryTalk
VantagePoint wizard appears.

2. Select Install FactoryTalk VantagePoint.

This is the screen for installing prerequisite software, VantagePoint, and optional features.

803 of 878

Important: You can install recommended components listed on this page at a later time; however,
make sure you perform the following:

The FactoryTalk Services Platform must be installed before installing FactoryTalk


VantagePoint.
After installing a recommended component at a later time, you must open the command
prompt on the target machine and execute the following command:
C:\Inetpub\wwwroot\Incuity\Download\IncuityManager.exe /IsConfigMode

3. Select Install Microsoft .NET Framework 4.0 (if it is not installed), and complete the installation
of the .NET Framework, which is a prerequisite for installing VantagePoint.
4. Select Install FactoryTalk Activation Manager, and install the following components, which are
prerequisites for installing VantagePoint:

HASP USB dongle drivers (After clicking Continue, a dialog box prompts you to optionally
install these drivers.)

FactoryTalk Diagnostics

FactoryTalk Activation Manager

Windows Firewall Configuration Utility

NOTE: You do not need to restart your computer for this step.
5. (Recommended) Select Install FactoryTalk Services Platform to install common components
used by the FactoryTalk connector, and complete the wizard.
6. (Recommended) Select Install OPC Core Components to install common components used by
OPC connectors.
7. (Recommended) Select Install FactoryTalk Historian SDK to install common components used
by the FactoryTalk Historian connector, and complete the wizard.
8. Select Install Microsoft StreamInsight to install components used by the Eventing feature.
Eventing sends email notifications when tags exceed their threshold or change states, when a
batch completes, and so on.

804 of 878

9. If you do not have a copy of Microsoft SQL Server 2008 R2 installed:


a. Select Install SQL Server 2008 R2 or Dashboard Builder.
b. Select Install SQL Server 2008 R2.

The VantagePoint DVD includes a copy of the Standard Edition of Microsoft SQL Server. This
edition requires an additional licensing cost and is recommended for large application
deployment. It is also possible to use an existing Microsoft SQL Server for deployment of
VantagePoint. During installation of VantagePoint, you will be asked to provide the details of this
SQL Server installation.
The VantagePoint Server requires Microsoft SQL Server for deployment of the IncuityStore
database. The IncuityStore database is where all items in the model are stored. This copy of SQL
Server can exist on the host machine of the VantagePoint Server, or on a different domain
machine.

805 of 878

c.

Review the following for additional information:

Important: The VantagePoint Server only requires installation of the SQL Server Database
Services component of SQL Server. If you are using the SQL CLR feature in VantagePoint, you
must also install Reporting Services.
Complete the wizard. For detailed SQL Server 2008 R2 installation instructions, see
http://rockwellautomation.custhelp.com/app/answers/detail/a_id/279061/kw/sql%202008%20vant
agepoint.
d. Select Install SQL Server 2008 R2 SP1, and complete the service pack installation.
10. Select Install FactoryTalk VantagePoint to install the product. Review the following for additional
information about this wizard:
Choose Setup
Type Page

Select one of the following:

ExpressInstalls all features on the same machine, including the


VantagePoint Server, IncuityStore database, and Portal.
CustomAllows you to:
Specify the name of the VantagePoint Portal. Note that you cannot
use the following non-alphanumeric characters in the Portal name or
it will not launch:
`~!@#$%^&*()_+=-{}|\][:"';<>?/.,
Install Client applications (required if using Portal reports) and
Sample content. Sample content includes all the items created
under MyEnterprise.Samples v4. The simulators created to support
these items are also part of the sample content. The Simulator
Connector type, however, will still exist as a data source under
System.Sources in VantagePoint Manager.
Install ActiveX Trend support (ActiveX Trend installation registers
Trend and XY Plotter ActiveX controls on the client machine,
enabling the controls to be used in ActiveX containers.)
Install Type Builder. The Type Builder helps you create and edit

806 of 878

Database
Connection
Information Page

VantagePoint package files


(*.itp). Package files contain information about base types in the
model, allowing you to customize a specific model. Package file
contents are XML based. The Type Builder abstracts the user from
the details of the XML structure and presents the data in an intuitive
user interface.
Install VantagePoint SQL CLR. If selected, a VantagePointCLR
database that hosts the SQL CLR stored procedures and functions
is installed in SQL Server, SQL CLR is enabled in SQL Server, and
the Incuity System User is added to the VantagePointCLR database
and to the SQL Server Reporting Services Admin / Users security
group.
This feature lets you query the VantagePoint model using T-SQL
commands, uses SQL Server Reporting Services to author and
publish reports to a report server, integrate Reporting Services
reports to the VantagePoint model/Portal, integrate Reporting
Services reports into Composite reports, and launch Report Builder
from the Portal.
Important:
You must install SQL Server Reporting Services before installing
this feature.
This feature can only be installed using the Custom Setup
option, and is disabled by default.

Enter database connection information.


The user running the installer must be a local machine administrator. To
access the SQL Server database, this user can use integrated security to the
database server if they have sys admin rights on the database server.
Otherwise, SQL Server credentials with sys admin rights (such as sa) must
be specified.
The IncuityStore database credentials are used by the VantagePoint Server
to create and access the IncuityStore SQL Server database, the
IncuityHistory database, and the IncuitySample database. The System user
is granted ownership of all three databases.

System/Office User
Page

The VantagePoint system needs a user account to operate under as it


configures the three system web sites: the VantagePoint Server, Portal
Server, and Office Server. Usually, the Server machine belongs to a Domain
with a normal user name and password.

This user should be a normal Domain user with only the most basic
permissions.
This user should not be added to any other local user groups such as
PowerUser or Administrator.
The password for this user should never expire.

This account enables the Excel report-renderer to run. The VantagePoint


Server renders reports published to the Portal by running an automated copy
of MS Office. This installation of Office needs to run with a pre-existing, valid

807 of 878

Windows user name and password. User level permissions are usually
adequate. The installer will launch Excel to create the user profile (Office
user). Should you later decide that this user needs greater permissions than
those automatically created, you can create a new Office user with the
necessary permissions, and then change the Office user in Manager. See
Modifying Server Accounts in the online help for more information.
Note: If you select Local account, all users added to the system must be
added from the system machine console. An administrator cannot browse
to the server from a client machine to add users.
When the installation of VantagePoint completes, the Portal will automatically open. From the Portal,
you can launch the other applications that are part of the VantagePoint System using links on the
Home page or from the Portal menu. These applications typically run on a client computer and will
download on demand.
On the VantagePoint Server, the VantagePoint applications can also be found under: Start > All
Programs > Rockwell Software > FactoryTalk VantagePoint.

808 of 878

Activating the FactoryTalk License


In order for your VantagePoint System to be operational, you must complete the FactoryTalk
Activation Process. If your VantagePoint Server has access to the Internet, you can complete the
activation process via the Activation Wizard which is accessed from the FactoryTalk Activation
Manager (Start > All Programs > Rockwell Software > FactoryTalk Activation > FactoryTalk
Activation Manager). If using the Activation Wizard, the FactoryTalk Activation Manager needs to be
run on the VantagePoint Server.
If you do not have access to the Internet from the VantagePoint Server, you can complete the
activation process from a computer with access to the Internet via the website
https://licensing.software.rockwell.com. See the FactoryTalk Activation online help or the Activate
Rockwell Software Products booklet for additional information.

The FactoryTalk Activation Manager is used to complete the activation process. You will need the
information on the license certificate to complete the process (Serial Number & Product). If you do
not have access to the Internet from the VantagePoint Server, you will need to complete the process
via the licensing website.

809 of 878

VantagePoint utilizes capacity based licensing which requires the FactoryTalk Activation Manager.
The FactoryTalk Activation Manager is installed as part of the VantagePoint Server installation and
runs on the same server. When completing the activation process, the generated license file(s) must
be located in the folder searched by the activation server.

If you complete the activation process via the website (rather than use the Activation Wizard), you will
need to copy the downloaded license file (yyy.lic) to a folder that is being searched by the local
activation server.
On Windows Server 2008 R2, the default folder is:
c:\Users\Public\Documents\Rockwell Automation\ Activations\

810 of 878

Initializing the License on VantagePoint


After you have completed FactoryTalk Activation, VantagePoint Manager (Manager) is used to
update VantagePoint with the licensing information from the FactoryTalk Activation Manager (Start >
All Programs > Rockwell Software > FactoryTalk VantagePoint > Manager). This step must be
completed on the VantagePoint Server (not by running Manager from a remote client). Select
Reactivate License from the Configuration menu in order for the VantagePoint Server to check for
new FactoryTalk Activations. This menu item is only available in Manager when it is run on the
VantagePoint Server.

811 of 878

Manager is used to administer the entire VantagePoint System. Select Configuration > License
Activation to update the license used by VantagePoint. This step is done after the FactoryTalk
Activation process has been completed.

Click Reactivate on this dialog for VantagePoint to request licenses from the FactoryTalk Activation
Manager. If no valid VantagePoint licenses are available from the FactoryTalk Activation Manager, an
error message displays. Adding a new license to VantagePoint will cause the server to stop/restart
briefly.

812 of 878

Using Manager, you can confirm what license is being used by VantagePoint. Select the License
node under the System folder. You should see the License Type specified as Permanent. If you are
running under a Grace Period license, the License type should display as Grace Period.
Notes:
When first installed, VantagePoint will use a Grace Period License if the FactoryTalk
Activation has not been completed. The Grace Period License allows the system to run for
7 days from the time of the initial installation. The expiration date of the Grace Period
License is displayed in Manager and in the Help | About dialog box on each of the
VantagePoint applications.
A Grace Period License activates VantagePoint functionality and sets the capacities to

5x Named Users
5x 3rd Party Historian Connector Instances
5x 3rd Party Real-time Connector Instances
5x Database Connector Instances

There is no restriction on the number of FactoryTalk Live and FactoryTalk Historian connectors that
can be configured. In addition, a Grace Period License does not place any limits on tag creation for
Calculation tags, Incuity tags, or Storage tags.

The FactoryTalk Activation Manager will not start if a valid VantagePoint license is not found.
The FactoryTalk Activation Manager runs as a service. After the activation process is
completed, you can close the FactoryTalk Activation Manager.
The reactivate process from VantagePoint Manager needs to be completed each time you
add additional capacity to the system through FactoryTalk Activation.
Additional licenses for VantagePoint can be purchased to:
o Add additional Named and Concurrent User Licenses
rd
o Add 3 Party Real-time Connector Instance(s)
rd
o Add 3 Party Historian Connector Instance(s)
o Add Database Connector Instances(s)

813 of 878

User Licenses
VantagePoint supports both Named and Concurrent User Licenses. Named User Licenses are
automatically assigned to users as they connect to the VantagePoint Server. It is also possible for an
administrator to delete and add a named user manually.

If the VantagePoint System detects a Concurrent User License, this license will be temporarily
assigned to users as available.

814 of 878

Configuring Connectors
Connecting to Data Sources
To view and analyze your manufacturing data, you will need to configure the VantagePoint Server to
connect to your production data sources. This configuration is done using VantagePoint Manager.
(Manager is used to manage the entire VantagePoint System including configuration of the model
and security.)
To connect to a data source:
1. Click the Manage link on the Portal Home page to open Manager. You can also select Tools >
Manager in the Portal menu.

2. In the Model Browser, select the System > Sources nodes to list the available connector types.
3. Right-click the desired connector, select New > Item, and let the wizard guide you through the
installation process.
Connectors can be configured to access data from:

FactoryTalk Live Data Sources (Logix controllers, PLC, SLC, etc.)


FactoryTalk Historian
FactoryTalk Alarm & Events History
rd
3 Party Real-time Sources (through FactoryTalk Live Data-OPC DA connector)
rd
3 Party Historian Sources (through OPC HDA, Industrial SQL Server, GE Proficy Historian,
OSI PI)
Database Connectors ( including SQL Server, Oracle, OLEDB, ODBC)
815 of 878

VantagePoint Simulator
A simulator is installed with VantagePoint so that you can begin learning the product before you have
it attached to your plant data sources. Several instances of the simulator are created during the
installation. Additional instances can be created by right-clicking the Simulator node (under the
System > Sources node), and selecting Create Instance.

Configuring FactoryTalk Data Sources


FactoryTalk VantagePoint supports connection to FactoryTalk Live Data, FactoryTalk Historian, and
FactoryTalk Alarm and Event data sources. FactoryTalk data sources must be configured
appropriately prior to referencing the data in VantagePoint.
The flow chart below illustrates how to configure FactoryTalk data sources such that the data can be
referenced by VantagePoint. This example uses LinxNG Enterprise which is the recommended and
preferred data server for communicating with Rockwell Automation controllers (Control Logix, PLC-5,
SLC-5 etc.). LinxNG Enterprise installation files can be found in the Redist\LinxNG folder on the
VantagePoint DVD.

Configuring FactoryTalk Data Sources Flowchart


ROCKWELL AUTOMATION CONTROLLERS
(ControlLogix, PLC-5, SLC-5, ETC)
o
o
Begin
o

Does your environment


contain an existing
FactoryTalk Directory?

NO

Connecting Rockwell
Automation data
sources to
Vantage