Alerts - GE.com | Building a world that works | General ...€¦ · 26/06/2020 · Alert Ingestion HTTP Status Codes 47 Chapter 5: Alerts Data Extraction 49 Overview 50 Extract Alerts

Alerts

© 2020 General Electric Company

Contents

Chapter 1: Overview 1Overview of the Alerts Module 2

Chapter 2: Alerts Grid View 14About Alert Grid View 15

Chapter 3: Alerts Inbox View 29About Alert Inbox View 30

Chapter 4: Manage Alerts 34About Alert Actions 35

Chapter 5: Alert Ingestion 49About Alert Ingestion 50

Ingest Alerts 50

Alert Ingestion HTTP Status Codes 53

Chapter 6: Alerts Data Extraction 55Overview 56

Extract Alerts Data 56

OData Metadata 56

Examples of OData Operations 57

Data Aggregation 57

Chapter 7: Release Notes 62Third Quarter of 2020 63

ii Alerts

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.

© 2020 General Electric Company iii

Chapter

1OverviewTopics:

• Overview of the Alerts Module

© 2020 General Electric Company 1

Overview of the Alerts ModuleThe GE Digital APM Alerts module provides alerts from the sensors and analytics running in your facility.

When asset sensors send data to the system, the predictive analytics conduct threshold matching. Whenthe data does not match the parameters set in the system, GE Digital APM generates an alert.

Note: The previous version of the Alerts module is still available in GE Digital APM as AlertsV1 for aseamless transition to the latest version and to minimize operational risks.

The heading of the Alerts page contains the following buttons:

• : Displays the asset hierarchy.

• : Displays the pre-defined filter sets that you can use to filter the alerts. Additionally, the drop-downlist provides the option to create custom filter sets. The filter set that is currently applied to filter the

alerts along with the number of alerts that meet the filter criteria appear next to .

• : Refreshes the Alerts page to display the new alerts that match the applied filter set. By default,

the Alerts queue is refreshed only when you select . However, you can enable auto-refresh for theview to be automatically refreshed in specific intervals by selecting the time interval in the drop-down

list box next to . Disabling auto-refresh prevents new alerts from loading until you manually refreshthe queue.

Note: When you select an interval time to refresh the Alerts Inbox view and Alerts Grid view, yourselection persists between both views so you can get the most recent results. Your filter and gridcustomizations also persist after refreshing.

• : Exports all alerts to a CSV file and downloads the CSV file to your local drive.

• : Displays the Create Alert window that allows you to create an alert.

• : Switches the view to Alerts Grid view which displays the alerts in a tabular format.

Note: When you are in the Alerts Grid view, the button changes to and you can select this buttonto switch the view to Alerts Inbox view.

Alerts are displayed in a queue once the Alerts microapp has opened. The filter My Alerts opens by

default. The other default filters can be accessed by selecting next to the filter name:

• Unclaimed – Not yet assigned or claimed.• All Alerts – All alerts in the database.• Claimed – Assigned or claimed.• In Process - Alert in In Process status.• My Alerts – Claimed by you.• SmartSignal – Available if SmartSignal is enabled.

Note: This filter is not available in Predix APM• More Filters – Can be used to create custom filters.

You can sort the queue by Time Received, Severity, or Alert Name. If you sort the inbox by TimeReceived, Severity, or Alert Name, the sorting persists when you switch to the Alerts Grid view. Onceyou have done the initial sort, you can sort by Ascending or Descending.

From the queue, each alert displays the following information when available:

2 © 2020 General Electric Company

• Alert name, severity, and the number of latched alerts displayed in parentheses between the severityand alert name. If there are no latched alerts, then nothing displays between the severity and alertname.

• Incident count for SmartSignal next to the alert name.• Date the alert was received.• Status of the alert.• Asset ID and site name.

An alert selected from the queue provides information about the alert and acts as a repository for notesand evidence pertaining to the issue.

About Alert Details PageThe Alert Details page displays all of the information about a given alert.

The Alert Details page is divided to into multiple sections to provide the functionalities or informationabout a selected alert. You can access these sections in one of the following ways:

• By scrolling the Alert Details page.• By selecting the icon corresponding to the section in the shortcut menu.

The shortcut menu in the Alert Details page provides an easy way to access any section in the page. Themenu contains icons corresponding to each section of the Alert Details page and appears near the scrollbar. The following image illustrates the shortcut menu in the Alert Details page:

By default, the sections of the Alert Details page are expanded. However, you can collapse a section byselecting the heading of the section.

The Alert Details page contains the following sections:

Note: You will only see the Recommendations and Work History sections in the Alert Details page ofthe GE Digital APM application.

Alert Header

Contains basic information about the alert:

• Alert name, severity, and latched alert count – If the alert is latched, the number of grouped alerts

appears in parentheses between the severity and alert name. Select to display a tooltip withan alert description. You can change the alert template from this tooltip.


• Date and time for receipt of the alert.• Alert status and disposition. The Disposition drop-down list for the alert appears when a claimed

alert has a Ready or In Process status. If the alert has already been processed, the page displaysthe previously selected disposition.

• Alert type.

• The Limited Visibility Alert icon ( ) – Toggle the icon to change the alert visibility from limitedto general. When visibility is set to General, the icon changes to the General Visibility Alert icon

( ).• The Unsubscribed/Subscribed icon – By default, the alert displays a status of Unsubscribed

( ), but toggling it changes it to Subscribed ( ).• The Timeline View button – when selected, shows a list of actions taken chronologically (with

latest action on top) for that alert, instead of the alert sections. Select Section View to revert tothe default view of the alert, showing all of the sections.

• A Claim Alert, Claim Advisory, or Reopen button, based on the status of the alert.• The Create Case button. This appears when you have claimed an alert and it is in the Ready or In

Process state.• Actions menu ( ), where you can release a claim, assign an alert, mark the alert as processed,

navigate to an external link, perform maintenance, or export the alert to a PDF file.

ALERT INFORMATION

In the shortcut menu, the ALERT INFORMATION section is represented by . This section containsthe following information on the alert and the asset associated with the alert:

• Alert ID• Timestamps of the first and last occurrences of the alert. In case of latched alerts, these values

indicate the first and last occurrences of the latched alerts and in case of SmartSignal alerts, thesevalues indicate the last processed and last observation timestamps of the alerts.

• Name of the owner of the alert• Source of the alert• Link to the analytic instance associated with the alert• Asset ID• Asset name• Asset criticality number. You can select the criticality number to view the Criticality Analysis page

that offers details on the justification level of the criticality for the primary asset related to thisalert.

Note: This feature is not available in Legacy Predix APM.• Density of the alert. The Density value appears only for SmartSignal and SmartSignal Tag Rule

alerts.• Site name• Links to the different levels of the asset hierarchy associated with the alert

SCAN GROUP DATA

In the shortcut menu, the SCAN GROUP DATA section is represented by . This section providestag names and values for the tags that contributed to the alert.

ANALYSIS

In the shortcut menu, the ANALYSIS section is represented by . This section lists the availableanalysis views for the alert, and provides a link to the associated alert analysis chart on the Analysispage. Accessing the link opens the template in a new browser tab. For GE Digital APM, accessing an


analysis template link in the Alerts Details page causes the analysis template to be shown in theMeridium tab. Additionally, for SmartSignal alerts, this section contains a link to the Event FrameAnalysis view of the SmartSignal chart that is associated with the alert.

INTERNAL NOTES

In the shortcut menu, the INTERNAL NOTES section is represented by . This section only appearsif you have either View Internal Notes or Manage Internal Notes permissions. These notes do notappear in the Alert Detail grid view, nor can they be exported via PDF.

Note: You can select for a note to delete it from this section.

NOTES

In the shortcut menu, the NOTES section is represented by . You can use this section to read andadd public notes related to the alert. These notes are viewable in the Alert Detail grid view and can beexported via PDF.

ASSET INFORMATION

In the shortcut menu, the ASSET INFORMATION section is represented by . This section lists thename of custom attributes and their values for the asset associated with the alert. If there are nocustom attributes available for the asset, the section will not contain any data. Additionally, you canhide the custom attributes for which no value is configured by selecting the Hide empty valuescheck box.

You can export this section to a PDF file. If the Hide empty values is selected, the attributes that donot contain a value are not exported.

INTERNAL LINKS

In the shortcut menu, the INTERNAL LINKS section is represented by . This section lists the linksto other internal sections, such as Analysis. This section appears in Alert Details page only if theassociated alert template has the section.

LINKED CASES

In the shortcut menu, the LINKED CASES section is represented by . This section displays a list of

cases created by the alert. You can select to link a case to the alert.

EVIDENCE

In the shortcut menu, the EVIDENCE section is represented by . You can use this section to uploadimages and documents related to the diagnosis of the issue. You also can view saved alert-analysis

charts. You can select to upload new files related to the alert.

QUALITY AUDIT

In the shortcut menu, the QUALITY AUDIT section is represented by . You can use this section toperform a quality audit on a processed alert after analyzing whether the disposition and processing ofthe alert was correctly done.

Note: This section appears only for processed alerts.

RECOMMENDATION

Note: This feature is not available in Legacy Predix APM.

In the shortcut menu, the RECOMMENDATION section is represented by . In this section, you cancreate a recommendation to propose a course of action to fix the problem that the alert hasindicated.


New Recommendation creation from an alert – To create a new recommendation, select to openthe Record Manager tab, which displays an Alert datasheet that you will need to complete.

To create and view recommendations from the Alert Details page, the following preconditions mustbe met:

• The same asset data must be available and mapped in both the GE Digital APM and Meridiumsystems.

• The user must have Predix Work Order Management permission to view Recommendations andWork History sections.

The RECOMMENDATION section displays the following data created from the selected alert:

• Recommendation name• Recommendation ID• Timestamp of adding the recommendation• Name of the user that added the recommendation• Recommendation status• Recommendation priority• Recommendation target date• Work Request ID created for this recommendation• View all Recommendations link – Opens a new tab that displays a list of all of the

recommendations available for the given asset. When you select a recommendation name, a newtab opens where you can view the details of that recommendation.

• Add a Comment link – you can add a comment to the recommendation. Once you save thecomment, it displays along with your user name, the date and time that the comment was added.

Note: When there are multiple recommendations for a given alert, the latest createdrecommendation is displayed first, with the remaining recommendations arranged in descendingorder based on the recommendation creation date. If no recommendations are shown for a givenalert, then the message There are no Recommendations created for this alertappears under the Recommendations heading.

WORK HISTORY


In the shortcut menu, the WORK HISTORY section is represented by . In this section, you can viewwork orders from the Alert Details page to understand the details of the work being done to resolvethe issue that the alert has indicated. The following precondition must be met:

• The same asset data must be available and mapped in both the GE Digital APM and Meridiumsystems.

