FactoryTalk VantagePoint EMI Advanced Lab: Exploring the Possibilities. For Classroom Use Only!

Transcription

1 FactoryTalk VantagePoint EMI Advanced Lab: Exploring the Possibilities For Classroom Use Only! Publication Number -- Date Copyright 2010 Rockwell Automation, Inc.

2

3 FactoryTalk VantagePoint EMI Advanced Lab: Exploring the Possibilities Contents Before you begin... 5 About this lab... 5 Tools & prerequisites... 5 Background:... 7 Type Packages... 8 Lab 1: Create a Type... 9 Lab 2: Enhance the Type Lab 3: Model Builder Plug-In Lab 4: Create a Tag Provider Lab 5: DbBuilder Plug-in: Dynamically create Tag Providers Section B: Excel Reporting The Excel Office Add-In Overview Menu Items VantagePoint Functions Using Names in Excel Excel Worksheets (Tabs) Created Lab 1: Excel Report and Publishing Lab 2: Support Absolute and Relative TimePeriod Lab 3: Linking Reports and Post Processing of 224

4 Lab 4: Using SQL in VantagePoint Excel Reports Lab 5: Report Runner Lab 6: Macros Lab7: Composite Reports Part A Creating a Proof-Oven Composite Report Part B Adding the Proof-Oven Composite report to the VantagePoint Portal View Part C - Adding an Excel Report Section C: Dashboards Lab 1: Dashboard Lab 2: Dashboard Cascading Selection Section D: Fun Snippets Incuity Tags Calculated Tags Lab 1: Creating an Incuity Tag Lab 2: Manual Data Entry Type Lab 3: Creating a Calculation Tag Section E: Status Item Lab 1: Simple Status Item Reporting Lab 2: StatusItem with Custom Type Package of 224

5 Before you begin The following steps must be completed before starting the lab exercise: 1. Start the VMware image W2k8-FTVP1. The image is configured for auto logon. Should the auto logon fail and you receive the logon screen, log on with the following credentials: Username: Administrator Password: Rockwell 2. All completed lab files are located on the desktop in a folder called Class Files. A location has been setup if there is a requirement in the lab exercise to save files: C:\_Student\. About this lab Welcome to the FactoryTalk VantagePoint EMI Hands-On Lab! This session provides you with an opportunity to explore FactoryTalk VantagePoint EMI 4.0. The following sections explain what you ll be doing in this lab session, and what you will need to do to complete the hands-on exercises. FactoryTalk VantagePoint EMI accesses information from disparate data sources, organizes it in a way that is meaningful to all levels in a company and provides tools for analysis and reporting of that data via the web to help stakeholders make more informed business decisions. Tools & prerequisites Software programs required: Microsoft Windows Server 2008 R2 Standard 64 Bit Microsoft Internet Explorer 8.0 RSLinx Enterprise v5.5 FactoryTalk Historian Site Edition v2.2. FactoryTalk VantagePoint EMI 4.0 FactoryTalk Administration Console 2.5 (CPR9 SR5) Microsoft Office 2010 (Excel 2010) SoftLogix v20 RSLogix5000 v20 RSLinx Classic v2.59 SR 5 FactoryTalk Activation Xcelsius 2008 Hardware devices required None Files required None 5 of 224

6 This page left blank intentionally 6 of 224

7 Section A: Model Background: Central to VantagePoint EMI 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 an access to the information stored throughout an Enterprise and bringing it into the unified view that VantagePoint hosts, does require some 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. To truly leverage the tool that the Model can become, it is necessary to create useful objects that the end users can easily use, objects that encapsulate all of the data about themselves. 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: Speed, Flow Rate, and 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: 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 an engineering view point the pump might have: performance curves, an associated motor, upstream and downstream equipment items. VantagePoint EMI 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 EMI, 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. 7 of 224

8 Type Packages Type Packages are extensions to VantagePoint EMI that define types which are often specific to an industry, business, or public sector entity. VantagePoint EMI ships with a few pre-defined sample type packages which are installed with the VantagePoint EMI software (unless a custom installation excludes the Sample Content). The sample packages are found on the same machine as the VantagePoint EMI Server under C:\Program Files\Incuity\Packages. In this location are other Type Packages which are currently in use by VantagePoint EMI. 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 EMI system. These packages can be created by directly editing an XML file, or by employing the VantagePoint EMI 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 EMI Manager to import Type Packages and build your model. By importing a Type Package, you will have added new types to VantagePoint EMI. 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. This section of the Advanced Training lab we will look at designing and building a model in the UPM (Unified Production Model) within VantagePoint EMI. This section will be broken down into several labs. Lab 1 will illustrate how to build a Type system using a tool called Type Builder to build a Tank Type. Lab 2 will enhance the type package built from Lab1 and introduce different techniques in model building. Lab 3 will automate the building of the Tanks Type via scripting and leveraging the Model Builder plug-in. Lab 4 will illustrate how to build tag providers from a SQL Server data source. Lab 5 we will learn how to leverage a plug-in called DbBuilder to script the creation of tag providers tags. 8 of 224

9 Lab 1: Create a Type In this lab we will learn how to create a type package representing a Tank. We will also create properties of Tank 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 Tank type. What you will learn Ability to Create a Type within VantagePoint EMI Manually Create a Model Data Source: FactoryTalk Historian Types, what does this mean in VantagePoint EMI. Let us consider a Tank for instance. A Tank may have attributes or properties such as instrumentation that measures its level, temperature and even pressure. If this Tank were to be created as a Type within VantagePoint EMI, you would be able to create instances of that Type (Tank) in any application; each Tank having their own properties. This is advantageous in the respect that if you were to need a report that gives details of a specific Tank Type, the report can be reused against any Tank of the same type. The type or Tank object in this case can also be used within any of the other reporting tools within VantagePoint EMI such as Trend. 1. Start on the W2k8-FTVP1 image. 2. Select Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Type Builder. 3. With the Type Builder loaded, we will now build a type that reflects a Tank with attributes from instrumentation such as Temperature, Pressure, Level and an Alarm tag. From the Type Builder application, select File > New to start a new project. 4. In the Package name field, assign the package name of TechEd. 5. From the menu select File > Save As. Save the file in the folder: C:\_Student\Advanced\SectionA\Lab1. File name should be TechEd.itp. Note: The file extension is a VantagePoint known file type meaning, Item Type Package. 9 of 224

10 6. In the Types area of Type Builder, click the Add button to create a new Type. Call the Type Tank. Click the OK button to accept the type name. 10 of 224

11 7. With the new Tank type created, create some properties associated to the Tank. Click the Add button located on the bottom right hand side of the Type Builder window under Type details. 8. With the newly created property created, select it so that it is highlighted and click the Edit button. 11 of 224

12 9. The Configure Property window is displayed. Change the Property Name to Temperature and leave the rest of the options to the default. Click OK. Refer to the following table for a definition of the available options in the Configuration Property dialog box: Field Property Name Data Type 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 predefined values Sub Data Type Default Value Description Read Write Default Property The data type of the item depending on which class the Property Type falls into Default value for the Property Sets a property description These attributes specify the security access rights of the associated PropertyType. The Read attribute specifies whether or not the property is visible 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. 12 of 224

13 10. Repeat the previous step for the Properties listed below (the Property previously created, Temperature, is included). Take note of the Sub Data Type changes for each of the different properties. Property Data Type Sub Data Type Temperature Reference Core.AnalogTag Pressure Reference Core.FloatTag Level Reference Core.AnalogTag Alarm Reference Core.DiscreteTag Product Code Reference Core.StringTag 11. Completed Type for the Tank Type is as follows. Note: We have our Type defined as a Tank type with properties associated to it. We also have defined properties of our Tank with much friendlier names that anyone can understand, as opposed to a cryptic tag name such as TNK_A_LVL_1011 for a level transmitter. 12. Save your changes by selecting File > Save from the menu. Close the Type Builder. 13 of 224

14 13. At this point we can now import the Type Package into VantagePoint and build our model. Open VantagePoint Manager by selecting Windows Start button and select All Programs > Rockwell Software > FactoryTalk VantagePoint > Manager. 14. Select File > Import.from the menu in VantagePoint Manager. 15. Click the ellipse button and browse to C:\_Student\Advanced\SectionA\Lab1, select the TechEd.itp file and click the Open button. This is the type package file for our Tank Type. Click the Next button to continue and the Finish button when the import has completed.. 14 of 224

15 16. The imported type package will be displayed in a list within VantagePoint with other known type packages installed. Select View, Packages from Manager. 17. To build a Tank, select View > Items. This will change the current view of the available type packages to a view on MyEnterprise and the System node. 15 of 224

16 18. Expand the node MyEnterprise. Right click on the folder Public and select New > Item. The Tank type object will be created in this location. 19. Select TechED.Tank and click Create to create a Tank instance of the defined type. 20. In the Configuration dialog box we can define the instance of Tank type. Enter Tank 1 in the Name field. 16 of 224

17 21. To define the properties of Temperature, Pressure, Level, Alarm and ProductCode we will need to browse to our defined data sources. From the ProductCode property, click the ellipse button to browse for the appropriate tag name. 22. Navigate to System > Sources > FactoryTalk > LocalHost > Historians > Production Historian and click on Tags Look for a tag called: RA Foods:RSLE:BL1.Line_1_BreadLine.Mixer_Current_Product_Code Select the tag so it is highlighted and drag it into the Product Code field 17 of 224

18 18 of 224

19 Repeat this step for the remaining tags of our Tank. Use the table below for the remaining properties. Property Location Tagname Temperature Pressure Level Alarm ProductCode FactoryTalk Historian Tag FactoryTalk Historian Tag FactoryTalk Historian Tag FactoryTalk Historian Tag FactoryTalk Historian Tag RA Foods:RSLE:BL1.Program:Proof_Oven.OvenUDT.TempZone1 CDT158 BA:LEVEL.1 RA Foods:RSLE:BL1.Program:Packaging.MachineUDT.MachineActive RA Foods:RSLE:BL1.Line_1_BreadLine.Mixer_Current_Product_Code 23. Completed Tank Instance. Click Create. Note: The tag name RA Foods:RSLE:BL1.Line_1_BreadLine.Mixer_Current_Product_Code in its format within VantagePoint is described as System.Sources.FactoryTalk.localhost.Historians.Production Historian.Tags.[RA Foods:RSLE:BL1.Line_1_BreadLine.Mixer_Current_Product_Code] is known as its Fully Qualified Name. The Fully Qualified Name or FQN of an object in VantagePoint is its unique identifier within the model. 19 of 224

20 24. Completed Tank 1 in the MyEnterprise > Public folder. 25. The Tank 1 object has now been created and some level of reporting against the Tank 1 can now be done. By selecting each of the Properties of Tank 1, such as Level, you ll notice on the right side (ensure the Properties tab is selected) the Live Value of the particular tag for Tank 1 is displayed. 26. Create one more Tank object under our Public Folder: Navigate to the MyEnterprise > Public folder and select New > Item Browse the available types for TechEd.Tank and click the Create button Call the new Tank Type, Tank 2 20 of 224

21 27. Define the properties of the tag just as we did in previous step 21. The table below suggests some tags for you to try. Feel free to select any tag from the available data sources (Connectors) for your properties: Property Location Tagname Temperature Pressure Level Alarm ProductCode FactoryTalk Historian Tag FactoryTalk Historian Tag FactoryTalk Historian Tag FactoryTalk Historian Tag FactoryTalk Historian Tag RA Foods:RSLE:BL1.Program:Proof_Oven.OvenUDT.TempZone2 SINUSOID RA Foods:RSLE:BL1.Program:Mixer.Mixer_KG_Wt RA Foods:RSLE:BL1.Program:Proof_Oven.OvenUDT.InZone2 RA Foods:RSLE:BL1.Program:Proof_Oven.MachineUDT.ProductCode Note: If you attempt to define a tag to a discrete type tag which is of type analog, a warning will occur specifying that an incorrect tag type was selected. Select the correct tag type for each corresponding property. 28. The two completed Tank Types: Try the Tanks in VantagePoint Trend. You will notice you can drag each Tank itself onto the trend or its individual properties. NO ILLUSTRATION SHOWN. Summary Using the VantagePoint Type Builder we created a new Type called Tank. With the creation of the type Tank, properties of the Tank were created referencing tags from FactoryTalk Historian. Completing the Type package we then proceeded to import the type package into VantagePoint creating instances of a Tank. The model gave us the ability to grab an object by its name and use it for reporting in VantagePoint Trend. 21 of 224

22 This page left intentionally blank 22 of 224

23 Lab 2: Enhance the Type This lab we will reuse our Type from Lab 1 and enhance the type adding more complex attributes and rules to our type. In this lab we will also add the Tank to the RSTechED model, implementing different types and create abstract types with our Tank Model Package. What you will learn Reusing existing Type Packages Implementing types Abstract constructions Collections data types References sub data type Data Source: FactoryTalk Historian / FactoryTalk Metrics If you have competed Lab 1 of this section you can continue Lab 2 from your original Type package labeled TechEd.itp that was saved in the location C:\_Student\Advanced\SectionA\Lab1. Note: If you have skipped Lab 1 of this section, the TechEd.itp file for the Tank package is located on the desktop in Class Files\SectionA\Lab1. 1. Start on the W2k8-FTVP1 image. With the previous lab file loaded in the Type Builder, do a saveas and rename the package to TechED1.itp, save the file to C:\_Student\Advanced\SectionA\Lab2. Click Yes to rename the Type Package. 2. Using the Type Builder we ll extend the concept of the Tank and make a Tank Farm where the Tank Type belongs to a collection of Farm type that actually belongs with the Area Type of TechEd.Food.Area. 3. First we ll create an Equipment type and make its construct Abstract. This will allow us to create different pieces of Equipment against the type. Please refer to VantagePoint Manager. Expand the RSTechED folder and navigate to Sites > Orlando > Areas; the model that we will connect to. 23 of 224

24 4. On the right hand side of Manger, select the General tab. Notice the properties of the object. For example: Orlando has a collection called Areas and its Fully Qualified name is MyEnterprise.RSTechED.Sites.Orlando.Areas. We will want to join our Farm type package to latch onto the Orlando > Areas node as a new Area type. 5. Create a new Type, call it Equipment and change its Construction to Abstract. Click the Add button to complete. Abstract: Types of this construction cannot be created as concrete instances in the Model. This is more of a convenient way to store a list of properties for use by other Types: they form a collection of base properties often shared by many Types, but alone do make a useful instance. 6. We need to tell our Type where in the RSTechED model it belongs. An existing type package for RSTechED needs to be imported. From the Required Packages area, click the Add button and then the Browse button to select the directory located on the desktop Class Files\SectionA\Lab2\ Select the file TechEd.Food.itp Click the OK button Return to the Select Package window and ensure that the package TechEd.Food.Package has been selected Click OK to continue 24 of 224

