Analytic Template Management
About Expressions
Expressions are user-defined formulas that are used to define various calculated tag values, mode conditions, tag rules, and diagnostic rules.
Expressions are written in a text-based language that allows access to properties of the items to which the expressions refer, and to a library of functions that operate on these properties. Expressions, when evaluated, always resolve to one value. Depending on where the expression is defined, the resolved value may be Boolean (for example, True), a floating point number, or a priority in the case of diagnostics rules.
Expression Use
Use Case | Description |
---|---|
Output Tag | Expressions are used to define the Actual, and sometimes the Estimate, value of output tags. In both cases, the expression must resolve to a floating point value. |
Mode | Expressions used in modes must resolve to True or False. Model level values (for example, Estimate) are not available in mode expressions. |
Tag Rule | Expressions used in tag rules must resolve to True or False. Since tag rules are not assigned to specific tags, a placeholder keyword, Tag, is used within the expression. |
Diagnostic Rule | Diagnostic rules must resolve to a priority. The only way to get a priority value is to make a call to the Priority or None function. The functions AssetIndications, ModelIndications, and IsAssociated are available to diagnostics. |
History Queue Access
It is possible to access a collection of past values for certain properties. Various functions that are available take collections of values as parameters, and history queues can be used as inputs. You can access the history values by adding open and closed parentheses after the property name with an integer between them to indicate the number of values to return. For example, Tag1.Actual(5)
provides the most recent five actual values for Tag1. Below is a list of properties that are available in expressions:
- Actual
- SmoothedActual
- Estimate
- Residual
- ResidualIndicationNegative
- ResidualIndicationPositive
- ResidualSmoothed
Lock an Analytic Template of the SmartSignal Type for Editing
You can modify an analytic template of the SmartSignal type natively in APM.
Before You Begin
- Ensure that the latest version of the template that you want to modify is defined as the current version. For example, if you have three versions (1.0.0, 2.0.0, and 3.0.0), ensure that version 3.0.0 is defined as the current version.
- You can only have five versions of a template. If the template that you want to modify already has five versions, you must delete an existing version before you modify the template.
About This Task
Procedure
Modify the Overview Data for an Analytic Template of the SmartSignal Type
Complete the following steps to modify data in the Overview section of the page for an analytic template of the SmartSignal type.
Before You Begin
Lock for editing the analytic template that you want to modify.
Procedure
What To Do Next
Synchronize associated deployments with the new version of the template.
Modify Tags and Rules Used in Analytic Templates of the SmartSignal Type
Complete the following steps to modify data for an analytic template of the SmartSignal type.
Before You Begin
Lock for editing the analytic template that you want to modify.
About This Task
Complete the following steps to modify tag or rule data in any of the following sections:
Procedure
What To Do Next
Synchronize associated deployments with the new version of the template.
Create a Tag Group
In the SmartSignal Analytic Template editor, you can create tag groups. These groups are used when performing analysis of an analytic instance. Tag groups are associated with an Analytic Template; however they are not part of the template. You can save changes to tag groups without having to publish a change to the template.
Before You Begin
Procedure
Results
Update a Tag Group
In the SmartSignal Analytic Template editor, you can create and update tag groups. You can save changes to tag groups without having to publish a change to the template.
Before You Begin
Procedure
Results
Delete a Tag Group
In the SmartSignal Analytic Template editor, you can delete tag groups.
Before You Begin
Procedure
Access Rule Assignments
You can view the rule assignments for an Analytic Template of the SmartSignal type in the Rule Assignment section of the page for a selected Analytic Template.