Selecting the Work Order description in the Alert Details page opens the Work History datasheet in anew tab, which shows the details of the selected work order.

Provides the Work Description, Work Order number, Status of the order, Work Request number andthe Scheduled Date for completion of the work.

Note: The work orders that appear in the Work History section of the Alert Details page areretrieved from the database using the GE_WH_ALERTS query. By default, the GE_WH_ALERTS query isconfigured to use the Alert ID as its parameter to retrieve the work orders based on the ID of theAlert. However, if you want to work orders to be retrieved from the database based on the Asset orAnalytic Template associated with the Alert, you can modify the GE_WH_ALERTS query to use one ofthe following parameters:


• Asset ID: To retrieve the work orders based on the unique identifier of the Asset associated withthe Alert.

• Name of the Analytic Template: To retrieve the work orders based on the Analytic Templateassociated with the Alert.

For more information on modifying the query, refer to the Queries documentation.

View all Work Orders link – Opens a new tab which displays a list of all of the work orders available forthe given asset. When you select a work order description, another tab opens where you can view thedetails of that work order.

Note: The work orders that appear in this datasheet are retrieved from the database using theGE_WH_ALERTS query. By default, the GE_WH_ALERTS query is configured to use the unique identifierof the Asset associated with the Alert as its parameter to retrieve the work orders based on the AssetID. However, if you want to work orders to be retrieved from the database based on the Alert ID orAnalytic Template associated with the Alert, you can modify the GE_WH_ALERTS query to use one ofthe following parameters:

• Alert ID: To retrieve the work orders based on the unique identifier of the Alert.• Name of the Analytic Template: To retrieve the work orders based on the Analytic Template

associated with the Alert.

About Alert Severity and Status

Alert Severity

Each alert displays a colored box containing a number, both of which reflect the severity of the alert.

Table 1: Alert Icon Colors and Corresponding Severity Levels

Color Severity level

Dark Red 1

Red 2

Orange 3

Pale Orange 4

Yellow 5

Blue 6

SmartSignal advisories display an incident-event count in parentheses to the left of the alert name.

Alert Status

The following table shows the possible alert statuses and the corresponding status indicators:


Table 2: Possible Alert Status

Status Indicator Description

Ready Alert is ready to be claimed.

In Process Alert has an owner.

Processed Alert has been marked as processed.

In Process Escalated Alert has been escalated.

In Process

Maintenance

Analytic associated with the alert is in maintenance.

About Alert Timeline ViewThe timeline view of an alert shows the history of the alert, letting you know who made changes to thealert and when the changes were made.

The timeline view of an alert displays the following events and the user who performed them:

• When an alert was created.• When the alert is claimed.• When the alert state is changed, for example, Marked as Processed, or Reopened Alert.• When the alert template is changed.• When a Note is added to or deleted from the alert. In the Timeline view, you can select the horizontal

arrow ( ) to the left of the Note to view the contents of the note.• When the alert disposition is changed, for example, Valid or False.• When evidence is added to or deleted from an alert.• When a case is created from the alert, and who created the case.• When an alert is linked to or unlinked from a case.• When the visible state of an alert is changed.

To return to the section view, in the details page of the alert, select the Section View button.

Note: To access the Timeline View, you must have Manage Alert permissions or View Alerts and ViewNotes permissions. However, if you have View Alerts permission but not View Notes permission, then youwill not be able to view the timeline.

About Alert VisibilityThe limited visibility alert icon is present in the Alert Details page, and is grayed out by default.

All new alerts are designated as "Limited Visibility Alerts" by default. If any asset for which you havepermissions has its alerts specified as "Limited Visibility", then you have limited visibility permissions forthat asset. If you have permissions to view limited visibility alerts, then, when you are logged in to GEDigital APM, you will see both limited visibility alerts and general visibility alerts.

When you hover over the grayed-out icon, a "Set Visibility to General" message appears. If you havelimited visibility permissions for Alerts and permissions to manage alerts, then you can change the

visibility factor for an alert by selecting the limited visibility alert icon ( ), which changes the alert icon

to ( ), meaning that the alert now has general visibility and can be seen by anyone with permissions to


view alerts. When you hover over the general visibility icon, a "Set Visibility to Limited" message appears.Selecting the icon returns the visibility of the alert back to limited visibility.

If you have access to the Alert Timeline View, then when an alert is set as "Visible to All", in the timelineview you can see who changed the visibility for the alert and when the change was made. Likewise, whenthe alert visibility is changed to "Limited", in the timeline view you can see that the visibility was changedto "Limited" as well as who changed the visibility and the time stamp for the change.

About Alert NotificationWhen an alert to which you have subscribed is updated by another user, you will receive an emailnotification about the change.

An email will be sent to the email address that you provide in your user profile. When you claim an alert,you are automatically subscribed to that alert. However, you cannot see who else has subscribed to thatalert.

Note:

• When a user updates an alert that belongs to another tenant, you will not receive any emailnotification about the change even though you have subscribed to the alert.

• When you lose access to an asset, you lose subscription to the alerts for that asset to which you hadpreviously subscribed.

• When you release an alert, you automatically lose subscription to that alert and stop receivingnotifications about any changes made to the alert.

The following table provides a list of activities that will send an email notification and the email messagedetails. All notifications include the following information:

• The date and time when the action was performed

Note: In the email notification, the date and time appear based on the time zone set in the MyPreferences page.

• The first name and last name of the user who performed the activity

An email notification is not sent for the alerts whose template property is set to not Consumable.

Table 3: Alerts Notification

Activity (that Triggers Notification) Email Notification Details

Alert Assigned <Alert severity and alert ID>

Alert Event Time: <Time at which the event that triggered thealert occurred>

Alert Received Time: <Time of receiving the alert>

Alert Assigned for <Asset ID>: <Asset Name>: <Site Name>

Alert assigned to <User First Name> <User Last Name>

Note: The asset and site details are included in the email only ifemail notifications are not configured to be secured for thetenant.

Alert Claimed No additional detail

Alert Template Updated Alert Template updated from <original alert template name> to<current alert template name>

Disposition Updated Disposition updated from <Original Value> to <Current Value>

Case Created Case <Case ID>: <Case Name> created


Activity (that Triggers Notification) Email Notification Details

Claim Released No additional detail

Marked as Processed No additional detail

Alert Marked as Processed by Auto Close Alert <Alert ID>:<Alert Name> Template

Mark as Processed by AutoClose Action in Case

<Date with Timestamp> - <Username>

Alert Reopened No additional detail

Note Added Note Text: <Note Details>

Note Deleted Note Text: <Note Details>

Attachment Added Attachment Name: <Name of Attachment>

Attachment Deleted Attachment Name: <Name of Attachment>

About Alert SubscriptionSubscribing to an alert causes you to be notified when there are any changes to the alert.

You can subscribe to an alert by selecting the grayed-out Unsubscribed icon ( ) in the Alert Detailspage. Hovering over the icon displays the text "Subscribe to this alert". Once you are subscribed, the icon

changes to the Subscribed icon ( ), which means that you will receive email notifications for changesto that alert. Hovering over the Subscribed icon displays the text "Unsubscribe from this alert". Selectingthe icon again will unsubscribe you from the alert.

Whenever you claim an alert, you are automatically subscribed to that alert, and will receive emailnotification when subsequent changes are made to the alert. The notification will also indicate by whomthe changes were made.

Note:

• When you lose access to an asset, then you lose subscription to the alerts for that asset if you hadpreviously subscribed to alerts for that asset.

• When you release an alert, you automatically lose subscription to that alert.

About Alert Escalation and De-escalationEscalation and de-escalation of an alert indicates the significance of the alert, which helps you prioritizethe alert for processing. Alert escalation and de-escalation are applicable only to latched alerts, and thestatus of an alert changes based on the change in severity.

The following table describes the alert escalation and de-escalation indicators based on the severitychange.

Change in Alert Severity Escalation Status Indicator

No change in severity No change

Increase in severity Escalated

Decrease in severity De-escalated


Example of Alert Escalation and De-escalation for an Unclaimed Alert in the Ready State

The following diagram illustrates an example of the alert escalation and de-escalation based on thechange in severity for an unclaimed alert, which is in the Ready state.

Consider a scenario where an alert occurs four times for the same asset with differentseverity.

The first occurrence of an alert is the initial alert for an asset. The alert is in the Readystate.

If the second occurrence of the alert for the asset has a severity higher than the initial

alert, the initial alert displays with its name to indicate that the alert is escalated.

If the third occurrence of the alert for the asset has the same severity as the severityof the alert in second occurrence, the initial alert displays with its name to indicatethat there is no change in severity.

If the fourth occurrence of the alert for the asset has the severity lower than the

severity of the alert in third occurrence, the initial alert displays with its name toindicate that the alert is de-escalated.


Example of Alert Escalation and De-escalation for Claimed Alert that is in In Process State

The following diagram illustrates an example of the alert escalation and de-escalation based on thechange in severity for a claimed alert, which is in the In Process state.

The first occurrence of an alert is the initial alert for an asset. When you claim thealert, the state changes from Ready to In Process.

If the second occurrence of the alert for the asset has a severity higher than the initialalert, the following changes occur on the initial alert:

• The state of the initial alert changes to In Process Escalated.

• The initial alert displays with its name to indicate that the alert is escalated.

If the third occurrence of the alert for the asset has the same severity as the severityof the alert in second occurrence, the following changes occur on the initial alert:

• The state of the initial alert will remain as In Process Escalated.• The initial alert displays with its name to indicate that there is no change in

severity.


If the fourth occurrence of the alert for the asset has the severity lower than theseverity of the alert in third occurrence, the following changes occur on the initialalert:

• The state of the initial alert changes to In Process.

• The initial alert displays with its name to indicate that the alert is de-escalated.

About SmartSignal Analytic Instance for MaintenancePerforming maintenance is the process of selecting an analytic instance associated with a SmartSignalalert for maintenance and retraining the analytic instance. You can select the SmartSignal analyticinstance from the Alerts application independent of the SmartSignal application.

Note: You can perform maintenance of analytic instances for only SmartSignal alerts that are in the InProcess state. The SmartSignal alerts should belong to the same tenant.

When you select Perform Maintenance for an alert, the status of the alert changes to In ProcessMaintenance, which signifies that the alert was generated because the analytic instance did notaccurately reflect the current operating state. Therefore, you can select the analytic instance associatedwith the alert for maintenance and retrain the analytic instance.

Note:

You must have the following permissions to perform maintenance:

• The Alerts or Manage Alerts permission to change the status of the alert to In Process Maintenance.

Note: You can change the status of an alert other than a SmartSignal alert to In Process Maintenance.However, you cannot access the analytic instance for the alert.

• The SmartSignal Mapping permission to modify an analytic instance of a SmartSignal alert. For moreinformation on SmartSignal permissions, refer to Default Permission Set Definitions in the Users andPermissions documentation.

