smartsignal · 2020-07-14 · in ge digital apm, you can use the following smartsignal features:...

SmartSignal

© 2020 General Electric Company

Contents

Chapter 1: Overview 1About SmartSignal 2

Chapter 2: SmartSignal Analytic Templates 3Getting Started 4

Analytic Template Management 12

Analytic Template Versions 17

SmartSignal Expression Syntax 20

Reference 28

Chapter 3: SmartSignal Maintenance 36Overview 37

Getting Started with Analytic Instances 41

Manage Analytic Instances 52

Manage SmartSignal Models 57

Model Training Data Charts 67

SmartSignal Maintenance Reference 77

Chapter 4: SmartSignal Deployments 82Access the Processing Status of SmartSignal Analytic Instances 83

Configure Email Notification Preferences 83

Validate Analytics with Asset Tags 84

Chapter 5: Configuration 86Overview 87

Permissions 87

Hosts 89

Tenants 90

Importing SmartSignal Classic Assets 94

Mapping to GED IMS Installation 97

ii SmartSignal

Chapter 6: Reference 100Template Tag Field Descriptions 101

SmartSignal Expression Syntax 114

Instance Tag Field Descriptions 178

SmartSignal Glossary 183

Chapter 7: Release Notes 184Third Quarter of 2020 185

Second Quarter of 2020 185

First Quarter of 2020 187

Fourth Quarter of 2019 189

Third Quarter of 2019 189



Fourth Quarter of 2018 193

Third Quarter of 2018 195



iii

Copyright GE Digital© 2020 General Electric Company.

GE, the GE Monogram, and Predix are either registered trademarks or trademarks of All other trademarksare the property of their respective owners.

This document may contain Confidential/Proprietary information of and/or its suppliers or vendors.Distribution or reproduction is prohibited without permission.

THIS DOCUMENT AND ITS CONTENTS ARE PROVIDED "AS IS," WITH NO REPRESENTATION ORWARRANTIES OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TOWARRANTIES OF DESIGN, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. ALL OTHERLIABILITY ARISING FROM RELIANCE UPON ANY INFORMATION CONTAINED HEREIN IS EXPRESSLYDISCLAIMED.

Access to and use of the software described in this document is conditioned on acceptance of the EndUser License Agreement and compliance with its terms.

iv © 2020 General Electric Company

Chapter

1OverviewTopics:

• About SmartSignal

© 2020 General Electric Company 1

About SmartSignalSmartSignal is a proven industrial equipment monitoring and reliability ecosystem that has been in theequipment analytics and machine learning spaces for over 10 years.

SmartSignal's predictive analytics identify impending equipment failures and their causes well before theyhappen, often weeks or months before other systems, so the focus of operations can shift from costlyreactive maintenance to efficient planned maintenance.

In GE Digital APM, you can use the following SmartSignal features:

Feature Description

Analytic template editing Create and maintain templates that define analytic instances.

SmartSignal Maintenance Manage SmartSignal analytic instances and models, including modifying analyticinstance and model configuration and managing training data.

SmartSignal Deployments Monitor and troubleshoot SmartSignal analytic deployments.

In addition to the preceding features, you can also modify your SmartSignal configuration using thefollowing administrative features:

• SmartSignal Assets• SmartSignal Hosts• SmartSignal Mappings• SmartSignal Tenants

2 © 2020 General Electric Company

Chapter

2SmartSignal Analytic TemplatesTopics:

• Getting Started• Analytic Template Management• Analytic Template Versions• SmartSignal Expression Syntax• Reference


Getting Started

About Analytic Templates of the SmartSignal TypeAn analytic template of the SmartSignal type is an analytic orchestration that includes asset informationin the form of available Tags, Key Performance Indicators, and Failure Modes. A tag refers to a sensor orcalculated value that is part of an analytic template.

An analytic template of the SmartSignal type also provides the additional configuration informationrequired to enable the advance reliability management features provided by the APM SmartSignalruntime. This runtime provides support for predictive diagnostics that utilize similarity and variable-basedmodeling techniques as well as a rich function library for doing advanced calculations and a proprietarydiagnostic expression language that supports complex rule generation used to identify fault conditions.

Access an Analytic Template of the SmartSignal TypeYou can access a analytic template of the SmartSignal type from either the Analytics module or theSmartSignal Maintenance module.

Procedure

1. Choose one of the following options:Choice Description

Access from the Analytics module a. In the module navigation menu, select Analytics >Analytics Templates.

b. In the menu, select the analytic template that you wantto access.

The workspace displaying a summary of theselected template appears.

c. Select the SmartSignal link.

Access from the SmartSignal Maintenance module a. In the module navigation menu, select SmartSignalMaintenance, and then select the analytic instanceassociated with the template that you want to access.

b. Select the Analytic Info link.

The page displaying details about the selected analytic template of the SmartSignal type appears in anew browser tab.

2. Select one of the following tabs to view analytic template details.Tab Name Description

Overview Displays basic information about the analytic template.

Input Tags Displays a grid containing input tag data.

Output Tags Displays a grid containing output tag data. You can select atag name to view the output tag expression.

Constant Tags Displays a grid containing constant tag data.

Modes Displays a grid containing modes data. You can select a modename to view the mode expression.

Models Displays a grid containing model data. You can select a modelname to view model details.

Model Tags Displays a grid containing model tags data.


Tab Name Description

Diagnostic Rules Displays a grid containing diagnostic rules data. You canselect a rule name to view the rule expression.

Tag Rules Displays a grid containing tag rules data. You can select a rulename to view the rule expression.

Rule Assignment Displays a grid containing rule assignments for the template.

Create a New Analytic Template of the SmartSignal TypeComplete the following steps to create a new analytic template of the SmartSignal type natively in GEDigital APM.

Procedure

1. In the module navigation menu, go to Analytics > Analytics Templates.

2. Select .The New Analytic workspace appears.

3. In the Runtime Type drop-down list box, select SmartSignal.

In the Template Details section, boxes appear in which you can enter information for the analytictemplate that you want to create.


4. In the Name box, enter a name for the analytic template.5. In the Owner box, enter a name for the owner of the analytic template.6. In the Primary Category drop-down list box, select any option.

Note: Supervised Learning is the option typically used to categorize analytic templates of theSmartSignal type.

7. Select Submit.

Results

• The new template is automatically published as version 1.0.0.• The page displaying details about the new analytic template appears.

Next Steps

No deployments are available for the new template yet. To enable deployments, you must first configuretags and rules used in the template.


Duplicate an Analytic TemplateIf you want to create a new analytic template that is similar to an existing template, you do not need toreproduce all of the similar data. Instead, you can copy an existing template and modify the copy asneeded.

Procedure

1. In the module navigation menu, go to Analytics > Analytics Templates.2. In the list of templates, select the template of the SmartSignal type that you want to copy.

The workspace for the selected template appears.3. In the workspace, select the SmartSignal link.

The page displaying details about the selected template appears in a new tab.4. In the drop-down list box, select Duplicate Analytic Template.

The Duplicate Analytic Template window appears, displaying the default name for the copy of thetemplate in the following format: <Template_Name>_copy.

5. Optional: As needed, modify the template name.

Note: Ensure that the template name is unique.6. Optional: If you want to access the duplicated template for editing immediately after you create it,

select the Go to the duplicated template for editing box.7. Select Duplicate.

Results

• The template is copied, and you can access the copy in the list of templates that appears in theAnalytics Templates page.

Tip: In order to see the new template in the list of templates that appears in the Analytics Templatespage, you must refresh the template list.

• If you selected the Go to the duplicated template for editing box, the duplicated template appearsin the current page.

Next Steps

Modify the duplicate template as needed.

Export an Analytic TemplateYou can export an analytic template as a .zip file. This may be useful if, for example, you created atemplate in one tenant, and you want to reuse it in another tenant. In this scenario, you could export thetemplate from the first tenant and then import it in the second.

About This Task

When you export an analytic template, only published changes for the current version of the template areexported.

Procedure

1. Access an analytic template of the SmartSignal type.2. In the Actions menu, select Export Analytic.

Note: If you were modifying the template prior to exporting it, but you had not yet published yourchanges, a message appears, notifying you that only published changes will be exported and asking


you to confirm whether you want to proceed. If you want to proceed without your most recentchanges, select Export. If you want to discard or publish your changes before exporting, select Cancel.

The analytic template is exported as a .zip file.

Sync Analytic Templates and Analytic Instances

Sync an Analytic Template across Multiple Analytic Instances

If an analytic template used by multiple analytic instances is modified to create a new version, you maywant to update some or all of the analytic instances associated with that template simultaneously. In thisscenario, complete the following steps to sync an analytic template across multiple analytic instances.

Before You Begin

Ensure that none of the analytic instances that you want to update is being edited by another user. Ifanother user has locked a analytic instance for editing, you can take edit control from that user.

Procedure

1. Access an analytic template of the SmartSignal type.2. Select Actions > Update Deployments.

The Analytic template synchronization for <Analytic Template> window appears.


3. In the window, select the check box next to each analytic instance that you want to sync with theanalytic template, and then select Start Updates.The sync job begins. Once the job is successfully completed, the selected analytic instances are syncedwith the selected analytic template.

4. Optional: If you want to view the status of the sync job, select the Job Details link.The SmartSignal Deployments page appears, displaying the Job Status section. The Status columnfor the sync job that you started displays one of the following values: success or fail.

5. Optional: If the job failed and you want to view the reason for the failure, select the fail link.A window appears, displaying information about the job failure.

Sync an Analytic Instance with an Analytic Template Version

You can sync an analytic instance in SmartSignal Maintenance with an analytic template version added inthe Analytics Templates page or the SmartSignal Analytic page.

Before You Begin

Add a new version of an analytic template in the Analytics Templates page or the SmartSignalAnalytic page.

Procedure

1. Lock for editing the analytic that you want to modify.

2. In the Actions box, select Health > Analytic Template Sync.The Select Analytic Template Version window appears.

3. In the Version drop-down list box, select the template version that you want to use, and then selectContinue.The Confirm Changes to Analytic Instance window appears displaying a message that indicateswhether the selected version contains structural changes.

Note: SmartSignal only supports synchronization of an analytic instance with an analytic templatecontaining structural changes if the analytic template was added using a transfer file. If you attempt tosynchronize an analytic instance with an analytic template containing structural changes that was notadded using a transfer file, the Confirm Changes to Analytics Instance window displays an errormessage.

4. Select Continue.A progress bar appears. When the instance is updated, the screen refreshes, and the updated data forthe selected version appears in the table.

5. Confirm that all data appears as expected.

6. When you have finished making changes, select Deploy, and then, when prompted to confirm thedeployment, select Deploy again.

Note: If you want to undo your changes, you can select Discard Changes in the Actions menu.

A notification appears when your changes have been deployed successfully.

Sync an Individual Tag Value with the Template

If you modified a field value in a tag within an analytic instance, the cell for that value is highlighted in thetable for that analytic instance. If you want to replace your customized field value in the analytic instancewith the value in the template, you can sync that specific value without syncing the entire analyticinstance.

Procedure



2. Optional: If the column containing the value that you want to sync is not already displayed, select ,

then select the check box next to the column that you want to display, and then select to close theColumn Chooser window.The specified columns are displayed.

When you access an analytic instance, cells in the following columns with modified values are highlightedin yellow, and the values in the cells appear in bold font:

Units Standard Units Actual High

Actual Low Adaptation High Adaptation Low

Decimals Step High Step Low

In the table for a model, the following additional columns use this formatting:

Alarm Type Residual (Positive)

Residual (Negative) Filter High

Filter Low Flatline Number

Is Driver Is Independent

Outlier (Negative) Outlier (Positive)

Residual Variance Spike Sensitivity

SPRT (Negative) SPRT (Positive)

Note: While you cannot modify values in the Residual Variance and Decimals columns in GE DigitalAPM, if you imported the analytic from SmartSignal Classic, the value could have been modified inSmartSignal Classic before you imported it.3. Hover over the cell that you want to sync with the template.

The Value is Customized window appears, displaying the template value and the instance value aswell as a message indicating that the value is customized and will not be synced with changes to theanalytic template.

Note: If no value appears next to Template Value or Instance Tag Value, that means avalue for that cell was not specified in the template or instance, respectively.

4. Select Sync to Template.The value in the specified cell is updated to match the value in the template.

Note: If you synced standard units which had been previously modified with the Convert ThresholdValues toggle switched to the on position, any threshold values associated with that tag that are stillsynced with the template are also updated to match the new standard unit. However, if you modified athreshold value in the instance, that value is not updated when you sync the standard units. If youwant to sync a modified threshold value with the template, you must sync it separately.

Reorder Tags in an Analytic Template

Procedure

1. Access an analytic template of the SmartSignal type.2. In the Actions menu, select Charting > Reorder Tags.

The Drag and drop to reorder tags window appears.3. Choose one of the following methods to reorder tags:


Choice Description

Drag and drop Drag and drop tags to arrange them in the order in which youwant them to appear.

Order by default position In the Order By box, select Default Position to arrange thetags by their default position, that being the order in whichthe tags were added to the analytic template.

Order by name In the Order By box, select Name to arrange the tags inalphabetical order.

4. When you have finished reordering tags, select Save.The tags are reordered and appear in the specified order in the page for modifying the analytictemplate.

Reorder Tag Groups in an Analytic TemplateIn the SmartSignal Analytic Template editor, when more than one group is included, you can define theorder in which the tag groups should be displayed in Analysis.

Before You BeginThe tenant must have been granted access to the SmartSignal Analytic Template Edit access rights to usethis functionality.

Procedure

1. Access an analytic template of the SmartSignal type.2. In the Actions menu, select Charting > Reorder Tag Groups.

The Drag and drop to reorder tag groups window appears.3. Choose one of the following methods to reorder tags:

Choice Description

Drag and drop Drag and drop tag groups to arrange them in the order inwhich you want them to appear.

Order by default position In the Order By box, select Default Position to arrange thetag groups by their default position, that being the order inwhich the tag groups were added to the analytic template.

Order by name In the Order By box, select Name to arrange the tag groups inalphabetical order.

4. When you have finished reordering tag groups, select Save.The tag groups are reordered and appear in the specified order when displayed.

Configure Fixed Scale Charting by Mode in an Analytic Template

About This Task

Note: This action will only be enabled when the published template has more than one mode defined.

Procedure

1. Access an analytic template of the SmartSignal type.2. In the Actions menu, select Charting > Fixed Scale by Mode.

The Fixed Scale by Mode window appears.3. In the fields corresponding to the tags you want to control the Y-Chart Axis, set either the Min and/or

Max value. If your template is defined with multiple MODES, then you can overwrite the setting at theMODE level. This allows you to have a different fixed scale for your model tags based on the mode.


4. When you have finished setting min/max values for your tags, select Save.

Analytic Template Management

About ExpressionsExpressions are user-defined formulas that are used to define various calculated tag values, modeconditions, tag rules, and diagnostic rules.

Expressions are written in a text-based language that allows access to properties of the items to whichthe expressions refer, and to a library of functions that operate on these properties. Expressions, whenevaluated, always resolve to one value. Depending on where the expression is defined, the resolved valuemay 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 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 areavailable take collections of values as parameters, and history queues can be used as inputs. You canaccess the history values by adding open and closed parentheses after the property name with an integerbetween them to indicate the number of values to return. For example, Tag1.Actual(5) provides themost 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 EditingYou can modify an analytic template of the SmartSignal type natively in GE Digital APM.

Before You Begin

• Ensure that the latest version of the template that you want to modify is defined as the currentversion. For example, if you have three versions (1.0.0, 2.0.0, and 3.0.0), ensure that version 3.0.0 isdefined as the current version.

• You can only have five versions of a template. If the template that you want to modify already has fiveversions, you must delete an existing version before you modify the template.

About This Task

When you modify a template and publish it, you create a new version of the template. This allows for thecontrolled introduction of changes. However, while you may have up to five versions of an analytictemplate, it is suggested that you limit the number of versions to two: the published version and theprevious 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 thatyou 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 thelatest version to modify the template, complete the following steps:

a) In the Edit Warning window, select Switch To Latest Version.The page refreshes, displaying the latest version of the template.

b) 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 notlocked for editing, the fields are not enabled for editing, and the following message appears: WarningReached maximum allowed versions (5). Cannot perform this operation.

Modify the Overview Data for an Analytic Template of the SmartSignalType

Complete the following steps to modify data in the Overview section of the page for an analytic templateof the SmartSignal type.

Before You Begin

Lock for editing the analytic template that you want to modify.

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:


Subsection Description

Name The value in this box cannot be modified.

Description In this subsection, you can enter a description for the analytictemplate.

Poll Cycle Interval In this subsection, you can specify the interval at which datais retrieved from tags used in the analytic template.

Advance History Queue When No Mode Met If this toggle is switched to the on position, runtime historyqueues used in output tag, mode, rule, and diagnosticevaluation are advanced on regardless of whether collecteddata meets any specified mode condition. If this toggle isswitched to the off position, history queues are only advancedif at least one mode condition for the analytic template ismet.

For more information about the history queue, see theHistory Queue Access section of the About Expressions topicin this documentation.

Notes In this subsection, you can enter notes about the analytictemplate.

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 isnot updated.

Next Steps

Synchronize associated deployments with the new version of the template.

Modify Tags and Rules Used in Analytic Templates of the SmartSignalType

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:

• Input Tags• Output Tags• Constants• Modes• Models• Model Tags• Diagnostic Rules• Tag Rules

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 AnalyticTemplate Reference section of this documentation.



Next Steps

Synchronize associated deployments with the new version of the template.

Create a Tag GroupIn the SmartSignal Analytic Template editor, you can create tag groups. These groups are used whenperforming analysis of an analytic instance. Tag groups are associated with an Analytic Template; howeverthey are not part of the template. You can save changes to tag groups without having to publish a changeto the template.

Before You Begin

The tenant must have been granted access to the SmartSignal Analytic Tag Groups feature and the usermust 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 groupappear.

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 whenthe tag is viewed from the tag group.

7. Select Diagnostics to choose the diagnostic rules that you want to have associated with the taggroup.

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 ananalytic 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 inthe group.

Update a Tag GroupIn the SmartSignal Analytic Template editor, you can create and update tag groups. You can save changesto tag groups without having to publish a change to the template.

Before You Begin


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 whenthe tag is viewed from the tag group.

5. Select Diagnostics to modify the diagnostic rules that you want to have associated with the taggroup.

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 tagselected before it can be saved.

Results

The selected tag group is updated in the system for the selected analytic template. The next time ananalytic 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 inthe group.

Delete a Tag GroupIn the SmartSignal Analytic Template editor, you can delete tag groups.

Before You Begin


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 AssignmentsYou can view the rule assignments for an Analytic Template of the SmartSignal type in the RuleAssignment 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 allDeployments that are created using the selected Analytic Template. If a rule appears in green, the ruleis evaluated against a corresponding model tag for all Deployments that are created using the selectedAnalytic Template.

A window appears, displaying the rule name, the tag type, and the rule expression for the selectedrule. If you selected a rule that appeared in green, the window also displays the name of thecorresponding 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.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 youmade.

Tip: You can select the <number> Modified link to view details comparing your changes to thecurrent version of the template.



Analytic Template VersionsWhen you access an analytic template, a version number appears under the template name. A newtemplate is version 1.0.0. Subsequent version numbers are determined by the degree of changes made tothe template. A change to the first number in the version number indicates a major change to the


template, that is, a structural modification to the template, such as the addition or removal of a tag. If atemplate with a major change is made current, you should review all models associated with thattemplate. A change to a number other than the first one in the version number indicates a minor changeto the template. A minor change, such as a modification to a rule expression, involves no structuralchanges to the template.

Define an Analytic Template Version as CurrentThe current version of an analytic template is the version used when deploying the analytic. If you have ananalytic template with more than one version, you can define which version is the current version.

Before You Begin

Ensure you have more than one version of the analytic template for which you want to define a currentversion. If you have only one version of a template, it is automatically the current version, and theVersion: <version number> menu does not appear in the workspace displaying a summary of theselected analytic template.

About This Task

Note: By default, when a new version of an analytic template of the SmartSignal type is imported orpublished, it is defined as the current version. However, you can complete the following steps to manuallydefine any version as the current version.

Procedure

1. In the module navigation menu, go to Analytics > Analytics Templates.2. Select the template for which you want to define a current version.3. Select the Version: <version number> menu.4. Next to the version that you want to define as the current version, select Make Current.

The current version of the selected analytic template is updated.

Compare Versions of an Analytic TemplateIf you want to see what changes were made to an analytic template, you can compare the currenttemplate version to a previous version.

Procedure

1. Access an analytic template of the SmartSignal type.

Note: To compare template versions, you must access a template for which there are multipleversions.

2. In the Actions menu, select Compare Versions.

The Select version to compare window appears. The displayed version is the current version of theanalytic template.


3. In the Select versions menu, select the version of the template that you want to compare to thecurrent version.

The Analytic Template Comparison window appears, displaying a table in which differencesbetween the two compared versions are listed.

The value in the Sections column corresponds to one of the following tabs:

• Input Tags• Output Tags• Constants• Modes• Models• Model Tags• Diagnostic Rules• Tag Rules• Rule Assignment

If a change was made in any of these sections, a <number> Modified link appears next to the sectionname in the Changes column.

4. To view details about the changes between the versions for any of these sections, select the<number> Modified link next to the section name.


A window appears, displaying the differences between the compared versions for the selected section.5. When you have finished comparing the changes between versions, select OK to close the <Section>

Changes window, and then select Close to close the Analytic Template Comparison window.

Delete a Version of an Analytic Template of the SmartSignal TypeYou can delete analytic template versions in order to ensure that your list of versions remains up to dateand you have fewer than five template versions so that you can create new template versions as needed.

Before You Begin

Define the version of the analytic template that you want to delete as the current version.

Procedure

1. In the module navigation menu, go to Analytics > Analytics Templates.2. Select the template containing the version that you want to delete.3. In the workspace displaying a summary of the selected template, select Delete.

A window appears, asking you to confirm that you want to delete the selected analytic templateversion.

4. To confirm that you want to delete the selected template version, select Delete.The selected template version is deleted.

SmartSignal Expression Syntax

SmartSignal Expression SyntaxSmartSignal Expression Syntax is used in output tags, calculated estimates, mode expressions, ruleconditions, and diagnostic rules.

Types of Expressions

Output Tags: The Output tags are specific types of SmartSignal tag aliases. The input tag aliases receivedata from an external source, the output tags determine their value from a formula. Output tags can beused to derive non-measurable quantities. Other than how the data is acquired, output tags are treatedthe same as a measured quantity for modeling, rules, and diagnostics. A formula is required to evaluate anoutput tag to a numeric value.

Calculated Estimates: Calculated estimates can be used with both input and output SmartSignal tagalias. You can assign a tag with a calculated estimate to a model, evaluate an estimate during the runtime,and leverage by rules and diagnostics just like any other model tag alias. Instead of using SBM/VBMtechnology, a user specified formula will be evaluated to estimate the tag. A formula is required toevaluate the calculated estimate to a numeric value.

Mode Expressions: The mode expression specifies a required condition for modeling. Typically, templateshave one mode of operation and the mode expression determines when the equipment is in operation.Some equipment may have multiple methods of operation and may require multiple modes with uniqueconditions for each method of operation. The mode expression is required to evaluate the modeexpressions to a Boolean value (true or false).

Tag Rules: The tag rules evaluate the behavior of a tag to find a specific condition of interest. A tag rulecan create an alert to notify that the tag behavior meets the specified condition or can be utilized bydiagnostics. The rule condition is required to evaluate the tag rule to a Boolean value (true or false).


Diagnostic Rules: Diagnostics evaluate behavior to find a specific condition. A diagnostic can create analert to notify that the behavior meets the specified condition. Diagnostics are intended to be morepowerful and specific than rules. Diagnostics can specify multiple conditions across multiple tag aliasesfrom any mode or model in the analytic template. Additionally, diagnostics can provide priority escalation(that is, the specification of multiple conditions with a variable importance in one alert).

Operators

Logical Operators

Value Argument

Greater than Argument1 > Argument2

Greater than or equal Argument1 >= Argument2

Less than Argument1 < Argument2

Less than or equal Argument1 <= Argument2

Equal to Argument1 = Argument2

Not equal to Argument1 != Argument2

If( Argurment(T/F) )then result else alternative result //the ( ) are required.

Argument1(T/F) And Argument2(T/F)

Argument1(T/F) Or Argument2(T/F)

!Argument(T/F) //! is not

Mathematical Operators

Value Argument

Addition Argument1 + Argument2

Subtraction Argument1 - Argument2

Negation Argument1

Divide Argument1 / Argument2

Multiply Argument1 * Argument2

Power Argument1 ^ Argument2

Order of Operations

The Operations follow a standard mathematical procedure. The order in which the operations areevaluated can be modified with the use of parenthesis: ( )Tag attributes. Due to the Proficy SmartSignalarchitecture, there are three types of tag attributes:

• Asset tag attributes• Model tag attributes• Internal tag attributes

To access a tag attribute use the syntax: TagAlias.Attribute (For example;Ambient_Temperature.SmoothedActual)


If no attribute is specified while writing a tag alias, *.actual will be assumed for externals andcalculations, whereas *.DefaultValue will be assumed for internal tags.

Analytic Tag Attributes

The Analytic tag attributes are available to all the input and output tags in the template.

Runtime Attributes: The Runtime attributes are established during runtime along with the collectionand processing of data. These attributes will update every time the data is collected. A maximum runtimehistory of 1024 data points are available.

Table 1: Runtime Attributes

Attribute Data Type Description

Actual Float The value collected from the data

historian or evaluated from a formula for

a tag.

Configured Attributes: The Configured attributes are established during model building or maintenance.These attributes will remain constant during runtime and can only be changed by user interaction.

Table 2: Configured Attributes


ActiveInAsset Boolean If the Active in Asset column for the tag

is selected, the value of the ActiveInAsset

attribute is True. If the Active in Asset

column for the tag is not selected, the

value of this attribute is False.

TagAlias String The generic name of the tag that is

established in Blueprint Center.

SourceTag String For external tags, the name of the tag in

the data historian from which Actualvalues will be collected. For calculation,

the field is not used and will be equivalent

to the Tag Alias.

Description String User configured text to describe the

location and purpose of a tag. Will be

displayed in Sentinel charts.

DisplayUnits String User configured text to describe the units

of measure of a tag. Will be displayed in

Sentinel charts.

StandardUnits MeasurementUnit Standardized units of measurement for

the tag to be used for unit conversion of

any tag attribute of float data type.

ActualHigh Float A threshold typically used in rules and

diagnostics representing the maximum

value of the tag for normal operation.



ActualLow Float A threshold typically used in rules and

diagnostics representing the minimum

value of a tag for normal operation.

AdaptationHigh Float A threshold used with automatic

adaptation representing the maximum

value of the tag that can be automatically

adapted into a model.

AdaptationLow Float A threshold used with automatic

adaptation representing the minimum

value of the tag that can be automatically

adapted into a model.

StepHighThreshold Float A threshold typically used in rules and


amount of acceptable instantaneous

change in the positive direction for a tag.

StepLowThreshold Float A threshold typically used in rules and


amount of acceptable instantaneous

change in the negative direction for a tag.

Model Tag Attributes

The Model tag attributes are available to all Input and Output tags in a model. Model tag attributes areavailable to calculated estimates, rules, and diagnostics, and are not available to calculations and modes.

Note: Even if a tag is in multiple models, these attributes are unique to each model.

Table 3: Runtime Attributes

Attribute Name Data Type Description

ActualSmoothed Float The Actual attribute smoothed by the

smoothing algorithm

Estimate Float The SmartSignal estimate of the tag value

for the current operational state of the

equipment.

Residual Float A measurement of the difference

between the current and estimated value

(Actual – Estimate) of the tag.

ResidualSmoothed Float The Residual attributed smoothed of the

tag by the smoothing algorithm

established in the Model tab of the

advanced options of Asset Center.


Attribute Name Data Type Description

ResidualIndicationPositive Float The status of the residual indication of

the tag in the positive direction. This

attribute will

• equal to 1: when there is a residual

indication

• equal to -1: when there is not

residual indication

• equal to 0: when a decision cannot be

made

Residual indication criteria are

established by selection of the AlarmType of the tag.

ResidualIndicationNegative Float The status of the residual indication of a

tag in the negative direction.

• equal to 1: when there is a residual

indication

• equal to -1: when there is not

residual indication

• equal to 0: when a decision cannot be

made

Residual indication criteria are

established by selection of the AlarmType of the tag.



ActiveInModel Boolean If the Active in Model column for the tag

is selected, the value of the ActiveInModel

attribute is True. If the Active in Model

column for the tag is not selected, the

value of this attribute is False.

ResidualNegativeThreshold Float A threshold, typically used in rules and


residual value of a tag for normal

operation in the negative direction.

ResidualPositiveThreshold Float A threshold typically used in the rules and


residual value of a tag for normal

operation in the positive direction.



SPRTNegative Float The negative value for the sensitivity of

the SPRT. This value is multiplied by the

standard deviation of the nominal

residual, which defines the negative

threshold for aggregated SPRT probability

measure, for the creation of residual

indications.

SPRTPostive Float The positive value for the sensitivity of

the SPRT. This value is multiplied by the

standard deviation of the nominal

residual, which defines the positive

threshold for aggregated SPRT probability

measure, for the creation of residual

indications.

ActualMeanReference Float The mean of the actual value of a tag

included in the reference values. This

attribute is automatically evaluated when

creating a state matrix if it has not been

manually overwritten.

ActualStandardDeviationReference Float The standard deviation of the actual

values of a tag included in the reference

values. If it has not been manually

overwritten, this attribute is

automatically evaluated when creating a

state matrix.

ResidualVarianceReference Float The variance of the residual values of a

tag included in the reference values. If it

has not been manually overwritten, this

attribute is automatically evaluated when

creating a state matrix. Residual values

are calculated by modeling the reference

values not included in the state matrix.

StateMatrixMinimum Float The maximum value of a tag in the state

matrix.

StateMatrixMaximum Float The minimum value of a tag in the state

matrix.

OutlierNegative Float A threshold used in runtime representing

the maximum actual value of a tag for

normal healthy operation. Actual values

exceeding this threshold will be replaced

with a NaN for model processing.



OutlierPositive Float A threshold used in runtime representing

the minimum actual value of a tag for

normal healthy operation. Actual values

exceeding this threshold will be replaced

with a NaN for model processing.

IsIndependant Boolean True if the isIndependant column of a

tag is checked otherwise false. When

checked the tag will be treated as an

independent variable in inferential

modeling.

Constant Tag Attributes



DefaultValue Float The value established for the tag in Asset

Center.

FunctionsEach functional input or argument will require a specific data type to be passed to the function. Based onthe arguments of a function, you can decide the data type that is required.

Functional Inputs / Arguments

There are nine data types that can be requested by the various functions. Occasionally, a functional inputrequires a list of inputs.

Data Type Description Example

Boolean A True or False result True, False.

Integer A number without a decimal or fractional

component

-1, 0, 1, 2 ..

Float A number with a decimal or fractional

component

3.14159

String A sequence of text characters. Use of

“ “ will cause all characters between the

double quotes to be interpreted as a

string.

“Hello World”

Model A reference to a model name NA

Tag A reference to a tag alias NA

TagRule A reference to a tag rule name NA


Data Type Description Example

ModelTagRules A reference to a model tag rule name NA

MeasurementUnit A unit of measurement for a tag. It must

make use of a Standard Units Column of

the tag.

Tag.StandardUnits

Unit Conversions

Unit conversions can be done in SmartSignal by making use of the Standard Units columns and the Unitconversion functions specified in the following sections.

A standard unit of the tag should be configured to specify the unit of measure (for example, if thetemperature tag is measured in ºC, the standard units should be set to Celsius). This provides SmartSignala standardized and reconizable format for the units of measure.

While writing SmartSignal syntax, there are two ways to call a unit conversion function.

The first method allows a specific tag attribute to be converted. To use this method, specify a tag followedby the attribute to convert, which is then followed by the unit conversion function of the unit of measure.The attribute should be converted to TagAlias.TagAttribute.UnitConversionFunction.

Unit conversion will be from the unit of measure specified by the standard units of a tag to that of thespecified unit conversion function. If the standard units of a tag are not configured (that is, set to None), orif the standard unit is not in the same unit category as the unit conversion function, then the attribute willnot be converted. Any tag attribute (4) of data type float can be used in unit conversions, such as; Actual,Estimate, Residual, ActualHigh, ActualLow, ResidualPositiveThreshold, or ResidualNegativeThreshold.

