37
Tenant Setup © 2020 General Electric Company

Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

  • Upload
    others

  • View
    3

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Tenant Setup

© 2020 General Electric Company

Page 2: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Contents

Chapter 1: Tenant Overview 1About Tenancy 2

Chapter 2: Tenant Preferences 4Configure Tenant Display Preferences 5

Configure the Module Navigation Menu Using Navigation Profiles 6

Configure SmartSignal Chart and Marker Preferences 9

Chapter 3: Manage Routes 11About Routes 12

Create or Modify Routes 12

Delete Routes 13

Chapter 4: Manage Help Application Links 14Create a Link to a Custom Help Application 15

Chapter 5: Alert Configuration 16About Alert Configuration 17

Chapter 6: About Case Configuration 20Configure a Property for a Case 22

Change the Sequence of Properties for a Case 22

Deprecate a Property for a Case 23

Chapter 7: Tenant Automation Rules 25About Automation Rules 26

Release Notes 1

First Quarter of 2020 1

Third Quarter of 2019 1

ii Tenant Setup

Page 3: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

First Quarter of 2019 1

Fourth Quarter of 2018 2

Second Quarter of 2018 3

iii

Page 4: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Copyright GE Digital© 2020 General Electric Company.

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

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

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

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

iv © 2020 General Electric Company

Page 5: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Chapter

1Tenant OverviewTopics:

• About Tenancy

© 2020 General Electric Company 1

Page 6: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

About TenancyA tenant is a group of users with common access to and privileges within their instance of GE Digital APM.A common set of underlying web services provides functionality (such as asset monitoring and usermanagement) to each tenant, yet secures access to customer-specific data. Users in one tenantorganization cannot access other tenants.

GE Digital APM can support multiple tenants. Each customer enterprise can be defined as an independenttenant with access to its GE Digital APM instance.

The system administrator adds customers as new tenants and administers all tenants. When adding anew tenant, the system administrator assigns a primary administrator for that tenant. After logging on,the primary tenant administrator completes the initial setup tasks, such as ingesting assets and timeseries data, creating users, and assigning user privileges.

Set or Change the Ingestor Password

Before You Begin

You must have an GE Digital APM tenant available. You must also have tenant administrator credentials toperform the initial tenant setup.

About This Task

During tenant setup, you must provide the ingestor password used by asset and alert ingestion servicesto ingest assets, alerts, and time series data into your current tenant. This password is unique to eachtenant, as the asset model and instances are exclusive to that tenant. Provide a complex password thatcomplies with your enterprise policies for password safekeeping.

When setting or changing a password, use the following guidelines:

• The password is case-sensitive and should be at least eight characters long.• You must use a combination of alphanumeric characters.• You can use special characters.• You cannot use consecutive characters such as 123 or abc.• You cannot repeat characters more than two times consecutively; for example, looop or 777.

The following are examples of invalid passwords:

Aaaron777b!rthday20009@bc1xyzrapper123

After setup, you can also change the ingestor password at any time.

Procedure

1. Sign in to your GE Digital APM tenant with your administrator credentials.2. In the module navigation menu, go to Setup.3. Depending on whether you are setting up a new password or changing the password, one of the

following applies:

• If you are setting up the password for the first time, you will be presented with a password setuppage.

2 © 2020 General Electric Company

Page 7: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

• If you are changing an existing password, click Change Ingestor Password.4. Enter a new password, and then re-enter the password to confirm.5. Select Submit to save your changes.

Next Steps

Once the password is set, you can ingest data into GE Digital APM.

Tenant Structure CreationBefore users can access the application (specific tenant organization), the tenant or user administratormust set up the tenant structure.

The tenant administrator needs to complete the following tasks to support a tenant architecture in GEDigital APM:

• Create a tenant. Upon creating the tenant, GE Digital APM automatically creates the ingestor useraccount. Then, you can log in as the tenant administrator and create a password for the ingestor user.

Note: The ingestor user account enables the ingestor user to upload assets to GE Digital APM. Thisaccount is created during the tenant setup.

• If you are using Predix APM, ../../../FoundationConfiguration/Content/CreateaNewSite.htm (Admin >Configuration Manager > Sites)