For more information on how to access the analytic instance associated with an alert, refer to:

• Access the analytic instance that is associated with a SmartSignal alert for maintenance from theAlerts Inbox

• Access the analytic instance that is associated with a SmartSignal alert for maintenance from theAlerts Grid


Chapter

2Alerts Grid ViewTopics:

• About Alert Grid View


About Alert Grid ViewBy default, the alerts appear in tabular format. If you select to view alerts in the Inbox view, theselection persists, even if you log out and log in to the GE Digital APM application.

In Grid view, you can view the alerts in a compressed layout as columns.

Note: Even though you have access to assets and enterprises of another tenant, for the alerts to appearin the grid view, you must have access to at least one asset of the same tenant to which you belong.

By default, the Alerts grid view is refreshed only when you select . However, you can enable auto-refresh for the view to be automatically refreshed in specific intervals by selecting the time interval in the

drop-down list box next to . You can select one of the following values in the drop-down list box:

• 30 Sec• 1 min• 5 min• 10 min

In the drop-down list box, you can select Off to disable the auto-refresh for the view.

In the Alerts grid view, you can sort the grid columns by selecting the column header. Latched alerts willappear in the grid, and the COUNT column displays the number of times the specific alert has occurred,and the FIRST OCCURRENCE and LAST OCCURRENCE columns display the date and time when thealert occurred first and when it occurred last, respectively.

The following columns are available in the grid view:

Column Header Description

ALERT ID The unique identification number for the alert.

ALERT SOURCE The source of the alert creation, such as Manual (creation), fromSmartSignal, or from the Orchestration Manager.

ALERT TYPE The type of the alert.

ALERT UUID The universally unique identifier of the alert.

ANALYSIS LINKS The analysis views available for the alert.

ANALYTIC INSTANCE The SmartSignal analytic instance associated with the alert.

ASSET ALIAS The alias for the asset name.

ASSET CUSTOMER NAME The name of the customer who owns the asset.

ASSET ID The unique identification number of the asset that caused thealert.

ASSET NAME The name of the asset that caused the alert.

ASSET PARENT The parent asset of the asset associated with the alert.

COUNT The number of latch alerts for a grouped alert. If the alert is notlatched, a dash (-) is displayed.

DENSITY The density value only appears for SmartSignal and SmartSignalTag Rule alerts. For other types of alerts, the value is blank.

DISPOSITION The disposition of the alert, such as Valid or False. This columnis required and the default value for an alert disposition is None.


Column Header Description

DISPOSITION QUALITY The information on whether the disposition of an alert wascorrect or incorrect. This column contains a value only for theprocessed alerts.

EVENT TIME The date and time of the event occurrence that caused thealert.

FIRST OCCURRENCE The date and time of the first occurrence of the grouped alert.

LAST OBSERVATION The date and time of the last observation of the alert.

LAST OCCURRENCE The date and time of the latest occurrence of the grouped alert.

LAST PROCESSED The date and time of the last processing of the alert.

LINKED CASES The link to any linked cases attached to an alert, which opensthe case in a separate browser tab.

NAME The name of the alert.

NOTES The number of notes present for an alert. Selecting the numberopens a window where you can view the note details. You canfilter the details by text.

Note: Internal Notes are not viewable in grid view.

OWNER The name of the person who owns the alert.

Note: In the following scenarios, the value that appears in theOWNER column is NULL:

• The corresponding alert is unclaimed.• The corresponding alert is not assigned to a user.

RECEIVE TIME The date and time when the alert was received.

SEVERITY The severity of the alert, where 1 being the most severe.

SEVERITY CHANGE The number of times the severity of the alert has been changed.

SITE NAME The name of the site where the asset is located.

SOURCE KEY The source key of the asset.

STATUS The status of the alert such as Ready (to be claimed), In Process(alert has an owner), or Processed (alert has been marked asprocessed).

TENANT ID The unique identification number of the tenant associated withthe alert.

USER NAME The name of the person who claimed the alert. When an alert isunclaimed, the value for User Name is NULL.

VISIBILITY The visibility of an alert, for example, Limited orGeneral.

You can view the alerts with Limited visibility if youhave the Limited visibility permissions. Anyonewith permissions to view alerts can view the alertswith General visibility.

You can filter and sort this column in the grid. Youcan change the visibility by selecting the Name ofthe alert. You must refresh the screen for thechange to take effect.


If you select a column header, the grid is primarily sorted for the selected column alphabetically inascending or descending order, and secondarily sorted by Alert Time Received (latest on top).

In the Alert Inbox grid view, if you select a different filtered Alert inbox in the module navigation menu orapply a new filter set using More Filters, the new filtered inbox appears in the grid view.

Selecting an alert displays the Alert Details page in another tab.

Toggle the Alert Inbox ViewYou can switch between the alerts inbox and alerts grid anytime while viewing the alerts.

About This Task

Procedure

• To access alerts grid:

1. In the module navigation menu, go to Alerts.

2. Select , and then select an alert filter set.A pane that contains a list of alerts appears.

3. Select .

The currently filtered alerts and information associated with the alerts appear in a table.

• To switch back to alerts inbox view, select .

Access Alerts of an Asset in Alerts GridThe Asset Hierarchy section in an alerts grid provides you with an option to select an asset such that youcan view the alerts related to the asset. You can select multiple assets and the alerts associated with theselected assets appear in the alerts grid.

About This Task

The Asset Hierarchy section contains all the assets for which you have access permission.

Procedure


2. Select , and then select the alert filter set.The alerts for the selected filter set appears.

3. Select .The Asset Hierarchy window appears, containing the list of assets in a parent-child structure.

Note: The hierarchy contains all the assets for which you have access permission.

Tip:

• You can search for an asset within the hierarchy.• You can filter the assets based on its category.

To filter the assets, perform the following steps:

a. Select Filter.The ASSET CLASSIFICATION section appears.


b. In the Select Asset Classification drop-down list box, select the category of the asset, andthen select Apply.

4. Select the check boxes corresponding to the assets for which you want the associated alerts.

Note: When you select a parent at any level in the Asset Hierarchy window, the subsequent childelements are also selected by default.

5. Select Apply.

Results

The alerts grid is refreshed, and the alerts associated with the selected assets appear.

Tip: To collapse the Asset Hierarchy section, select .

You can apply your favorite filters to the list of alerts.

The selection, and the open or collapsed state of the hierarchy persists, and it is available the next timeyou access the application.

Add and Remove Columns in the Alerts GridYou can show or hide certain columns in the Alerts Inbox grid view.

About This Task

Use the columns drop-down list box to add and remove columns in the Alert Inbox grid view.

Note: You can add or remove multiple columns by selecting or deselecting multiple columns at the sametime. This setting will be saved across the sessions for the given user.

Procedure

• To add a column using the Show Columns drop-down list box:


2. Select .The currently filtered alert inbox appears as a table.

3. In the Show Columns drop-down list box, select the check box for the column that you want toadd to the Alerts grid.The selected column appears in the grid.

Note: You can enter the name of the column in the Search box to search for it in the drop-downlist.

• To add a column using the Table Settings window:


2. Select .The currently filtered alert inbox appears as a table.

3. Select .The Table Settings window appears.

4. In the SHOW COLUMN column, select the check box for the column that you want to add to thegrid.

5. Select Apply.The selected column appears in the grid.

• To remove a column using the Show Columns drop-down list box:


1. In the Show Columns drop-down list box, clear the check box for the column that you want toremove from the Alerts grid.The column is removed from the grid.

• To remove a column using the Table Settings window:


2. In the SHOW COLUMN column, clear the check box for the column that you want to remove fromthe grid.

3. Select Apply.The selected column is removed from the grid.

Sort and Filter ColumnsSorting and filtering columns allow you to categorize and find the required data easily.

Before You Begin

You must have one of the following permissions:

• View Alert Detail• View Limited Visibility Alerts• Alerts• Manage Alerts

About This Task

Sorting of a column in a grid is not affected by a filter. For example, suppose you had sorted the NAMEcolumn in alphabetical order and the ALERT ID column in descending order. When you filter the NAMEcolumn with a specific alert name, the order in which the data is sorted in the NAME and ALERT IDcolumns remains unchanged.

Procedure

• To sort a column:



3. Select .The alert grid for the selected filter set appears.

4. Select the heading of the column that you want to sort.The column is sorted in reverse order.

The ASSET ID, ASSET NAME, ASSET ALIAS, ASSET CUSTOMER NAME, and SITE NAME columnsare sorted in the natural collation order, first by number, then uppercase and lowercase letter, andthen Receive Time.

Tip: To reverse the order, select the column heading again.• To filter a column:





4. In the heading of the page, select the Toggle Filter button ( ).The Filter boxes appear for each column in the table.

5. In the Filter box for the column based on which you want to filter the table, enter a few characters.

Note: In Internet Explorer, double-click the Filter box, and then enter the text.

Tip: As soon as you enter three characters, entries are filtered in the column. As you continue totype, the entries are further filtered, narrowing the results.

For example, to find the alerts that are in process, in the Filter box of the STATUS column, enterIn.The data in the grid is filtered, and only entries with the In Process and In Process Maintenancestatuses appear.

Reorder Columns in Alerts GridYou can customize the alerts grid by reordering the columns.

Before You Begin

You must have permissions to view and edit alerts.

About This Task

You can change the order of the columns by dragging the columns in the grid. You can also use the TableSettings window to reorder the columns. After you have reordered the columns in the alerts grid, thesetting persists even if you do any of the following:

• Change alerts• Navigate away from the Alerts module• Change the alert filter set• Log out and then log back in

Procedure

• To reorder the columns by dragging:


2. Select , and then select the alerts filter set for which you want to reorder the columns in alertsgrid.

3. Select A pane that contains a list of alerts appears.

4. Select the name of the column header that you want to move, and then drag the column either tothe left or to the right in the table.The column position is rearranged based on where you dropped it in the table.

• To reorder the columns using the Table Settings window:


2. Select , and then select the alerts filter set for which you want to reorder the columns in alertsgrid.

3. Select A pane that contains a list of alerts appears.



5. In the RE-ORDER column, hover over the row that contains the name of the column whoseposition you want to change in the table, and then select one of the following buttons:

◦ : Moves the columns to the left in the table

◦ : Moves the columns to the right in the table6. Select Apply.

The column position is rearranged in the table.

Freeze Columns in Alerts Grid

About This Task

You can freeze the columns in the Alerts grid to keep the columns visible on the left of the grid while youscroll to another area of the grid.

Procedure





5. In the FREEZE COLUMN LEFT column, select the check box corresponding to the name of the columnthat you want to freeze.

6. Select Apply.The selected column is locked and remains visible even when you scroll to another area of the grid.

Group ColumnsGrouping of columns organizes data in different levels.

Before You Begin