The second method allows a quantity to be converted. To use this method, specify the unit conversionfunction of the unit of measure to which the quantity should be converted toUnitConversionFunction ( QuantityToConvert , StandardUnit ), followed by twofunction inputs:

• Quantity to be converted• Standard unit of the quantity

Unit conversion will be from the unit of measure specified by the tag’s standard units to that of thespecified unit conversion function. If the tag’s standard units are not configured (that is set to None), or ifthe standard unit is not in the same unit category as the unit conversion function, then the attribute willnot be converted.


Reference

Input Tag and Output Tag Field DescriptionsThis topic describes the fields that can be viewed in the Input Tag and Output Tag grid.

Column Description

ActionsIn this column, you can select to modify a tag, or you can select to delete atag.

If the tag is configured to generate a calculated value, appears in this column. You

can select to view the formula for the calculation.

Name The name of the tag.

Calculated Estimate Estimate generated by a user defined expression rather than the reference dataselection algorithm.

Description The description of the tag.

Actual High Thresholds used in rules to determine whether data is outside of expected limits.

Actual Low

Adaptation High Upper and lower thresholds used to determine the range of data that can be adaptedinto models from runtime using the auto-adaptation algorithms.

Adaptation Low

Tag ID Automatically generated unique ID for the tag. This value cannot be modified.

Measurement Units The units of measure for the source data of the tag, such as degrees (C) or percentage(%). This is used only as an identifying label and is displayed on the y-axis when thetag is used in model training data charts.

Standard Units The units of measurement for the source data for the tag.

Data Type The data format of the tag. The options are Float, Integer, Boolean, String, or Date. Thedata type cannot be changed once a tag is added and the analytic template is saved.

Tag TypeIf the tag is configured to generate a calculated value, appears in this column. You


Decimal Scale The number of decimal places included in the tag readings. This value is inherited fromtemplates imported from Classic SmartSignal Blueprint Center. It is not used in GEDigital APM and cannot be modified.

Step High Threshold Thresholds used for step-change rules.

Step Low Threshold

Notes Notes about the tag.


Column Description

Chart Y Min Chart Y Min and Max values override default chart automatic scaling on the y-axis.

In other words, by default, analysis charts are automatically scaled on the y-axis basedon tag reading values. For example, if you have a tag with reading values that rangefrom 10 through 30, the bottom of the y-axis in the chart has a value of 10, and thetop of the y-axis has a value of 30. If you prefer to see a chart that starts at 0 and endsat 50 in the y-axis, you can enter 0 in the Chart Y Min column and 50 in the Chart YMax column.

Note: If you imported an analytic template from a SmartSignal Classic blueprint, ifthat blueprint had Chart Y Min and Max values, those values are maintained in GEDigital APM.

Chart Y Max

Constant Tag Field DescriptionsThis topic describes the fields that can be viewed in the Constant Tag grid.

Table 6: Analytic Level Constants

Column Description

ActionsIn this column, you can select to modify a tag, or you can

select to delete a tag.



Data Type The data format for the tag. The options are Float, Integer,Boolean, String, or Date. Once a tag is added and the analytictemplate is saved, you cannot modify the data type.

Default Value The default value for the tag.

Note: For constant tags with a type of Date, no default valuecan be selected.


Table 7: Model Level Constants

Column Description




Mode The mode with which the tag is associated.

Model The model with which the tag is associated.




Column Description




Modes Field DescriptionsThis topic describes the fields that can be viewed in the Modes grid.

Field Purpose



Name The name for the mode analytic template.

Description The description for this mode analytic template.

Expression The expression used to define the mode condition.

Is Valid Boolean value used to determine the validity of the expression.

Notes The notes for this mode analytic template.

Models Field DescriptionsThis topic describes the fields that can be viewed in the Models grid.

Field Purpose



Display Name The name of the model analytic template.


Description Description of the model analytic template.

Estimate Generator A reference data selection algorithm used to generateestimated values. There are two types of estimate generators:

SBM

Similarity Based Model

VBM

Variable Similarity Based Model


Field Purpose

Similarity Operator One of the following algorithms used for modeling:

SSCOP2

A similarity operator used during estimate generation. It ismost useful for auto associative modeling. It tends to be amore fault tolerant than SSCOP3.

SSCOP3

An alternative similarity operator. It provides a smootherestimate of the response variables, and tends to performbetter in inferential modeling cases. However, it is less faulttolerant than SSCOP2 which is why we often assume thatthe predictor (input) variables can be considered good. If itturns out not to be the case, spillover can occur in one ormore of the response variables (inferred variables).

Enable VSG Specifies whether or not virtual signal generation is enabled. IfNaNs and/or outliers are encountered and the number of tagscontaining bad data is below the Maximum % of Bad Tagsthreshold, the system will fill in the missing or bad data formodeled tags with virtual signal data.

Max Percentage of Bad Tags The percentage threshold above which the system inhibitsvirtual signal generation.

Variance Scale Factor A multiplier for the standard deviation of normal residualsignals.

Residual Smoothing - Smoothing Algorithm Moving Average

The simplest of the three smoothing algorithms. It is amoving window technique where the system averages thedata within each window to produce the filtered sample foreach window. Although simple and computationallyefficient, there is an inherent delay in the response of thefilter that is proportional to the window size. Also, thepresence of a spike in the input data will affect the outputsignal for the length of the window size.

Spline

A real-time moving window technique that employs a cubic-spline fit to each of the individual sliding windows. Thespline filter can produce a filtered signal with very littledelay, but this is more computationally expensive. Also, aspike in the input data results in a shift in the output, butthis effect will be short-lived compared to the movingaverage filter.

Olympic

This filter is very similar to the Moving Average filter, butthe system does not use the maximum and minimum datasamples for each window in the calculation of the averagevalue. The resulting filter is very computationally efficientand effective at removing spikes. However, it suffers fromthe same response delay as the Moving Average filter.

Residual Smoothing - Window Size The total window (the number of data points or persistence) touse for smoothing.

Residual Smoothing - Spline A number between 0 and 1, where the value 0 causes thegreatest smoothing and a value of 1 results in no smoothing(the output values equal the input values). A typical defaultvalue is 0.1.


Field Purpose

State Matrix Creation - Down Sample Algorithm One of the following algorithms that is used when creating thestate matrix:

Min Max

This algorithm finds where the maximum and minimumvalues for each tag occur and then uses those samples asthe basis for the state matrix. If the same vector isidentified from two different tags, the redundancy iseliminated. This method provides the minimum number ofvectors in the training matrix.

Vector Ordering

This algorithm is the recommended choice. This algorithmidentifies samples to include in the state matrix by spacingthe magnitudes of each training snapshot. A trainingsnapshot is a data sample containing a reading from eachtag. If the same vector is identified from two different tagsthe redundancy is eliminated. The appropriate targetnumber of observations in the state matrix is entered in theTarget Vectors box. This method is useful for data thatcontains many states and is non-stationary (i.e., the meanof the tags varies over time).

Min Max Split

This method applies the MinMax algorithm to equal-sizedsections of data. This method returns more data than theMinMax method, so you can use this method if the MinMaxmethod does not return enough observations for modeltraining. When this method is selected, the ReferenceData Splits box appears.

Maximum Vectors The maximum number of vectors to include in the state matrix.This option works with models that have auto adaptation. If themaximum vectors are larger than the target vectors, it willincrease the size of the state matrix. For example, if the targetvectors is set to 25 and the maximum vectors is set to 50, thefirst 25 times auto adaptation occurs, the state matrix willbecome larger, then it will stop increasing at 50. If the maximumvectors is smaller than the target vectors, this field will have noeffect.

State Matrix Creation - Target Vectors The number of vectors that will be targeted when the statematrix is created. Used when Vector Ordering is specified in theDownsample Algorithm box.

VBM - Fixed Size LocalD Fixed

The VBM state matrix will contain exactly this many vectors.

Variable

The VBM state matrix will select a number of vectorsbetween the minimum and maximum (below).

Similarity Percentile Threshold used to determine whether or not vectors aredifferent enough from each other to both be considered for theVBM state matrix.

Redundancy Check Time Specifies when redundancy checks are to be executed (e.g.,during runtime or setup of the model).

Reference Data Splits The number of sections to which the MinMax algorithm shouldbe applied. Used when Min Max Split is specified in theDownsample Algorithm box.

Notes Notes about the model analytic template.

Created Date Date the model analytic template was created.

Last Changed Date Date the model analytic template was last modified.


Model Tags Field DescriptionsThis topic describes the fields that can be viewed in the Model Tags grid.

Column Description




Is In Model If selected, this analytic template tag will be included as part ofthe model blueprint. The collection of model-specific settingsand data for this tag are collectively referred to as a model tag.



Alarm Type Defines the algorithm used to trigger residual indications.

None

Disables residual indications for the residual signal for thetag.

SPRT

This is a specialized decision algorithm called theSequential Probability Ratio Test (SPRT). The system canapply it when the residuals are normally distributed andserially uncorrelated. The algorithm uses a statisticalhypothesis testing technique to determine if the mean ofthe residual has shifted in the positive or negative direction.

Residual Threshold

This is the default value. It triggers a residual indication ifthe residual signal of the tag exceeds the value in thePositive Residual Threshold column or falls below the valuein the Negative Residual Threshold column.

Smoothed Residual Threshold

Triggers a residual indication if the smoothed residual signalof the tag exceeds the value in the Residual + Thresholdcolumn or falls below the value in Residual - Thresholdcolumn. This method is used to remove spike data andnoise from the residuals.

Is Independent Inferential models use an observation of measured signal valuesto generate one or more estimated signal values not present inthe observation of measured signal values. When using thismethod, this field indicates whether the independent variablesshould represent all of the drivers for the dependent outputvariables.

Is Driver Any tags with this selected will be looked at to determine if anew operating state is occurring to trigger auto adaptation. Atleast one tag must be checked to enable auto-adaptation.

Residual Variance Used to set a custom value of residual variance for use by theSPRT algorithm. If not set, each Asset will use the variance if theresidual across its training data. Do not change this settingwithout fully understanding what it does.

Negative Outlier Threshold Threshold used for outlier rules.

Positive Outlier Threshold Threshold used for outlier rules.


Column Description

Negative Residual Threshold The maximum absolute value allowed for a negative residual(i.e., when the estimate is below the actual for a signal). Seedetails in the Alarm Type column.

Positive Residual Threshold The maximum absolute value allowed for a positive residual (i.e.,when the estimate is above the actual for a signal). See detailsin the Alarm Type column.

Negative SPRT Sensitivity The negative values for the sensitivity of the SPRT. This value ismultiplied by the standard deviation of the residual, which inturn defines the amount of negative change in the residualmean that must occur to constitute an alarm.

Positive SPRT Sensitivity The positive values for the sensitivity of the SPRT. This value ismultiplied by the standard deviation of the residual, which inturn defines the amount of positive change in the residual meanthat must occur to constitute an alarm.

Model Tag Display Name The display name of the tag.

Data Type The data format for the tag. The options are Float, Integer,Boolean, String, or Date.

Tag Type The type of tag (i.e., Input, Output, or Constant).


Filter High The upper filtering threshold. This field sets the upper thresholdvalue for filtering of tag signals to remove data outside thenormal operating range. Any tag data greater than this value isconsidered an outlier. Outliers will be filtered out of trainingdata.

Filter Low The lower filtering threshold. This field sets the lower thresholdvalue for filtering of tag signals to remove data outside thenormal operating range. Any tag data less than this value isconsidered an outlier. Outliers will be filtered out of trainingdata.

Flat Line Number If the data for this tag remains at the same level for more thanthis number of data points, the data will be considered to be flatlined, and will be filtered out of training data.

Spike Sensitivity The sensitivity of the spike detection algorithm used to detectspikes in tag signals. A higher value will detect more spikes, butmay also generate false positives. Spike data will be filtered outof training data. Do not change this setting without fullyunderstanding what it does.

Notes The notes for the tag.

Diagnostic Rules Field DescriptionsThis topic describes the fields that can be viewed in the Diagnostic Rules grid.

Field Purpose



Name The name for the diagnostic rule.




Field Purpose

Startup Suppression Poll Cycles Specifies the number of poll cycles the rule will be suppressed(that is, not evaluated) after the asset enters a new mode.

Active Boolean values that determines whether the tag is active orinactive.

Description The description for the diagnostic rule.

Notes The notes for the diagnostic rule.

Tag Rules Field DescriptionsThis topic describes the fields that can be viewed in the Tag Rules grid.

Field Purpose



Display Name Displays the name of the rule. A green check mark displayednext to the name field indicates that the item is ready to beused. A yellow triangle indicates that the rule is not ready to beused. Hover over the yellow triangle to see which information ismissing from the rule.

Description A description for this rule.

Mnemonic Abbreviation used to identify the rule to assist with referencesin diagnostics rules.

Suppression Poll Cycle Specifies the number of poll cycles the rule will be suppressed(that is, not evaluated) after the asset enters a new mode.

Priority The priority of the rule; affects display of advisories in theapplication.

Message Configures the message that will appear for the advisory. Thereare four options that can be displayed in the message: SourceTag, Description, Alias, and Asset.


Notes Notes for this rule.


Chapter

3SmartSignal MaintenanceTopics:

• Overview• Getting Started with Analytic

Instances• Manage Analytic Instances• Manage SmartSignal Models• Model Training Data Charts• SmartSignal Maintenance

Reference


Overview

About SmartSignal MaintenanceIn the SmartSignal Maintenance module, you can access and modify the SmartSignal analytic instance(that is, SmartSignal analytics that have been mapped to GE Digital APM assets) and models in yoursystem.

Access an Analytic InstanceYou can view and modify the details associated with the analytic instances, modes, and models in theSmartSignal Maintenance module.

Procedure

1. In the module navigation menu, go to SmartSignal Maintenance.2. In the Analytic Instances pane, navigate to an analytic instance in the hierarchy, and then select the

name of the analytic instance, mode, or model that you want to access.3. To search for a specific analytic instance, mode, or model, specify the search criteria in the Search...

box, and then press Enter.

Tip:

• Select in the hierarchy header to show hierarchy filter options.• To access a list of analytics that you have locked for editing, switch the My Locks toggle to the on

position.• To access a list of the SmartSignal analytic instances, switch the SmartSignal toggle to the on

position.• To refresh the hierarchy in the Analytic Instances pane, select .• To view the hierachy in a list format or a hierarchical format, select or , respectively.

Note:

◦ Based on the performance of the GE Digital APM system, the results that appear by specifyingthe following filter criteria are rendered directly in the hierarchical format.

◦ My Locks toggle◦ SmartSignal toggle◦ Search... box

◦ and icons do not always appear when you access the Analytic Instances pane. The iconsappear based on the number of levels in the hierarchy and the network connection speed.


◦ and icons appear in the hierarchy and indicate that the model filters and model statematrix are out-of-date.

4. To close the Analytic Instances pane, select , or select an area of the page outside of the pane.

Results

The page for the selected analytic instance, mode, or model appears, displaying information used toconfigure the analytic.

Access the Analytic Template or Asset Associated with an AnalyticInstance

You can access the SmartSignal analytic template or GE Digital APM asset associated with an analyticinstance.

Procedure

1. Access the analytic instance.2. Perform one of the following steps:

• If you want to access the SmartSignal analytic template associated with the instance, selectAnalytic Info.The SmartSignal Template page appears in a new tab, displaying the details of the SmartSignalanalytic template associated with the analytic instance.

• If you want to access the GE Digital APM asset associated with the instance, select APM Asset.The APM Asset page appears in a new tab, displaying the details of the GE Digital APM assetassociated with the analytic instance.

Sync Analytic Templates and Analytic Instances

Sync an Analytic Template across Multiple Analytic Instances

If an analytic template used by multiple analytic instances is modified to create a new version, you maywant to update some or all of the analytic instances associated with that template simultaneously. In thisscenario, complete the following steps to sync an analytic template across multiple analytic instances.

Before You Begin

Ensure that none of the analytic instances that you want to update is being edited by another user. Ifanother user has locked a analytic instance for editing, you can take edit control from that user.

Procedure

1. Access an analytic template of the SmartSignal type.2. Select Actions > Update Deployments.

The Analytic template synchronization for <Analytic Template> window appears.


3. In the window, select the check box next to each analytic instance that you want to sync with theanalytic template, and then select Start Updates.The sync job begins. Once the job is successfully completed, the selected analytic instances are syncedwith the selected analytic template.

4. Optional: If you want to view the status of the sync job, select the Job Details link.The SmartSignal Deployments page appears, displaying the Job Status section. The Status columnfor the sync job that you started displays one of the following values: success or fail.

5. Optional: If the job failed and you want to view the reason for the failure, select the fail link.A window appears, displaying information about the job failure.

Sync an Analytic Instance with an Analytic Template Version

You can sync an analytic instance in SmartSignal Maintenance with an analytic template version added inthe Analytics Templates page or the SmartSignal Analytic page.

Before You Begin

Add a new version of an analytic template in the Analytics Templates page or the SmartSignalAnalytic page.

Procedure



2. In the Actions box, select Health > Analytic Template Sync.The Select Analytic Template Version window appears.

3. In the Version drop-down list box, select the template version that you want to use, and then selectContinue.The Confirm Changes to Analytic Instance window appears displaying a message that indicateswhether the selected version contains structural changes.

Note: SmartSignal only supports synchronization of an analytic instance with an analytic templatecontaining structural changes if the analytic template was added using a transfer file. If you attempt tosynchronize an analytic instance with an analytic template containing structural changes that was notadded using a transfer file, the Confirm Changes to Analytics Instance window displays an errormessage.

4. Select Continue.A progress bar appears. When the instance is updated, the screen refreshes, and the updated data forthe selected version appears in the table.

5. Confirm that all data appears as expected.

6. When you have finished making changes, select Deploy, and then, when prompted to confirm thedeployment, select Deploy again.



Sync an Individual Tag Value with the Template

If you modified a field value in a tag within an analytic instance, the cell for that value is highlighted in thetable for that analytic instance. If you want to replace your customized field value in the analytic instancewith the value in the template, you can sync that specific value without syncing the entire analyticinstance.

Procedure


2. Optional: If the column containing the value that you want to sync is not already displayed, select ,

then select the check box next to the column that you want to display, and then select to close theColumn Chooser window.The specified columns are displayed.

When you access an analytic instance, cells in the following columns with modified values are highlightedin yellow, and the values in the cells appear in bold font:

Units Standard Units Actual High

Actual Low Adaptation High Adaptation Low

Decimals Step High Step Low

In the table for a model, the following additional columns use this formatting:

Alarm Type Residual (Positive)

Residual (Negative) Filter High

Filter Low Flatline Number

Is Driver Is Independent

Outlier (Negative) Outlier (Positive)


Residual Variance Spike Sensitivity

SPRT (Negative) SPRT (Positive)

Note: While you cannot modify values in the Residual Variance and Decimals columns in GE DigitalAPM, if you imported the analytic from SmartSignal Classic, the value could have been modified inSmartSignal Classic before you imported it.3. Hover over the cell that you want to sync with the template.

The Value is Customized window appears, displaying the template value and the instance value aswell as a message indicating that the value is customized and will not be synced with changes to theanalytic template.

Note: If no value appears next to Template Value or Instance Tag Value, that means avalue for that cell was not specified in the template or instance, respectively.

4. Select Sync to Template.The value in the specified cell is updated to match the value in the template.

Note: If you synced standard units which had been previously modified with the Convert ThresholdValues toggle switched to the on position, any threshold values associated with that tag that are stillsynced with the template are also updated to match the new standard unit. However, if you modified athreshold value in the instance, that value is not updated when you sync the standard units. If youwant to sync a modified threshold value with the template, you must sync it separately.

Getting Started with Analytic Instances

About Analytic InstancesAn analytic instance, also known as an analytic deployment, typically represents a piece of equipment,but it can also refer to a system. The instance uniquely identifies, and is the container of, modes andmodels. Additionally, the analytic instance is an instance of an analytic template of the SmartSignal type,inheriting tags and rules from the template.

Access Analytic Instance HistoryWhen you access a SmartSignal analytic instance, you can view the history of actions taken regarding theselected instance, and you can also export the analytic instance history to an .xls file.

Procedure

1. Access a SmartSignal analytic.2. In the Actions menu, select Changes > View Instance History.

The Analytic Instance History window for the selected instance appears, displaying a tablecontaining details about actions taken regarding the analytic instance during the dates specified in thedate boxes.


The View Instance History window displays details for a variety of actions that can be takenregarding an analytic instance, including the following actions:

• Deploying or discarding changes• Synchronizing an instance with a template version• Activating or inactivating an instance• Locking an instance for editing• Importing an instance from a SmartSignal Classic transfer file

3. Optional: If you want to view the history for a different date range, in the date boxes, enter or selectthe dates for which you want to view the history, and then select Get History.

Note: If you are using Internet Explorer 11, instead of the calendar functionality that appears in otherbrowsers, a drop-down list box appears in which you can select one of the following values:

• 7 days• 30 days• 180 days• 365 days• All

4. Optional: If you want to specify which columns appear in the window, select , and then, in theColumn Chooser window, modify the selections as needed.

5. Optional: If you want to export an .xls file containing the data displayed in the Analytic Instance

History table, select .

Generate Sensor Health ReportIn the SmartSignal Maintenance module, you can generate a report to indicate if the sensors are notworking as expected or producing any bad quality data.

Procedure

1. Access a SmartSignal analytic.

2. In the Actions menu, select Health > Sensor Health Report.

If there are no existing reports, then the Generate Sensor Health Report window appears for you tospecify the report parameters.


The report will be generated based on the following parameters:

Report Parameter Description

DATE RANGE The report uses the tag data that has been processed by theanalytic (i.e., observations) over the specified date range.

% NAN The percentage tag values that are NAN (i.e., Not A Number)that can be tolerated before it is added to the Watch list.

% FLATLINE The percentage tag values that are flat-lined (i.e., is notchanging) that can be tolerated before it is added to theWatch list.

% OUTLIER The percentage of tag values that are outside actual high/lowlimits that can be tolerated before it is added to the Watchlist.

3. Select Generate.

The job starts and a progress bar appears that provides the status of the steps performed in the reportgeneration process. The duration of the job depends on the date range specified and the number oftags that are active. After the report is generated, the report is displayed in a table that is divided intothree rating sections (i.e., Watch, Warn, Good). You can change the sequence of the rating with thehelp of the Rating button. You can also expand and collapse each section by selecting the Rating bar.

The generated report contains the following columns.

Column Name Description

Tag The tag alias name.

Source Tag The time series link of the tag.


Units The units of measurement for the source data of the tag.



Confidence A high percentage indicates confidence in the quality of thetag. A lower percentage indicates that the tag may havequality issues.

The percentage is calculated using a combination of thefollowing:

a. The thresholds given for percentage of NaN, Flat-line, andOutlier.

b. The tag's estimates are closely matching the sensorvalues (for the tags that are modeled).

Within 5% of Actual The percentage of tag values, where the estimated value iswithin 5% of the actual value.

% NaN The percentage tag values that are NaN (i.e., Not A Number).

% Flatline The percentage tag values that are flat-lined (i.e., is notchanging).

% Outlier The percentage of tag values that are outside actual high/lowlimits.

4. Select to export an .xls file containing the data displayed in the report.5. Select Close after the review is complete.

Generate Diagnostic Coverage ReportIn the SmartSignal Maintenance module, you can generate a report that indicates how well the diagnosticrules defined in the template are being covered by this instance.

Procedure

1. Access a SmartSignal analytic.2. In the Actions menu, select Health > Diagnostic Coverage Report.

The Diagnostic Coverage Report window appears for you to specify the report parameters.

The report will be generated based on the following parameters:

Report Parameter Description

Ignore inactive models By default, the report will not include inactive models whendetermining rule coverage by excluding the inactive models inreport. You can clear this check box to see the coverage usingall models defined in the template.

Note: If the analytic instance is locked for editing, the report will be generated based on theconfiguration details of the locked instance.

Tip: If you want to generate the report based on the configuration details of the deployed instance,select the Show Deployed Report check box.

3. Select Generate.


The job starts and a progress bar appears that provides the status of the steps performed in the reportgeneration process. After the report is generated, the report is displayed in a table that is divided intothree sections (i.e., Fully Covered, Partially Covered, Not Covered). You can use the check box aboveeach section to filter the diagnostic rules that appear in the grid below. You can also expand andcollapse each diagnostic rule to see the underlying contributing tags.

The generated report contains the following columns.


Diagnostic Rule Name The name of the diagnostic rule as defined in thecorresponding analytic template.

Tag Alias The tag alias name.

P1 – P5 Visual indication of each priority level configured in the ruleand whether it is covered by the tag and model configuration.

View Press the calculator icon to see the full diagnostic ruleexpression.

4. Select the row to expand the grid to see the tags that contribute to diagnostic rule.Each tag has a corresponding icon that signifies the priorities of the tag contributes and whether thetag is active for that priority.

5. Select to export an .xls file containing the data displayed in the report.6. Select Close after the review is complete.

Clean Training DataYou can clean the training data to reduce its disk space usage and to improve the performance of theSmartSignal Maintenance module.

Procedure

1. Access a SmartSignal analytic.2. In the Actions menu, select Model Training > Clean Training Data.

The Clean Training Data window appears.3. Modify the percentage to which you want to reduce the size of the training data.4. Select Continue.

The job configured to clean the training data starts and a window appears to display the progress ofthe job.


Results

After the job is completed, the Clean Training Data Report window appears, displaying the results of thejob.

Modify Settings for an Analytic InstanceIn the SmartSignal Maintenance module, you can modify the settings associated with an analytic instance,including the instance name, description, and data collection settings.

Procedure

1. Lock for editing the analytic that you want to modify.2. In the Actions menu, select Settings > Edit Settings.

The Edit Settings window appears.

3. As needed, modify values in the available sections.

Setting Description

Active Switch this toggle to determine whether the analytic instanceis active (that is, operational).

Name In this box, you can modify the name of the analytic instance.

Description In this box, you can modify the description of the analyticinstance.


Setting Description

Collection Type In this drop-down list box, you can select the data collectiontype that you want to use for this analytic instance.SmartSignal supports four modes of data collection:

Snapshot

This collection type ingests the most recent data for alltags in the analytic instance.

Use this collection type if you have a continuous,uninterrupted flow of data. This type is not recommendedwhen data is ingested irregularly or in batches.

Batch

This collection type ingests data at the collection intervalwhen readings for all tags in the analytic instance havethe same time stamp.

Use this collection type if your data is time aligned (thatis, the readings for your tags for a collection interval havethe same time stamp) and readings are ingestedtogether. This type is not recommended if the readingsacross all tags used in the analytic instance are notaligned to the same time stamp.

Sample and Hold

Like the Snapshot collection type, this type uses the mostrecent data for all tags used in the analytic instance.However, unlike Snapshot, Sample and Hold alsosupports data that is ingested irregularly or in batches.

Use this collection type or the Interpolated collectiontype in most cases. This type is not recommended ifprecisely time-aligned tag readings are required. In theSample and Hold collection mode, the maximumdifference between two tag readings can be up to onehour. If the most recent reading value before the specifiedcollection time is at least one hour old, no value (a NaN) isreturned.

Interpolated

This collection type returns a linearly interpolated valuebetween two tag readings if no reading value is availableat the specified collection time. Otherwise, if a readingvalue is available at the specified collection time, thatvalue is returned. However, if the most recent readingvalue before the specified collection time is at least onehour old, no value (a NaN) is returned.

Although the Interpolated collection mode isrecommended for tags used in a SmartSignal model, it isnot recommended for tags with quantized outputs (thatis, outputs that are confined to a relatively small set ofdiscrete, or distinct, values).

Collection Interval In this box, you can modify the interval at which data iscollected for all tags used in the analytic instance.

4. Select Close.5. When you have finished making changes, deploy the analytic instance.


Export SmartSignal Analytic DataYou can export a SmartSignal analytic from APM to a file format that is compatible for importing back toyour SmartSignal Classic product.

Procedure


2. In the Actions menu, select Import & Export > Export.An .xfr file is created and downloaded based on your browser download settings. This file containsthe data for the selected analytic.

Output Tag Health

View Output Tag Health

Output tags use formulaic calculations to create records. In the SmartSignal Maintenance module, you canview the health of output tags used to create records.

Procedure

1. Access a Deployment.

2. In the Actions menu, select Health > Output Tag Health.The Output Tag Health window appears, displaying a list of active output tags used in the selectedDeployment. The image below shows the Output Tag Health window with a tag selected.


One of the following icons appears next to each output tag to indicate the status of the tag:

Icon Description

Indicates that the formula contains a sufficient number ofactive input tags for the calculation to be able to evaluate andproduce reliable data.

Indicates that the formula does not contain a sufficientnumber of active input tags for the calculation to be able toevaluate and produce reliable data.

Indicates an inability to determine whether the formulacontains enough active input tags for the formula to be ableto evaluate and produce reliable data. If you see this icon, youshould manually review the formula and the input tags ituses.

3. If you want to view the formula input tags used in an output tag, as well as a graph of processed TimeSeries data for an output tag, select an output tag in the Output Tags section.The following information appears:

• The formula appears in the Formula section.• The input tags appear in the Input Tags section.

Note:

◦ Active input tags appear in black text while inactive input tags appear in gray text.◦ You cannot modify the output tag formula in the Output Tag Health window.◦ The input tags cannot be modified in this section. If you want to modify an input tag for a

deployment, complete the steps to modify top-level data in a Deployment.• A graph appears in the Processed Data section, displaying recent time series data for the selected

output tag if the tag has processed any data through the SmartSignal Runtime Engine.

Note: The chart displays raw data without any SmartSignal alert indicators.

Inactivate Output Tags

About This Task

Depending on the status and quantity of input tags used in the formula for an output tag, you may want todeactivate the output tag. For example, if an output tag formula includes inactive input tags, thecalculation may not work and may result in inaccurate model data. Complete the following steps toidentify and inactivate output tags that you do not want to use.

Procedure

1. Access the Output Tag Health window for the Deployment for which you want to inactivate outputtags.

2. Evaluate the output tags in the list to determine which should remain active and which should beinactivated, and then complete the following steps:

Note: The check box next to any output tag with bad tag health is automatically selected.

a) Ensure that the check box next to any output tag that you want to inactivate is selected.b) Ensure that the check box next to any output tag that you want to remain active is cleared.

3. Once you have confirmed which tags should remain active and which should be inactivated, selectInactivate Selections.


The selected tags are no longer used in the Deployment, and they no longer appear in the Output TagHealth window.

Note: You cannot reactivate an inactive output tag in the Output Tag Health window. If you want toreactivate an output tag, complete the steps to activate or deactivate a tag in a Deployment.

Access Constants for a SmartSignal DeploymentIn the SmartSignal Maintenance module, you can access the constants associated with a deployment.

Procedure

1. Access SmartSignal Maintenance, and then select a deployment.2. In the Actions box, select Settings > View Constants.

The View Constants window appears.

Validate with Asset TagsIn the SmartSignal Maintenance module, you can validate that the Asset Tags that have been associatedwith the analytic instance are without issue.

Procedure

1. Access SmartSignal Maintenance, and then select a deployment.2. In the Actions box, select Health > Validate with Asset Tags.

If there are no issues found with the current tag configuration, the Validate with Asset Tags windowappears.

If one or more of the following conditions are identified:

• A time series link in analytic data source is different from the link defined in the associated APMAsset tag.

• A tag alias was not found in the input or output mapping of the analytic.• A tag alias was not found in the associated APM Asset tag list.• The UOM defined in the SmartSignal Analytic Instance was not compatible with the UOM defined in

the associated APM Asset tag.• The UOM defined in the APM Asset tag is not support by the SmartSignal Analytic engine.

The Validate with Asset Tags – Issues Found window appears.


The table displayed in the image are described in the following table.


Tag Alias Analytic instance tag alias. This name is defined in the analytictemplate.

Source Tag Analytic instance source tag name.

Standard Units Analytic instance standard units.

Standard Units Category Analytic instance Unit of Measure category

APM Asset Tag Name APM Asset Tag’s name in the I/O map

APM Asset Tag Timeseries Link APM Asset Tag’s Timeseries link

APM Asset Tag UOM APM Asset Tag’s Unit of Measure

APM Asset Tag UOM Category APM Asset’s Tag Unit of Measure category

