View
13
Download
0
Category
Preview:
Citation preview
Alert Templates
© 2020 General Electric Company
Contents
Chapter 1: Overview 1Overview of the Alert Templates Module 2
Chapter 2: Manage Alert Templates 3Create, Configure, or Delete an Alert Template 4
Sort and Filter Columns in the Alert Template Grid 8
Show or Hide Columns in Alert Templates 9
Add and Remove Analysis Views in an Alert Template 9
Change Alert Templates 10
Add and Remove External Links in an Alert Template 10
Add and Remove Case Templates in an Alert Template 11
Chapter 3: Alert Templates Ingestion 12About Alert Template Ingestion 13
Add an Alert Template Source 13
Ingest Alert Templates 14
Chapter 4: Release Notes 17Fourth Quarter of 2020 18
Second Quarter of 2020 18
Second Quarter of 2018 18
First Quarter of 2018 19
ii Alert Templates
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 AlertTemplates Module
© 2020 General Electric Company 1
Overview of the Alert Templates ModuleWhen you create and deploy an analytic, you can use free-form text to associate the analytic with one ormore alert templates.
Multiple analytics can be associated with a single alert template. When an analytic triggers an alert, thesystem checks for associated alert templates, which it uses to route alerts to the correct inbox. You canuse alert templates to facilitate the ingestion of alerts into GE Digital APM.
When you create an analysis view, it is associated with an asset or an asset class. These new views can beadded to an alert template. This allows you to customize alert analysis views for specific alert types.
Alert templates connect and automate alerts received from sensors by providing the followinginformation:
• Assigned data severity.• One or more assigned analysis views.• Analytic source.• Alert issue type.
Tip: You need specific permissions to complete these tasks. For more information on the permission sets,refer to the Users and Permissions documentation.
The following definitions are helpful when selecting options for an alert template:
ConsumableToggle for allowing alerts to appear in the alert inbox. Default is on.
TripToggle for designating associated alerts as trip alerts that require immediate action. Default is off.
SeverityThe importance assigned to an alert when triggered by a predictive analytic.
TypeThe type of alert being used, such as vibration or combustion.
SourceThe pool of predictive analytics used to display anomalous data received from asset sensors.
ActiveToggle to indicate that the template is active. Alerts can be ingested by an analytic or createdmanually only when the alert template is active.
External LinksA way to add external links to an alert template so they can be viewed in a new page from anassociated alert.
Case TemplatesA way to associate a case template with an alert template.
Analysis View (Templates)Rules associated with building views for an alert.
2 © 2020 General Electric Company
Chapter
2Manage Alert TemplatesTopics:
• Create, Configure, or Delete anAlert Template
• Sort and Filter Columns in theAlert Template Grid
• Show or Hide Columns in AlertTemplates
• Add and Remove AnalysisViews in an Alert Template
• Change Alert Templates• Add and Remove External Links
in an Alert Template• Add and Remove Case
Templates in an Alert Template
© 2020 General Electric Company 3
Create, Configure, or Delete an Alert TemplateYou can create new alert templates, modify existing templates, or delete templates that are no longer inuse.
Before You Begin
When creating a new alert template, ensure that the alert template does not already exist by searching orscrolling through the available alert templates.
About This Task
You can configure an existing alert template, or create a new one. Changes to an alert template affect allalerts associated with the template.
Procedure
• To create an alert template:
1. In the module navigation menu, go to Alert Templates.A page appears in a new tab, listing the alert templates.
2. Select .3. In the same row as the Cancel and Save buttons, in the box, enter a unique name for the template.4. In the Alert Content section, as needed, enter values in the available fields to create a unique
template.
Field To Do
Severity Select a severity from 1-5 to associate with the applicabletriggered alerts.
Type Select an alert type for the analytic to associate withapplicable alerts.
Source Select an analytic Source to associate with applicablealerts.
Note: You can select manual from the source list whencreating a new alert template. This allows you to createalerts that don't come from a typical source.
Description In the Description box, enter a description for the alerttemplate.
4 © 2020 General Electric Company
Field To Do
Analysis Templates To add an analysis template:
a. In the Analysis Template section, select .The Add Templates window appears.
b. Select either Class Level Template or Instance LevelTemplate tab, and then select Add corresponding tothe analysis template that you want to add.
c. Select Done.The template is added and the Pre-Event Time, Post-Event Time, and Data Resolution columns areautomatically populated.
Tip: To change the Pre-Event Time, Post-Event Time,and Data Resolution, select the arrow next to the entryin the column, and then select one of the followingvalues from the drop-down list.
Note:
◦ If the Pre-Event and Post-Event times total 30days, then the only option available in the DataResolution column is 10 minutes. If the Pre-Eventand Post-Event times total 14 days or less, thenthe options available in the Data Resolutioncolumn are 5 or 10 minutes. If the Pre-Event andPost-Event times total 7 days or less, then theoptions available in the Data Resolution columnare 1, 5, or 10 minutes. If the Pre-Event and Post-Event times total 1 day or less, then the optionsavailable in the Data Resolution column are 10seconds, 1, 5 or 10 minutes. If the Pre-Event andPost-Event times total 1 hour or less, then alloptions are available in the Data Resolutioncolumn.
◦ Pre-Event and Post-Event time values cannot bothbe zero (0). If the Pre-Event time is zero, then thePost-Event time is anything but zero. For example,if you select 4 as the Pre-Event time and 0 as thePost-Event time, and then change the Pre-Eventtime to 0, the Post-Event time is automaticallychanged to the default value.
If you want to show data up to the present time, selectthe check box in the Show Up To Present column. ThePost-Event Time and Data Resolution columns arecleared and the Show Up to Present check box isselected. After you clear the Show Up to Presentcheck box, the Post-Event Time and Data Resolutioncolumns will display the default values.
Note: You can associate multiple analysis views with thealert template.
To remove a selected analysis from the alert template,
select to the right of the named view.
© 2020 General Electric Company 5
Field To Do
Internal Links You can add internal links to navigate to GE Digital APMAnalysis or O&G Analysis.
a. Select for Internal Links.b. In the Add/Remove Internal Links window, select one
of the following options, and then select Add.
◦ Go to GE Digital APM Analysis◦ Go to O&G Analysis◦ Link to GE Digital APM Analysis
Note: You can repeat this step to add another link.c. Select Done.
The selected links appear in the Internal Links sectionof the template.
To remove an internal link, do one of the following:
◦ In the Add/Remove Internal Links window, selectRemove for the link you want to remove, and thenselect Done. The link is removed from the InternalLinks section of the template.
◦ In the Internal Links section of the template, hoverover the link you want to remove.
An appears at the end of the row.
Select the The link is removed from the Internal Links section.
Note: You can edit the Internal Links title for the section torename it. Select Internal Links and then enter the newtitle. There is a 100 character limit when renaming InternalLinks.
5. Select the Configuration tab.The Configuration section appears.
6. As needed, enter values in the available fields.
Field Do this
Active After a template is created, it appears as active. While youare modifying the template or if you do not want to make itavailable to users, use the toggle button to switch it fromactive to inactive (grayed out).
Consumable If the alert template is not under construction, use thetoggle button to select Consumable. If the templateproperty is set to non-consumable, the alerts ingested forthose templates will be non-consumable. You can changethis property by changing the Consumable value in theAlert template. This change will apply to all alerts ingestedafter the change.
You can filter on the value of the Consumable property suchthat when you filter for non-consumable alerts, all non-consumable (Consumable property = false) alerts arereturned.
Trip Select the Trip toggle button to designate the tripassociation for alerts requiring immediate action.
6 © 2020 General Electric Company
Field Do this
External Links To add an external link:
a. In the External Links section, select .New Link appears in the Name column and Enter a URLappears in the URL column.
b. Select New Link, enter the name of the link in the box,and then select Enter.
Tip: To modify the name, select the Edit icon.
The name of the URL appears in the Name column.c. Select Enter a URL, and enter the url in the box, and
then select Enter.
Tip: To modify the name, select the Edit icon.
The URL appears in the URL column.
To remove an external link, hover over the row thatcontains the external link that you want to remove, and
then select .
The external link is removed from the template.
Case Templates To add a case template to the alert template:
a. In the Case Templates section, select .The Add Case Template window appears.
b. Select a case template, and then select Add.The template is added and appears in the CaseTemplates section.
To remove a case template from the alert template, hoverover the row that contains the case template that you want
to remove, and then select .
Associated Analytics You can associate analytics with an alert template, whichallows you to view the list of analytics associated with thealert template. This helps you know which source analytic istriggering the alerts and you can use this information to finetune the analytic when necessary. In the alert template, thelist of associated analytics displays the name, the versionand a description of the analytic. When you select the nameof the analytic, the analytic template details open in a newtab. You cannot modify the Associated Analytics section inthe template.
Note: When there are no analytics associated with thealert template, the message There are noanalytics associated with thisalert template appears.
7. Select Save.The new template is added to the alert templates list.
You can save an alert template, then add information later.• To modify the attributes of an existing alert template:
1. In the module navigation menu, go to Alert Templates.Alert Templates opens in a new tab.
2. Select the Search icon ( ) in the Alert Templates list to expose the Search field. Enter at leastthree characters and press ENTER to narrow the list.
Select Search again to clear the search and hide the Search field.
© 2020 General Electric Company 7
3. Select the specified template name.4. Modify the template details, then select Save.
• To delete a selected alert template:
1. In the module navigation menu, go to Alert Templates.A page appears in a new tab, listing the alert templates.
2. In the Name column, select the template that you want to modify.The template opens.
3. Select Delete Template.
The template is removed from the list.
Sort and Filter Columns in the Alert Template GridYou can sort and filter the list of templates using any column to retrieve the specific required templatematching the sorting order and filtering criteria.
Before You Begin
You must have permissions to access and modify templates.
Procedure
• To sort a column in the Alert Templates grid:
1. In the module navigation menu, go to Alert Templates.2. Select the heading of the column that you want to sort.
The data in the column is sorted either in the ascending or descending order. To reverse the order,select the column header again.
Note:
◦ Columns are sorted alphanumerically, first by symbols, then number, and then uppercase andlowercase letter.
◦ The columns remain sorted in the same order even when you access the details page of an alerttemplate, and then navigate back to the Alert Templates grid.
• To filter a column in the Alert Templates grid:
1. In the Filter text box below the column header, enter the term with which the column is filtered.
Note: As soon as you type three characters, the column begins to filter the entries. As you continueto type the characters, the column continues to filter the entries, narrowing down the results.
To find all entries with the Closed Status, enter Clo in the Filter text box for the Status column,and then press Enter.The column is filtered, showing all entries with status Closed.
Note:
◦ The filters applied to the columns in the Alert Templates grid are persistent even when youaccess the details page of an alert template, and then navigate back to the Alert Templates grid.
◦ Sorting of a column is not affected by the filtering criteria. For example, if you sort the grid bythe Name column, and then filter by Name and ID, the sort order will remain the same.
8 © 2020 General Electric Company
Show or Hide Columns in Alert TemplatesYou can show or hide one or more columns in an Alert Template.
Before You Begin
You must have permissions to access and modify the templates.
Procedure
• To show a column in the Alert Templates grid:
1. In the module navigation menu, go to Alert Templates.2. Select Hide/Show Columns, and then select the check box for each column names that you want
the grid to display.The selected columns appear in the grid. By default, all column names are selected.
• To hide a column in an Alert Template, select Hide/Show Columns, and then clear the check box foreach column name that you want the grid to hide.The selected columns do not appear in the grid.
Add and Remove Analysis Views in an Alert TemplateYou can add or remove one or more analysis view templates for a selected alert template, allowingmultiple view selections during analysis.
About This Task
Associations for an alert template are not enabled until you save them. Associated analysis views appearin the details page of the alert.
Note:
• SmartSignal alerts do not include this functionality.• You cannot save an Event Data Analysis template to an Alert Template.
Procedure
• To add an analysis view template to a selected alert template:
1. In the module navigation menu, go to Alert Templates.A page appears in a new tab, listing the alert templates.
2. Select the alert template to which you want to add an analysis view.3. In the Alert Templates section, select .
The Add Templates window appears.4. Select the required analysis view, and then select Add.
Tip: You can search for an analysis view by selecting Search, and then entering at least threecharacters to find the relevant analysis view.
The selected analysis view is added to the alert template.
• To remove an analysis view from an alert template, hover over the template name, and then select .
© 2020 General Electric Company 9
Change Alert Templates
About This Task
If a triggered alert does not match its given alert template type, you can change the alert templateassociated for the alert.
Procedure
1. In the module navigation menu, go to AlertsV1.2. Select the alert for which you want to change the alert template.
3. In the details page of the alert, select next to the alert name, and then select .The Change Alert Template window appears.
4. In the box, enter a value to populate a list of suggested alert templates from the same alert source.5. Select the alert template, and then select Save.
The alert name changes to the selected name, and all the attributes match the new template.
To validate your changes, select the alert name to view the description, which also displays the originalalert template name.
Add and Remove External Links in an Alert TemplateYou can add or remove external links from an alert template.
About This Task
Links added to an alert template appear in the Action list for the associated alerts.
Procedure
• To map an external link to an alert template:
1. In the module navigation menu, go to Alert Templates.A page appears in a new tab, listing the alert templates.
2. Select the alert template to which you want to add the external links.3. Select the Configuration tab.
4. In the External Links section, select .
5. Hover over New Link, and then select .6. In the Name box, enter a new name for the link.
7. Hover over Enter a URL, and then select .8. In the URL box, enter the URL for the link.
The link appears in the External Links section of the selected alert template. You can select thelink in the Action list for an associated alert.
• To remove an external link from an alert template, in the External Links section, hover over the
external link that you want to remove, and then select .
10 © 2020 General Electric Company
Add and Remove Case Templates in an Alert TemplateYou can add or remove a case template from an alert template.
Procedure
• To add a case template to an alert template:
1. In the module navigation menu, go to Alert Templates.A page appears in a new tab, listing the alert templates.
2. Select the alert template to which you want to add a case template.3. Select the Configuration tab.
4. In the Case Templates section, select .The Add Case Templates window appears.
5. Select the case template that you want to add, and then select Add.The selected case template appears in the Case Templates section.
• To remove a case template from an alert template, in the Case Templates section, hover over the
case template that you want to remove, and then select .
© 2020 General Electric Company 11
Chapter
3Alert Templates IngestionTopics:
• About Alert Template Ingestion• Add an Alert Template Source• Ingest Alert Templates
12 © 2020 General Electric Company
About Alert Template IngestionAlert template ingestion requires that you add an alert template source to the tenant before you caningest alert templates. For more information, refer to the Ingestion documentation.
Add an Alert Template SourceBefore ingesting an alert template, you must add an alert template source to the tenant.
Before You Begin
You need the following:
• Ingestion payload for creating an alert template source in JSON format.• Obtain the ingestion URL for creating an alert template source from your system administrator.• Oauth token to connect to the REST API endpoint.
Important: Make sure you have a valid unexpired token. Tokens are client specific and usually expirewithin a set time.
• From the Setup section get the following information:
◦ Client ID◦ 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 must add an alert template source to your tenant before you can ingest alert templates.
Procedure
1. Open your REST client.2. Enter the ingestion URL in the HOST value field.3. Select the POST method.4. In Headers, add the following key-value pairs.
Parameter Description
Authorization Enter the token_type followed by a space, then the access_token from the response youpreviously obtained. For example, bearer eyJhbGciOiJSUzI1NiJ9.A...The following code sample includes 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"}
© 2020 General Electric Company 13
Parameter Description
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.A sample JSON payload is shown below:
{ "name" : "Source System 1", "description" : "Source System 1 description"}
Results
On successful acceptance, you receive a 201 Created in the JSON response.
Example
HTTP/1.1 201 CreatedContent-Type: application/jsonContent-Length: 274
{ "uuid" : "0188015D6FB54937BC82452F3F21D7BF", "isActive" : true, "createdOn" : 1457478555853, "updatedOn" : 1457478555853, "id" : 46244, "name" : "Source System 1", "description" : "Source System 1 description", "tenantUuid" : "A5BE798652EE43F0BDE0CA20A7239BBB"}
Next Steps
You can ingest alert templates for the alert template source into your tenant.
Ingest Alert TemplatesYou must have created at least one alert source before you ingest alert templates into GE Digital APM.
Before You Begin
You will need the following:
• At least one alert template source added to your tenant.• Ingestion payload for alert templates in JSON format.• Obtain the ingestion URL for creating an alert template source from your system administrator.• 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 get the following information:
14 © 2020 General Electric Company
◦ Client ID◦ 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 alert profile REST service endpoint to perform bulk alert profile ingestion from yoursource system.
Procedure
1. Open your REST client.2. Enter the ingestion URL in the HOST value field.3. Select the POST method.4. In Headers, add the following parameters (key-value pairs).
Parameter Description
Authorization Enter the token_type followed by a space, then the access_token from the response youpreviously obtained. For example, bearer eyJhbGciOiJSUzI1NiJ9.A...The following code sample includes 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.
A sample JSON payload is shown below:
{ "isActive" : true, "createdOn" : 1457478557569, "tenantUuid" : "A5BE798652EE43F0BDE0CA20A7239BBB", "name" : "TemplateBuilderName2", "description" : "Template Builder Description2", "source" : "/v1/profileSources/46246", "severity" : 3, "type" : "/v1/profileType/46349", "isConsumable" : true, "isTrip" : false, "validateAsset" : true}
Results
On successful acceptance, you receive a 201 Created in the JSON response.
© 2020 General Electric Company 15
Example
HTTP/1.1 201 CreatedContent-Type: application/jsonContent-Length: 1028
{ "uuid" : "7BBCF0460BCE4E769689F23C2B9D163C", "isActive" : true, "createdOn" : 1457478558737, "updatedOn" : 1457478558737, "id" : 32539, "tenantUuid" : "A5BE798652EE43F0BDE0CA20A7239BBB", "name" : "TemplateBuilderName2", "description" : "Template Builder Description2", "source" : { "uuid" : "A169DB7623674D2FB307B2212C749714", "isActive" : true, "createdOn" : 1457478557567, "updatedOn" : 1457478557567, "id" : 46246, "name" : "TemplateSourceBuilderName", "description" : "Template Source Builder Description", "tenantUuid" : "A5BE798652EE43F0BDE0CA20A7239BBB" }, "severity" : 3, "type" : { "uuid" : "D1E6529F71AD49D99E6DF048F721CDF7", "isActive" : true, "createdOn" : 1457478557564, "updatedOn" : 1457478557564, "id" : 46349, "name" : "TemplateType Builder Name", "description" : "Template Type Builder Description", "tenantUuid" : "A5BE798652EE43F0BDE0CA20A7239BBB" }, "isConsumable" : true, "isTrip" : false, "validateAsset" : true}
Next Steps
You can ingest alerts into your tenant.
16 © 2020 General Electric Company
Chapter
4Release NotesTopics:
• Fourth Quarter of 2020• Second Quarter of 2020• Second Quarter of 2018• First Quarter of 2018
© 2020 General Electric Company 17
Fourth Quarter of 2020
Release Date: December 11, 2020This topic provides a list of product changes released for this module on this date.
Table 1: Enhancements and New Features
The following enhancements and new features have been added.
Description Tracking ID
The Alert Templates grid has been enhanced to retain the sorting order and filter criteria even
when you access the details page of an Alert Template and then navigate back to the Alert
Templates grid.
US445890
Second Quarter of 2020
Release Date: June 26, 2020This topic provides a list of product changes released for this module on this date.
Table 2: Resolved Issues
The following issues, which existed in one or more previous versions, have been resolved.
Description Tracking ID
Previously, when you deleted an Alert Template, and then attempted to delete a Case Template
that was associated with the Alert Template, the deletion failed and an error message indicating
that the Case Template was still associated with an Alert Template appeared. This issue occurred
even though the Case Template was not associated with any other Alert Template. This issue has
been resolved.
DE114708
Second Quarter of 2018
Alert Templates and Case TemplatesThis topic provides a list of product changes released for this module on the dates listed below.
Release Date: June 29, 2018
Table 3: Enhancements and New Features
Note Tracking ID
The Case Templates are now displayed in a tabular format. US248372
You can now filter the Case Templates using the header column of the grid. US248373
18 © 2020 General Electric Company
Note Tracking ID
You can now choose to show or hide columns of a Case Template. US248375
You can now sort a column of a Case Template grid either in ascending or descending order. US251085
You can now view the Case Templates grid in your preferred language. US187104
US187103
The Alert Templates are now displayed in a tabular format. US251076
You can now filter the Alert Templates using the header column of the grid. US251083
You can now choose to show or hide columns of an Alert Template. US251088
You can now sort the columns of an Alert Template grid either in ascending or descending order. US251086
You can now export selected Alert Templates instead of all the templates. US255781
You can now view the Alert Templates grid in your preferred language. US251082
Table 4: Resolved Issues
Note Tracking ID
Previously, when analysis template and alerts failed to load, an error message appeared,
displaying the message in both English and Polish even if you had set your preferred language as
Polish. This issue has been resolved.
DE49977
Previously, when you had imported a template, it had overridden the templates that were
modified by another user. This issue has been resolved.
DE73120
Previously, when you attempted to create a case from an alert using the case template ingested
from an API, the case was not created. This issue has been resolved.
DE66244
Previously, when you attempted to create an Alert Template, the Source and Type values were
displayed in another language. This issue has been resolved.
DE45622
First Quarter of 2018
Alerts Templates and Cases Templates Release Notes for March 30, 2018This topic provides a list of new and updated product features that are available for this release. It alsoprovides a list of resolved and known issues in this version of Alerts Templates and Cases Templates
Release Information
Module Name Alerts Templates
Cases Templates
Release Date March 30, 2018
Documentation Build Date March 22, 2018
© 2020 General Electric Company 19
What's New or Changed in This Release
This section outlines the new product features that are available for this release
• Users with administrator privileges can now view the audit logs for Alert Templates and CaseTemplates in the Audit Log Management page.
20 © 2020 General Electric Company
Recommended