• You can group the following columns:

◦ ALERT SOURCE◦ ASSET ALIAS◦ ASSET CUSTOMER NAME◦ ASSET ID◦ ASSET NAME◦ OWNER◦ SEVERITY◦ SITE NAME◦ STATUS◦ USER NAME


Procedure


2. Select , and then select the alert filter set to access the alerts grid in which you want to groupcolumns.The alerts grid for the selected filter set appears.

3. Select a column heading, and then drag it to the Drag a column header here to group by thatcolumn box.

Results

The selected columns are grouped. The setting persists such that the grouped columns are available thenext time you access the application. You can expand each group to access the alerts that belong to thegroup. Additionally, the number of alerts that belong to a group appears next to the name of the group.

Note:

• For uninterrupted performance, while an operation is being performed on grouped columns, do notperform another operation at the same time. We recommend that you wait for the operation tocomplete.

• In Internet Explorer, to filter data in the grid, double-click the Filter box, and then enter the text.

View Linked Cases in Alerts GridYou can view the case details associated with an alert by selecting the linked cases in the alerts grid.

Before You Begin

You must have Cases and View Case Details permissions to complete these tasks.

About This Task

Note: The Limited Visibility cases will be available in the LINKED CASES column only if you have the ViewLimited Visibility Cases permission. Otherwise, only the General Visibility Cases will be available in theLINKED CASES column.

Procedure



3. Select to view alerts in a grid view.4. Perform the following steps to view the details of a case associated with an alert:

a) In the LINKED CASES column for an alert, select .A menu appears, displaying the IDs of the cases that are associated with the alert.

Note: The number of cases associated with the alert appears in parenthesis next to the icon.b) In the menu, select the ID of the case whose details you want to view.

The details of the linked case appear in a new tab.


View Notes in Alerts Grid

About This Task

In the Alerts grid, you can view the public notes related to an alert.

Procedure



3. Select to view alerts in a grid view.

4. In the NOTES column of the grid, select for the alert whose notes you want to view.The public notes related to the alert appear in a tool-tip.

Generate a PDF Report for an Alert

Before You Begin

You must have one of the following permissions to export the details of an alert to a PDF file:

• Alerts• View Alert Details• Manage Alerts

About This Task

You can export the details of an alert to a PDF file. The PDF report contains the details of the alert, andyou can thereby easily print or share the information from that PDF. You can export the following sectionsof the Alert Details page:

• ASSET INFORMATION• ANALYSIS• SCAN GROUP DATA• NOTES• EVIDENCE• LINKED CASES

The charts in the ANALYSIS or EVIDENCE section appear as images in the PDF file.

Note:

• If an analysis or evidence of an alert contains multiple cards, only the charts of the first card appear inthe generated PDF report.

• A generated PDF report for an alert can contain up to eight charts of an analysis or evidence.

Procedure


2. Select , and then select the alert filter set that contains the alert for which you want to generate aPDF report.A page that contains a list of alerts appears.


3. Select the alert.The Alert Details page appears.

4. Select , and then select Export PDF.The Export PDF window appears.

5. Select the sections that you want to include in the report.

By default, all sections are selected. The ALERT INFORMATION option is unavailable for selection andby default, it is included in every report that was generated for the alert.

To cancel the selection for a section that you do not want to include in the PDF report, select thesection to remove the check mark.

6. Select Export.A message appears, indicating that the PDF report is being generated.

Note:

• Export of alert details to a PDF file may take up to five minutes.• Only a PDF file of size up to 5 MB will be generated for an alert.

ResultsThe PDF file is downloaded on your computer based on the web browser setting.

Select Alerts for Bulk Action

Before You BeginIf you have only View Alert Detail permissions, the Bulk Actions drop-down list box will be unavailable inthe alerts grid.

About This TaskUsing Bulk Action, you can perform the same action on multiple alerts simultaneously. However, you canuse the Bulk Action feature to perform only those actions that are supported by all the selected alerts. Forexample, you can change the owner of multiple alerts at a time only if none of the alerts is in Processedstate. If even one of the selected alerts is in Processed state, you cannot change the owner of the rest ofthe alerts using the Bulk Action feature.

Procedure



3. Select to view the alerts in grid view.4. Select the check box for each alert for which you want to perform the bulk action or select the check

box in the table header to include all alerts.A pane appears at the bottom of the table.

Tip: To select consecutive alerts, select the check box for the first alert, press and hold Shift, and thenselect the check box for the last alert.

5. Perform one of the following steps:

• If you want to update the notes, disposition, status, or owner for the alert, in the pane that isdisplayed at the bottom of the table, specify the appropriate values in the NOTES, DISPOSITION,STATUS, and OWNER boxes, respectively, and then select Submit.

• If you want to perform other actions on the alerts, select Bulk Actions, and then select one of thefollowing options.


Note: The Bulk Action drop-down list box will be enabled only after you select one or more alerts.

Bulk Action Description

Claim Claims the alerts and perform various actions on them.

Note: You cannot claim an alert that belongs to another tenant.

When you select this option, a message appears, indicating the resultof the action, where <N> is the number of alerts affected.

Disposition Applies the disposition for the selected alerts.

Note: You cannot apply a disposition for an alert that belongs to another tenant.

When you select this option, the Disposition window appears.Select one of the following options, and then select Apply:

• NoneSpecifies not to assign any disposition.

By default, None is selected.• Valid

Specifies a valid issue, which requires additional action.• False

Specifies False positive, which does not require any further action.• False system

Specifies a False positive because of a system malfunction. Henceit does not require any further action.

• Sensor IssueSpecifies a Sensor malfunction, which may require a work orderto investigate and repair the failed sensors.

• Reset State DataSpecifies that an Alert is a result of corruption or resetting ofstate information, which may require further action.

• OutageSpecifies an outage at a plant for an associated asset. Hence, itdoes not require any further action.

A message appears, indicating the result of the action, where <N> isthe number of alerts affected and the selected change appears in theDisposition column for the alerts.

Note:

• Only the owner of an alert can change its disposition.• If an alert does not have an owner, you cannot update the disposition.• If an alert has been processed, then you cannot update its disposition.

Release Claim Applies release claims on selected alerts.

Note: You cannot release a claim for an alert that belongs to another tenant.


After the Release Claim is applied to the selected alerts, their statuschanges from In Process to Ready.

Mark as Processed Marks the selected alerts as being processed.

Note: You cannot mark an alert that belongs to another tenant as processed.




Status of the selected alerts is changed to Processed.

Create Case Creates a case for multiple alerts.

Note: You cannot create a case for an alert that belongs to another tenant.

When you select this option, the Create Case window appears.Enter the required details, and then select Create.

Note: You can create a case only for claimed alerts and the alerts should belong to thesame asset.

A case is created for the selected alerts.

Add Note Adds the entered text as a note to the selected alerts.

When you select this option, the Add Note window appears. In thetext box, add a note, and then select Save.

Note: In the text box, you can add a note of up to 5000 characters.

A message appears, indicating the result of the action, where <N> isthe number of alerts affected.

If one of the selected alerts is opened, the added note appears in theNotes section of the details page of the alert.

Upload Evidence Uploads files that are attached to the selected alerts.

When you select this option, your browser file selection dialog boxappears. Select the file that you want to upload as evidence to theselected Alerts.

A message appears, indicating the result of the action, where <N> isthe number of alerts affected.

Perform Maintenance Performs actual maintenance on the alerts.

The Perform Maintenance option is available in the Bulk Actionsdrop-down list box only if the selected alerts are in In Process state.

The status of the selected alerts changes to In Process Maintenance.

Note: It is recommended to perform maintenance on alerts that are generated bySmart Signal or any Analytics. If you perform maintenance on other alerts, only thestatus changes to In Process Maintenance with no impact on the workflow.

View Default Analysis The View Default Analysis option is available in the Bulk Actions drop-down list boxonly if SmartSignal is configured as an Alert Source.

Opens the default analysis charts of the selected SmartSignal alerts.

You can select up to 10 SmartSignal alerts.

When you select this option, the charts of selected alerts aredisplayed in a separate web browser tab in Analysis view.

If the tenant preferences for Smart Signal charting is set to Create aNew Card for Each Alert, then a new card is created for each alert.The name of the card is set to the alert name. By default, this settingis off.



When the setting is off, all the tags from the selected alerts areplotted on the same card. If the card limit is exceeded, a new card iscreated automatically where the remaining tags are plotted.

Access the SmartSignal Analytic for Maintenance from the Alerts GridPerforming maintenance is the process of selecting an analytic instance associated with an alert formaintenance and retraining the analytic instance if it generated a spurious alert because the analyticinstance did not accurately reflect the current operating state. You can access the analytic instanceassociated with a SmartSignal alert from the ANALYTIC INSTANCE column in the alerts grid.

Before You Begin

You must have the following permissions to perform the tasks related to perform maintenance:


Note: You can change the status of an alert other than SmartSignal alerts to In Process Maintenance.However, you cannot access the analytic instance for the alert.


About This Task


Procedure


2. Select , and then select the alert filter set that contains the alert for which you want to performmaintenance of the associated analytic instance.A grid for the selected filter set appears.

Tip:

You can change the status of the alert to In Process Maintenance to signify that the analytic instanceassociated with the alert is in maintenance. To change the status, perform the following steps:

a. In the grid, select the check box for each alert for which you want to perform maintenance of theassociated analytic instance.

b. In the Bulk Actions drop-down list box, select Perform Maintenance.

The status of the selected alerts changes to In Process Maintenance.

You can filter the STATUS column such that the grid displays only alerts that are in In ProcessMaintenance state.

3. In the ANALYTIC INSTANCE column, select the link to access the SmartSignal Maintenance page,where you can modify the analytic instance for the corresponding alert.

Note:

The ANALYTIC INSTANCE link is not available for the following alerts, instead it contains None:

• Alerts other than SmartSignal alerts.


• Alerts that belongs to another tenant.

For more information on modifying an analytic, refer to the Analytics documentation.


Chapter

3Alerts Inbox ViewTopics:

• About Alert Inbox View


About Alert Inbox ViewIn the Alert Inbox view, the list of alerts that match the filter criteria appears in a pane on the left of thepage. You can select an alert in the pane to access the details of the alert in the Alert Details page.

By default, the Alerts grid view is refreshed only when you select . However, you can enable auto-refresh for the view to be automatically refreshed in specific intervals by selecting the time interval in the

drop-down list box next to . Disabling auto-refresh prevents new alerts from loading until youmanually refresh the queue.

Toggle the Alert Grid ViewYou can switch between the Alert Inbox and Alert Grid views anytime while viewing the alerts.

About This Task

Procedure

• To access Alert Inbox view:



3. Select .

The currently filtered alerts and information associated with the alerts appear in a table.

• To switch back to Alert Grid view, select .