• If you are using Predix APM, ingest assets via Unified Loaders > Asset Ingestion Loader.• If you are using Legacy Predix APM, login as the ingestor user and ingest the asset model, tag

classifications, and asset data (including asset instances, connections, and tag associations).• Add other users and administrators.• Create alert templates.• Ingest alerts for ingested assets.• Add user groups and link them to the appropriate permission sets.• (SSO only) Import users from your identity management system into your tenant.• Add assets to users and user groups.• Complete deployment steps for modules and features.

© 2020 General Electric Company 3

Page 8: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Chapter

2Tenant PreferencesTopics:

• Configure Tenant DisplayPreferences

• Configure the ModuleNavigation Menu UsingNavigation Profiles

• Configure SmartSignal Chartand Marker Preferences

4 © 2020 General Electric Company

Page 9: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Configure Tenant Display PreferencesYou can configure the display preferences for all the users of the tenant.

Before You Begin

You must have tenant admin permissions to access the Tenant Preferences page.

Procedure

1. In the module navigation menu, go to Tenant Preferences.The Tenant Preferences page appears.

2. Select the Display tab.

3. As needed, enter the values in the following fields.Field Names Description

Asset DisplayName

Displays the name of the asset based on the following options:

• GE: Displays the asset name. By default, this option is selected.• Customer: Displays the alias name of the asset that you provided. This name appears on the Asset page.

Select the ( ) button to switch between GE and Customer name.

CultureSetting

Identifies the preferred culture of the user. This setting determines the date and number formats that aredisplayed when the user signs in to GE Digital APM.

Language Determines the display language. By default, US English is selected. You can select the preferred languagefrom the following options:

• Chinese (Simplified)• Dutch (Netherlands)• French (France)• German (Germany)• Italian (Italy)• Japanese• Polish• Portuguese (Brazil)• Russian• Spanish (Spain)• US English

System ofMeasure

Determines the system of measure. You can select your preferred system of measure in the drop-down listbox.

Note: The values in the drop-down list box appear based on the values that you configure in the Systems ofMeasure Configuration section. None and Metric are the system-provided system of measures, and bydefault, None is selected.

TimeZone Determines the time zone of your location. You can select your preferred time zone from the drop-down listbox.

If you select Site Local as your preferred time zone, all the date or time values will beconverted to the time zone of your asset.

Note:

• The selected time zone affects only this application.• Any selected time zone that observes Daylight Savings Time automatically observes the local time.

4. Select Save.A message appears, indicating that the changes will take effect after you log out and then log in to theapplication.

© 2020 General Electric Company 5

Page 10: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

5. Select OK.

Next Steps

Log out of the application and then log in for the changes to take effect.

Note: The display preferences that are configured in the Tenant Preferences page appear as defaultpreferences for all users of the tenant, except for the users who have set their own display preferences inthe My preferences User Preferences page.

Configure the Systems of MeasuresYou can add new systems of measures for a tenant.

Before You Begin

You must have tenant admin permissions to access the Tenant Preferences page.

Procedure

1. In the module navigation menu, go to Tenant Preferences.The Tenant Preferences page appears.

2. Select the Systems of Measure Configuration tab.

3. In the Systems of Measure section, select .

The button appears in the page.

4. Select , and then enter the name for the new system of measure.

5. Select Save.

Results

The new system of measure is added to the list and it also appears in the Units of Measure Conversionspage and Display section of the Tenant Preferences and My preferences User Preferences page.

Configure the Module Navigation Menu Using NavigationProfiles

A navigation profile contains information about the set of menu items that should appear in the modulenavigation menu.

About This Task

You can select a navigation profile if you want to switch to the user interface of a specific product for allthe users of a tenant. For example, if you want to change the UI to display the menu that is available inAPM, you can select the APM navigation profile. The following navigation profiles are available forselection:

• APM• Predix Essentials• Predix Essentials & APM• Predix Essentials & OPM• Predix Essentials, APM & OPM

6 © 2020 General Electric Company

Page 11: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

The following images display the different sets of menu items that appear based on the navigation profilesthat you select:

• Module navigation menu that appears when you select the APM navigation profile.

• Module navigation menu that appears when you select the Predix Essentials navigation profile.

• Module navigation menu that appears when you select the Predix Essentials & OPM navigation profile.

© 2020 General Electric Company 7