25 7. We will now create a new Type called Farm. Farm will contain all the different equipment collection defined by our type package. Add a new Type call it Farm. Add a new property and call it Equipments. Change the Data Type to Collection and its Sub Data Type to TechEd1.Equipment 8. In the Implements area within Type Details, add TechEd.Food.Area to the Farm Type. 25 of 224

26 9. We will now create one additional piece of Equipment to get the concept across. Create a new type called Hopper Add a property called Weight with a Data Type of Reference and a Sub Data Type of Core.AnalogTag. Create another property called Product with a Data Type of Reference and a Sub Data Type of Core.StringTag We want the Hopper to belong to the Equipment type. In the Implements area, click the Add button and select TechEd1.Equipment 10. Select the type Tank and in the Implements area click the Add button and make it implement TechEd1.Equipment. Save the Package. Close Type Builder. What just happened: In this exercise we used the existing Type package for our basic Tank, imported an existing Type Package from another project that has a type of TechEd.Food.Area. We wanted our Farm to contain other pieces of equipment s other than a Tank, so we created a Hopper and assigned the Hopper type to the Collection of Equipments and also joined the Tank type to the equipment collection. When we create an instance of the Farm type in the model, we will only be able to create it at the Area section of the RSTechED Model. We will also be able to pick what Hoppers and Tanks we want to create in the Farm Type. 13. Import our new Type package: Click File > Import, using the ellipse button, browse to the folder C:\_Student\Advanced\SectionA\Lab2\TechEd1.itp Click the Next button to continue and the Finish button when the import has completed. 14. To build an Instance of the new Type: In VantagePoint Manager, navigate to MyEnterprise > RSTechED > Sites > Orlando > Areas Right click on Areas and select New > Item 26 of 224

27 Select TechEd1.Farm and click the Create button. 15. Enter TankFarm for the Name. Click the Create button. 16. Next, to create a couple of tanks and a hopper in our TankFarm: Right click on Equipments and select New > Item Select TechEd1.Tank and click Create Enter Tank 1 for the Name and click Create Repeat for an additional Tank with the Name Tank Repeat the previous step this time creating a Hopper with the Name Hopper Results of the New Type Package Note: We did not wire the tags to the objects in this section of the lab. Please feel free to do so picking any tag from the Data Sources available. Summary Lab 2 taught us other types of techniques for building our model. We can build common types and implement them within new projects We can build types of well know classes, such as Equipments We can build types that belong to a collection We can build types that require other type packages for implementation. 27 of 224

28 This page left intentionally blank 28 of 224

29 Lab 3: Model Builder Plug-In This lab we will describe how to use the Model Builder Plug-in. It is a free add-on tool 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 has been done for you. This lab will illustrate how to use the ModelBuilder with the completed SQL scripts with brief explanations of the script itself. NOTE: Model Builder is available on the knowledgebase at FactoryTalk VantagePoint EMI - Model Builder. What you will learn How to script the creation of a model using Model Builder Data Source: FactoryTalk Historian 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. 29 of 224

30 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. Note: You will need to understand your data model and be comfortable writing SQL to take advantage of this solution. If you have competed Lab 2 of this section you can continue Lab 3 from your original Type package labeled TechEd1.itp that was saved in the location C:\_Student\Advanced\SectionA\Lab2. Note: If you have skipped Lab 2 of this section, the TechEd1.itp file for the Tank package is located on the desktop in Class Files\SectionA\Lab3. 1. Start on the W2k8-FTVP1 image. 2. Open VantagePoint Manager, from the Windows Start menu (Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Manager). Ensure the Type package for TechEd1.itp has been loaded in VantagePoint Manger. Check Manager by selecting View > Packages. If the TechEd1.itp file is NOT present, load it from the File > Import menu item. Select the ellipse button and browse to the desktop Class Files\SectionA\Lab3\TechEd1.itp. 3. Expand the System Node and navigate to the Sources folder. 4. In the Sources folder, right click on ModelBuilder and select Create Instance. 30 of 224

31 5. Call the instance TankFarm. Select Execute. 6. Expand the node TankFarm and right click on DbLocations. Select New > Item. 7. Call the new Item instance TankDB. Select Eastern Time for the Time Zone. 31 of 224

32 8. In the Database field, click the ellipse button to reference a SQL database. Browse to System > Sources > Db > MsSQL> RAFoods. Click OK when done. Note: RAFoods is a connection to a Microsoft SQL Server database; Model Builder requires a SQL data source. 9. The figure below is the completed configuration of Model Builder data source. Click Close (not shown) to continue. 32 of 224

33 10. Right click on the ModelBuilder instance called TankFarm and select Edit. 11. Select Edit Queries, located on the bottom left of the Model Builder editor. 12. The following dialog is shown. This is the ModelBuilder development environment. 33 of 224

34 13. Click the Import Queries button on the bottom left. Browse to the desktop to Class Files\SectionA\Lab3\SectionALab3.sql. Note: Change the Files of Type selection to SQL files to open the file SectionALab3sql on the Open window dialog. 14. The Import displays three items in the grid, TankFarm, Tank and Hopper. 34 of 224

35 15. What do the queries do? Let s look at the first entry TankFarm. Select it from the grid. The following select statement is used to create the instance of the TankFarm Farm Type. Select Tank Farm, TechEd1.Farm,, MyEnterprise.RSTechED.Orlando.Areas, The following table defines how the SQL script is designed. Select Tank Farm TechEd1.Farm ItemName: Name of the object to be created in the model ItemType: Name of the Type to create an instance from ParentItemType: Not Required MyEnterprise.RSTechED.Orlando.Areas ParentItemName: Fully Qualified Name of the position in the model to create the instance Tank Farm. ParentPropertyName: can be left NULL or blank 16. Click on Tank and Hopper to see the script used to build an instance of both types. 17. Let s build the model. Click the Close button to return to the Editor window of ModelBuilder. 18. Click the Build button to create the model. A successful execution of the script will be described as Completed. Click Close (not shown) when done. 35 of 224

36 19. Refresh the MyEnterpise node from the refresh button on the tool bar. The figure below illustrates the model built by the SQL script in Model builder. Summary In this lab we learned how to use the ModelBuilder plugin to automate the process of building our Model against our defined Type Packages using SQL Syntax and queries. We also learned how to dynamically wire attributes in the model to field device tags. For example: 'Pressure','System.Sources.FactoryTalk.localhost.Historians.Production Historian.Tags.[BA:LEVEL.1]' Where Pressure is the property of the defined type and System.Sources is the fully qualified name of the tag. 36 of 224

37 Lab 4: Create a Tag Provider What you will learn How to Create a Tag Provider from data in a SQL Server Background: Data Source: Microsoft SQL Server SQL Syntax 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. NOTES: The query must contain a line which contains the exact string: --<SingleTagQuery> This 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 as a parameter when its query is executed. 37 of 224

38 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 is important because the VantagePoint runtime maps them to an internal value structure based on their location in the resulting data set. 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 38 of 224

39 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} 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 database or other sources 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. 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. 39 of 224

40 This is an expensive SQL operation, but useful in some cases. Insert SingleTagQuery comment as shown below: 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. The following Table is a snapshot of the database table that this lab will be making tag providers against. 40 of 224

41 1. Start on the W2k8-FTVP1 image. 2. Open VantagePoint Manager from the Windows Start menu (Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Manager). 3. Navigate to System > Sources > Db > MsSQL > RAFoods > TagProviders. Note: RAFoods is a SQL connection to a database on W2k8-FTVP1 called RAFoodsProductionData. 4. Right-click on TagProviders and select New > Item. We will create a new instance of a TagProvider on the RAFoods SQL connector. 5. In the New Tag Provider dialog, give the New Tag Provider object a Name called BL2_Float. Select Eastern Time for the Database time zone. 6. Click the New button to create a new Template. Give the dialog a name of BL2_Float_Data. 41 of 224

42 7. We will now write SQL Query in the Queries dialog box for the History query. Delete all the existing comments in the dialog first. NOTE: The Query is also available in the folder Class Files\SectionA\Lab4 called HistoryQuery.txt. Copy the Query in the text file and paste it in the Query dialog area of the Template for History. SQL: --<SingleTagQuery> datetime datetime = '{1}' = '{2}' SELECT Line + '_' + Machine + '_' + TagName as NewTagName, TagValueFloat, DATEADD(ms, TransTimeMS, TransTime) AS TimeValue, Quality = 192 INTO #Temp1 FROM dbo.linedata SELECT NewTagName, as TimeValue, Quality = 192 FROM #Temp1 WHERE NewTagName IN({0}) and TimeValue = (Select Top 1 TimeValue From #Temp1 Where TimeValue AND NewTagName IN({0}) Order by TimeValue DESC) UNION SELECT NewTagName, TagValueFloat, TimeValue, Quality = 192 FROM #Temp1 WHERE NewTagName IN({0}) and TimeValue and TimeValue ORDER BY TimeValue ASC DROP TABLE #Temp1 8. In the date format field specify the date format as yyyy-mm-ddthh:mm:ss.fff. 42 of 224

43 9. Completed the History Query. 43 of 224

44 10. Test the History Query: Click the Test Query button. Add a tag called BL2_ProofOven_TempZone1 in the External Key field. Change the date range to the last few months from now. Click the Execute button. 11. Close the Test Result window. Close the Test History Command Query window when done. 44 of 224

45 12. From the SQL Queries combo box, select Live Command. Write the following SQL statement for the Live command. NOTE: The Query is also available in the folder Class Files\SectionA\Lab4 called LiveQuery.txt. Copy the Query in the text file and paste it in the Query dialog area of the Template for Live. SQL: --<SingleTagQuery> DateTime = GetDate() SELECT Line + '_' + Machine + '_' + TagName as NewTagName, TagValueFloat, DATEADD(ms, TransTimeMS, TransTime) AS TimeValue, Quality = 192 INTO #Temp1 FROM dbo.linedata SELECT NewTagName, TagValueFloat, TimeValue, Quality = 192 FROM #Temp1 WHERE NewTagName IN({0}) and TimeValue = (SELECT TOP 1 TimeValue FROM #Temp1 Where TimeValue AND NewTagName IN({0}) ORDER BY TimeValue DESC) DROP TABLE #Temp1 13. Repeat the previous step for Point-In Time Command, selecting Point-In Time Command from the combo box. NOTE: The Query is also available in the folder Class Files\SectionA\Lab4 called PointInTimeQuery.txt. Copy the Query in the text file and paste it in the Query dialog area of the Template for Point-In Time. SQL: --<SingleTagQuery> DateTime = '{1}' SELECT Line + '_' + Machine + '_' + TagName as NewTagName, TagValueFloat, DATEADD(ms, TransTimeMS, TransTime) AS TimeValue, Quality = 192 INTO #Temp1 FROM dbo.linedata SELECT NewTagName, TagValueFloat, TimeValue, Quality = 192 FROM #Temp1 WHERE NewTagName IN({0}) and TimeValue = (SELECT TOP 1 TimeValue FROM #Temp1 Where TimeValue ORDER BY TimeValue DESC) DROP TABLE #Temp1 14. Click the OK button to complete. This will exit the Template dialog for our tag provider queries. 15. Add a Tag to the Tag Provider collection by clicking the Add button. 45 of 224

46 16. In the Add Tag dialog box: add a new tag in the Name field as BL2_ProofOven_TempZone1 change the Type to Float assign an External key as BL2_ProofOven_TempZone1 select the OK button to add the new tag to the Tag Provider collection External Key: Is the unique identifier to the data being pulled by the TagProvider Type: is the Data Type of the value of the data returned 17. Repeat the previous step for the following tags list below. TagName Type External Key BL2_ProofOven_TempZone2 Float BL2_ProofOven_TempZone3 Float BL2_ProofOven_TempZone4 Float BL2_ProofOven_TempZone2 BL2_ProofOven_TempZone3 BL2_ProofOven_TempZone4 46 of 224

47 18. Click the OK button to complete the Tag Provider for BL2_Float. 19. When completed the TagProvider will contain our tags in the collection of Tags for Provider BL2_Float. 20. Try plotting the Tags using Trend. 47 of 224

48 This page left intentionally blank 48 of 224

49 Lab 5: DbBuilder Plug-in, Dynamically create Tag Providers What you will learn How to Create a Tag Provider using the DbBuilder and dynamically populate all tags against the provider Data Source: Microsoft SQL Server NOTE: Db Builder is available on the knowledgebase at FactoryTalk VantagePoint EMI - Db Builder. Background: Sometimes a user will have data sitting in a transactional database and will want to bring it in as tag data to Incuity Trend, XY Plotter, or Excel Add-In. This is normally accomplished by creating a Tag Provider and the method for doing so is described in the help file. Manually creating tag providers in any numbers can be a considerable 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 re-imported to facilitate reuse. The standard SQL queries required by a tag definition file are: Tag Population query: this query defines all of the individual Tags that will be created by this provider Live query: this query tells each tag how to fetch the most recent data History query: this query tells each tag how to fetch a sorted series of data bounded by a start and end date time Point-In-Time query: this query tells each tag how to fetch data best associated with a particular date time Max Row-Count query (optional): used to limit the number of rows returned by the Live, History and Point-In-Time queries UTC Time query (optional): used to resolve relative time period data requests wrt the server and the local machine Shortcuts to the Db Tags can be created anywhere in the Model. Integrated scheduling is provided to resynchronize the Db Tags. 1. Start on the W2k8-FTVP1 image. 2. Open VantagePoint Manager from the Windows Start menu (Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Manager). 49 of 224

50 3. Browse the Model to System > Sources > DbBuilder. 4. Right-click on DbBuilder and click Create New Source 5. In the Execute Create Instance dialog box, enter in the Name field BL2 Tags. Notice the Cycle Time, this is used to re-synch DbBuilder and allow for creation of additional tags if data and tag information in the underlying data changes. Click the Execute button to create the instance. 6. Once the instance of BL2 Tags has been created, select it and browse the tree by expanding the node beside the item. Right click on the DbLocations and select New > Item. 50 of 224