Access Alerts of an Asset in Alerts InboxIn the alerts inbox, you can select an asset such that you can view the alerts related to the asset. You canselect multiple assets and the alerts associated with the selected assets appear in the alerts inbox.

Procedure


2. Select , and then select the alert filter set.The alerts inbox for the selected filter set appears.

3. Select .The Asset Hierarchy pane appears, containing the list of assets in a parent-child structure.

Note: The hierarchy contains all the assets for which you have access permission.

Tip:

• You can search for an asset within the hierarchy.• You can filter the assets based on its category.

To filter the assets, perform the following steps:

a. Select Filter.The ASSET CLASSIFICATION section appears.


b. In the Select Asset Classification drop-down list box, select the category of the asset, andthen select Apply.

4. Select the check boxes corresponding to the assets for which you want the associated alerts.

Note: When you select a parent at any level in the Asset Hierarchy pane, the subsequent childelements are also selected by default.

5. Select Apply.

Results

The alerts inbox is refreshed, and the alerts associated with the selected assets appear.

You can use the Filters icon ( ) to apply your favorite filters to the list of alerts.

The selection persists, and it is available the next time you access the application.

Access the SmartSignal Analytic Instance for Maintenance from theAlerts Inbox

Performing maintenance is the process of selecting an analytic instance associated with an alert formaintenance and retraining the analytic instance if it generated a spurious alert because the analyticinstance did not accurately reflect the current operating state. You can access the analytic instanceassociated with a SmartSignal alert from the details section of an alert.

Before You Begin

You must have the following permissions to perform the tasks related to perform maintenance:


Note: You can change the status of an alert other than SmartSignal alerts to In Process Maintenance.However, you cannot access the analytic instance for the alert.


About This Task


Procedure


2. Select , and then select the alert filter set that contains the alert for which you want to performmaintenance of the associated analytic instance.A pane that contains a list of alerts appears.

3. Select the alert for which you want to perform maintenance of the associated analytic instance.A section that contains the details of the alert appears.

Tip: You can change the status of the alert to In Process Maintenance to signify that the analyticinstance associated with the alert is in maintenance. To change the status, in the details section of thealert, select , and then select Perform Maintenance. The status of the alert changes to In ProcessMaintenance.

4. In the ALERT INFORMATION section of the alert, select the ANALYTIC INSTANCE link to access theSmartSignal Maintenance page, where you can modify the analytic instance.


Note:

The ANALYTIC INSTANCE link is not available for the following alerts, instead it contains None:

• Alerts other than SmartSignal alerts.• Alerts that belong to another tenant.

For more information on modifying an analytic instance, refer to the Analytics documentation.

Generate a PDF Report for an Alert

Before You Begin

You must have one of the following permissions to export the details of an alert to a PDF file:

• Alerts• View Alert Details• Manage Alerts

About This Task

You can export the details of an alert to a PDF file. The PDF report contains the details of the alert, andyou can thereby easily print or share the information from that PDF. You can export the following sectionsof the Alert Details page:

• ASSET INFORMATION• ANALYSIS• SCAN GROUP DATA• NOTES• EVIDENCE• LINKED CASES

The charts in the ANALYSIS or EVIDENCE section appear as images in the PDF file.

Note:

• If an analysis or evidence of an alert contains multiple cards, only the charts of the first card appear inthe generated PDF report.

• A generated PDF report for an alert can contain up to eight charts of an analysis or evidence.

Procedure


2. Select , and then select the alert filter set that contains the alert for which you want to generate aPDF report.A pane that contains a list of alerts appears.

3. Select the alert.The Alert Details page appears.

4. Select , and then select Export PDF.The Export PDF window appears.

5. Select the sections that you want to include in the report.

By default, all sections are selected. The ALERT INFORMATION option is unavailable for selection andby default, it is included in every report that was generated for the alert.

To cancel the selection for a section that you do not want to include in the PDF report, select thesection to remove the check mark.


6. Select Export.A message appears, indicating that the PDF report is being generated.

Note:

• Export of alert details to a PDF file may take up to five minutes.• Only a PDF file of size up to 5 MB will be generated for an alert.

Results

The PDF file is downloaded on your computer based on the web browser setting.


Chapter

4Manage AlertsTopics:

• About Alert Actions


About Alert ActionsIn the alerts inbox and details page of an alert, you can perform various tasks.

You can perform the following tasks for an alert that belongs to the same tenant:

• Claim and release an alert.• Assign an alert.• Assign a disposition to an alert.• Add notes to an alert.• Create an alert manually.• Apply filters to an alert.• Add evidence to an alert.• Create and view a case from an alert.• Create a recurring alert.• Mark an alert as processed.• Audit of an alert.• Generate a PDF report for an alert.• View an asset faceplate from an alert.

For an alert the belongs to another tenant, you can perform only the following tasks:

• View the analysis chart.• View and add notes.• View existing evidence and attach new evidence.• View the audit results of an alert.• View the list of linked cases with general visibility that are associated with the assets to which you

have access.• Export alerts to PDF.

Claim or Release an Alert

About This Task

Claiming an alert allows you to take ownership of an alert, select its disposition, and create a case for thealert.

Note:

• You cannot claim or release a claim for an alert that belongs to another tenant.• When you release an alert, you automatically lose subscription to that alert.

Claiming an alert in the Ready state changes its status to In Process. If an alert is In Process, you cannotclaim the alert until it has been released by the current owner.

Procedure

• To claim an alert:


2. Select , and then select the alert filter set.The alerts inbox for the selected filter set appears.

3. Select an alert in the alerts queue.


The selected alert appears.4. Select Claim Alert.

Note: For a SmartSignal advisory, select Claim Advisory.

The alert status changes to In Process with you designated as the owner, and the alert moves to theMy Alerts filter queue.

Note: You can select the My Alerts filter to view claimed alerts.• To release a claim, select , and then select Release Claim.

The alert returns to the Unclaimed filter queue. Releasing an alert causes it to revert to a Readystatus.

Assign an AlertAn analyst can assign an alert that belongs to the same tenant to another user.

Before You Begin

You must have Manage Alerts permissions to assign an alert to another user.

About This Task

Procedure


2. Select , and then select the alert filter set that contains the alert that you want to assign.A pane that contains a list of alerts appears.

3. Select the alert.A section that contains the details of the alert appears.

4. Select , and then select Assign Alert.The Assign Alert window appears.

5. Select the text box, and then in the Search box that appears, enter at least one character of the username.A list of user names populates with the matching characters.

6. From the list, select the user to whom you want to assign the alert.

7. Select Assign.

Results

The name of the user appears as the owner in the ALERT INFORMATION section, and the user is nowsubscribed to this alert. In addition, visibility for this alert is set to Limited.

Note: When you assign an alert to a user who does not have access to the alert, and does not haveManage Alerts permission, a message appears indicating that the alert was not assigned.

Assign an Alert DispositionAfter claiming an alert, you can assign a disposition to indicate its validity. Dispositions are retained whenyou release, process, or reclaim an alert.

About This Task

Note: You cannot assign a disposition for an alert that belongs to another tenant.


In the Alerts grid view, the default value for Disposition is None and the Disposition column is required.The Disposition column can be sorted as well.

Procedure


2. Select , and then select My Alerts to display the claimed alerts.A pane that contains a list of claimed alerts appears.

3. Select the alert to which you want to assign a disposition.A section that contains the details of the alert appears.

4. In the Disposition drop-down list box, select one of the following options.

Valid Valid issue that requires additional action.

False False positive. The alert does not need any further action.

False - System False positive because of a system malfunction. The alert does not need any further action.

Sensor Issue Sensor malfunction. The alert may result in a work order to investigate and repair the failed sensors.

Reset State Dat The alert is a result of the corruption or resetting of state information. Corrupted state informationrequires additional action.

Outage Outage at the plant for the associated asset. The alert does require not any further action.

None No disposition assigned.

Your selection results in the following workflow actions:

• Selecting False, False - System, or Outage invalidates the alert.• Selecting Valid, Sensor Issue, or Reset State Dat acknowledges that the alert needs further

investigation, and you can begin your analysis.

Add or Delete Notes in an AlertNotes can help clarify evidence during a diagnosis.

About This TaskThere are two note sections in the details page of an alert, INTERNAL NOTES and NOTES.

• Internal NotesThe INTERNAL NOTES section appears only if you have either View Internal Notes or Manage InternalNotes permission. If you have the View Internal Notes permission, you can view and read any internalnotes, but cannot add or edit the note. The Manage Internal Notes permission allows you to viewinternal notes and add a note. However, you can delete only your own notes. The INTERNAL NOTESsection does not appear in the alerts grid, nor can be exported to a PDF.

• Notes

The NOTES section is available to all users with View Alert Detail or Manage Alert permission. If you haveManage Alert Detail permissions, you can edit or delete notes. The NOTES section appear in alerts grid asa column, and can be exported to a PDF.

Procedure

• To add a note:


2. Select , and then select the alert filter set that contains the alert for which you want to add anote.


A pane that contains a list of alerts appears.3. Select the alert.

A section that contains the details of the alert appears.4. In the NOTES section of the alert, enter text in the box.

Note: You can enter up to 5000 characters.5. Select Add Note.

The new note appears in the NOTES section.

• To delete a note, select next to the note.The selected note is removed from the NOTES section.

Add, Delete, or Download Evidence in an AlertYou can add files to an alert as evidence to help diagnose an issue. In addition, when you save an analysisof an alert in Analysis view, it appears as an evidence in the EVIDENCE section of the alert.

About This Task

Evidence can be examined by anyone with access permission for the alert. You can add the followingdocument types:

• Image files (JPG, JPEG, PNG, BMP, TIF)• Text type files (DOC, DOCX, XLS, XLSX, PPT, PPTX, TXT)• PDF files

You cannot add folders or EXE, BAT, CMD, MSI, BIN, ZIP, RAR files as evidence.

You can download the files that are attached as evidence or delete the files that you have attached.

Procedure

• To add a file:


2. Select , and then select alert filter set that contains the alert for which you want to add a file asevidence.A pane that contains a list of alerts appears.

3. Select the alert.A section that contains the details of the alert appears.

4. In the EVIDENCE section, select .5. Select the file that you want to add as evidence, and then select Open.

The name, type, and size of the file appear in the EVIDENCE section.

Important: While the file is being uploaded, do not navigate away from this page, else the file willnot be added.

• To delete a file, select for the file that you want to delete.

You can delete only the files that you have added.

• To download a file to your local drive, select for the file that you want to download.


Create an Alert ManuallyYou can create an alert at any level of the asset hierarchy that belongs to the same tenant.

Before You Begin

You must have Manage Alerts and Limited Visibility permissions to create an alert.

About This Task

You can create an alert to monitor potential issues. You can enter asset IDs at the enterprise, site, andsegment levels, in addition to the actual asset.

