*
Concepts
*
Tasks
*
Settings

Creating a Calculated Cumulative Indicator

A cumulative indicator is an indicator that tracks a value that increases over time. For example, an odometer is cumulative. Today’s reading will always be higher than yesterday’s reading. A cumulative indicator can be read as either an accumulated value (the value over the lifetime of the indicator) or as a consumed value (the difference from the last reading).
The value of cumulative indicators can also be determined using a formula. You can set up this formula in the same way as for other numeric calculated indicators. The way in which the calculated value is used depends on whether the indicator has been set up as an accumulated value (for example, an odometer) or a consumed value (for example, a trip meter).
If the indicator is set up as an accumulated value, then each time the calculation is triggered and a new reading is created, the indicator’s life-to-date value is reset to the value calculated by the formula. For example, if the result of the calculation is 2,000 km, then the life-to-date value for the indicator is set to 2,000 km.
On the other hand, if the indicator has been defined as a consumed valued, each new reading represents only the change since the last reading was taken. Therefore, the value calculated by the formula is added to the indicator’s current life-to-date value. For example if the calculated value is 10 km and the indicator’s current life-to-date value is 2,000 km, the new life-to-date value is 2,010 km.
This topic explains how to create a calculated cumulative indicator. For more information on calculated indicators, see Introduction to Calculated Indicators.

To Create a Calculated Cumulative Indicator

1.
Open the asset that needs the indicator. Select the Inspection Management view, Indicators tab.
2.
Click New. The Create New Indicator dialog appears.
3.
Select From scratch and click OK.
4.
The Indicator window appears. For example:
5.
On the Properties view, General tab:
•
Enter a name for the indicator. The name should describe what is being measured, such as “Operating Hours.”
•
Select a cumulative indicator type from the Indicator type list. The window changes to reflect the value type.
6.
Check that the unit of measure is correct.
7.
In the Collection method list, select “Calculated using a formula.” The Calculation tab is added to the window. For example:
8.
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.
Inspection type
The type of inspection to be performed on the asset, for example, “Intrusive” or “Out of service”.
Inspection effectiveness
This value provides a measurement of the thoroughness, sensitivity, and efficiency of the inspection strategy, which can then inform your assessments of confidence and probability of failure.
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.
9.
You can enter a target value for a numeric or cumulative indicator on the Details tab. For example:
The target value is displayed on charts and dashboards that show readings for the indicator. In this example, the target line appears as a red dotted line on charts:
10.
Select the Daily Average tab to select how APM tracks the indicator’s daily average.
11.
To specify the months during which readings should be taken, select the Seasonal tab. Click Indicator is collected seasonally and select the starting and ending dates. For example:
Reading due dates will reflect the seasonal settings.
12.
On the Description tab, you can enter a detailed description of the indicator and what it measures. On the Image tab, you can also paste an image into the box.
13.
On the Meter tab, you can set the measurement type and roll-over value or daily maximum values for the indicator. This is the same as setting these options on a regular cumulative indicator.
14.
If necessary, you can enter initial values for the indicator (for example, the current odometer reading). To do this, click Enter Initial Values. Complete the Enter Initial Values for an Indicator dialog, as you would for a regular cumulative indicator.
15.
Select the Calculation tab.
16.
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
17.
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.
18.
If the type of expression is VB.NET or C#, type in the mathematical formula or function that the system will use in the text box provided.
If you are entering a function, see Using Logical Operators and Functions.
If you are using a formula, you can use three elements:
•
Calculation inputs (a name that represents data from another asset indicator): 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 period (.), must not exceed 20 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 the next step.
•
Operators (such as, add or multiply): Type the operator in the format shown in Operators for Calculated Indicators.
•
Constants (that is, 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 “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 gets the current values of the indicators.
19.
If the type of expression is stored procedure, the information on the Calculation tab changes:
Provide the name of the stored procedure.
20.
Now you need to define the inputs for the calculation. The input name must match the name of an input in the formula, function, or procedure. 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. For detailed instructions, see:
•
Creating Calculation Inputs Based on Indicator Readings
•
Creating Calculation Inputs Based on Filters
21.
Click OK when you have finished creating the input. The Calculation Input dialog closes and the input is added to the table of inputs.
22.
For VB.NET or C# script expressions, you can check the syntax (the order of the elements) of your calculation by clicking Calculate on the Expression tab. When you click this button, the system looks for errors in how you typed the calculation. In addition, the system uses the test values on the inputs to complete a test calculation. You can use the result of this calculation to check that the expression is giving the desired results.
23.
When you have defined the calculation expression and inputs, you can click Check (Test). The test function uses the values from the inputs (for example, indicator readings) and displays the result in the Test Reading window.
24.
For stored procedure expressions, the call syntax is displayed for your reference. The calculation inputs are added to this call statement automatically. Ensure that the parameters in the stored procedure match the input names and that the procedure includes a return value parameter.
25.
If necessary, you can change the Required Proximity of the calculation inputs. This option appears at the bottom of the Expression tab when you have defined two or more inputs based on readings.
Setting Name
Description
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.
26.
Select the Frequency tab. In the Triggering mechanism section, select when and how the system will trigger 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.
27.
Select the Auditing tab. To improve product performance, you can control the amount of audit information generated when a reading is created. (The audit information is displayed in the Indicator Reading window, Calculation tab.)
Setting Name
Description
Auditing level for the indicator’s readings
Auditing levels are:
•
Full auditing – Full information is displayed on the reading’s Calculation tab
•
Description and input values – The reading’s Calculation tab displays the description and input values in the text field. The table of input values is not displayed
•
No auditing – The reading’s Calculation tab is not displayed
28.
When you are finished, save the indicator and close the window. APM adds the new indicator to the asset.