51 7. The DbLocation Properties dialog requires information fields filled in. For the Name field enter DbRAFoods. Select a Time Zone of Eastern Time from the combo box. For the Database, click the ellipse button and select the RAFoods database connector (located at System > Sources > Db >MsSQL) In the RootPath field enter MyEnterprise.Public.BL2 Food Tags. 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. Click the Finish button to complete. 9. Right-click on BL2 Tags and click the Edit option. 10. Click the Edit Tag Definitions button. 11. Click the Import Definitions button. 12. Browse the directory to on the desktop Class Files\SectionA\Lab5. Select the file called Tags_Queries.xml. Click the Open button. 13. A dialog window asking you to proceed will pop-up, click the Yes button to allow the overwriting of the existing tags definitions. If no dialog box proceed to the next step. 51 of 224

52 14. Click on the first entry in the grid. Notice that all the pertinent fields of TagProvider are available with an additional field called Tag Population Query. The addition of the Tag Population Query field is what makes this tool quite powerful. The Tag Population Query field allows for dynamically creating tag names. 15. Let s add one more tier to the instance of BL2 Tags in the grid. Click the Add button on the Editor of the DbBuilder. 52 of 224

53 16. In the Add New Definition Dialog box enter the Definition Name BL2_StringTags. Click OK to continue. A new row is created in the grid with the previous values in the fields. These fields will need to be updated with the values required for the new Definition 17. Enter the following in the corresponding fields as described in the table below. Click the Save button to save the New entry for BL2_StringTags when completed. Note: The queries are also available in the folder Class Files\SectionA\Lab5 called TagValueStringQueries.txt..Use the queries in the text file by copying and pasting the scripts. Field Description Delimiter Character Date Format Mask Quote Character Path Point-in-time Query Value Tag Provider Template for BL2 String Tags, yyyy-mm-ddthh:mm:ss.fff ' BL2_StringsTags --<SingleTagQuery> DateTime = '{1}' SELECT Line + '_' + Machine + '_' + TagName as NewTagName, TagValueString, DATEADD(ms, TransTimeMS, TransTime) AS TimeValue, Quality = 192 FROM dbo.linedata WHERE Line + '_' + Machine + '_' + TagName IN({0}) And DATEADD(ms, TransTimeMS, TransTime) = (SELECT TOP 1 DATEADD(ms, TransTimeMS, TransTime) FROM dbo.linedata Where DATEADD(ms, TransTimeMS, TransTime) ORDER BY DATEADD(ms, TransTimeMS, TransTime) DESC) 53 of 224

54 Live Query History Query --<SingleTagQuery> DateTime = GetDate() SELECT Line + '_' + Machine + '_' + TagName, TagValueString,DATEADD(ms, TransTimeMS, TransTime) as [DateTime], Quality = 192 FROM dbo.linedata WHERE Line + '_' + Machine + '_' + TagName IN({0}) And DATEADD(ms, TransTimeMS, TransTime) = (SELECT TOP 1 DATEADD(ms, TransTimeMS, TransTime) FROM dbo.linedata Where DATEADD(ms, TransTimeMS, TransTime) AND Line + '_' + Machine + '_' + TagName IN({0}) ORDER BY DATEADD(ms, TransTimeMS, TransTime) DESC) --<SingleTagQuery> datetime datetime = '{1}' = '{2}' SELECT Line + '_' + Machine + '_' + TagName as Tagname, TagValueString as [Value], DATEADD(ms, TransTimeMS, TransTime) AS [DateTime], Quality = 192 FROM LineData WHERE Line + '_' + Machine + '_' + TagName IN({0}) And DATEADD(ms, TransTimeMS, TransTime) = (Select Top 1 DATEADD(ms, TransTimeMS, TransTime) From LineData Where DATEADD(ms, TransTimeMS, TransTime) AND Line + '_' + Machine + '_' + TagName IN({0}) Order by DATEADD(ms, TransTimeMS, TransTime)DESC) UNION Max Row-count Query Tag Population Query SELECT Line + '_' + Machine + '_' + TagName as TagName, TagValueString as [Value], DATEADD(ms, TransTimeMS, TransTime) AS [DateTime], Quality = 192 FROM LineData WHERE Line + '_' + Machine + '_' + TagName IN({0}) And DATEADD(ms, TransTimeMS, TransTime) And DATEADD(ms, TransTimeMS, ORDER BY DATEADD(ms, TransTimeMS, TransTime) ASC SET ROWCOUNT {0} Select Distinct Line+'_' + Machine + '_' +Tagname as TagName, Line+'_' + Machine + '_' +Tagname as Description, Line+'_' + Machine + '_' +Tagname as externalkey, 'String' as [Type],0 as [min],400 as [max] From LineData Where TagValueString is not null And Line = 'BL2' 54 of 224

55 18. Let s build the tags, close the DbBuilder Editor window by clicking on the Open button. 19. Next, Click the Synchronize button to build the tags. Click the Finish button when completed. 20. Review the newly created tags. Browse to MyEnterprise > Public > BL2 Food Tags. There will be two sub folders in the BL2 Food Tags folder: BL2_FloatTags and BL2_StringTags. You may need to select the Refresh icon for the tags to show up. 21. Open Trend and try the newly created tags in Trend. 55 of 224

56 This page left intentionally blank 56 of 224

57 Section B: Excel Reporting 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 doesn t 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 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 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 57 of 224

58 portions of their Model design, intricate reports developed with 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. 58 of 224

59 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 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 2008, by Business Objects, 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 Office 2007 if the Server is not also running 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. 59 of 224

60 Menu Items Opening the Add-In menu Open the Add-In menu by clicking on the Add-In tab in the Excel ribbon. Insert Function This is the easiest way to add functions to the current workbook. It is not the only way, however. You can also use the toolbar button, manually enter a function into the formula bar, or use Excel's generic built-in function wizard. Convert Function to Values 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. Update Function Removes the function from the cells, inserts it into a single cell to determine the size of the results, and then re-inserts it into the correct size range. Applies to VantagePointTagDetails and VantagePointLive. Note: data is obtained only once during this process. Convert Sheet to Values Converts the entire sheet to values. All functions are converted (Excel + VantagePoint) Update Sheet Updates the values to every VantagePoint function contained on the active sheet. Update Workbooks Update the values to every VantagePoint function contained in all open workbooks. Open Report Definition Opens a published report. Publish Publishes the current book to the Model via the Publish Wizard. Browse to Published Reports Opens a web browser at the published reports location 60 of 224

61 Help Opens a web browser at the help page About Displays the common About dialog. VantagePoint Functions In Excel 2007, select Add-Ins on the Ribbon Bar. Selecting VantagePoint > Insert Function will result in the following dialog box: 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. 61 of 224

62 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 VantagePoint Report Creates a hyperlink to an existing VantagePoint report. 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; end users can generate these reports and by simply changing the parameters of the report, 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) 62 of 224

63 Lab 1: Excel Report and Publishing Report Objective: Build a History report that queries two tags from the Extruder type over a time period with its data represented in a chart. Publish the completed Report to the VantagePoint Portal. The report must be a template report that can be used against any piece of equipment of the same type defined by the model. What you will learn Build a report from Scratch How to Create an Excel Template Report History Function Call How to Publish an Excel Report Data source: Extruder Type Note: For your reference this lab has been pre-built by the instructor and is located in the folder Class Files\ SectionB\Lab1\ExtruderHydraulicPressurevsStrokeLength.xlsx. 1. Start on W2k8-FTVP1 image. 2. Start Microsoft Excel from the Start menu (Start > All Programs > Microsoft Office). 3. From the Excel menu bar select VantagePoint. 4. Select Insert from the ribbon bar. This step will now launch the VantagePoint Function Selection dialog wizard which will walk us through the steps to query history for our machine. 63 of 224

64 5. In the VantagePoint Function Selection dialog, select History. Check the check box labeled Use advanced Type Mapping features. Checking this box tells VantagePoint that you will be selecting a Type within the model to create your report against. In the Output location box, select the button beside the text field and point it to Sheet1 cell C6. Click Next to proceed to the next step. 64 of 224

65 6. The Type Selection view is presented. VantagePoint wants to know of what object in the model that you want to reference contains a Tag. Select the radio button option for Items that contain Core.Tags. Upon selecting this option a view of MyEnterprise is now present for navigation. 65 of 224

66 7. Browse the model to MyEnterprise > Samples v4 >Intermediate > Extruders. Click on Extruder001 so that it is highlighted. We are selecting the instance Extruder001; however what we are really interested in is its type. Take note that the type is called Incuity.ExtruderSample.Extruder. Click Next to continue 8. The Item Selection view is now presented. VantagePoint s reporting wizard is basically saying that it has found another instance of the Type Incuity.ExtruderSample.Extruder; would you like to select it also? Because we will be building a report that reports against all instances of the type Incuity.ExtruderSample.Extruder, leave the current selection to one and click the Next button to continue. 66 of 224

67 9. The Type Mapping Explanation view is now presented. This is a view summarizing your selection of the type being used in your report. Click Next to continue forward. 10. The Type Mapping view is now presented. The view is displaying all the properties of the selected type instance that contains properties with tags pointing to field devices. Select the property Hydraulic Pressure and Stroke Length. Click Next to move forward. 67 of 224

68 11. The Parameter Creation view is now presented. 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 Incuity.ExtruderSample.Extruder. Change the Name to just Extruder as opposed to Extruders. This would give an indication to the user that they can only select one Extruder. Note, that the constraints on the parameter, with a max range of one parameter for the type at a time are selectable. The Range containing Mapped Items fields indicate where in the report the fields of the type will be located. This is field if referenced at the end of the Wizard will contain the tags being used by the report itself. Click Next to move forward. 68 of 224

69 12. The Time Selection view is now presented. There are several options on this view that can be selected. Option 1 would be to select a Relative time period, for example last hour, last day, last month etc. Option 2 would be to select an Absolute range, such as January to January :30 PM. Option 3 would be to 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 would be to use a Range. The range selection allows the use of the type Core.TimePeriod. For example if your model contained an instance of a type Shift that implements Core.TimePeriod, the start and end of a shift type can be used by the report. Select Use this Range radio button. Click the New Button. 69 of 224

70 13. On the Type Selection dialog, browse to MyEnterprise > Samples v4 > Support > Report Library > Time Periods and select Last 1 hour. Click Next to continue. 14. On the Item Selection dialog click Next to continue. 70 of 224

71 15. The next dialog Parameter Creation is selected. Change the name in the field Name to DateTime. When the parameter is displayed on the VantagePoint Portal, DateTime is the name of the parameter which will be exposed to the user. Check the box Make this an External parameter when published. Click Next to continue. 16. Click Next on the dialog Time Selection. 17. The Data Options view is now presented. Select Data format as Narrow. Click Next to move forward. 18. The Function Options view is presented. Click Finish to complete the Wizard steps for the History request. 19. Note that the data returned to the Excel spreadsheet is displayed in a Narrow format. 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. Let s edit the query and change the output of the data format to be Wide. Select the Edit button on the ribbon bar. 20. Click Next until the dialog box for Data Options is displayed. 21. Change the Data Format to Wide. 22. Click Next until the dialog box for Function Options is displayed. 71 of 224

72 23. In the Function Options dialog, Select DateTime and Tagnames in the Columns to display box. Click the Finish button to complete. 24. The Excel document will contain data from the history request. Select Range D7 to E40 so that it is highlighted. Note: If data is displayed in an incorrect format such as date/time instead of an integer value in the columns, do the following steps. Select the column with the incorrect format and right click on the column, select Format Cells and change the Category to number. 25. Next we ll create a chart and publish our report to the VantagePoint Portal. From the Microsoft Excel main menu, select Insert and in the Charts group select Line. Select the Line Chart. 72 of 224

73 26. The completed report is as follows: 27. Publish the report to be viewed within the VantagePoint Portal. From the Excel menu bar select VantagePoint. Select Publish from the ribbon bar. The dialog Report Type lists the types of published reports that can be selected. Click Next. 73 of 224

74 28. The next dialog summarizes the Types in the report that will be used as a parameter s to the report from the Portal. Select Next. 29. The Next dialog requires a location to the store the report within the UPM (Unified Production Model). Select the folder labeled Public. Click Next to continue. Note: At this point of storing the report in the model the report name itself may be changed if required. 74 of 224

75 30. The final dialog summarizes the completion of the report that will be published. Click Finish to post the report to the VantagePoint Portal and view. 31. View of Published Report in the VantagePoint Portal. Notice that the report can accept an Extruder as a Parameter. By selecting the drop down combo box select a new Extruder type and click the Generate Report button. 32. Go back to the Excel report and save the report to the following path C:\_Student\Advanced\SectionB\Lab1. Call it ExtruderHydraulicPressurevsStrokeLength.xlsx. Summary In this lab we learned how to create an Excel Template report and how to edit it. The data returned uses Wide History against a Type called Incuity.ExtruderSample.Extruder. We also learned how to publish the data to the VantagePoint Portal and change parameters to the report. 75 of 224

76 This page left blank intentionally 76 of 224

77 Lab 2: Support Absolute and Relative TimePeriod Report Objective: Enhance the previous lab report by adding support for multiple time period types. This will allow the report to be driven by a time period type of either Relative and/or an absolute period from the VantagePoint Portal. We ll also use an Excel technique of populating a chart with data that is dynamically changing and republish the report to the VantagePoint Portal. What you will learn How to create a report to support a time period selection as a parameter How to create a report to support dynamic data ranges for a chart. Note: If you did not complete Lab 1. The completed Lab 1 can be located in the folder Class Files\Section B\Lab1\ExtruderHydraulicPressurevsStrokeLength.xlsx. Open the report from Lab1 and publish it to the VantagePoint Portal. See Lab 1 on how to republish the report. 1. Start on W2k8-FTVP1. 2. Open Microsoft Excel. 3. From the Excel menu bar select VantagePoint. 4. Select Open. 5. Browse the tree to MyEnterprise > Public. Select the report ExtruderHydraulicPressurevsStrokeLength. Click Open. Note: VantagePoint can be treated as a repository for reports. Where master copies can reside within VantagePoint s UPM and reports that have not been commissioned can be extracted later and worked on. In this scenario we extracted our report from Lab1 to continue developing it. 6. When the report opens, delete the Chart that is on Sheet1. 7. Select Cell H6 on Sheet1. Enter the following formula. This formula will calculate how many records are in the Column E and add five rows from the start of the data. =COUNTA(E:E)+5 77 of 224