Procedure



3. In the heading of the alerts inbox, select .The Create Alert window appears.

4. In the ASSET ID box, enter a valid asset ID.

Note: You can enter an asset ID for an enterprise, a site, a segment, or an asset.5. In the ALERT TEMPLATE box, enter characters to populate the list of templates that matches the

characters.

Note: For an alert template to appear in the list of templates, the template must have the Source fieldset to Manual.

6. As needed, select Single Alert or Recurring Alert.7. In the EVENT TIME box, select a date and time for the event.

The Create button becomes active.8. Select Create.

A message appears indicating that an alert was created successfully. The new alert appears in theUnclaimed filter set.

Results

When an alert is created at the enterprise level, you will see the Asset Name and Asset ID in the ALERTINFORMATION section of the Alert Details page. When an alert is created at the site level, you will seethe Asset Name, Enterprise Name, and Asset ID in the ALERT INFORMATION section. When an alert iscreated at the segment level, you will see the Asset Name, Site Name, and Asset ID in the ALERTINFORMATION section.

Create Custom Filters for AlertsYou can create custom filters for alerts that have specific requirements.

About This Task

The default filter sets for alerts appear in the module navigation menu. By default, alerts are displayed inthe alerts page based on the first filter set.

The filter sets allow you to view specific set of alerts by narrowing the entries. You can use the auto-refresh settings to display the newly added alerts. You can set the frequently used filters as favorites.


When a new alert is added, the auto-refresh setting considers the existing filters and assigns the alert tothe correct queue.

Procedure


2. Select , and then select More Filters.The Filter Alerts window appears.

3. Select New Filter Set.

4. In the Type Filter Set Name box, enter a unique name for the new filter set, and then select Save.

Note: Filter names should be unique even though GE Digital APM allows you to save multiple filtersusing the same name.

5. Select Add Filter, and then select one or more of the following filter options.

You can apply any combination of these filters to the entries or save them as a filter set.

Table 4: Filters Options

Filter Options Action to be Performed

Status Select one of the following statuses from the drop-down listbox:

• Ready• In Process• Processed• In Process Escalated• In Process Maintenance

Is Claimed Select one of the following options from the drop-down listbox:

• TrueDisplays all the claimed alerts.

• FalseDisplays all the unclaimed alerts.

Dispositioned Select either is equal to or is not equal to, and then selectan option from the drop-down list box. (None is the defaultvalue).

Note: The custom entries for Disposition that are created inthe Alert Configuration section of the Tenant Preferencespage are available in the Dispositioned drop-down list box ofthe Filter Alerts window.

Owner/User Name Enter the name of a user or owner in the contains or is notequal box, and then enter string in the box.

Severity Select one of the following options from the drop-down listbox, and then enter a severity in the drop-down combo box:

• is equal to• is not equal to• is greater than• is greater or equal to• is less than• is less than or equal to

Source Select either is equal to or is not equal to, and then selectan option from the drop-down list box. (None is the defaultvalue).


Filter Options Action to be Performed

Alarm Type Select either is equal to or is not equal to, and then selectan option from the drop-down list box.

Alarm Name Enter the name of an alert in the contains box.

Notes Enter the text in the contains box.

Event time Select one of the following options:

• Last 24 Hours• Last 7 Days• Last 30 Days• Last 3 Months• Last 6 Months• Last 12 Months• Custom Range

When Custom Range option is selected, the text box isenabled, and you can enter the time range.

Alert Received Time Select one of the following options:

• Last 24 Hours• Last 7 Days• Last 30 Days• Last 3 Months• Last 6 Months• Last 12 Months• Custom Range

When Custom Range option is selected, the text box isenabled and you enter the time range.

Is Consumable Select one of the following options from the drop-down listbox:

• TrueDisplays all the claimed alerts.

• FalseDisplays all the unclaimed alerts.

The selections appear in the Filter Alerts window.

Note: You can remove a filter from the Filter Alerts window by selecting .6. Select Save, and then select Apply.

Results

The custom filter is created and is available in the list of filter sets in the drop-down list that appears on

selecting .

Apply Filters to AlertsYou can apply default or custom filter sets to Alerts.

About This Task

You can use filter sets to narrow queue entries into a manageable set. In addition, you can manage queueauto-refresh settings to control the appearance of new alerts, and designate frequently-used filters asfavorites for quick application to the queue. Auto-refresh takes existing filters into account when addingnew alerts, assigning them to the correct queue.


Note: The filters applied to the alerts inbox or grid is persistent even if you navigate out of alerts,therefore not requiring you to select the filter attributes again until you log out of the application. This isvalid for a given user session.

Procedure


2. Select , and then select a filter set, such as My Alerts or Unclaimed.The filter is applied to the alerts inbox or alerts grid.

• To apply a new filter from the Filter Alerts window without saving it as a new filter set, selectMore Filters, make your filter selections, and then select Apply.

• To add a custom filter set to the module navigation menu as your favorite:

a. Select More Filters to access the Filter Alerts window.b. Hover over a filter set name in the list.

c. Select next to the filter name.

• To remove a favorite filter from the module navigation menu, select .• To modify an existing filter with new filter options:

a. In the module navigation menu, go to Alerts.

b. Select , and then select More Filters.c. In the Filter Alerts window, select the name of the filter that you want to modify.d. Add, remove, or modify the filter options.e. Select Save.

• To delete an existing filter:

a. In the module navigation menu, go to Alerts.

b. Select , and then select More Filters.

c. In the Filter Alerts window, for the filter that you want to delete.d. Select Save.

About Recurring AlertsYou can create a reminder or recurring alerts for assets or tags that don't have any analytics running togenerate alerts.

You can use the recurring alerts to review the current state of these assets for the given tags. Thereminder criteria is time-based and shows the interval in minutes, as well as the event start time andevent end time.

• Event start time – begins from the present time onwards.• Event end time – is any date and time in the future.

You can create and schedule a recurring alert, cancel a scheduled recurring alert, and view recurring alerts

in the alerts inbox and grid. An alert with indicates that it is a recurring alert.

Access a Recurring Alert

You can view recurring alerts in the Scheduled Alert Settings page.

Before You BeginYou must have permissions to view alerts.


Procedure

1. In the module navigation menu, go to AlertsV1.

2. Select an alert inbox filter set.

3. Select .The Scheduled Alert Settings page appears, displaying a list of recurring alerts.

Create a Recurring Alert

You can create a recurring alert in both the alerts inbox and alerts grid.

Before You Begin

You must have Manage Alerts permission to create a recurring alert.

About This Task

Note:

• You can create a recurring alert for an asset that belongs to the same tenant.• You cannot create more than 2000 alerts in a series of recurring alert.

You can create a recurring alert in one of the following ways:

• From the Create an Alert window.• From the Recurring Alerts page.

Procedure

• To create a recurring alert from the Create an Alert window:

1. In the module navigation menu, go to AlertsV1.2. Select an alert inbox filter set.

3. Select .The Create an Alert window appears.

4. Enter values in the ASSET ID and ALERT TEMPLATE boxes.5. In the RECURRENCE section, select Recurring Alert.6. In the INTERVAL TIME box, enter the interval in which the recurring alert must be generated.

Note:

◦ You must enter the interval in minutes.◦ You cannot create more than 2000 alerts in a series of recurring alert.

7. Enter a start date and time if you want to start the recurring alert later than the default date andtime.

The default value is the current date and time.8. Enter an end date and time for the recurring alert.

The default value is the current date and time. You must enter a date and time later than thedefault date and time. Otherwise, the alert creation will fail.

9. Select Create.

Note: The Create button is inactive until all values are entered.

A confirmation message appears.• To add a recurring alert from the Recurring Alerts page:

1. In the module navigation menu, go to AlertsV1.


2. Select an alert inbox filter set.

3. Select .The Scheduled Alert Settings page appears.

4. Select .The Create an Alert window appears.

5. Enter values in the ASSET ID and ALERT TEMPLATE boxes.6. In the RECURRENCE section, select Recurring Alert.7. In the INTERVAL TIME box, enter the interval in which the recurring alert must be generated.

Note:

◦ You must enter the interval in minutes.◦ You cannot create more than 2000 alerts in a series of recurring alert.

8. Enter a start date and time if you want to start the recurring alert later than the default date andtime.

The default value is the current date and time.9. Enter an end date and time for the recurring alert.

The default value is the current date and time. You must enter a date and time later than thedefault date and time. Otherwise, the alert creation will fail.

10. Select Create.

Results

A message appears, confirming that the recurring alert has been successfully scheduled. The newrecurring alert is then added to the Scheduled Alert Settings page.

Create a Case from an AlertTo initiate and track the process used to address an issue identified in an alert, you can create a case fromthe corresponding details page of the alert.

Before You Begin

You must have Alerts permissions and Cases permissions to create a case from an alert.

Note: You can create a case for an alert that belongs to the same tenant.

About This Task

Note: When you create a case from an alert and if the EVIDENCE section of the alert contains an analysischart, the same analysis chart will be available in the EVIDENCE section of the case.

You can create a case from an alert by providing an Asset ID at any level (enterprise, site, segment, orasset).

Procedure


2. Select , and then select My Alerts.A pane that contains a list of alerts assigned to you appears.

3. Select the alert for which you want to create a case.The details page of the alert appears.

4. Select Create Case.The Create Case window appears.


5. In the Template drop-down list box, select a template.

Note: If the alert template used for the claimed alert has no case template mapped to it, then theTemplate list is not available, and the Template box will display the value None.

6. In the Title box, enter a case name.7. In the Severity drop-down list box, select a value.8. In the Symptoms box, enter a description, and then select Save.

Note: By default, the case title and severity match the alert name and severity. You can modify thecase title and severity.

Results

A case with the selected name and severity appears in the LINKED CASES section of the alert. The casethen becomes available in the Cases module.

If you create multiple cases for a single alert, the Case Number in the Case Information section isincremented by one for each additional case.

Access a Case from an Alert

About This Task

When you create a case from an alert, the case is generated in the Cases module, and a link to the caseappears in the LINKED CASES section in the details section or page of an alert.

Procedure


2. Select , and then select the alert filter set that contains the alert for which a case is created.A pane that contains a list of alerts appears.

3. Select the alert.The details page of the alert appears.

4. In the LINKED CASES section, select the linked case that you want to view.

The Limited Visibility cases will be available in the LINKED CASES section only if you have the ViewLimited Visibility Cases permission. Otherwise, only the General Visibility Cases will be available in theLINKED CASES section of the alert.

The case details of the selected case open in a new web browser tab.

Link or Unlink a Case to an Alert

About This Task

You can link cases to an alert as evidence. To link cases to an alert, you must either have the Edit AlertDetail permission or Alerts permission. You can select a case from a list related to the current asset orsearch all cases and filter them based on the following attributes:

• Case Name• Case ID• Asset ID• Status

