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.

Note: The text of expressions is case insensitive.

Expression Use

Use CaseDescription
Output TagExpressions 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.
ModeExpressions used in modes must resolve to True or False. Model level values (for example, Estimate) are not available in mode expressions.
Tag RuleExpressions 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 RuleDiagnostic 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

About This Task

When you modify a template and publish it, you create a new version of the template. This allows for the controlled introduction of changes. However, while you may have up to five versions of an analytic template, it is suggested that you limit the number of versions to two: the published version and the previous version.

Procedure

  1. Access an analytic template of the SmartSignal type.
  2. Select Edit.
    Note: You can only modify the latest version of a template. If the current version of the template that you selected is not the latest version, when you select Edit, the Edit Warning window appears, notifying you that the version that you have selected is not the latest. If you want to switch to the latest version to modify the template, complete the following steps:
    1. In the Edit Warning window, select Switch To Latest Version.
      The page refreshes, displaying the latest version of the template.
    2. Select Edit.
    The template is locked for editing, and you can now modify the available fields as needed.
    Note: If the selected template already has five versions, when you select Edit, the template is not locked for editing, the fields are not enabled for editing, and the following message appears: Warning Reached maximum allowed versions (5). Cannot perform this operation.

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.

Procedure

  1. In the page for the analytic template that you want to modify, select the Overview tab.
    Note: You cannot modify the template name.
  2. As needed, modify data in the following subsections:
    SubsectionDescription
    NameThe value in this box cannot be modified.
    DescriptionIn this subsection, you can enter a description for the analytic template.
    Poll Cycle IntervalIn this subsection, you can specify the interval at which data is retrieved from tags used in the analytic template.
    Advance History Queue When No Mode MetIf this toggle is switched to the on position, runtime history queues used in output tag, mode, rule, and diagnostic evaluation are advanced on regardless of whether collected data meets any specified mode condition. If this toggle is switched to the off position, history queues are only advanced if at least one mode condition for the analytic template is met.

    For more information about the history queue, see the History Queue Access section of the About Expressions topic in this documentation.

    NotesIn this subsection, you can enter notes about the analytic template.
  3. When you are ready to publish your changes, in the Publish window, select Publish.
    The analytic template is published, creating a new version of the template.
    Note: If the template does not have any analytic instances associated with it, the version number is not updated.

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.

About This Task

Complete the following steps to modify tag or rule data in any of the following sections:

Procedure

  1. Select a tab to access the section in which you want to modify data.
  2. In the Actions column next to the item that you want to modify, select .

    A window appears in which you can modify data for the selected item.

  3. As needed, modify data in the available fields, and then select Save.
    Tip: For descriptions of each of the fields available in each section, see the SmartSignal Analytic Template Reference section of this documentation.
  4. When you are ready to publish your changes, in the Publish window, select Publish.
    The analytic template is published, creating a new version of the template.
    Note: If the template does not have any analytic instances associated with it, the version number is not updated.

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

The tenant must have been granted access to the SmartSignal Analytic Tag Groups feature and the user must have the SmartSignal Analytic Template access rights to use this functionality.

Procedure

  1. Access an analytic template of the SmartSignal type that you want to modify.
  2. Select the Tag Groups tab, and then select Add a Tag Group.
    The Tag Group configuration window appears.
  3. Enter a tag group name that is unique to associated template.
  4. Select Tag List.
    A list of tags that can be charted in the Analysis view and are are eligible to be added to the group appear.
    Note: A tag that is included in a model can be selected to be included in the tag group.
  5. Select the tag that needs to be included in the tag group.
    Note: A tag is eligible for selection only if it is included in a model.
  6. Select Settings to configure how the tags that are included in the tag group must appear in Analysis.
    Note: The settings that are configured will supersede any tenant or user-defined chart settings when the tag is viewed from the tag group.
  7. Select Diagnostics to choose the diagnostic rules that you want to have associated with the tag group.
  8. Select Column Chooser to control which models appear in the selection table.
  9. Select Save to save the changes made to the tag group.
    Note: A tag group must have a name and at least one tag selected before it can be saved.

Results

The selected tag group is created in the system for the selected analytic template. The next time an analytic instance with Analysis is viewed for this analytic template, the tag group will be available for use. The group will appear only if the corresponding analytic instance has active tags configured for the tags in the group.

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

The tenant must have been granted access to the SmartSignal Analytic Tag Groups feature and the user must have the SmartSignal Analytic Template access rights to use this functionality.

Procedure

  1. Access an analytic template of the SmartSignal type that you want to modify.
  2. Select the Tag Groups tab, and then select the tag group you want to update from the drop-down list box.
    The Tag Group configuration window appears with the selected tag group details.
  3. Select Tag List, and then select or clear the tags included in the tag group as needed.
  4. Select Settings to modify the charts for the tag group as needed.
    Note: The settings that are configured will supersede any tenant or user-defined chart settings when the tag is viewed from the tag group.
  5. Select Diagnostics to modify the diagnostic rules that you want to have associated with the tag group.
  6. Select Column Chooser to modify which models are displayed in the selection table.
  7. Select Save to save the changes made to the tag group.
    Note: You cannot change the name of a tag group and the tag group must have at least one tag selected before it can be saved.

Results

The selected tag group is updated in the system for the selected analytic template. The next time an analytic instance with Analysis is viewed for this analytic template, the tag group will be available for use. The group will appear only if the corresponding analytic instance has active tags configured for the tags in the group.

Delete a Tag Group

In the SmartSignal Analytic Template editor, you can delete tag groups.

Before You Begin

The tenant must have been granted access to the SmartSignal Analytic Tag Groups feature and the user must have the SmartSignal Analytic Template access rights to use this functionality.

Procedure

  1. Access an analytic template of the SmartSignal type that you want to modify.
  2. Select the Tag Groups tab, and then select the tag group you want to delete from the drop-down list box.
    The Tag Group configuration window appears with the selected tag group details.
  3. Select to delete the selected tag group.
    A message appears, asking you to confim that you want to delete the selected tag group.
  4. Select Delete to delete the tag group.
    A message appears, confirming that the selected tag group is deleted.

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.

Procedure

  1. Access an analytic template of the SmartSignal type.
  2. Select the Rule Assignment tab.
    The Rule Assignment section appears, displaying a table containing a list of tags and associated rules.
  3. Optional: If you want to view details for a specific rule, select a rule in the Rule column.
    Note: If a rule appears in blue, the rule is evaluated against the corresponding input tag for all Deployments that are created using the selected Analytic Template. If a rule appears in green, the rule is evaluated against a corresponding model tag for all Deployments that are created using the selected Analytic Template.
    A window appears, displaying the rule name, the tag type, and the rule expression for the selected rule. If you selected a rule that appeared in green, the window also displays the name of the corresponding model tag.

Publish an Analytic Template

Procedure

  1. When you have finished modifying an analytic template, select Publish to publish your changes.
    Tip: If you want to discard your changes, you can select Actions > Discard Changes.
    The Publish window appears.
    Note: If only the diagnostic and tag rules are modified, an option appears, asking you to publish the changes without modifying the existing template version.
  2. Optional: If you want to review your changes before you publish the template, in the Publish window, select Review Changes.

    The Analytic Template Comparison window appears, displaying a table that lists the changes you made.

    Tip: You can select the <number> Modified link to view details comparing your changes to the current version of the template.
  3. When you are ready to publish your changes, in the Publish window, select Publish.
    The analytic template is published, creating a new version of the template.
    Note: If the template does not have any analytic instances associated with it, the version number is not updated.