78 8. Select Cell H8 and type Series_xAxis. 9. Select Cell H9 and type the following formula: ="'Sheet1'!$c$7:$c$"&$H$6 Note: double quote followed by a single quote, Sheet1, single quote, exclamation. C7 is the starting cell of the returned data and C concatenated with H6 is the ending cell. The result of this formula is a string range reference. 10. In Cell H10 type Series_Pressure. 11. In Cell H11 type the following formula: ="'Sheet1'!$d$7:$d$"&$H$6 12. In Cell H12 type Series_Stroke. 13. In Cell H13 type the following formula: ="'Sheet1'!$e$7:$e$"&$H$6 After creating the dynamic string formula for the cell reference, do a save-as and save the workbook to C:\_Student\Advanced\SectionB\Lab From the Excel Menu bar select Formulas > Name Manager. 15. Select New. 16. Give the New Object the name Pressure. 17. In the refers to field type, =indirect(sheet1!$h$11). Click OK. 78 of 224

79 18. Repeat step 15, 16 and 17; for Series_Stroke call it Stroke and for Series_xAxis call it xaxis. 19. At this point the Name manager within Excel will contain three definitions with indirect references to Series_xAxis, Series_Pressure and Series_Stroke. Test to ensure that the data range will stretch to fit the scope of data it s referencing. From the Name Manger, select xaxis and click the Excel button. This will dynamically wrap around the range of data for the xaxis defined. 79 of 224

80 20. Change to Sheet Insert a Line Chart from the Excel menu bar. Stretch the chart object to fit from A1 to M Right click on the Chart object and select, Select Data. 23. In the Legend Entries (Series) click the Add button. 24. For the name of the series create a new one called Pressure. For the series values enter: =ExtruderHydraulicPressurevsStrokeLength.xlsx!Pressure Note: The series value requires the Fully Qualified Name of the WorkBook with the definition to the actual referenced values. 25. Repeat for Stroke. For the series values enter: =ExtruderHydraulicPressurevsStrokeLength.xlsx!Stroke 26. Now we ll add datetime on the X Axis. Select the Edit button under Horizontal (Category) Axis Labels. 27. Enter =ExtruderHydraulicPressurevsStrokeLength.xlsx!xAxis for the Axis Label range. 80 of 224

81 28. Click OK to complete the Data Source selection dialog. 29. Notice that the Chart is plotted as a single line and point on the X Axis. Select the X Axis and right click select Format Axis. Select Axis Option > Axis Type > Text Axis. Click Close to continue. The chart should now be display date/time correctly across the x axis. 81 of 224

82 30. At this point we ve told Excel how to handle the data returned from the VantagePoint History call and plotted the data in a dynamically changing chart based on the amount of data returned. 31. Save the Document and Publish the report to MyEnterprise > Public. Choose the option to browse the Report after it has been published. Click Yes to overwrite the existing file. 32. Click the option to Use This Relative Value, select Last 20 Minutes. Click the Generate Button to refresh the report with the new parameter values. Notice in the drop down list box that there are only Relative Time period options available. This was the case because when we selected Last 1 Hour we selected a timeperiod type defined as Core.Timeperiod.Relative. 33. The following steps we will modify the Type in the report so that the report itself can support the selection of an Absolute Time Range and a Relative Time Range. Go back to the Excel document. 34. Right-click on the Sheet1. Select UNHIDE. Select IncuityInfo and click OK. 35. Select the Cell with the value Core.TimePeriod.Relative. Change the value to Core.TimePeriod. Note: Because we have specified Core.TimePeriod we are allowing use of all children types too.. This would include Core.TimePeriod.Relative and Core.TimePeriod.Absolute. 36. Right click on IncuityInfo and Hide it. Repeat for all Worksheets except Sheet2 containing our chart. 37. From the VantagePoint Menu, republish the report to the Portal. Remember to overwrite the existing Report and select Browse to the Report when the Report has completed. 82 of 224

83 38. From the Portal s Parameter tab, select the radio button Use this TimePeriod Value. Notice that there is now an entry for Absolute in the drop down list box. Select the Absolute range and enter a range for today before this lab started. Because we made this report a Template to an Extruder type, it is also possible to change the Extruder instance and run the report against a new Extruder. Summary This lesson we focused on some additional techniques within the Excel environment such as knowing how to chart a dynamic range of data into an Excel Chart. We also played with the VantagePoint type Core.TimePeriod. Understanding of this type is fundamental in the designs of many reports when Date/Time parameters are required to be passed by a user. We also learned that it is quite possible to render the reports of interest and hide all our raw data worksheets when a report is commissioned and published to the VantagePoint Portal. 83 of 224

84 This page left intentionally blank 84 of 224

85 Lab 3: Linking Reports and Post Processing In this lab we will study how to drill through to other reports and pass parameters from one report to another. This lab will link to ExtruderHydraulicPressurevsStrokeLength.xlsx that was completed in Lab2. We will pass to the report a Date/Time and an Extruder instance. We will also look at some of the advanced options with the VantagePoint Wizard and functions such as SQL Post Processing and Aggregation. What you will learn How to Link to other reports How to use advanced options within the Portal. Note: If you did not complete Lab 2. The completed Lab 2 can be located on the desktop in the folder Class Files\SectionB\Lab2\ExtruderHydraulicPressurevsStrokeLength.xlsx. Open the report from Lab2 folder and publish it to the VantagePoint Portal, ensure the report is in the MyEnterprise > Public location. See Lab 1 step 22 to 26 on how to republish the report. 1. Start on W2k8-FTVP1 image. 2. Start Microsoft Excel from the Start menu (Start > All Programs > Microsoft Office). 3. From the Excel menu bar select VantagePoint. 4. Select Insert from the ribbon bar. This step will now launch the VantagePoint function wizard which will walk us through the steps to query history for our machine. 5. In the VantagePoint Function Selection dialog, select History. Check the box for Use Advanced Mapping Features. Change the Output location to 'Sheet1'!$C$6. Click Next to continue. 85 of 224

86 6. The Type Selection view is presented. VantagePoint wants to know of what object in the model that you want to reference contains a Tag. Select the radio button option for Items that contain Core.Tags. Upon selecting this option a view of MyEnterprise is now present for navigation. 86 of 224

87 7. Browse the model to MyEnterprise > Samples v4 >Intermediate > Extruders. Click on Extruder001 so that it is highlighted. We are selecting the instance Extruder001; however what we are really interested in is its type. Take note that the type is called Incuity.ExtruderSample.Extruder. Click Next to continue 8. The Item Selection view is now presented. VantagePoint s reporting wizard is basically saying that it has found another instance of the Type Incuity.ExtruderSample.Extruder; would you like to select it also? Because we will be building a report that reports against all instances of the type Incuity.ExtruderSample.Extruder, leave the current selection to one and click the Next button to continue. 87 of 224

88 9. The Type Mapping Explanation view is now presented. This is a view summarizing your selection of the type being used in your report. Click Next to continue forward. 10. The Type Mapping view is now presented. The view is displaying all the properties of the selected type instance that contains properties with tags pointing to field devices. Select the property Batch Number and move it to the selected tag list. Click Next to continue. 88 of 224

89 11. The Parameter Creation view is now presented. 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 Incuity.ExtruderSample.Extruder. Change the Name to just Extruder as opposed to Extruders. This would give an indication to the user that they can only select one Extruder. Note, that the constraints on the parameter, with a max range of one parameter for the type at a time are selectable. The Range containing Mapped Items fields indicate where in the report the fields of the type will be located. This is field if referenced at the end of the Wizard will contain the tags being used by the report itself. Click Next to move forward. 89 of 224

90 12. The Time Selection view is now presented. There are several options on this view that can be selected. Option 1 would be to select a Relative time period, for example last hour, last day, last month etc. Option 2 would be to select an Absolute range, such as January to January :30 PM. Option 3 would be to 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 would be to use a Range. The range selection allows the use of the type Core.TimePeriod. For example if your model contained an instance of a type Shift that implements Core.TimePeriod, the start and end of a shift type can be used by the report. Select Use this Range radio button. Click the New Button. 90 of 224

91 13. On the Type Selection dialog, browse to MyEnterprise > Samples v4 > Support > Report Library > Time Periods and select Last 1 hour. Click Next to continue. 14. On the Item Selection dialog click Next to continue. 91 of 224

92 15. The next dialog Parameter Creation is selected. Change the name in the field Name to DateTime. When the parameter is displayed on the VantagePoint Portal, DateTime is the name of the parameter which will be exposed to the user. Check the box Make this an External parameter when published. Click Next to continue. 16. Click Next on the dialog Time Selection. 17. On the Data Options dialog, select the Data Format as Narrow. Uncheck Skip Advanced Options located in the bottom right of the dialog. Click Next to move forward. 92 of 224

93 18. In the Sampling Options dialog check the box, Apply Aggregation Sampling. 19. Slide the vertical bar down and select Sample and Hold. Note all the different sampling conventions that can be applied to the history data for the tag. On the right side of the dialog, in Sampling Method, select the radio button Use a variable number of samples. Change the interval to sample every 1 minute, from the beginning of the time period. Click Next to continue. 93 of 224

94 20. On the SQL Post Processing dialog, check the box to apply SQL Post Processing. This technique will allow us to apply advanced SQL Algorithms at the server to manipulate our data before being sent to the VantagePoint report. From the Query template drop down list box, select Time In State Query. in the list. Click the Test button to view its result. Click Next to continue. 21. In the Functions Options dialog, click the Finish button to complete the Wizard definition of our history Query. Note: Essentially at this point we have returned data from our Batch Number Property of the Extruder type. Using the SQL Post Processing Query Time in State we are able to return the Start of the Batch and the End of the Batch (End being Start of the Previous Batch) and the Batch Number for that Period; also included in the result set is the duration of the actual batch. 22. In Sheet1, Cell C1 type Selected Extruder. 23. In Sheet1, Cell C2 type =Extruder. 24. In Sheet1, Cell I6 type Drill to Hydraulic vs. Stroke details For Batch. 94 of 224

95 25. From the Excel menu bar select VantagePoint. Select Insert. In the VantagePoint Function Selection dialog, select Link to Report. In the Output location box, select Sheet1, cell I7. Click Next to move forward. 26. From the Configure Hyperlink dialog, select the Target report from the list of reports, ExtruderHydraulicPressurevsStrokeLength. Change the Name of Text to display to Drill To Details. Click Next to proceed. 27. The Function Options dialog view is now selected. In this dialog we will need to pass two parameters to our drill through report, DateTime and Extruder. 28. Click the Modify button next to Extruder. 95 of 224

96 29. Select the radio button Select cells containing one Item. Click the button next to the text box labeled Cells containing one Item. Point it to C2 on Sheet1 and click the OK button to accept. This is the fully qualified name of the Extruder instance we ll pass to the drill through report. Click OK to accept the value for Extruder. 30. Click the Modify Button next to DateTime. Click the radio button Select cells containing one time period definition. On the Start Time Cell field select the Excel reference button and point it to Sheet1, C7. This is the first instance of a Start date/time for our Batch number in our history table. Select OK. Repeat the previous step for End Time pointing its cell reference to Sheet1, D7. Click OK to accept. 96 of 224

97 31. Once the Parameters have been all defined, click the OK button and then the Finish button to complete the hyperlink Definition. 32. Sheet1, I7 now has a HyperLink in the cell with the following formula: =IncuityHyperlink("MyEnterprise.Public.ExtruderHydraulicPressurevsStrokeLength","","Drill to Details","&Extruder=%27Sheet1%27!%24C%242&DateTime=period2&start2="&Sheet1!C7&"&end2= "&Sheet1!D7&"",,PortalRoot). 33. Click the HyperLink. Once the report is opened; in the VantagePoint Portal review that the correct information was passed to the report. Close the Internet Explorer Window when finished. 34. We need to do a few things to complete our drill through report. First, we need to ensure that our Extruder selected and passed to our Child report is fixed to the correct cell. Second we will want to carry our formula through to the entire array of data being displayed. And, we will also want to display the date/time columns in a format that our users can understand. 35. Select Sheet1, I Press the F2 key. This will put the Excel Array formula into an Edit mode. 37. Find the following: &Extruder=%27Sheet1%27!%24C%242 Change to &Extruder="& Sheet1!$C$2 & or &Extruder="& $C$2 & This will ensure that the cell reference to Sheet1!$C$2 is fixed and will not change as we copy our expression through the application. To complete the change to the Array formula, press Ctrl+Shift+Enter. This keystroke combination is required to refresh an Excel Array formula. 38. We ll also want to handle errors in our array size for our HyperLink. The following is an example of how to do this. Change the current formula to: =if(c7=,,incuityhyperlink("myenterprise.public.extruderhydraulicpressurevsstrokelength","","drill to Details","&Extruder="&Sheet1!$C$2&"&DateTime=period2&start2="&Sheet1!C7&"&end2="&She et1!d7&"",,portalroot)). The formula will now read if C7 equals nothing, then nothing, else execute the formula IncuityHyperLink. Enter to accept the formula change. 97 of 224

98 39. Select Sheet1, I7. Place your cursor in the Bottom Right of the cell, and drag the cursor down to row Select column C and D. Right click on column C and select Format. Change the Format of the cells to Custom and type: m/dd/yyyy h:mm:ss. Click OK to accept the changed format. 41. Hide all work sheets accept Sheet1. Right click on the worksheet name and select HIDE. 98 of 224

99 42. Publish the report to VantagePoint as Batch Report. From the Excel menu bar select VantagePoint and the Publish icon on the ribbon bar. Publish the report to MyEnterprise > Public. Check the box to Browse to the report after it has been published. 43. Once the report has been published, Change the Extruder to Extruder 2 and generate the report. Summary This lab introduced us to several techniques in Reporting within VantagePoint. We learned how to configure a Report for drill through. The key being that the drill through (Child) report must exist first and have been published to the VantagePoint Portal. We also learned some key concepts related to large amounts of data. These concepts include aggregating the data such as Averaging, Summing, and Counting and in the case of the lab Sample and Hold. Also changing sampling intervals and finally applying SQL Post Processing, letting the data server do all the work to manipulate the data. We also learned some Excel related techniques such as when changing an Excel Array formula, F2 to edit the formula and ctrl+shift+enter to refresh the changed formula. Another key concept described is how to handle data when rows are growing and changing to make a more professional looking report; by hiding cells within an IF statement if no data is found in a particular cell as an example. 99 of 224

100 This page left intentionally blank 100 of 224

101 Lab 4: Using SQL in VantagePoint Excel Reports In this lab we will study how to use Linked Queries and embed SQL Statements within the Excel environment and have it rendered in the VantagePoint Portal. The SQL queries will execute against the RAFoods Database on W2K8-FTVP1. We will also create a time period object within this lab and use the instance in the report to enable a date / time selection parameter from the Portal. The first part of the lab we ll create a Linked Query Item and then embed a SQL statement within the report. What you will learn How to Use Linked Queries How to Use SQL embedded in your Excel Report. How to Use GetItemProperties query 1. Start on the W2k8-FTVP1 image. 2. Open VantagePoint Manager from the Windows Start menu (Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Manager). 3. Right click on the folder Public, select New > Item. 4. Browse the type system objects by clicking the + on core.object. Select Core.TimePeriod > Core.TimePeriod.Absolute. Click the Create button to create a new absolute time period object in the Public folder. 101 of 224

