Create a template for power rollup analyses

This example demonstrates how to create a template that you can use to generate a set of rollup analyses. The analysis template aggregates the total power draw of all processes at a refinery.

Prerequisites: Create the following necessary objects in your PI AF database:

• Element template named Refinery.

• Element named Rotterdam Refinery, derived from the Refinery template

• Child element named Catalytic Cracking under the Rotterdam Refinery element

• Attribute named Power Draw under the Catalytic Cracking child element

1. In the Library browser, select the element template for which you want to create the analysis template.

   In this example, the element template is called Refinery. This template is used to create refinery elements.

2. Click the Analysis Templates tab.

   • Name

     The name that uniquely identifies this analysis. For example, PowerRollup.

   • Analysis Type

     Click Rollup. A rollup analysis calculates statistical data for specified attributes, such as a total or an average value. For more information, see Understand rollup analyses.

3. Enter information to identify the analysis:

   • Name

     The name that uniquely identifies this analysis. For example, PowerRollup.

   • Analysis Type

     Click Rollup. A rollup analysis calculates statistical data for specified attributes, such as a total or an average value. For more information, see Rollup analyses.

4. Select an example element to provide candidate attributes:

5. Click the Select an example element link to open a window that shows elements derived from the selected element template.

6. Select an element and click OK.

   For example, in the list of elements derived from the Refinery template, click Rotterdam Refinery.

7. For the Rollup attributes from option, click Child elements of Rotterdam Refinery to indicate that the analysis rolls up attributes of child elements of the refinery element.

8. Select the attributes to include in the rollup:

9. From the Sample Child Element list, select the element from which you want to view attributes.

   For example, select Catalytic Cracking to see attributes from the Catalytic Cracking element in the attributes table.

   The table only shows attributes from the selected element. The rollup include attributes from all child elements that match the criteria that you specify.

10. To the left of the attributes table, specify criteria that select attributes to roll up.

    For example, in the Attribute Name field, type Power* to specify all attributes that begin with Power. The attributes table shows a check mark next to any attributes in the selected child element that match this criteria. However, the rollup includes attributes from any child element that match the criteria, not just those in the table.

11. In the functions table, specify the rollup calculations and output:

12. Select the check boxes next to any statistical function you want the rollup to calculate.

    For example, click the Sum check box to total values.

13. In the Output(s) column, click Map to store results from the calculation to an output attribute.

14. Click New Attribute Template to create a new attribute template with a PI point data reference.

15. Specify values that define the created attribute and point, and then click OK.

    For example, you can use the default values, which name the point and attribute PowerRollup_Sum and write the point to the default Data Archive, indicated by the substitution parameter.

16. Click Evaluate and check whether the result returned in the Value column is reasonable.

17. Set the Scheduling option to Event-Triggered.

18. To verify the analysis, examine the results produced with historical data:

19. In the analyses list, right-click the analysis and then click Preview Results.

20. Enter a start time and end time not later than the current time, and click Generate Results to see a list of results.

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