Professional Documents
Culture Documents
TRDO.100045.03.004 - VP.3 Training Labs
TRDO.100045.03.004 - VP.3 Training Labs
Training Manual
VP.3 – Design and Deploy
December 2009
TRDO.100045.03.004 - VP.3 Training Labs
Table of Contents
SECTION 1 SECURITY .......................................................................................................................................... 5
Security is one of the most important issues considered in the design of the VantagePoint System.
VantagePoint has moved away from traditional program development, where software is installed and
run on a local disk, to an environment that allows for zero-touch deployment of software across an
intranet. VantagePoint allows access to diverse data sources – including sensitive plant equipment. For
these reasons, tight security is a non-negotiable feature.
VantagePoint is developed and deployed using the .NET Framework which provides developers with two
levels of security management. First, and most evident to users, is Role Based Security. This
implementation of security is similar to the security employed by many operating systems. Users are
assigned to Groups, or Roles, and Roles carry specific access rights. VantagePoint has five pre-configured
roles, or User Profiles.
Perhaps more importantly, however, the .NET Framework also provides security on code itself. This is
referred to as code access or evidence-based security. With code access security, a user may be trusted
to access a resource, but if the code the user executes is not trusted, then access to the resource will be
denied. This security, based not only on Roles but also on code, is a fundamental facility to permit
security on web based applications such as VantagePoint.
The .NET Framework security system functions on top of traditional operating system security. Both
layers complement each other. Users in VantagePoint are authenticated by their Windows log-on
process. When a user accesses VantagePoint programs, their Windows log-on name is handed over to
VantagePoint where a further authentication and identification of the user will occur, and the Role of
the user will be established.
VantagePoint roles and users are generally maintained through VantagePoint Manager, although a
VantagePoint Administrator can manage users from any application through the model browser by
navigating the System folder.
The following lab will walk you through the common practice of hiding objects within the Model
Browser from specific User Roles.
You are an administrator on your local PC and have the permissions to create local user
accounts.
You have VantagePoint installed on your local PC.
Your VantagePoint server is a member of your company’s Active Directory and so are all users on your
network. You are also aware that all Domain User accounts are automatically mapped to the
VantagePoint Role called Everyone. Therefore, if you were able to restrict the Everyone user role from
accessing the folder, you will have met your Manager’s requirements.
In order to test your approach you will first need to create a local user account that will by default be
mapped to the Everyone User Role.
NOTE The steps for creating user accounts are slightly different on various Microsoft operating
systems. The following example is based on the Window 2003 operating system.
1. Make sure you are on the VM-FTVPSVR virtual machine (VM) image. To check the name of the
virtual image you are currently on, minimize all open windows and you should see the
virtual image name in the background image used for the desktop.
2. Right-click on the My Computer icon in your desktop and select Manage.
3. Expand the folder Local Users and Groups and then select the folder Users.
5. Uncheck User must change password at next logon. Enter TestUser for the User name. Enter a
password and again a second time to confirm. Click Create then Close.
8. Note that by default the Everyone role has read permissions on this folder. This is indicated by a
check mark in the Read column.
9. Let us first verify that the user we created above has access to the Reports folder. Open Internet
Explorer by right-clicking on Internet Explorer in the Quick Launch menu and selecting Run
as.
12. If you are prompted for credentials, check the Remember my password checkbox and enter
credentials for the user again. Click OK.
13. If the Microsoft Phishing Filter dialog pops up, select the Ask me later option and click OK.
14. If the Information Bar dialog pops up, check the Don’t show this message again checkbox and
click Close.
15. Once in the Portal, click Reports then MyEnterprise. Our test user can currently view the
MyEnterprise.Samples.Extruders folder.
16. Return to VantagePoint Manager. The Security tab for the Reports folder should still be visible.
Uncheck the option for Inherit security settings. For the Everyone role, uncheck the Read
permissions box and click Save.
17. Return to Internet Explorer and click the Refresh button. After the page reloads, notice that the
Samples.Report folder is no longer visible in the model view.
18. To make the folder visible again, we will now return to VantagePoint Manager.
19. In the Security tab, check the box for Inherit Security Settings then click Save.
20. Verify that the folder is visible again.
The VantagePoint Server allows for user access through the licensing scheme of named users and
concurrent users. A named user is typically one that requires dedicated access to the VantagePoint
system, that is, this user that must always have access. A concurrent user is typically one that does not
require dedicated access to the VantagePoint system, that is, this user can afford to wait for a
concurrent license to free up if one is not available immediately.
In this lab, you will learn how to add a named user in the VantagePoint server. That is, you will assign a
specific user to consume one of the named user licenses. You will also see how a license, both named
and concurrent, is consumed in VantagePoint. Some notes before we begin.
1. The trial VantagePoint license used in the VM allows for 3 named users and 3 concurrent users.
We will verify this.
2. For a user logging in from a client (VM-FTSOURCES) to be recognized on the VantagePoint server
(VM-FTVPSVR) we need the user to exist on both machines with the same password.
The table below lists the steps in the scenario we will try to walk through. NU is short for Named User
and CU is short for Concurrent User. Read the text immediately below the table for an explanation of
the steps.
First, we will see how many named and concurrent user licenses are currently being used. We will find
that 1 out of the 3 named user licenses is in use; the 1 user in the Named User List is VM-
FTVPSVR/Administrator. This leaves us with 2 unused named user licenses. Also, none of the
concurrent user licenses are being used currently.
We will add ManagerAA to the Named User List. There is still 1 named user license left which is not in
use. When a random, let’s say lower-priority, user OperatorA logs in and accesses a report, this user
automatically uses up this unused named user license. Now, all 3 named user licenses are in use.
Later, other lower-priority users, OperatorB, OperatorC, and OperatorD, log in and use up all of the
available concurrent user licenses. OperatorE, when he/she tries to log in, is denied access because
now there are no named or concurrent user licenses available.
When ManagerBB (say a higher-priority user who must have access), tries to log in, he/she is also not
allowed access because the named and concurrent user license count limits of 3 have each been
reached.
The random user OperatorA is removed from the Named User List by a VantagePoint administrator and
ManagerBB is assigned a license. Now, ManagerBB has access.
View the Named User Limit and the Named User List
1. Make sure you are on the VM-FTVPSVR image.
2. Launch VantagePoint Manager.
3. Click on the System.License node and view its properties (select the Properties tab) to view the
named user limit. It is 3 in this case. Also note that the concurrent user limit is 3.
4. Click on the System.License.NamedUsers node. The list below shows all the users currently in
the Named Users List. Currently, only the local administrator, who you logged in as from the
client VM-FTSOURCES in earlier labs, is consuming a named user license.
6. Click Create.
7. Similarly, create the following users. Note we have already created the user in the first row –
ManagerAA.
Username Password
8. Now switch to the VM-FTVPSVR image and create the same user accounts as shown in the
previous step.
4. For the user name, type in ManagerAA. Click the Check Name button. The dialog should
resemble the following.
5. Click OK. We have now added a user to the Named User List in VantagePoint.
4. Internet Explorer will now launch using the ManagerAA credentials. If an Internet Explorer
dialog appears, uncheck Continue to prompt when Web site content is blocked and click Close.
5. If another Internet Explorer dialog appears, check In the future, do not show this message and
click OK.
7. If prompted, enter the ManagerAA credentials again, check Remember my password and click
OK.
8. If the Microsoft Phishing Filter dialog appears, select Ask me later and click OK.
11. Click Add to add the VantagePoint Server URL to the Local Intranet list.
16. In the Portal navigation menu at the top, click on Reports > MyEnterprise.
17. In the tree, click on MyEnterprise.Samples.Extruders.Reports.Extruder - Compare Efficiency to
view the report.
18. The report generates. This shows that ManagerAA has access.
11. Note the access details for this user in the Properties pane on the right.
10. You will get a dialog stating that another named user could not be added because the maximum
named user license count would be exceeded. Click OK.
11. We will now delete OperatorA from the Named User List.
12. First, close VantagePoint Manager.
13. In the Run dialog (Start > Run), perform an IISRESET by typing in iisreset and clicking OK.
NOTES
There are still a number of data points within your facility that require manual data entry or the
integration of data existing within text files, such as:
In this scenario, there is a requirement for operators to log comments on equipment performance
hourly as well as to import data collected from an offline sampling system. You need to provide users
with an easy method to enter the data and utilize it in reports. These requirements can be met with
Incuity Tags.
Incuity Tags are VantagePoint-specific tags that can be used to store logs, comments, etc. These tags
can be consumed like any other tag in VantagePoint clients like Trend and the Excel Add-In with which
reports can be created.
5. Click Save.
3. Select the Bulk tab and copy in the data from the CSV file provided by your Instructor.
Calculated tags are tags whose value is the result of evaluating an expression. The expression can
include references to other tags, as well as constants and functions in shared libraries. In this lab you will
create a calculated tag to evaluate an expression.
3. Right-click the Calculated Tags folder and select New > Item.
4. In the Types tab at the bottom of the dialog, select the Core.Tag shortcut. Then, at the top,
expand Core.Tag. Expand Connector.Incuity.Calculation.Tag. Select the discrete tag item
Connector.Incuity.Calculation.DIscreteTag and click Create.
5. In the next dialog, enter PumpIsRunning for the Name and Tracks when extruder pump is
running for the Description
11. The Expression Editor should resemble the following image. Click OK.
13. Click Close in the Test Results dialog, then click OK in the Expression Editor dialog.
14. Select the Properties tab. This is where you can enter a display value for the results of your
expression. Enter the following text for the TRUE and FALSE messages then click Create
17. Turn on discrete shading. You can do this by selecting an area in the trend then right-clicking
and selecting Properties > Trace. In the Properties dialog, check Enable shading checkbox
and click OK. Your trend should look similar to the following image.
An expression template gives us the ability to refer to item names that are relative to a calculation tag
so that we may reuse that expression in multiple calculation tags. This means that you could have
hundreds of calculation tags using the same expression, and manage the expression in one place. If you
change the expression in an expression template, any tags that reference the expression template are
updated with the new expression the next time they are accessed after the template is updated.
In this lab, you will learn how to create an expression template to be used with multiple calculation tags.
7. Configure the instance as shown in the image below. Note that the tags are from the
ExtruderData1 simulator.
8. Create another instance in the same location but this time use tags from the ExtruderData2
simulator.
NOTE Relative referencing is a technique used to reference properties of an item by employing syntax
that resolves fully qualified names by traversing up the model tree structure
18. You are now returned to the Expression Editor. Type a slash following the value that was just
inserted then click Item Value.
19. Select the Speed property, check the relative name option and click OK.
NOTES
VantagePoint has several installed simulators. You have the ability to create new simulators should you
choose to do so.
4. Click Execute.
5. Launch Trend and navigate to Sim60Lab.Tags.
6. Drag the Sine tag onto the trace area.
7. Right-click on the Sine tag in the items pane and select Edit.
8. Set Min to 0, Noise Amount to .05 and Phase to 110. Leave the Value field as is.
9. Click OK.
10. Edit the MachineSpeed tag as shown in the image below. Leave the Value field as is. Click OK.
11. Edit the MachineRunning tag as shown in the image below. Leave the Value field as is. Click OK.
2. Select the Tags folder, right-click on the Sine tag and select Edit.
3. Set the Phase property to 110 to match the phase on the Sim60Lab simulator’s Sine tag. Set the
NoiseAmount to 0.1. Click OK.
4. In Trend, drag the Sine tag from Sim60Lab onto the trace area. Drag the Sine tag from
Sim60NoisyLab onto the trace area and stack the traces. Note the noise amount in the Sine
tag from the Sim60NoisyLab simulator.
When the VantagePoint server is installed, some type packages are also installed in C:\Program
Files\Incuity\Packages. When these are imported into the model they will extend the types available
from which to model.
In this lab, you will use some of the types defined in a custom type package imported in a previous lab –
VP.2, Lab 5.2. You will create some equipment items from the imported types and tie them to simulator
tags.
2. Scroll to the bottom of the list and expand Incuity.TankMonitor.Package to view the Tank
Monitor Package.
NOTE In the image below, the scope indicates that the tags are from the Sim60_2 simulator that was
created at the beginning of this lab.
8. Create a valve in the same location, configure it as shown below and click Create.
9. Now, create a tank in the same location, configure it as shown below and click Create.
10. Drag and drop the Tank001 item from the Equipment folder to the Production Line 1 folder.
11. Launch Trend. Drag the tank, pump and valve items onto the trace area.
12. Select the Run Indication tag in the list below the trace area. Right-click on the trace area and
select Properties > Trace.
13. Check the options for Enable Shading, Use trace color and Apply these trace settings to all new
Trends. Then click OK.
14. If you have stacked your tags, turn off the stacking option. Your trace area should look similar to
the following.
In this lab the participant will create and import a Type Package to introduce a user-defined type into
VantagePoint. An instance will be created from this type to extend the VantagePoint Model. The
package will then be removed from the VantagePoint system, edited to add more properties, and then
re-imported.
5. In the Type details area, click Add. This will add a new property with the default name Prop1.
6. Double-click Prop1 in the properties list and configure it as shown in the image below then click
OK.
7. Select File > Save and save the package file to your Desktop. Use the default file name.
6. Configure the instance as shown in the following image then click Create.
4. Save the updated type package file by selecting File > Save.
NOTE VantagePoint does not have any merge functionality. Before you are able to import an updated
package file, you must delete the previous version in order to have a successful import. Upon
deletion of an old package, any instances that you have created using types defined in that
package will also be deleted.
6. Notice the new AdHoc Tags collection item under the Machine001 instance.
5. In the Description field, enter Asset Class to which the Machine belongs.
6. Click Detail.
7. At the bottom of the dialog, click the Add button twice.
8. Click Index1 and change the name to SmallMachinery. Change Index2 to LargeMachinery.
9. Click OK.
10. Save the new package file.
6. Click Cancel.
The VantagePoint Model is made up of instances that have been created from types. Types are defined
using a type package, which is an XML document with an .ITP file extension. Instances can also be
defined using an XML file but with an .IIP file extension. The .IIP extension stands for Item Instance
Package. Both type and instance packages can be imported into a VantagePoint system.
Instance packages can be exported, edited, and re-imported. In this lab, the participant will import one
of the sample type packages installed on the server and will use its types to build an instance structure.
The instance structure will then be exported, edited and re-imported.
For this exercise, we have an existing plant model defined and an instance created for our Chicago
facility. We want to bring another plant on line in Cleveland that is a replica of the existing plant. We will
use the Export tool to extract part of the model then make changes to the external file before re-
importing back into the model.
NOTE Usage: NScript Export.vb /items:"Fully Qualified Name (FQN) of the top level item to be
exported" /out:"Location to place the output file (with an .IIP extension)".
1. Copy the Export.vb file found in C:\Program Files\Incuity\Samples\Scriptlets and place it in this
location – C:\Program Files\Incuity\Bin.
2. Open a command prompt (Start > Run, type in cmd and click OK) and change the directory to
C:\Program Files\Incuity\Bin. Now, enter the text below at the prompt and hit the Enter
key. When the export completes, push the Enter key again.
5. Check the C:\Inetpub\wwwroot\Incuity\Import folder and verify that the .iip file has been
moved to the Success folder. If there were any errors, the .iip file would appear in the
Failure folder and further information would be available in the Incuity.log file located in the
C:\Inetpub\wwwroot\Incuity\Logging folder.
6. Delete the newly created Cleveland Plant instance before proceeding to the next lab. You can
delete this instance by browsing to MyEnterprise.Samples.Production.Cleveland Plant, right-
clicking on it and selecting Delete.
Certain Logix Data Types such as User-Defined Types (UDTs) and some System-Defined Types (SDTs) or
Predefined Types are not known to VantagePoint when VantagePoint is first installed. That is, there are
no import rules defined in VantagePoint for these Data Types. When these Data Types are imported,
they will be mapped to a generic VantagePoint Type (Connector.FactoryTalk.Logical.UDT) and Instances
of these different Logix Data Types will not be distinguishable from each other in VantagePoint.
In order to preserve the uniqueness of these Logix Data Types, corresponding VantagePoint Types can
be created and import rules can be defined to map each Logix Data Type to an equivalent VantagePoint
Type. The import rule would specify the VantagePoint Type we want to map the Logix Data Type to, and
the members of the Logix Data Type which are to be mapped to the properties of the VantagePoint
Type.
Once the import rule is created and the structures (instantiated Logix Data Types) are imported, all
Instances of these Logix Data Types, for which import rules have been defined, will become available as
Instances of the specified Types in VantagePoint. Users can then leverage this in the model when
creating template reports against these Types.
In this lab, the participant will map a UDT called WorkOrder to a VantagePoint Type called
RSSamples.WorkOrder.WorkOrder.
5. In the tree view window on the left, browse to the folder Data Types > User Defined and select
WorkOrder.
6. Double-click WorkOrder. Note the list of Members and also the Data Type of each Member.
7. In the tree view window, right-click on the WorkOrder node and select Monitor Tags.
8. Note that WO_DB contains an array, of size 10, of the data type WorkOrder.
9. Expand WO_DB. Note that the Data Type of WO_DB[0] is WorkOrder. Click on the plus sign (+)
next to WO_DB[0] to expand this node. Note the Data Types of each of the members and
also the values.
5. Note also that Members of the Logix Data Type that are of the Data Type STRING have
corresponding Type properties that of the Sub Data Type Core.StringTag. For INT, it is
Core.IntegerTag.
NOTE As a reference, here is a list of the recommended VantagePoint SubData Types to use
when creating VantagePoint Types to match a given Logix Data Type.
3. Import Rules have been defined for the Data Types you see listed. Note that currently no
Import Rule has been defined for the Logix Data Type WorkOrder.
3. Below the WorkOrder Instance, right-click on the MappingRule node and select Assign Item.
7. Click Create.
8. Below Mapping Rule, right-click on the Members node and select New > Item.
9. For the Name, PropertyName and Type fields, enter CustomerName, Customer Name and
STRING respectively. Note that the PropertyName value has a space in it.
11. Repeat steps 8 to 10 and create rules for all Members in the table below. We have already
created the rule for the first Member in the list. Note the subtle differences between the
names and the corresponding property names (e.g. space between words, Qty versus
Quantity)
12. The list of Members should look like the following screenshot.
3. Click Next.
4. Click Next.
5. In the tree browser, select FTVP App > CLX1.
6. Click Next.
7. Click Next.
8. Note that WorkOrder is shown in the list. This indicates that we now have an import rule
defined for this Data Type. Check the WorkOrder checkbox. This means that this Data Type
will be imported. Also, note that the VantagePoint Type is
RSSamples.WorkOrder.WorkOrder.
9. Click Next.
10. Click Next.
11. Click Next.
12. Click Finish.
13. Click OK when the import is complete.
14. Browse to System.Sources.FactoryTalk.localhost.Applications.FTVP App.CLX1.Online.WO_DB
and expand the WO_DB node to view the imported structure.
15. Below WO_DB, select WO_DB[0] and view its properties in the Properties pane on the right.
Note that the Type is RSSamples.WorkOrder.WorkOrder. The same is true for WO_DB[1],
WO_DB[2], etc.
Additional Exercise
If you have finished early, create an ad-hoc Template Excel report showing the live values of all the
properties of the selected RSSamples.WorkOrder.WorkOrder Instance. Publish the report and verify
that you can change the selected work order at runtime in the Portal.
NOTES
VantagePoint allows the creation of composite reports. These reports may contain several types of
content – trends, dashboards, excel reports and HTML content. In this lab, you will create a composite
report that contains two trends and some HTML content.
6. Click Add.
7. In the Parameter Editor, click the browse button next to the Default Value field.
NOTE The ExtruderCompositeReport item contains three nodes: ParameterTypes, OwnedItems and
Rows. ParameterTypes and OwnedItems are internal to the report and should not be edited.
Configuration on the composite report is done in the Rows node.
13. Right-click on Rows and select New > Item. Configure the creation dialog as shown below then
click Create.
14. Below the TitleRow node, right-click on Cells and select New > Item. Configure the creation
dialog as shown below then click Create.
15. Below the Cell1 node, right-click on Content and select New > Item.
16. Choose Portal.ViewableHtmlContent and click Create.
17. Configure the creation dialog as shown below. Leave the HTMLMarkup field empty for now. Do
not click Create.
18. Launch Internet Explorer and enter the following in the address bar:
http://vm-ftvpsvr/VantagePointPortal/internal/htmleditor.aspx
19. In the HTML editor, enter a title for your report similar to the following image (the text in the
image uses the font Verdana, is of size 5, and is centered.
20. Click the HTML button in the bottom left corner to switch to the raw HTML. Select the HTML you
see and copy it to the clipboard.
21. Return to the instance creation dialog in VantagePoint Manager. Click the magnifying glass icon
to the right of the HTMLMarkup field.
22. Right-click in the text area and select Paste. Click OK. The instance creation dialog should look
similar to the following.
26. Right-click on the Content item under Cell1 and select New > Item. Select
Portal.ViewableTrendContent and configure as shown below.
30. Click Reports > My Enterprise then navigate the tree for the composite report we just created –
MyEnterprise.Public.<Your Name>.Reports.ExtruderCompositeReport. Click on the report.
31. Once the report is generated, notice that the Stroke Length trend looks very busy. This is
because all the properties of an extruder are being displayed. We will now set the trend to
only display the Stroke Length tag property of the selected extruder.
33. Return to the Portal and click on your ExtruderCompositReport. Notice the change in the trend.
36. Add a new parameter under the ParameterMapping node and configure it as follows then click
Create.
37. Return to the Portal and click on ExtruderCompositeReport. You should see something similar
to the following.
38. Return to VantagePoint Manager so that we can change the time span on the Stroke Length
trend.
39. Right-click ParameterMapping under StrokeLengthTrend and select New > Item. Configure the
parameter mapping instance as follows. This will serve as the start parameter which is used
to set the start of the time period for which historical data is displayed in the trend.
40. Similarly, configure another parameter mapping instance as shown below. This will serve as the
end time which is used to set the end of the time period for which historical data is
displayed in the trend.
NOTE The default time span for a trend is the last 5 minutes. We are overriding the default time span
and setting it to the last 10 minutes. Available time options are s for seconds, m for minutes, h
for hours, and d for days.
41. Return to the Portal and click on ExtruderCompositeReport. It should look similar to the
following. Note the difference in the time span in the Stroke Length trend compared to the
Hydraulic Pressure trend.
42. We will now add a more specific name to the title of our report.
43. Return to VantagePoint Manager and navigate to MyEnterprise.Public.<Your
Name>.Reports.ExtruderCompositeReport.Rows.TitleRow.Cells.Cell1.Content.ReportTitle.
44. Right-click on ReportTitle and select Edit.
45. Click the magnifying glass icon next to the HtmlMarkup field.
46. Replace the text Extruder with [ShortName] then click OK.
51. Return to VantagePoint Portal and click on ExtruderCompositeReport. The name of the selected
machine now appears in the title of the report.
4. Under the Content node, add a ViewableTrendContent item and configure it as shown below.
Click Create.
NOTE xtag defines the parameter for the x-axis while ytag defines the parameter for the y-axis.
In this lab, you will learn how to better organize your available content using model views in
VantagePoint Portal. A model view displays only a portion of the model in the Portal. You also have the
ability to designate which items within that portion are to be shown. Model views can be created from
VantagePoint Manager as well as directly in the Portal.
NOTE Name – View<n>. This is a recommendation naming convention where n is the next
available number starting from 1. This name cannot be modified after creation.
Description – This is an optional field and if defined will display as a tooltip item for the
view menu item.
Display Name – This is an optional field and if not defined will default to the internal name
described above. It is the name that is shown under the Portal’s Reports menu.
AutoExpandDepth – This defines the number of folder levels to expand when first
displayed.
Anchor Node – This corresponds to the location in the model namespace where you would
like the content viewer to root the display.
Default Content – This defines any content that you would like to be displayed by default
on the right side of the content viewer when a user enters your view.
Menu Element – Can be the following:
i. MenuGroup
ii. MenuPage
iii. MenuLink
iv. Menu Command
2. Click Create.
3. Navigate to System.Applications.Portal.Settings.ContentViewer.ModelViews.Sample Content
View and edit it.
4. Notice if the MenuElement was left blank during creation, it defaults to what was entered under
Name.
6. Scroll down the tree and note that the Production folder is visible. We will hide this folder in
the next section.
4. Click Create.
5. Return to the Portal. Select Reports > Sample Content to refresh the view and note that the
Production folder is no longer visible.
4. Click Create.
5. Return to the Portal. Click Reports > Sample Content to refresh the view. Note that all content
in the MyEnterprise.Sample.Extruders folder level and deeper is visible in a single list under
the Samples folder.
4. Right-click the Report Library folder in the tree below and select Anchor > Anchor here.
5. Right-click the Report Library.Composite.Analog Tag Analysis report and select Visibility >
Make this the default content item.
7. The view is refreshed and the report designated as the default content is shown.
4. Notice that along with a new Mode View called MyReports, a new Menu Group is added under
System.Applications.Portal.Settings.Menu.Reports called MyReports.
5. Launch VantagePoint Portal (or click on Home if the portal is already open). Select Reports in
the menu bar. Notice the new menu item in the drop down list. Click on My Reports.
In this lab, you will learn about configuring the VantagePoint Portal menu in the VantagePoint model.
The additional menu structure we will create will look like the following:
Equipment
Extruder Reports (link to a Model View)
Direct Links
Extruder 1 Dashboard (link to a template dashboard and pass in Extruder001 as
the parameter value)
Extruder 2 Dashboard (link to a template dashboard and pass in Extruder002 as
the parameter value)
Efficiency Trend – Last 10 Minutes (link to a trend and pass in the start and end
date time)
5. Click Create.
6. Now we want to use the ContentViewer.aspx page to link to a pre-defined Model View. For this,
we will need the FQN of the view. Start by browsing to the following view and clicking on it
– System.Solutions.Samples.PortalSettings.ModelViews.Production. To the right, select
the General tab. Highlight the FQN, right-click and select Copy.
9. Enter Extruder Reports for the Name and the DisplayName fields. Enter 1 for the
DisplaySequence. Uncheck the OpenInNewWindow checkbox. For the URL field, enter
http://vm-
ftvpsvr/vantagepointportal/contentviewer.aspx?view=System.Solutions.Samples.PortalSettin
gs.ModelViews.Production. Note that you do not have to type the FQN of the view as you
have copied it already in Step 6.
13. Now we will create a sub-menu under Equipment. In VantagePoint Manager, browse to
System.Applications.Portal.Settings.Menu.Equipment, right-click on Equipment and select
New > Item.
14. Select Portal.MenuGroup and click Create.
15. Enter Direct Links for the Name and the DisplayName fields. Enter 2 for the DisplaySequence as
we want this displayed below the Extruder Reports menu item in the Portal. Click Create.
16. Now we want to create a link under Direct Links to a template dashboard and also pass in the
parameter value.
17. Right-click on Direct Links and select New > Item.
18. Select Portal.MenuLink and click Create.
19. Enter Extruder 1 Dashboard for the Name and DisplayName fields. Enter 1 for the
DisplaySequence.
26. Repeat steps 17 -22 to create a link to the same dashboard but this time pass in the FQN of
Extruder002. Set the DisplaySequence field to 2 and uncheck the OpenInNewWindow
checkbox.
28. Last, we want to configure the Portal menu to link to a Trend report and pass in the start and
end date time.
29. Repeat steps 17 -22 to create a link to the Trend report Plant Output. The URL should be the
following - http://vm-
ftvpsvr/vantagepointportal/ContentViewer.aspx?report=MyEnterprise.Samples.Production.R
eports.Plant Output&start=rel&end=10m&showparams=false. Again, you can use the
copy/paste method to get the Trend report’s FQN. Set the Name and DisplayName fields to
Efficiency Trend – Last 10 Minutes. Set the DisplaySequence field to 3 and uncheck the
OpenInNewWindow checkbox.
In this lab, you will learn about the Portal.Hyperlink type in the VantagePoint system and how
to use it.
32. Launch VantagePoint Manager.
33. Right-click on the MyEnterprise.Public.<your name>.Reports folder and select New > Item.
34. In the ‘New Item’ dialog, click the plus icon to expand the Core.Object tree. Scroll down the list and
find Portal.Hyperlink and then click Create.
35. In the next dialog, fill in the values as shown in the image below then click Create.
37. The Incuity Web Link is now shown in the model browser under the Public folder with the display
name of Incuity. If you have Internet access, you can click the link to test it.
In this lab, you will learn about the Portal.ReportRuntimeInfo type in the VantagePoint system and how
to use it.
5. In the instance dialog, click the browse button next to the Report field. Browse to
MyEnterprise.Samples.Extruders.Reports and select the Extruder Comparison report. Click
Assign.
6. Fill in the remaining values as shown in the image below and click Create. Note the scope to
determine the FQN of the selected report.
7. Right-click on RuntimeInfo under the newly created item and select New > Item. Configure the
instance dialog as shown below.
8. Click Create.
9. Right-click ParameterMapping and select New > Item. Configure the instance dialog as shown
below and click Create.
In the lab, you will learn how to use VantagePoint Portal type rules. A type rule associates a specified
type, such as an Extruder, with one or more published reports.
2. Right-click on ContentTypes and select New > Item. Fill in the dialog as shown below then click
Create.
3. Below the newly created DiscreteTagRule node, right-click on ViewableContent and select New
> Item.
5. Name the report Event Report but leave Display Name blank for the moment.
7. Browse for the report Single Discrete Tag Event Report as shown in the below image. The FQN
of the report is MyEnterprise.Samples.Report Library. Single Value Displays. Single
Discrete Tag Event Report.
10. First, in the MyEnterprise.Public.<Your Name> folder, create a new folder called Sample Tags.
11. Next, browse to System.Sources.Simulator.ExtruderData1.Tags, select the MachineRunning tag
and copy it (as a shortcut) to the MyEnterprise.Public.<your name>.Sample Tags folder.
14. Let us return to our Event Report item and add the display name that we omitted earlier. In
VantagePoint Manager, navigate to
System.Applications.Portal.Settings.ContentViewer.ContentTypes.DiscreteTagRule.Viewa
bleContent.Event Report.
NOTE The DisplaySequence field is used to define the relative order in which the viewable content is
displayed under the type item.
17. Return to the Portal and click on Reports > MyEnterprise. In the Browser pane, scroll down and
notice the change in the Sample Tags folder.
18. Click on the Event Report link under the MachineRunning tag. The report is generated using the
MachineRunning tag.
In the portal, the Content Viewer will only display items if they are contained in a recognized content
container. Normally, content containers would have been a Folder item however, VantagePoint allows
for the definition of a ContentContainerType which enables all instances of a specified type to be a
container.