Page 12: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Before You Begin

• Ensure that you have the tenant admin permissions to access the Tenant Preferences page.

Procedure

1. In the module navigation menu, go to Tenant Preferences.The Tenant Preferences page appears.

2. Select the Module Navigation tab.The Module Navigation section appears.

3. In the Select a Navigation Profile drop-down list box, select the products that you want to appear inthe module navigation menu.

Note: If you select a navigation profile other than the default navigation profile, only the modulenavigation menu configured for that profile appears. You cannot access custom applications using themenu.

or

Select Reset Module Navigation Settings to Default.

Note: This setting shows menu items that are based on your permissions.

A message appears, stating that your changes are saved. This configuration is applied to all the usersof the tenant.

Note: You can access only the menu items for which you have permission to access.

Next Steps

Sign out of the application, and then sign in to access the module navigation menu that you haveconfigured.

8 © 2020 General Electric Company

Page 13: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Configure SmartSignal Chart and Marker PreferencesYou can configure the SmartSignal chart and marker preferences for all the SmartSignal users of thetenant.

Before You Begin

You must have tenant admin permissions to access the Tenant Preferences page.

Procedure

1. In the module navigation menu, go to Tenant Preferences.2. Select the SmartSignal Chart and Marker Settings tab.

3. As needed, select to enable or disable settings for the following options.Option Description

SmartSignalChart andMarker Settings

Customizes the SmartSignal markers and applies the changes to all templates in their possessions.

You can select marker, color, or position from the drop-down list. You can also selectthe stacking order number. The order numbers are one through five. One being thetop-most position in the stack, and five being the bottom-most in the stack. Morethan one type of marker can be placed in a lane.For more information on each of the options, see the Reference section in the SmartSignaldocumentation. You can select from the following options:

• Diagnostic Rule• Adaptation Successful• Adaptation Inhibit• NaN• Outlier• VSG• Single Point Excursion• Tag Level Rules Default

4. Select Save.A message appears, indicating that the changes will take effect after you log out and then log in to theapplication.

5. Select User Preferences.

6. As needed, select to enable or disable settings for the following options.Option

• Diagnostic Rule• Adaptation Successful• Adaptation Inhibit• NaN• Outlier• VSG• Single Point Excursion• Tag Level Rules Default• Actual• Estimate• Residual• Smooth Actual• Smooth Residual

For more information on each of the options, see theReference section in the SmartSignal documentation.

7. Select OK.

© 2020 General Electric Company 9

Page 14: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

8. Optionally, select Restore Defaults to revert the entire table to its original state.

Next Steps

Log out of the application and then log in for the changes to take effect.

Note: The display preferences that are configured in the Tenant Preferences page appear as defaultpreferences for all users of the tenant, except for the users who have set their own display preferences inthe My preferences User Preferences page.

10 © 2020 General Electric Company

Page 15: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Chapter

3Manage RoutesTopics:

• About Routes• Create or Modify Routes• Delete Routes

© 2020 General Electric Company 11

Page 16: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

About RoutesRoutes are configurable URLs that determine a destination web page from a hyperlink or interface control.

For example, when an alert is generated, a link is provided for you to access the alert in APM. The URLpath that you provide when you create the route is the destination page of that link.

You can also create a new route for a custom Help application.

Create or Modify RoutesAs a user with tenant admin permissions, you can create or modify routes for navigating to alert links andassets within the product, or for adding a custom Help application link.

Procedure

1. In the left navigation menu, select Tenant Preferences.The Tenant Preferences page appears.

2. Select Route Manager.

3. To create a route, select .4. To modify a route, hover over the row that contains the route that you want to modify, and then select

.5. Select a field name to specify required values for the route.

In this field Select or Enter

Name A unique route name.

The route name appears in the Route Selectionpage of the intended module.

Module The module as it appears in the left navigation menu.

The combination of the Module and the Pathcreates the fully qualified URL at runtime.

Path The relative URL path.

Type The route type. Valid values are alertLink, assetFacePlate, orhelpLink.

Description A description of the route.

6. Select Apply to save the route changes or Reset to discard the changes.

Next Steps

Log out of the tenant and log back in to verify your changes.

Related Tasks

Create a Link to a Custom Help Application on page 15

12 © 2020 General Electric Company