Auto Fix True: The issue will be fixed when instance is deployed.

False: The issue cannot be fixed automatically. User actionrequired.

3. Select Close once you are done with the review.


Manage Analytic Instances

Lock an Analytic for EditingYou can view data associated with analytic instances, modes, and models without locking the analytic.However, if you want to modify an analytic, you must first lock it for editing to ensure that multiple usersdo not make conflicting changes.

About This Task

You must have edit permissions for SmartSignal analytics in order to lock an analytic for editing. If youonly have view permissions, you can view analytic data, but you cannot lock it for editing.

Note: If you had an analytic locked for editing but your permissions were modified so that you no longerhad edit permissions, you are unable to discard or deploy your changes. Another user with editpermissions can take edit control and either discard or deploy the changes.

Procedure


Note: Regardless of whether you access an analytic instance, mode, or model, when you lock it forediting, the entire analytic instance is locked for editing.

2. Depending on whether the analytic is locked for editing by another user, select one of the followingoptions:

• If the analytic is not locked for editing by another user, select Edit.• If the analytic is locked for editing by another user, confirm that the user who has the analytic

locked for editing is no longer editing the analytic, and then select Take Edit Control. Whenprompted, select Take Edit Control again.

The table changes so that the values can be modified. If you took edit control from another user, anychanges that user had in progress are transferred to you.

Note: If you took edit control from another user and you do not want to keep the changes that userhad in progress, you can select Actions > Discard Changes to remove the changes that were inprogress.

Modify Data in the Page for an Analytic InstanceUse these steps to modify the values associated with an analytic instance.

Procedure


2. Select any cell to modify the value.

3. Optional: If you want to export the training data for the analytic instance to a .csv file, selectActions > Export Training Data To CSV.

A .csv file containing the training data for the selected analytic instance is downloaded.

Note: In the .csv file, for any time stamp that does not have a value for a tag, the displayed value isdetermined by the tag type:

• For float, integer, boolean, and date data types, a NaN is displayed.


• For the string data type, an empty string is displayed.

Next Steps

When you have finished making changes, deploy the analytic instance.

Modify the Source Tag Field for a Tag in an Analytic InstanceThe value in the Source Tag field for a tag in an analytic instance must match the value assigned to thattag by the time series data source. If these values do not match, complete the following steps to modifythe Source Tag field value for the tag in an analytic instance.

Procedure

1. Lock for editing the analytic that you want to modify.2. In the table, locate the tag for which you want to modify the Source Tag field value, and, in the Source

Tag column, select .The Select APM Asset Tag window appears.

3. In the window, either select a tag from the list or enter a value in the Predix Time Series Link box,and then select Select.

4. When you have finished making changes, deploy the analytic instance.

Results

Once the changes are deployed, the source tag mappings are updated based on your modifications to theSource Tag field. You can view the deployed tag mappings for the instance in the 2. I/O Mapping sectionof the workspace for the analytic instance in the Analytics module.

Additionally, if you synchronize the analytic instance with its analytic template, any changes you make totag mappings in the analytic instance are maintained.

Modify the Standard Unit of Measure for a TagIn the SmartSignal Maintenance module, you can modify the standard unit of measure for a tagassociated with an analytic instance.

Procedure

1. Lock for editing the analytic that you want to modify.2. In the table, locate the tag for which you want to modify the standard unit of measure, and, in the

Standard Units column, select .The window for modifying the standard units for the selected tag appears.


3. In the Standard Units box, select a unit of measure.4. Select one of the following Convert Threshold Values toggle positions, and then select Save:

Toggle Position Description

On Updates the default unit of measure for threshold values forthe analytic template to the unit of measure you selected.Threshold values are also rounded outward (that is, upperthresholds are rounded higher, and lower thresholds arerounded lower).

Off Does not update the default unit of measure for thresholdvalues for the analytic template.

Next Steps


Activate or Deactivate a Tag in a DeploymentIn the SmartSignal Maintenance module, you can determine whether a specific tag associated with adeployment will be used in predictions and data modeling.

Procedure

1. Lock for editing the analytic that you want to modify.2. In the table, locate the tag that you want to activate or deactivate, and, in the Active column, select or

clear the check box to activate or deactivate the tag, respectively.


Depending on whether you selected or cleared the check box in the Active column, the tag isactivated or deactivated.

Next Steps


Modify Constants for a SmartSignal DeploymentIn the SmartSignal Maintenance module, you can modify the constants associated with a deployment.

Procedure

1. Lock for editing the analytic that you want to modify.2. In the Actions box, select Settings > Edit Constants.

The Edit Constants window appears.3. Modify the values as necessary.4. Select Close.

Next Steps


Test an Analytic Instance

About This Task

Using the SmartSignal Maintenance module, you can test an analytic instance before deploying.

Procedure

1. Lock for editing the analytic that you want to test.2. In the Actions box, select Health > Test Analytic.

The Test Analytic window appears.


3. Select one of the following options:

• Analytic Output: Select this option if you want to use data that has already been processed by theanalytic, and then select the date range for the test.

• File: Select this option if you want to specify a data file that contains your test data, and thenselect or drop the file that must be used for the test.

4. Select Continue.The progress window appears, displaying the progress of the job.

Note: For additional information about the status of the job, you can select in the progresswindow.

After the job is completed, the Test Analytic Results window appears, displaying the results of thejob.

Note: To view the results in the analysis, you can select the View Test Results in Analysis link.

5. After you review the results, select Close.

Deploy a SmartSignal Analytic InstanceAfter you modify an analytic instance or model, you must deploy your changes for them to take effect.

Procedure

1. Access a SmartSignal analytic.2. As needed, modify the analytic instance.3. When you have finished modifying the analytic instance, select Deploy.

The Deploy window appears, displaying a box in which you can enter notes about your modificationsto the analytic instance.

4. Optional: In the Note box in the Deploy window, enter notes about your modifications to the analyticinstance.

Note: Any notes you enter appear when you view the analytic instance history.5. When you are ready to deploy your changes, select Deploy.


Results

• The analytic instance is deployed, and you can view details about the analytic instance in theOverview section in the SmartSignal Deployments page.

• The analytic instance and any notes you added appear in the Analytic Instance History window forthe analytic instance for which you deployed changes.

Manage SmartSignal ModelsSmartSignal models are used to predict equipment behavior under various operating conditions. A modelconsists of a group of related tags and historical data that have been filtered to reflect healthy equipmentbehavior, residual threshold settings, model settings, and testing information. Runtime data for all tags ina model are compared to the state matrix for the model to generate estimates. Through various modelsettings and rules, users are alerted when abnormal conditions are encountered. Models only operatewhen operating mode criteria have been met.

Access Model DataYou can access the data in a model associated with a SmartSignal deployment.

Procedure

1. In SmartSignal Maintenance, select .2. In the Deployments pane, select the name of the model whose details you want to access.

3. To close the Deployments pane, select or select an area of the page outside the menu.The page for the selected model appears. By default, the table on this page displays only tags that areactive in the model.

4. Optional: If you want to display alternate tags, in the Filter menu, then select one of the followingoptions:

Filter Option Description

Active in Deployment If you select this filter, all tags in the deployment are displayedin the table, even if some of them are not active in theselected model.

All Active and Inactive If you select this filter, all tags associated with the selectedmodel are displayed, regardless of whether they are active orinactive.

Access Settings for a ModelIn the SmartSignal Maintenance module, you can access the settings associated with a model.

Procedure

1. Access SmartSignal Maintenance, and then select a model.2. In the Actions box, select Settings > View Model Settings.

The View Model Settings window appears, displaying the various settings related to the model.


Model Settings

The following settings are available for a model.

Field Descriptions

Active Specifies whether or not the application should makepredictions and perform data modeling using the model’s tagsand configuration.

Note: The deployment containing a model must be active for anactive model to be processed.

Estimation Parameters

Estimation Generator The engine used to generate estimated values.

SBM

Similarity Based Model.

VBM

Variable Similarity Based Model.

Similarity Operator The algorithm to be used for modeling.

SSCOP2


SSCOP3


Enable VSG Specifies whether virtual signal (estimate) generation. If NaNsand/or outliers are encountered and the number of tagscontaining bad data is below the Maximum % of Bad Tagsthreshold, the system will fill in the missing or bad data formodeled tags with virtual signal data.

Maximum % of Bad Tags The percentage threshold above which, the system inhibitsvirtual signal generation. This option is available only whenEnable VSG is selected.

Variance of Style Factor A multiplier for the standard deviation of normal residualsignals.

Residual Smoothing


Field Descriptions

Smoothing Algorithm Moving Average


Spline

A real-time moving window technique that employs acubic-spline fit to each of the individual sliding windows.The spline filter can produce a filtered signal with very littledelay, but this is more computationally expensive. Also, aspike in the input data results in a shift in the output, butthis effect will be short-lived compared to the movingaverage filter.

Olympic

This filter is very similar to the Moving Average filter, but thesystem does not use the maximum and minimum datasamples for each window in the calculation of the averagevalue. The resulting filter is very computationally efficientand effective at removing spikes. However, it suffers fromthe same response delay as the Moving Average filter.

Window Size The total window (the number of data points or persistence) touse for smoothing.

Spline Smoothing Factor A number between 0 and 1, where the value 0 causes thegreatest smoothing and a value of 1 results in no smoothing(the output values equal the input values). A typical defaultvalue is 0.1

State Matrix Creation

Downsample Algorithm The algorithm that will be used when creating the state matrix.

Min Max

This algorithm finds where the maximum and minimumvalues for each tag occurs and then uses those samples asthe basis for the state matrix. If the same vector isidentified from two different tags, the redundancy iseliminated. This method provides the minimum number ofvectors in the training matrix.

Vector Ordering


Min Max Split

This method applies the MinMax algorithm to equal-sizedsections of data. This method returns more data than theMinMax method, so you can use this method if the MinMaxmethod doesn't return enough observations for modeltraining.


Field Descriptions



Target Vectors The number of vectors that will be targeted when the statematrix is created. Used when Vector Ordering is specified inthe Downsample Algorithm box.

Redundancy Check Time Specifies when redundancy checks are to be executed (e.g.,during runtime or setup of the model). They will be executedwhen the H-Matrix created or modified, when the Local D-Matrix is created, or both. Since the H-Matrix is relatively large, aredundancy check will take comparatively longer to run. Thegoal is to keep redundancies out of the estimate generationalgorithm.

H-Matrix Modified

Anytime the H-Matrix is modified by either the user or byadaptation, an algorithm is executed to filter similar vectorsfrom the H-Matrix.

Local D-Matrix Created

During runtime, VBM creates a local state matrix at everyobservation. Local D is typically small in size (approximately10 vectors).Selecting this option runs the algorithm thatfilters similar vectors when the local state matrix is created.Since it is a small matrix, it executes quickly.

Always

Executes redundancy filtering when the H-Matrix ismodified and when the Local D-Matrix is created.

Dynamic State Matrix Vectors

Number of Vectors Fixed

The VBM state matrix will contain exactly this manyvectors.

Variable



Minimum Minimum number of vectors in the VBM state matrix. Onlyapplicable when Number of Vectors is Variable.

Maximum Maximum number of vectors in the VBM state matrix. Onlyapplicable when Number of Vectors is Variable.

Auto-associative vs. Inferential Modeling Methods

At each sample, the system generates a residual vector–one element for each tag. A residual is thedifference between an estimated value and a real-time value. If the system or process is behaving


normally and the model is accurate, the residuals should be small with a random Gaussian distributionaround 0

The system uses an Auto-Associative or Inferential modeling method when calculating residuals. Whenthe model is Auto-Associative, the model uses every tag input to calculate the estimated state of everytag in the model. When the model is Inferential, the modeling component uses only a portion of the taginputs to generate the estimated values for all the tags in the model.

In contrast to auto-associative modeling where all input tags contribute to the estimates for all outputs,inferential modeling uses a subset of the input tags to generate estimates for all outputs. An inferentiallymodeled (dependent) tag is not a contributor to the model’s output. This type of tag is useful when youwant to insure that the inferred tags do not affect the estimates of the remaining tags in the model.

The modeling method is controlled by the "Is Independent" switches in the active model tags. (If the "IsIndependent" column is not visible on the model tags page, enable it by clicking on the "Columns" buttonto view the column selector, and check the "Is Independent" checkbox.) The "Is Independent" flag on a tagindicates (if checked) that the tag's values are independent of the values of other tags or (if unchecked)that the tag's values can be inferred from the values of other tags. There are three cases that determinethe modeling method:

• If all of the model's tags have the "Is Independent" checkbox checked, then auto-associative modelingis used.

• If any (but not all) of the "Is Independent" checkboxes are unchecked, then inferential modeling is used.• If all of the "Is Independent" checkboxes are unchecked, then inferential modeling is impossible (since

it requires at least one independent tag), so modeling reverts to auto-associative.

About Virtual Signal Generation

SmartSignal provides you the option to generate a virtual signal so the modeling engine can generateestimates for tags that contain outlier or missing data values. The benefit of virtual signal generation isthe ability to preserve good data that exists along with bad data in the same observation vector.

By default, when bad or missing tag data is encountered, the data feed replaces bad values with a NaN(Not a Number) and passes the data to the runtime engine. If the data is from a non-modeled tag, theruntime engine replaces the NaN with a Null and displays the affected data as a blank in graphs. If thedata is from a modeled tag, the entire vector is ignored during modeling. Also, if the outlier filter algorithmis enabled and a vector contains a value that is considered an outlier, the entire vector is ignored duringmodeling.

If you enable the virtual signal generation function and the number of tags containing bad data (Outlier orNaN) is less than or equal to a threshold you set, the modeling engine generates estimates for tags thatcontain missing data values. To avoid creating NaN values in the residuals and other modeling engineoutputs, the modeling engine sets the residual and SSCADI decision (for a tag that corresponds to a virtualestimate) to zero. The system also modifies all other modeling algorithms (those performing operationson input data) so they can handle the NaNs and outliers.

About the State Matrix

In a model, the state matrix is a matrix of vectors in which each vector represents one of the normaloperating states (for healthy behavior) of the equipment or system. Historical data from all tags in themodel are included in the matrix. Using the state matrix, the runtime engine can, in real-time, compareeach observation of live data to the set of normal operating states represented in the state matrix. Withthis comparison, the runtime engine generates an estimate for each tag in the observation and thencompares the actual value to the estimate value.


Modify Data in the Page for a ModelUse these steps to modify the values associated with a model.

Procedure

1. Lock for editing the analytic that you want to modify.2. Select any cell to modify the value.

Next Steps


Create or Rebuild a ModelIn the SmartSignal Maintenance module, you can create or rebuild a model for a deployment.

Procedure

1. In the module navigation menu, go to SmartSignal Maintenance.2. Select an analytic deployment.3. Depending on whether the analytic is locked for editing by another user, select one of the following

options:

• If the analytic is not locked for editing by another user, select Edit.• If the analytic is locked for editing by another user, confirm that the user who has the analytic

locked for editing is no longer editing the analytic, and then select Take Edit Control. Whenprompted, select Take Edit Control again.

The table changes so that the values can be modified. If you took edit control from another user, anychanges that user had in progress are transferred to you.

Note: If you took edit control from another user and you do not want to keep the changes that userhad in progress, you can select Actions > Discard Changes to remove the changes that were inprogress.

4. In the Actions box, select Model Training > Update Models.The Update Models window appears.

5. If you want to import training data, select the CHANGE TRAINING DATA check box, and thencomplete the following steps:

a) Select one of the following options:

Option Description

APPEND Adds new training data to the existing training data.

REPLACE Replaces existing training data with new training data.

SYNC Synchronizes new tag training data with existing models.

Select SYNC, when you need to add the tag to a deployment and sync the data for that tag withthe model (timestamps), without having to re-stripe data for the models. You can use Sync for anexternal file, if you need to export the timestamps for deployment data, then retrieve the data forthe newly added tag from an external source, and then import the data only for the new tag intothe deployment.

Note: Data synchronization is performed using the following conditions:


• If the timestamp on a given row in the designated file exists in the current training data, thedata point will be updated with the data point from the file.

• If the timestamp does not match, the data will be ignored.• If the data being synced results in changing a value for an output tag, those output tags are re-

evaluated.b) Select the source of the training data from one of the following options:

Option Description

PREDIX TIME SERIES Uses raw time series data.

ANALYTIC OUTPUT Uses only the data that the SmartSignal Cloud Runtime hasprocessed in this analytic. This source data is available forthe Append and Replace options, but not for the Syncoption.

FILE (.CSV, .ZIP, .TAB) Uses the data from the specified file.

c) Select a date range.d) If you selected PREDIX TIME SERIES, specify a date range and interval.

Note: If you selected ANALYTIC OUTPUT, the data is taken at the interval at which it wascollected and processed for this deployment.

6. If you want to include imported data in reference data, switch the Include imported data inreference data toggle, and then select one of the following options:

Option Description

Conservative This is the default option, and it is recommended in mostcases.

This option presumes that your training data setincludes a high proportion of undesirableoperating behavior on which to train the model.Therefore, this option uses a small subset of theavailable training data as reference data, whichresults in a model with a narrow training range.This narrow range reduces the possibility ofincluding undesirable data, but it may omit somerelevant data.

Moderate This option uses a balanced approach to include a larger set ofavailable training data as data patterns while reducing thepotential of training in undesirable data.

Aggressive This option is only recommended when asset operation isgenerally controlled, and available training data is consideredreliable.

This option uses a wider set of the availabletraining data as reference data. While this mayresult in a model with a wider training range, italso increases the potential to train the modelusing undesirable patterns.

All This option uses all available or imported training data asreference data and is only recommended for especiallyadvanced users or when the amount of available training datais limited.

7. If you want to change which model are being rebuilt, change the selection of the models in the grid.8. If you want to change the User Data Selection value for any model, use the check box in the gird to set

its value. For more information, refer to the Modify Training Data section of this documentation.


9. Select Continue.A progress indicator appears in the Edit Deployment workspace. When the process is complete, theTraining Result Data window appears, summarizing the added data.

Activate or Deactivate a ModelYou can activate or deactivate a model to specify whether the SmartSignal software should makepredictions and perform data modeling using the tags and configuration associated with the model.

About This Task

Note: The deployment containing a model must be active for an active model to be processed.

Procedure

1. Access SmartSignal Maintenance, and then select a model.2. Select Edit.3. In the Actions box, select Settings > Edit Model Settings.

The Edit Settings window appears.4. Select the Active toggle to activate or deactivate the model.

Your changes are saved automatically.5. Select Close.6. When you have finished making changes, select Deploy, and then, when prompted to confirm the

deployment, select Deploy again.



Results

In the tree, the model appears gray if it is inactive or black if it is active.

Add Reference Data to a ModelIn the SmartSignal Maintenance module, you can add reference data to an existing model.

About This Task

For best performance, add only the minimum amount of data required for a representative data set. It isrecommended that you do not exceed 20,000 total vectors of training data.

Procedure

1. Access SmartSignal Maintenance, and then select a model.2. Select Edit.3. In the Actions box, select Model Training > Update Models.

The Update Models window appears.4. Select Change Training Data to add, replace, or sync data into your models.5. Specify a date range.6. If you want to include imported data in reference data, switch the Include imported data in

reference data toggle, and then select one of the following options:


Option Description

Conservative This is the default option, and it is recommended in mostcases.

This option presumes that your training data setincludes a high proportion of undesirableoperating behavior on which to train the model.Therefore, this option uses a small subset of theavailable training data as reference data, whichresults in a model with a narrow training range.This narrow range reduces the possibility ofincluding undesirable data, but it may omit somerelevant data.

Moderate This option uses a balanced approach to include a larger set ofavailable training data as data patterns while reducing thepotential of training in undesirable data.

Aggressive This option is only recommended when asset operation isgenerally controlled, and available training data is consideredreliable.

This option uses a wider set of the availabletraining data as reference data. While this mayresult in a model with a wider training range, italso increases the potential to train the modelusing undesirable patterns.

All This option uses all available or imported training data asreference data and is only recommended for especiallyadvanced users or when the amount of available training datais limited.

7. Select Continue.A progress indicator appears in the Edit Deployment workspace. When the process is complete, anotification appears, confirming that the model was created.

8. Select OK.The reference data is added to the model.

Access Constants for a ModelIn the SmartSignal Maintenance module, you can access the constants associated with a model.

Procedure

1. Access SmartSignal Maintenance, and then select a model.2. In the Actions box, select Settings > View Model Constants.

The View Model Constants window appears.

Rebuild a ModelWhen you make changes to a model (for example, by modifying tag data or training data charts), you mayneed to rebuild the model in order for your changes to take effect. Complete the following steps to rebuilda model.

Procedure

1. Access the model that you want to rebuild.2. Select Edit.


3. In the Actions menu, select Model Training > Rebuild Model.4. When you have finished making changes, select Deploy, and then, when prompted to confirm the




Modify Constants for a ModelIn the SmartSignal Maintenance module, you can modify the constants for a model.

Procedure

1. Access SmartSignal Maintenance, and then select a model.2. Select Edit.3. In the Actions box, select Settings > Edit Model Constants.

The Edit Constants window appears.4. Modify the values as necessary.5. Select Close.6. When you have finished making changes, select Deploy, and then, when prompted to confirm the




Deploy a SmartSignal Analytic InstanceAfter you modify an analytic instance or model, you must deploy your changes for them to take effect.

Procedure

1. Access a SmartSignal analytic.2. As needed, modify the model.3. When you have finished modifying the model, select Deploy.

The Deploy window appears, displaying a box in which you can enter notes about your modificationsto the model.

4. Optional: In the Note box in the Deploy window, enter notes about your modifications to the model.

Note: Any notes you enter appear when you view the analytic instance history.5. When you are ready to deploy your changes, select Deploy.

Results

• The analytic instance is deployed, and you can view details about the analytic instance in theOverview section in the SmartSignal Deployments page.

• The analytic instance and any notes you added appear in the Analytic Instance History window forthe analytic instance for which you deployed changes.


Model Training Data Charts

About Model Training Data ChartsModel training is the process of filtering out bad data and bad tags and selecting healthy equipmentbehavior to be available for the state matrix. In the Smart Signal Maintenance module, you can view chartscontaining the training data associated with each tag in a model. These charts contain all data associatedwith the tag and include colored highlighting (also known as stripes) to designate which data will be usedas training data.

Training Data and Training Data Filters

Ideal training data is a set of values over time that represent good or normal behavior for the equipment.Since the charts contain all data, colored highlighting (that is, stripes) is used to indicate whether certaindata is normal or abnormal. Data indicated as abnormal (such as NaN values, flat-lines, and outlier values)is then excluded. Of the remaining data, some or all of it may be indicated as good data that should beincluded in the training data.

Data is identified as either normal or abnormal based on the following categories.

Category Stripe Color Description

Adapted Light green Data auto-adapted into the model from

runtime data processing.

Note: If data that was imported via an .xfr

transfer file contained auto-adapted data,

that data is included the training data, but

is not identified with the Adapted stripe

on the charts.

Correlation Orange Data excluded via the tag correlation

chart.

Exclude (Red) Red Manually excluded data.

Flat-Line Light purple Data excluded by autofilters due to

unchanging data values.

Include (Green) Green Good or normal data, manually included

as training data.

Mode Not Met Gray Data excluded where the mode condition

was not met.

Nan (Not a Number) Blue Data excluded by autofilters due to data

having a non-numeric or bad quality

value.

Filter High/Low Yellow Data excluded by exceeding manual

high/low filter limits.


Category Stripe Color Description

Spike Pink Data excluded by autofilters due to a

temporary step up/down.

State Matrix Purple Data being used to generate model

estimate.

You can select to view a pane displaying a list of categories of data along with graphs depicting thepercentage of data filtered per category, as shown in the following image.

Note: For each category, if no data was filtered, the graph displays 0.0%, and no stripes of that colorappear in the chart, regardless of whether the toggle is switched to the on or off position.

The categories that appear in the Total Filtered Data section represent categories of data that areexcluded from model training. The percentages displayed next to them comprise a portion of the totalfiltered data. In the preceding image, for example, only one category of data was filtered, that being the10.2% of data for the selected model that was identified as abnormal because the data was NaN.

The categories that appear in the Total Available Data section represent categories of data that areincluded as good or normal data for model training.

Stripes Behavior in GE Digital APM

When you use GE Digital APM, the stripes displayed on the charts are generated from any or all of thefollowing sources:

• Stripes automatically generated by the reference data selection algorithm based on your selectionwhen you create a model, add training data to a model, or rebuild a model.

• Stripes that were manually specified in SmartSignal Maintenance in GE Digital APM.• Stripes that were specified in SmartSignal Classic Asset Center prior to importing the data into GE

Digital APM via a transfer center file.

When an action is taken in GE Digital APM that automatically generates stripes based on the referencedata selection algorithm, the following process is completed in the background:

1. Filters are run to locate abnormal data and stripes are applied to exclude these vectors. Theappropriate type of stripe is used to denote the reason that a vector was considered abnormal (forexample, NaN).

2. Training data vectors are selected.3. The state matrix is created using the selected training data.


After this process is completed, the training data charts reflect changes in data (in the case of addingtraining data) and changes in stripes due to filtering, training data selection, and state matrix selection.

The Model Training Data Chart Interface

The page for model training data charts provides a variety of user interface elements for navigating andmodifying charts and chart data. The following tables present the available user interface elements alongwith their descriptions.

User Interface Element Description

You can use this button to view a pane that displays a list of

available tags for the selected model. Output tags appear with a

calculator icon next to them, while input tags have no calculator

icon next to them.

In this pane, you can select tags for which you want to display

the training data charts. You can select the SORT TAGS BYTEMPLATE ORDER toggle button to sort tags in the order

defined in the Analytic Template. You can use the SHOWINACTIVE TAGS toggle button to see the tags in the instance

that are not associated with the model, and to determine

whether you want to see only active tags in the model or

instance. Inactive instance tags can be displayed only when the

SHOW INSTANCE TAGS toggle button is selected.

Note: Any tag that is selected to display its chart will remain

selected and will be visible in the tags list and charts until you

clear the tag. This allows you to select the SHOW INACTIVEMODEL TAGS and SHOW INSTANCE TAGS toggle buttons

without affecting the displayed charts.

You can use this button to view a pane that displays a list of

available stripe filters. See the preceding Training Data and

Training Data Filters section for more information on the

available stripe filters for training data.

You can use this button to view a list of vectors. You can select

an option in this list to display only vectors that meet certain

criteria so that you can more easily understand and take actions

on the available training data.

You can use this button to view a pane that contains the model

tag statistics. This view allows you to search, sort, and filter the

training data to find bad actors (for example, NaN, Filter High/

Low, Spike, and Flatline).

You can use this button to view a chart displaying the

correlation of data between two tags. The correlation chart

displays data in an alternative view to the line chart that can

help you notice outlier data that might not be easily detected in

the line chart.



You can use this button to view a pane in which you can switch

the User Data Selection toggle based on whether you want

the SmartSignal auto-selection algorithm to determine what to

include as good or normal data in the chart or whether you

want to modify the chart manually.

Note: The following buttons are available in line charts and correlation charts. In line charts, each of the following actions is

applied to all charts currently displayed.

You can use this button to execute the filters for the model. This

button is enabled only when the model filters are out-of-date

and needs evaluation.

You can use this button to rebuild the model. This button is

enabled only when the model is out-of-date and needs to be

rebuilt.

You can use this button to zoom in on the x-axis for a selected

portion of the displayed charts.

You can use this button to zoom in on the y-axis for a selected

portion of the displayed charts.

You can use this button to zoom in on the x- and y-axes for a

selected portion of the displayed charts.

You can use this button to reset the zoom on the charts.

You can use this button to undo changes made to stripes in the

charts.

You can use this button to redo changes that you had previously

undone.

Note: The following elements are only used in line charts.

You can use this button to select the previous set of tags and

display the corresponding charts.

You can use this button to select the next set of tags and

display the corresponding charts.

You can use this button to select the next tag and add it to the

bottom of the list of charts.

You can use this button to remove the last chart from the list of

charts.

You can use this button to add or remove green stripes from

charts for selected tags. Green stripes indicate good or normal

data.



You can use this button to add or remove red stripes from

charts for selected tags. Red stripes indicate manually excluded

data.

You can use this button to change the size of the charts. You

can select one of the following available sizes:

• Default

• Small

• Medium

• Large

Note: The following elements are only used in correlation charts.

This button is referred to as a lasso. You can use this button to

select data points that you want to exclude from model training.

You can use this button to determine which tags are displayed

in the correlation chart.

You can use this button to switch the axes on which the

selected tags appear.

You can use this button to remove lassoed data points from

model training.

If you have previously excluded data points from a correlation

chart, you can include them again by lassoing the region in

which they appeared and then selecting this button.

Access Training Data ChartsIn the SmartSignal Maintenance module, you can access charts displaying the training data associatedwith the tags in an analytic instance.

Procedure

1. Access the model for which you want to view training data charts.2. In the Actions menu, select Model Training > Model Training Data Chart.

The Model Training page appears in a new browser tab.

Note: The first five charts are displayed in the alphabetical order of their names. You can change thesort order to the order defined in the corresponding Analytic Template.

3. Select .A list of the tags associated with the model appears.

4. Select one or more tags whose data you want to view in a chart.

Tip: To show or hide inactive tags, switch the SHOW INACTIVE MODEL TAGS toggle. To change theorder in which the charts appear to the order defined in the corresponding Analytic Template, switchthe SORT TAGS BY TEMPLATE ORDER toggle.

5. Select again to close the list of tags.A chart appears for each selected tag, displaying a graph representing tag data. Additionally, portionsof the chart may include striping based on whether the data is identified as normal or abnormal.


Filter Model Training DataIn the page displaying training data charts for a selected model, you can filter the chart display intwo ways:

• You can choose to display only vectors that meet certain criteria so that you can more easilyunderstand and take actions on the available training data.

• You can hide certain stripes or stripe colors from the chart display in order to better distinguish otherstripes.

These filters affect only the appearance of the displayed charts, not the data itself. The following twoprocedures explain how to use these filters in order to focus your view of the training data charts on thedata that you want to see.

Filter Vectors Displayed in Charts

Procedure

1. Access the page displaying model training data for the model for which you want to filter data.

2. Select , select the tags for which you want to view charts, and then select again.The charts appear for the selected tags.

3. Select , and then select one of the following options:Option Description

All Values in Instance (All Modes) Displays all values for all modes in the instance.

All Values in Mode Displays all values for the selected mode. This option alsohides vectors that are not excluded by the Mode Not Met filterso that you can focus on only the data that is in the mode ofoperation for the model.

All Values Not Excluded Displays all values not excluded. In other words, this optionhides all values that are excluded by any filter, includingvectors manually excluded using red stripes.

Reference Values Displays the chart values that are reference values. In otherwords, this option hides any vectors that are not manuallyincluded using green stripes.

State Matrix Values Displays the chart values that are used in the state matrix.

The chart display is filtered based on the selected option.

Hide or Display Stripes in Charts

Procedure


2. Select , select the tags for which you want to view charts, and then select again.The charts appear for the selected tags.

3. Select .

A pane appears, displaying a list of categories of data along with graphs depicting the percentage ofdata filtered per category, as shown in the following image.


4. As needed, switch the toggles next to any of the categories to display or hide the correspondingstripes in the training data charts.

Note: For more information about what each of the categories refers to, see the About Model TrainingData Charts topic.

5. When you have finished modifying the displayed stripes, select .The pane is closed, and the chart display is updated to show or hide stripes based on your selections.

Filter Tag Data in Charts

In addition to using filters to modify the way the chart displays data and stripes, you can also configurefilters in each displayed chart to automatically exclude regions of abnormal data. The following procedureexplains how to use filters in model training data charts on a tag-by-tag basis to modify training data.

Procedure


2. Select , select the tag for which you want to filter model training data, and then select again.A chart appears for the selected tag.

3. In the chart heading, select .


The tag statistics appear on the right side of the chart.

4. Enter values in any of the following filter boxes:Filter Description

Filter High/Low The values entered in these boxes define upper and lowerthreshold values. Use this filter to remove tag data thatexceeds the entered high value or falls below the entered lowvalue.

Flat-line Number The value entered in this box defines the minimum number ofidentical consecutive values that must be encountered inorder to determine that the data has flat-lined. Use this filterto remove data that flat-lines.