102 5. Call the new time period object TechEdClass. 6. Set the Start to today s date an hour ago. Set the End to today s date and time to the current time. Click the Create button to create the object. 7. Open Microsoft Excel. Place cursor on Cell D5 and type TimePeriod in the cell. Place cursor on Cell D6. 8. From the Excel menu bar select VantagePoint and click the Insert button on the ribbon bar. In the VantagePoint Function Selection dialog, select Get Item Properties. Click Next to continue. 9. Browse MyEnterprise > Public and select TechEdClass time period object. Click Next to continue. 10. On the Item Selection dialog, click Next to continue. 11. On the Parameter Creation dialog, change the name to DateTime. Check the box Make this an external parameter when published. Click Next to continue. 12. In the Properties to display field, select Item Name, Name, FullyQualified Name, Start and End properties. Click the Finish button to continue. 13. Select Cell D12, type reformatted Start. Select D13 type reformatted End. 14. In Cell E12 type the following formula. Where, E9 is the Start date value from the GetItemProperty query. The formatted date string is in a canonical date format. This is an ISO standard for date format. =TEXT(E9,"yyyy-MM-dd HH:mm:ss") Note: This is good practice if developing reports outside of North America as this convention as a canonical date format will adhere to in all countries. 102 of 224

103 15. Drag cell E12 to E13 for the reformatted End cell reference. 16. Select Cell D16, type Machine Instance into the cell. 17. Select Cell D From Excel menu bar select VantagePoint and Insert button from the ribbon bar. In the VantagePoint Function Selection dialog, select Get Item Properties. Click Next. 19. In the Range Selection dialog, under the section Create a new range using: click the New button. 103 of 224

104 20. Browse the model to MyEnterprise > RSTechED > Sites > Orlando > Areas > Baking > Lines > BL1 > WorkCells > Mixer. Click Next to continue. 21. On the Item Selection dialog, click Next to continue. 22. On the Parameter Creation dialog, change the name to WorkCell. Check the box Make this an external parameter when published. Click Next to continue. 23. In the Properties to display field check all the Properties. Click the Finish button to continue. Note: Currently in our Excel Work Book, we have two objects from the model. One of Core.TimePeriod.Absolute, so we can drive our report by changing an absolute time range and the other item type is a WorkCell. The reason for the instance of the WorkCell item in the Workbook is so we can drive our report by selecting different Work Cells from our model. We use an instance of the Work Cell in the report is so we can build our report at design time. 104 of 224

105 24. The Fully Qualified Name of the Mixer from the Model contains the Line that the Mixer belongs to. We will now split the Line out of the string. Select Cell H5 and type Find Line. Select H6 and type the following formula: =FIND("Lines.",E19,1) Select H7, type the following formula: =RIGHT(E19,LEN(E19)-H6-5) Select H8, type the following formula: =LEFT(H7,3) 25. Select Sheet2 in the Excel workbook. This is where we ll summarize all our parameter needed by the SQL query. Select A1 and type: Start. Enter formula =Sheet1!E12 in cell B1. Select A2 and type: End. Enter formula =Sheet1!E13 in cell B2. Select A3 and type: Line. Enter formula =Sheet1!H8 in cell B3. Select A4 and type: Machine. Enter formula =Sheet1!E18 in cell B4. Select B6 and type: Linked Query Result. 26. Create the Linked Query. Open VantagePoint Manager. 27. Browse to System > Sources > Db > MsSql > RAFoods > Queries. Right click on Queries and select New > Item. 28. In the New Query dialog give the object the name of Lab4_SQL. 29. Browse to Class Files > MI15 AdvancedLab > SectionB > Lab4 > LinkQuery.txt. Open the file LinkQuery.txt and copy its content. LinkQuery --<SingleTagQuery> --LinkedQuery SQL Report. datetime DateTime nvarchar(100) nvarchar (100) = '{0}' = '{1}' = '{2}' = '{3}' Select top 100 Line, Machine, TagName, TagValueString,TagValueFloat as [Value], dateadd(ms,transtimems,transtime) as [DateTime] From LineData Where dateadd(ms,transtimems,transtime) And dateadd(ms,transtimems,transtime) And Line And Machine Order by dateadd(ms,transtimems,transtime) desc 105 of 224

106 30. In the Query field, paste the query copied from the text file LinkQuery.txt. Click OK to complete the configuration. 31. Go back to the Excel WorkBook. We will now reference the LinkQuery object we just created and pass in the parameters to drive the query. Select Sheet 2, cell B In the Excel menu bar select VantagePoint and the Insert button from the ribbon bar. In the VantagePoint Function Selection dialog, select Database Query. Select the radio button Use query stored in the model. Click Next to continue. 106 of 224

107 33. The dialog Item Selection requires an instance of the Link Query Item type. Browse to System > Sources > Db > MsSql > RAFoods > Queries. In the list of Queries select Lab4_SQL and move it to the right in the list of selected items. Click Next to continue. 107 of 224

108 34. From the Insert Query dialog box, at the From Cells: select the ellipse button to browse the Excel worksheet for the parameters. 35. Select the range B1 to B4, and click OK. Click the Test Query button to ensure that the data queried gets returned correctly. Click the Next button to continue. 108 of 224

109 36. Click the Finish button to exit the Linked Query wizard. Select Column G and format the column as a date/time. Use a custom format of yyyy-mm-dd HH:mm:ss. 37. Hide all worksheets except Sheet2. Right click on the worksheets to be hidden and select Hide. 38. Publish the report to VantagePoint In the Excel menu bar select VantagePoint and the Publish button from the ribbon bar. Ensure that the report is a type with Parameters to publish. Make sure that the DateTime and WorkCell parameters are checked as external parameters. 109 of 224

110 39. Publish the Work Book to MyEnterprise > Public. Call the Work book Lab4_LinkedQueries. Check the box to Browse to the report after it has been published. 40. Browse to the report after publishing it. 41. Go back to the Opened Work Book for this lab. We ll now embed a query in the workbook. 42. Select Sheet2; cell J1 and type: ="Select Distinct Machine From LineData" 43. In cell J2 type: ="Where Line='"& B3 & "'" Note: After the equal sign the character is a single quote then double quote. 44. In cell J6 type: Embedded query results. 45. Select cell J7. We will use this cell to return the results from our embedded query. 46. In the Excel menu bar select VantagePoint the Insert button from the ribbon bar. 110 of 224

111 47. From the Function Dialog select Database Query. Select the radio button option for Use Query embedded in the workbook. Click Next to continue. 48. The Item Selection dialog is asking for an instance of a Db connector, select RAFoods and move it to the selected items list. Click Next to continue. 111 of 224

112 49. In the Insert Query dialog, select the Store in Cell: ellipse button and browse the Excel workbook to Sheet2 and select J1 and J2 and then OK. Click Next to continue. Click Finish to complete the operation. 50. Publish the workbook to the Portal in MyEnterprise > Public overwriting the existing Lab4_LinkedQueries report and browse to the report after it has finished publishing. 112 of 224

113 51. Change the parameters in the Portal environment and re-generate the report. Completed Report: Summary Lab 4 built on the ability for VantagePoint to execute SQL queries from the Model using Linked Query objects or by embedding the query itself in an Excel workbook. This lab also used an additional VantagePoint function, GetItemProperties. The GetItemProperties function allowed us to get properties of an object such as the Start and End date/time for a TimePeriod object and return its current value to be used by Linked and/or embedded SQL queries. Publishing of the report allowed us to drive the report with an external parameter of date/time from a calendar control and by selecting the appropriate cells within the Excel workbook. Using Excel techniques of parsing strings, we were able to use the fully qualified name of a Workcell in our model to obtain a reference to the Line that the Workcell belonged to as a parameter to our SQL query. 113 of 224

114 This page left intentionally blank 114 of 224

115 Lab 5: Report Runner Many customers have a requirement for regularly scheduled unattended report generation. The Report Runner plug-in allows users to configure an existing published report and to schedule a report generation on a regular basis. Advanced options are also available if needed. Once installed, the Report Runner allows the individual configuration of any number of published Excel reports that can be run on a once-only or scheduled repeating basis. Run-time parameters can be specified in advance, as can a custom report file naming convention. The reports can be set to print automatically at run time, and they can also be configured to appear automatically in the portal content viewer. In this lab exercise we will configure and automate the rendering of VantagePoint Excel reports using the ReportRunner PlugIn. What you will learn: How to Configure Report Runner How to Schedule Pre-Rendered Reports to the Portal with Hyperlinks. How to Schedule Reports to be created as PDF documents. 1. Start on W2k8-FTVP1. 2. Click Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Manger. 3. Browse to System > Solutions > ReportRunner. 4. Right click ReportSets and select New > Item. 115 of 224

116 5. Set the New Report Set Name field name MyFirstScheduledReport. Click OK. 6. For the Report Set Source select Run Single Report. 7. Click the drop down list box and select the MyEnterprise.Samples v4.advanced.production.reports.extruder Comparison report. 116 of 224

117 8. In the Parameters with Values list, click the + beside Extruder1. Right-click on Extruder001 and select Delete to remove the existing choice. 9. Right click on Extruder1 and select Add... This will pop up a dialog that will let you search for a valid parameter in the Model. Click the button and browse to MyEnterprise > Samples v4 > Intermediate > Extruders > Extruder001. Click OK for the selected Extruder. 10. Click OK to complete the selection. Note: Select a printing option. If you want the report to be printed then check the Print automatically to option and then select a printer from the Print to combo box. This combo box will list all printers available to the Server under the IncuitySystem account. If the report would appear better in landscape mode then check that option too. 117 of 224

118 11. Completed Report Parameters: 12. Select the Additional Settings tab. 13. Set the following parameters: Check the box Overwrite prior report. Insert a Link to the Report URL into the VantagePoint Model. Set the value to MyEnterprise.Public Check the box Make generated report visible in the Portal Model Browser Log the report, uncheck Report Logging Create an Optional PDF output. Uncheck the box Save copy of Report in PDF format 14. Select the Scheduling tab. 118 of 224

119 15. Set the following parameters: Check the box Report processing is enabled. Set the Next Run to three minutes from the current time. Set the repeating time to every 5 minutes. 16. Let s check to see if we have configured the Report Runner correctly. Click the box labeled Validate. Click OK on the Validation check complete. No configuration problem dialog box. 17. Click the Run Now button to execute the Report. Click the Close button when completed. 18. Click the OK button to exit the configuration of Report Runner. 19. Click Yes to save the new report set. 20. From Manager, click on MyEnterprise > Refresh. 21. Select MyEnterprise > Pubic. The report we ran after validation is now visible in the model. 119 of 224

120 22. Open Windows Explorer to C:\inetpub\wwwroot\IncuityPortal\MyEnterprise\Samples v4\advanced\production\reports. Notice that the html report has been created after we ran the report. 23. Click Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Portal. 24. From the Portal menu, select Report > Public. 25. Select the Hyperlink reports located in the MyEnterprise > Public folder. This is the hyperlink to the HTML report created on Report Runner schedule. Completed Report Summary This lab introduced another available VantagePoint Plugin called, Report Runner. Report Runner is a free download from the Rockwell Automation Knowledge Base. With the installation of the Report Runner in the VantagePoint system, administrators can now schedule reports and PDF reports. There are a couple of benefits of pre-rending the reports within the Portal environment, one being performance allowing users to obtain high demand reports such as Daily Production reports. 120 of 224

121 Lab 6: Macros An added functionality of VantagePoint is its ability to support Macro embedded reports. Many customers leverage Excel Macro s in their reports to automate repetitive functionality or do advanced calculations. VantagePoint can support the execution of the Macro s 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. 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 1. Start on W2k8-FTVP1. 2. Open Microsoft Excel. 3. Select the Excel Options button, located under File. 4. From the Excel Options dialog, check the option for Show Developer tab in the Ribbon. 5. From the Excel Options dialog, select the Trust Center option. 6. Click the button labeled Trust Center Settings. 121 of 224

122 7. From the Trust Center dialog, select Macro Settings. Check the Enable all Macros option and Trust access to the VBA project object model options. Click OK to accept the configuration. 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. Note: that you will now see the developer option on the Menu bar. 8. On Sheet1 select Cell C4. This is the start of the cell range where we will return the raw data from the VantagePoint Query. 9. In the Excel menu bar select VantagePoint and the Insert button on the ribbon bar. 10. In the VantagePoint Function Selection dialog, select History. Check the box for Use Advanced Mapping Features. Click Next to continue. 11. Select the option labeled Items that contain Core.tag. 12. Browse MyEnterprise > RSTechED > Sites > Orlando > Areas > Baking > Lines > BL1 and select BL1. Note that the selected type is TechEd.Baking.Line. Click Next to continue. 122 of 224

123 13. Select Next on the Item Selection dialog. 14. Select Next on the Type Mapping Explanation dialog. 15. On the Type Mapping dialog, select GoodProduct and ScrapProduct and add it to the item selection list. Click Next to continue. 16. On the Parameter Creation dialog select the check box to Make this an external parameter when published. Click Next to continue. 17. On the Time Selection dialog select the Last 10 Minutes. Click Next to continue. 18. On the Data Options dialog select Wide Format. Click Finish to exit the Wizard. 19. Format the Columns for GoodProduct and ScrapProduct to be numeric; if returned as another data type. 20. At this point we will add a Macro to the Workbook. First do a SaveAs and title the file as MyFirstMacro and specify the location as C:\_Student\Advanced\SectionB\Lab6. Change the Save as Type to Excel Macro Enabled Workbook (*.xlsm). Click the Save button to save the document. 21. On Sheet 1, select Cell F1. Enter the following formula. This formula will calculate the total data rows returned. =COUNTA(D:D) From the Excel Menu Bar, select the Developer tab. 23. Select Visual Basic. This will open the Visual Basic editor. 24. From the Visual Basic menu bar, select Insert > Module. 123 of 224