Page 17: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

As a user with tenant admin permissions, you can create a link to a custom Help application using theRoute Manager.

Delete RoutesAs a user with tenant admin permissions, you can delete routes that are no longer needed.

About This Task

Procedure

1. In the left navigation menu, select Tenant Preferences.The Tenant Preferences page appears.

2. Select Route Manager.

3. Hover over the row that contains the route that you want to delete, and then select .4. Select Apply to save the route changes or Reset to discard the changes.5. The route is removed from the list of routes.

Next Steps

Log out of the tenant and log back in to verify your changes.

© 2020 General Electric Company 13

Page 18: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Chapter

4Manage Help Application LinksTopics:

• Create a Link to a Custom HelpApplication

14 © 2020 General Electric Company

Page 19: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Create a Link to a Custom Help ApplicationAs a user with tenant admin permissions, you can create a link to a custom Help application using theRoute Manager.

Procedure

1. In the left navigation menu, select Tenant Preferences.The Tenant Preferences page appears.

2. Select Route Manager.

3. Select to create a route.4. Specify required values for the route.

In this field Select or Enter

Name Name of the application for which custom Help is written.

Module Select Custom Help.

Path The relative URL path for the Help application

Type Select helpLink.

Description A description of the custom Help application.

5. Select Apply to save the changes.

© 2020 General Electric Company 15

Page 20: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Chapter

5Alert ConfigurationTopics:

• About Alert Configuration

16 © 2020 General Electric Company

Page 21: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

About Alert ConfigurationThe Alert Configuration tab on the Tenant Preferences page allows you to configure various elementsfor an alert.

Using the Alert Configuration tab, you can configure various elements, such as the Disposition, Type, andSource for an alert.

The following table provides the list of default values available for various elements available in the AlertConfiguration tab.

Section Name Description

Disposition Lists the available dispositions for an alert. The following valuesappear by default:

• None• Valid• False• False System• Sensor Issue• Reset State Dat• Outage

You can add new values or perform other actions as describedin the subsequent sections.

Type Lists the types of alerts. The following values appear by default:

• Combustion• Vibration• Mechanical

You can add new values or perform other actions as describedin the subsequent sections.

Source Lists the available types of sources for an alert. The followingvalues appear by default:

• Manual• Predix• SS Tag Rule

You can add new values or perform other actions as describedin the subsequent sections.

Configure an Element for an AlertIn Tenant Preferences, you can configure various elements, such as the disposition, type, and source for analert.

Before You Begin

You must be logged in to GE Digital APM as a tenant administrator to access Tenant Preferences.

About This Task

This procedure describes the steps to configure a disposition. You can use this procedure to configure thetypes and sources as well.

© 2020 General Electric Company 17

Page 22: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Procedure

1. On the Tenant Preferences page, select the Alert Configuration tab.The Alert Configuration page appears, displaying the Disposition, Type, and Source sections.

2. In the Disposition section, select Edit icon ( ).

The button appears.

3. Select , and then enter the name for the new disposition.The Save button is enabled.

4. When you are done, select Save.The new disposition is added in the Disposition section.

Results

The list of configured dispositions will also appear on the Alert Detail page.

Change the Sequence of Elements for an AlertYou can change the order of input values that appear in the Disposition, Type, and Source sections.

Before You Begin

You must be logged in to GE Digital APM as a tenant administrator to access Tenant Preferences.

About This Task

This procedure describes how to change the order of input values in the Disposition section. You can alsouse this procedure to change the sequence of input values in the Type and Source sections.

Procedure

1. On the Tenant Preferences page, select the Alert Configuration tab.The Alert Configuration page appears, displaying the Disposition, Type, and Source sections.

2. In the Disposition section, select the Edit icon ( ).

The Move icon ( ) appears for each disposition listed.3. Select and hold the Move icon, and then drag and drop a disposition to a new location in the list of

dispositions.The Save button is enabled.

4. When you are done, select Save.The sequence of dispositions is changed.

Results

The revised list of configured dispositions appears on the Alert Details page.

Deprecate an Element for an AlertYou can deprecate an element, such as disposition, type, or source, which removes it from the list ofavailable dispositions, types, or sources for an alert.

Before You Begin

You must be logged in to GE Digital APM as a tenant administrator to access Tenant Preferences.