Spike Sensitivity The value entered in this box defines the sensitivity of thefilter to sudden spikes in data. A low Spike Sensitivity valueindicates a high sensitivity. In other words, the lower thevalue, the more data will be excluded. It is generallyrecommended that the Spike Sensitivity value be set to 2.

NaN (Not a Number) The total number of non-numeric or bad quality values aredisplayed.

Total Filtered Data The total number of values that have been filtered aredisplayed.

Note: Your changes are saved automatically.

5. When you have finished modifying filter values, select .

Next Steps

Rebuild the model.

Modify Training DataIn the page displaying training data charts for a selected model, you can manually specify which data youwant to include and which data you want to exclude from consideration when building a model.

Before You Begin

Lock for editing the model for which you want to modify training data.


Procedure

1. Access the training data charts for the model for which you want to modify training data.

2. Select , and then select one of the following User Data Selection toggle positions:Position Description

Off This is the default position. When the toggle is switched tothe off position, the SmartSignal auto-selection algorithmdetermines what to include as good or normal data.

On When the toggle is switched to the on position, you canmanually select which data to include in or exclude from thetraining data chart.

Note: If you modify the User Data Selection toggle position for the training data chart for a model,the setting you select remains selected until you select a different toggle position.

Important: If you switch the toggle to the on position and then later switch it back to the off position,when you rebuild the model, all of your manual data selections in the training data chart will beremoved and replaced with selections generated by the SmartSignal auto-selection algorithm.

3. As needed, use the model training data chart interface options to navigate the charts and modify chartdata.

For example, if you want to add or remove green stripes, select , and the complete the followingsteps:

a) To add a green stripe, select the portion of the chart where you want to add the stripe.

A green stripe is added, indicating that the data in the selected area represents good or normaldata on which you want to train the selected model.

b) To remove a green stripe, hover the cursor over the stripe that you want to remove.

The cursor changes, and the stripe is outlined, as shown in the following image.

c) Once the cursor changes and the stripe is outlined, select the stripe.

The stripe is removed.

Or, for example, if you want to add or remove red stripes, select , and then complete the followingsteps:

a) To add a red stripe, select the portion of the chart where you want to add the stripe.

A red stripe is added, indicating that the data in the selected area should be excluded from modeltraining.

b) To remove a red stripe, hover the cursor over the stripe that you want to remove.

The cursor changes, and the stripe is outlined, as shown in the image above.


c) Once the cursor changes and the stripe is outlined, select the stripe.

The stripe is removed.4. When you have finished making changes to the chart, return to the page for the selected model.

If you modified the green stripes, a message appears, prompting you to rebuild the model.

Next Steps

Rebuild the model.

Modify Tag Data in the Correlation Chart for a ModelThe correlation chart displays data in an alternative view to the line chart that can help you notice outlierdata that might not be easily detected in the line chart. You can use correlation charts to exclude thisoutlier data from model training.

Before You Begin

Lock for editing the model for which you want to modify tag data.

Procedure

1. Access the training data charts for a model.

2. Select .A scatter plot appears, comparing values for the first two tags (alphabetically) used in the model.

Note: The data points are color coded based on the colors used for data filtering, which you can view

by selecting when you are viewing line charts. See the documentation on training data andtraining data filters for more details about filter colors.

3. As needed, use the model training data chart interface options to navigate the charts and modify chartdata.For example, to exclude data points from model training, complete the following steps:

a) Select .b) Lasso the data points that you want to exclude by placing your cursor near the data points and

then pressing and holding the left mouse button while you drag the cursor around the data points.The specified data points are lassoed.

Note: If you zoom in or out after you lasso a selection of data points, your lasso is cleared.

c) Select .The selected data points are excluded from model training.

4. Optional: If you want to include data points that were previously excluded, lasso the area in which the

data points previously appeared, and then select .

Tip: To view excluded data points, use either the All Values in Mode or the All Values in Instance filter.

The previously excluded data points are included in the correlation chart and are visible when you usethe All Values Not Excluded filter.


Rebuild a ModelWhen you make changes to a model (for example, by modifying tag data or training data charts), you mayneed to rebuild the model in order for your changes to take effect. Complete the following steps to rebuilda model.

Procedure

1. Access the model that you want to rebuild.2. Select Edit.3. In the Actions menu, select Model Training > Rebuild Model.4. When you have finished making changes, select Deploy, and then, when prompted to confirm the




Execute Model Filters

About This Task

If you modify a model (for example, by modifying training data charts), you can execute the model filtersfor your modifications to take effect in the training data charts.

Procedure

1. Access the training data charts.

2. Select .The execution of the filters begin and a progress bar appears, indicating the progress of the execution.After the filters are executed, the training data charts are refreshed to display the new filtering.

SmartSignal Maintenance Reference

Analytic Instance Tag Field DescriptionsThis topic describes the fields that can be viewed in a SmartSignal Maintenance deployment.

Field Description

Tag Alias The display name of the tag. This value is inherited from theanalytic template and cannot be modified.

Tag TypeIf the tag is configured to generate a calculated value,

appears in this column. You can select to view the formulafor the calculation.

Source Tag The time series ID of the tag. This value can be modified.

Decimals The number of decimal places included in the tag readings. Thisvalue is inherited from templates imported from ClassicSmartSignal Blueprint Center. It is not used in GE Digital APMand cannot be modified.



Field Description

Active The collection of deployment-specific settings and data for thistag are collectively referred to as a deployment tag. If selected,this tag will be included as part of the deployment.

Last Changed Date Date the tag was last modified.

Units The units of measure for the source data of the tag, such asdegrees (C) or percentage (%). This is used only as an identifyinglabel and is displayed on the y-axis when the tag is used inmodel training data charts.

Actual High Threshold used in rules to determine whether data is outside ofexpected limits.

Actual Low Threshold used in rules to determine whether data is outside ofexpected limits.

Deployment ID The ID for the deployment.


Step High Threshold used for step-change rules.

Step Low Threshold used for step-change rules.

Tag Template ID The ID for the tag template.

Adaptation High Upper threshold used to determine the range of data that canbe adapted into models from runtime using the auto-adaptation algorithms.

Adaptation Low Lower threshold used to determine the range of data that canbe adapted into models from runtime using the auto-adaptation algorithms.

Source Tag Alias The display name of the source tag.

Analytic Template Display Name The name of the analytic template.

Created By The ID of the user who created the tag.

Created Date Date the tag was created.

Data Type The data format of the tag. The options are Float, Integer,Boolean, String, or Date. This value is inherited from the analytictemplate and cannot be modified.

Tag ID Automatically generated unique ID for the tag. This valuecannot be modified.

Last Changed By The ID of the user who last modified the tag.

Note Notes about the tag.

Model Tag Field DescriptionsModel tag data is used to predict equipment behavior under various operating conditions. This topicprovides a list and description of the fields that exist for model tags and appear on the grid for a selectedmodel.

Field Description



Field Description



Active in Deployment Depending on whether the tag is an input tag or an output tag, ifthis check box is selected, one of the following will occur:

• For an input tag, data will be collected at every datacollection interval.

• For an output tag, data will be produced at every datacollection interval.

The collection of deployment-specific settings and data for thistag are collectively referred to as a deployment tag.







Active in Model If selected, this tag is included as part of the model and is usedin predictions and data modeling. If it is deactivated, it is notused in predictions and data modeling. The collection of model-specific settings and data for this tag are collectively referred toas a model tag.


Algorithm Description

None Disables residual indicationsfor the residual signal forthe tag.

SPRT This is a specialized decisionalgorithm called theSequential Probability RatioTest (SPRT). The system canapply it when the residualsare normally distributed andserially uncorrelated. Thealgorithm uses a statisticalhypothesis testingtechnique to determine ifthe mean of the residual hasshifted in the positive ornegative direction.


Field Description


Residual Threshold This is the default value. Ittriggers a residual indicationif the residual signal of thetag exceeds the value in thePositive Residual Thresholdcolumn or falls below thevalue in the NegativeResidual Thresholdcolumn.

Smoothed ResidualThreshold

Triggers a residual indicationif the smoothed residualsignal of the tag exceeds thevalue in the Residual +Threshold column or fallsbelow the value in Residual– Threshold column. Thismethod is used to removespike data and noise fromthe residuals.

Residual (Positive) The maximum absolute value allowed for a positive residual(that is, when the estimate is above the actual for a signal). Seedetails in the Alarm Type description.

Residual (Negative) The maximum absolute value allowed for a negative residual(that is, when the estimate is below the actual for a signal). Seedetails in the Alarm Type description.

Actual Mean The mean of the actual values for a tag included in the referencevalues. This attribute is automatically evaluated when creatinga state matrix.

Actual Standard Deviation The standard deviation of the actual values for a tag included inthe reference values. This attribute is automatically evaluatedwhen creating a state matrix.






Filter Low The lower filtering threshold. This field sets the lower thresholdvalue for filtering of tag signals to remove data outside thenormal operating range. Any tag data less than this value is


Field Description

considered an outlier. Outliers will be filtered out of trainingdata.

Flatline Number If the data for this tag remains at the same level for more thanthis number of data points, the data will be considered to beflatlined, and will be filtered out of training data.

Instance Tag ID Automatically generated unique ID for the tag. This valuecannot be modified.



Model Tag ID Automatically generated unique ID for the tag. This valuecannot be modified.

Notes in Instance Notes about the analytic instance.

Notes in Template Notes about the analytic template. This value is inherited fromthe analytic template and cannot be modified.

Notes in Model Notes about the configuration of the tag for the selected model.

Outlier (Negative) Threshold used for outlier rules. Data outside of Outlier limitsappear as NaNs in charts.

Outlier (Positive) Threshold used for outlier rules. Data outside of Outlier limitsappear as NaNs in charts.

Residual Variance The variance of the residual values for a tag included in thereference values. This attribute is automatically evaluated whencreating a state matrix. Residual values are calculated bymodeling the reference values not included in the state matrix.

Spike Sensitivity The sensitivity of the spike detection algorithm used to detectspikes in tag signals. A lower value will detect more spikes, butmay also generate false positives. Spike data will be filtered outof training data.

SPRT (Negative) The negative values for the sensitivity of the SPRT. This value ismultiplied by the standard deviation of the residual, which inturn defines the amount of negative change in the residualmean that must occur to constitute an alarm.

SPRT (Positive) The positive values for the sensitivity of the SPRT. This value ismultiplied by the standard deviation of the residual, which inturn defines the amount of positive change in the residual meanthat must occur to constitute an alarm.



Tag Order The order of the tags in the deployment. This value is inheritedfrom the analytic template and cannot be modified.


Chapter

4SmartSignal DeploymentsTopics:

• Access the Processing Status ofSmartSignal Analytic Instances

• Configure Email NotificationPreferences

• Validate Analytics with AssetTags


Access the Processing Status of SmartSignal Analytic InstancesYou can use the SmartSignal Deployments page to access the processing statuses of analytic instancesin your system.

Procedure

1. In the module navigation menu, go to SmartSignal Deployments.2. Select a number above one of the following headings:

• Not Processing• Partial Processing• Successfully Processing• Not Loading• Not Active

The grid displays processing details for the analytic instances in the category you selected.

Tip: You can select the name of an analytic instance on this page to access the selected instance inthe SmartSignal Maintenance module.

3. Optional: By default, the page refreshes automatically every five minutes. However, if you want tomodify the refresh interval, choose one of the following options:

Choice Description

Manually refresh the page If you want to manually refresh the page, select Refresh.

Modify the refresh interval If you want to modify the interval at which the page refreshes,select an interval in the box next to the Refresh button.

4. Optional: To access events related to an analytic instance:

a) Select an instance in the first table.Details for the selected instance are populated automatically in the second table.

b) As needed, in the date filter boxes, select a date range for which you want to access events.c) Select Search Events.

The second table on the page displays details of the events related to the selected analyticinstance.

5. Optional: If you want to export a .csv file containing the processing status of analytic deploymentsin your system, select Export.

Configure Email Notification Preferences

Before You Begin

Make sure that the tenant is configured to send the analytic processing notification. If the tenant is notconfigured to send the notification, contact your Analytic administrator to configure the email notificationsettings for the tenant.

About This Task

You can configure email notification preferences to receive email notifications about tenant analyticsprocessing. If you are already subscribed to receive the notifications, you can modify the preferences tostop receiving the notifications. Based on the configuration done by your Analytic administrator, you canreceive notifications about analytics that are:


• Successfully Processing• Partial Processing• Not Processing• Not Loading

Procedure

1. In the module navigation menu, go to SmartSignal Deployments.2. In the Actions box, select Email Notification Preferences.

The Email Notification Preferences window appears.3. Select Subscribe.

You are subscribed to receive email notification containing information about tenant analyticsprocessing.

Note: If you are already subscribed to receive the email notification, the Email NotificationPreferences window provides you the option to Unsubscribe from the notification.

Validate Analytics with Asset Tags

About This Task

You can validate the status of the Analytic Instance Asset Tag configuration. This report identifies anySmartSignal analytic instance where one of the following conditions is detected:

• A time series link in the analytic data source is different from the link defined in the associated APMAsset tag.

• A tag alias was not found in the input-output mapping of the analytic.• A tag alias was not found in the associated APM Asset tag list.• The UOM defined in the SmartSignal Analytic Instance was not compatible with the UOM defined in

the associated APM Asset tag.

Procedure

1. In the module navigation menu, go to SmartSignal Deployments.2. In the Actions box, select Validate Analytics with Asset Tags.

The Validate Analytics with Asset Tags window appears.

Note: The Last Run box contains the date and time when the latest asset tag view was updated.3. Select Run Now to create or update the view.

The job starts and a progress indicator appears in the window.4. After the report is generated, select Download to get the result in detail.


The report is downloaded in a .csv format. The report contains the columns that are described in thefollowing table.


Analytic ID Analytic instance name.

Active True: Analytic instance is active.

False: Analytic instance is not active.

Deployed True: Analytic instance is deployed.

False: Analytic instance is not deployed.

Tag Name Analytic instance tag alias.

Source Tag Name Analytic instance source tag name.

APM Tag Tag name in the I/O map.

Timeseries Link Timeseries link specified in the APM Asset Tag.

Has IO Mapping True: Tag was found in the I/O map.

False: Tag was not found in the I/O map.

APM Asset Tag True: The APM Asset Tag was found.

False: The APM Asset Tag was not found.

Source Tag In Sync True: Source tag in the analytic matches the time series link in the APM Asset tag.

False: Source tag in the analytic does not match the time series link the APM Assettag.

Can be fixed True: The issue can be fixed using the Update input tags button.

False: The issue cannot be fixed automatically.

5. Select View to access the list of analytic instances that have been flagged by the job.The Validate Analytics with Asset Tags – Issues Found window appears, displaying the list ofanalytic instances that were identified.

6. Select the analytic instance that you want to view and resolve the configuration issue.7. Select Close after the review is completed.


Chapter

5ConfigurationTopics:

• Overview• Permissions• Hosts• Tenants• Importing SmartSignal Classic

Assets• Mapping to GED IMS

Installation


Overview

About Configuring SmartSignal in GE Digital APM for the First TimeTo use SmartSignal with GE Digital APM, you must have Tenant Admin permissions, and the followingfunctions must be configured:

• If you are using the SmartSignal Mapping application to create or associate an APM asset with aSmartSignal analytic, add and configure the SmartSignal host.

• Configure the SmartSignal tenant.• Associate the SmartSignal tenant with a host.• Map SmartSignal analytics to APM assets for the tenant.

Permissions

Assign Permissions to the SmartSignal Permission SetEnsure that the SmartSignal permission set contains the appropriate permissions.

Procedure

1. Sign in to GE Digital APM as an administrator.2. In the module navigation menu, go to Administration > Permission Sets.

3. In the page for accessing permission sets, next to SmartSignal, select , and then select EditPermission Set.The page for modifying permission sets appears.

4. Ensure the check boxes next to the following permissions are selected in the following sections:

Subsection Permissions

Asset • Edit Assets• Ingest Assets

Alerts • Manage Alerts• Alerts

Timeseries • View Timeseries• Configure Data Sources for Timeseries

Analytics • Manage Analytics Catalog• SmartSignal• Predix• Spark

Templates Alert Templates

SmartSignal Host and Tenant Setup SmartSignal Hosts and Tenants

SmartSignal Mappings • Setup SmartSignal Analytic• View SmartSignal Analytic

Units of Measure View UoM

As needed, select the check box next to any of the following permissions.


Subsection Permissions

SmartSignal Analytic Maintenance SmartSignal Model Personalization Feature

SmartSignal Analytic Template Features SmartSignal Analytic Template Edit

SmartSignal Observation Transferring Features SmartSignal Observation Transferring Feature

Tip: For more details about permissions and permission sets, see https://www.ge.com/digital/documentation/predix-apm/INTA5NzkwODctZWM0Mi00Y2M0LWI3ZjEtZGQzMDA1NDU5MWMw.html.

5. Select Save.The permission set is saved, and users with the SmartSignal permission set have the appropriatepermissions.

Assign the SmartSignal Permission Set to the Ingestor Role

Procedure

1. Sign in to GE Digital APM as an administrator.2. In the module navigation menu, go to Administration > Users.

The Users section of the User Management page appears.

3. Next to Ingestor Role, select , and then select Edit User.The Edit Users section appears.

4. In the Permission Sets & Assets subsection, select Add Permission Set.The Assign Permission Set and Asset to <user> window appears.

5. In the window, in the Permission Set section, select the SmartSignal option, and then select Assign.

Grant View-Only Permission for SmartSignal AnalyticsBy default, users with the SmartSignal permission set can access and modify SmartSignal analytics. If youwant a user to be able to view SmartSignal analytics, but you do not want that user to be able to modifyanalytics, complete the following steps to grant that user view-only permission.

Before You Begin

Ensure that the SmartSignal permission set is not assigned to the user to whom you want to grant view-only permission.

Procedure

1. Sign in to GE Digital APM as an administrator.2. In the module navigation menu, go to Administration > Users.3. Select the name of the user to whom you want to grant view-only permissions.

The Assign Permission Set and Asset to <user> window appears.4. Select Create New Permission Set.

The page for adding permissions appears.5. Enter a permission set name and description.6. Next to each permission that you want to grant to the user, select the check box.

Important: Ensure that the View SmartSignal Analytic check box is selected and the SetupSmartSignal Analytic check box is cleared.

Tip: For more details about permissions and permission sets, see https://www.ge.com/digital/documentation/predix-apm/INTA5NzkwODctZWM0Mi00Y2M0LWI3ZjEtZGQzMDA1NDU5MWMw.html.

7. Select Save.


https://www.ge.com/digital/documentation/predix-apm/INTA5NzkwODctZWM0Mi00Y2M0LWI3ZjEtZGQzMDA1NDU5MWMw.html




The new permission set is created, and the Assign Permission Set and Asset to <user> windowappears again.

8. Select the permission set that you created, and then select Assign.The user is now able to view, but not modify, SmartSignal analytics.

Hosts

Add a SmartSignal HostYou can add a new SmartSignal host in the SmartSignal Global Host Management page.

Procedure

1. In the module navigation menu, go to SmartSignal Hosts.2. In the SmartSignal Hosts section, select Host Management.3. On the SmartSignal Global Host Management page, select Add Host, and then do the following:

Command or Action Description

SS Host Id Enter the host Id.

SS Host Name Enter the host name.

Default Host Select the check box to make it the default host.

SS Host Admin URL Enter the host admin URL.

SS Host Evidence URL Enter the host evidence URL.

SS Host Asset URL Enter the host asset URL.

4. Select Add Host.The host is added.

Modify a SmartSignal HostYou can modify a SmartSignal host in the SmartSignal Global Host Management page.

Procedure

1. In the module navigation menu, go to SmartSignal Hosts.2. In the SmartSignal Hosts section, select the Edit icon next to the Host ID that you want to modify.3. On the SmartSignal Global Host Management page, select Add Host, and then do the following:

Command or Action Description

SS Host Name Enter the updated host name.

Default Host Select or clear the check box.

SS Host Admin URL Enter the updated host admin URL.

SS Host Evidence URL Enter the updated host evidence URL.

SS Host Asset URL Enter the updated host asset URL.

4. Select Update Host to save your changes.The host is modified.


Delete a SmartSignal HostYou can delete a SmartSignal host in the SmartSignal Global Host Management page.

Procedure

1. In the module navigation menu, go to SmartSignal Hosts.2. Next to the host that you want to modify, select Edit .

The workspace for the selected host appears.3. Select Delete.

A window appears asking you to confirm whether you want to delete the selected host.4. Select Yes to confirm deletion.

The host is permanently deleted from the database.

Tenants

About SmartSignal Tenant Service Configuration and Runtime EngineConfiguration

You can use the SmartSignal Tenant page to modify your service configuration as well as your runtimeengine configuration. However, the default SmartSignal configurations are appropriate for most users inmost scenarios. If you want to modify these settings, ensure that you contact GE Digital APM supportprior to doing so.

In the SmartSignal Tenant page, you can manage tenant memory in the Service Configuration section,and you can manage actual smoothing and adaptation settings in the Runtime Engine Configurationsection.

The following table describes the components in the Runtime Engine Configuration section:

Box Name Description

Smooth Algorithm One of the following algorithms used to discern significant data patterns:

Moving Average

The simplest of the available smoothing algorithms, this algorithm uses a moving

window technique in which the system averages the data within each window to

produce the filtered sample for each window. Although simple and

computationally efficient, there is an inherent delay in the response of the

algorithm that is proportional to the window size. Also, the presence of a spike in

the input data will affect the output signal for the length of the window size.

Olympic

This algorithm is similar to the Moving Average algorithm, but the system does

not use the maximum and minimum data samples for each window in the

calculation of the average value. The resulting algorithm is computationally

efficient and effective at removing spikes. However, it suffers from the same

response delay as the Moving Average algorithm.

Smoothing Window (Points) The number of data points used for smoothing.

IRA Similarity Threshold Threshold for triggering In Range Adaptation (IRA), which occurs when the current

reading for a tag is significantly different from any reading for the model tag.



FSI Similarity Threshold Threshold for triggering Fault Similarity Inhibition (FSI), which occurs when driver tags

(that is, tags that are used to determine if a new operating state is occurring to trigger

auto adaptation) diverge from the model more than tags that are not drivers.

Model Range Minimum Inhibition Threshold for triggering Model Range Inhibition (MRI), which occurs when tags

experience rapid change. The lower the Model Range Minimum Inhibition value, the

more frequently the threshold is triggered.

FSI IRA Parameter Fault Similarity Inhibitor (FSI) detects changes in the behavior of non-driver sensors

that may indicate a fault. The similarity factors of all driver tags and all non-driver tags

are calculated and compared to each other.

Model Range Variability Factor A function of the ratio of the distance a model limit is from the corresponding Limit

Value Inhibitor (LVI) and the LVI range.

Deployment Processing Status Timeouts Not Processing: No data received in last (hours)

The number of hours that the runtime engine must wait to receive data for the

analytic instance. If the runtime engine does not receive any data for the analytic

instance within the specified number of hours, the processing state of the analytic

instance is changed to Not Processing in the SmartSignal Deployments module.

Collection Configuration Maximum Carry Forward Duration (minutes)

The maximum number of minutes a tag value is carried forward without being

updated before it is reported as No Value.

% of updated tags required

The percentage of tags that must be updated within the specified vector wait

time. If the collection type is Batch, no vector is delivered for the interval. For all

other collection types, NaN is reported for all the tags that did not report a new

value.

Vector wait time

The waiting period for the percentage of tags specified in the % of updated tagsrequired box to be fulfilled before reporting NaN for the tags without a value.

Input Tag UOM Conversion

When enabled, the Runtime Engine automatically performs UOM conversion on

the input tag that is read from the Predix Time Series, where the UOM configured

in the Source Tag is different, yet compatible with the Standard Units configured

in the SmartSignal Analytic instance.

When disabled, the Runtime Engine assumes that the input tag is already in the

UOM that is configured in the SmartSignal Analytic instance.

Refer to the complete list of Input Tag UOM on page 110 Conversion Categories

and Names.

Configure Analytic Processing Status Notification

About This Task

This topic describes how to configure the email notification that is sent to the users who are subscribed toreceive the processing summary reports for the deployed analytic instances. You can also configure thesettings to generate the reports at specific intervals and send the detailed reports to the subscribedusers.


Procedure

1. In the module navigation menu, go to SmartSignal Tenant.The TENANT INFORMATION page appears.

2. Select Config.A page appears, displaying the options to configure the tenant.

3. Select Analytic Processing Notification.The Analytic Processing Notification section appears.

4. As needed, specify values in the following fields.

Field Name Action to be Performed

SEND ANALYTIC INSTANCEPROCESSING STATE NOTIFICATION

Select the check box if you want to send the notifications containing theprocessing statuses of the analytic instances to the subscribed users.

SUBSCRIBED USERS Displays the number of the users who are subscribed to receive the notificationscontaining the processing statuses of the analytic instances.

SEND EMAIL NOTIFICATION EVERY Select the time interval at which you want to send the notifications to thesubscribed users.

EMAIL SUBJECT Enter a subject line for the email notification.

MESSAGE Enter a message that you want to send to the subscribed users.

ATTACH ANALYTIC DETAIL REPORT Select the check box if you want to send a detailed report containing theprocessing status of each analytic instance of the tenant.

INCLUDE IN THE NOTIFICATION WHENANALYTIC

As needed, select the following check boxes:

• Successfully Processing

If selected, the notification will contain the analytic instancesthat are successfully processed.

• Partial Processing

If selected, the notification will contain the analytic instancesthat are partially processed.

• Not Processing

If selected, the notification will contain the analytic instancesthat are not processed.

• Not Loading

If selected, the notification will contain the analytic instancesthat are not loaded.

5. Select Save.The analytic processing status notification is configured.

Set Up a SmartSignal TenantYou can enter the APM Tenant Credentials for a new SmartSignal Tenant in the Tenant Managementpage.

Before You Begin

• Assign the appropriate permissions to the SmartSignal permission set.• Assign the SmartSignal permission set to the Ingestor role.

Procedure

1. In the module navigation menu, go to SmartSignal Tenant.

2. Select Setup Tenant.


3. Enter the Tenant Name.Note: If your tenant requires a SmartSignal cloud-based runtime engine, complete the following step. Ifyour tenant does not require a SmartSignal cloud-based runtime engine, skip the following step.4. For tenants that require the SmartSignal cloud-based runtime engine:

a) Ensure that the Requires SmartSignal Runtime toggle is switched to the on position.b) If a SmartSignal host is associated with this tenant, select a value in the SmartSignal Host box,

and then enter the appropriate value for the selected host in the Asset Group ID box.5. For tenants that do not require the SmartSignal cloud-based runtime engine:

a) Ensure that the Requires SmartSignal Runtime toggle is switched to the off position.b) Select a SmartSignal host in the drop-down list box, and then enter the Asset Group ID for the

selected host.6. Select Add.

The Tenant Credentials page appears.7. In the Tenant Credentials page, enter the necessary values, and then select Update.8. Select Back to return to the Tenant Management page.

Modify SmartSignal Tenant CredentialsYou can modify a SmartSignal tenant in the SmartSignal Tenant Management page.

Procedure

1. In the module navigation menu, go to SmartSignal Tenant.2. Select Config.3. Select Credential Configuration.4. As needed, modify values in the following boxes


APM Token Service Enter the updated APM token service URL.

Client Id Enter the updated client Id.

Client Secret Enter the client secret.

Grant Type Enter the grant type password.

User Id Enter the updated user Id.

Password Enter the updated password.

Escalated Incidents Only Select the check box only if this is an escalated incident.

5. When you have finished modifying the credentials, select Validate Credential.6. Once the credentials are validated, select Update Credential.

Your modifications are saved.

Associate a SmartSignal Tenant with a HostYou can associate a SmartSignal host with a SmartSignal tenant.

Procedure

1. In the module navigation menu, go to SmartSignal Tenant.2. Select Config.3. Select Associate Host.4. In the SmartSignal Host box, select a host.


5. Enter a value in the Asset Group ID box.6. Select Add.

Results

A message appears, indicating that the host is successfully associated with the tenant, and the host nameis added to the Host List section in the SmartSignal Global Host Management page.

Remove a Host Association from a SmartSignal TenantYou can remove a host that is associated with a SmartSignal tenant.

Before You Begin

Ensure there are no existing analytic instances associated with the host. If you try to delete the tenantbinding when there are associated analytic instances, the delete action fails, and a failure messageappears.

Procedure

1. In the module navigation menu, go to SmartSignal Tenant.2. Select Tenant Management.3. In the Host List section of the Tenant Management page, next to the name of the host that you want

to delete, select .4. When a message appears, asking you to confirm that you want to delete the host, select Yes.

Results

A message appears, indicating that the host is successfully removed from the tenant, and the host nameis removed from the Host List section in the SmartSignal Global Host Management page.

Importing SmartSignal Classic Assets

Import a SmartSignal Analytic Instance from a SmartSignal Classic AssetUsing a Transfer File

If you previously created a SmartSignal asset in the SmartSignal Classic system, you can import that assetinto GE Digital APM as a SmartSignal analytic instance.

Before You Begin

Ensure you have created a transfer file and have saved it locally before you import the file.

About This Task

The .xfr transfer file created in SmartSignal Classic contains the configuration information necessary tocreate or replace the SmartSignal analytic instance.

Procedure

1. In the module navigation menu, go to SmartSignal Mappings > Upload Assets.The SmartSignal Analytic page appears.

2. In the Import Transfer File section, select Choose Files, and then select the.xfr transfer file thatyou want to import.


Tip: You can select multiple transfer files.

The file is listed in the Select a Transfer Center File subsection.3. Optional: If you want to confirm whether the transfer file data can be successfully converted to be

used in GE Digital APM, complete the following steps:

Important: This step is not necessary for most users. If you think this step is required for yourorganization, you should consult with GE Digital support prior to completing this step.

a) Select Create Asset JSON.A progress indicator appears. When the file creation is complete, the JSON is downloaded based onyour browser download settings.

b) Review the JSON file as necessary.4. Select Import.

The file is imported and appears in the table appending the Select Transfer Center Files subsection.5. Optional: If you want to view status of the import, select the Navigate to job status button.

The Deployments page appears, displaying the Jobs Status section in which you can view detailsabout the import job.

Create Asset JSON from Data in an Input FileBefore you create APM assets from an Input Excel File, you can use these steps to verify the data. Inaddition, creating asset JSON validates that the data in the import file can be successfully converted to beused in APM.

Before You Begin

You must have selected an input file and validated its contents, such that the SmartSignal Classic assetsappear in the Validate/Action Results table.

Procedure

1. In the module navigation menu, go to SmartSignal Mappings.2. Select the Upload Analytic Instance tab, and then ensure that the Validate/Action Results table is

populated.3. In the table, select the check box for each analytic instance for which you want to create asset JSON.4. Select Create Asset JSON.

A progress indicator appears. When the file creation is complete, it is downloaded based on yourbrowser download settings.

5. Review the JSON file as necessary.

Import an Analytic Template from a SmartSignal Classic Blueprint FileIf you want to add a new analytic template of the SmartSignal type or add a new version of an existingSmartSignal analytic template to GE Digital APM, you must import the analytic template from a .zip fileexported from SmartSignal Classic Blueprint Center.

Before You Begin

Export a SmartSignal Classic Blueprint as an APM analytic template.

Procedure

1. In the module navigation menu, go to Analytics > Analytics Templates.The Analytics Templates page appears.


2. Depending on whether you want to add a new template or add a new version of an existing template,choose one of the following:

• If you want to add a new template, select , and then, in the Runtime Type drop-down list box,select SmartSignal.

• If you want to add a new template version for an existing template, select the template that youwant to update, and then select Edit.

The workspace for a new or selected analytic template appears. The image below displays the NewAnalytic workspace.

3. Select the browsing for a file link, and then, in the file explorer, open the .zip file that you want toupload.

Results

• The workspace for the newly created or updated analytic template appears.• All boxes on the workspace are updated automatically.• If you added a new template, the following information appears under the template name: Version

1.0.0.• If you added a new version of an existing template, the new version is automatically made the current

version, and it appears in the drop-down list of versions under the template name.

Note:

Version numbers are determined by the degree of changes made to the template.

◦ A change to the first number in the version number indicates a major change to the template. Amajor change is the result of a structural modification to the template, such as the addition orremoval of a tag. If a template with a major change is made current, you should review all modelsassociated with that template.

◦ A change to a number other than the first one in the version number indicates a minor change tothe template. A minor change, such as a modification to a rule expression, involves no structuralchanges to the template.