124 25. Type the following code. Note that the code can be copied and pasted into the Macro. The code is located on the desktop: Class Files > MI15 AdvancedLab > SectionB > Lab6 > VBAMacroCode.txt. Select the entire code copy and paste it into the blank 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 'Label A1 Sheet2.Range("A1").Value = "Selected Line: " & Right(Sheet5.Range("A1").Value, 3) 'Label F4 Sheet2.Range("F4").Value = "Total Product" 'get the total row count totalrows = Sheet2.Range("F1").Value 'only enter the loop if the data range is greater than zero If totalrows > 0 Then 'loop through rows adding Good + Scrap PRoduct to get a total. For i = 5 To totalrows Sheet2.Range("F" & i).select Sheet2.Range("F" & i).value = Sheet2.Range("D" & i) + Sheet2.Range("E" & i) Next End If Sheet2.Range("F4").Select 'Reformat the columns correctly Sheet2.Range("D1:F" & totalrows).select Selection.NumberFormat = "0.00" 'Hide unused sheets Sheet3.Visible = xlsheethidden Sheet4.Visible = xlsheethidden Sheet5.Visible = xlsheethidden End Sub 26. Save the document. Close the Visual Basic Window. 124 of 224

125 27. From the Excel menu bar select VantagePoint and the Publish icon from the ribbon bar. Publish the report to MyEnterprise > Public folder and browse to the report after it has been published. Change parameters. Summary This lab illustrated how you can take advantage of the power of Excel s macros. The macros in this lab used a formula that determined how many records were returned for a query, looped through the data and summed two columns together. Before the code is finished and the report was rendered to the VantagePoint Portal, worksheets were hidden, data reformatted and titles placed in the document. 125 of 224

126 This page left intentionally blank 126 of 224

127 Lab7: 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. The image below displays the Production KPIs Composite Report as it appears in the Model Browser (MyEnterprise > Samples > Production > Production KPIs). The ParameterTypes and OwnedItems nodes are maintained by the report itself and are not of interest here. The Rows node contains 4 rows, R0, R1, R2 and R3. R0- Row 0 of the report has one Cell, Header. The content within the cell is an HTML document containing an image to be used as the header of the report. 127 of 224

128 R1 - Row 1 of the report has three Cells, Downtime, Process Variability and Throughput, each containing a KPI dashboard. R2 - Row 2 of the report has three Cells, Cell0, Cell1 and Cell2. Each contains a description of the relevant KPI as well as links to supporting reports. R3 Row 3 of the report has one Cell, Footer. The content within the cell is an HTML document containing text and links. 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. 128 of 224

129 Part A Creating a Proof-Oven Composite Report In this lab, the end result will be a composite report as displayed below. There will be three steps in creating this "final" composite report: You will create an "initial" composite report made up of only one row with two cells, the "top row" you see in the below graphic. Each cell will contain a trend report. You will add the report to the VantagePoint Portal View so that it is displayed in the Portal. You will add a second row with one cell to the composite report and identify an existing Excel report as the "contents" for this cell (the "bottom row" in the below graphic). 1. Start on the W2k8-FTVP1 image. 2. Start Manager by going to Start > All Programs > Rockwell Software > FactoryTalk VantagePoint 129 of 224

130 3. Navigate to the Solutions > RAFoods 2012 > Reports folder. Right-click and select New > Item 4. Select the Core.TemplateReport type (at bottom of dialog). Select the Portal.CompositeReportTemplate and click Create. 130 of 224

131 5. In the Name textbox enter ProofOven_Composite (the name of this report). Click Add. 6. In the Name textbox enter ProofOvenParameters. Click the Default Value Items browse icon 7. Expand the MyEnterprise > RAFoods 2012 > Cleveland > Baking > Line 1 > Equipment folder and select the ProofOven workcell. Click OK. Note: This is defining the VantagePoint "Type" that this report will be based on. 131 of 224

132 8. Click OK on the Parameter Editor dialog. 9. Click OK on the Create Composite Report Template dialog. 10. Select the ProofOvenDetail report and click the All Items In Tree icon. Note: This will expand the report in the VantagePoint Manager 11. From the expanded report select Rows. Right-click and select New > Item. Note: We are adding a Row to the report 132 of 224

133 12. In the Name textbox enter TrendRow (this is the name you are giving to this row). In the HeightInPixels textbox enter 800. Click Create 13. Select Cells. Right-click and select New > Item Note: We are going to add a cell to the TrendRow 14. In the Name textbox enter OvenStatus. Click Create. Note: We are adding a cell called OvenStatus to the TrendRow row 133 of 224

134 15. Select Content. Right-click and select New > Item. Note: We are going to add the type of report we want to display in the OvenStatus Cell 16. Select Portal.ViewableTrendContent. Click Create. 134 of 224

135 17. In the Name textbox enter ProofOvenStatus (the name you are giving to this report). In the DisplayName textbox enter ProofOven Status. Click Create. 18. Select ParameterMapping (this will "map" tags or parameters to the trend). Right-click and select New > Item. 135 of 224

136 19. We are going to add tags to this trend In the Name textbox enter ProofOven_BatchID In the TargetParameterName textbox enter param (to define this entry as a "parameter") In the SourceName textbox enter Status.BatchID after the "dot" or "period" 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! Click Create 136 of 224

137 20. Let s add a few more tags to our trend. Select ParameterMapping. Right-click and select New > Item. 21. We are adding a second tag to this trend. In the Name textbox enter ProofOven_Step In the TargetParameterName textbox enter param In the SourceName textbox enter Status.MachineStep after the "dot" Click Create 22. We are going to add a second cell to the TrendRow row. Select Cells. Right-click and select New > Item. 137 of 224

138 23. In the Name textbox enter ProofOvenProcess (the name of your second cell). In the DisplaySequence textbox enter 1 (the first cell is set to DisplaySequence 0 (zero)). Click Create. 24. We are going to add the type of report we want to display in the ProofOvenProcess Cell. Select Content. Right-click and select New > Item 25. Select Portal.ViewableTrendContent. Click Create. 138 of 224

139 26. In the Name textbox enter ProofOvenProcess (the name of this report). In the DisplayName textbox enter ProofOven Process. Click Create. 27. Select ParameterMapping. Right-click and select New > Item 28. We are going to add tags to this trend: In the Name textbox enter Zone1_Temp In the TargetParameterName textbox enter param In the SourceName textbox enter Process.TempZone1 after the "dot" 139 of 224

140 Click Create 29. Select ParameterMapping (we are going to add three more tags or parameters to this trend). Right-click and select New > Item. 30. Do the following steps in this order: In the Name textbox enter Zone2_Temp In the TargetParameterName textbox enter param In the SourceName textbox enter Process.TempZone2 after the "dot" Click Create 31. Select ParameterMapping. Right-click and select New > Item 32. Do the following steps in this order: In the Name textbox enter Zone3_Temp In the TargetParameterName textbox enter param In the SourceName textbox enter Process.TempZone3 after the "dot" Click Create 140 of 224

141 33. Select ParameterMapping. Right-click and select New > Item 34. Do the following steps in this order: In the Name textbox enter Zone4_Temp In the TargetParameterName textbox enter param In the SourceName textbox enter Process.TempZone4 after the "dot" Click Create 35. Review the following steps and diagram for an overview of what you have done so far: In the Lines folder, created a composite report named ProofOvenDetail Added a Row named TrendRow Added one cell named OvenStatus and defined a trend named ProofOvenStatus consisting of two tags, ProofOven_ BatchID and ProofOven_Step Added a second cell named ProofOvenProcess and defined a trend also named ProofOvenProcess consisting of four tags, Zone1_Temp through Zone4_Temp 141 of 224

142 This page left intentionally blank 142 of 224

143 Part B Adding the Proof-Oven Composite report to the VantagePoint Portal View 1. Expand the Solution > RAFoods 2012 tree to Solutions > RA Foods 2012 > Portal Settings > ContentTypes > [_RAFoods.2012.Enterprise.ProofOven] > ViewableContent. Select ViewableContent. Right-click and select New > Item. 2. Select Portal.ViewableReportContent. Click Create. 143 of 224

144 3. Do the following steps in this order: In the Name textbox enter Proof-Oven-Detail In the DisplayName textbox enter Proof-Oven-Detail Click the Report icon 4. Expand the System > Solutions > RAFoods 2012 tree to the Reports. Select the ProofOven_Composite report Click Assign Click Create 5. Open the VantagePoint Portal. From the Reports menu select RA Foods of 224

145 Note: You now have Proof-Oven-Detail report for the ProofOven type everywhere it exists in the model. Because this is a "Template Report", based on a specific Type, the report will appear in the Portal wherever instances of the specific Type are used in the model. 6. Verify you have data for both reports. Note: Each Trend has its own toolbars and you can stack the Y-axis (done on the two trends shown below), turn on X and/or Y-axis cursors, refresh the trends, turn on or off Live Mode, etc. 145 of 224

146 7. Close VantagePoint Portal. 146 of 224

147 Part C - Adding an Excel Report 1. In your ProofOven_Composite report, right-click on TrendRow and select Edit Change HeightInPixels from 800 to 300 and click OK. 3. Right-click on Rows and select New > Item Do the following steps in this order: Enter Name of ExcelRow Specify DisplaySequence of 1 Specify HeightInPixels of 500 and click Create 147 of 224

148 5. Under ExcelRow, right-click on Cells and select New > Item Enter Name of BakingProofOvenStates and click Create 7. Right-click on Content and select New - Item of 224

149 8. Select PortalViewableReportContent and click Create Do the following steps in this order: Enter Name of BakingProofOvenStates Enter DisplayName of ProofOven States Click ellipsis button to the right of Report 149 of 224

150 10. Browse to System > Solutions > RA Foods 2012 > Reports. Select the report ProofOvenStateCurrentShift. Click Assign. Click Create. Note: This report is based on the same "Type" you identified when you first created the composite report at the beginning of this lab 150 of 224

151 11. Now view the Proof_Oven_Detail report in the VantagePoint Portal. A second row has been added containing the pre-existing ProofovenStatesCurrentShift Excel report. When finished, close the Portal. 151 of 224

152 This page left blank intentionally 152 of 224

153 Section C: Dashboards Introduction to Dashboards Dashboard displays can be created with Dashboard Builder, published and displayed in 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. Dashboard Editing Environment 153 of 224

154 Dashboard Example 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. 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 154 of 224

155 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 Dashboard 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. The Source Files.swf - The file used by FlashPlayer 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. 155 of 224

156 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 Macromedia s 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. 156 of 224

157 Special note using Xcelsius on VantagePoint Server computers On computers running VantagePoint Server, VantagePoint runs an instance of Microsoft Excel in the background. When Xcelsuis 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 Xcelsuis, you would need to open Windows Task Manager and kill the instance of Excel that VantagePoint is using. Note that this may impact VantagePoints ability to render reports. It is recommended to run Xcelcius on computers other than the one running the VantagePoint Server. 157 of 224

158 This page left intentionally blank 158 of 224

159 Lab 1: Dashboard In this Lab we ll create a dashboard to report on the RSTechED model. The dashboard being built will include best practices and advice when creating a dashboard. The dashboard will report on Equipment tags from the RSTechED model returning live data and we ll be able to pass any equipment (workcell) type to the Model, therefore creating a template dashboard. What you will learn: How to Configure an Xcelsius dashboard How to build a template dashboard How to Publish an Xcelsius dashboard 1. Start on W2k8-FTVP1. 2. Run Xcelsius.exe from the Desktop. Note: The execution of the Xcelsius application on the TechEd image is NOT common practice. We have fashioned the execution to work on the VantagePoint server which is not supported. Xclesius is meant to run on a client machine. 3. Click Continue on the Xcelsius 2008 Trial dialog. Note: If a Dialog Message is displayed illustrating that the server is busy, WAIT a few seconds and then click the RETRY button to continue. 4. Right click on Sheet1 and rename it: getxmllivedata. Tip: Good Practice to name the worksheets in Both Excel and Xcelsius development environments when creating the reports. 5. Select Cell D5 on Sheet1 in the Excel Spread Sheet. 6. In Cell D5, type: Get Live Data from the RSTECHED Equipment Model. Tip: Good Practice to describe and document the task of the VantagePoint query. If you need to go back later and make changes and reverse engineer any dashboards, documentation will help as to what the query was intended for. 7. Select Cell D6, on Sheet1. 8. From the Excel menu bar select VantagePoint and the Insert button on the ribbon bar. 159 of 224

160 9. In the Dashboard Model Builder dialog select Current Value and check the box for Use advanced type mapping features. 10. Change the Name to xmllivedataworkcell and the Description to gets the data from a workcell. Click Next to continue (button not shown below). Tip: Good Practice to describe and document each VantagePoint query name and descriptions fields. 160 of 224

161 11. On the Type Selection dialog, select Items that contain Core.Tags and the Item view radio button. 12. Browse MyEnterprise > RSTechED > Sites > Orlando > Areas > Baking > Lines > BL1 > WorkCells and select Mixer. Click Next to continue. 13. Click Next on the Item Selection dialog. 14. Click Next on the Type Mapping Explanation dialog. 15. On the Type Mapping dialog, select GoodProduct and ScrapProduct and add it to the item selection list. Click Next to continue. 161 of 224

162 16. On the Parameter Creation dialog, check the box Make this an External Parameter when published. Change the name to WorkCell. Click Next to continue. 17. On the Dashboard Data Options dialog, select the Columns to display as TagName, FullyQualifiedName, Datetime and Value. Slide the bar down and uncheck Engineering Unit. Click Finish. 18. The XML containing the current values for GoodProduct and ScrapProduct is now displayed. Select cell I7 and type reformatted Value. 19. Select I8 and type the following formula: =fixed(value(g8),0) 20. Drag cell I8 to I9. Formula should read: =fixed(value(g9),0) 21. Select Cell J7 and type: Total Product 22. Select J8 and type the following formula: =I8+I9. In K7 type Max Value. In K8 enter the formula =J Select the Components toolbox in Xcelsius. Select Single Value and then browse and select Gauge. Drag the gauge onto the blank canvas. Leave the gauge selected. 24. From the Xcelsius menu, select Edit > Copy. 25. From the Xcelsius menu, select Edit > Paste. 26. Ensure the gauge is selected and drag the gauge to the right on the canvas. 27. From the Xcelsius menu, select Edit > Paste, to paste another gauge to the canvas. 28. Select the first gauge and drag it to the right of the second gauge on the canvas. 29. Select the First gauge. The properties of the gauge are displayed on the right of the canvas. 30. Give Gauge1 the Title Good Product. 162 of 224