18 © 2020 General Electric Company

Page 23: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

About This Task

This procedure describes how to deprecate a disposition for an alert. You can use this procedure todeprecate a type or source as well.

Procedure

1. On the Tenant Preferences page, select the Alert Configuration tab.The Alert Configuration page appears, displaying the Disposition, Type, and Source sections.

2. In the Disposition section, select the Edit icon ( ).3. Pause or hover over the disposition that you want to deprecate.

The Delete icon ( ) appears.4. Select Delete.

The Deprecate window appears.5. Select Confirm.6. When you are done, select Save.

The selected disposition is removed from the Disposition section and appears in the Deprecated

section. You can select to add the deprecated value back to the list of available dispositions.

© 2020 General Electric Company 19

Page 24: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Chapter

6About Case ConfigurationTopics:

• Configure a Property for a Case• Change the Sequence of

Properties for a Case• Deprecate a Property for a Case

On the Tenant Preferences page, the Case Configuration tab allowsyou to configure various properties for a case.

Using the Case Configuration tab, you can configure variousproperties for the category, urgency, closure code, and status for acase.

The following table provides the list of default values available forvarious properties in the Case Configuration tab.

Section Name Description

Category Lists the available categories for a case.The following values appear by default:

• Combustion• Equipment• Instrumentation• Mechanical• Operational• Performance• Process• Vibration

You can add new values or perform otheractions as described in the subsequentsections.

This section will always contain onecategory.

Closure Code Lists the types of closure codes for acase. The following values appear bydefault:

• None• Forced Outage• No Action• Operational Change• Scheduled Maintenance• Sensor Repair• Unplanned Maintenance

You can add new values or perform otheractions as described in the subsequentsections.

20 © 2020 General Electric Company

Page 25: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Section Name Description

Status Lists the types of status for a case. Thefollowing values appear by default:

• Closed• Awaiting• Open

You can add new values or perform otheractions as described in the subsequentsections.

You cannot deprecate the values Openand Closed.

Urgency Lists the available urgencies for a case.The following values appear by default:

• EHS• Emergency• High• Low• Next Opportunity• Next Planned

You can add new values or perform otheractions as described in the subsequentsections.

This section will always contain oneurgency.

© 2020 General Electric Company 21

Page 26: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Configure a Property for a CaseOn the Tenant Preferences page, you can configure the property for a category, urgency, closure code,and status for a case.

Before You Begin

You must be logged in to GE Digital APM as a tenant administrator to access the Tenant Preferencespage.

About This Task

This procedure describes the steps required to configure a category in the Category section. You can alsouse this procedure to configure urgencies, closure codes, and status.

Procedure

1. In the left pane, select Tenant Preferences.2. On the Tenant Preferences page, select the Case Configuration tab.

The Case Configuration page appears, displaying the Category, Urgency, Closure Code, and Statussections.

3. In the Category section, select the Edit icon( ).

The button appears.

4. Select , and then enter the name for the new category.The Save button is enabled.

5. Select Save.The new category is added in the Category section.

Results

The list of configured categories will also appear in the case details section of the Cases and CaseTemplates page.

Next Steps

In the Category and Urgency sections, when you modify a property, you will need to refresh your cacheto view the updated list of categories or urgencies.

Change the Sequence of Properties for a CaseOn the Tenant Preferences page, you can change the order of input values that appear in the Category,Urgency, Closure Code, and Status sections for a case.

Before You Begin

You must be logged in to GE Digital APM as a tenant administrator to access the Tenant Preferencespage.

22 © 2020 General Electric Company

Page 27: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

About This Task

This procedure describes how to change the order of input values in the Category section. You can alsouse this procedure to change the sequence of urgencies, closure codes, and status.

Procedure

1. In the left pane, select Tenant Preferences.The Tenant Preferences page appears.

2. On the Tenant Preferences page, select the Cases Configuration tab.The Case Configuration page appears, displaying the Category, Urgency, Closure Code, and Statussections.

3. In the Category section, select the Edit icon ( ).

The Move icon ( )appears for each listed category.4. Select and hold the Move icon, and then drag the category to a new location in the list of categories.

The Save button is enabled.5. Select Save.

The sequence of categories is changed.