Mapping to GED IMS InstallationThe topics in this section explain how to configure a hybrid SmartSignal solution that uses both GE DigitalAPM and SmartSignal Classic. This hybrid configuration is not applicable to most users.

About MappingsYou can use the SmartSignal Mappings application to configure and maintain relationships betweenSmartSignal analytics and APM assets.

The Input Excel File

To map assets, you must first upload an Input Excel File. The input file should contain the followingcolumns and content:


APM Asset SourceKey Name of the APM asset.

APM Asset Path The APM hierarchy. Do not include the root node or the asset node in the path. If there

are multiple nodes, the delimiter should be >.

SmartSignal Asset Name The asset name in the SmartSignal Classic Asset Center.

SmartSignal Asset Path Asset hierarchy in the SmartSignal Classic Asset Center. Do not include the root node

or the asset node in the path. If there are multiple nodes, the delimiter should be >.

Host Name The configured SmartSignal host name in the SmartSignal Global HostManagement page.

Collection Type Specifies how frequently observations should be processed for this asset. The valid

values are:

• Snapshot (default)

• Batch

• Sample and Hold

• Interpolated

See the Modify Settings for an Analytic Instance topic for descriptions of each of these

data collection type.

Mappings Procedures

Once you have uploaded an asset input file, you can:

• Import SmartSignal Classic Assets into GE Digital APM using a transfer file.

Note: In APM, SmartSignal Classic assets become analytic instances.• Associate an APM asset with a SmartSignal analytic.• Unassociate an APM asset from a SmartSignal analytic.

Note: The Associate and Unassociate functions are used to create or delete associations between APMassets and SmartSignal Classic assets in a hybrid system, while the Import function is used to create anew cloud analytic instance. Essentially, Associate leaves the SmartSignal asset on the legacy system,while Import copies relevant data into a cloud analytic.


Access Current Mappings for SmartSignalIn the SmartSignal Mappings application, you can access all of the asset mappings between SmartSignalanalytics and APM assets for a tenant.

Procedure

1. In the module navigation menu, go to SmartSignal Mappings > Current Mappings.The SmartSignal Analytic page appears, displaying the Current Mappings section, which contains atable with the following columns:


SmartSignal Instance Name The name of the SmartSignal analytic instance that is part of the association.

APM Asset ID The ID of the asset in APM.

APM Source Key The name of the APM source key that uniquely identifies the asset within the APMtenant.

Is Cloud Instance

Host Name The configured SmartSignal host name found in the SmartSignal Global HostManagement page.

2. Optional: If you want to filter mappings or search for a specific mapping, enter a value in the Filterbox in any of the columns.

Associate or Unassociate an APM Asset with a SmartSignal AnalyticYou can associate or unassociate an APM asset with a SmartSignal analytic using the SmartSignalMappings page.

Before You Begin

• Both the APM asset and the SmartSignal analytic must exist at the paths provided in the Input ExcelFile, and all columns in the spreadsheet must be specified.

• You must have selected an input file and validated its contents, such that the SmartSignal analyticsappear in the Validate/Action Results table.

A single existing APM asset can be associated with multiple existing SmartSignal analytics. To associatewith multiple SmartSignal analytics, you need to do the following:

• In the row containing the first existing SmartSignal asset that you want to associate with the APMasset, use the Associate button if the APM asset already exists. If it doesn't exist yet, use the Createbutton first.

• For the remaining SmartSignal assets, specify the same APM Asset SourceKey and Path as the firstSmartSignal asset and use the Associate button.

About This Task

SmartSignal analytics can only be associated with one APM asset at a time. The last associated action willtake precedence. For example, if you have the following spreadsheet and select Associate, SmartSignalasset_1 will be associated with apm_asset_A, and not apm_asset_1.


A B C D

1 APM Asset SourceKey APM Asset Path SmartSignal AssetName

Smartsignal AssetPath

2 apm_asset_1 node1>node2>node3 asset_1 node1|node2

3 apm_asset_A nodeA>nodeB asset_1 node1|node2

Procedure

1. In the module navigation menu, go to SmartSignal Mappings.2. Select Upload Assets, and then select the Upload Analytic Instance tab.3. In the Upload Analytic Instance workspace, ensure that the Validate/Action Results table is

populated.4. In the table, select the check box for each asset that you want to associate with or unassociate from

SmartSignal.

Note: You must select at least one asset.5. Scroll to the bottom of the table, and then, depending on whether you want to associate or

unassociate the assets, select one of the following:

• Associate• Unassociate

Results

Depending on your selection, each APM asset is now either associated with or unassociated from itsrespective SmartSignal analytic.


Chapter

6ReferenceTopics:

• Template Tag Field Descriptions• SmartSignal Expression Syntax• Instance Tag Field Descriptions• SmartSignal Glossary


Template Tag Field Descriptions

Input Tag and Output Tag Field DescriptionsThis topic describes the fields that can be viewed in the Input Tag and Output Tag grid.

Column Description

ActionsIn this column, you can select to modify a tag, or you can select to delete atag.




Calculated Estimate Estimate generated by a user defined expression rather than the reference dataselection algorithm.


Actual High Thresholds used in rules to determine whether data is outside of expected limits.

Actual Low

Adaptation High Upper and lower thresholds used to determine the range of data that can be adaptedinto models from runtime using the auto-adaptation algorithms.

Adaptation Low


Measurement Units The units of measure for the source data of the tag, such as degrees (C) or percentage(%). This is used only as an identifying label and is displayed on the y-axis when thetag is used in model training data charts.


Data Type The data format of the tag. The options are Float, Integer, Boolean, String, or Date. Thedata type cannot be changed once a tag is added and the analytic template is saved.

Tag TypeIf the tag is configured to generate a calculated value, appears in this column. You


Decimal Scale The number of decimal places included in the tag readings. This value is inherited fromtemplates imported from Classic SmartSignal Blueprint Center. It is not used in GEDigital APM and cannot be modified.

Step High Threshold Thresholds used for step-change rules.

Step Low Threshold



Column Description

Chart Y Min Chart Y Min and Max values override default chart automatic scaling on the y-axis.

In other words, by default, analysis charts are automatically scaled on the y-axis basedon tag reading values. For example, if you have a tag with reading values that rangefrom 10 through 30, the bottom of the y-axis in the chart has a value of 10, and thetop of the y-axis has a value of 30. If you prefer to see a chart that starts at 0 and endsat 50 in the y-axis, you can enter 0 in the Chart Y Min column and 50 in the Chart YMax column.

Note: If you imported an analytic template from a SmartSignal Classic blueprint, ifthat blueprint had Chart Y Min and Max values, those values are maintained in GEDigital APM.

Chart Y Max

Output Tag Field DescriptionsThis topic describes the fields that can be viewed in the Output Tag grid.

Column Description

ActionsIn this column, you can select to modify a tag, or you can select to delete a tag.




Calculated Estimate Estimate generated by a user defined expression rather than the reference data selection algorithm.


Actual High Threshold used in rules to determine whether data is outside of expected limits.

Actual Low Threshold used in rules to determine whether data is outside of expected limits.

Adaptation High Upper threshold used to determine the range of data that can be adapted into models from runtime usingthe auto-adaptation algorithms.

Adaptation Low Lower threshold used to determine the range of data that can be adapted into models from runtime usingthe auto-adaptation algorithms.


Measurement Units The units of measure for the source data of the tag, such as degrees (C) or percentage (%). This is used onlyas an identifying label and is displayed on the y-axis when the tag is used in model training data charts.


Data Type The data format of the tag. The options are Float, Integer, Boolean, String, or Date. The data type cannot bechanged once a tag is added and the analytic template is saved.

Tag TypeIf the tag is configured to generate a calculated value, appears in this column. You can select to viewthe formula for the calculation.

Decimal Scale The number of decimal places included in the tag readings. This value is inherited from templates importedfrom Classic SmartSignal Blueprint Center. It is not used in GE Digital APM and cannot be modified.

Step High Threshold Threshold used for step-change rules.

Step Low Threshold



Constant Tag Field DescriptionsThis topic describes the fields that can be viewed in the Constant Tag grid.

Table 8: Analytic Level Constants

Column Description









Table 9: Model Level Constants

Column Description












Modes Field DescriptionsThis topic describes the fields that can be viewed in the Modes grid.

Field Purpose



Name The name for the mode analytic template.

Description The description for this mode analytic template.



Notes The notes for this mode analytic template.

Models Field DescriptionsThis topic describes the fields that can be viewed in the Models grid.

Field Purpose



Display Name The name of the model analytic template.


Description Description of the model analytic template.

Estimate Generator A reference data selection algorithm used to generateestimated values. There are two types of estimate generators:

SBM

Similarity Based Model

VBM

Variable Similarity Based Model

Similarity Operator One of the following algorithms used for modeling:

SSCOP2


SSCOP3


Enable VSG Specifies whether or not virtual signal generation is enabled. IfNaNs and/or outliers are encountered and the number of tagscontaining bad data is below the Maximum % of Bad Tagsthreshold, the system will fill in the missing or bad data formodeled tags with virtual signal data.


Field Purpose

Max Percentage of Bad Tags The percentage threshold above which the system inhibitsvirtual signal generation.

Variance Scale Factor A multiplier for the standard deviation of normal residualsignals.

Residual Smoothing - Smoothing Algorithm Moving Average


Spline

A real-time moving window technique that employs a cubic-spline fit to each of the individual sliding windows. Thespline filter can produce a filtered signal with very littledelay, but this is more computationally expensive. Also, aspike in the input data results in a shift in the output, butthis effect will be short-lived compared to the movingaverage filter.

Olympic

This filter is very similar to the Moving Average filter, butthe system does not use the maximum and minimum datasamples for each window in the calculation of the averagevalue. The resulting filter is very computationally efficientand effective at removing spikes. However, it suffers fromthe same response delay as the Moving Average filter.

Residual Smoothing - Window Size The total window (the number of data points or persistence) touse for smoothing.

Residual Smoothing - Spline A number between 0 and 1, where the value 0 causes thegreatest smoothing and a value of 1 results in no smoothing(the output values equal the input values). A typical defaultvalue is 0.1.


Field Purpose

State Matrix Creation - Down Sample Algorithm One of the following algorithms that is used when creating thestate matrix:

Min Max

This algorithm finds where the maximum and minimumvalues for each tag occur and then uses those samples asthe basis for the state matrix. If the same vector isidentified from two different tags, the redundancy iseliminated. This method provides the minimum number ofvectors in the training matrix.

Vector Ordering


Min Max Split

This method applies the MinMax algorithm to equal-sizedsections of data. This method returns more data than theMinMax method, so you can use this method if the MinMaxmethod does not return enough observations for modeltraining. When this method is selected, the ReferenceData Splits box appears.


State Matrix Creation - Target Vectors The number of vectors that will be targeted when the statematrix is created. Used when Vector Ordering is specified in theDownsample Algorithm box.

VBM - Fixed Size LocalD Fixed

The VBM state matrix will contain exactly this many vectors.

Variable



Redundancy Check Time Specifies when redundancy checks are to be executed (e.g.,during runtime or setup of the model).


Notes Notes about the model analytic template.

Created Date Date the model analytic template was created.

Last Changed Date Date the model analytic template was last modified.


Model Tags Field DescriptionsThis topic describes the fields that can be viewed in the Model Tags grid.

Column Description




Is In Model If selected, this analytic template tag will be included as part ofthe model blueprint. The collection of model-specific settingsand data for this tag are collectively referred to as a model tag.




None

Disables residual indications for the residual signal for thetag.

SPRT

This is a specialized decision algorithm called theSequential Probability Ratio Test (SPRT). The system canapply it when the residuals are normally distributed andserially uncorrelated. The algorithm uses a statisticalhypothesis testing technique to determine if the mean ofthe residual has shifted in the positive or negative direction.

Residual Threshold

This is the default value. It triggers a residual indication ifthe residual signal of the tag exceeds the value in thePositive Residual Threshold column or falls below the valuein the Negative Residual Threshold column.

Smoothed Residual Threshold

Triggers a residual indication if the smoothed residual signalof the tag exceeds the value in the Residual + Thresholdcolumn or falls below the value in Residual - Thresholdcolumn. This method is used to remove spike data andnoise from the residuals.



Residual Variance Used to set a custom value of residual variance for use by theSPRT algorithm. If not set, each Asset will use the variance if theresidual across its training data. Do not change this settingwithout fully understanding what it does.

Negative Outlier Threshold Threshold used for outlier rules.

Positive Outlier Threshold Threshold used for outlier rules.


Column Description

Negative Residual Threshold The maximum absolute value allowed for a negative residual(i.e., when the estimate is below the actual for a signal). Seedetails in the Alarm Type column.

Positive Residual Threshold The maximum absolute value allowed for a positive residual (i.e.,when the estimate is above the actual for a signal). See detailsin the Alarm Type column.

Negative SPRT Sensitivity The negative values for the sensitivity of the SPRT. This value ismultiplied by the standard deviation of the residual, which inturn defines the amount of negative change in the residualmean that must occur to constitute an alarm.

Positive SPRT Sensitivity The positive values for the sensitivity of the SPRT. This value ismultiplied by the standard deviation of the residual, which inturn defines the amount of positive change in the residual meanthat must occur to constitute an alarm.

Model Tag Display Name The display name of the tag.

Data Type The data format for the tag. The options are Float, Integer,Boolean, String, or Date.

Tag Type The type of tag (i.e., Input, Output, or Constant).



Filter Low The lower filtering threshold. This field sets the lower thresholdvalue for filtering of tag signals to remove data outside thenormal operating range. Any tag data less than this value isconsidered an outlier. Outliers will be filtered out of trainingdata.

Flat Line Number If the data for this tag remains at the same level for more thanthis number of data points, the data will be considered to be flatlined, and will be filtered out of training data.

Spike Sensitivity The sensitivity of the spike detection algorithm used to detectspikes in tag signals. A higher value will detect more spikes, butmay also generate false positives. Spike data will be filtered outof training data. Do not change this setting without fullyunderstanding what it does.

Notes The notes for the tag.

Diagnostic Rules Field DescriptionsThis topic describes the fields that can be viewed in the Diagnostic Rules grid.

Field Purpose



Name The name for the diagnostic rule.




Field Purpose

Startup Suppression Poll Cycles Specifies the number of poll cycles the rule will be suppressed(that is, not evaluated) after the asset enters a new mode.

Active Boolean values that determines whether the tag is active orinactive.

Description The description for the diagnostic rule.

Notes The notes for the diagnostic rule.

Tag Rules Field DescriptionsThis topic describes the fields that can be viewed in the Tag Rules grid.

Field Purpose



Display Name Displays the name of the rule. A green check mark displayednext to the name field indicates that the item is ready to beused. A yellow triangle indicates that the rule is not ready to beused. Hover over the yellow triangle to see which information ismissing from the rule.

Description A description for this rule.

Mnemonic Abbreviation used to identify the rule to assist with referencesin diagnostics rules.

Suppression Poll Cycle Specifies the number of poll cycles the rule will be suppressed(that is, not evaluated) after the asset enters a new mode.

Priority The priority of the rule; affects display of advisories in theapplication.

Message Configures the message that will appear for the advisory. Thereare four options that can be displayed in the message: SourceTag, Description, Alias, and Asset.


Notes Notes for this rule.


Input Tag UOMThis topic lists the UOM names that are currently supported by the SmartSignal Input Tag UOMconversion feature.

Category Name Description Alias name in APM UOM

Pressure PSIG Pound-force per square inchgauge

psi g, psig, PSIG

PSIA Pounds-force per square inchabsolute

psi a, psia, psi, PSIA

inHg Inches of mercury in.Hg, inHgA, inHg a, inHg

mmHg Millimeters of mercury mm.Hg a, mmHg,

inH2O Inches of water in.H2O a, inH2O

ftH2O Feet of water ft.H2O a,ftH2O

Bar Units of pressure bar,bar a, Bar, BAR

Pa Pascal Pa

KPa Kilopascals KPa

Torr Units of pressure Torr

Atm Atmospheres atm

BarG Bars gauge barg, bar g, bar(g), BarG

mmH2O Millimeters of water mm.H2O, mm.H2O a, mmH2O

mBar Millibar mBar

MPa Megapascal MPa

hPa Hectopascal hPa, HPA

daPa Dekapascal daPa

dPa Decipascal dPa

cPa Centipascal cPa

milliPa = 49, Millipascal mPa, milliPa

μPa Micropascal uPa

KilogramsPerSquareCentimeterAbsolute

kg/cm^2 a KilogramsPerSquareCentimeterAbsolute, kg/cm2 a

KilogramsPerSquareCentimeterGauge

kg/cm^2 g KilogramsPerSquareCentimeterGauge, kg/cm2 g

inHgG Inches of mercury Gauge inHgG, in.Hg g

mmHgG Millimeters of mercury Gauge mmHgG , mm.Hg g

inH2OG Inches of water Gauge in.H2O g, inH2OG

ftH2OG Feet of water Gauge ft.H2O g, ftH2OG

mmH2OG Millimeters of water Gauge mm.H2O g, mmH2OG

mBarG Millibar Gauge mBarG, mBarg, mBar g,mBarG


Temperature Celsius Celsius Celsius, Deg C, deg C, DEG C

Fahrenheit Fahrenheit Fahrenheit, Deg F, deg F, DEG F

Kelvin Kelvin Kelvin

Rankine Rankine Rankine

Frequency RPM Revolutions per minute rpm, RPM

CPS Cycles per second cycles/sec, cycles/s, CPS

CPM Cycles per minute cycles/min, CPM

Speed FPM Feet per minute ft/min, FPM

MPM Meters per minute m/min, MPM

IPS Inches per second in/sec, in/s, IPS

MetersPerSecond m/sec m/sec, m/s, MetersPerSecond

MillimetersPerSecond mm/sec mm/sec, mm/s,MillimetersPerSecond

MicrometersPerSecond μm/sec um/sec, um/s,MicrometersPerSecond

FeetPerSecond ft/sec ft/sec, ft/s, FeetPerSecond

Hertz Hz Hz, Hertz


FlowRateVolume GPM Gallons per minute gal/min, GPM

GPH Gallons Per Hour gal/hr, GPH

CFM Cubic feet per minute ft3/min, CFM

m3PerHour Cubic meters per hour m3/hr, m3PerHour

LPS Liters per second liter/sec, liter/s, LPS

LBMPerHour Pounds mass per hour lbm/hr, LBMPerHour, lb/hr

kLBMPerHour Kilo-pounds mass per hour klbm/hr, kLBMPerHour

kgPerHour Kilograms per hour kg/hr, kgPerHour

kgPerSecond Kilograms per second kg/sec, kg/s, kgPerSecond

CFS Cubic feet per second ft3/sec, ft3/s, CFS

CFH Cubic feet per hour ft3/hr, CFH

CFD Cubic feet per day ft3/day, CFD

kCFM Thousands of Cubic feet perminute

k(ft3)/min, kCFM

kCFS Thousands of Cubic feet persecond

k(ft3)/sec, kCFS

kCFH Thousands of Cubic feet perhour

k(ft3)/hr , kCFH

kCFD Thousands of Cubic feet perday

k(ft3)/day, kCFD

MCFM Millions of Cubic feet perminute

M(ft3)/min, MCFM

MCFS Millions of Cubic feet persecond

M(ft3)/sec, M(ft3)/s, MCFS

MCFH Millions of Cubic feet per hour M(ft3)/hr, MCFH

MCFD Millions of Cubic feet per day M(ft3)/day, MCFD

GPS Gallons per second gal/sec, gal/s, GPS

GPD Gallons per day gal/day, GPD

m3PerSecond Cubic meters per second m3/sec, m3/s, m3PerSecond

m3PerMinute Cubic meters per minute m3/min, m3PerMinute

m3PerDay Cubic meters per day m3/day, m3PerDay

LPM Liters per minute liter/min, LPM

LPH Liters per hour liter/hr , LPH

LPD Liters per day liter/day,LPD

ccPerSecond Cubic centimeters per second cm3/sec, cm3/s, ccPerSecond

ccPerMinute Cubic centimeters per minute cm3/min, ccPerMinute

ccPerHour Cubic centimeters per hour cm3/hr, ccPerDay

ccPerDay Cubic centimeters per day cm3/day, ccPerDay

in3PerSecond Cubic inches per second in3/sec, in3/s, in3PerSecond

in3PerMinute Cubic inches per minute in3/min, in3PerMinute

in3PerHour Cubic inches per hour in3/hr, in3PerHour

in3PerDay Cubic inches per day in3/day, in3PerDay

BBS Barrels (oil) per second bbl/sec, bbl/s, BBS

BBM Barrels (oils) per minute bbl/min, BBM

BBH Barrels (oils) per hour bbl/hr, BBH

BBD Barrels (oils) per day bbl/day, BBD

kBBS Thousands of Barrels (oil) persecond

kbbl/sec, kbbl/s, kBBS

kBBM Thousands of Barrels (oils) perminute

kbbl/min, kBBM

kBBH Thousands of Barrels (oils) perhour

kbbl/hr, kBBH

kBBD Thousands of Barrels (oils) perday

kbbl/day, kBBD

MBBS Millions of Barrels (oil) persecond

Mbbl/sec, Mbbl/s, MBBS

MBBM Millions of Barrels (oils) perminute

Mbbl/min, MBBM

MBBH Millions of Barrels (oils) perhour

Mbbl/hr, MBBH

MBBD Millions of Barrels (oils) perday

Mbbl/day, MBBD

LBMPerSecond Pounds mass per second lbm/sec, lbm/s,LBMPerSecond, lb/s, lb/sec

LBMPerMinute Pounds mass per minute lbm/min, LBMPerMinute,lb/min

LBMPerDay Pounds mass per day lbm/day, LBMPerDay, lb/day

kLBMPerSecond Kilo-pounds mass per second klbm/sec, klbm/s,kLBMPerSecond

kLBMPerMinute Kilo-pounds mass per minute klbm/min, kLBMPerMinute

kLBMPerDay Kilo-pounds mass per day klbm/day, kLBMPerDay

MLBMPerHour Mega-Pounds mass per hour Mlbm/hr, MLBMPerHour

MLBMPerSecond Mega-Pounds mass persecond

Mlbm/sec, Mlbm/s,MLBMPerSecond

MLBMPerMinute Mega-Pounds mass perminute

Mlbm/min, MLBMPerMinute

MLBMPerDay Mega-Pounds mass per day Mlbm/day, MLBMPerDay

kgPerMinute Kilograms per minute kg/min, kgPerMinute

kgPerDay Kilograms per day kg/day, kgPerDay

MetricTonPerSecond Metric Ton per second Metric Ton/sec,MetricTonPerSecond

MetricTonPerMinute Metric Ton per minute Metric Ton/min,MetricTonPerMinute

MetricTonPerDay Metric Ton per day Metric Ton/day,MetricTonPerDay

MetricTonPerHour Metric ton per hour Metric Ton/hr,MetricTonPerHour

ThousandsOfCubicMetersPerSecond

k(m^3)/s k(m3)/sec, k(m3)/s,ThousandsOfCubicMetersPerSecond

ThousandsOfCubicMetersPerMinute

k(m^3)/m k(m3)/min,ThousandsOfCubicMetersPerMinute

ThousandsOfCubicMetersPerHour

k(m^3)/h k(m3)/hr,ThousandsOfCubicMetersPerHour

ThousandsOfCubicMetersPerDay

k(m^3)/d k(m3)/day,ThousandsOfCubicMetersPerDay

MillionsOfCubicMetersPerSecond

M(m^3)/s M(m3)/sec,MillionsOfCubicMetersPerSecond

MillionsOfCubicMetersPerMinute

M(m^3)/m M(m3)/min,MillionsOfCubicMetersPerMinute

MillionsOfCubicMetersPerHour

M(m^3)/h M(m3)/hr,MillionsOfCubicMetersPerHour

MillionsOfCubicMetersPerDay M(m^3)/d M(m3)/day,MillionsOfCubicMetersPerDay


Power HP Horsepower (International) hp, HP

W Watts W

MW Megawatts MW

kW Kilowatts kW

NmPerSecond Newton meters per second N-m/sec, NmPerSecond

BTUPerHour BTU / Hour btu/hour, BTUPerHour

MBTUPerHR Million BTU / hour Mbtu/hr, MBTUPerHR

Var Var (varistor) Var

Millivar mVar mVar, Millivar

Kilovar kVar kVar, Kilovar

Megavar MVar MVar, Megavar

Torque FtLBF Foot pounds force ft-lbF, FtLBF

Nm Newton meter N-m, Nm

Length ft Feet ft

In Inches in, In

m Meters m

mm millimeters mm

cm centimeters cm,

mils a mil = a thousandth of an inch mils , MILS

μm Micrometers um

Mass Pounds lbm lbm, Pounds

Kilopounds klbm klbm, Kilopounds

Kilograms kg kg, Kilograms

ElectricCurrent Amps A A, Amps

Milliamps mA mA, Milliamps

Kiloamps kA kA, Kiloamps

ElectricPotential Volts V V, Volts

Millivolts mV mv, Millivolts

Kilovolts kV kV, Kilovolts

Time Seconds seconds seconds

Minutes minutes minutes

Hours hours hours

Days days days

Years years years


StmSpecificEnthalpy BTUPerLbm Stem Table Function, SpecificEnthalpy British Unit, Btu/Lbm

btu/lbm, BTUPerLbm

JPerkg Stem Table Function, SpecificEnthalpy SI Unit, J/kg

not found ?????

kJPerkg Stem Table Function, SpecificEnthalpy SI Reference unit,kJ/kg

kJ/kg, kJPerkg

BTUPerLbmF Stem Table Function, SpecificEntropy British unit,BTU/Lbm/F

btu/lbmf, BTUPerLbmF

kJPerkgK Stem Table Function, SpecificEntropy SI unit, kJ/kg/K

kJPerkgK,

JPerkgK Stem Table Function, SpecificEntropy SI Reference unit,J/kg/K

j/kgk, JPerkgK

StmSpecificVolume CubicFeetPerLb Stem Table Function, SpecificVolume British unit, Ft^3/Lb

cubicfeet/lb, CubicFeetPerLb

CubicMeterPerKg Stem Table Function, SpecificVolume SI unit, m^3/kg

cubicmeter/kg,CubicMeterPerKg

StmThermoConductivity BTUPerHrFtF Stem Table Function,ThermoConductivity Britishunit, BTU/hr/ft/F

btu/hrftf, BTUPerHrFtF

WattPerMeterK Stem Table Function,ThermoConductivity SI unit,Watt/m/C

watt/meterk, WattPerMeterK

StmDynamicViscosity LbmPerFtHr Stem Table Function,DynamicViscosity British unit,Lbm/ft/hr

lbm/fthr, LbmPerFtHr

Centipoise Stem Table Function,DynamicViscosity SI unit,Centipoise, 1e-3 kg/m/s

centipoise, Centipoise

PaSec Stem Table Function,DynamicViscosity SI Formalunit, Poise (analog to Pa * s),kg/m/s

pasec, PaSec

SmartSignal Expression Syntax

Unit Conversions

Electric Current

Unit Standard Unit Unit Conversion Function

Amps A ToAmps

Kiloamps kA ToKiloamps

Milliamps mA ToMilliamps


Electric Potential


Millivolts mV ToMillivolts

Volts V ToVolts

Kilovolts kV ToKilovolts

Flow Rate - Mass


pound per second lbm/sec ToPoundsOfMassPerSecond

pound per minute lbm/min ToPoundsOfMassPerMinute

pound per hour lbm/hr ToPoundsOfMassPerHour

pound per day lbm/day ToPoundsOfMassPerDay

kilopounds per sec klbm/sec ToThousandsOfPoundsOfMassPerSecond

kilopound per minute klbm/min ToThousandsOfPoundsOfMassPerMinute

kilopound per hour klbm/hr ToThousandsOfPoundsOfMassPerHour

kilopound per day klbm/day ToThousandsOfPoundsOfMassPerDay

megapound per second Mlbm/sec ToMillionsOfPoundsOfMassPerSecond

megapound per minute Mlbm/min ToMillionsOfPoundsOfMassPerMinute

megapound per hour Mlbm/hr ToMillionsOfPoundsOfMassPerHour

megapound per day Mlbm/day ToMillionsOfPoundsOfMassPerDay

kilograms per sec kg/sec ToKilogramsOfMassPerSecond

kilograms per minute kg/min ToKilogramsOfMassPerMinute

kilograms per hour kg/hr ToKilogramsOfMassPerHour

kilograms per day kg/day ToKilogramsOfMassPerDay

metric ton per second Metric Ton/sec ToMetricTonsPerSecond

metric ton per hour Metric Ton/hr ToMetricTonsPerHour

metric ton per day Metric Ton/day ToMetricTonsPerDay

metric ton per minute Metric Ton/min ToMetricTonsPerMinute

Flow Rate - Volumetric


Barrels of oil per day bbl/day ToBarrelsOfOilPerDay

Barrels of oil per hour bbl/hr ToBarrelsOfOilPerHour



Barrels of oil per minute bbl/min ToBarrelsOfOilPerMinute

Barrels of oil per second bbl/sec ToBarrelsOfOilPerSecond

Cubic centimeters per day cm3/day ToCubicCentimetersPerDay

Cubic centimeters per hour cm3/hr ToCubicCentimetersPerHour

Cubic centimeters per minute cm3/min ToCubicCentimetersPerMinute

Cubic centimeters per second cm3/sec ToCubicCentimetersPerSecond

Cubic feet per day ft3/day ToCubicFeetPerDay

Cubic feet per hour ft3/hr ToCubicFeetPerHour

Cubic feet per minute ft3/min ToCubicFeetPerMinute

Cubic feet per second ft3/sec ToCubicFeetPerSecond

Gallons per day ga/day ToGallonsPerDay

Gallons per hour gal/hr ToGallonsPerHour

Gallons per minute gal/min ToGallonsPerMinute

Gallons per second gal/sec ToGallonsPerSecond

Cubic inches per day in3/day ToCubicInchesPerDay

Cubic inches per hour in3/hr ToCubicInchesPerHour

Cubic inches per minute in3/min ToCubicInchesPerMinute

Cubic inches per second in3/sec ToCubicInchesPerSecond

Thousands of barrels of oil per day kbbl/day ToThousandsOfBarrelsOfOilPerDay

Thousands of barrels of oil per hour kbbl/hr ToThousandsOfBarrelsOfOilPerHour

Thousands of barrels of oil per minute kbbl/min ToThousandsOfBarrelsOfOilPerMinute

Thousands of barrels of oil per second kbbl/sec ToThousandsOfBarrelsOfOilPerSecond

Thousands of cubic feet per day k(ft3)/day ToThousandsOfCubicFeetPerDay

Thousands of cubic feet per hour k(ft3)/hr ToThousandsOfCubicFeetPerHour

Thousands of Cubic feet per minute k(ft3)/min ToThousandsOfCubicFeetPerMinute

Thousands of cubic feet per second k(ft3)/sec ToThousandsOfCubicFeetPerSecond

Liters per day liter/day ToLitersPerDay

Liters per hour liter/hr ToLitersPerHour

Liters per minute liter/min ToLitersPerMinute

Liters per second liter/sec ToLitersPerSecond

Cubic meters per day m3/day ToCubicMetersPerDay

Cubic meters per hour m3/hr ToCubicMetersPerHour

Cubic meters per minute m3/min ToCubicMetersPerMinute



Cubic meters per second m3/sec ToCubicMetersPerSecond

Thousands of cubic meter per day k(m3)/day ToThousandsOfCubicMetersPerDay

Thousands of cubic meter per hour k(m3)/hr ToThousandsOfCubicMetersPerHour

Thousands of Cubic meter per minute k(m3)/min ToThousandsOfCubicMetersPerMinute

Thousands of cubic meter per second k(m3)/sec ToThousandsOfCubicMetersPerSecond

Millions of cubic meter per day M(m3)/day ToMillionsOfCubicMetersPerDay

Millions of cubic meter per hour M(m3)/hr ToMillionsOfCubicMetersPerHour

Millions of cubic meter per minute M(m3)/min ToMillionsOfCubicMetersPerMinute

Millions of cubic meter per second M(m3)/day ToMillionsOfCubicMetersPerSecond

Millions of barrels of oil per day Mbbl/day ToMillionsOfBarrelsOfOilPerDay

Millions of barrels of oil per hour Mbbl/hr ToMillionsOfBarrelsOfOilPerHour