Linked alerts are listed in the EVIDENCE section with the most recent entry first.

Note: You cannot link cases to an alert that belongs to a different tenant.


Procedure

1. To link cases to an alert, perform the following steps:

a) In the module navigation menu, go to Alerts.

b) Select , and then select the alerts filter set and then select the alert for which you want to linkcases.A pane containing a list of alerts appears.

c) Select the alert.A section containing the details of the alert appears.

d) In the LINKED CASES section, select .The Select Cases To Link window appears, displaying a list of cases.

Note: You can search for a case in the list by entering the case name, case ID, asset ID, and statusin the corresponding boxes, and then selecting Search.

e) Select one or more cases from the list, and then select Link.The linked cases appear in the LINKED CASES section of the case.

2. To unlink a case from an alert, in the LINKED CASES section, for the alert that you want to unlink froma case, select Unlink.The case is unlinked from the alert.

Mark an Alert as Processed

About This Task

You can mark a claimed, In Process alert as Processed to indicate that the alert no longer needs attention.Once an alert has been processed, it appears in the queue as Processed.

Note: You can mark an alert as processed if the alert belongs to the same tenant.

Procedure


2. Select , and then select My Alerts to access alerts claimed by you.A pane that contains a list of alerts appears.

3. Select an In Process alert claimed by you.4. Select , and then select Mark as Processed.

A message appears, indicating that the alert has been marked as processed.

Note: The alert is removed from the My Alerts queue. To find the processed alert, select MoreFilters, and search by Status.

Reopen a Processed AlertAfter an alert has been processed, you cannot change its disposition state.

About This Task

After you reopen a processed alert, you can then use the same workflow as a new alert. The alert retainsits previous case links and associated disposition state values. You can then create a case, or close thealert.


Procedure


2. Select , and then select More Filters.The Filter Alerts window appears.

3. In the Add Filters drop-down list box, select Status.

4. In the drop-down list box, select Processed, and then select Apply.A list of processed alerts appears.

5. Select a processed alert.The details section of the alert appears.

6. Select Reopen.The state of the alert changes from Processed to In Process, and reappears in the My Alerts queue.

As needed, perform the following:

• To modify the disposition, In the Disposition drop-down list box, select a value. Changing thedisposition for an alert allows you to define the reason for the alert.

• To create a case for the reopened alert, select Create Case. In the event of a valid alert disposition,you may need to create a case to resolve the issue

Access Asset Faceplate from an AlertThe Asset Faceplate contains information about a selected asset, including equipment information, assetattributes, and associated tags.

About This Task

The Asset Faceplate is located in Assets, but you can view it in Alerts.

Procedure


2. Select , and then select the alert filter set.A pane that contains a list of alerts appears.

3. Select the alert.The details page of the alert appears, displaying the hierarchy of the asset in the ASSET field of theALERT INFORMATION section.

4. In the ASSET field, select the name of the asset.The Asset Faceplate appears in a new tab.

Tip: You can view the details of the Enterprise, Site, or Segment associated with the asset by selectingthe name of the Enterprise, Site, or Segment in the ASSET field.

View Asset Criticality for AlertsYou can view Asset Criticality for alerts in the Alerts Details page.

About This Task


Procedure



2. In the Alerts Details page, select the criticality number in the ALERT INFORMATION section todisplay the details of the criticality level in the Asset Criticality Analysis page in GE Digital APM.


Chapter

5Alert IngestionTopics:

• About Alert Ingestion• Ingest Alerts• Alert Ingestion HTTP Status

Codes


About Alert IngestionAlert ingestion requires that you create an alert profile and ingest one or more assets before you ingestalerts into GE Digital APM.

Ingest AlertsYou must first create at least one alert profile and ingest one or more assets before you ingest alerts intoGE Digital APM.

Before You Begin

Before ingesting alerts, you need the following information:

• Ingestion payload for alerts in JSON format.• OAuth token to ingest alerts.

Important: Make sure you have a valid unexpired token. Tokens are client-specific and usually expirewithin a set time.

• From the Setup section, obtain the following information:

◦ Client ID◦ Alert ingestion URL◦ Username

• Ingestion password that was created during initial tenant setup.• Access to a REST client such as Postman or Advanced REST client.

About This Task

You can use the alerts REST service endpoint to perform bulk alert ingestion from your source system.

Procedure

1. Open your REST client.2. Enter the ingestion URL in the HOST value field.

Note: You can obtain this from the Tenant Setup section – Alerts ingestion URL by logging in as atenant admin. For example, https://apm-gateway-svc-preprod.preprod-apm-api.predix.com/v1/jobs

3. Select the POST method.4. In Headers, add the following parameters (key-value pairs).


https://apm-gateway-svc-preprod.preprod-apm-api.predix.com/v1/jobs

Table 5: Asset Ingestion Service Headers

Parameter Description

Authorization Enter the token_type followed by a space, then the access_token from theresponse you previously obtained. For example, bearereyJhbGciOiJSUzI1NiJ9.A... The following code sampleincludes a bearer token:

{ "access_token": "eyJhbGciOiJSUzI1NiJ9.A...", "token_type": "bearer", "refresh_token": "eyJhbGciOiJSUzI1NiJ9.e..", "expires_in": 86399, "scope": "openid", "jti": "5e2c90ea-9edd-4da1-80c8-4a0d67f77ef3"}

tenant The unique ID for the tenant (for example,07F28C049E0F4F29B8E85E4A6C916D7F)

5. Select application/json as Content-Type .

6. Paste the JSON payload into the request body.Sample JSON payload:

{ "taskList" : [ { "taskId" : "smartSignalTask", "type" : "createAlarm", "body" : { "name" : "alert-Length-70A701E8F0594532AB102F2A6FE0BAD7", "associatedMonitoredEntitySourceKey" : "Inverter1-ASSET-TYPE1", "eventStart" : 1446632335938, "storageReceiveTime" : 1446632335938, "severity" : 3, "incident" : { "incidentEventCount" : "125", "firstOccurance" : "2015-08-11T19:07", "lastOccurance" : "2015-08-19T15:47" }, "scanGroupData" : { "BRG_1_VIB_2_1X_AMP" : "53.95484042", "BRG_1_VIB_1_OVERALL" : "62.4367112", "BRG_1_VIB_2_OVERALL" : "57.80885233", "BRG_1_VIB_2_1X_PHASE" : "305.013721", "BRG_1_VIB_1_1X_AMP" : "59.19077386" }, "tagsOfInterest" : [ { "uuid" : "e6d65833-028f-4d0f-b0cc-8334bdcf2d53", "isContributing" : false, "displayGrouped" : true, "displayGroupedName" : "DRIVER_LOAD", "uom" : "KLB/HR" }, { "uuid" : "8288f357-4ab2-4e99-ab14-c0717b27fe5b", "isContributing" : false, "displayGrouped" : true,


"displayGroupedName" : "PUMP_SPEED", "uom" : "rpm" }, { "uuid" : "34e1c35b-97f2-4668-9428-bdd5ea663137", "isContributing" : false, "displayGrouped" : true, "displayGroupedName" : "LUBE_OIL_TEMP", "uom" : "Celsius" } ], "alarmState" : { "name" : "Resolved" }, "alarmDisposition" : { "name" : "None" }, "sourceKey" : "AlarmSourceKey", "notes" : [ { "text" : "This is my first note", "userOwnerSourceKey" : "test002_mdmgr" }, { "text" : "This is my second note", "userOwnerSourceKey" : "test002_mdmgr" } ], "attachments" : [ { "name" : "test_bulk_attachments.txt", "blobBase64Encoded" : "YnVsayAgaW5nZXN0aW9uIHRlc3QK", "userOwnerSourceKey" : "test002_mdmgr" } ] }, "links" : [ ] } ]}

Results

On successful acceptance, you receive a 202 Accepted in the JSON response. Note that the ingestionoccurs asynchronously, which means that your request is queued for the server to process it. Check theingestion progress through HTTP GET to verify ingestion success. Save the uuid from the JSON responsefor tracking purposes.

Example

HTTP/1.1 202 AcceptedContent-Type: application/jsonContent-Length: 158

{ "uuid" : "8C3D72213EC44D7697A8C465F858F59E", "links" : [ { "rel" : "status", "href" : "/v1/jobs/8C3D72213EC44D7697A8C465F858F59E/status" } ]}


Next Steps

Use a GET method to track the ingestion progress:

1. In the REST client, select the GET method.2. In the Host value field, enter the following:

https://apm-event-ingestor-alerts-svc-preprod.run.asv-pr.ice.predix.io/v1/jobs/8C3D72213EC44D7697A8C465F858F59E/statusNote:

This should be the Alerts ingestion URL obtained from the Setup page appended to /<UUID>/status. For example, if the following is the response from your alert ingestion:

{

"uuid" : "8C3D72213EC44D7697A8C465F858F59E", "links" : [ { "rel" : "status", "href" : "/v1/jobs/8C3D72213EC44D7697A8C465F858F59E/status" }]}

then the URL to make a GET call to track the ingestion progress would be: https://apm-gateway-svc-preprod.preprod-apm-api.predix.com/v1/jobs/8C3D72213EC44D7697A8C465F858F59E/status

3. Append the URL, with the uuid value that you obtained in the JSON response from the earlier POSTmethod. It should look similar to the example above.

4. In the Header field, enter the Authorization token and tenant_uuid.5. Select Send.

You should receive a sample response as shown below:

HTTP/1.1 200 OKContent-Type: application/jsonContent-Length: 155

{ "id" : 5061, "uuid" : "8C3D72213EC44D7697A8C465F858F59E", "taskStatusList" : [ { "status" : "PENDING", "taskId" : "smartSignalTask" } ]}

Alert Ingestion HTTP Status CodesHaving the HTTP Status Codes available can help you understand ingestion issues that may arise.

The following are the possible HTTP status codes for alert ingestion. The codes help you find possibleingestion issues.


https://apm-gateway-svc-preprod.preprod-apm-api.predix.com/v1/jobs/8C3D72213EC44D7697A8C465F858F59E/status

https://apm-gateway-svc-preprod.preprod-apm-api.predix.com/v1/jobs/8C3D72213EC44D7697A8C465F858F59E/status

Table 6: HTTP Status Codes

Status Code Meaning

200 OK The request completed successfully without errors.

202 Accepted A new resource has been created successfully. Check the Location header in the response to

get information on the resource URI.

204 No Content An update to an existing resource has been applied successfully.

400 Bad Request The request was not formatted appropriately. Review the response body for additional information

on the type of error that occurred. For example, the request may contain invalid query syntax or

operators.

401 Unauthorized The request has failed authentication as the provided credentials are either invalid or were not

provided. This could also happen when the token has expired.

404 Not Found The requested resource could not be found. It could mean that your request was not created on the

server side..


Chapter