Note: In the Category and Urgency sections, when you change the order of input values, you willneed to refresh your cache to view the updated list of categories or urgencies.

Results

The revised list of configured categories will also appear in the case details section of the Cases and CaseTemplates page.

Deprecate a Property for a CaseYou can deprecate a property that appears in the Category, Urgency, Closure Code, and Statussections for a case.

Before You Begin

You must be logged in to GE Digital APM as a tenant administrator to access Tenant Preferences.

About This Task

This procedure describes how to deprecate a category for a case. You can use this procedure to deprecateurgencies, closure codes, and status as well.

Procedure

1. In the left pane, select Tenant Preferences.The Tenant Preferences page appears.

2. On the Tenant Preferences page, select the Case Configuration tab.The Case Configuration page appears, displaying the Category, Urgency, Closure Code, and Statussections.

3. In the Category section, select the Edit icon ( ).4. Pause on or hover over the category that you want to deprecate.

The Delete icon ( ) appears.5. Select Delete.

© 2020 General Electric Company 23

Page 28: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

6. The Deprecate window appears.7. Select Confirm.

The Save button is enabled.8. Select Save.

The selected category is deprecated and is unavailable in the Category section. You can select the

Edit icon ( ), and then select the Undo Deprecation icon ( ) to add the deprecated categoryback to the list of available categories.

Note: In the Categoryand Urgency sections, when you deprecate a property, you will need to refreshyour cache to view the updated list of categories or urgencies.

Results

The revised list of configured categories will also appear in the case details section of the Cases and CaseTemplates page.

24 © 2020 General Electric Company

Page 29: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Chapter

7Tenant Automation RulesTopics:

• About Automation Rules

© 2020 General Electric Company 25

Page 30: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

About Automation RulesAutomation Rules is a tab in the Tenant Preferences page.

Users must have tenant admin permissions to access the Tenant Preferences page, which provides accessto the Automation Rules tab. A tenant admin can create rules at the tenant level that determine thecriteria that will trigger a specific action for Alerts or Cases. In creating a rule, the tenant admin selects atrigger for the action, the asset involved, any additional criteria, and the action that the rule invokes.

Automation Rules for Alerts

A tenant admin can create automation rules to trigger one of the following actions on Alerts:

• Create a latched alert rule to group alerts.• Create a rule for automatic processing of alerts when the Alert Disposition is updated. You can

configure the rule to trigger one of the following actions:

◦ Mark the status of the Alert as Processed.◦ Set the Visibility of the Alert to Limited or General.

Create a Latched Alert Rule

You can create an Alert rule for latching, or grouping, alerts that frequently recur.

Before You Begin

You must have tenant admin permissions to see the Tenant Preferences page and the Automation Rulestab. The tenant admin can view, create, and delete automation rules.

Procedure

1. In the left navigation menu, select Tenant Preferences.The Tenant Preferences page appears.

2. Select Admin > Tenant Preferences.The Tenant Preferences page appears.

3. In the Automation Rules tab, select the Plus icon (+) to the right of the Alert Rules row, and specifythe following information in the subsequent dialog boxes.

Command orAction

Description

Select atrigger

Select an event that will cause this rule to trigger.

a. Select Alert Created in the list.b. Select Next.

Enter Asset a. Enter the Asset Source Key for the asset you want to create the rule for, and then select outside thebox to validate the selected asset.

b. Or, check the Use All Resources box. When Use All Resources is selected, the rule will apply to allassets across all sites in all enterprises. When the user checks the box, the text field above it is disabled(grayed out).

c. Once the green check mark appears to the right of the asset box, the Next button is enabled. SelectNext.

Note: If the asset is not validated, the message Asset Not Found appears instead of the checkmark.

26 © 2020 General Electric Company

Page 31: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Command orAction

Description

Select Criteria Select the Add Filter criteria for triggering the latching, and then select one or more of the following optionsfrom the list.

a. Severity – Select one of the following from the list, and then enter a number in the text field:

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

b. Source – Select one of the following from the first list:

• Is equal to• Is not equal to

and then select one of the following from the second list:

• None (default value)• Predix• Orchestration Manager• Manual• SmartSignal• SS Tag Rule

c. Alert Type – Select one of the following from the first list:

• Is equal to• Is not equal to

and then select one of the following from the second list:

• None (default value)• Combustion• Vibration• Mechanical• Generic

d. Alert Name – Enter a name in the text field.

Important: The alert name must not contain the following characters:

• Quotation mark (")• Apostrophe (')• Semicolon (;)• Slash (/)• Open parenthesis ( ( )• Close parenthesis ( ) )

Note: To remove any of the criteria, select the X at the end of the row.e. Select Next.

Select anAction

Select the action to be taken when the rule is triggered.

a. Select Latch Alert from the list.b. Select Finish.

Results

The message Your changes have been saved successfully appears in the upper right sideof the page, and the new rule appears in the Alert Rules section of the Automation Rules tab.

© 2020 General Electric Company 27

Page 32: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Create a Rule for Automatic Processing of Alerts

You can create automation rules for alerts that specify an automatic action that is taken when allconditions are met.

Before You Begin

You must have tenant admin permissions to access the Automation Rules section. The tenant admincan view, create, and delete automation rules.

About This Task

You will need to select a trigger for the subsequent action, an asset ID, the criteria (or source of the alert),and the action invoked by the trigger.

Procedure

1. In the module navigation menu, select Tenant Preferences.The Tenant Preferences page appears.

2. Select Admin > Tenant Preferences.The Tenant Preferences page appears.

3. In the Automation Rules section, select next to the Alert Rules row, and specify the followinginformation in the subsequent windows.

Command orAction

Description

Trigger Select the Alert Disposition Updated option in the list.

Asset a. Enter the Asset Source Key for the asset for which you want to create the rule, and then select outsidethe box to validate the selected asset.

-or-

Select the Use All Resources check box. When the Use All Resources check box isselected, the rule will apply to all assets across all sites in all enterprises. When theuser selects the check box, the box above it is disabled (grayed out).

A green check mark appears next to the asset box and the Next button is enabled.b. Select Next.

Note: If the asset is not validated, the message Asset Not Found appears instead of the checkmark.

Criteria Select filter criteria to restrict when the rule will trigger. Disposition is the default, and only, option.

Select Next.

Action Select one of the following options:

• Select Mark Alert as Processed to configure the rule to automatically set thestatus of the Alert to Processed based on the filter criteria.

• Select the Set Alert Visibility option to specify the action that will be taken whenthe rule is triggered.

a. Set the Alert Visibility by selecting either General or Limited. Limited is selectedby default.

b. When done, select Finish.

Note: General visibility alerts are visible to any user with permissions to view alertsand the relevant asset. Limited visibility alerts require an additional permission.

28 © 2020 General Electric Company

Page 33: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Results

Once the rule is created, a message appears, specifying that the rule is saved and the new rule appears inthe Alert Rules section of the Automation Rules section.

Note: If you create a rule that duplicates an existing rule, you are not prompted regarding the duplicateentry, but only the initial rule is displayed in the Automation Rules section.

Create an Automation Rule for CasesYou can create automation rules for cases that specify an automatic action that is taken when allconditions are met.

Before You Begin

You must have tenant admin permissions to access the Automation Rules tab in the Tenant Preferencespage. The tenant admin can view, create, and delete automation rules. A user to whom the case rule isassigned must have permissions to access Cases as well as the asset for which the rule was created.

About This Task

You will need to select a trigger for the subsequent action, an asset ID, the criteria (or source of the case),and the action invoked by the trigger.

Procedure

1. In the left navigation menu, select Tenant Preferences.The Tenant Preferences page appears.

2. Select Admin > Tenant Preferences.The Tenant Preferences page appears.

3. In the Automation Rules tab, select the Plus icon (+) to the right of the Case Rules row, and specify thefollowing information in the subsequent dialog boxes.

Command orAction

Description

Trigger Select Case Created in the list.

Asset Select an asset ID from the list, and then select outside the box to validate the selected asset.

A green check mark appears to the right of the asset box and the Next button isenabled. Select Next.

If the asset is not validated, the message Asset Not Found appears instead ofthe check mark.

Criteria Select Orchestration Manager as the criteria and then select Next.

Action Select Auto Assign Case as the action and then select Next.

4. After selecting an action, enter the user name in the text box for the user to whom the case will beassigned.

5. Select Finish.Validation of the user to whom the case was assigned is done to ensure he or she has access to theselected asset. If the user does not have permission, then the message User does not haveaccess to asset appears.

Results

Once the rule is created, a message appears, specifying that the rule is saved and the new rule appears inthe Case Rules section of the Automation Rules tab.

© 2020 General Electric Company 29

Page 34: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Note: If you create a rule that duplicates an existing rule, you are not prompted regarding the duplicateentry, but only the initial rule is displayed in the Automation Rules tab.

Delete an Automation RuleAs a tenant admin, you can delete an automation rule that has been set for either alerts or for cases.

Before You Begin

You must have tenant admin permissions to see the Tenant Preferences page and the Automation Rulestab. The tenant admin can view, create, and delete automation rules.

Procedure

1. In the left navigation menu, select Tenant Preferences.The Tenant Preferences page appears.

2. Select Admin > Tenant Preferences.The Tenant Preferences page appears.

3. In Tenant Preferences, select the Automation Rules tab.4. In either the Alert Rules or Case Rules section, find the rule you want to delete.

5. Select the rule, and then select the Delete icon ( ).The Delete Rule dialog box appears.

6. Confirm the deletion of the rule.The message Rule Deleted successfully appears.

Results

The rule is removed and you can verify that for any newly created alerts that satisfy the deleted alert rulethe alert disposition is unchanged, while any newly created cases that satisfy the deleted case rule areunassigned or unclaimed. If you add the deleted rule again, you can verify that either the alert dispositionhas changed or cases are unassigned, per the rule.

30 © 2020 General Electric Company

Page 35: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Release Notes

First Quarter of 2020

Release Date: March 27, 2020

Table 1: Enhancements and New Features

The following enhancements and new features have been added.

Description Tracking ID

You can now configure the preferred culture of a user that determines the date and number

formats displayed in GE Digital APM for the user. To facilitate this enhancement, a new drop-

down list box, Culture Setting, has been added to the Display section of the TenantPreferences page.

US386929

Third Quarter of 2019

Tenant PreferencesThis topic provides a list of product changes released for this module on the dates listed below.

Release Date: September 27, 2019

Table 2: Enhancements and New Features

The following enhancements and new features have been added.

Description Tracking ID

You can now access Route Manager from the Tenant Preferences page. F46374

First Quarter of 2019

Tenant PreferencesThis topic provides a list of product changes released for this module on the dates listed below.

Release Date: March 29, 2019

Table 3: Enhancements and New Features

The following enhancements and new features have been added.

© 2020 General Electric Company 1

Page 36: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Description Tracking ID

You can now select which applications appear in the module navigation menu by selecting a

module navigation profile. A new page, Module Navigation Menu, was added to TenantPreferences to facilitate this change. The following navigation profiles are available:

• APM

• Predix Essentials

• Predix Essentials & APM

• Predix Essentials & OPM

• Predix Essentials, APM, & OPM

US304693

Table 4: Obsolete Features

As of this release, the following items are no longer available.

Description Tracking ID

When a navigation profile is selected, the applications that are not accessible to a user no longer

appear in the module navigation menu.

US315324

Fourth Quarter of 2018

Tenant PreferencesThis topic provides a list of product changes released for this module on the dates listed below.

Release Date: December 14, 2018

Table 5: Enhancements and New Features

Description Tracking ID

You can now select which applications appear in the module navigation menu by selecting a

module navigation profile. A new page, Module Navigation Menu, was added to TenantPreferences to facilitate this change. The following navigation profiles are available:

• APM

• Predix Essentials

• Predix Essentials & APM

• Predix Essentials & OPM

• Predix Essentials, APM, & OPM

US304693

2 © 2020 General Electric Company

Page 37: Tenant Setup · perform the initial tenant setup. About This Task During tenant setup, you must provide the ingestor password used by asset and alert ingestion services to ingest

Second Quarter of 2018

Tenant PreferencesThis topic provides a list of product changes released for this module on the dates listed below.

Release Date: June 29, 2018

Table 6: Enhancements and New Features

Note Tracking ID

GE Digital APM now supports the following six new languages:

• Chinese (Simplified)

• Dutch (Netherlands)

• Italian (Italy)

• Japanese

• Portuguese (Brazil)

• Spanish (Spain)

US259336

© 2020 General Electric Company 3