*
Concepts
*
Tasks
*
Settings

Creating a Calculated Indicator Template

A calculated indicator is an indicator that has its readings calculated using a formula, rather than entered manually by a person or electronically by an on-line system.
You can set up a calculated indicator to record information about an asset condition that is not directly available from a measuring device on the asset. For example, you could set up a calculated indicator to measure the efficiency of a pump. Because this is difficult to measure directly, you can create a formula that uses other indicators on the pump that you can measure. You can set up numeric, cumulative, and descriptive indicators as calculated indicators. You can use data from other asset indicators or from APM objects as part of the calculation.
If you set up calculated indicator templates, you can use them to create calculated asset indicators. This eliminates the need to define the calculation for each asset indicator. When you set up a calculation on an indicator template, you must define the variables using other indicator templates. This means that when you create an asset indicator from the template, you must update the calculation with the appropriate asset indicators.
Note: On indicator templates, you can only use other indicator templates in your calculation. When you use the template to create an asset indicator, you will need to reset the calculation so that it uses the correct asset indicators.

To Create a Calculated Indicator Template

1.
Select the site’s Inspection Management view, Indicators tab.
2.
Select the Templates tab. By default, the table lists the indicator templates for the site and above.
3.
Click New. The Indicator template window appears.
4.
On the Properties view, General tab:
•
Enter a name for the indicator. The name should describe what is being measured, such as “Engine Oil Temperature.”
•
Select an indicator type from the Indicator type list. The window changes to reflect the value type.
5.
Check that the unit of measure is correct.
6.
In the Collection method list, select “Calculated using a formula.” The Calculation tab is added to the window.
7.
On the Collection tab, you can enter values that determine how often readings are expected and the next collection date. You can also enter information to make it easier to select this indicator when adding indicators to a work order task or standard task, when copying indicators to another asset, when setting up dynamic inspection routes, or when implementing reliability programs.
If you are creating the indicator from a strategy development analysis (MTA2, RCM2, RBI, CPR), the searching values (frequency, regulatory frequency, trade, operating condition, maintenance group, and technology) are automatically copied from the associated action plan, if the analysis’ indicator settings allow it. In this case, you need only verify the values.
Note: Any changes that you make to the searching values are not copied to the indicator’s associated action plan.
Review and select values, as appropriate:
Setting Name
Description
Frequency
Select the expected frequency with which the readings should be collected. This information is used to select indicators in lists and as matching criteria on dynamic inspection routes for standard tasks.
Note: A frequency must be selected if the indicator is to use a collection window based on a percentage of its frequency.
Regulatory frequency
Interval between inspections as mandated by the appropriate regulatory agency.
Trade
Select the trade that is normally responsible for collecting readings for the indicator. This information is used to filter lists of indicators.
Operating condition
Select the operating condition that the asset must have before readings can be collected for it. This information is used to filter lists of indicators.
Maintenance group
Select the maintenance group that is normally responsible for collecting readings for this indicator. This information is used to filter lists of indicators.
Technology
Select the PdM technology used to collect readings from the indicator. This information is used to filter lists of indicators.
Tip: If the technology is linked to an asset type that is used to collect indicator readings, you can identify the measurement device on indicator readings and checksheets.
Collection sequence
Enter the sequence number to be given to the indicator when it is added to a standard task. The sequence number suggests the order in which the indicator reading is to be taken. This default sequence can be changed on the standard task.
Collection group
Collection group is one of the properties that can be assigned to a route asset on a standard task’s dynamic inspection route. Collection groups are typically used for large assets whose indicators are read at different points in the route. For example, indicators could be split into two groups: front and back indicators. The front and back of the asset might be visited at different times on the route or even on different routes (standard tasks).
Collection set
Collection set is one of the matching criteria that can be used to select indicators for a standard task’s dynamic inspection route. You can create collection sets as required by your organization to identify indicators for different routes.
Bar code
If your organization uses bar codes to identify employees, assets, indicators, or areas, enter the bar code here. The number must be unique for all objects that support bar codes. For example, an employee’s bar code might be his employee number with the prefix “E”.
External ID
The short name for the indicator. This is an optional value that does not need to be unique for the asset. The default value is copied from the indicator name.
Map coordinates
The latitude and longitude coordinates of the indicator.
Note: By default, the map coordinates are automatically populated with the coordinates of the asset to work on.
Note: Latitude can have values ranging from -090.000 to +090.000. Longitude values can be from -180.000 to +180.000. For values outside these ranges, APM will accept the values and adjust accordingly. For example, a longitude value of +200.0 will translate to -160.0 on the map.
8.
Select the Details tab if the indicator’s readings are to be represented with the gauge control. The target value defines the range of the gauge.
9.
To specify the months during which readings should be taken, select the Seasonal tab. Click This indicator is collected seasonally and select the starting and ending dates. For example:
Reading due dates will reflect the seasonal settings.
10.
Select the Description tab to enter more information about the indicator.
11.
Select the Calculation tab.
12.
On the Expression tab, select the type of expression. A calculated indicator can be based on:
•
VB.NET – Inputs and functions defined on the Calculation tab can be used to create a formula that is calculated at run time. This is the default option
•
C# – Inputs and functions defined on the Calculation tab can be used to create a formula that is calculated at run time
•
Stored procedure – The expression is provided in a stored procedure that receives its inputs at runtime and returns a value
13.
For VB.NET and C# expressions, you must also select the expression type. Your options are “Simple expression” (for single-line commands) or “Complete class” for more complex scripts.
With the Complete class option, a starter script template is provided automatically, which you can edit as needed. You can also click Regenerate from Template to reset the formula to the starter script.
The template scripts include DebugData statements that you can augment to output trace messages when the Check (Test) or Check (Live) method is invoked to test the calculation.
Tip: You can view the template scripts by opening the Enterprise window, clicking the Administration menu and then Calculation options. For more information, see Defining Calculation Options.
14.
If the type of expression is VB.NET or C#, in the text box provided, type the mathematical formula that the indicator will use. You can use three elements in your formula:
•
Calculation inputs (another indicator template): Enter a variable name for each indicator that you want to use in the calculation. Each calculation input must begin with a letter, cannot contain a “.”, must not exceed 255 characters, and must be unique within the calculation. For example, for a temperature indicator you might enter “Temperature1”. You will link an indicator to the variable in step 16.
•
Operators (such as, add or multiply).
•
Constants (a fixed value used in the calculation): Enter the value of the constant in the calculation. For example to divide by two, you would enter a “2”.
Example:
To enter a calculation that takes the average of two indicators, you would type:
(Indicator1 + Indicator2) / 2
The variables “Indicator1” and “Indicator2” are placeholders for data from asset indicators. When the calculation is evaluated, APM will get the current values of the indicators.
15.
If the type of expression is stored procedure, the information on the Calculation tab changes:
Provide the name of the stored procedure.
16.
Now you need to define all of the inputs for the calculation. You can create two types of calculation inputs: based on indicator readings or based on filters. From the New list select either Indicator Input or Filter Input. The Calculation Input dialog appears.
Note: On indicator templates that have reading-based inputs, you can only use other indicator templates in your calculation. When you use the template to create an asset or performance indicator, you will need to reset the calculation inputs so that they use the correct asset indicators.
For detailed instructions, see the following topics:
•
Creating Calculation Inputs Based on Indicator Readings
•
Creating Calculation Inputs Based on Filters
17.
For VB.NET and C# expressions, you can check the syntax (the order of the elements) of your calculation by clicking Check (Test) and the system verifies the calculation for errors.
18.
To use the test values on the inputs to complete a test calculation, click Calculate. You can use the result of this calculation to check that the expression is giving the desired results.
19.
When you have defined the calculation expression and inputs, you can click Check (Live). The test function uses the values from the inputs (for example, indicator readings) and displays the result in the Test Reading window.
Note: If you are using a C# complete class script and change the expression to a VB.NET complete class script (or vice versa), you must first click Regenerate from Template to regenerate the template to use the proper syntax.
20.
For stored procedure expressions, the call syntax is displayed for your reference. The calculation inputs are added to this call statement automatically. For example:
Ensure that the parameters in the stored procedure match the input names and that the procedure includes a return value parameter.
21.
If necessary, you can change the Required Proximity of the calculation inputs. This option appears in the Expression tab after you have added two or more inputs based on readings.
Required Proximity
This setting is only applicable when a calculation uses more than one indicator-reading-based calculation input. This rule does not apply to filter-based calculation inputs.
This option sets the time proximity required for calculated, performance, or rule-based indicators. You can specify the length of time within which all readings must have been collected in order for APM to evaluate the rule or calculation.
For example, you can specify that all indicator readings used in the rule or calculation must have been collected within one day of each other. If any of the indicators fall outside of the time period entered here, APM will not evaluate the rule or calculation.
Note: Required proximity is only applicable if two or more calculation inputs are based on indicator readings and use the most recent reading in the input.
22.
Select the Frequency tab. In the Triggering mechanism section, select when and how the system triggers the calculation. If the calculation is to be triggered at a regular interval (based on a recurrence pattern), define the scheduled interval for the indicator.
For detailed instructions, see Defining an Indicator’s Calculation Frequency.
23.
On the States and Alarms tab, you can set up states and alarms for the indicator template. For detailed instructions, see Adding States and Alarms to an Indicator or Template.
24.
When you are finished, save the indicator and close the window.
Tip: To create asset indicators using this template, see Creating Indicators from Indicator Templates.