163 31. Select the Data by Range radio button for Data and click the Excel reference button. Point the reference cell to sheet getxmlivedata, cell I8. The gauge should now display the Good Product value. Change the Maximum Limit to reference cell K From the Gauge1 Properties tab select the Alert tab. 33. Check the box Enable Alerts. 34. Under Color Order set the option High Values are Good. 35. Repeat the above steps for the properties of Gauge2 and Gauge3. Set the Data to I9, and the title as Scrap Product. Set the color order to Low values are good. Set the Data to J8, and the title as Total Product. Set the color order to High Values are good. And set the Maximum Limit to K Save the Xcelsius project file to your student file location C:\_Student\Advanced\SectionC\Lab1. Call the project Lab1_WorkCellDashboard.xlf. 37. Our dashboard for Live data is nearly complete. 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 we ll import the xml maps in the workbook to Xcelsius, we ll then import the named ranges from the Workbook to Xcelsius, so these named ranges can be exposed as parameters to the flash report. 163 of 224

164 38. From the Xcelsius menu, select Data > Connections. 164 of 224

165 39. In the Data Manage dialog, select Add > Excel XML Maps. 40. Notice that the name of the XML map that Xcelsius found was the custom name we gave our map in the beginning of this lab, getxmllivedata. Select it and ensure you are on the Definition tab. Select the Excel button next to XML Data URL. 165 of 224

166 41. Point the reference to getxmllivedata worksheet, D6. Click OK when done. 42. Select the USAGE tab and check the box, Refresh Every, leave the default of 5 seconds. 166 of 224

167 43. From the Data Manager dialog, select Add > FlashVariables. Change the Name of the Flash Variables to ProductionConnection. 44. Click the Import Named Ranges button. This action will import the named ranges from the Excel Workbook. Click the CLOSE button to complete. 45. At this point we designed our dashboard and defined how VantagePoint will communicate to it. Let s compile the dashboard and publish it to the VantagePoint Portal. 46. From the Xcelsius menu, select File > Export > Flash (swf) Save the file to the Student location C:\_Student\Advanced\SectionC\Lab1. Call the file Lab1_WorkCellDashboard.swf. The swf file extension defines the document to be a flash file. Click the Save button. The act of saving compiles the xlf (Project file) to a Flash document. 48. From the Excel menu bar select VantagePoint and the icon Publish from the ribbon bar. 49. The File Selection dialog is requesting the xlf project file and swf flash document files. These files will get saved to the VantagePoint repository and subsequently can be retrieved from the VantagePoint model if you were to lose the files on the local hard drive. 167 of 224

168 50. Select the ellipse button next to Flash file and browse for the swf flash file located in, C:\_Student\Advanced\SectionC\Lab1\Lab1_WorkCellDashboard.swf Select the ellipse button next to Project file and browse for the xlf project files located in, C:\_Student\Advanced\SectionC\Lab1\Lab1_WorkCellDashboard.xlf. Click Next to continue. 51. The next dialog reminds us that the dashboard has an external parameter expose called WorkCell. Click Next to continue. 52. In the Report Folder Selection dialog, select MyEnterprise > Public. Click Next to continue. 53. Check the Browse to Published dashboard checkbox and click the Finish button. Summary This lab was a simple example of how to build an Xcelsius dashboard from Scratch. We learned a few important techniques when designing and building a dashboard. Name your XML maps, use ranges and document each function throughout your report in the spreadsheet. We also learned the steps required to configure Xcelsius to compile a dashboard that VantagePoint can talk to. 168 of 224

169 Lab 2: Dashboard Cascading Selection In this Lab we ll create a dashboard to report on the RSTechED model. This lab will continue from Lab 1 adding complexities such as the ability to support cascading combo boxes to drive the data being displayed. Note: This lab is challenging and a great lab to learn some more advanced techniques in VantagePoint and dashboards. The concept here is to be able to drive the data in the dashboard without actually driving it from the Parameter selection pane from the Portal. What you will learn: How to Configure an Xcelsius dashboard How to build a template dashboard How to Publish an Xcelsius dashboard How to build a dashboard with cascading combo boxes. How to use the GetItemProperties query in VantagePoint How to split the VantagePoint data retrieval queries and rebuild them with inject references 1. Start on W2k8-FTVP1. 2. Run Xcelsius.exe from the Desktop. 3. Click Continue on the Xcelsius 2008 Trial dialog. 4. Open the Previous Lab 1 project File. If you did not complete Lab 1, the Lab 1 session file can be found in Class Files > MI15 AdvancedLab > SectionC > Lab1 > Lab1_WorkCellDashboard.xlf. 5. From the Xcelsius menu, select File > SaveAs, save the file to C:\_Student\Advanced\SectionC\Lab2 and rename the project to Lab2_WorkCellDashboard.xlf. 6. Insert a New WorkSheet by click the new worksheet icon 7. Rename the WorkSheet to GetLines, by right clicking on the new Worksheet. 8. On the worksheet GetLines, select cell C2 and type, Get the Lines from the Area collection. 169 of 224

170 9. On the worksheet GetLines select cell C From the Excel menu bar select VantagePoint and the button Insert from the ribbon bar. 11. Select Get Item Properties. 12. Change the name of the xml map to xmlgetlines and the description range with xml lines. Click Next to continue. 13. On the Range Selection dialog, click the New button. 14. Browse the Model to MyEnterprise > RSTechED > Sites > Orlando > Areas and select Baking. Click Next to continue. 15. In the Item Selection dialog, click Next to continue. 170 of 224

171 16. In the Parameter Creation dialog, click Next to continue. 17. In the Dashboard Data Options dialog, in the Properties to display area select the following: Name, Fully Qualified Name and Lines. Click Finish. 18. Notice that Cell E7 contains the collection of Lines from the Model. Select cell C In Cell C10 type Line Collection. 20. Select cell C11, type the following formula: =E7&"," 21. Select cell C12, type Find the comma in the string. 22. Select cell D12, type FQN of Line. 23. Select cell C13, type the following formula: =FIND(",",$C$11,1) 24. Select cell D13, type the following formula: =MID($C$11,1,C13-1) 25. Select cell C13 and D13 and drag the cells down one row. 26. Select cell C14 and change the formula to the following: =FIND(",",$C$11,C13+1) 27. Select cell D14 and change the formula to the following: =MID($C$11,C13+1,C14-C13-1) 28. We should now have our two lines split out of the collection. Note: If you wanted to handle more than just the two lines you would have pull the formula down from C14 and D14 to the max possible combination from your particular model. 29. From the Xcelsius Components Toolbox, select the category Selectors and chose the Combo box. Drop the combo box to the top of the canvas and stretch it out as wide as the display of Gauges. 30. On the getlines worksheet, select Cell C16 and type the following: User selected Line. 31. Select cell C17 and highlight the Cell with an Orange background. 171 of 224

172 32. Select the Combo box from the canvas. Give the combo the title Line Selection. 33. In the Labels field, select the Excel button and select Cells D13 to D In the Data Insertion field, select the Insertion Type as Label. 172 of 224

173 35. Select the Excel button in the Destination field, select Cell C Select the Behavior tab of combo box On the Selected Item field, select Item as Label of 224

174 38. Right click on the Combo Box and select Bring to Front. 39. At this point we have defined our list of available Lines from the Area collection. We ll next need to handle errors if the user selected Line is empty; as the case now in design time. On the Excel worksheet getlines, select Cell C18 and type Selected Line. 40. Enter the following formula in Cell C19. =IF(C17="",D13,C17) 41. Select the Name Box and Type the following: userselectedline. Ensure cell C19 is selected. Hit the enter key to accept the name. 42. On the getlines worksheet, select cell C22. Type the following: Collection Of Workcells 43. Select cell C From the Excel menu bar select VantagePoint and the Insert button from the ribbon bar. We will now get the collection of WorkCells in the line. Select GetItemProperties. Change the Name to xmlgetworkcells with the Description of Collection of WorkCells. Click Next to continue. 45. On the Range Dialog menu, select the New button. 46. Select MyEnterprise > RSTechED > Sites > Orlando > Areas > Baking > Lines select BL1. Click Next to continue. 47. Click Next in the Item Selection dialog. 48. Click Next in the Parameter Creation dialog. 49. On the Dashboard Data Options dialog, in the Properties to display area select the following: Name, Fully Qualified Name and WorkCells. Click Finish. 50. Select the formula bar for Cell C23. We will be changing the original VantagePoint formula. Edit the following formula from: /Incuity to ="/Incuity. 174 of 224

175 51. After propertynamescopes= in the formula delete: MyEnterprise.RSTechED.Sites.Orlando.Areas.Baking.Lines.BL1 Enter the following formula: &userselectedline& 52. Go to the end of the formula by right cursoring in the formula bar. Terminate the formula with a double quote at the end. Hit the Enter key to accept the changes. At this point we ve changed the query dynamically based on the selection by the user in the Line selection combo box. 53. Select another combo box from the components toolbox in Xcelsius menu. Drop the combo box below the Line Selection box. Call the Combo Box Selection of Work Cells. 54. Select WorkSheet getlines and select Cell C30. Type the following: Collection of WorkCells 55. Type the following formula in Cell C31: =E27&"," 56. Type the following in C32: Find the comma in the string 57. Type the following formula in C33: =FIND(",",$C$31,1) 58. Select D32, type: FQN of WorkCell 59. Select D33 and type the following formula: =MID($C$31,1,C33-1) 60. Select C33 and D33, drag it down one row. Copying the formula one row down. 61. Edit the formula in C34 to: =FIND(",",$C$31,C33+1) 62. Edit the formula in cell D34 to: =MID($C$31,C33+1,C34-C33-1) 63. Select Cells C34 and D34 and drag it down one row, copying the formula down. 64. Place a new Combo box on the canvas for WorkCells. Point the Labels reference to cells D33 to D35. Give it the title Work Cells. 65. Change the Insertion type to Label. 175 of 224

176 66. Select the Excel reference button for Destination and point it to Cell E2 on WorkSheet getxmllivedata. 67. Select the Behaviour button for Combo Box 2 and change the item to Label Go to worksheet, getxmllivedata and select cell E3. Enter the following formula: =IF(E2="",D33,E2) 69. Keep Cell E3 selected on worksheet getxmllivedata and name the cell userselectedworkcell in the name box. 70. Now, we ll edit the VantagePoint query for LiveData and inject the selected WorkCell into the query. Select Cell D6 on the worksheet getxmllivedata. We will be changing the original VantagePoint formula. Edit the following formula from: /Incuity to ="/Incuity. 71. After ItemNameScopes= in the formula delete: MyEnterprise.RSTechED.Sites.Orlando.Areas.Baking.Lines.BL1.WorkCells.Mixer Enter the following formula: &userselectedworkcell& 72. Cursor with the right cursor key to the end of the formula and add a double quote. 73. The final step is to tell Xcelsius about the new queries and import the new parameters to the dashboard. From the menu select Data > Connection. Click Add > Excel XML Maps. 74. Change the order of the XML maps to the following: 176 of 224

177 75. Select ProductionConnection. Click the button Import Named Ranges. 76. Select xmlgetlines_map. Click the Excel Reference button and point it to WorkSheet getlines and Cell C Select the Usage tab and check Refresh before components are loaded. 78. Select xmlgetworkcells_map. Click the Excel Reference button and point it to getlines!$c$ of 224

178 79. Select the Usage tab and make the following changes. 80. Click the Close button to finish the Data connections configuration. 81. Save the project. 82. Select File > Export > Flash (swf...). 83. Save the flash file as Lab2_WorkCellDashboard.swf. 84. We ll now learn another approach of publishing the dashboard where we use the Dashboard object from VantagePoint. 85. Open VantagePoint Manager by Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Manager. 86. Select MyEnterprise > Public. Right-click on the Public folder and select New > Item. 87. Select Core.Template.Report type. Select Flash.DashboardTemplate and click the Create button. 178 of 224

179 88. Give the New item the name Lab2_Dashboard. 89. Select the folder button for FlashDocument and browse to C:\ _Student\Advanced\SectionC\Lab2 and select the file Lab2_WorkCellDashboard.swf. Select the folder for XcelsiusProject and select the file Lab2_WorkCellDashboard.xlf. 90. Click the Create button for the New Flash object to complete the publishing of the Dashboard to the model. 91. Open VantagePoint Portal select Reports > Public. Click the Lab2_Dashboard and try the dashboard with the cascading combo boxes. 179 of 224

180 Summary This lab was a more complex than that of Lab 1. We learned a few important techniques when designing and building a dashboard. Name your XML maps, use ranges and document each function throughout your report in the spreadsheet. We also learned the steps required to configure Xcelsius to compile a dashboard that VantagePoint can talk to. We also learned how to manually manipulate the VantagePoint XML query. In this lab we also learned of a technique whereby users may want to generate the dashboard from the VantagePoint Portal, but once the dashboard is displayed want to drive the parameters of the dashboard from with-in the dashboard without leaving the screen. 180 of 224

181 Section D: Fun Snippets 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 tag s Value) are determined by the underlying datasource. 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. Add values for Incuity Tags using one of the following techniques: via the Tag Manual Data Entry page in the Portal via the Manual Data Entry dialog in the Model Browser Creating a VantagePoint Tag When the system is installed, a default VantagePoint connector is Created. You add VantagePoint tags to this connector using the New > Item context menu-item: 181 of 224

182 Select the type of Tag Item required: Creating Discrete Tags Name: Name of the tag. Description: Description of the tag. Source: Not required since this is a user defined tag. TrueMessage: Display when value of tag is True, e.g. "On", "True", "Running" FalseMessage: Display when value of tag is False, e.g. "Off", "False", "Stopped" 182 of 224

183 Creating Float or Integer Tags Name: Name of the tag. Description: Description of the tag. Min: Minimum value for the tag. Max: Maximum value for the tag. Engineering unit: Not required but may be inserted. The ellipse button to the right of the field opens a scrolling list of System Engineering Unit from which a selection can be made. 183 of 224

184 Creating String Tags Name: Name of the tag. Description: Description of the tag. Source: Not required since this is a user defined tag. MaxLength: Maximum length of the stored String tag in characters. Creating Time Tags Name: Name of the tag. Description: Description of the tag. Source: Not required since this is a user defined tag. 184 of 224

185 Calculated Tags Calculated tags are tags whose value is the result of evaluating an expression. The expression can include references to other tags, plus 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/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. In the trend above, there are three simulation tags and one calculated tag. At the top is a sine wave. Next is a ramp, followed by a square wave, and finally, the calculated tag. The expression for the calculated tag is: If(value(squarewave) = true, value(ramp), value(sine)) which evaluates to: If the square wave tag s value is true, then get the value form the ramp tag, else get the value from the sine wave tag. You can see this expression represented by the traces in the trend chart. 185 of 224

186 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. 186 of 224

