*
Concepts
*
Tasks
*
Settings

Creating a Calculated Descriptive Indicator

A descriptive indicator is an indicator that has a distinct set of values that can be detected but not measured in numbers. For example, if you have an indicator that measures tire condition, a list of possible values for the condition of the tires would be “Good Condition,” “Slightly Worn,” or “Threadbare.”

VB.NET and C# Scripts

You can set up a calculated indicator that will produce a descriptive value as the output. To do this, enter a function using VB.NET or C# code and Boolean logic. You should be familiar with VB.NET or C# before creating indicators of this type.
For example, consider a descriptive indicator that can have any one of the three following values:
•
Normal
•
Fair Condition
•
Worn Out
In the formula below, the value of the indicator is set based on two numeric inputs: Input1 and Input2. If the value of Input1 plus that of Input2 is less than or equal to 100, then the value of the descriptive indicator is set to “Normal”. If it is between 100 and 200, it is set to “Fair Condition”. Otherwise, it is set to “Worn Out”.
For example:

VB.NET

If Input1 + Input2 <= 100 Then
Return “Normal”
Elseif Input1+Input2 > 100 And Input1+Input2 < 200 Then
Return “Fair Condition”
Else
Return “Worn Out”
End If

C#

if (Input1 + Input2 <= 100)
{
return “Normal”;
}
else if (Input1+Input2 > 100 & Input1+Input2 < 200)
{
return “Fair Condition”;
}
else
{
return “Worn Out”;
}

Stored Procedures

You can enter the formula for a calculated indicator in APM as a VB.NET or C# script. However, if you need a complicated calculation requiring extensive or complex processing, you can use a stored procedure. At run-time, the indicator is recalculated in the normal way, either manually based on an input or based on a recurrence pattern.
When calculated, the value of the inputs are fed to the stored procedure. The stored procedure must return either a number or a string, and this value is used to create the reading for the indicator. If a calculation fails, a reading is still created, but it is flagged as “Invalid” and the appropriate reason for the invalid reading is noted.
When defining the indicator, provide the name of the stored procedure and calculation inputs with names that correspond to the parameters used in the procedure. A calculation input and its parameters must use the same data type, and the procedure must include a return parameter that is either a string or number. You can create calculation inputs for stored procedures as you would for a VB.NET or C# script, except that the inputs cannot use the array aggregation type.
Note: When using Date and DateTime data types, be aware that the Date type uses the enterprise time zone, and the DateTime type uses Coordinated Universal Time (UTC).
This topic explains how to create a calculated descriptive indicator. For more information on using functions in calculated indicators, see Functions and Logical Operators.

To Create a Calculated Descriptive 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 “Tire Condition.”
•
Select a descriptive indicator type from the Indicator type list. The window changes to reflect the value type.
6.
Select “Calculated using a formula” in the Collection method list. The Calculation tab is added to the window. For example:
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.
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.
8.
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.
9.
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.
10.
On the States tab, you can set up states and alarms for the indicator. You should set up a state for each possible value identified in the calculation. For the example in this topic, you would set up three states called “Normal”, “Fair Condition”, and “Worn Out”. You can also set up alarms for any non-normal states. For detailed instructions, see Adding States and Alarms to an Indicator or Template.
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#, type in the mathematical formula or function that the system will use in the text box provided. It should match the format illustrated in the example in the introduction.
15.
If the type of express is stored procedure, the information on the Calculation tab changes:
Provide the name of the stored procedure.
16.
Now you need to define 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. The input name must match the name of an argument named in the function (for example, Input1). For detailed instructions, see the following topics:
•
Creating Calculation Inputs Based on Indicator Readings
•
Creating Calculation Inputs Based on Filters
17.
Click OK when you have finished creating the input. The Calculation Input dialog closes and the input is added to the table of inputs.
18.
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. APM 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.
19.
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.
20.
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.
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.
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.
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.
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
24.
Select the Jobs and Tasks tab. On this tab, you can add the standard jobs, standard tasks, and templates that will be displayed to users acknowledging alarms or warnings.
25.
If APM interoperability has been set up to access data in SAP Plant Maintenance, the SAP Corrective Tasks tab is available. Select this tab to browse for SAP objects for reference purposes. You can add maintenance items, maintenance plans, and task lists.
26.
Select the Options tab and the Graphics tab.
27.
Provide the following information:
Setting Name
Description
Reading charts
Style of chart to be used for indicator readings.
Default time period to show
Amount of time (for example, weeks, months, years) for which to show indicator readings. When this option is enabled, the Indicator window’s Readings view, Readings tab displays readings for this amount of time, ending with the next reading date. This setting also affects how KPI readings are displayed on dashboards.
Asset
Asset to use in indicator comparison charts.
Indicator
Indicator to use in indicator comparison charts.
Asset
Asset to use for tasks and failures in indicator reading charts.
Gauge type
The style of gauge to use for this indicator.
Preview value
Number used to demonstrate a reading in the gauge preview.
28.
On the Options tab, select the Work Orders tab. On this tab you can:
•
Have APM automatically include the indicator on all work order tasks that are created for this asset or for this asset and its child assets.
•
Have APM take “snapshots” of indicators for the asset that is being worked on for a work order task. This means that APM records the current state of the indicator at the time that the work order task is created, when it is closed, or both when it is created and closed. Select the appropriate options in the Snapshots and Snapshot timing areas.
29.
When you are finished, save the indicator and close the window. APM adds the new indicator to the asset.