6Alerts Data ExtractionTopics:

• Overview• Extract Alerts Data• OData Metadata• Examples of OData Operations• Data Aggregation


OverviewOData is a REST standard for creating data centric APIs and is used to share the data through HTTP in asecured manner. BI tools support OData through inbuilt adapters or connectors and use the extractedAlerts data for reporting purpose.

Extract Alerts Data

Before You Begin

• You must have the OData Extract-Alerts permission to extract the Alerts data.• You must obtain the authorization bearer token for a tenant.

Note: You must use the User ID and password instead of the Client ID and password.

Access the OData service to extract data in any supported BI tool using their inbuilt adapters.

Filter Alerts based on the Asset Permissions

The extracted Alerts returned by the OData service is filtered based on the asset permissions of thelogged in user. This filtering capability allows you to filter the Alerts, to list only the assets to which youhave access.

Filter Alerts based on Limited Visibility Permissions

The extracted Alerts returned by the OData service is filtered based on the asset permissions of thelogged in user. This filtering capability allows you to filter and view Alerts, with respect to your LimitedVisibility permission in the GE Digital APM dashboard. You will not be able to access all the Alerts for aparticular asset, without the Limited Visibility permission.

Cross-tenant Support

The OData microservice supports cross-tenant queries. Users who have permissions in more than onetenant can query for Alerts across tenants. This support allows you to consolidate the total Alerts countand the query results returned by the OData service.

Note: Ordering data is not supported in a cross-tenant query. As a result, any order by clause in a querywill be applied per tenant and the tenant results are concatenated.

OData MetadataTo get all the metadata including entities, properties, and relationships, use the link:

https://apm-odata-alerts-cases<domain prefix>.int-app.aws-usw02-pr.predix.io/Alerts.svc/$metadata.


Examples of OData OperationsOperations Example

To extract 1000 Alerts from the top of the list https://apm-odata-alerts-cases<domain prefix>.int-app.aws-usw02-pr.predix.io/Alerts.svc/Alerts?$top=1000

To extract the Alerts which were created or updated in themonth of September 2017

https://apm-odata-alerts-cases<domain prefix>.int-app.aws-usw02-pr.predix.io/Alerts.svc/Alerts?$filter=UpdatedDate gt 2017-09-01T00:00:00.000Z andUpdatedDate lt 2017-10-01T00:00:00.000Z

To extract the Alerts based on the Alert Name or Alert ID https://apm-odata-alerts-cases<domain prefix>.int-app.aws-usw02-pr.predix.io/Alerts.svc/Alerts?$select=AlertId,Id,Name

To expose the density details for an Alert • https://apm-odata-alerts-cases<domainprefix>.intapp.aws-usw02-pr.predix.io/Alerts.svc/Densities?$top=1

• https://apm-odata-alerts-cases<domainprefix>.intapp.aws-usw02-pr.predix.io/Alerts.svc/Alerts?$top=1&$expand=Density

Data Aggregation

Supported Functions

Grouping and Aggregation

The OData microservice supports the grouping and aggregation functionality (e.g. sum, avg, min, and max)on the properties of the associated entities.

The following query example provides the number of Alerts aggregated by the name of the sites.

GET {{host}}/Alerts.svc/Alerts?$apply=groupby((Asset/SiteName),aggregate(Id with countdistinct as AlertCount))

{ "@odata.context": "https://apm-odata-alerts-cases-svc-rc.int-app.aws-usw02-pr.predix.io/Alerts.svc/$metadata#Alerts(Asset(SiteName),AlertCount)", "value": [ { "@odata.id": null, "AlertCount": 4, "Asset": { "@odata.id": null, "SiteName": "AK-Site" } }, { "@odata.id": null, "AlertCount": 21, "Asset": { "@odata.id": null, "SiteName": "AllFault_VSG_Testa_Q2" }


}, { "@odata.id": null, "AlertCount": 39, "Asset": { "@odata.id": null, "SiteName": "ASCIITESTCategory139_Level2" } }]}

Note:

• If you have permissions on multiple tenants, the response will contain one entry per tenant, and couldresult in repeated entries for the grouped property:GET {{host}}/Alerts.svc/Alerts?$apply=groupby((Severity),aggregate(Idwith countdistinct as AlertCount))

{ "@odata.context": "$metadata#Alerts(Severity,Result)", "value": [ { "@odata.id": null, "Severity": 1, "Result": 308683 }, { "@odata.id": null, "Severity": 2, "Result": 38792 }, { "@odata.id": null, "Severity": 3, "Result": 163438 }, { "@odata.id": null, "Severity": 1, "Result": 11879 }, { "@odata.id": null, "Severity": 2, "Result": 409 } ]}

• To display the Tenant Id of the record, you must include the TenantId property in the groupby function:GET {{host}}/Alerts.svc/Alerts?$apply=groupby((Severity,TenantId),aggregate(Id with countdistinct asAlertCount))

{ "@odata.context": "{{host}}/Alerts.svc/$metadata#Alerts(Severity,TenantId,AlertCount)", "value": [ {


"@odata.id": null, "Severity": 1, "TenantId": "a49d0312-cc4b-47c6-817d-4fdabcf56544", "AlertCount": 308683 }, { "@odata.id": null, "Severity": 2, "TenantId": "a49d0312-cc4b-47c6-817d-4fdabcf56544", "AlertCount": 38792 }, { "@odata.id": null, "Severity": 3, "TenantId": "a49d0312-cc4b-47c6-817d-4fdabcf56544", "AlertCount": 163438 }, { "@odata.id": null, "Severity": 1, "TenantId": "8d663b3d-faf9-43d8-9aa1-62ac70f7a3eb", "AlertCount": 11879 }, { "@odata.id": null, "Severity": 2, "TenantId": "8d663b3d-faf9-43d8-9aa1-62ac70f7a3eb", "AlertCount": 409 } ]}

Numeric Aggregations Support

The OData microservice supports the numeric aggregation methods using ?$apply=aggregate(<PropertyName> with <method> as <alias>)The following aggregation methods are supported:

• sum - Provides the total of all the values for the specified property.• average - Provides the average value of all the values for the specified property.• min - Provided the smallest value of all the values for the specified property.• max - Provides the largest of all the values for the specified property.

{{host}}/Alerts.svc/Alerts?$apply=aggregate(Severity with average asAvgSeverity)

{ "@odata.context": "$metadata#Alerts(AvgSeverity)", "value": [ { "@odata.id": null, "AvgSeverity": 1.7697726851152447 } ]}


Note: If you have permissions on multiple tenants, the response will contain one entry per tenant.{{host}}/Alerts.svc/Alerts?$apply=aggregate(Severity with average asAvgSeverity)

{ "@odata.context": "$metadata#Alerts(AvgSeverity)", "value": [ { "@odata.id": null, "AvgSeverity": 1.7697726851152447 }, { "@odata.id": null, "AvgSeverity": 1.1111111111111112 } ]}

Basic Aggregations with User Permission Filters

You must apply the same user permission on aggregated data that is applied to the standard ODataqueries.

User permissions are the sets in GE Digital APM which restrict the view that users can have to a specificAsset Hierarchy. The standard OData queries filter data using these permissions.

Filter Aggregations

You can filter aggregations based on the filter parameters specified in an aggregate query. You can add afilter syntax to the aggregate query to limit the values used in an aggregation.

The following query example provides the number of Alerts created for each asset that is associated withan enterprise.

{{host}}/Alerts.svc/Alerts?$apply=filter(Asset/EnterpriseName eq 'E2EEDISON ENTERPRISE')/groupby((AssetName),aggregate(AlertId withcountdistinct as CNT_ALERTID))

{ "@odata.context": "https://odata-latest.run.aws-usw02-pr.ice.predix.io/Alerts.svc/$metadata#Alerts(AssetName,CNT_ALERTID)", "value": [ { "@odata.id": null, "AssetName": "APS Small Gen Segment #1", "CNT_ALERTID": 8 }, { "@odata.id": null, "AssetName": "Array #1 ASSET TYPE 2", "CNT_ALERTID": 20514 }, { "@odata.id": null, "AssetName": "TS Asset Type1", "CNT_ALERTID": 174 }, { "@odata.id": null,


"AssetName": "TS Asset V2 Type1", "CNT_ALERTID": 2262 } ]}

COUNT (DISTINCT) Support

The Count Distinct operation allows you to obtain a distinct count on any property of an entity. The countaggregation function can be used on the primary key. The OData microservice supports the COUNTDISTINCT function in the queries, using ?$apply=aggregate(<PropertyName> withcountdistinct as <alias>)GET {{host}}/Alerts.svc/Alerts?$apply=aggregate(AssetId withcountdistinct as Assets)

{ "@odata.context": "$metadata#Alerts(Assets)", "value": [ { "@odata.id": null, "Assets": 25 } ]}

Note: If you have permissions on multiple tenants, the response will contain one entry per tenant. GET{{host}}/Alerts.svc/Alerts?$apply=aggregate(AssetId with countdistinct asAssets)

{ "@odata.context": "$metadata#Alerts(Assets)", "value": [ { "@odata.id": null, "Assets": 25 }, { "@odata.id": null, "Assets": 15 } ]}


Chapter

7Release NotesTopics:

• Third Quarter of 2020


Third Quarter of 2020

Release Date: September 25, 2020This topic provides a list of product changes released for this module on this date.

Table 7: Enhancements and New Features

The following enhancements and new features have been added.

Description Tracking ID

The user interface of the Alerts module has been enhanced with a new look and feel to manage

the alerts lifecycle more efficiently. The following list provides some of the key capabilities offered

by the enhanced user interface:

• Enhanced Grid View: Provides a new interactive layout with better information

accessibility. The new layout enables you to drag the columns to reorder them and freeze the

grid columns. Additionally, you can now group more than three columns at a time and view

the alert count for each group and sub-group.

• Enhanced Filter Alerts Window: Provides a new layout of the Filter Alerts window to

improve the usability when creating and modifying the custom filters, the layout of the FilterAlerts window has been enhanced.

• Enhanced Alert Details Page: Provides an improved layout for the Alert Details page with

easy navigability to different sections of the page through a shortcut menu. You can now

access all levels of hierarchy for the asset associated with the alert.

• Link to Event Frame Analysis View: Provides access to the Event Frame Analysis View for

SmartSignal alerts from the Alert Details page.

• New Bulk Edit Pane: Improves productivity by combining multiple bulk actions that can be

performed together on a group of alerts.

Note: The previous version of the Alerts module is still available in GE Digital APM as AlertsV1 for

a seamless transition to the latest version and to minimize operational risks.

F50916


Documents

Alerts - GE.com | Building a world that works | General ...€¦ · 26/06/2020 · Alert Ingestion HTTP Status Codes 47 Chapter 5: Alerts Data Extraction 49 Overview 50 Extract Alerts