Millions of barrels of oil per minute Mbbl/min ToMillionsOfBarrelsOfOilPerMinute

Millions of barrels of oil per second Mbbl/sec ToMillionsOfBarrelsOfOilPerSecond

Millions of cubic feet per day M(ft3)/day ToMillionsOfCubicFeetPerDay

Millions of cubic feet per hour M(ft3)/hr ToMillionsOfCubicFeetPerHour

Millions of cubic feet per minute M(ft3)/min ToMillionsOfCubicFeetPerMinute

Millions of cubic feet per second M(ft3)/sec ToMillionsOfCubicFeetPerSecond

Frequency


Cycles per second cycles/sec ToCyclesPerSecond

Cycles per minute cycles/min ToRevolutionsPerMinute

Hertz Hz ToHertz

Revolutions per minute rpm ToCyclesPerMinute

Length


Milliinches mils ToMilliInches

Inches in ToInches

feet ft ToFeet

Micrometers µm ToMicrometers

Millimeters mm ToMilliMeters



Centimeters cm ToCentiMeters

Meters m ToMeters

Mass


Kilograms kg ToKilograms

Pounds lbm ToPounds

Kilopounds klbm ToKilopounds

Power


horsepower hp ToHorsepower

british thermal units per hour btu/hour ToBtuPerHour

millions of british thermal units per hour Mbtu/hr ToMillionsOfBtuPerHour

Watts W ToWatts

Kilowatts kW ToKilowatts

Megawatts MW ToMegawatts

Newton-meters per second N-m/sec ToNewtonMetersPerSecond

Pressure


Atmospheres atm ToAtmospheres

Pounds per square inch (absolute) psia ToPoundsPerSquareInchAbsolute

Pounds per square inch (gauge) psig ToPoundsPerSquareInchGauge

Bar (absolute) bar a ToBars

Bar (gauge) bar g ToBarsGauge

Millibars mBar ToMillibars

Millimeters of water mm.H2O ToMillimetersOfH2O

Inches of water in.H2O ToInchesOfH2O

Feet of water ft.H2O ToFeetOfH2O

Millimeters of mercury mm.Hg ToMillimetersOfMercury

Inches of mercury in.Hg ToInchesOfMercury



Torr Torr ToTorrs

Kilograms per square centimeter absolute kg/cm2 a ToKilogramsPerSquareCentimeterAbsolut

e

Kilograms per square centimeter gauge kg/cm2 g ToKilogramsPerSquareCentimeterGauge

Micropascal µPa ToMicropascals

Millipascal mPa ToMillipascals

Centipascal cPa ToCentipascals

Decipascal dPa ToDecipascals

Pascal Pa ToPascals

Dekapascal daPa ToDekapascals

Hectopascal hPa ToHectopascals

Kilopascal kPa ToKilopascals

Megapascal MPa ToMegapascals

Reactive Power


Millivar mVar ToMillivar

Var Var ToVar

Kilovar kVar ToKilovar

Megavar MVar ToMegavar

Speed


Inches per second in/sec ToInchesPerSecond

Feet per minute ft/min ToFeetPerMinute

Feet per second ft/sec ToFeetPerSecond

Micrometers per second µm/sec ToMicrometersPerSecond

Millimeters per second mm/sec ToMicrometersPerSecond

Meters per minute m/min ToMetersPerMinute

Meters per second m/sec ToMetersPerSecond


Temperature


Fahrenheit Fahrenheit ToFahrenheit

Rankine Rankine ToRankine

Celcius Celcius ToCelsius

Kelvin Kelvin ToKelvin

Time


Days days ToDays

Hours hours ToHours

Minutes minutes ToMinutes

Seconds seconds ToSeconds

Years years ToYears

Torque


Foot pound force ft-lbF ToFootPoundsOfForce

Newton-meters N-m ToNewtonMeters

Mathematical FunctionsThis topic lists the Mathematical function descriptions that are currently supported by the SmartSignalExpression Syntax feature.

Algebraic

Function Description Argument Example

Abs () Returns the absolute value of

a number

(Float value)

value: A value to find the

absolute value of

Abs(-9) = 9; Abs(9) = 9

Exp ( ) Returns e raised to the

specified power

(Float power)

power: A power to raise e to

Exp(2) = 7.389

Log ( ) Returns the natural (base-e)

logarithm of a number

(Float value)

value: A number to find its

natural logarithm

log(10) = 2.303



Log10 ( ) Returns the base 10 logarithm

of a number

(Float value)

value: A number to find its

base 10 logarithm

log10(10) = 1

Modulus ( ) The remainder after a number

is divided by a divisor

(Float dividend, Float divisor)

dividend: A dividend or

numerator of the division

divisor: A divisor or

denominator of the division

Modulus (5.3, 2.0) = 1.3

Power ( ) Returns the result of a number

raised to a power

(Float value, Float power)

value: The base of the

exponentiation

power: The power (exponent)

of the exponentiation

Power(2,3) = 8

Quotient ( ) Returns the integer portion of

a division

(Float dividend, Float divisor)

dividend: The dividend or

numerator of the division

divisor: The divisor or

denominator of the division

Quotient(13,5) = 2

Sign ( ) Returns the sign of a number:

1 if the number is positive, -1 if

the number is negative

(Float value)

value: A value to find the sign

of

sign(-5) = -1



Sqrt ( ) Returns the square root of a

number

(Float value)

value: A number to calculate

its square root

sqrt(4) = 2

Sum ( ) Returns the summation of a

set of tag values

(List<Float> tagValues, Float

lowerThreshold, Float

upperThreshold, Boolean

alwaysEvaluate)

tagValues: A list of tag values

on which the summation will

be evaluated. Either a list of

tags or a list of tag history can

be accepted. If a list of tags is

used only active tags (Active in

Asset checked) will be used

lowerThreshold: The lower

threshold will be applied to the

list of tagvalues. Any tag

value less than the

lowerThreshold will be

ignored during evaluation. If a

threshold is not specified or

NaN() than a lowerThresholdwill not be applied

upperThreshold: The upper



value greater than the

upperThreshold will be



NaN() than an

upperThreshold will not be

applied

alwaysEvaluate: When set to

true NaNs and tag values

outside of the threshold(s) will

be ignored and an summation

of the remaining tag values will

be returned. When set to false

any NaN or tag value outside

of the threshold(s) will cause a

NaN to be returned. If not

specified a value of true is

assumed

Sum([Tag1, Tag2, Tag3]); Sum

(Tag1.Actual(20))

Sum ([Tag1, Tag2, Tag3],

Tag1.ActualHigh,

Tag1,ActualLow, False)


Statistical


Average ( ) Returns the average of a set of

tag values




alwaysEvaluate)


on which the average will be

evaluated. Either a list of tags

or a list of tag history can be

accepted. If a list of tags is


Asset checked) will be used




value less than the












NaN() than an


applied.




be ignored and an average of

the remaining tag values will






assumed.

Average([Tag1, Tag2, Tag3]);

Average(Tag1.Actual(20));

Average([Tag1, Tag2, Tag3],

Tag1.ActualLow,

Tag1,ActualHigh, False)



Maximum ( ) Returns the maximum of a set

of tag values




alwaysEvaluate)


on which the maximum will be





Asset checked) will be used.




value less than the












NaN() than an


applied.











assumed.

Maximum([Tag1, Tag2, Tag3]);

Maximum (Tag1.Actual(20))

Maximum ([Tag1, Tag2, Tag3],

Tag1.ActualHigh,




Minimum ( ) Returns the minimum of a set

of tag values




alwaysEvaluate)


on which the maximum will be









value less than the












NaN() than an


applied.











assumed.

Minimum([Tag1, Tag2, Tag3]);

Minimum (Tag1.Actual(20))

Minimum ([Tag1, Tag2, Tag3],

Tag1.ActualHigh,




MeanShiftedWindow ( ) Returns the average of a set of

tag values over a window

shifted backwards from

current

(List<Float> tagValues, Integer

windowSize, Integer

windowStart)


to find the average of. Be sure

that the number of tag values

provided is greater than

windowSize + WindowStart

windowSize: The size of the

window to average the

tagValues

windowStart: The index

(datapolls) back from current

of where to start the

windowSize. A value of 0 will

not shift the window and yield

the same results as average()

MeanShiftedWindow(Tag.Actu

al(11), 5, 5)



Median ( ) Returns the median of a set of

tag values




alwaysEvaluate)


on which the median will be









value less than the












NaN() than an


applied




be ignored and an median of







assumed

Median([Tag1, Tag2, Tag3]);

Median (Tag1.Actual(20));

Median ([Tag1, Tag2, Tag3],

Tag1.ActualHigh,


Random ( ) Returns a random number

between the specified limits

(Integer minValue, Integer

maxValue)

minValue: The result will be

greater than or equal to

minValue

maxValue: The result will be

less than maxValue

Random(0, 1)



SlopePerPoll ( ) Returns the 1st order

regression modeling slope of a

set of tag valuesThe specified

tag values will be used for the

y coordinates. X coordinates

will be indexed. The resultant

slope will be measured in

change in tag value per index

(E.g. change in tag value per

datapoll rate)

(List<Float> tagValues)

tagValues: A set of tag values

to find the slope of

Slope(Tag.Actual(10))



Spread ( ) Returns the spread of a set of

tag values. Spread is the

difference between the

maximum and minimum tag

values




alwaysEvaluate)


on which the spread will be









value less than the




NaN() than a lowerThresholdwill not be applied.








NaN() than an


applied.




be ignored and an spread of







assumed.

Spread([Tag1, Tag2, Tag3]);

Spread (Tag1.Actual(20))

Spread ([Tag1, Tag2, Tag3],

Tag1.ActualHigh,




StandardDeviation ( ) Returns the standard

deviation of a set of tag values




alwaysEvaluate)


on which the spread will be









value less than the




NaN() than a lowerThresholdwill not be applied.








NaN() than an


applied.




be ignored and an spread of







assumed.

StandardDeviation([Tag1,

Tag2, Tag3]); Spread

(Tag1.Actual(20))

StandardDeviation ([Tag1,

Tag2, Tag3], Tag1.ActualHigh,




Variance ( ) Returns the variance of a set

of tag values




alwaysEvaluate)


on which the median will be









value less than the












NaN() than an


applied




be ignored and an median of







assumed

Variance([Tag1, Tag2, Tag3]);

Variance (Tag1.Actual(20))

