Create a rollup analysis template
- Last UpdatedJan 11, 2023
- 5 minute read
- PI System
- PI Server 2024 R2
- PI Server
In PI System Explorer, you can create a rollup analysis template for a selected element template. You select input values for the rollup either from attributes of the selected element template or from the attributes of a child element template (whose parent element is derived from the element template). You can choose an example child element and use its attributes to help you develop a rollup analysis template.
Prerequisite: Identify the statistical functions you want the rollup to calculate and where you want to save the results. You can map results from a function to an existing attribute of the element template, or you can create a new output attribute when you configure an analysis template.
-
In the Library browser, select the element template where you want to create the analysis template.
-
Under Rollup attributes from, indicate the source of input values:
-
Click Child elements of Element Template Name to roll up attributes of child elements of an element based on the current element template.
-
Click This element - Element Template Name to roll up attributes of an element based on the current element template.
-
-
In the viewer, click the Analysis Templates tab.
The tab lists any analysis templates already defined for the element template.
-
Create a new analysis template for the element template:
-
If no analysis templates exist, click Create a new analysis template to create the first one.
-
Otherwise, click New Analysis Template
to create a new one.
-
-
Enter information to identify the analysis:
-
Name
The name that uniquely identifies this analysis.
-
Description
Optional text that describes the analysis.
-
Categories
Optional category that you can assign to the analysis. Click the list and select the check box next to categories you want to assign or click New to create a new category.
-
Analysis Type
Click Rollup.
-
-
Optional. Clear the Enable analyses when created from template check box so that the analysis is created in Disabled status.
By default, a new analysis will be created with Enabled status. You must clear the option if you do not want to start the analysis when created.
-
Under Rollup attributes from, indicate the source of input values:
-
Click Child elements of Element Template Name to roll up attributes of child elements of an element based on the current element template.
-
Click This element - Element Template Name to roll up attributes of an element based on the current element template.
-
-
Select an example element to provide candidate attributes:
-
Click the Select an example element link to open a window that shows elements derived from the selected element template.
-
Select an element and click OK.
-
-
Select the attributes to include in the rollup:
If rollup attributes come from:
Then:
Child elements
-
From the Sample Child Element list, select the element from which you want to view attributes.
The table shows attributes of the selected element. To improve performance, the table only shows a limited number of attributes. You can click the Show more attributes link below the table to show additional attributes from the selected element.
-
To the left of the table, specify criteria that select attributes to roll up:
-
Attribute Name
Type an entire attribute name or part of a name with wildcard characters. For example, type temp* to select all attributes that begin with "temp", such as Temperature and Temp1.
Note: The selection of attributes depends on whether Attribute Level is set to "Root Level" or "Child Level".
-
Attribute Level
Select Root Level to choose from top-level attributes or Child Level for child attributes. You cannot choose both child attributes and top-level attributes in a single roll-up analysis.
-
Attribute Category
Select a category to limit selected attributes to those in that category.
-
Element Category
Select an element category to limit selected attributes to attributes that have parent elements in that category.
-
Element Template
Select an element template to limit selected attributes to attributes that have parent elements based on that template.
Note: The criteria apply to all attributes of any child element, not just those shown in the table.
You can specify criteria that select attributes not shown in the table. For example, if you set Sample Child Element to an element from category CatX but set Element Category to CatY, you will select none of the attributes in the table but the analysis will still include the attributes in the rollup.
-
This element
To the left of the table, specify criteria that select attributes to roll up:
-
Attribute Name
Type an entire attribute name or part of a name with wildcard characters. For example, type temp* to select all attributes that begin with "temp", such as Temperature and Temp1.
Note: The selection of attributes depends on whether Attribute Level is set to "Root Level" or "Child Level".
-
Attribute Level
Select Root Level to choose from top-level attributes or Child Level for child attributes. You cannot choose both child attributes and top-level attributes in a single roll-up analysis.
-
Attribute Category
Select a category to limit selected attributes to that category.
The table shows a check mark next to any displayed attribute included in the rollup.
-
-
In the functions table, specify the rollup calculations and output:
-
Select the check boxes next to any statistical function you want the rollup to calculate.
-
Click Map to store results from a calculation to an output attribute.
You can map the output to an existing attribute or map the output to a new output attribute.
-
Optional. At the top of the table, click Evaluate to verify the output values of the selected functions.
-
-
Optional. To verify the analysis, examine the results produced with historical data:
-
In the analysis list, right-click the analysis and then click Preview Results.
-
Enter a start time and end time not later than the current time, and click Generate Results to see a list of results.
-
-
To apply changes and save your work locally, click
on the toolbar.
-
Click Check In on the toolbar to save the analysis template to the PI AF server and to create the analysis for any element based on the element template.