187 Lab 1: Creating an Incuity Tag The following lab illustrates some techniques using Incuity Tags and Manual Data Entry from the VantagePoint Portal. What you will learn: How to Configure an Incuity Tag How to Use an Incuity Tag for Manual Data Entry 1. Start on W2k8-FTVP1 2. Run Manager from Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Manager. 3. Select System > Sources > Incuity. Right click on Tags and select New > Item. 4. Select Connector.Tags.FloatTags and click the Create button. Note: Tags such as String, Discrete, Float, Integer, and Time tags can be Created in VantagePoint. 5. In the name field, type MyFloatTag. Click Create to create the new float tag as a new data source. 6. In the Tags collection of Incuity Tags, select MyFloatTag and then select the tab Properties. Click the Edit button. 7. Enter a Value of Open the VantagePoint Portal. 187 of 224

188 9. 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. From the Portal menu, select Tools > Tag Data Manual Entry. 10. Select the combo box for Select Tag FQN and browse to the tag System.Sources.Incuity.Tags.MyFloatTag. 11. Select the Now button to capture the current date/time into the Text box field Enter Timestamp. 12. Enter the value in the Value field. Note: The Value entered in Manual data entry can be stamped with a Quality of Good, Bad or Uncertain. 13. Click the Save the button to save the value to the VantagePoint storage system. 14. Repeat the above steps to enter a few more values. 188 of 224

189 15. Browse to System > Services > Storage > Local > Handlers > Default > Tags > MyFloatTag. Notice that the tag MyFloatTag has been automatically added to the VantagePoint Storage engine and its value will be stored. 16. Open the VantagePoint Trend tool. 17. Browse System > Sources > Incuity > Tags and select MyFloatTag and drop it onto the Trend Tool. 18. Example of Manual data on a trend plot. 189 of 224

190 Summary In this lab we learned how to create an Incuity tag and apply it to an application of Manual Data Entry. We also learned that the Incuity tag is stored by the VantagePoint Storage engine within the VantagePoint model. 190 of 224

191 Lab 2: Manual Data Entry Type In this lab we ll create an instance of the type Portal.ManualDataEntry. This type accepts a collection of tags that can be used for manual data entry simultaneously. What you will learn: How to Configure a Portal.ManualEntry type. How to use the new type with-in the Portal for manual entry. 1. Start on W2k8-FTVP1. 2. Open VantagePoint Manager. 3. Select System > Sources > Incuity. Right click on Tags and select New > Item. Select Connector.Tags.FloatTag and click Create. 4. In the name field type, BL_Line_1_ManualScrap and click the create button. 5. Repeat the previous step creating the following tags: BL_Line_2_ManualScrap BL_Line_3_ManualScrap 191 of 224

192 6. Select MyEnterprise > Public and right click selecting New > Item. 7. Browse the types to Portal.ManualDataEntry.Click Create. 192 of 224

193 8. Give the new object the name Production Scrap. Click the Create button. 9. Browse System > Sources > Incuity > Tags. Select the three new Incuity tags, BL_Line_1_ManualScrap, BL_Line_2_ManualScrap and BL_Line_3_ManualScrap. 10. Right Click on the Highlighted tags and select Copy. 193 of 224

194 11. Browse to MyEnterprise > Public > Production Scrap > Tags. Right Click on Tags and select Paste Shortcuts. 12. Open the VantagePoint Portal. Select Reports > Public. 13. Select Product Scrap. Enter some values, date/times for each of tags and click Save. Repeat for additional some values. 194 of 224

195 14. Open VantagePoint Trend and plot the tags from the Production Scrap collection. Click the icon from the toolbar to stack the traces. Summary In this lab we learned how to create Incuity tags and apply it to a collection object contained by the Type Portal.ManualEntry. Once the type was created we copied and pasted a shortcut of the tags to the collection object tags of the new instance of the type Portal.ManualEntry. VantagePoint understands this type and will automatically present a manual data entry form when the instance is selected from the Portal. We also learned that we can configure the type to handle 1 to x tags and simultaneously enter data for multiple tags. 195 of 224

196 The page left intentionally blank 196 of 224

197 Lab 3: Creating a Calculation Tag In this lab we ll create two examples of a Calculation tag, one doing simple mathematics and another other using functionality of built in Math expression to be used as a lookup value to an integer source. What you will learn: How to Configure a Calculation Tag How to use expressions 1. Start on W2k8-FTVP1. 2. Open VantagePoint Manager. 3. Select MyEnterprise > Public and right-click on Public > New Item. 4. In the Type List scroll to select Core.Tag. 5. From the Core.Tag tree, select Connector.Incuity.Calculation.Tag > Connector.Incuity.Calculation.FloatTag. Click Create. 197 of 224

198 6. On the New Float Calculated Tag dialog box give it the tag the name MyFirstCalc. 7. Select the Edit Expression button. 8. In the Expression Editor dialog, put the cursor in the Enter a Tag Expression text box. 9. Select Item Value button. 10. Browse the model to System > Sources > FactoryTalk > localhost > Historians > Production Historian > Tags > SINUSOID. Click OK. 198 of 224

199 11. The expression in the box will now read: Value("System.Sources.FactoryTalk.localhost.Historians.Production Historian.Tags.SINUSOID"). Multiply the value by 2. Enter the following expression: Value("System.Sources.FactoryTalk.localhost.Historians.Production Historian.Tags.SINUSOID") * 2 Click OK. 12. Click Create to exit the Calculation expression box and create our new tag. 199 of 224

200 13. Create one more Calculated tag in MyEnterprise > Public and select the tag type as String. 14. Call the string tag MyDownTimeReasonCodes. 15. Click the Edit Expression button. 16. Put the cursor in the Enter a Tag Expression text box. 17. Click the Function button. 18. From the Library combo box select ListHelpers > MapValue. Click OK. 200 of 224

201 19. In the expression box highlight Value. Select the Item Value button. 20. Browse to System > Sources > Simulator > Line 1 > Tags > Downtime and select Downtime. Click OK. 21. Highlight Default Value and type: Unknown 22. Highlight Values and 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 23. The completed formula. 24. Click OK and the Create button to create the New tag. 201 of 224

202 25. Open VantagePoint Trend. 26. Browse to MyEnterprise > Public. 25. Drag and Drop MyFirstCalc and MyDownTimeReasonCodes onto the Trend application. Also drag and drop onto the Trend System > Sources > Simulator > Line 1 > Tags and select tag Downtime. Summary In this lab we learned how to do a simple Calculation between a tag and a variable, how to use the Calculation expression and advanced library functions in the Calculation Tag engine. 202 of 224

203 Section E: Status Item Overview 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 ProgramEngine provides users with the ability to create ProgramTags, Tasks and TypeHandlers. All of which were used in the Sample Content. Specific details of this functionality can be found in the various Sample Content Descriptions below. 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. 203 of 224

204 This page left blank intentionally 204 of 224

205 Lab 1: Simple Status Item Reporting In this lab we ll create a few calculated tags that monitor field devices and return a discrete value of On/Off (True/False). We ll then create a StatusItem collection with some StatusItems instances to monitor the calculated tags and use the Portal for reporting the Status of our indicators. What you will learn: How to Configure a StatusItem type. How to create complex calculated tags. How to Use the Portal to a dashboard to report on Status of objects in the StatusItem collection. 1. Start on W2k8-FTVP1. 2. Launch Manager from Start > All Programs > Rockwell Software > FactoryTalk VantagePoint. 3. Browse to MyEnterprise > Public. 4. Right click on Public and select New > Item. 5. We ll now create a few calculated tags as discrete tags. Browse the types to Core.Tag. Select the cross-hairs to expand the node, Connector.Incuity.Calculation.Tag. Select Connector.Incuity.Calculation.DiscreteTag. Click Create. 6. Give the new Discrete Calculated tag the following name: TankLevel > of 224

206 7. Click the Edit Expression button. 8. Click the Item Value button. 9. Browse the Insert Item Value dialog to System > Sources > FactoryTalk > LocalHost > Historians > Production Historian and select the Tags node to view all tags in the collection. 10. Browse and select the tag BA:Level.1. Click OK. 11. Enter the following formula around the selected tag. Click Ok to complete. if (Value("System.Sources.FactoryTalk.localhost.Historians.Production Historian.Tags.[BA:LEVEL.1]") > 20, True, False) 12. Click the Create button to create the new discrete calculated tag. 206 of 224

207 13. Repeat the above steps for the following calculated tags. Make all the calculated tags discrete tags. Tag: Temperature > 3 and < 20 Formula: if(value("system.sources.factorytalk.localhost.historians.production Historian.Tags.[BA:TEMP.1]") > 3 and Value("System.Sources.FactoryTalk.localhost.Historians.Production Historian.Tags.[BA:TEMP.1]") < 20, True, False) Tag: Light Naphtha End Point > 100 Formula: if (Value("System.Sources.FactoryTalk.localhost.Historians.Production Historian.Tags.CDEP158") > 100, True, False) 14. Create a new StatusItem Collection to monitor the Status of the discrete tags created. Right click on Public and select New > Item. 207 of 224

208 15. Browse the type library to Base.Common.StatusItemCollection Click Create. 16. Call the new StatusCollection object Process Overview and the same for the display name. Click Create. 208 of 224

209 17. Select the StatusItems node. 18. Right click on StatusItems and select New > Item. 19. Select Base.Common.StatusItem, click the Create button. 209 of 224

210 20. Give the New StatusItem the following name and display name: Light Naphtha End Point >100. Click the ellipse button on StatusIndicator and point it to the tag Light Naphtha End Point > 100 located in the Public folder. Click the Assign button to wire the tag to the StatusIndicator field. Click Create to create the new StatusItem object. 21. Repeat the above steps for the remaining tags to be monitored. Tag: Tank Level > 20 Tag: Temperature > 3 and < Launch the VantagePoint Portal. 23. Select Reports > Public. 210 of 224

211 24. Click on Process Overview to view the Status Item dashboard. Summary: In this lab we learned several new techniques such as creating complex mathematical formulas that can be used against tags from the model. Subsequently we then linked the status of the tags to the StatusItem type class to present a dashboard of the calculations. This functionality gives the users a quick view into how a particular process is behaving and required no reporting skills to setup. 211 of 224

212 This page left blank intentionally 212 of 224

213 Lab 2: StatusItem with Custom Type Package In this lab we ll study a predefined model illustrating the ability to inherit the StatusItem class into your own custom types. We ll also use the import function to load the model into the VantagePoint system. We ll view the StatusItem Report from the Portal and add a new StatusItem object to the existing model. What you will learn: How to Configure a StatusItemCollection into a custom type How to Import a Model. 1. Start on W2k8-FTVP1. 2. From Start > All Programs > Rockwell Software > FactoryTalk VantagePoint launch the VantagePoint Type Builder application. 3. Select File > Open. Browse to Class Files folder on the desktop, Section E Lab 2 to select the file MyCompany.itp. 213 of 224

214 4. Let s study what has been done to this Type package called MyCompany. Select the type Area. Note that in the required packages field, the Base.Common.Package has been imported into the MyCompany type package as a required package. The imported type Base.Common.Package contains the type called Base.Common.StatusItemCollection. We need this type to be implemented in the Area type so we add it to the Implement field of our type package. Once the Type has been implemented it shows up as a Property in the Area type, just as Lines and OEE are also properties of Area. This Step is repeated for both Line and Machine types. Select each type to understand how the implement uses the type of StatusItemCollection in each instance defined. 5. We will now import a predefined model into the VantagePoint UPM (Unified Production Model). 6. Start VantagePoint Manger from Start > All Programs > Rockwell Software > FactoryTalk VantagePoint > Manager. 7. Select File > Import. 214 of 224

215 8. Select the ellipse button and browse to the Class Files folder on the desktop, Section E Lab Select the File ProductionModel_Lab2.icp. Click the Open button. 10. On the Import dialog, click the Next button to continue. 215 of 224

216 11. On the Imports Dialog for Import Options, leave the Items Conflicts default as Keep the default option as specified in the package. Click the Next button to continue. 12. Once the import has completed successfully click the Finish button to close the dialog. 13. From Manager, browse to MyEnterprise > Public. 216 of 224

217 14. Break the tree structure down by clicking on the cross-hairs to expand the nodes. This small example of a model consists of an Area called Production with two lines. Under each of the lines are a collection of machines. Line2 in particular has three machines. 15. Open VantagePoint Portal. Click on Report > Public. 217 of 224

218 16. Click the node called Production. An indicator located to the left of Production will give an insight as to the states of Line1 and Line2. Green as Good and Red as bad. The StatusItems allows us to view the tree structure of the model in a flattened view that we can quickly deduce the state of our Lines in a dashboard. 17. Click on Line1 or Line2 to drill into the Line collection and view the states of our machines. In the example below we can see Line1 has a bad state and the cause being the Packaging machine has a failure. Because the StatusItems implement the ContentTypes rules, the report called OEE Last 1 Hour automatically wires to each of the machines in the Line. Note that the Trend Icon can also launch the VantagePoint Trend passing the StatusItem tag to the Trend tool. Click on the Report and the Trend tool to view each report type. 18. In the following step we will add one more machine to the StatusItem view called Mixer on Line of 224

219 19. Browse to MyEnterprise > Public > Production > Lines > Line1 > Machines. Right click on Machines and select New > Item. 219 of 224

220 20. Give the new item the name Mixer. Select the ellipse button next to StatusIndicator. Browse the model to System > Sources > FactoryTalk > Historians > Production Historian > Tags. Turn the Filter on by clicking the funnel icon. In the filter box type Active. Select the tag for BL1 Mixer MachineActive. Click the Assign button to wire the tag to the StatusIndicator field. The StatusIndicator is the Property that was implemented when we implemented the type StatusItemCollection. 220 of 224

221 21. Repeat the above step for the remaining tags. The tags are located in the following node: FactoryTalkMetrics > Connectors> FTMConnector> PlantModel> RA_Foods> Cleveland> Baking> BreadLine1 > BL1_Mixer. Select the tags for Availability, OEE, Quality and Performance (Throughput). Click the Create button to complete the Mixer. 221 of 224

222 22. The following is the completed Mixer for Line1. Right click on the Mixer and select Copy. 23. We need to add the Mixer of Line1 to the StatusItem Collection. Browse to MyEnterprise > Public > Production > StatusItems > Line1 > StatusItems. Break the tree down on StatusItems. 222 of 224

223 24. Right click on StatusItems. And select Paste Shortcut. 25. The Mixer has now been added to the collection of StatusItems. 26. Open the VantagePoint Portal to Reports > Public. View the State of the new mixer added to Line of 224