Variance ([Tag1, Tag2, Tag3],

Tag1.ActualHigh,




VarianceShiftedWindow ( ) Returns the variance of a set

of tag values over a window

shifted backwards from

current

(List<Float> tagValues, Integer

windowSize, Integer

windowStart)


to find the variance of. Be sure

that the number of tag values

provided is greater than

windowSize + WindowStart

windowSize: The size of the

window to find the variance of

the tagValues

windowStart: The index

(datapolls) back from current

of where to start the

windowSize. A value of 0 will

not shift the window and yield

the same results as variance()

VarianceShiftedWindow(Tag.A

ctual(11), 5, 5)

Trignometric


Sin ( ) Returns the sine of an angle (Float angle)

angle: An angle in radians

Sin(π) = 0; Sin(π/2) = 1

Asin ( ) Returns the angle in radians

whose sine is the specified

number

(Float value)

value: A number representing

a sine

asin(0) = 0; asin(1) = π/2

Cos ( ) Returns the cosine of an angle (Float angle)


Cos(π) = -1; Cos(π/2) = 0

ACos ( ) Returns the angle in radians

whose cosine is the specified

number

(Float value)


a cosine

acos(0) = π/2; acos(1) = 0

Tan ( ) Returns the tangent of an

angle

(Float angle)


Tan(π) = 0; Tan(π/2) = ∞

Atan ( ) Returns the angle in radians

whose tangent is the specified

number

(Float value)


a tangent

atan(0) = 0; atan(1) = π/4

Atan2 ( ) Returns the angle in radians of

the specified x and y

coordinates

(Float x, Float y)

x: The x coordinate of a point

y: The y coordinate of a point

atan2(0,1) = π/2; atan2(1,0) =

0; atan2(1,1) = π/4

Pi ( ) Return the value of Pi (π N/A Pi() = π or 3.14159265…



ToRadians ( ) Converts an angle from

degrees to radians

(Float degrees)

degrees: An angle measured in

degrees

ToRadians(Tag.Actual)

ToDegrees ( ) Converts an angle from

radians to degrees

(Float radians)

radians: An angle measured in

radians

ToDegrees(Tag.Actual)

Smoothing


MovingAverage ( ) This function applies

smoothing by averaging the

set of tag values

(List<Float> values)

values: A set of tag history to

be smoothed

MovingAverage(Tag.Actual(6))

Olympic ( ) This function applies

smoothing by using a moving

average after discarding the

highest and lowest values



be smoothed

Olympic(Tag.Actual(6))

Spline ( ) This function applies

smoothing via a spline curve fit

of the data

(List<Float> values, Float

factor, Float stdDeviation)


be smoothed

factor: A value between 0 and

1 scaling the amount of fitting.

A value of 0 will fit the data to

a line, a value of 1 will result in

a perfect fit (i.e. no

smoothing). A factor of 0.25 is

often a good place to start.

stdDeviation: The standard

deviation of the data

Spline(Tag.Actual(6), 0.25,

Tag.ActualStandardDeviationR

eference)

Rounding


Round ( ) Returns the nearest integer

value

(Float value)

value: The number to be

rounded

Round(2.4) = 2, Round(2.5) = 3

RoundUp ( ) Returns the smallest integer

value that is greater than or

equal to a value

(Float value)


rounded up

RoundUp(5.3) = 6,

RoundUp(-5.3) = -5,

RoundUp(5) = 5



RoundDown ( ) Returns the largest integer

value that is less than or equal

to a value

(Float value)


rounded down

RoundDown(5.3) = 5,

RoundDown(-5.3) = -6

Truncate ( ) Truncates a number to an

integer by removing the

decimal

(Float value)


truncated

Truncate(6.6) = 6,

Truncate(-5.3) = -5


Logical FunctionsThis topic lists the Mathematical function descriptions that are currently supported by the SmartSignalExpression Syntax feature.


Logical Functions

Function Description Arguments Example

WindowRatio ( ) This function looks at a

window of data and compares

it to a threshold. If the number

of true comparisons is greater

than or equal to the trueSize

than windowRatio will return

true otherwise it will return

false

(Integer trueSize, List<Float>

values, String

comparisonOperator, Float

threshold, Integer

requiredGoodSize)

trueSize: The trueSize specifies

the number of true

comparison must be found in

the window (specified in

values) for windowRatio to

return True. When a NaN

present in values the

TrueSize is divided by the

window to create a ratio (or

percentage) for which

values: A list of tag values to

be compared to the threshold.

The window size is specified by

the size of the list. E.g.

Tag.Actual(20) is a window of

20

comparisonOperator: Specifies

how to compare the values to

the threshold. Valid options

are: =, >, <, >=, <=, !=. The

operator must be in quotes,

“=”

threshold: A threshold that the

values will be compared to

requiredGoodSize: The

required number of numeric

values. If the number of

numeric (non NaNs) in valuesis less than this value

windowRatio will return false.

Typically requiredGoodSize is

about one half the window

size

WindowRatio(17,

Tag.ResidualIndicationPositiv

e(18), ”=”, 1, 9)



Compare ( ) This function looks at a


it to a threshold. If the number

of true comparisons is greater

than or equal to the trueSize

than compare will return true

otherwise it will return false

(Integer trueSize, List<Float>

tagValues, String

compareOperator, Float

threshold)

trueSize: The trueSize specifies

the number of true

comparison must be found in

the window (specified in

tagValues) for windowRatio

to return True


to be compared to the

threshold. The window size is

specified by the size of the list.

E.g. Tag.Actual(20) is a window

of 20. When a NaN present in

tagValues compare will return

a false

compareOperator: Specifies

how to compare the

tagValues to the threshold.

Valid options are: =, >, <, >=,

<=, !=. The operator must be in

quotes, “=”


tagValues will be compared to

Compare(17,

Tag.ResidualIndicationPositiv

e(18), ”=”, 1)



IsConstantValue ( ) This function returns true if

the values provided are

constant in value.

The average of all provided

values is evaluated. A constant

value is determined if all

values are within one (plus or

minus) epsilon of the average.

If any value is a NaN the

function will return false. If any

value is outside of the

lowerThreshold or

upperThreshold the function

will return false.


epsilon, Float lowerThreshold,

Float upperThreshold)

values: A list of tag history

epsilon: Specifies the

resolution of how similar the

values most be to be

considered constant. All values

most be within + or - one

epsilon

lowerThreshold: All values

must be higher in value then

the lowerThreshold or the

function will return false.

Outlier checking can be

ignored by specifying a

lowerThreshold of Nan()

upperThreshold: All values

must be lower in value then

the upperThreshold or the

function will return false.

Outlier checking can be

ignored by specifying an

upperThreshold of NaN()

isConstantValue(Tag.Actual(10

), 0.00000001, Tag.ActualHigh,

Tag.ActualLow)

IsStep ( ) This function returns true if

there is a step change in

values provided.

Olympic smoothing will be

performed on the values

provided (excluding the most

recent observation) to obtain

the averageValue previous to

the most recent observation.

The two most recent

observations will be compared

to the averageValue evaluating

the difference. A step change

is determined if for both

comparisons: value –

averageValue > |

stepUpThreshold| or value –

averageValue < -|

stepDownThreshold|

(List<Float> actualValues,

Float stepUpThreshold, Float

stepDownThreshold )

values: A set of tag history

containing at least 4

observations E.g. Tag.Actual(7)

stepUpThreshold: Required

magnitude of the step change

in the positive direction. Step

up can be ignored by

specifying a stepUpThreshold

of NaN()

stepDownThreshold: Required

magnitude of the step change

in the negative direction. Step

down can be ignored by

specifying a stepUpThreshold

of NaN()

isStep(Tag.Actual(7),

Tag.StepHigh, Tag.StepLow)



IsBetween ( ) Returns true if the value is

between the lower and upper

thresholds

(Float value, Float


upperThreshold)

value: The value to validate is

between the lower and upper

thresholds


threshold for which value must

be greater than



be less than

trueSize: The minimum

number of values that must be

between the thresholds to

evaluate as true

isBetween(Tag.Actual,

Tag.ActualLow, Tag.ActualLow)

IsEqual ( ) Returns true if the left and

right values are equal to each

other within a value of epsilon

Using the equal symbol (”=”) is

the same as IsEqual() with an

epsilon of 0.00000001

(Float leftValue, Float

rightValue, Float epsilon

leftValue: The left side of the

equality

rightValue: The right side of

the equality

epsilon: The acceptable

amount of error. For IsEqual()

( to return true abs(leftValue –

rightValue) < epsilon

IsEqual(Tag1.Actual,

Tag2.Actual, 0.00000001)

IsNaN ( ) Returns true of the value is a

not a number (NaN)

(Float value)

value: The value to validate is a

NaN

IsNaN(Tag.Actual)

IsOutlier ( ) Returns true if the value are

outside the lower and upper

thresholds

(Float value, Float


upperThreshold)


an outlier



be less than



be greater than

IsOutlier(Tag.Actual,

Tag.ActuaLow, Tag.ActualLow)



IsNanOrOutlier ( ) Returns true if the value are


thresholds or a NaN

(Float value, Float

LowerThreshold, Float

upperThreshold)


an outlier or NaN

LowerThreshold: The lower


be less than



be greater than

IsNanOrOutlier(Tag.Actual,

Tag.ActualLow,

Tag.ActualHigh)

IsNanOrOutlier ( ) Returns true if the value are


thresholds or a NaN

(Float value, Float

LowerThreshold, Float

upperThreshold)


an outlier or NaN

LowerThreshold: The lower


be less than



be greater than

index: The index (datapolls)

back from current of where to

validate the a value. An index

of 0 will not shift the window

and yield the same results as

using InNanOrOutlier without

an index

InNanOrOutlier(Tag.Actual(6),

Tag.ActualLow,

Tag.ActualHigh, 5)



IsValidHistoryLength ( ) Returns true if all values are

valid.

Invalid values are NaNs or

values outside the lower and

upper thresholds



upperThreshold)



threshold for which all values

must be greater than. The

lower threshold can be ignored

by specifying NaN()



must be less than. The upper

threshold can be ignored by

specifying NaN()

isValidHistoryLength(Tag.Actu

al(10), Tag.OutlierNegative,

Tag.OutlierPositive)

IsValidHistoryLength ( ) Returns true if the number of

valid values is greater than or

equal to windowSize.

Invalid values are NaNs or

values outside the lower and

upper thresholds

(List<Float> values, Integer

windowSize, Float


upperThreshold)


windowSize: The required

number of valid values in the

tag history



must be greater than. The

lower threshold can be ignored

by specifying NaN()



must be less than. The upper

threshold can be ignored by

specifying NaN()

IsValidHistoryLength(Tag.Actu

al(12), 10, Tag.OutlierNegative,



Counting FunctionsThis topic lists the Mathematical function descriptions that are currently supported by the SmartSignalExpression Syntax feature.

Counting Functions


CountComparison ( ) This function looks at a


it to a threshold then returns

the number of times the

comparison returns a true

result

(List<Float> tagValues, String

comparisonOperator, Float

threshold)


to be compared to the

threshold. The window size is

specified by the size of the list.

E.g. Tag.Actual(20) is a window

of 20

comparisonOperator: Specifies

how to compare the values to

the threshold. Valid options

are: =, >, <, >=, <=, !=. The

operator must be in quotes,

“=”


tagValues will be compared to

CountComparison(Tag.Actual(

10), “>”, Tag.ActualHigh)

CountOutliers ( ) This function looks at a

window of data and returns

the number of times an outlier

is found



upperThreshold)


look for outliers in



be less than



be greater than

CountOutliers(Tag.Actual(10),

Tag.OutlierNegative,


CountNaNs ( ) This function looks at a list of

values and returns the number

of times an NaN is found



look for NaNs in

CountNaNs(Tag.Actual(10));

CountNaNs([Tag1.Actual,

Tag2.Actual])


Steam Table FunctionsAll steam table function require a unitSet input. This is an integer from 0 to 6 that picks a set of units fromthe below table. The specified unitSet determines the require unit of measure of all inputs as well as theunit of measure of the functional output.

Unit Set English SICustomary

EnglishGauge

SI Formal SI kPa Metric MetricFormal

Unit Set

Number

0 1 2 3 4 5 6

Unit Set

Name

"ENG" "SI" "ENGG" "SIF" "SIK" "MET" "METF"

Temperature °F °C °F K °C °C °C

Pressure Psia Bar Psig Mpa kPa Bar kg/cm2

Enthalpy Btu/lbm kJ/kg Btu/lbm kJ/kg kJ/kg kcal/kg kcal/kg

Entropy Btu/lbm/°F kJ/kg/°C Btu/lbm/°F kJ/kg/°C kJ/kg/°C kJcalkg/°C kJcalkg/°C

Specific

Volume

Ft3/lb mt3/kg Ft3/lb mt3/kg mt3/kg mt3/kg mt3/kg

Quality Non-Dim Non-Dim Non-Dim Non-Dim Non-Dim Non-Dim Non-Dim

Specific Heat Btu/lb/°F kJ/kg/°C Btu/lb/°F kJ/kg/°C kJ/kg/°C kcal/kg/°C kcal/kg/°C

Thermal

Conductivity

Btu/hr/ft/°F Watt/m/°C Btu/hr/ft/°F Watt/m/K Watt/m/°C Watt/m/°C kcal/m/h/°C

Dynamic

Viscosity

lbm/ft/hr Centipoise lbm/ft/hr Pa-sec Centipoise Centipoise Centipoise

Isentropic

Expansion

Coefficient

Non-Dim Non-Dim Non-Dim Non-Dim Non-Dim Non-Dim Non-Dim

Sonic Velocity ft/sec m/sec ft/sec m/sec m/sec m/sec m/sec


Saturation

StemTableSaturationPressure

( )

Returns the corresponding

saturation steam pressure for

the provided saturation

temperature

(Float temperature, Integer

unitSet)

temperature: A saturated

steam temperature value

StemTableSaturationPressure(

Tag1.Actual.ToFahrenheit, 0)

SteamTableSaturationTemper

ature ( )


saturation steam temperature

for the provided saturation

pressure

(Float pressure, Integer

unitSet)

pressure: A saturated steam

pressure value

SteamTableSaturationTemper

ature(Tag1.Actual.ToPoundsPe

rSquareInchAbsolute, 0)



SteamTableDynamicViscosity

( )

Returns the dynamic viscosity

of steam

(Float pressure, Float

temperature, Integer unitSet)

pressure: A steam pressure

value

temperature: A steam

temperature value

SteamTableDynamicViscosity(

Tag1.Actual.ToPoundsPerSqua

reInchAbsolute,


SteamTableDynamicViscosityP

Q ( )


of steam

(Float pressure, Float quality,

Integer unitSet)


value

quality: A steam quality. Vapor

quality is the percentage of

mass in a saturated mixture

that is vapor.

SteamTableDynamicViscosityP

Q(Tag1.Actual.ToPoundsPerSq

uareInchAbsolute, Tag2, 0)

SteamTableDynamicViscosityT

Q ( )


of steam

(Float temperature, Float

quality, Integer unitSet)


temperature value




that is vapor.

SteamTableDynamicViscosityT

Q(Tag1.Actual.ToFahrenheit,

Tag2, 0)

Enthalpy

SteamTableEnthalpy ( ) Returns the enthalpy of steam (Float pressure, Float



value


temperature value

SteamTableEnthalpy(Tag1.Act

ual.ToPoundsPerSquareInchAb

solute,


SteamTableEnthalpyPS ( ) Returns the enthalpy of steam (Float pressure, Float entropy,

Integer unitSet)


value

entropy: A steam entropy

value

SteamTableEnthalpyPS(Tag1.A

ctual.ToPoundsPerSquareInch

Absolute, Tag2, 0)

SteamTableEnthalpyPQ ( ) Returns the enthalpy of steam (Float pressure, Float quality,

Integer unitSet)


pressure value




that is vapor.

SteamTableEnthalpyPQ(Tag1.

Actual.ToPoundsPerSquareInc

hAbsolute, Tag2, 0)



SteamTableEnthalpyTQ ( ) Returns the enthalpy of steam (Float temperature, Float



temperature value




that is vapor.

SteamTableEnthalpyTQ

(Tag1.Actual.ToFahrenheit,

Tag2, 0)

Entropy

SteamTableEntropy ( ) Returns the entropy of steam (Float pressure, Float



value


temperature value

SteamTableEntropy(Tag1.Actu

al.ToPoundsPerSquareInchAbs

olute,


SteamTableEntropyPH ( ) Returns the entropy of steam (Float pressure, Float enthalpy,

Integer unitSet)


value

enthalpy: A steam enthalpy

value

SteamTableEntropyPH(Tag1.A


Absolute, Tag2, 0)

SteamTableEntropyPQ ( ) Returns the entropy of steam (Float pressure, Float quality,

Integer unitSet)


value




that is vapor.

SteamTableEntropyPQ(Tag1.A


Absolute, Tag2, 0)

SteamTableEntropyTQ ( ) Returns the entropy of steam (Float temperature, Float


temperature A steam

temperature value

quality A steam quality. Vapor



that is vapor.

SteamTableEntropyTQ(Tag1.A

ctual.ToFahrenheit, Tag2, 0)

Isentropic Expansion Coefficient



SteamTableIsentropicExpansio

n ( )

Returns the isentropic

expansion of steam




value


temperature value


n(Tag1.Actual.ToPoundsPerSq

uareInchAbsolute,



nPH ( )


expansion of steam

(Float pressure, Float enthalpy,

Integer unitSet)


value


value


nPH(Tag1.Actual.ToPoundsPer

SquareInchAbsolute, Tag2, 0)


nPS ( )


expansion of steam

(Float pressure, Float entropy,

Integer unitSet)


value


value


nPS(Tag1.Actual.ToPoundsPer



nPQ ( )


expansion of steam


Integer unitSet)


pressure value




that is vapor.


nPQ(Tag1.Actual.ToPoundsPer



nTQ ( )


expansion of steam




temperature value




that is vapor


nTQ(Tag1.Actual.ToFahrenheit,

Tag2, 0)

Sonic Velocity

SteamTableSonicVelocity ( ) Returns the sonic velocity of

steam




value


temperature value

SteamTableSonicVelocity(Tag1

.Actual.ToPoundsPerSquareInc

hAbsolute,




SteamTableSonicVelocityPH ( ) Returns the sonic velocity of

steam


Integer unitSet)


value


value

SteamTableSonicVelocityPH(T

ag1.Actual.ToPoundsPerSquar

eInchAbsolute, Tag2, 0)

SteamTableSonicVelocityPS ( ) Returns the sonic velocity of

steam


Integer unitSet)


value


value

SteamTableSonicVelocityPS(Ta

g1.Actual.ToPoundsPerSquareI

nchAbsolute, Tag2, 0)

SteamTableSonicVelocityPQ ( ) Returns the sonic velocity of

steam


Integer unitSet)


pressure value




that is vapor.

SteamTableSonicVelocityPQ(T

ag1.Actual.ToPoundsPerSquar

eInchAbsolute, Tag2, 0)

SteamTableSonicVelocityTQ ( ) Returns the sonic velocity of

steam




temperature value




that is vapor

SteamTableSonicVelocityTQ(T

ag1.Actual.ToFahrenheit, Tag2,

0)

Specific Volume

SteamTableSpecificVolume ( ) Returns the specific volume of

steam




value


temperature value

SteamTableSpecificVolume(Ta


nchAbsolute,


SteamTableSpecificVolumePH

( )

Returns the specific volume of

steam


Integer unitSet)


value


value

SteamTableSpecificVolumePH(


reInchAbsolute, Tag2, 0)



SteamTableSpecificVolumePS

( )


steam


Integer unitSet)


value


value

SteamTableSpecificVolumePS(



SteamTableSpecificVolumePQ

( )


steam


Integer unitSet)


value




that is vapor.

SteamTableSpecificVolumePQ(



SteamTableSpecificVolumeTQ

( )


steam




temperature value




that is vapor.

SteamTableSpecificVolumeTQ(

Tag1.Actual.ToFahrenheit,

Tag2, 0)

Specific Heat

SteamTableSpecificHeat ( ) Returns the specific heat of

steam




value


temperature value

SteamTableSpecificHeat(Tag1.


hAbsolute,


SteamTableSpecificHeatPH ( ) Returns the specific heat of

steam


Integer unitSet)


value


value

SteamTableSpecificHeatPH(Ta



SteamTableSpecificHeatPS ( ) Returns the specific heat of

steam


Integer unitSet)


value


value

SteamTableSpecificHeatPS(Ta





SteamTableSpecificHeatPQ ( ) Returns the specific heat of

steam


Integer unitSet)


pressure value




that is vapor.

SteamTableSpecificHeatPQ(Ta



SteamTableSpecificHeatTQ ( ) Returns the specific heat of

steam




temperature value




that is vapor.

SteamTableSpecificHeatTQ(Ta

g1.Actual.ToFahrenheit, Tag2,

0)

Temperature

SteamTableTemperaturePH ( ) Returns the temperature of

steam


Integer unitSet)


value


value

SteamTableTemperaturePH(Ta



SteamTableTemperaturePS ( ) Returns the temperature of

steam


Integer unitSet)


value


value

SteamTableTemperaturePS(Ta



Thermal Conductivity

SteamTableThermalConductivi

ty ( )

Returns the thermal

conductivity of steam




value


temperature value


ty(Tag1.Actual.ToPoundsPerSq

uareInchAbsolute,





tyPQ ( )

Returns the thermal



Integer unitSet)


value




that is vapor.


tyPQ(Tag1.Actual.ToPoundsPer



tyTQ ( )

Returns the thermal





temperature value




that is vapor


tyTQ(Tag1.Actual.ToFahrenheit

, Tag2, 0)

Quality

SteamTableQualityPH ( ) Returns the quality of steam (Float pressure, Float enthalpy,

Integer unitSet)


pressure value

enthalpy: A saturated steam

enthalpy value

SteamTableQualityPH(Tag1.Ac

tual.ToPoundsPerSquareInchA

bsolute, Tag2, 0)

SteamTableQualityPS ( ) Returns the quality of steam (Float pressure, Float entropy,

Integer unitSet)


pressure value

entropy: A saturated steam

entropy value

SteamTableQualityPQ(Tag1.Ac

tual.ToPoundsPerSquareInchA

bsolute, Tag2, 0)

Temperature Scale Conversion

SteamTableTemperatureTo199

0 ( )


1990 steam temperature for

the provided 1968 steam

temperature


unitSet)


temperature value


0(Tag1.Actual.ToFahrenheit, 0)


8 ( )


1968 steam temperature for

the provided 1990 steam

temperature


unitSet)


temperature value


8(Tag1.Actual.ToFahrenheit, 0)


Equipment Specific Functions


Airplane Engine

NonLinearFuelFlowEstimate ( ) - (Float totalAirTemperature,

Float pressureAltitude, Float

aircraftMachNumber, Float

mainEngineControl, Float

beta1, Float beta2, Float

beta3, Float beta4, Float

beta5, Float beta6)

-

Air Heater

AirHeaterEfficiency ( ) Returns air heater efficiency

(percentage, ratio of gas heat

transfer to the air) assuming

no leakage

(Float inletGasTemp, Float

outletGasTemp, Float

inletAirTemp)

inletGasTemp: DEG F -- Gas

inlet temp to the air heater

from the boiler

outletGasTemp: DEG F -- Gas

outlet temp from the air

heater

inletAirTemp: DEG F -- Air inlet

temp to the air heater

AirHeaterEfficiency(Gas_Inlet_

Temp_Mean.Actual.ToFahrenh

eit,

Gas_Outlet_Temp_Mean.Actua

l.ToFahrenheit,

Air_Inlet_Temp_Mean.Actual.To

Fahrenheit)

AirHeaterEfficiency2 ( ) Returns air heater efficiency

(percentage, ratio of gas heat

transfer to the air) accounting

for leakage with an

assumption of 20.9 % oxygen

in air



inletAirTemp, Float

inletGasOxygenConcentration,

Float

outletGasOxygenConcentratio

n)



from the boiler



heater


temp to the Air Heater

inletGasOxygenConcentration:

% -- Flue gas oxygen content

into the Air Heater


n: % -- Flue gas oxygen content

out of the Air Heater

AirHeaterEfficiency2(Gas_Inlet

_Temp_Mean.Actual.ToFahrenh

eit,


l.ToFahrenheit,


Fahrenheit,

O2_Concencentation_In,

O2_Concentration_Out)



AirHeaterLeakageRate ( ) Returns the leakage rate (%)

with an assumption of 20.9%

oxygen in air

(Float


Float


n)



into the air heater



out of the air heater

AirHeaterLeakageRate(O2_Co

ncencentation_In,


AirHeaterThermalPower ( ) Returns the thermal power

(Btu/hr) of the air heater using

an assumed Cp for air of 0.245

(Btu/lbm.F)

(Float airFlowrate, Float

inletAirTemp, Float

outletAirTemp)

airFlowrate: Lbm/hr -- Air

mass flow rate through the air-

side


temp to the air-side

outletAirTemp: DEG F -- Air

outlet temp from the air-side

AirHeaterThermalPower(Total

_Mass_Air_Flow.Actual.ToPoun

dsOfMassPerHour,


Fahrenheit,

Air_Outlet_Temp_Mean.Actual.

ToFahrenheit)

AirHeaterCrossRatio ( ) Returns the X-ratio (unitless,

the ratio of gas temperature

drop to air temperature rise)

assuming no leakage



inletAirTemp, Float

outletAirTemp)



from the boiler



heater





AirHeaterCrossRatio(Gas_Inlet

_Temp_Mean.Actual.ToFahrenh

eit,Gas_Outlet_Temp_Mean.Ac

tual.ToFahrenheit,


Fahrenheit,


ToFahrenheit)



AirHeaterCrossRatio2 ( ) Returns the X-ratio (Unitless,

ratio of gas temperature drop

to air temperature rise)

accounting for leakage with

the assumption of 20.9%

oxygen in air



inletAirTemp, Float

outletAirTemp, Float


Float


n)



from the boiler



heater







into the air heater



out of the air heater

AirHeaterCrossRatio2(Gas_Inl

et_Temp_Mean.Actual.ToFahre

nheit,


l.ToFahrenheit,


Fahrenheit,


ToFahrenheit,

O2_Concencentation_In,


Heat Exchanger

SteamHeatExchangerThermal

Power ( )

Returns the heat exchanger

thermal power (Btu/lb) of a

steam heat exchanger via

steam table functions

(Float flowrate, Float

inletPressure, Float inletTemp,

Float outletTemp)

flowrate: Klbm/hr -- Mass

flowrate of the water to be

heated

inletPressure: PSIG -- Pressure

of the water to be heated

inletTemp: DEG F -- Inlet

temperature of the water to

be heated

outletTemp: DEG F -- Outlet

temperature of the water to

be heated

SteamHeatExchangerThermal

Power(Feedwater_Flow.Actual.

ToThousandsOfPoundsOfMass

PerHour,

Feedwater_Pressure.Actual.To

PoundsPerSquareInchGauge,

Feedwater_Heater_Inlet_Temp.

Actual.ToFahrenheit,

Feedwater_Heater_Outlet_Tem

p.Actual.ToFahrenheit)



HeatExchangerLogMeanTemp

eratureDiff ( )

Returns the log-mean

temperature difference of a

heat exchanger in the same

units of the inputs. All inputs

must be in consistent

temperature units

(Float hotFluidInletTemp, Float

coldFluidInletTemp, Float

hotFluidOutletTemp, Float

coldFluidOutletTemp)

hotFluidInletTemp: Consistent

Temps -- Hot side inlet temp of

the heat exchanger

coldFluidInletTemp: Consistent

Temps -- Cold side inlet temp

of the heat exchanger

hotFluidOutletTemp:

Consistent Temps -- Hot side

outlet temp of the heat

exchanger

coldFluidOutletTemp:

Consistent Temps -- Cold side

outlet temp of the heat

exchanger

HeatExchangerLogMeanTemp

eratureDiff(Hot_Process_Gas_T

emp,

Cooling_Water_Supply_Temp,

Cooled_Process_Gas_Temp,

Cooling_Water_Outlet_Temp)

Centrifugal Compressor

CompressorHorsePower ( ) This returns the compression

work (hp) by the compressor

(Float polytropicHead, Float

volumetricFlowRate, Float

polytropicEfficiency, Float

molecularWeight)

polytropicHead: Ft --

Polytropic head of the

compressor process stage

volumetricFlowRate: Mft3/day

-- Volumetric flow rate of the


polytropicEfficiency: % --

Polytropic efficiency of the


molecularWeight: Lbm/mole --

Process gas molecular weight

CompressorHorsePower(Proc

ess_Stage_1_Polytropic_Head,

Process_Stage_1_Suction_Flo

w.Actual.ToMillionsOfCubicFee

tPerDay,

Process_Stage_1_Polytropic_Eff

iciency,

Process_Stage_1_Gas_Molecul

ar_Weight)

CompressorPolytropicEfficienc

y ( )

This returns the Polytropic

Efficiency (%, the ratio of the

work performed by the

compressor under ideal

polytropic conditions to the

actual work performed by the

compressor) of a compressor

process stage

(Float pressureRatio, Float

temperatureRatio, Float

specificHeatRatio)

pressureRatio: Unitless --

Compressor pressure ratio

temperatureRatio: Unitless --

Compressor temperature ratio

specificHeatRatio: Unitless --

Process gas specific heat ratio

(Gamma, Cp/Cv)

CompressorPolytropicEfficienc

y(Process_Stage_1_Press_Rati

o,

Process_Stage_1_Temp_Ratio,

Process_Stage_1_Gas_Specific

_Heat_Ratio)



CompressorPolytropicHead ( ) Returns the polytropic head

(feet) of a compressor


suctionTemp, Float

specificHeatRatio, Float

molecularWeight, Float

compressibilityFactor)


Pressure ratio of the


suctionTemp: DEG F --

Compressor suction gas temp

specificHeatRatio: Unitless --

Process gas specific heat ratio

(Gamma, Cp/Cv)

molecularWeight: Lbm/mole --

Process gas molecular weight

compressibilityFactor: Unitless

-- Process gas compressibility

factor (Z)

CompressorPolytropicHead(Pr

ocess_Stage_1_Press_Ratio,

Process_Stage_1_Suction_Tem

p.Actual.ToFahrenheit,

Process_Stage_1_Gas_Specific

_Heat_Ratio,

Process_Stage_1_Gas_Molecul

ar_Weight,

Process_Stage_1_Gas_Compre

ssibility_Factor)

Combustion Turbine

CTCompressorEfficiency ( ) Returns the compressor

isentropic efficiency (%, ratio

of the work performed by the

compressor under ideal

isentropic compression to the

actual work performed by the

compressor) using a gamma

(Cp/Cv) of 1.4 for air at 59 DEG

F and 14.7 psia


temperatureRatio)


Compressor pressure ratio


Compressor temperature ratio

CTCompressorEfficiency(Comp

ressor_Press_Ratio,

Compressor_Temp_Ratio)

CTModifiedWobbeIndex ( ) Returns the Modified Wobbe

Index (Unitless) which is a

temperature-corrected

measure of the volumetric

energy content of the fuel gas.

The function uses the

measuredHeatValue if

available otherwise the

defaultHeatValue will be used

(Float fuelGasSupplyTemp,

Float measuredHeatValue,

Float defaultHeatValue)

fuelGasSupplyTemp: DEG F --

Fuel gas temperature

measuredHeatValue: Btu/ft3 --

Measured fuel gas heating

value

defaultHeatValue: Btu/ft3 --

Assumed constant fuel gas

heating value when a

measured value is unavailable

CTModifiedWobbeIndex(Fuel_

Gas_Supply_Temp.Actual.ToFa

hrenheit,

Fuel_Gas_Heating_Value,

Fuel_Gas_Heating_Value_Cons

tant)



CTPressureRatio ( ) Returns the compressor

pressure ratio (unitless). The

function uses the first

available tag among the

inletPressure,

barometricPressure, and

differentialPressure to

calculate the pressure ratio. If

none are available the function

uses standard atmospheric

pressure (14.69595 psia)

(Float OutletPressure, Float

InletPressure, Float

barometricPressure, Float

differentialPressure)

OutletPressure: PSIG --

Compressor discharge

pressure

inletPressure: PSIA --

Compressor static inlet

pressure

barometricPressure: PSIA --

Barometric pressure as a

proxy for inlet pressure

differentialPressure: PSIA --

Differential pressure across

the inlet from standard

pressure

CTPressureRatio(Compressor_

Discharge_Press_Selected.Act

ual.ToPoundsPerSquareInchGa

uge,

Compressor_Inlet_Press_Absol

ute.Actual.ToPoundsPerSquare

InchAbsolute,

Barometric_Press.Actual.ToPo

undsPerSquareInchAbsolute,

Compressor_Inlet_Press_Drop.


hAbsolute)

CTTemperatureRatio ( ) Returns the temperature ratio

(unitless). Both inputs must be

consistent absolute

temperatures

(Float outletTemp, Float

inletTemp)

outletTemp: Kelvin, Rankine --

Compressor discharge temp

inletTemp: Kelvin, Rankine --

Compressor inlet temp

CTTemperatureRatio(Compres

sor_Discharge_Temp_Median.A

ctual.ToRankine,

Compressor_Inlet_Temp_Medi

an.Actual.ToRankine)

CTThermalEfficiency ( ) Returns the CT overall thermal

efficiency (%, ratio of the total

power produced by the CT to

the power available in the

natural gas fuel)

The function uses the

volumetricFuelFlowRate if


massFuelFlowRate will be

used. massFuelFlowRate is

converted to volumetric flow

using specific volume 20 (ft3/

lbm) for natural gas. The

function uses the

measuredHeatValue if


defaultHeatValue will be used.

(Float turbinePower, Float

volumetricFuelFlowRate, Float

massFuelFlowRate, Float

measuredHeatValue, Float

defaultHeatValue)

turbinePower: MW -- Power

output of the CT

volumetricFuelFlowRate: ft3/hr

-- Total volumetric fuel flow

rate

massFuelFlowRate: Lbm/hr --

Total mass fuel flow rate

measuredHeatValue: Btu/ft3 –

Measured fuel gas heating

value

defaultHeatValue: Btu/ft3 --

Assumed constant fuel gas

heating value when a

measured value is unavailable

CTThermalEfficiency(Gross_Lo

ad.Actual.ToMegawatts,

Volumetric_Fuel_Flow.Actual.T

oCubicFeetPerHour,

Mass_Fuel_Flow.Actual.ToPoun

dsOfMassPerHour,

Gas_Fuel_Heating_Value,

1030)



CTTurbineEfficiency ( ) Returns the turbine isentropic

efficiency (%, ratio of the

actual performed by the

turbine to the work performed

under ideal isentropic

expansion). The function uses

a gamma (Cp/Cv) of 1.4 of air

at 59 DEG F and 14.7 psia


temperatureRatio)

pressureRatio: Unitless -- This

is the turbine expansion ratio

(in/out)


This is the turbine

temperature ratio (in/out)

CTTurbineEfficiency(Power_Tur

bine_Press_Ratio,

Power_Turbine_Temp_Ratio)

Steam Turbine

SteamTurbineEfficiency ( ) Returns the Steam Turbine


of the actual power extracted

from the steam to the ideal,

isentropic power). The process

is assumed to be adiabatic and

the ideal state (H2s) involves

no increase in entropy. The

function will return a NaN

anytime the turbine exhaust

temperature is at or below the

saturation temperature and

uses steam table lookups

(Float exhaustPressure, Float

inletPressure, Float

exhaustTemp, Float inletTemp)

exhaustPressure: PSIG --

Steam turbine exhaust

pressure

inletPressure: PSIG -- Steam

turbine inlet pressure (after

valves)

exhaustTemp: DEG F -- Steam

turbine exhaust temperature

inletTemp: DEG F -- Steam

turbine inlet temperature

(after valves)

SteamTurbineEfficiency(Turbin

e_Exhaust_Steam_Press_Mean

.Actual.ToPoundsPerSquareInc

hGauge,

Turbine_Inlet_Steam_Press_M

ean.Actual.ToPoundsPerSquar

eInchGauge,

Turbine_Exhaust_Steam_Temp

_Mean.Actual.ToFahrenheit,

Turbine_Inlet_Steam_Temp_M

ean.Actual.ToFahrenheit)

SteamTurbineFlow ( ) Returns the steam turbine

flow function (ft2). It is a

function of the effective cross-

sectional area of the flow-path

past the turbine blades. This

function uses steam tables to

lookup the specific volume of

steam

(Float steamFlowRate, Float

inletPressure, Float inletTemp)

steamFlowRate: Klb/hr --

Steam turbine inlet steam flow

rate


turbine inlet steam pressure

(after control valves)


turbine inlet steam

temperature

SteamTurbineFlow(HPT_Inlet_

Steam_Flow_Median.Actual.To

ThousandsOfPoundsOfMassPe

rHour,

HPT_First_Stage_Steam_Press

_MT1.Actual.ToPoundsPerSqua

reInchGauge, HPT_ First_Stage

_Steam_Temp_Mean.Actual.To

Fahrenheit)



SteamTurbineHighPressureEffi

ciency ( )

Returns the steam turbine







no increase in entropy. The

function will return a NaN

anytime the turbine exhaust

temperature is at or below the

saturation temperature and

uses steam table lookups

(Float inletPressure, Float

inletTemp, Float

exhaustPressure, Float

exhaustTemp)


turbine inlet pressure (after

valves)


turbine inlet temperature

(after valves)



pressure

exhaustTemp: DEG F -- Steam

turbine exhaust temperature

SteamTurbineEfficiency(HPT_Fi

rst_Stage_Steam_Press_MT1.A


Gauge, HPT_

First_Stage_Steam_Temp_Mea

n.Actual.ToFahrenheit,HPT_CR

H_Press_MT1.Actual.ToPounds

PerSquareInchGauge,

HPT_Exhaust_Steam_Temp_MT

1.Actual.ToFahrenheit)

SteamTurbineLowPressureEffi

ciency ( )

Returns the steam turbine






the ideal state (H2s) uses the

entropy at the inlet to

determine the enthalpy at the

exhaust for wet steam

(Float inletPressure, Float

inletTemp, Float

exhaustPressure, Float

exhaustSteamQuality)


turbine inlet steam pressure


turbine inlet steam

temperature



pressure

exhaustSteamQuality: Unitless

(0-1) -- Steam turbine exhaust

steam quality

SteamTurbineLowPressureEffi

ciency(LP_turbine_Inlet_Press.


hGauge,

LP_Turbine_inlet_Temp.Actual.

ToFahrenheit,

LP_Turbine_Exhaust_Press.Act

ual.ToPoundsPerSquareInchGa

uge,

LP_Turbine_Exhaust_Steam_Q

uality_Calculated)

Pump

PumpDriverPower ( ) This returns the driver power

(Hp) required at the current

conditions

(Float hydraulicPower, Float

efficiency)

hydraulicPower: Hp --

Hydraulic power to pump the

fluid

efficiency: Unitless (0-1) --

Pump efficiency

PumpDriverPower(Pump_Hydr

aulic_Power.Actual.ToHorsepo

wer,

(Pump_efficiency_Percent/

100))



PumpEfficiency ( ) Returns the pump isentropic

efficiency (%, ratio of the

actual power used to pump

water to the ideal, isentropic

power). The process is

assumed to be adiabatic and


no increase in entropy. This

function is for water pumping

applications and uses steam

table lookups

(Float dischargePressure, Float

suctionPressure, Float

dischargeTemp, Float

suctionTemp)

dischargePressure: PSIG --

Pump discharge pressure

suctionPressure: PSIG -- Pump

suction pressure

dischargeTemp: DEG F -- Pump

discharge temperature

suctionTemp: DEG F -- Pump

suction temperature

PumpEfficiency(Feedpump_dis

charge_Press.Actual.ToPounds

PerSquareInchGauge,

Feedpump_Suction_Press.Actu

al.ToPoundsPerSquareInchGau

ge,

Feedpump_Discharge_Temp.A

ctual.ToFahrenheit,

Feedpump_Suction_Temp.Actu

al.ToFahrenheit)

PumpHydraulicPower ( ) Returns the required pump

hydraulic power (hp) pump

water at the current pressures

and flow rates. This function is

for water pumping

applications and uses steam

table lookups

(Float dischargeFlowRate,

Float dischargePressure, Float


dischargeTemp)

dischargeFlowRate: Klbm/hr --

Pump water mass flow rate




suction pressure

dischargeTemp: DEG F --

Water temperature moved

through the pump for specific

volume lookup

PumpHydraulicpower(Conden

sate_Flow.Actual.ToThousands

OfPoundsOfMassPerHour,

Condensatepump_discharge_P

ress.Actual.ToPoundsPerSquar

eInchGauge,

Condsatepump_Suction_Press.


hGauge,

Condensate_Temp.Actual.ToFa

hrenheit)

PumpTorque ( ) Returns the pump torque (ft-

lbf)

(Float driverPower, Float

speed)

driverPower: Hp -- Pump shaft

power

speed: RPM -- Pump speed

PumpTorque(Pump_Motor_Dri

ver_Power.Actual.ToHorsepow

er,

Pump_Speed.Actual.ToRevoluti

onsPerMinute)

PumpTotalDischargeHead ( ) Returns the pump total

discharge head (Ft). This

function uses steam table

lookups and is only applicable

for applications that pump

water

(Float dischargePressure, Float


dischargeTemp)




suction pressure

dischargeTemp: DEG F --

Water temperature moved

through the pump for specific

volume lookup

PumpTotalDischargeHead(Con

densate_Pump_Discharge_Pre

ss.Actual.ToPoundsPerSquareI

nchGauge,

Condsate_Pump_Suction_Pres

s.Actual.ToPoundsPerSquareIn

chGauge,

Condensate_Temp.Actual.ToFa

hrenheit)

Journal Bearing (Extended Vibration Monitoring)



ForwardAmplitude ( ) Returns the magnitude of the

forward component of a

vibration vector. This function

checks for probe quality as the

last argument before returning

an output otherwise it returns

NaN

(float amplitudeA, float

amplitudeB, float phaseA, float

phaseB, boolean

isRadianUnitAngleMeasureme

nt, boolean

isValidVibrationProbeSignal)

amplitudeA: The filtered

amplitude of a vibration

reading typically called X or

Horizontal

amplitudeB: The filtered


reading typically called Y or

Vertical

phaseA: The filtered phase of a

vibration reading typically

called X or Horizontal

phaseB: The filtered phase of a


called Y or Vertical


nt: True/False: A Boolean

statement to define the units

of measurement of the phase

signals. Typically an internal

tag. True=Radians,

False=Degrees

isValidVibrationProbeSignal:

True/False: A Boolean

statement to define the sensor

validity of the readings coming

for amplitudeA and

amplitudeB, this can be a

dynamically updating

calculation or an embedded

function

ForwardAmplitude(DE_BRG_VI

B_HOR_1X_AMPLITUDE,

DE_BRG_VIB_VER_1X_AMPLITU

DE,

DE_BRG_VIB_HOR_1X_PHASE,

DE_BRG_VIB_VER_1X_PHASE,

PHASE_MEASUREMENT_ISRAD

IAN.defaultvalue,

(DE_BRG_VIB_HOR_1X_ISVALI

D AND

DE_BRG_VIB_VER_1X_ISVALID)

)



ReverseAmplitude ( ) Returns the magnitude of the

reverse component of a





NaN



phaseB, boolean


nt, boolean





Horizontal




Vertical












tag. True=Radians,

False=Degrees





for amplitudeA and




function

ReverseAmplitude(DE_BRG_VI

B_HOR_1X_AMPLITUDE,


DE,




IAN.defaultvalue,


D AND


)



ForwardPhase ( ) Returns the direction (polar) of

the forward component of a





NaN



phaseB, boolean


nt, boolean





Horizontal




Vertical












tag. True=Radians,

False=Degrees





for amplitudeA and




function

ForwardPhase(DE_BRG_VIB_H

OR_1X_AMPLITUDE,


DE,




IAN.defaultvalue,


D AND


)



ReversePhase ( ) Returns the direction (polar) of

the reverse component of a





NaN



phaseB, boolean


nt, boolean





Horizontal




Vertical












tag. True=Radians,

False=Degrees





for amplitudeA and




function

ReversePhase(DE_BRG_VIB_H

OR_1X_AMPLITUDE,


DE,




IAN.defaultvalue,


D AND


)



MajorAxis ( ) Returns the magnitude for the

major axis of a filtered orbit.

The major axis is the sum of

the forward and reverse

amplitudes. This function




NaN



phaseB, boolean


nt, boolean





Horizontal




Vertical












tag. True=Radians,

False=Degrees





for amplitudeA and




function

MajorAxis(DE_BRG_VIB_HOR_1

X_AMPLITUDE,


DE,




IAN.defaultvalue,


D AND


)



MinorAxis ( ) Returns the magnitude for the

minor axis of a filtered orbit.

The minor axis is the absolute

difference of the forward and

reverse amplitudes. This

function checks for probe

quality as the last argument

before returning an output

otherwise it returns NaN



phaseB, boolean


nt, boolean





Horizontal




Vertical












tag. True=Radians,

False=Degrees





for amplitudeA and




function

MinorAxis(DE_BRG_VIB_HOR_

1X_AMPLITUDE,


DE,




IAN.defaultvalue,


D AND

DE_BRG_VIB_VER_1X_ISVALID

)=1.0)



EllipticityRatio ( ) This function returns a non-

dimensional relationship of

the major and minor axis to

quantify the shape of an orbit

map. This will return 0 when

the orbit is completely circular

and 1 when the orbit is

completely planar. This







phaseB, boolean


nt, boolean





Horizontal




Vertical












tag. True=Radians,

False=Degrees





for amplitudeA and




function

EllipticityRatio(DE_BRG_VIB_H

OR_1X_AMPLITUDE,


DE,




IAN.defaultvalue,


D AND


)=1.0)



PrecessionDirection ( ) This function is a relationship

between forward and reverse

amplitude components and

returns an integer that

describes the direction of the

precession of the shaft motion

relative to the rotational

direction. Forward precession

indicates the shaft motion is in

the same direction as the

rotational direction and is

outputted to 1.0.

Indeterminate precession is

denoted 0. Reverse precession

indicates the shaft motion is in

the opposite direction of

rotation and is denoted -1.0.

This function checks for probe






phaseB, boolean


nt, boolean

isValidVibrationProbeSignal,

float lowFactor, float

highFactor)




Horizontal




Vertical












tag. True=Radians,

False=Degrees





for amplitudeA and




function

lowFactor: Constant: This is a

threshold typically set to 0.99

for bounding the relationship


amplitude to determine

forward precession (output

1.0)

highFactor: Constant: This is a

threshold typically set to 1.01

for bounding the relationship


amplitude to determine

reverse precession (output

-1.0)

PrecessionDirection(DE_BRG_

VIB_HOR_1X_AMPLITUDE,


DE,




IAN.defaultvalue,


D AND


)=1.0, 0.99, 1.01)



MaximumProbeRange ( ) This function describes the

maximum valid reading output

from the vibration probe. The

maximum reading is a sum of

gap voltage and the amplitude

peak to peak variation over

one rotation of the shaft. It

converts the amplitude

reading to voltage using the

voltage displacement gradient

constant

(float probeGap, float

directAmplitude, float

voltageDisplacementGradient)

probeGap: This is the gap

reading coming from a

vibration probe, typically in DC

Voltage

directAmplitude: This is the

direct amplitude reading

coming from the vibration

probe in displacement

voltageDisplacementGradient:

Constant: This is typically an

internal tag that describes the

calibration of DC voltage to

displacement of the probe

MaximumProbeRange(DE_BRG

_VIB_HOR_GAP,

DE_BRG_VIB_HOR_DIRECT_AM

PLITUDE,

VOLTAGE_DISPLACEMENT_GR

ADIENT)

MinimumProbeRange ( ) This function describes the

minimum valid reading output

from the vibration probe. The

minimum reading is the

difference of gap voltage and

the amplitude peak to peak

variation over one rotation of

the shaft. It converts the

amplitude reading to voltage

using the voltage

displacement gradient

constant

(float probeGap, float

directAmplitude, float

voltageDisplacementGradient)

probeGap: This is the gap

reading coming from a

vibration probe, typically in DC

Voltage

directAmplitude: This is the

direct amplitude reading

coming from the vibration

probe in displacement

voltageDisplacementGradient:

Constant: This is typically an

internal tag that describes the

calibration of DC voltage to

displacement of the probe

MaximumProbeRange(DE_BRG

_VIB_HOR_GAP,

DE_BRG_VIB_HOR_DIRECT_AM

PLITUDE, 0.2)



CompensatedAmplitude ( ) This function is the amplitude

(magnitude) of the vector

difference between a

reference vector and current

vector. The reference vector is

typically at slow roll conditions

(Coast down at 5-15 %

running speed) where dynamic

influences are negated. This





(float amplitude, float

amplitudeSlowRoll, float

phase, float phaseSlowRoll,

boolean


nt, boolean


amplitude: The current filtered


reading typically called 1X, 2X

etc.

amplitudeSlowRoll: The

reference filtered amplitude of

a vibration reading typically

called 1X, 2X at slow roll

conditions

phase: The filtered phase of a


called 1X,2X etc.

phaseSlowRoll: The reference

filtered phase of a vibration


at slow roll conditions






tag. True=Radians,

False=Degrees





for amplitudeA and




function

CompensatedAmplitude(BEAR

ING_1_VIB_HOR_1X_AMPLITU

DE,

BEARING_1_VIB_HOR_1X_SLO

W_ROLL_AMPLITUDE_SSC,

BEARING_1_VIB_HOR_1X_PHA

SE,


W_ROLL_PHASE_SSC,


IAN.defaultvalue,

IsValidVibrationProbeSignal(B

EARING_1_VIB_HOR_1X_AMPL

ITUDE,

MIN_AMPLITUDE_THRESHOLD,

BEARING_1_VIB_HOR_MAXIM

UM_PROBE_RANGE,


UM_PROBE_RANGE.ActualHig

h,

BEARING_1_VIB_HOR_MINIMU

M_PROBE_RANGE,


M_PROBE_RANGE.ActualLow)



CompensatedPhase ( ) This function is the direction

(polar) vector difference

between a reference vector

and current vector. The

reference vector is typically at

slow roll conditions (Coast

down at 5-15% running speed)

where dynamic influences are

negated. This function checks

for probe quality as the last

argument before returning an

output otherwise it returns

NaN


amplitudeSlowRoll, float

phase, float phaseSlowRoll,

boolean


nt, boolean


amplitude: The current filtered



etc.

amplitudeSlowRoll: The

reference filtered amplitude of

a vibration reading typically

called 1X, 2X at slow roll

conditions

phase: The filtered phase of a


called 1X,2X etc.

phaseSlowRoll: The reference

filtered phase of a vibration


at slow roll conditions






tag. True=Radians,

False=Degrees





for amplitudeA and




function

CompensatedPhase(BEARING

_1_VIB_HOR_1X_AMPLITUDE,


W_ROLL_AMPLITUDE_SSC,


SE,


W_ROLL_PHASE_SSC,


IAN.defaultvalue,



ITUDE,

MIN_AMPLITUDE_THRESHOLD,


UM_PROBE_RANGE,



h,


M_PROBE_RANGE,





OrbitShape ( ) This function returns a

quantitive value to describe

the shape of a filtered orbit

based on the relationship

between the Major and Minor

Axis. There are 5 defined

shapes and are compared to

their corresponding thresholds

to output an integer orbit

shape. Circular = 0, Elliptical =

1, Highly Elliptical = 2, Planar =

3, Indeterminate = 4. This







phaseB, boolean


nt, boolean

isValidVibrationProbeSignal,

float ellipticalThreshold, float

highlyEllipticalThreshold, float

planarThreshold, float

minimumAmplitudeThreshold)




Horizontal




Vertical












tag. True=Radians,

False=Degrees





for amplitudeA and




function

ellipticalThreshold: Constant:

Typically an internal tag and

set to 0.8. A Major to minor

relationship below this

number determines the Orbit

Shape of 1. This threshold is

dependent on equipment type

and expert opinion

highlyEllipticalThreshold:

Constant: Typically an internal

tag and set to 0.4. A Major to

minor relationship below this

number determines the Orbit

Shape of 2. This threshold is


and expert opinion

planarThreshold: Constant:

Typically an internal tag and

set to 0.025. This number is


and expert opinion for

determining the Orbit Shape

of 3

minimumAmplitudeThreshold:

Constant displacement: This is

the minimum amplitude

reading at which there is no

longer reliable value to detect

the energy from shaft dynamic

changes. This value is inversely

dependent on running speed

OrbitShape(BEARING_1_VIB_H

OR_1X_AMPLITUDE,

BEARING_1_VIB_VER_1X_AMP

LITUDE,


SE,

BEARING_1_VIB_VER_1X_PHAS

E,


IAN.defaultvalue,

BEARING_1_VIB_HOR_1X_ISVA

LID AND

BEARING_1_VIB_VER_1X_ISVA

LID)=1.0, 0.8, 0.4, 0.025, 0.3)



IsValidVibrationProbeSignal ( ) This function returns a

Boolean True or False result

after doing a series of

comparisons to determine

whether a Vibration Probe

output is good. It checks for

range, NaNs and Minimum

Amplitude. This function would

be used for each probe and

filtered harmonic pair, ie

Horizontal 1X


minimumAmplitudeThreshold,

float maximumProbeRange,

float

maximumProbeRangeLimit,

float minimumProbeRange,

float

minimumProbeRangeLimit)

amplitude: The filtered



minimumAmplitudeThreshold:

Constant displacement: This is

the minimum amplitude

reading at which there is no

longer reliable value to detect

the energy from shaft dynamic

changes. This value is inversely

dependent on running speed

maximumProbeRange: The

output of the high range of a

probe, the output of the

MaximumProbeRange

Function

maximumProbeRangeLimit:

The threshold for the

maximum probe range. The

Maximum Probe Range must

be less than this value to be

considered valid

minimumProbeRange: The

output of the low range of a

probe, the output of the

MinimumProbeRange Function

minimumProbeRangeLimit:

The threshold for the

minimum probe range. The

Minimum Probe Range must

be greater than this value to

be considered valid



ITUDE,

MIN_AMPLITUDE_THRESHOLD.

defaultvalue,


UM_PROBE_RANGE,



h,


M_PROBE_RANGE,



Or as a Calculated Variable (If

(IsValidVibrationProbeSignal(B


ITUDE,

MIN_AMPLITUDE_THRESHOLD.

defaultvalue,


UM_PROBE_RANGE,



h,


M_PROBE_RANGE,


M_PROBE_RANGE.ActualLow

)=TRUE) then 1.0 else 0.0)


Concatenation Functions


TextLength ( ) Returns the number of

characters in a set of text

(String sourceString)

sourceString: A string to count

the number of characters

TextLength(“message”) = 7

IsContainedInText ( ) Returns true if the substring is

contained in the sourceString.

This function is not case

sensitive

(string subString, string

sourceString)

subString: The sub string to

search for

sourceString: The string to

search in

IsContainedInText(“your”,

“Your flight”) = true

TextPosition ( ) Returns the starting position

of the first occurrence of the

substring in the sourcestring.

Returns 0 if the substring was

not found

(string subString, string

sourceString)

subString: The sub string to

search for


search in

TextPosition("fli", "Your flight")

= 6

ReadFromText ( ) Returns the string of

characters beginning at

startIndex and ending at

endIndex

(string sourceString, Integer

startIndex, Integer endIndex)


read from

startIndex: The index of the

first character to read

endIndex: The index of the last

character to read

ReadFromText("one two

three", 5, 7) = "two"

InsertInText ( ) Returns the sourceString with

the substring inserted before

the character at insertIndex

(string stringToInsert, string

sourceString, Integer

insertIndex)

stringToInsert: The string to

insert sourceString

sourceString: The source string

insertIndex: The index to insert

before

InsertInText(" not ", "do enter",

3) = "do not enter"



ReplaceInText ( ) Returns the sourceString with

a text substitution starting

and startIndex and ending at

endIndex

(string stringToSubstitute,

string sourceString, Integer


stringToSubstitute: The string

to substitute


startIndex: The start index to

begin substitution

endIndex: The end index to

end substitution

ReplaceInText("exit", "do not

enter here", 8 , 12) = "do not

exit here"

OmitFromText ( ) Returns the sourceString

omitting the characters

startIndex and ending at

endIndex

(string sourceString, Integer



startIndex: The start index to

begin omission

endIndex: The end index to

end omission

OmitFromText("do not

enter",4,7) = "do enter"

CapitalizeWords ( ) Returns the sourceString with

the first letter of each word

capitalized

(string sourceString)


CapitalizeWords("this is a

test") = "This Is A Test"

UppercaseText ( ) Returns the sourceString will

all alphabetic characters

capitalized



UppercaseText("123AbcDef") =

"123ABCDEF"

LowercaseText ( ) Returns the sourceString will

all alphabetic characters

uncapitalized



LowercaseText("123AbcDef")

="123abcdef"

DoesTextBeginWithQuantity

( )

Returns true if the string

begins with one or more

numeric characters



DoesTextBeginWithQuantity("

123abc") = true;

DoesTextBeginWithQuantity("

abc123") = false


Diagnostics FunctionsThese functions are only available when writing diagnostics.


AssetIndications ( ) Returns a count of the number

of asset tag advisory

indications on a set of asset

tags.

An advisory indication exists

when the conditional logic of

the rule evaluates to true for

the asset tag. Using the

AssetIndications() function will

assign each of the asset rules

to each of the asset tags.

When the conditional logic is

met the advisory indication

chart marker will be displayed

in Sentinel.

(List<AssetBlueprintTagRule>

assetTagRules, List<AssetTag>

assetTags)

assetTagRules: A list of asset

blueprint tag rules

(mnemonics). Asset blueprint

tag rules are specified on the

Rules tab (in blue)

assetTags: A list of asset

blueprint tags aliases. Asset

blueprint tags are specified on

the Tags sub tab of the Asset

Blueprints tab

If (AssetIndications([AVH],

[Tag1, Tag2]) >=2 ) then …

ModelIndications( ) Returns a count of the number

of model tag advisory

indications on a set of model

tags.

An advisory indication exists

when the conditional logic of

the rule evaluates to true for

the model tag. Using the

ModelIndications() function

will assign each of the model

rules to each of the model

tags. When the conditional

logic is met the advisory

indication chart marker will be

displayed in Sentinel.

(Model model,

List<ModelBlueprintTagRule>

modelTagRules,

List<AssetTag> assetTags)

model: A name of a model in

the asset blueprint. Only one

model may be specified. All

modelTagRules will counted

from this model only

modelTagRules: A list of model

blueprint tag rules

(mnemonics). Model blueprint


Rules tab of Blueprint Center

(in green)





Blueprints tab. If the asset

blueprint tag alias is not

assigned to the model then

model tag advisory indications

cannot be created

If

(ModelIndications(Mechanical,

[H],[Tag1, Tag2]) >=2 ) then …



Priority ( ) Result of a diagnostic

condition. When the

diagnostic condition is true an

advisory will be created of the

specified priority

(Integer value, String message)

value: The priority of the

diagnostic condition. Can

range from 1 to 5 where 1 is

the highest priority possible

message: The advisory

message of the diagnostic

condition. If a message is not

specified name of the

diagnostic will be used for the

advisory message in Sentinel.

If


[H],[Tag1, Tag2]) >=2 ) then

Priority(5) else …

None ( ) Used to complete diagnostic

logic

- If


[H],[Tag1, Tag2]) >=2 ) then

Priority(5) else None()

Normal ( ) Returns true when there are

no specified asset tag advisory

indications on any of the

specified asset tags

Any specified asset tag

advisory indication on any

specified asset tag will cause

Normal() to return false. If

none of the specified asset

tags are active in asset

Normal() will return false

(List<AssetBlueprintTagRule>

assetTagRules, List<AssetTag>

assetTags)

assetTagRules: A list of asset

blueprint tag rules

(mnemonics). Asset blueprint


Rules tab (in blue)





Blueprints tab

If (Normal([AVH],[Tag1, Tag2]))

then …



Normal ( ) Returns true when there are

no specified model tag

advisory indications on any of

the specified model tags

Any specified model tag

advisory indication on any

specified model tag will cause

Normal() to return false. If

none of the specified asset

tags are active in asset

Normal() will return false

(Model model,

List<ModelBlueprintTagRule>

modelTagRules,

List<AssetTag> assetTags)



model may be specified. All

modelTagRules will counted

from this model only

modelTagRules: A list of model

blueprint tag rules

(mnemonics). Model blueprint


Rules tab of Blueprint Center

(in green)





Blueprints tab. If the asset


assigned to the model then

model tag advisory indications

cannot be created

If (Normal(Mechanical,[H],

[Tag1, Tag2])) then …

IsAssociated ( ) Used to complete diagnostic

logic as well as associated

asset tags with diagnostic

logic

Associated tags will be

displayed in the diagnostic

advisory folder in Sentinel’s

asset explorer. Any asset tag

used in Assetindications() is

automatically associated with

the diagnostic

(List<AssetTag> assetTags)

assetTags: A list of asset tags

to associate with the

diagnostic

If (AssetIndications([AVH],

[Tag1, Tag2]) >=2 ) then

Priority(5) else

IsAssociated([Tag3])

IsAssociated ( ) Used to complete diagnostic

logic as well as associated

model tags with diagnostic

logic

Associated tags will be

displayed in the diagnostic

advisory folder in Sentinel’s

asset explorer. Any model tag

used in Modelindications() is

automatically associated with

the diagnostic

(Model model, List<AssetTag>

assetTags)



model may be specified

assetTags: A list of asset tags

to associated with the

diagnostic. If the asset


assigned to model no

association will be created

If


[H],[Tag1, Tag2]) >=2 ) then

Priority(5) else

IsAssociated(Mechanical,

[Tag3])



History ( ) Returns a value of from a point

in a tag history

(List<Float> history, Integer

index)

history: A list of tag history

index: The index (datapolls)

back from current of to return

a value. An index of 0 will

return the current value

history(Tag.Actual(5), 4)

Position ( ) Returns the index of a specific

value in a tag's history

If the value is in the tag's

history more than once, the

most recent (closest to 0)

index will be returned. If the

value is not in the tag's history

-1 will be returned

(List<double> history, double

value)

history: A list of tag history

value: The value to find

postition(Tag.Actual(5), 200 )

NaN ( ) Returns a NaN (not a number)

that is useful for passing into

other functions when it is not

desired to specify an input (For

example, the lower or upper

threshold in Average() )

- Average([Tag1, Tag2, Tag3],

NaN(), Tag1.ActualHigh)

Instance Tag Field Descriptions

Analytic Instance Tag Field DescriptionsThis topic describes the fields that can be viewed in a SmartSignal Maintenance deployment.

Field Description







Active The collection of deployment-specific settings and data for thistag are collectively referred to as a deployment tag. If selected,this tag will be included as part of the deployment.

Last Changed Date Date the tag was last modified.


Field Description




Deployment ID The ID for the deployment.




Tag Template ID The ID for the tag template.



Source Tag Alias The display name of the source tag.

Analytic Template Display Name The name of the analytic template.

Created By The ID of the user who created the tag.

Created Date Date the tag was created.


Tag ID Automatically generated unique ID for the tag. This valuecannot be modified.

Last Changed By The ID of the user who last modified the tag.

Note Notes about the tag.

Model Tag Field DescriptionsModel tag data is used to predict equipment behavior under various operating conditions. This topicprovides a list and description of the fields that exist for model tags and appear on the grid for a selectedmodel.

Field Description




Active in Deployment Depending on whether the tag is an input tag or an output tag, ifthis check box is selected, one of the following will occur:


Field Description

• For an input tag, data will be collected at every datacollection interval.

• For an output tag, data will be produced at every datacollection interval.

The collection of deployment-specific settings and data for thistag are collectively referred to as a deployment tag.







Active in Model If selected, this tag is included as part of the model and is usedin predictions and data modeling. If it is deactivated, it is notused in predictions and data modeling. The collection of model-specific settings and data for this tag are collectively referred toas a model tag.



None Disables residual indicationsfor the residual signal forthe tag.

SPRT This is a specialized decisionalgorithm called theSequential Probability RatioTest (SPRT). The system canapply it when the residualsare normally distributed andserially uncorrelated. Thealgorithm uses a statisticalhypothesis testingtechnique to determine ifthe mean of the residual hasshifted in the positive ornegative direction.


Field Description


Residual Threshold This is the default value. Ittriggers a residual indicationif the residual signal of thetag exceeds the value in thePositive Residual Thresholdcolumn or falls below thevalue in the NegativeResidual Thresholdcolumn.

Smoothed ResidualThreshold

Triggers a residual indicationif the smoothed residualsignal of the tag exceeds thevalue in the Residual +Threshold column or fallsbelow the value in Residual– Threshold column. Thismethod is used to removespike data and noise fromthe residuals.

Residual (Positive) The maximum absolute value allowed for a positive residual(that is, when the estimate is above the actual for a signal). Seedetails in the Alarm Type description.

Residual (Negative) The maximum absolute value allowed for a negative residual(that is, when the estimate is below the actual for a signal). Seedetails in the Alarm Type description.

Actual Mean The mean of the actual values for a tag included in the referencevalues. This attribute is automatically evaluated when creatinga state matrix.

Actual Standard Deviation The standard deviation of the actual values for a tag included inthe reference values. This attribute is automatically evaluatedwhen creating a state matrix.






Filter Low The lower filtering threshold. This field sets the lower thresholdvalue for filtering of tag signals to remove data outside thenormal operating range. Any tag data less than this value is


Field Description

considered an outlier. Outliers will be filtered out of trainingdata.

Flatline Number If the data for this tag remains at the same level for more thanthis number of data points, the data will be considered to beflatlined, and will be filtered out of training data.

Instance Tag ID Automatically generated unique ID for the tag. This valuecannot be modified.



Model Tag ID Automatically generated unique ID for the tag. This valuecannot be modified.

Notes in Instance Notes about the analytic instance.

Notes in Template Notes about the analytic template. This value is inherited fromthe analytic template and cannot be modified.

Notes in Model Notes about the configuration of the tag for the selected model.

Outlier (Negative) Threshold used for outlier rules. Data outside of Outlier limitsappear as NaNs in charts.

Outlier (Positive) Threshold used for outlier rules. Data outside of Outlier limitsappear as NaNs in charts.

Residual Variance The variance of the residual values for a tag included in thereference values. This attribute is automatically evaluated whencreating a state matrix. Residual values are calculated bymodeling the reference values not included in the state matrix.

Spike Sensitivity The sensitivity of the spike detection algorithm used to detectspikes in tag signals. A lower value will detect more spikes, butmay also generate false positives. Spike data will be filtered outof training data.

SPRT (Negative) The negative values for the sensitivity of the SPRT. This value ismultiplied by the standard deviation of the residual, which inturn defines the amount of negative change in the residualmean that must occur to constitute an alarm.

SPRT (Positive) The positive values for the sensitivity of the SPRT. This value ismultiplied by the standard deviation of the residual, which inturn defines the amount of positive change in the residual meanthat must occur to constitute an alarm.



Tag Order The order of the tags in the deployment. This value is inheritedfrom the analytic template and cannot be modified.


SmartSignal Glossary

ModeA mode is a node in the hierarchy that represents a distinct mode of operation for some equipment orsystem. Typically, there is only one mode for an analytic instance, indicating when the equipment is in asteady state of operation. The mode has established criteria that tell the runtime engine to process themodels and evaluate rules only if the mode criteria have been met. For the purpose of writing rules, themode is contained by the analytic instance and is the container of models.

Reference DataIn a model, reference data is the set of measured actual values that represent the normal range ofequipment operating conditions in which equipment is operating in a desired manner. Filtering has beenapplied to this data set and is the basis for the state matrix.

State MatrixIn a model, the state matrix is a matrix of vectors in which each vector represents one of the normaloperating states (for healthy behavior) of the equipment or system. Historical data from all tags in themodel are included in the matrix. Using the state matrix, the runtime engine can, in real-time, compareeach observation of live data to the set of normal operating states represented in the state matrix. Withthis comparison, the runtime engine generates an estimate for each tag in the observation and thencompares the actual value to the estimate value.

TrainingTraining is the process used during the initial build of a model to filter out bad data and bad tags andselect healthy equipment behavior to be available for the state matrix.


Chapter

7Release NotesTopics:

• Third Quarter of 2020• Second Quarter of 2020• First Quarter of 2020• Fourth Quarter of 2019• Third Quarter of 2019• Second Quarter of 2019• First Quarter of 2019• Fourth Quarter of 2018• Third Quarter of 2018• Second Quarter of 2018• First Quarter of 2018


Third Quarter of 2020

Release Date: September 25, 2020This topic provides a list of product changes released for this module on this date.

Table 10: Resolved Issues

The following issues, which existed in one or more previous versions, have been resolved.

Description Tracking ID

Previously, if the unit of measure for an asset tag was set to metric ton per hour (t/hr), the tag

values were incorrectly converted to kilogram per hour (kg/hr). This issue has been resolved.

DE140308

Release Date: August 18, 2020This topic provides a list of product changes released for this module on this date.




Previously, while getting analytic tags under certain conditions, an error occurred. This issue has

been resolved.

DE139133

Previously, the Output Tag Heath feature of SmartSignal Maintenance application incorrectly

reported an output tag as invalid under certain conditions. This issue has been resolved.

DE138152

Release Date: July 14, 2020This topic provides a list of product changes released for this module on this date.




Previously, you could not update the SmartSignal analytic instances that were aligned to a

segment. In addition, deployments failed when the APM Asset source key was modified to

include spaces. These issues have been resolved.

DE138440

Second Quarter of 2020

Release Date: June 26, 2020This topic provides a list of product changes released for this module on this date.


Table 13: Enhancements and New Features

The following enhancements and new features have been added.


As a tenant administrator, you can now provide a user access to the SmartSignal Maintenance

application while restricting access to the SmartSignal Deployment application.

F52268

You can now define the order in which Tag Groups appear in your analysis charts. This provides a

consistent view of tags when reviewing alert evidence.

F49026

The SmartSignal Template has been enhanced to improve the usability. You can now:

• Expand the size of the expression editing window.

• View tags that have been added to the template without publishing first.

• View matching left or right parenthesis that are being highlighted.

F49026

To improve the security, reliability, and scalability when delivering email messages, Amazon

Simple Email Service (Amazon SES) is now used as the email delivery of Analytic Processing

Notifications. You will now receive the notifications from [email protected].

F48194

Previously, when you modified the tag status, all models were flagged as required to be rebuilt.

Now, only the specific models that are impacted by a change in an analytic instance are flagged

as require a rebuild, thereby providing clarity on the impact of the change.

F47526

You can now choose to go directly to the Event Frame Analysis view when the corresponding

alert is flagged as supporting this view. Thus, you do not have to access the Default Analysis view

before switching to the Event Frame view.

F46990




Previously, SmartSignal analytics considered Predix Time Series data that contained a quality

indicator of 1 or 2 as good data. This issue has been resolved. Now, only data that has a quality

indicator of 3 is considered as good data and data with other quality indicators are considered as

NAN.

DE135134

Previously, when the SmartSignal Analytic processing was delayed because RTE was unable to

reconnect with Redis Cache, an error occurred. This issue has been resolved.• DE133522

• DE132996

Previously, SmartSignal Analytic instances would lose their association with the APM Asset and

thus unable to deploy the instance. This issue has been resolved.

DE132857

Previously, the rows in the SmartSignal application were intermittently offset from the first

column. This issue has been resolved.

DE132308

Previously, when getting analytic instance tag groups under certain conditions, an error occurred.

This issue has been resolved.

DE131971

Previously, the SmartSignal Deployment application experienced a problem when all the

SmartSignal analytics were deactivated. This issue has been resolved.

DE131960

Previously, in the SmartSignal Maintenance application, if you had filtered the data of a chart by

All Values Not Excluded and the chart was zoomed in, the zoom was reset when you applied red

stripe to a portion of the chart. This issue has been resolved.

DE131747


Release Date: May 1, 2020This topic provides a list of product changes released for this module on this date.




You can now generate a diagnostic coverage report for a locked analytic instance. This allows you

to see the impact of the changes before deploying.

F51434

You can now see a message when you hover over the job status that is in process. This allows you

to see the step in progress and percentage of completion on a longer running job.

US402297




Previously, when you tried to get analytic instance tag groups under certain conditions, the

service returned an HTTP 500 Internal Server error. This issue has been resolved.

DE131971

Previously, the SmartSignal Maintenance application’s rows were sometimes offset from the first

column. This issue has been resolved.

DE132308

First Quarter of 2020

Release Date: March 27, 2020This topic provides a list of product changes released for this module on this date.




You can now configure your tenant to generate an analytic processing report and allow your

users to receive a notification e-mail with its content. This report provides the processing status

information that is available in the SmartSignal Deployment application in an easy to read e-mail

message.

APMRM-1908/F49149

You can now generate a diagnostic coverage report for an analytic instance. This allows you to

see the percentage of rules, which are “Fully”, “Partially”, or “Not Covered”, based on your tag and

model configuration.

• APMRM-1946/F49097

• APMRM-758/F38349

You can now configure a separate fixed scale setting (Y Chart Min/Max) at the mode level for

analytic tags.

APMRM-1741/F42828





Previously, the SmartSignal Analytic Template editor displayed the tag type attribute using the

Classic SmartSignal terminology (for example, Internal, External, Calculated). This issue has been

resolved.

DE128048

Previously, the navigation of the SmartSignal Maintenance application did not display segment

level analytics. This issue has been resolved.

DE127756

Previously, model name changes made to the analytic template did not get updated in the

instances that were deployed already. This issue has been resolved.

DE126277

Release Date: January 15, 2020This topic provides a list of product changes released for this module on this date.




You can now filter the Smartsignal Maintenance Application hierarchy by APM Asset

Classification or Analytic Template Name. You can toggle the filter to view all locked analytic

instances on a tenant. Icons denoting filters and models are out-of-date appear in the hierarchy.

APMRM-1947/F49147

Tag Groups configuration is now improved by aligning the checkbox against the diagnostic name. US390849




Previously, the Vector waiting time was not adjusted by poll interval to allow RTE to catch up on

current time. This issue has been resolved.

DE125128

Previously, the Maintenance App displayed the Test Analytic at model level when you did not

have feature access. This issue has been resolved.

DE124803

Previously, Tag Groups did not get deleted when the Analytic Template was deleted. This issue

has been resolved.

DE124710

Previously, the Analytic template editor shows "no changes" when still working to build

comparison results. This issue has been resolved.

DE122080


Fourth Quarter of 2019

SmartSignalThis topic provides a list of product changes released for this module on the specified dates.

Release Date: December 13, 2019




You can now create tag groups in an analytic template. F47846

You can now view alert density and analytic processing status in the alerts grid. F46531

You can now navigate to an analytic deployment from the Analytic Instances pane in the

SmartSignal Maintenance module.

F46215




Previously, changes made to diagnostic chart markers did not appear as expected in the analysis

view. This issue has been resolved.

DE120846


SmartSignalThis topic provides a list of product changes released for this module on the dates listed below.

Release Date: September 27, 2019




You can now sort the training data charts by the tag order (that is, ordinal) in the SmartSignal

Maintenance module.

F47069

You can now scroll through the training data charts in bulk in the SmartSignal Maintenance

module.

F47002

You can now resize the training data charts in the SmartSignal Maintenance module. F47001



You can now enable automatic UOM conversion on the input tags that are read from Predix Time

Series when performing runtime processing or ingesting model training data.• F45252

• F45250

You can now request and view a sensor health report in the SmartSignal Maintenance module. F36676

You can now test your SmartSignal analytic instance from the SmartSignal Maintenance module

before deployment. In addition, you can view the test results in Analysis.

F34014




Previously, in a correlation chart, when you selected the lasso ( ), the selection did not persist

(that is, the lasso was not sticky). Due to this, you needed to select the lasso each time you

wanted to remove more data. This issue has been resolved.

DE116464

Previously, after you added an input tag to an analytic template, and then published it, the

comparison result between the current version and the previous version was incorrect. This issue

has been resolved.

DE113366

Previously, when you attempted to add a model-level constant to an analytic template, in the

Add Constant window, in the Select drop-down list box, values with long names were

truncated. This issue has been resolved.

DE113367

Previously, in the View Model Settings window, when the value in the DOWNSAMPLEALGORITHM box was Smart Train, the TARGET VECTORS box did not appear in the window.


DE88031

Release Date: August 5, 2019




You can now access the training data charts for both active and inactive tags associated with an

Analytic instance in the SmartSignal Maintenance module. To facilitate this enhancement, a new

toggle button, SHOW INSTANCE TAGS, has been added to the page that appears when you

select the Tag Selection button ( ).

F46054

You can now synchronize tag data with existing models when you create or rebuild a model for

deployment in the SmartSignal Maintenance module. To facilitate this enhancement, a new

option, SYNC, has been added to the CHANGE TRAINING DATA section of the Update Modelswindow.

F45962

You can now access the statistics of the tags available for a model in the SmartSignal

Maintenance module. To facilitate this enhancement, a new button, , has been added to the

page that contains the training data charts for the model.

F25936





Previously, the jobs that were scheduled for the Analytic instances failed and the following error

message appeared:

Missed schedule: The analytic instance is not processing on the configured schedule.


DE115165

Previously, if you imported an Analytic template for which the chart markers were configured for

a diagnostic rule and was exported from another tenant, multiple instances of the diagnostic rule

were created. This issue has been resolved.

DE115163

Previously, if the template value for a Standard Unit in an Analytic template was set to None, you

could not synchronize the Standard Unit of the Model tag with the template. This issue has been

resolved.

DE114914

Previously, the data filters such as Mode and NaN did not filter data for large data sets as

expected. This issue has been resolved.

DE114698



Release Date: June 28, 2019




You can now verify your input tag mapping health before deploying an analytic instance. F44075

You can now access the SmartSignal analytic template and GE Digital APM asset that are

associated with an analytic instance from the SmartSignal Maintenance module.

F43875

You can now configure custom chart markers for diagnostic rules and tag rules from the analytic

template editor.

F43802

You can now view the name of the user who has locked an analytic template or analytic instance. • F43207

• F43199

You can now have more control over the use of the automatic data filtering while rebuilding

models for an analytic instance.

F42235

A new function has been added to support standard deviation based on the mode. F40084

You can now clean your analytic instance training data to reduce its disk space usage and to

improve the performance during addition model maintenance.

F28782

You can now configure the maximum carry forward duration for the SmartSignal tenant. F22781




Release Date: March 29, 2019




You can now add Chart Y Min and Chart Y Max values to an analytic template to override

automatic Y-axis scaling in Analysis charts.

F42784

You can now export an analytic template as a .zip file. F40124

You can now use correlation charts to exclude data from model training. Additionally, data points

in correlation charts are now color coded based on the colors in the stripe and filter legend.

F34015

The following improvements have been to the tables in SmartSignal Maintenance to make it

easier to detect which tag values have been modified in an analytic instance or model:

• If a value has been modified, the cell is highlighted in yellow, and the value appears in bold

font.

• If you hover over a cell with a modified value, a window appears, notifying you of the

differences between the analytic instance or model value and the template value.

• In the Value is Customized window, you can select the Sync to Template button to reset

the value in the analytic instance or model to the value in the template.

F32280

Administrative users can now grant a user view-only permission for SmartSignal analytics. To

facilitate this enhancement, a new permission, View SmartSignal Analytic, has been added in the

SmartSignal Mappings section in the page for modifying permission sets.

F28777

Table 29: Known Issues

The following issues are unresolved in this release.


The deployment process in the GE Digital APM Analytics module limits the ability to update

analytic templates when deployments contain more than one APM asset. Therefore, when you

create a new analytic instance using the deployment process in the GE Digital APM Analytics

module, do not include more than one APM asset in your deployment. Note that if you create a

deployment using multiple assets, when you modify your SmartSignal analytic template, any

associated analytic instances will not remain in sync with the template, and you will need to

deploy new instances to have instances that are synced with the template.

N/A

In the SmartSignal Maintenance module, if you have an analytic instance with a large amount of

data, you may experience performance issues. To improve performance, use Google Chrome as

your browser; you may also need to close other applications to increase available memory.

N/A


Release Date: January 23, 2019


The following issues that existed in one or more previous versions have been resolved.


Previously, when you imported an analytic instance into GE Digital APM, if the APM asset

associated with the analytic instance had an output tag with a time series link defined, that time

series link value was not maintained in the output tag in the analytic instance. This issue has

been resolved. Now, in this scenario, the time series link value is included as the source tag value

in the analytic instance.

DE91623

Fourth Quarter of 2018


Release Date: December 14, 2018




You can now more easily modify source tag mapping in the SmartSignal Maintenance application.

To facilitate this enhancement, a new window, Select APM Asset Tag, now appears, displaying a

list of available asset tags, when you select the button to edit the source tag in the workspace for

the selected analytic instance. Additionally, any changes you make to the source tag mapping are

now reflected in the 2. I/O Mapping section of the workspace for the analytic deployment in the

Analytics module.

F38493

To improve the process of modifying analytic templates of the SmartSignal type, the following

enhancements have been made:

• You can now specify the order in which tags appear in the section for a selected tag type. To

facilitate this enhancement, a new option, Reorder Tags, has been added to the Actionsmenu in the page for editing an analytic template.

• When you attempt to modify an analytic template version other than the latest version, a

window now appears, displaying a button that you can select to access the latest version of

the template.

• You can now review your changes and compare them to the current version of the template

prior to publishing. To facilitate this enhancement, a new button, Review Changes, has been

added to the Publish window.

• You can now compare analytic template versions in the page for editing an analytic template.

To facilitate this enhancement, a new option, Compare Versions, has been added to the

Actions menu.

• If you publish a new version of an analytic template for which there are no analytic instances,

the version number is not updated.

F38076



To improve navigation among analytic instances, the following enhancements have been added:

• In the Analytic Instances pane in the SmartSignal Maintenance module, a search bar now

appears in which you can search for the name of an analytic instance.

• In the Analytic Instances pane in the SmartSignal Maintenance module, you can now

switch a toggle to view only the analytics that you have locked for editing.

• In the SmartSignal Deployments module, the names of analytic instances now appear as

links that you can select to access the instance in the SmartSignal Maintenance module.

F35806

In the page for an analytic instance, you can now export training data to a .csv file. To facilitate

this enhancement, a new option, Export Training Data to CSV, now appears in the Actionsmenu in the page for an analytic instance.

F35379

In the page displaying training data for a model, you can now view a chart that correlates data

from two tags. The correlation chart displays data in an alternative view to the line chart that can

help you notice outlier data that might not be easily detected in the line chart.

F35378

In training data charts, you can now choose to display only vectors that meet certain criteria so

that you can more easily understand and take actions on the available training data. To facilitate

this enhancement, the pane displaying a list of categories of data along with graphs depicting the

percentage of data filtered per category is now accessed from the button while the list of

available vectors is accessed from the button.

F33301

You can now duplicate an existing analytic template of the SmartSignal type. F31868

You can now create an analytic template of the SmartSignal type natively in GE Digital APM. F28784

You can now enter notes about the changes you made when you deploy an analytic instance. In

addition, you can also view the history of actions taken for an analytic instance, including the

following actions:

• Deploying or discarding changes

• Synchronizing an instance with a template version

• Activating or inactivating an instance

• Locking an instance for editing

• Importing an instance from a SmartSignal Classic transfer file

To facilitate this enhancement, a new option, View Instance History, has been added to the

Actions menu in the page for an analytic instance.

F28779

Release Date: November 21, 2018



You can now import multiple analytic instances simultaneously when you import from

SmartSignal Classic using a transfer file.

F39769




Release Date: September 28, 2018


Note Tracking ID

You can now refresh the data in the SmartSignal Deployments page manually or configure an

interval at which the data will automatically refresh.

US285140

When viewing training data charts for a selected model, you can now filter values in individual

charts in order to enhance training data quality for the selected tag.

US283000

In the page displaying training data charts for a selected model, the pane displaying an overview

of filtered data by category now also displays the calculated total filtered data as well as the total

available data.

US281073

The model training data chart user interface has been modified to enhance usability. US281069

You can now modify an analytic template of the SmartSignal type natively in GE Digital APM. US278239

SmartSignal tenant configuration has been updated to incorporate additional customization and

to support better memory management in order to enable higher volumes of analytic

deployments.

US276871



Release Date: June 29, 2018


Note Tracking ID

You can now 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.

US257978

In SmartSignal Maintenance, in the page for a selected Model, you can now view values for the

following fields:

• Residual Variance

• Actual Mean

• Actual Standard Deviation

US257665


Note Tracking ID

You can now synchronize an Analytic Template across multiple Deployments. US257663

You can now view the formula for an output tag in the Tag Alias column in the page for a

Deployment. To facilitate this enhancement, a calculator button ( ) now appears next to the

value in the Tag Alias field.

US257628

You can now view the health of an output tag used in a Deployment and, as needed, inactivate an

output tag so that it will not be used to create data.

US257625

Release Date: April 27, 2018

Table 35: Limitations

Note Tracking ID

The Import Training Data option for creating a model in SmartSignal Maintenance does not

currently support the use of String Tag data types in Mode or Output Tag expressions.

US250217



Release Date: March 30, 2018


Note Tracking ID

You can now take edit control of a SmartSignal deployment when another user has the

deployment locked for editing.

US221821

You can now synchronize an analytic instance with an analytic template version added in

Application Analytics or SmartSignal Mappings.

US216796

You can now manually specify which data you want to include or exclude in a training data chart. US207633

You can now modify the standard unit of measure for a tag in the workspace for a deployment in

SmartSignal Maintenance.

US207621

You can now modify the value in the Source Tag field for a tag in a deployment in SmartSignal

Maintenance.

US207612

You can now activate or deactivate a tag in the workspace for a deployment in SmartSignal

Maintenance.

US207604

You can no longer create APM assets from a SmartSignal Analytic instance.

Note: You can still use JSON to create APM assets from an asset input file.

US194388


Table 37: Limitations

Note Tracking ID

Charts displayed in GE Digital APM Analysis can contain a maximum of 200,000 data points per

tag.

US241973

When you modify the Source Tag field value for a tag in an analytic deployment instance, the

APM Asset tag ID is not automatically updated to match the new Source Tag value.

US241973

In order to use SmartSignal analytic templates in GE Digital APM, the templates must be created

and maintained in a SmartSignal Classic installation. The templates are imported as files into the

APM tenant.

US241973

When you synchronize an analytic deployment instance with an analytic template version

containing structural changes, you can no longer export the instance back to a SmartSignal

Classic installation.

US241973


smartsignal · 2020-07-14 · in ge digital apm, you can use the following smartsignal features:...

Documents