Application Help for SAP Predictive Asset
Application Help for SAP Predictive Asset
3 Analytics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
3.1 Explorer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Analysis Tools. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Explorer Global Filter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
3.2 Features in Indicator Chart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
3.3 Equipment Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
3.4 Failure Mode Analytics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Using Failure Mode Analytics on the Equipment or Model Pages. . . . . . . . . . . . . . . . . . . . . . . . . 61
Using Failure Mode Analytics in the Failure Modes Application. . . . . . . . . . . . . . . . . . . . . . . . . . 67
Using the Failure Mode Analytics Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
3.5 Personal Dashboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
3.6 Analytics Dashboards. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Creating an Analytics Dashboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73
Viewing an Analytics Dashboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Editing an Analytics Dashboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Deleting an Analytics Dashboard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
3.7 Emerging Issue Detection (EID). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
4 Processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80
4.1 Improvement Requests. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Creating an Improvement Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Reviewing an Improvement Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Completing an Improvement Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Resubmitting an Improvement Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Confirming an Improvement Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Viewing the List of Improvement Requests. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Deleting an Improvement Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86
4.2 Obsolescence Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Viewing the Obsolescence Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
4.3 Lookup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Managing Lookup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
5 Master Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
5.1 Equipment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Managing Equipment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
5.2 Models. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Managing Models. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
5.3 Functional Locations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Creating a Functional Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Updating Indicator Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Viewing and Updating a Functional Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Viewing Alerts of Functional Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Viewing Time Series Data (Indicator Chart) of a Functional Location. . . . . . . . . . . . . . . . . . . . . 164
5.4 Locations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Creating a Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Updating a Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Deleting a Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Viewing Work Orders of a Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Viewing Notifications of Location. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
5.5 Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Creating and Editing Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175
Deleting Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
5.6 Failure Modes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Managing Failure Modes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
5.7 Fingerprints. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Creating a Fingerprint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Viewing a Fingerprint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Editing a Fingerprint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Deleting a Fingerprint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
5.8 Spare Parts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .189
Managing Spare Parts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .189
5.9 Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .199
Managing Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
5.10 Systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Managing Systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
5.11 Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .218
Uploading a Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Maintaining Different Language Versions of a Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Editing Document Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .225
7 Administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
7.1 Managing Company Profile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Adding Location Details of your Organization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
Updating Location Details of your Organization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
SAP Predictive Asset Insights is an Internet of Things (IoT) application. You can reach all the functions from the
SAP Fiori launchpad.
● Avoidance of costly disruptions by predicting equipment malfunctions before they happen by processing
huge volumes of information technology (IT) and operational technology (OT) data using sophisticated
machine learning algorithms.
● Use insights from sensor data to improve product quality, reliability, and customer satisfaction
● Manage complex asset (equipment) structures
● Build an asset network collaboration for better service and maintenance processes
Supported Languages
The language in which the UI is displayed depends on the language you have set in your browser settings. If you
have set a language that is not one of the supported languages, the UI of SAP Predictive Asset Insights is
displayed in the default language.
Here is an overview of how to reach the various applications and functions for SAP Predictive Asset Insights.
Access URLs
The SAP Intelligent Asset Management Fiori launchpad URL provides access to all the available applications for
SAP Predictive Asset Insights. For information about subscribing to the launchpad, see Subscribing to SAP
Predictive Asset Insights and Other Solutions.
The following table provides you with an overview of all URLs depending on your licenses:
Access To URL
SAP Intelligent Asset Management Fiori launchpad for a test https://<tenant subdomain>.iam-
and demo license pr.cfapps.<region>.hana.ondemand.com
Please contact your Identity Management Administrator if you cannot see the applications you require. They
will ensure the appropriate role collection is assigned to your user.
Related Information
SAP Fiori Launchpad with SAP Predictive Asset Insights [page 10]
You can use the SAP Predictive Asset Insights applications on a number of devices and browsers.
The browser support for the solution is aligned with the browsers supported by SAP BTP cockpit. For more
information, see the Browser Support sub-section in the topic Prerequisites and Restrictions for SAP BTP.
Some of the features are not supported on few devices or browsers. The following list provides you this
information:
● You cannot work with hotspots or 3D visual files on any of the handheld devices other than a PC and a
MAC.
● You cannot upload files on an iPad that is using an SAP Fiori Client.
● Personal dashboard is preconfigured for end users only and does not include administrator relevant
transactions. However, administrator can directly access the URL to navigate to each individual Admin app.
Here we describe the meanings of some fundamental terms in SAP Predictive Asset Insights.
Term Definition
Note
The term equipment is a noncount noun. Hence:
Note
Search for terminology definitions for SAP Predictive Asset Insights under component IOT-PDM at https://
sapterm.com .
You access SAP Predictive Asset Insights using the SAP Intelligent Asset Management launchpad. This
launchpad includes the applications from the SAP Intelligent Asset Management relevant products on a single
SAP Fiori launchpad based on your subscriptions. We provide several roles that allow the display of groups that
logically group related applications. You can customize the launchpad to show and hide applications as you
require.
Supported Features
● Anchor navigation
● Search
● User actions menu
○ App Finder - find applications and add them to the SAP Fiori launchpad
○ Settings - maintain the settings for the SAP Fiori launchpad, for example, changing the appearance of
the launchpad, specifying a unit of measure, or selecting an automatic data refresh interval for the
analysis tools
○ Edit Home Page - change the visibility and placement of groups and applications
○ Theme Manager - create your own themes for the SAP Fiori launchpad
Group Functions
Note
The Explorer [page 13] is the place where
most of the activities for SAP Predictive Asset
Insights occur, bringing together sensor and
business data to analyze data for equipment
and functional locations, and help you decide
how to proceed.
Master Data If you are a business user you can browse all kinds
of related information about your equipment. Addi
tionally create and edit master data.
Machine Learning Engine Find tools for your data science tasks:
Roles
The role collections assigned to your user determine which groups and applications are visible. For an overview
of the roles that need to be assigned to see and use the applications, see the Security Information for SAP
Predictive Asset Insights.
The tiles under Analytics on the SAP Fiori launchpad provide you the abilities to view, filter, and analyze data
across equipment, perform follow-up tasks, as well as overview the dashboards.
Overview of Analytics
Tile Use
Explorer [page 13] Use analysis tools in the Explorer to analyze data for your
equipment and functional locations, and then decide on fol
low-up actions. The Explorer brings together sensor and
business data and from here you can navigate to different
object pages to get an overview of all the data associated
with a selected object.
Failure Mode Analytics [page 60] Use failure mode analytics to get insights and analytics
about the last occurring failures for your equipment and
equipment models. Failure mode analytics uses machine
learning to turn the human knowledge contained within the
texts of notifications into insights about the nature of fail
ures.
Personal Dashboard [page 69] This app is personalized to be a one-stop point to navigate to
the applications, your frequently viewed items of equipment,
favorites and unread announcements.
3.1 Explorer
The Explorer is an application that contains analysis tools to analyze data for equipment and functional
locations.
Note
If you are using the application with a touch-enabled device, not all features work using the touch feature.
Features
To focus your analysis, you can use different filter functions. The following functions are available:
Note
The filter functions across all analysis tools filter based on top equipment. For the alerts, equipment
indicators, and map analysis tools, they also filter based on top functional locations.
To filter across all analysis tools, you can use the following options:
○ Choose an analysis tool, select, for example, one or more work orders, notifications, or equipment. All
of these belong to certain top equipment. By choosing Apply as Filter, all analysis tools are filtered and
only show data for the same top equipment. If you use the alerts, equipment indicators, or map
analysis tool, data for the same top equipment and top functional locations is shown.
○ Use the Explorer global filter and apply multiple filters to all analysis tools in the Explorer in one go.
You can combine the different filter functions. For example, when you filter in an analysis tool and use the global
filter, the analysis tool displays data filtered by both criteria.
For more information about the different filter functions, see Analysis Tools [page 15] and Explorer Global
Filter [page 48].
To refresh data across all your analysis tools, you can use different refresh functions. The following functions
are available:
● Manually refreshing data across all analysis tools in the Explorer by choosing Refresh.
● Automatically refreshing data across all analysis tools in the Explorer by activating an automatic data
refresh with a refresh interval in the Settings of the SAP Fiori launchpad.
You can combine the data refresh functions. For more information about the data refresh functions, see
Analysis Tools [page 15].
You can save a current set of analysis tools with their selected variants in the Explorer as a new tile by choosing
(Save as Tile). This allows you to save different sets of analysis tools and analysis tool variants, for
example, a set of analysis tool variants that focuses on a specific piece of equipment. The new tile is then
added to your selected group on the SAP Fiori launchpad. Any applied filter functions or other settings of the
analysis tools are not carried over to the new tile.
To update the set in the new tile, you can select different analysis tool variants, add or remove analysis tools,
and use all features of the Explorer and the analysis tools. Once you exit the tile, your updates are saved. Other
settings are not saved.
To manage the tile, for example, to rename or move the tile, you can go to the user menu on the SAP Fiori
launchpad and choose Edit Home Page.
For more information about the Equipment page, see Equipment Page [page 58].
An analysis tool is a self-contained part of the application with its own user interface and functionality that
provides an insight into one or more pieces of equipment and functional locations.
For every analysis tool, variants can be configured by an administrator. The analysis tool variants contain
different settings. As a business user, you can adapt the analysis tools to work with the Explorer according to
the personal business scenario. For more information about the configuration, see Explorer and Analysis Tools
Configuration [page 489].
Note
You can add analysis tools from the Analysis Tools Catalog to the Explorer and then select a specific variant for
each analysis tool. In the Analysis Tools Catalog, you can also remove added analysis tools. For more
information, see Adding Analysis Tools to the Explorer [page 19] and Removing Analysis Tools from the
Explorer [page 20].
Alerts [page 22] Provides a list of current alerts based on rules defined for
sensor data, key figures, and health scores. Provides data
visualization so that you can see when alerts have occurred.
Indicator Chart [page 21] Provides data visualization across one or more measure
ments.
Note
Besides adding the indicator chart from the Analysis
Tool Catalog, you can also reach the indicator chart from
the alerts analysis tool.
Work Orders [page 35] Provides a list of current work orders and their details.
Equipment Indicators [page 32] Provides a list of master data, attributes, and indicators for
equipment and functional locations. These indicators indi
cate if the behavior of technical object is normal or not.
Map [page 36] Provides a geographic map with the locations of top equip
ment and top functional locations and allows you to select
indicators and apply their colors to the map markers. It also
allows spatial selection.
Transformer Health Analytics [page 41] Provides insights into the health status of mineral oil-filled
transformers using the Dissolved Gas Analysis (DGA). DGA
checks the concentration of dissolved gases in the insulating
oil and detects the type and severity of fault in the trans
former.
Features
Functionality and behavior can differ from one analysis tool to another, depending on its purpose. However,
some features are the same in most analysis tools:
Full Screen Mode (Relevant for map, indicator chart, and equipment indicators)
If you want to focus your analysis on one specific area, for example, if you only want to look at the map where
your equipment are located, you can open an analysis tool in full screen mode and hide the other analysis tools
Note
Filter in One Analysis Tool (Relevant for all analysis tools except for indicator chart)
For almost all analysis tools, you can filter your analysis tool. Depending on the analysis tool, the filter
mechanism differs. For example, for work orders, you can choose (Filter), select the filters, enter the
values and then choose Go to apply this selection to the analysis tool. In the map, you can filter by drawing
geofences around the technical objects. In transformer health analytics, you can use a time filter. The filter
function in one analysis tool does not affect filters in other analysis tools.
Note
This filter function filters based on top equipment. For the alerts, equipment indicators, and map analysis
tools, it also filters based on top functional locations.
In the Explorer, you can filter across all analysis tools. Select, for example, one or more work orders,
notifications, or equipment. All of these belong to certain top equipment. By choosing Apply as Filter, all
analysis tools are filtered and only show data for the same top equipment. If you use the alerts, equipment
indicators, or map analysis tool, data for the same top equipment and top functional locations is shown. If you
add a new analysis tool to the Explorer after you have selected a certain set of equipment, the newly added
analysis tool automatically displays data based on your existing selection. If you want to reset the filters in all
Note
The transformer health analytics analysis tool only shows the filter results if you choose Apply as Filter in
another analysis tool, but the Apply as Filter button itself is not available in the analysis tool, so you cannot
apply a selection from this analysis tool across the other analysis tools.
Besides applying filters to all analysis tools by using the Apply as Filter function in an analysis tool, you can also
use the global filter in the Explorer. For more information, see Explorer Global Filter [page 48].
Note
The tabs are only displayed when you have added at least two analysis tools to the Explorer.
Add Evidence (Relevant for notifications, work orders, and indicator chart)
Add evidence enables you to identify, monitor, and manage an equipment issue early. To analyze an issue, you
need to gather information or 'evidence'. This evidence is collected in improvement requests. You can add an
Unit of Measure (UoM) Conversion (Relevant for indicator chart and equipment indicators)
In the SAP Fiori launchpad, you can define if the unit of measure system for the application is metric (default)
or imperial. To change the unit of measure, go to the (User Actions Menu). Choose Settings Unit of
Measure .
UoM conversion deals with conversion of values across units within a dimension, and a source unit is converted
to a target unit. For example, if the unit system is metric and dimension is length, any source unit (miles) must
be converted to target unit (kilometers).
To activate automatic data refresh and define the refresh interval, go to (User Actions Menu). Choose
Settings Automatic Data Refresh . Once you have activated and defined the automatic data refresh, the
Explorer initiates the data refresh on the analysis tools based on the defined refresh interval. The last refreshed
date and time is then displayed at the top of the Explorer. If you add or delete any analysis tool, the closest
refresh cycle is reset, and the refresh interval starts again.
For the analysis tools, Indicator Chart and Alerts, the automatic data refresh is also applied in the Equipment
application. For more information about viewing Indicator Chart and Alerts, see Viewing Time Series Data
(Indicator Chart) of an Equipment [page 122] and Viewing Alerts of an Equipment [page 121].
The manual and automatic data refresh features result in refresh of all analysis tool with its data from the
database. Depending on the analysis tool, its variant settings, the number of records the analysis tool need to
fetch, and overall system load, the time to complete the refresh may differ. If for a scenario, the time to refresh
all the analysis tools take 3 seconds, and the refresh rate is set to that interval or shorter, for instance, 1 second,
a continuously refreshing analysis tools will be visible
And, during the refresh, a major area of an analysis tool will not be functioning.
To trigger an automatic refresh, set a higher refresh rate, for instance a minute. Observe the time it takes to
refresh the data. This will also indicate the lowest refresh rate you should use. For example, if the refresh takes
3 seconds, you can trigger an automatic refresh rate not lesser than 5 seconds.
You can display the health score information by clicking on an indicator value link in the Equipment Indicator
analysis tool.
Languages
For information on the supported user interface (UI) languages, refer SAP Predictive Asset Insights [page 7].
Prerequisites
At least one analysis tool variant has been configured by an administrator or the respective preconfigured
variant is available. For more information about the configuration, see Explorer and Analysis Tools
Configuration [page 489].
Context
To analyze data of your equipment, you need to add analysis tools to the Explorer.
Procedure
1. On the SAP Fiori launchpad, go to the Analytics group and open the Explorer application.
2. At the top of the Explorer, choose Manage Tools.
Note
The transformer health analytics analysis tool has only one variant. That means that for this analysis
tool, you cannot expand the dropdown list and select a different variant.
6. From the My Views dropdown list, select the desired analysis tool variant. You can choose from all
configured variants.
7. If required, repeat step 5 and 6 for all your added analysis tools.
Results
You can navigate between the analysis tools by using the anchor navigation (tabs).
Note
The tabs are only displayed when you add at least two analysis tools to the Explorer.
Related Information
This topic describes how to remove analysis tools from the Explorer.
Context
At least one analysis tool has been added to the Explorer. For more information, see Adding Analysis Tools to
the Explorer [page 19].
1. On the SAP Fiori launchpad, go to the Analytics group and open the Explorer application.
2. At the top of the Explorer, choose Manage Tools.
The Analysis Tools Catalog with the selected analysis tools is displayed.
3. In the Analysis Tools Catalog, deselect the analysis tools that you want to remove from the Explorer.
Results
You can later add the removed analysis tools to the Explorer again.
Related Information
This analysis tool enables you to visualize data across one or more indicators with the same unit of measure
across multiple hierarchies. You can also view thresholds related to an equipment and functional location.
By default, the chart is empty on navigating to this section. Using the Apply as Filter option, you now visualize
data related to a functional location. Use the Select Indicators option to select or deselect the indicators.
Note
● Alerts, notifications, work orders and indicator forecast are not displayed in the indicator chart in
Explorer
● Legends display equipment name in Explorer
● The Indicator Chart pop-up displays Alert Description.
For more information on features within the indicator chart, refer Features in Indicator Chart [page 51]
Related Information
This analysis tool displays a list of the current alerts that are triggered by equipment events or rules defined for
sensor data and health scores.
Alerts calculated from sensor data or health scores give you information about the issues your equipment or
functional locations (technical objects) are experiencing. Within the alert analysis tool, you can display an alert
page that contains the alert details and additional information. The information provided helps you to decide on
prescriptive maintenance and helps to identify potential actions to be taken for the incoming alerts.
Note
Alerts Analysis Tool supports Planning Plant, Planner Group and Maintenance Plant fields.
As soon as a notification status is set as complete, the alerts associated with the notification is also set as
complete. This occurs only if the alert type for an alert has the auto close option enabled.
Display list of alerts You can display the alert list in one of the following ways:
Display Alert Page with additional alert information Click an alert in the alert list to navigate to the Alert Page
[page 26].
View related top technical object/technical object Click the Top Equipment/ Top Functional Location or Equip
ment/ Functional Location link to view details about the top
technical object or technical object for which the alerts were
created.
Information on alert occurrence The following alert occurrence information is available in the
alert list:
● Column Created On: When did the alert occur for the
first time?
● Column Updated On: When did the alert get last up
dated?
Note
Once the deduplication period is completed or the exist
ing alert with the specific alert type for this piece of
equipment is set to Completed, a new alert instance is
generated. This definition is not valid for alerts that ex
isted before the deduplication period was defined for
this alert type. For more information, see Alert Dedupli
cation [page 26].
Sort and filter alerts Sort and filter the alerts and columns you want to display.
You can also use the Settings option to search for attributes
for the alerts.
Filter Use the Filters option to enable filter settings, view default
settings defined in the configuration screen, add and edit fil-
ters, and define whether these filters are shown in the filter
bar. Click Go to apply the specified filters. You can also use
the Show Filter Bar option to edit the filter and filter condi
tions.
Overview of available features Some features (for example refreshing data automatically or
manually, filtering or default variants) are relevant for the Ex
plorer in general or relevant for all analysis tools. For more in
formation, see Explorer [page 13]and Analysis Tools [page
15].
User Authorization configuration The alert analysis tool complies to user and network authori
zation configuration for Equipment and Alert Type.
Note
This is displayed only when language specific descrip
tions are maintained in asset central foundation.
Create alert for technical object Create alerts for functional locations by using machine
alarms and display the functional locations in different appli
cations.
Violated and Related Indicators Violated indictators are indicators that are used in rules con
ditions and these conditions are true in rule evaluation.
Custom fields Custom field values are available in addition to the standard
fields that are delivered by SAP. This includes the following:
Prerequisites
To be able to perform the activites described below for alerts, you need the following roles:
● Role AlertProcessorAdmin: Users can change the alert status, create notifications and set/change the
processor.
● Role AlertProcessor : Users can change the alert status, create notifications, but cannot assign an alert to
processors.
Button Contents
Set in Process Change alert status to in process or completed using the re
spective buttons.
Set to Completed
When you set an alert to in process, you are automatically
assigned as the processor.
Note
If you select more than 10 alerts at one time, the Set in
Process and Set to Completed buttons will be disabled.
Set Processor Use the Set Processor button to change the alert processor.
Note
If you select more than 10 alerts at one time, then the
Set Processor button will be disabled.
Create Notification Create a new notification for the selected alerts. The new no
tification added is visible as link in the alert list and on the
alert page. Click the Notification link to view more details
about the notification.
Note
You can create notifications for multiple alerts, only if
the alerts belong to the same equipment. If not, the
Create Notification button will be disabled.
Invitee will see alerts only for the equipment and alert types that are shared by premium users.
Related Information
Deduplication option allows the user not to create duplicate alerts for an existing alert type and equipment.
New alerts can be generated once the deduplication period is over or the status of existing alert is set to
Completed.
Procedure
1. Define deduplication in alert type - Define alert deduplication at the alert type level using the Templates
application. For more information, refer Adding Alert Types [page 285]
2. Assign alert type to model - Alert type must be grouped as alert type group and assigned to model. For
more information, refer Assigning Alert Type Groups to a Model [page 144]
3. Create alerts - Create alerts for the alert types.
4. View alerts - View alerts for a list of equipment in the Equipment application or Explorer. For more
information, refer Viewing Alerts of an Equipment [page 121] and Alerts [page 22]
You use the alert page to see an overview of data associated with a selected alert.
You can access the alert page with its holistic view of different information by clicking an alert in the alert list.
For more information about prerequisites and available functions for alerts (for example changing the status of
alerts, setting processors), see Alerts [page 22].
Note
● For an alert of a functional location, the Information Section and Indicator Chart is available.
● For an alert of a Functional Location, Indicator Chart is displayed in the Alert page.
Information Shows information about the alert (such as alert type, pro
cessor, origin of the alert, alert occurrence and last alert oc
currence), and information about the related piece of equip
ment or functional location, and the notifications. If a notifi-
cation has been created for the alert, you can click the notifi-
cation to display details.
Indicator Chart Indicator chart will be the default section displayed in the
alert details page.
The default time period for the indicator chart in alert details
page can be configured in the indicator chart variant. The
first time period configured in the indicator chart variant will
be used as the default one.
Note
Depending on your configuration settings, additional
alert attributes are displayed in one or more tabs next to
the indicator chart.
Failure Modes and Causes This section shows failure modes and causes, alert types
and instructions related to the piece of equipment (asset).
The information helps you to understand which failure
modes occurred for the particular alert and helps you to de
cide how to proceed with an alert.
Example
In this example, the highlighted failure modes (failure
mode 1 and failure mode 6) are displayed.
● Failure mode 1
● Failure mode 3
● Failure mode 4
● Failure mode 6
● Failure mode 1
● Failure mode 2
● Failure mode 5
● Failure mode 6
Note
The ranking of Failure Modes and occurrence is
displayed only if Failure Model Analytics is
available and the required role is assigned to
the user.
Equipment Maintenance History The maintenance history for the piece of equipment shows
an overview of what maintenance has taken place for the
piece of equipment up to now. The notifications/work orders
of the most recent top 3 alerts assigned to the related piece
of equipment are shown and ordered by creation date. The
most recent one is shown first. You can navigate to the notifi-
cations and work orders and display them to see details.
Which top 3 alerts are relevant? All alerts for the related
piece of equipment for the last 365 days until now are taken
into account. All alerts for which a notification has been cre
ated, and to which the same alert type has also been as
signed, are relevant for display. The notifications/work or
ders of the 3 most recent alerts are then displayed in the
Equipment Maintenance History section.
Example
You display the alert page with detailed information
about an alert. Alert type ABC is assigned. In this exam
ple the highlighted notifications and work orders are
shown as top 3.
Related Information
This analysis tool provides a list of equipment and functional locations (technical objects) with their indicators,
attributes, and master data. You can also assess the technical object status.
It is also possible to view technical objects, their heirarchy, attributes, and indicator by navigating to the details
page of a piece of equipment or functional location. The Apply as Filter option also provides the flexibility to
filter all analysis tools in the Explorer.
Note
The indicator value is not in real time. A job, which is scheduled every 15 minutes, pulls the data from the
timeseries store that is displayed in the Equipment Indicator analysis tool.
Note
The equipment indicator only shows equipment where Predictive Maintenance is selected as the product
relevance or no product relevance is selected.
Columns
The columns marked as default while configuring a variant by the administrator display in this analysis tool.
Choose the Settings option and either select or deselect the required columns from the available list. Use the
move up and down option to change the column position. You can restore the previous position of columns.
On clicking an indicator, additional information of that particular indicator displays. For more information, refer
Analysis Tools [page 15]
You can sort the technical objects in an ascending or descending order. Possible to filter technical objects
according to all selected filters. By default, the list of technical objects and their columns in this analysis tool
are sorted and filtered according to sort and filter defined in the configuration variant.
Note
● The search, sort, and filter options will display only the columns configured in the variant by the
administrator.
● The attributes of data type Currency are treated as strings in equipment indicators and all the
operation on the field will work as string operations.
Apply Filter
The Apply as Filter option provides the flexibility to filter all the analysis tools in the analysis tool catalog
according to the selection in the Equipment Indicators
Select the Reset Global Filter option to reset your filtered selection in the analysis tool
Search
Using this analysis tool, you can search for technical objects, their master data, attributes, and indicators.
The Equipment indicator tool displays the indicator values in the display UoM.
The numeric values displayed in the equipment indicators complies with the unit system configured in the SAP
Fiori launchpad. Choose Unit of Measure Variant in the Settings option of the SAP Fiori launchpad to
personalize. For more information on UoM, see Analysis Tools [page 15]
Auto Refresh
Possible to refresh data automatically. For more information, refer Analysis Tools [page 15]
Indicator Threshold
Using this analysis tool, it is possible to visualize the indicator threshold range where in the indicator value lies.
These thresholds are visible as colored icons on the page. The indicator thresholds are configured in the
Indicators application. For more information, refer Adding Indicator Groups and Indicators [page 273]
Invitee will be able to see only the shared equipment and its shared indicators and attribute values.
Related Information
3.1.1.6 Notifications
We use the term notification to describe an object created in a back end system (for example, Enterprise Asset
Management) that has been replicated into SAP Predictive Asset Insights and is visible in the Notifications
analysis tool. You use this analysis tool to view notifications for all equipment.
● Click a notification in the notification list to view details. You can view details such as failure modes and
causes
● Click the Equipment, Top Equipment, Equipment Description, and Top Equipment Description links to view
details of the top equipment and equipment for which the notifications are created. Details are available in
the Equipment page. For more information, refer Viewing and Creating Equipment Notifications [page 123]
● View the progress of notifications, defined as Planned, Pending, and Completed
○ Planned: All notifications with the basis start date greater than the current date
○ Pending: All notifications with the basic complete date greater than the current date or all notifications
with the basic start date lesser than the current date
○ Completed: All notifications with the status Completed or Closed
● Create a new improvement request or edit an existing improvement request using the Add Evidence
button. You navigate to the Improvement Request page. For more information, refer Creating an
Improvement Request [page 82] and Emerging Issue Detection (EID) [page 79]
● Create a new notification and assign it to a top equipment. You can provide additional information such as
type, priority, and description. The newly added notification displays as Notification among the attributes.
Click the Notification to view more details about the notification.
● Use the Filters option to enable filter settings, view default settings defined in the configuration screen, add
and edit filters, and define whether these filters are shown in the filter bar. Click Go to apply the specified
filter(s). In addition, you can also use the Show Filter Bar option to edit the filter and filter conditions
● You can filter Notifications by Date or Date Range. However, the equal (=) operation is not supported to
filter the Date fields.
● Using the Settings option, sort and filter notifications. In addition, search the attributes for a notification
● Automatic or manual refresh of data. For more information, see Analysis Tools [page 15]
Related Information
● In the Alerts analysis tool, select one or multiple alerts and create a notification. The notification ID is
updated and you can navigate to view further details of the notification
● In the Notifications analysis tool, create new notification for a piece of equipment. The newly created
notification appears in the analysis tool and you can navigate to view more details
● On the Equipment page, navigate to the alerts view on the Monitoring tab. Select one or multiple alerts and
create a notification. The notification ID is updated in the alerts view with the status. You can navigate to
view more details
● On the Equipment page, navigate to the notifications view on the Maintenance and Services tab. In this view
choose Manage Notification to create a new notification for a piece of equipment. The newly created
notification is displayed in the notification view. You can navigate to view more details
Note
The notifications are saved in SAP Predictive Asset Insights. They can be pushed to the back end
system using the integration possibilities.
Related Information
We use the term work order to describe an object created in a back end system that has been replicated into
SAP Predictive Asset Insights and is visible in the Work Orders analysis tool.
Using this analysis tool, you can perform the following functions:
● Get an overview of all existing work orders, or just those for a particular top equipment by selecting it and
choosing Apply as Filter. Alternatively you can view the work orders for just one piece of equipment when
using this analysis tool on the Equipment List page.
● Get more information about the work order, for example, view details such as associated documents and
spare part details. Your administrator can configure tabs and organize the information you would like to
see, for example, the service organization or group of subject matter experts to which the work order is
assigned (planner group).
● On clicking the Equipment, Top Equipment, Equipment Description and Top Equipment Description link, the
details of the equipment for which the work order is created displays in the Equipment page. For more
information, refer Viewing Work Orders of an Equipment [page 125] and Equipment Page [page 58].
● View progress of work orders, that is, Planned, Pending, and Completed.
○ Planned: All work orders with the basic start date greater than the current data
○ Pending: All work orders with the basic end date greater than the current date or all work orders that
have start date lesser than the current date
Related Information
3.1.1.8 Map
This analysis tool provides a geographic map with the locations of equipment and functional locations
(technical objects) and allows you to select indicators and apply their colors to the map markers. It also allows
spatial selection.
You can use the map to display where the technical objects are located and analyze them on a map.
Note
On the map, you can use different layers to display specific types of equipment and the functional locations.
The following example displays three different layers in one map as follows:
You can hover over a marker to view information about the top equipment or top functional location that is
represented by that marker. The following information is displayed:
● Technical object ID
● Technical object description
● Model description
Note
If you hover over a line or polygon, the technical object ID, technical object description, and model
description are not displayed.
If you want to get more information, you can choose a marker or line. The details include links to the
Equipment, Model or Indicator detail pages.
Note
If a line is fully covered by a polygon, you cannot choose it to show the details.
Also, markers can be visualized by different indicators that you create in Indicators section of the Templates
application, for example, Bearing Temperature. In general, all markers on the map are displayed in blue. When
you select an indicator, only the relevant top equipment and top functional locations for this indicator are
● Yellow: Warning
● Red: Critical
● Grey: Unknown
Additional details about the indicator can be seen by choosing a marker. The details include, for example, the
indicator value, color, threshold, a link to view indicator details, and more. If you have questions about
indicators for your business scenario, ask your administrator.
Note
The map only correctly displays data for an indicator that is assigned to a single indicator group. If an
indicator is assigned to two indicator groups, and both groups are assigned to the same model template,
the data is not displayed correctly. If your data is displayed incorrectly, contact your administrator who can
ensure that indicators are only assigned to one indicator group or that indicator groups are only assigned to
one model template.
Map Views
You can switch between different map views by hovering over . By hovering over this icon, the related models
are also displayed, and you can focus your analysis by selecting or deselecting models.
You can choose from multiple map views if these are configured accordingly by your administrator. If you have
questions about the map views for your business scenario, ask your administrator.
Note
The map views list does not have a scroll bar. That means if you have a list with multiple map views and
models, you only see the map views and models, which are located within the display size of the map. If the
list is longer than the display size of the map, you cannot see all map views and models. Therefore, we
recommend to limit the list of map views and models.
The following list shows some sample map views that can be configured:
● Streets
● National Geographic
Features
Zoom In and Depending on which area you want to focus, you can zoom in and zoom out by:
Zoom Out
● Using the corresponding buttons
● Using the mouse wheel
Spatial
Note
Selection
If you want to draw geofences using a touch-enabled device, consider that the touch
feature does not work in Internet Explorer. In Internet Explorer, you need to turn the
touch feature off in your device manager and use the mouse. Depending on your device,
once you have turned the touch feature off, you may also need to do a restart so that
your change becomes effective.
Indicator You can select indicators by using the Select Indicator dropdown list to view markers by
Selection different colors and values that you created in the Indicators section of the Templates
application.
Panning the You can pan the map by dragging and dropping it. If you zoomed out to the lowest level, the
Map world maps repeat horizontally. Once you drag the map to the next map, the equipment on
the map is also moved.
Data Refresh You can refresh data automatically or manually. For more information, see Analysis Tools
[page 15].
Related Information
This analysis tool provides insights into the health status of mineral-oil filled transformers using the Dissolved
Gas Analysis (DGA) and helps you detect anomalies in the gas concentration of transformers. This helps to
reduce the risk of failure of the transformers in service.
When a transformer undergoes abnormal thermal and electrical stresses, hydrocarbon gases are produced due
to the decomposition of transformer's insulating oil. Based on the oil samples of the transformer, DGA checks
the concentration of dissolved gases in the insulating oil and detects the type and severity of fault in the
transformer. The faults are displayed using different Duval triangles.
● Duval Triangle 1
● Duval Triangle 4
● Duval Triangle 5
Each of these Duval triangles displays the concentration ratio of three different hydrocarbon gases and displays
different types of faults. The three sides of the triangle represent the gas concentrations from 0 to 100%. The
types of faults are displayed as fault zones. There are multiple thermal and electrical fault zones. Each fault
zone has a different color and name. The point where a transformer fault is plotted on the fault zones is called a
fault point. The fault points are displayed as dots in the Duval triangles.
Fault Zones
Depending on the Duval triangle and the faults, a combination of the following fault zones is diplayed:
C Thermal faults T3-C, T2-C, and T1-C Hot spots or carbonization of paper
with carbonization of paper due to thermal fault with T > 300 °C.
T3-H Thermal faults in oil only High temperature thermal fault above
700°C only for the oil and not for paper.
Duval Triangle 1
Duval Triangle 1 is the default triangle that is displayed. It is widely used to detect faults in mineral oil-filled
transformers. The triangle displays the following hydrocarbon gases:
● CH4 (Methane)
● C2H4 (Ethylene)
● C2H2 (Acetylene)
The following graphic displays an example of Duval Triangle 1. In this example, there are four transformers in
the D1, D2, T3 fault zones. The fault points are displayed as white dots:
Duval Triangle 4
Duval Triangle 4 diagnoses low temperature faults in mineral oil-filled transformers. It is used only when the
fault point falls under PD, T1, or T2 fault zones in Duval Triangle 1. The triangle displays the following
hydrocarbon gases:
The following graphic displays an example of Duval Triangle 4. In this example, there are two transformers in
the ND and S fault zones. The faults point are displayed as white dots:
Duval Triangle 5
Duval Triangle 5 diagnoses low temperature faults in mineral oil-filled transformers. It is used only when the
fault point falls under T2 or T3 fault zones in Duval Triangle 1. The triangle displays the following hydrocarbon
gases:
● CH4 (Methane)
● C2H4 (Ethylene)
● C2H6 (Ethane)
In order that your administrator can configure the analysis tool, the oil sample data needs to be available in the
system. You can then access the configured analysis tool in one of the following ways:
● From the Explorer, by Adding Analysis Tools to the Explorer [page 19].
● From the Equipment page, by choosing Analytics Transformer Health .
Depending on where the analysis tool is displayed, the analysis tool offers different features for different
analyses.
There are different features that you can use to work with the analysis tool. Some of these features are
common across the analysis tools. For more information about the common features across all analysis tools,
see Analysis Tools [page 15]. Besides this, the analysis tool offers the following features in the Explorer:
Feature Description
Select Duval triangles You can use the Duval triangle dropdown list to select the
Duval triangle that you would like to view.
View fault zone details Next to the Duval triangle, you can hover over the fault
zones in the legend to view the descriptions of the fault
zones.
View fault point details In the Duval triangle, you can hover over a fault point to
display the ID of the transformer. When you choose the fault
point, the following information is displayed:
● Equipment
● Sample Date
● Fault Zone
● Gas Concentrations
View transformer % per fault zone Next to the Duval triangle, you can view the number of faulty
transformers and their fault zones in a bar chart. Above the
chart, the total number of faulty transformers is displayed.
Each bar represents a fault zone. The percentage value
represents the distribution of the faulty transformers in a
fault zone. You can hover over the bar chart to view the
distribution of the faulty transformers across the fault
zones.
Example
Above the bar chart, the total number of faulty
transformers is three. The bar chart displays three fault
zones with a percentage value of 33,33%. The rest of
the fault zones have 0%. That means that there are
three fault zones and in each of these fault zones there
is one faulty transformer.
Select oil sample time ranges Per default, all of the oil samples are selected for the
analysis. With the All Time dropdown list, you can select the
samples for a certain time range, for example, the last five
days. The time ranges that you can select in the dropdown
list depend on the ranges that have been defined during the
configuration of the analysis tool.
Feature Description
Select Duval triangles You can use the Duval triangle dropdown list to select the
Duval triangle that you would like to view.
View fault zone details Next to the Duval triangle, you can hover over the fault
zones in the legend to view the descriptions of the fault
zones.
View fault point details In the Duval triangle, you can hover over a fault point to
display the sample date. When you choose the fault point,
the following information is displayed:
● Sample Date
● Fault Zone
● Gas Concentrations
Switch between the chart view and table view You can switch between the chart view and the table view by
View oil sample details of the transformer If you have switched to the table view, you can view the oil
sample details of the transformer in the descending order of
date. The table shows the concentration level of the
dissolved gases together with the units of the gases in parts
per million (ppm) and the fault zones of the Duval triangles.
Hydrogen, Methane, Ethane, Ethylene, and Acetylene are
mandatory gases required for calculating the coordinates
for the fault point.
In the table, the oil samples can have any of the following
statuses:
Select oil samples for Duval triangles Although, the latest valid oil sample is displayed in the Duval
triangle per default, you can also select multiple oil samples
from the oil sample details table. You can choose from all oil
samples, but only the valid oil samples will be used. When
you then switch back to the chart view, the fault zones and
fault points for the selected valid oil samples are displayed
in the Duval triangle.
View the sequence of faults If you have selected multiple oil samples in the oil sample
details table, you can view the sequence of faults in the
Duval triangle. The fault points are connected by arrows.
The direction of the arrows represents the oil sample data
trend in ascending order of date.
Related Information
The Explorer global filter is a filter function in the Explorer that enables you to filter all your analysis tools in the
Explorer based on several attributes, for example, class or location in one go.
Note
● The Explorer global filter filters based on top equipment and top functional locations. Currently, the
alerts, equipment indicators, and map analysis tools return both technical objects. The rest of the
analysis tools return top equipment only.
● The Explorer global filter filters a maximum of 10,000 top equipment across all analysis tools.
● The Explorer global filter only filters top equipment where Predictive Maintenance is selected as the
product relevance or no product relevance is selected.
For the Explorer global filter, variants can be configured by an administrator. The variants contain different
filters. When you select a variant in the Explorer, the defined filters are applied to all analysis tools in the
Explorer. When you then leave the Explorer and later open it again, the variant is selected and automatically
applied. For more information about the configuration, see Explorer and Analysis Tools Configuration [page
489].
Note
In addition to the variants configured by an administrator, we also deliver a preconfigured variant entitled
SAP Standard. This variant contains no filters so that the analysis tools show data for all top equipment and
depending on the analysis tool for all top functional locations. If your administrator has deleted this
preconfigured variant, it is not available to you.
For more information about using the Explorer global filter with variants and filters, see Using the Explorer
Global Filter with Variants [page 49] and Using the Explorer Global Filter with Filters [page 50].
Related Information
This topic describes how to use variants to filter all analysis tools in the Explorer.
Prerequisites
● At least one analysis tool has been added to the Explorer. For more information, see Adding Analysis Tools
to the Explorer [page 19].
● At least one variant for the Explorer global filter has been configured by an administrator or the
preconfigured variant is available. For more information about the configuration, see Explorer and Analysis
Tools Configuration [page 489].
Procedure
1. On the SAP Fiori launchpad, go to the Analytics group and open the Explorer application.
The Explorer global filter with the preconfigured variant is displayed. If the preconfigured variant has been
deleted, another configured variant or the last selected variant is displayed.
2. To select a different variant, expand the variant dropdown list next to the variant title.
The filters are applied to all analysis tools in the Explorer and the analysis tools show data for the same top
equipment and depending on the analysis tool also for the same top functional locations. Below the variant
title, you can view which filters are applied, for example, Model (1).
To view the number of the returned technical objects (top equipment and/or top functional locations), expand
the filter bar by choosing (Expand Header) below the Explorer global filter. You can later collapse the filter
bar again.
To reset the applied filters in the analysis tools, choose (Reset Global Filter).
Related Information
This topic describes how to select a combination of filters from scratch to filter all analysis tools in the Explorer.
Prerequisites
● At least one analysis tool has been added to the Explorer. For more information, see Adding Analysis Tools
to the Explorer [page 19].
● At least one variant for the Explorer global filter has been configured by an administrator or the
preconfigured variant is available. For more information about the configuration, see Explorer and Analysis
Tools Configuration [page 489].
Procedure
1. On the SAP Fiori launchpad, go to the Analytics group and open the Explorer application.
The Explorer global filter with the preconfigured variant is displayed. If the preconfigured variant has been
deleted, another configured variant or the last selected variant is displayed.
2. Expand the filter bar by choosing (Expand Header) below the Explorer global filter.
3. Define the filters. You can choose between the following options:
○ Select the filters and values for the filters in the filter bar directly.
○ Choose Adapt Filters and select the filters and values for the filters in the dialog box. In the dialog box,
you can also deselect filters. The filters are then hidden in the filter bar.
Results
The filters are applied to all analysis tools in the Explorer and the analysis tools show data for the same top
equipment and depending on the analysis tool also for the same top functional locations. In the filter bar, you
can view the number of the returned technical objects (top equipment and/or top functional locations).
You can also collapse the filter bar by choosing (Collapse Header). Below the variant title, the applied
filters are then displayed, for example, Model (1).
To reset the applied filters in the analysis tools, choose (Reset Global Filter).
Related Information
This analysis tool enables you to visualize data across one or more indicators. You can also view the alerts,
notifications, work orders, and threshold related to an equipment and functional location.
Variants
You can select variants created using the configuration screen. Depending on the selected variant, the default
time range and number of points on the chart varies. SAP delivers two preconfigured variants Indicator Chart -
SAP Default and Indicator Chart - SAP Default Indicators for a Model.
Note
The variant Indicator Chart-SAP Default Indicators for a Model is available only in Equipment page and
not in Explorer.
For more information, see Fields for Configuring the Indicator Chart [page 497]
You can choose the time interval for your analysis as follows:
Note
By selecting dates accordingly, it is possible to visualize work orders and notifications that are yet to be
created/added.
Add Evidence
You can create an improvement request or edit an improvement request. The selected date range in the
indicator chart and selected indicators are available within the Description tab of an improvement request. For
more information, see Emerging Issue Detection (EID) [page 79] and Creating an Improvement Request [page
82]
Select Indicators
You select, group, and sort indicators using the Select Indicators dialog box (maximum of 30 indicators). By
default, indicators set as Favorite displays. To select the maximum number of indicators for a piece of
equipment with indicators more than 30, select the checkbox in the header row. The first 30 indicators are
selected.
Depending on the indicator color selected in the Templates application, the indicator chart displays in the same
color.
Note
This feature is not enabled for the indicator chart from the Explorer.
Legend
You can reset time selections you made for the indicator chart to their initial state by choosing Reset Selection
Settings
You can decide the settings required on the chart. The following options are available:
● Indicators: Select the option to decide whether indicators must display as points or lines or as both on the
chart
● Threshold: On selecting, the primary thresholds selected in the Indicator's application displays in the
indicator. The number of thresholds defned as primary in the Indicator's application displays.
● Forecast: On selecting a duration, the forecast data for the highlighted indicator displays on the chart. The
duration starts from the day you select the duration.
● Values: Select to view a maximum or minimum value or both value of the displayed indicator points on the
chart
● Events: Select to view alerts, work orders, and notifications, if any on the chart
Autoscaling
You can scale the Y axis of the indicator chart automatically or manually. Click any of the Y axis labels to view
the Y-Axis Setting popup. Automatic scaling is activated by default. If you deselect the Default Values checkbox,
you can enter minimum and maximum values to manually scale the Y axis.
Time Selector
Using the time line selector available at the bottom of a chart, you can select a particular time period within the
time interval to narrow down your analysis and zoom into the indicator chart. The shorter the time period, the
higher the granularity of the indicator chart. You can also select a time period directly in the indicator chart. To
do so, place your cursor directly in the chart at the starting point of the time period. Then click and drag the
cursor to the end point of the time period. When you release the mouse button, the indicator chart is focused
on the selected time period.
Indicators
There are three categories of indicator in the indicator charts, that is, flow, level, and discrete. Depending on the
indicator chosen, the corresponding graph is displayed.
Note
0 Off Nil
1 On Dark shade
Note
Any other value apart from 0, 1 and 2 represents a null status and will be hatched
The mouseover for a value displays the value as a string. The strings are hard coded, but language
dependent. You can find more information on SAP Help Portal under Templates in the API Tutorial
Let's take the pump as an example. From the Select Indicators option, choose pressure (flow), waterlevel
(level), and the blower status (discrete) as the indicator.
● Flow variable: Pressure displays the line graph for values that are available within the selected range
● Level variable: Waterlevel displays the step graph for values that are available within the selected range.
● Discrete variable: Blower status displays the active (On, Off) or inactive (Idle) status of the indicator in
colors.
The legend is displayed at the side of the chart.
The indicator chart supports the forecasting of indicator values of an equipment of an equipment model. You
can select the duration for which the forecast needs to be displayed. The supported duration is one day, one
week, one month, and 3 months. The duration starts from the day you select the duration.
The indicator that is forecasted displays as a dotted line. The blue area displays the confidence interval with the
upper and lower boundry. The confidence interval also indicates how reliable the forecasting is. A small
confidence interval indicates a reliable forecasting. If no data is available for a particular time in the time range
of historical time series data, no lines displays within the indicator chart.
Prerequisite: You should configure forecasting for the indicator in the Models application. For more
information, refer Configuring Indicator Forecasting for a Model [page 147].
Note
● This feature is available only within the indicator chart in the equipment page.
● To view the indicator forecast after the configuration, the related piece of equipment needs to be
synchronized with SAP Internet of Things.
Alerts
The indicator chart visualizes alerts for the selected indicators and selected equipment hierarchy. Same type of
alerts for a top equipment or equipment aggregate within small intervals and are visible on the chart. By
default, alerts that are related to an equipment and not linked to an indicator displays in the indicator chart. On
adding the indicators, the alerts linked to the selected indicator also displays in the chart.
Alerts associated to multiple indicators are displayed in Indicator Chart in the Equipment Details page and Alert
Details page.
You can control the visibility of alerts using the Settings option.
Work Orders
The indicator chart visualizes work orders for the selected equipment or component hierarchy. Same type of
work orders for a top equipment or equipment aggregate and are visible on the chart as a line. Click the
corresponding icon to view the work order details.
Notifications
The indicator Chart visualizes notifications for the selected equipment or component hierarchy. Same type of
notifications for a top equipment or equipment aggregate and are visible on the chart as a line. Click the
corresponding icon to view the notification details.
Threshold
You can view the thresholds for the highlighted indicators in the indicator chart. The primary thresholds
selected in the Indicator's application displays on the chart. The number of thresholds defined as primary in the
Indicators application displays. By default, except for the border lines, the threshold color appears transparent.
Transparency is maintained to prevent overlapping of chart details.
Note
Thresholds are only displayed for the indicator category, Flow and Level.
The values displayed in the indicator chart complies with the unit system configured in the SAP Fiori
launchpad. Choose Unit of Measure in the Settings option of the SAP Fiori launchpad to personalize. For more
information on UoM, see Analysis Tools [page 15]
The indicator chart tool will display the indicator values in the display UoM.
The indicator chart support conversion of indicator values from one UoM to another. Click the Y axis to display
the UoM conversion popover. Once the conversion is performed for a UoM, all indicators of that particular UoM
will be converted.
Note
After the conversion, the target unit of measure will be displayed in the Y axis and tooltip. The select
indicator popup will display the previous unit of measure.
Multi Chart
Multi chart provides capability to display multiple charts and segregate indicators according to unit of measure
(UoM). Click the Multi Chart option in the indicator chart to perform this action.
When switching from regular chart to multi chart, the indicators within the indicator chart is segregarated into
multiple charts according to unit of measure. You can add or delete chart of unit of measure using the new
select indicators option. A maximum of 5 charts is supported with 6 indicators per chart. If any of the
conditions are not met, a corresponding indicator selection popup with warning message displays.
Note
Note
Any changes with respect to multi chart persists when navigating from the indicator chart to multi chart
and back only if there are no changes to the indicators.
Possible to refresh data automatically or manually. For more information, refer Analysis Tools [page 15]
Invitee will be able to see the time-series data only of the shared equipment and shared indicators.
Related Information
You use the Equipment page to get an overview of all the data associated with a selected piece of equipment.
● From the Explorer by choosing an equipment link in the Alerts, Indicator Chart, Work Orders, Notifications,
Equipment Indicator, Map, or Transformer Health Analytics analysis tools.
● From the Equipment List via the Equipment application under Master Data on the SAP Fiori launchpad.
Tab Contents
Information ● Highlights
● Data Sheet
● Model Information
● Equipment Information
● Business Partner
● Sales Organization Data
● Installation Location
● Life Cycle Information
● Systems
● Groups
Documentation ● Highlights
● Documents
● Instructions
● Failure Modes
● Alert Types
● Announcements
● Improvement Requests
● Fingerprints
Failure mode analytics uses machine learning to turn the human knowledge contained within the texts of
notifications into insights about the nature of failures. This provides you with insights and analytics about the
patterns of failures for your equipment and equipment models.
Background Information
● Failure mode analytics uses unsupervised and supervised machine learning to analyze notification texts
and extract the most related topics and words from notification texts. It then assigns them to standard
failure modes for your equipment and equipment models.
● The system uses various metrics and visualizations to provide you with insights and analytics about the
patterns of failures for your equipment and equipment models.
Example
Rose, a reliability engineer, spots a problematic asset, Pump-00554, which pumps crude through a
pipeline. She reviews its alerts in the Explorer. The alerts point towards a bearing problem, so Rose checks
on two influencing factors: the oil lubrication level, and the temperature of the inflow. She suspects that the
inflow temperature is an issue and that the root cause could be a crack in the pump casing. To confirm her
assumption, she uses failure mode analytics to get more information. The failure mode OHE (Overheating)
has the most occurrences and the MTBF (Mean-Time-Between-Failure) is 1515 hours. She views the
detailed analysis for OHE (Overheating) and the top words from the notification text data are Oil level and
Temperature High. She looks at the notification that is ranked as most relevant and sees that it was created
Related Tasks
Using Failure Mode Analytics on the Equipment or Model Pages [page 61]
Using Failure Mode Analytics in the Failure Modes Application [page 67]
Related Information
This topic describes how to use failure mode analytics on the equipment or model pages.
Prerequisites
● Failure mode analytics has been configured. For more information, see Configuring Failure Mode Analytics
[page 461].
● The roles AC_ORG_DATA_READ and APP_READ are assigned to your user.
Procedure
1. On the SAP Fiori launchpad, go to the Master Data group and open the Equipment or Models application.
2. Choose the piece of equipment or equipment model that you want to analyze.
Note
Only choose the piece of equipment for which equipment model failure mode analytics has been
configured, or the equipment model for which failure mode analytics has been configured. Otherwise,
the results are empty. If you are unsure for which equipment model failure mode analytics has been
configured, contact your administrator.
Results
The top 5 failure modes for the equipment model within the last 365 days are displayed in cards.
Note
You can also select a different time period and choose the Go button to apply your selection. Be aware that
if you, for example, select the time period from January 8 to January 9, this is a 48 hour time span, not a 24
hour time span.
The failure modes are ranked by the number of occurrences, depending on how often specific words related to
the failure mode occurred in the notifications for this piece of equipment or equipment model. You can view
details about a failure mode by choosing the failure mode description on the card. You can also display all
failure modes that are assigned to the equipment model by choosing All Failure Modes.
● The number of times this failure mode was identified in the notifications created during the time period
● For the piece of equipment, to what extent this figure compares against all notifications analyzed for the
equipment model
● The MTTR (Mean Time To Repair), MTTF (Mean Time To Failure), and MTBF (Mean Time Between Failure =
The sum of MTTR + MTTF) for each failure mode. For more information about the calculation of these KPIs,
see Calculation of Mean Time KPIs [page 63].
● For the equipment model, the top bad actors for each failure mode
Note
If there are more than 5 failure modes found for the equipment model and some failure modes were
removed from the equipment model after the configuration of failure mode analytics (after the model
scoring), the following can happen: when you switch from the top 5 failure modes cards to all failure modes,
the card data might change for the same failure mode, for example, the occurrence of the failure mode in
notifications.
Next Steps
To view the top words of a specific failure mode and the top-related notifications with their work orders, you
can now navigate to the Failure Mode Analytics application by choosing View Analytics on a failure mode card.
For more information about the results when using the application, see Using the Failure Mode Analytics
Application [page 68].
Related Information
On the failure mode cards, you can view KPIs for Mean Time to Repair (MTTR), Mean Time to Failure (MTTF),
and Mean Time Between Failures (MTBF) for each failure mode at equipment level and model level. This topic
provides you with an overview of how these KPIs are calculated including examples.
Overview
During the failure mode analysis, notifications for all equipment of a model are collected within the time range.
Based on these collected notifications, the downtimes caused by failures and the subsequent uptimes when a
failure has been rectified, can be identified. Failures are notifications with a breakdown. That means these
notifications have the breakdown attribute set to True or the notificationTypeDescription attribute set
to Breakdown. For more information about viewing the notificationTypeDescription attribute, see
Viewing and Creating Equipment Notifications [page 123]. For more information about viewing the breakdown
attribute, see Notifications.
These failures and corresponding downtimes as well as uptimes are the basis for the calculation of the KPIs for
MTTR, MTTF, and MTBF. The following graphic illustrates these dependencies:
The mean time to repair is the expected average time period that it takes to repair a piece of equipment or
model that is down because of a failure or planned maintenance. It is the downtime of a piece of equipment or
model. The KPI for this mean time is calculated as follows:
Mean Time to Repair = (The total time period when the piece of equipment or model is down for a repair
during the time range) / (the number of repairs during the time range)
The total time period when the piece of equipment or model is down for a repair during the time range is
the time period between the malfunction start date and the malfunction end date of a notification. The number
of repairs during the time range is the total number of collected notifications for which the time to repair
(downtime) is known.
You have selected 1 month as a time range for your failure mode analysis. Within this period, 1 notification
was collected. This notification has a malfunction start date at 4:30 a.m. January 1, 2019 and a malfunction
end date at 4:30 p.m. January 1, 2019.
This means that the total time period when the piece of equipment or model is down for a repair is 12 hours
and the number of repairs for which the time to repair (downtime) is known is 1. The resulting mean time to
repair is 12 hours (12/1).
Example
You have selected 2 months as a time range for your failure mode analysis. Within this period, 3
notifications were collected. For all these 3 notifications, the time to repair (downtime) is known:
● The first notification has a malfunction start date at 3:00 a.m. January 1, 2019 and a malfunction end
date at 3:00 p.m. January 1, 2019.
● The second notification has a malfunction start date at 3:00 a.m. January 2, 2019 and a malfunction
end date at 3:00 p.m. January 2, 2019.
● The third notification has a malfunction start date at 3:00 a.m. January 3, 2019 and a malfunction end
date at 9:00 a.m. January 3, 2019.
This means that the total time period when the piece of equipment or model is down for a repair is 30 hours
(12+12+6) and the number of repairs for which the time to repair (downtime) is known is 3. The resulting
mean time to repair is 10 hours (30/3).
The mean time to failure is the expected average time period between an ended failure and the next expected
failure. It is the uptime of a piece of equipment or model and a basic measure of how reliable an ideally non-
repairable system is. Furthermore, the mean time to failure is a statistical value and is meant to be the mean
over a long period of time and a large number of units. The KPI for this mean time is calculated as follows:
Mean Time to Failure = (The total time period when the piece of equipment or model is up before a failure
during the time range) / (the number of failures during the time range)
Example
You have selected 1 month as a time range for your failure mode analysis. Within this period, 2 notifications
with a breakdown were collected. For the second notification, the uptime before a failure is known. For the
first notification, the uptime before the first failure is not known:
● The first notification with a breakdown has a malfunction start date at 2:00 a.m. January 1, 2019 and a
malfunction end date at 2:00 p.m. January 1, 2019.
● The second notification with a breakdown has a malfunction start date at 8:00 p.m. January 1, 2019
and a malfunction end date at 2:00 a.m. January 2, 2019.
This means that the total time period when the piece of equipment or model is up before a failure is 6 hours
and the number of failures for which the uptime before a failure is known is 1. The resulting mean time to
failure is 6 hours (6/1).
Example
You have selected 2 months as a time range for your failure mode analysis. Within this period, 3
notifications with a breakdown were collected. For 2 of these notifications, the uptimes before a failure are
known. For the first notification, the uptime before the first failure is not known:
● The first notification with a breakdown has a malfunction start date at 2:00 a.m. January 1, 2019 and a
malfunction end date at 2:00 p.m. January 1, 2019.
● The second notification with a breakdown has a malfunction start date at 8:00 p.m. January 1, 2019
and a malfunction end date at 2:00 a.m. January 2, 2019.
● The third notification with a breakdown has as malfunction start date at 10:00 a.m. January 2, 2019
and a malfunction end date at 1:00 p.m. January 2, 2019.
This means that the total time period when the piece of equipment or model is up before a failure is 14
hours (6+8) and the number of failures for which the uptime before a failure is known is 2. The resulting
mean time to failure is 7 hours (14/2).
The mean time between failures is the expected average time period between the last failure and the next
upcoming failure. It is a measure of how reliable a system is. The KPI for this mean time is calculated as follows:
Mean Time Between Failures = (The total time period between two subsequent failures during the time
range) / (the number of failures during the time range)
The total time period between two subsequent failures during the time range is time period between the
malfunction start date of a previous notification with a breakdown and the malfunction start date of the next
notification with a breakdown. The number of failures during the time range is the total number of collected
notifications that have a breakdown and for which the time period between two subsequent failures is known.
Example
You have selected 1 month as a time range for your failure mode analysis. Within this period, 2 notifications
with a breakdown were collected. For the first notification, the time period between the subsequent failures
is known. For the second notification, the time period between the subsequent failures is not known as the
next failure has not yet started:
● The first notification with a breakdown has a malfunction start date at 8:00 a.m. January 1, 2019 and a
malfunction end date at 1:00 p.m. January 1, 2019.
● The second notification with a breakdown has a malfunction start date at 5:00 p.m. January 1, 2019 a
malfunction end date at 2:00 a.m. January 2, 2019.
This means that the total time period between subsequent failures is 9 hours and the number of failures for
which the time period between the subsequent failures is known is 1. The resulting mean time between
failures is 9 hours (9/1).
Example
You have selected 2 months as a time range for your failure mode analysis. Within this period, 3
notifications with a breakdown were collected. For 2 of these notifications, the time period between the
subsequent failures is known. For the third notification, the time period between the subsequent failures is
not known as the next failure has not yet started:
● The first notification with a breakdown has a malfunction start date at 8:00 a.m. January 1, 2019 and a
malfunction end date at 1:00 p.m. January 1, 2019.
● The second notification with a breakdown has a malfunction start date at 5:00 p.m. January 1, 2019 a
malfunction end date at 2:00 a.m. January 2, 2019.
● The third notification with a breakdown has as malfunction start date at 10:00 a.m. January 2, 2019
and a malfunction end date at 2:00 p.m. January 2, 2019.
This topic describes how to use failure mode analytics in the Failure Modes application.
Prerequisites
● Failure mode analytics has been configured. For more information, see Configuring Failure Mode Analytics
[page 461].
● The roles AC_ORG_DATA_READ and APP_READ are assigned to your user.
Procedure
1. On the SAP Fiori launchpad, go to the Master Data group and open the Failure Modes application.
2. In the Failure Mode List window, select the failure mode that you want to analyze.
3. Choose the ANALYTICS tab.
4. Select the equipment model to which the failure mode belongs.
Note
Only choose the equipment model for which failure mode analytics has been configured. Otherwise,
the results are empty. If you are unsure for which equipment model failure mode analytics has been
configured, contact your administrator.
5. Choose Go.
Results
The failure mode analysis is complete and the following results are displayed:
Related Information
This topic describes how to use the Failure Mode Analytics application.
Prerequisites
● Failure mode analytics has been configured. For more information, see Configuring Failure Mode Analytics
[page 461].
● The role APP_READ is assigned to your user.
Note
If the required role is not assigned to your user, you cannot see the application on the launchpad.
Contact your Identity Management Administrator if the role has not been assigned to your user yet.
Procedure
1. On the SAP Fiori launchpad, go to the Analytics group and open the Failure Mode Analytics application.
2. Select the equipment model that you want to analyze. You can choose from all equipment models for
which failure mode analytics has been configured.
Results
The failure mode analysis is complete and the following results are displayed:
● In the Top words bar graph, the most frequently occurring words found within the notifications for the
selected failure mode and equipment model are displayed. This helps you to see if there is a term that
seems relevant to the issues you may have with the related equipment. The top words are ranked by
relevancy. The ranking contains values from 1 as the most relevant, to 0 as the least relevant.
● In the Top Notifications table, the top-related notifications for the top words are displayed. This helps you to
find a solution for your issues. The top notifications are ranked by relevancy, and likelihood of belonging to
a failure mode. The ranking contains values from 1 as the most relevant, to 0 as the least relevant. The
colors for the ranking are provided in three groups:
○ Green scores = 0.670 to 1
○ Yellow scores = 0.340 to 0.669
○ Red scores = 0 to 0.339
You can view details of a notification by clicking the notification link.
● Under Related Order in the Top Notifications table, the work orders for the notifications are displayed. From
the work orders, you can derive the actions taken for equipment of the same equipment model. You can
view details of a work order by clicking the work order link.
Related Information
This app is personalized to be a one-stop point to navigate to the applications, your frequently viewed items of
equipment, favorites, and unread announcements.
● Overview: Contains a search bar to find objects from applications such as Equipment, Models, and
Instructions.
● Applications: Allows you to navigate directly to applications from this section.
Note
Analytics dashboards visualize data, for example, by using interactive charts or tables. This provides you with
insights and allows you to analyze and explore your data.
The source of the analytics dashboards are stories from SAP Analytics Cloud. A story is a presentation-style
report that uses charts, visualizations, text, images, and pictograms to describe data. You can embed the
stories as analytics dashboards in SAP Predictive Asset Insights. The following graphic displays an example of
a story:
You have two options how you can create dashboards. You can use both options in parallel. The following
graphic displays the options:
Note
The custom live option is only available with Amazon Web Services (AWS).
You can use the custom live option. This option is useful if you want to combine data from SAP Predictive Asset
Insights with other data to do own calculations, and so on. The data from SAP Predictive Asset Insights
includes the following:
● Master data: Most of the attributes for equipment (including custom attributes), models, locations,
installation locations, notifications, and alerts
● Time series data: Non-numeric indicators, hourly aggregated data for numeric indicators, and last
indicator values
You can use the data live in the dashboard. Any data changes are reflecting in your dashboard. To use this
option, you need your own SAP HANA database and access to SAP Analytics Cloud.
Custom Offline
There is also the option to copy data from SAP Predictive Asset Insights. This includes the following data:
● Header data of equipment (without custom attributes), models, locations, spare parts, notifications, and
work orders
● Last indicator values
This option is useful to include spare parts in the dashboard. Any data changes are not reflecting in your
dashboard unless you schedule a data replication job. To use this option, you need access to SAP Analytics
Cloud.
For more information about the technical requirements to use the options, see Enabling Analytics Dashboards
[page 468].
You can view the dashboards in multiple applications. This includes the following:
● Dashboards in the Analytics Dashboards application: With these dashboards, you can view analytics on
data that is related to multiple objects, for example, for all equipment or models with their related data like
notifications.
● Dashboards on object pages: With these dashboards, you can view analytics on data that is related to a
single object, for example, one piece of equipment or one model. One analytics dashboard is displayed per
object. The objects include:
○ Equipment
○ Models
○ Locations
○ Spare Parts
Note
To analyze and explore your data, you can perform different actions in the dashboards. Possible features are,
for example:
● You can filter table cells or chart data points or exclude non-relevant cells / data points.
● You can interactively select for a chart by which attributes the data should be reduced.
● You can show top or bottom ranked elements in a chart.
● You can add a reference line or trellis chart in a chart.
For more information about all available features, see the SAP Analytics Cloud documentation.
Related Tasks
Prerequisites
All configuration steps to enable the creation of custom dashboards in SAP Predictive Asset Insights have been
completed. For more information, see Enabling Custom Live Dashboards [page 471] and Enabling Custom
Offline Dashboards [page 476].
Procedure
The Dashboards screen is displayed. The screen lists all available dashboards.
Note
You can use all characters, except for \, :, and *.
Data Source Select where the data for the dashboard should come
from. You can choose from the following options:
○ Custom Live: If you select this option, the dashboard
includes "live" data from SAP Predictive Asset
Insights together with your own data.
○ Custom Offline: If you select this option, the
dashboard includes copied data from SAP Predictive
Asset Insights
For the users of the application who later view the
dashboards in the list, the data source is only for
informational purposes to understand whether the data
of the dashboard is live or offline, for example, for offline,
the data refreshes only after a replication.
Story URL Paste the URL of your story from SAP Analytics Cloud.
Note
Consider the following:
○ For each of the object pages, you can choose
one dashboard. If you later edit a custom
dashboard or create a new custom dashboard
and you select an object page for which a
dashboard is already chosen, the already
existing dashboard for this object page will be
replaced with the new dashboard.
○ Spare parts are only available for custom offline.
This means, if you select spare parts for custom
live dashboards, no data will later be displayed
on the respective object page.
Data Model ID (Only displayed when you have selected an Paste the model ID of your story from SAP Analytics
object page from the dropdown list) Cloud. The model ID filters the story data by a specific
object, for example, a piece of equipment.
To paste the model ID, open SAP Analytics Cloud and add
the string /api/v1/stories?include=models to
the domain of the URL.
Example
https://<domain>/api/v1/stories?
include=models
Dimension (Only displayed when you have selected an Enter the dimension of your object. The dimension is the
object page from the dropdown list) ID of your object and filters the story data by that ID, for
example, for the specific piece of equipment.
You can enter the following dimensions:
○ For custom live, the dimension is based on the
internal ID column name, for example,
EQUIPMENT_INTERNALID for equipment.
○ For custom offline:
○ internalId for equipment, models, and
locations
○ sparepartinternalID for spare parts
4. Choose Save.
Results
Related Information
Prerequisites
The Dashboards screen is displayed. The screen lists all available dashboards.
2. From the list, choose the dashboard that you want to view.
Results
You can later close the dashboard by choosing the back button on the screen.
Prerequisites
Procedure
1. On the SAP Fiori launchpad, open the application for which you want to view the dashboard. Depending on
the dashboard, you can choose between the following applications:
○ Equipment application
○ Models application
○ Locations application
○ Spare Parts application
Tip
You can also navigate to the equipment page from the Explorer. For more information, see Explorer
[page 13].
Note
If the tab for the analytics dashboard is not displayed, choose (Configure Sections) and activate the
checkbox for Analytics Dashboard. For some of the object pages, the checkbox is within the Analytics
checkbox. In this case, activate both checkboxes. The roles that are required to configure the sections
are listed in the prerequisites.
Results
Prerequisites
Procedure
The Dashboards screen is displayed. The screen lists all available dashboards.
2. From the list, select the dashboard that you want to edit.
3. Choose Edit.
The Edit Dashboard dialog box is displayed.
4. In the dialog box, change the required fields.
For more information about the fields, see Creating an Analytics Dashboard [page 73].
Note
5. Choose Save.
Results
Prerequisites
Procedure
Results
Emerging Issue Detection (EID) enables you to identify, monitor, and manage an equipment issue early. As part
of this process, you gather information such as issue history, relevant documents, and investigation details that
will help to make a more detailed analysis of the issue.
The evidence is collected in an improvement request [page 82], using the Add Evidence button.
During your evidence collection, you can create a new improvement request or edit an existing improvement
request. You can manually collect the evidence related to an issue and attach it to an improvement request
using the following analysis tools:
● Indicator Chart
Related Information
The tiles under Processes on the SAP Fiori launchpad give you access to the various business processes
offered by SAP Predictive Asset Insights.
Overview of Processes
Tile Use
Improvement Requests [page 80] Get suggestions or a solution for an equipment issue by cre
ating an improvement request.
Obsolescence Management [page 87] A report that graphically illustrates deadlines for manufac
turer support for a model or a piece of equipment.
Lookup [page 88] Search for error codes and look up related information for an
equipment or a model.
Smart Matcher [page 90] Use this application to assign models to a lean (equipment
with no model assignment to it) equipment.
Work Orders [page 91] View a list of work orders. A work order is an order, which
specifies a task to be carried out on the equipment.
While using an equipment, you could face issues with regard to its process or maintenance. To get suggestions
or a solution, you can create an improvement request. By creating this request, you involve the relevant
stakeholders who can collaborate and provide you with a suggestion or even a solution.
If stakeholders within your organization can resolve your request, create an internal improvement request. If
you want to involve stakeholders outside your organization, create an external improvement request.
● Requester: The user who requests for a suggestion or a solution by creating an improvement request.
● Reviewer: The user who reviews the improvement request sent by the improvement requester.
● Provider: The user who suggests a solution for the improvement request sent by the requester.
Note
The user who is currently processing the improvement request is referred to as the Processor. The
processor can be the requester, reviewer or the provider.
Using the Improvement Requests application, you can perform the following tasks:
Status Description
OR
Author Action The provider sends the improvement request to the reviewer
or requester for more details.
Confirmed The reviewer has closed the case after it was processed by
the provider.
You create an improvement request when you want suggestions or solutions about a piece of equipment, its
process, or maintenance.
Procedure
Note
e. Choose a priority
f. Select a reviewer to review your improvement request.
g. Select a provider who can provide a resolution to your improvement request.
h. Choose OK.
4. To add one or more items of equipment, choose Edit→ Affected Equipment and perform the following tasks:
a. Choose Add
b. Select one or more items of equipment
c. Choose Assign
5. To add additional information to the case, choose Request Description and provide the necessary
description of the case in the Description text box.
6. To assign instructions to the case, choose Request Instructions and perform the following tasks:
a. Choose the Assign button in the Instructions section.
b. Select one or more instructions from the Select Instructions popup.
c. Choose Assign in the popup.
7. To add additional information to the case using documents, choose Request Documents and
perform the following tasks:
As an reviewer, you perform this procedure to review an improvement request created by an requester.
Context
The system displays the Improvement Requests window with a list of existing cases.
2. Choose a request from the improvement requests list, or search for a request that you want to review.
3. You can modify information in the request as necessary and add comments in the comments section to
enhance the information required for the processing the request.
4. To submit the request to a provider, choose Submit.
○ To request additional information from the requester, choose Send to Requester for Update.
You perform this task to provide a suggestion or a solution to an improvement request created by a requester,
or submitted by a reviewer.
Context
As a provider, you have a request assigned to you that requires resolution either by the reviewer or by the
requester.
Procedure
1. Open the Improvement Requests application. The system displays the improvement requests window
with a list of existing requests.
2. Choose a request from the improvement requests list, or search for a request that you want to resolve.
3. To process the improvement request, choose In Process.
4. To provide a solution for the request, add comments or documents, as required, in the Recommendation
section.
5. Choose Completed.
As an requester or a reviewer, you can resubmit an improvement request to the provider for further processing.
As an reviewer, you can confirm a request after the provider has provided a recommendation or rejected the
improvement request.
Context
You have received an improvement request that either has a recommendation from a provider, or has been
rejected by the provider.
Procedure
The system displays the Improvement Cases window with a list of existing cases in statuses
Recommendation Provided or Rejected.
2. To add any additional comments, choose Edit.
3. For an improvement request in status Recommendation Provided, choose Confirm to close the request.
○ For a rejected improvement request, you can perform either of the following:
○ Choose Confirm Rejection to close the rejected request.
○ Choose Resubmit to Provider to resubmit the request.
You perform this activity if you need more information about an improvement request after a recommendation
has been provided or the case has been rejected by the provider.
Prerequisites
As a reviewer, provider or requester you might want to see the improvement requests based on certain filters.
Context
The user has an easier way to see the requests based on different statuses and roles.
Procedure
1. Open the Improvement Requestsapp and view the list of the requests. Now, you want to see the requests
that you need to process as a requester.
2. Choose For Processing in the drop down next to the table.
3. Choose <My Processing Role> from the filter bar. Automatically, the request list will be filtered out
based on the statuses set on the filter bar.
You can delete an improvement request that you no longer want to have on the network.
Prerequisites
Results
You can view the improvement request in the list screen with status as Deleted.
Note
An application that graphically illustrates deadlines for manufacturer support for a model or a piece of
equipment. These deadlines pertain to:
For more information, refer to Viewing the Obsolescence Management [page 87].
You use this application to visualize models that will be obsolete in the next 3 years and affected equipment.
Procedure
Note
The report displays information for every month in the time period that you have selected.
Results
You see a graphical representation of the number of models and items of equipment that are due for expiry for
your given time period.
Note
The tabular view below the graphical representation displays information about the Model Count and
Equipment Count that are clickable links. Clicking on the Equipment Count, you can navigate to the
equipment list. You can select equipment from the list to view the details page.
You have an option in the chart tool bar to view this data in the following views:
For chart view, you can use Select Chart Type to visualize the data in different chart types, for example, line
chart, bar chart, and so on.
By default, the chart view displays data based on month/year dimension. You can also add additional
dimensions to drill down the data using the View By option on the chart tool bar.
You can select a segment from the interactive chart and use the Details option on the chart tool bar to view
details of the selected option. You can personalize the data in the chart using the Settings option from the chart
tool bar.
You can opt to view all the details in the tabular view or details of only the selected segment from the interactive
chart by using the options from the table tool bar. You can personalize the data in the table using the Settings
option from the table tool bar.
4.3 Lookup
You use this app to search the error code and look-up related information for an equipment or a model.
Lookup application also allows you to find troubleshooting information for an equipment or a model. You can
use the Scan Bar Code option to find the equipment and its details.
You can use the look-up option to search for a model or a piece of equipment. Manufacturers can maintain
error codes on the model level:
● Error code descriptions and failure modes for a particular error code can be provided
● Breakdown instructions assigned to the respective model and failure mode are automatically displayed for
each model
In devices that support RFID, in addition to scanning of QR/barcodes you can also scan NFC tags to identify
equipment (Custom Fiori client needed). Set up the bar code configurations under General Application
Settings Bar Code Configurations , you have to define the <Prefix> and <Suffix> in order to use this
feature.
You can perform various operations on lookup such as lookup and error code-related information for an
equipment or a model.
Context
You can use this app to search for <Error Code> and <Lookup>. You can perform the following operations
using the lookup application:
Manufacturer provides the information on the model level. The operator in turn synchronizes installed base
information from SAP Plant Maintenance (SAP PM) to SAP Predictive Asset Insights. With this, operator
owns a significant amount of equipment from SAP PM in SAP Predictive Asset Insights. If the data quality of the
equipment is sufficient enough, the smart matcher can help you link a lean equipment (equipment with no
model assignment to it) to the respective model it belongs to.
The above is based on an algorithm that involves fuzzy search. In case of poor or incomplete data on
equipment level, the smart matcher application provides a card view in which you can match recommended
models to equipment. The recommendation is again based on the same algorithm. The output of the algorithm
is a match factor between 0.75 (75%) and 1 (100%).
You can perform various operations on smart matcher such as matching an equipment to model or updating
the model details in model app and checkin Smart Matcher application.
Context
You use the Smart Matcher application to assign models to a lean (equipment with no model assignment to it)
equipment. You can perform the following operations using the Announcements application:
The term "work order" is a generic term for the following order types:
● production orders
● process orders
● inspection orders
● maintenance orders
● networks
The work order list page contains a list of the work orders and work order operations that you have selected
using the filter criteria.
On the list page, you can select multiple work orders and work order operations, and choose Manage to view
the orders, operations, equipment, documents associated with one or more work orders. You can deselect and
select the work orders in the carousel and accordingly the associated items for the selected work orders is
refreshed on the respective sections.
Work order lifecycle status and collaboration status are displayed in the Status field of the list page.
Any work order that is shared with or shared by you will have the collaboration status enabled.
Prerequisites
Procedure
The tiles under Master Data on the SAP Fiori launchpad enable you, as a business user, to browse all kinds of
related information about your equipment. If you are an administrator you can additionally create and edit
master data.
Objects: Any item that you create in the SAP Predictive Asset Insights can be referred to as an object.
Business objects: You can also refer to all the objects involved in a business scenario as business objects.
● Equipment
● Functional Locations
Note
Unit of Measure (UoM) Conversion: SAP provides a basic set of unit of measures. And, unit of measure
conversion is applicable only for this basic set of unit of measures.
Tile Use
Equipment Search [page 313] Search for equipment based on attributes of an equipment.
Models [page 131] Create/display models. A model is an abstract representation from the manufac
turer that defines all maintenance and specification information related to a new
or existing product. A physical equipment is an instance of a model.
Functional Locations [page 150] Maintain functional location information for a piece of equipment and systems. A
functional location represents the area at which a piece of equipment can be in
stalled and you can perform maintenance tasks.
Locations [page 165] Create/display a location is a virtual record of the location where an equipment
is installed.
Functions [page 175] Defines how the assigned objects are intended to operate. For example, you can
assign functions to equipment, models etc.
Failure Modes [page 176] Create/display failure modes. A failure mode is a probable failure that could oc
cur to piece of equipment.
Fingerprints [page 185] Defined as a collection of snapshot of the indicator chart derived from a set of
indicators and meta data (type, data and time, description, equipment state) for
a specific time period. It describes the reference state of a single equipment that
can be used for further process steps, for example, equipment documentation,
trending, failure analytics.
Spare Parts [page 189] Create/display spare parts. Spare parts are components that are kept in your in
ventory as spare. Typically, these components are not fitted into your equip
ment, but can be fitted into a piece of equipment when needed.
Groups [page 199] Create/display groups. You can group together different business objects for
multiple purposes.
Systems [page 206] Define systems based on a system model and assign system template to it.
Instructions [page 251] Create/display instructions. An instruction is a set of steps that help the user to
carry out a specific task, for example, maintenance of a specific piece of equip
ment
Templates [page 262] Create/display templates. A template is a format created by the manufacturer to
maintain metadata related to a model, piece of equipment or a location.
Rules [page 307] Create and manage rules and associated actions.
5.1 Equipment
A piece of equipment is a physical instance of a model. An operator maintains additional information specific to
an item of an equipment such as the following:
● Information:
Maintain information related to an equipment such as serial number of the equipment, tag number of the
equipment, installation date of the equipment, and build date of the equipment.
● Installation location:
Maintains geographical coordinates of the piece of an equipment to locate the location.
● Documents:
Maintains some best practices information while using the item of an equipment using unstructured
documents.
● Unpublished
● In Revision
● Published
Context
More Information
Add and remove equipment components. For more information, see Adding Equipment Components
[page 107].
View details of an existing equipment and update an existing For more information, see Viewing and Updating a Piece of
equipment.For more information, see
Equipment [page 115].
Delete a piece of equipment. For more information, see Deleting a Piece of Equipment
[page 119].
Note
In addition, you can use the Lookup application to scan
the bar code, or the QR code of an item of equipment to
view the details related to an item of equipment and per
form actions such as update equipment phase, or edit
header information for an item of equipment.
View work orders for a piece of equipment Viewing Work Orders of an Equipment [page 125]
View notifications for a piece of equipment Viewing and Creating Equipment Notifications [page 123]
View and edit indicators Viewing and Editing Indicators [page 126]
View and analyze leading indicators for a piece of equip Viewing and Analyzing Leading Indicators for Equipment
ment.
View an analytics dashboard for a piece of equipment. Viewing a Dashboard on Object Pages [page 76]
View the top failure modes for a piece of equipment. Using Failure Mode Analytics on the Equipment or Model Pa
ges
View a failure curve with different insights for a piece of Viewing a Failure Curve for Equipment [page 130]
equipment.
You create a piece of equipment based on an existing model, and add additional information such as operator,
equipment installation information, equipment location information, and assign documents relevant to the
equipment.
Prerequisites
Context
Additional Infor
Step # Description mation
2 Choose New.
1. You can optionally assign a model template for the equipment. Select the model
template in the Model ID.
In the Model ID dropdown, select an existing model from which you want to in
herit the properties for the item of the equipment.
If SAP Predictive Asset Insights is available, once the model template is selected
the <IoT Sync> field is enabled. This field enables you to replicate the selected
object in SAP Internet of Things and maintain connection between these sys
tems. You can choose a <Yes> or <No>. By default, the sync is always set to
<Yes>.
Note
For more information, see https://help.sap.com/viewer/
067e3d8253654398996ec49271b7441a/latest/en-US/
ac5129f13f6c43eb99025ebdd079f83b.html.
○ Not Operational
9. In the UID field, enter the unique ID that could be used to identify the equipment
in any system.
Note
○ UID must be in the following format: <Unique company identifier>/
<Model-ID>/<Serial No>.
10. In the Long Description field, enter a long description for an item of equipment.
11. Choose Save to create a single piece of equipment. Enable the Create
Components switch to create equipment hierarchy from the model template. In
the Set Components tab, you can define the individual subequipment. Create
Components creates the individual items of equipment, use Save to finalize the
activity.
Note
Component hierarchy is added to the equipment when a model is assigned
to it.
4 Add values/infomation to the attributes of the underlying templates in the data sheet Adding Data in the
section, model information, equipment information, business partner information, Information Section
installation location, lifecycle information, system, or groups [page 102]
5 Add structure components, spare parts or visaul parts information Adding Structure &
Parts [page 105]
7 Add documents, instructions, failure modes, alert types announcements or create Adding Information
improvement request for the equipment in the Documenta
tion Section [page
108]
System publishes the item of the equipment and creates a first revision of the item of
the equipment.
The object page of the equipment displays the header information that includes information like Phase/
System Status, External IDs, Status (of the equipment), Languages and so on.
Context
Procedure
1. Phase/System Status
You can view the phase of the equipment using the icon next to the equipment name in the header. The
icon displays the following symbols for the relevant phases:
Icon Phase
Planned
Not Operational
You can also view the system status, the date when the record was created and also navigate to the
Manage Phase feature.
You can document the different life cycle phases of the equipment using Manage Phase. Equipment can be
in one of the following phases:
○ Current phase: It has three subsections:
○ Planned
○ Actual
○ Phased out
These main phases are followed by a subsequent status schema, for example, Fully Operational.
○ Fully Operational
○ Planned => (Not <=> Partially <=>Fully) Operational
○ Operational <=> Dispose => Retire
○ Retire => Sold
Note
Legends:
Dependencies:
○ Dismantle the equipment assigned to location, otherwise they can't reach the state of Dispose,
Retire, and Sell.
○ The Sold phase needs a Published status and an assigned model to the equipment.
○ Sold means a Transfer of Ownership. Equipment in that stage is not furthermore editable for the
old Owner, but listed in their repository with the app. Date of ownership transfer.
Equipment exposed as a System can have an additional(optional) status (ISO 14224):
○ Redundant or Passive Standby:
Redundancy wherein parts of the system for performing a required function are operational, while
the remaining parts of the system are inoperative until needed.
○ Standby or Active Standby:
Redundancy wherein all the parts of the system for performing a required function are intended to
operate simultaneously.
○ Next Phase
With the next phase, you can document or plan the upcoming, multiple phase changes.
○ This planned phase change does not have a mandatory phase change as consequence.
○ This selectable phase here, do not follow a status schema or dependency.
○ Current and planned phase will be exposed in the Manage Phase dialog and on the related highlight
card. In addition, all current phase changes are notified in the Timeline of the Equipment with
information of status change, timestamp, and changes done by internal person or business partner.
You can document the different life cycle phases of the equipment.
2. If a UID is available for the equipment, then you can view the UID field.
You can click on the UID field and choose Copy to copy the UID.
3. External IDs: You can view the Object ID of the equipment and also view the IDs used for the equipment in
the external systems. You can also use Add button to add external IDs.
4. Status: You can view the status of the equipment.
5. Languages: You can view the languages supported.
6. Manage:
You can perform the following actions using the Manage button in the published equipment:
○ New Revision: This option is available only if the equipment is already in Published state.
○ View Last Published/View Last Revision: This option is available only if the equipment is in In Revision
state.
○ Update Model: You can update the model associated with the equipment. This option is available only if
the equipment is already in Unpublished or In Revision state.
○ Remove Model: You can remove the model associated with the equipment. This option is available only
if the equipment is already in Published or In Revision state.
○ View Lifecycle Changes
○ Delete
○ Edit Header: You can edit the equipment information like equipment ID, description, and image. This
option is available only if the equipment is already in Unpublished or In Revision state.
Context
Procedure
1. Highlights: You can view the highlight cards and also set their visibility using the Settings button.
2. To add values to the attributes of the underlying templates, choose INFORMATION Data Sheet and
perform the following steps:
a. Choose Edit and enter values for the attributes as defined by the underlying templates.
You can select the values if codelist are defined for the attributes. You can do multiple selections for
datatypes of type String and Date.
b. You can reorder the attribute groups using Reorder Groups.
c. If you have not assigned any equipment template while creating the equipment, you can add it later
using Add Template. You can add or remove multiple equipment templates.
d. You can display the alternate unit of measure using Show Alternate UoM.
You can set the default unit of measurement system in the Unit of Measure Variant under User
Account(icon on the left corner of the launchpad) Settings Unit of Measure .
e. Choose Save.
You can now add equipment templates with nested structures, but will not be able to maintain the values.
You can only maintain the values using the value PUT API. In case you have added nested structure
templates and templates with flat structure attributes (old kind of template), then also you can only
maintain the values using the API.
4. To add installation information, select the INFORMATION Equipment Information tab and perform
the following tasks:
Field Description
Note
Serial number is not mandatory for equipment with
model assigned to them. Serial numbers can be
added at a later lifecycle phase of the equipment.
Equipment Tag Number Specify the tag number issued by your organization
when the manufacturer has not specified any serial
number or batch number.
Technical Identification Number Enter the Technical Identification Number for the equip
ment
Note
c. Choose Save.
You can use tags to help you logically categorize activities, information, or reminders about your
equipment. You can now inherit the address from the location to the equipment.
5. To add business partner information, select the INFORMATION Business Partners tab and perform
the following tasks:
a. Choose Edit and enter the fields as described in the table:
Field Description
Source Business Partner Role Update the source business partner role, if necessary.
Service Providers Select the name of the service provider for the piece of
equipment.
Insurers Select the name of the insurer for the piece of equip
ment.
Suppliers/Dealers Select the name of the dealer for the piece of equip
ment.
Sold-to Party Select the name of the party to which the equipment is
sold.
Ship-to Party Select the name of the party to which the equipment is
shipped to.
Bill-to Party Select the name of the party to which the equipment is
billed.
6. To add Sales Organization Data, select INFORMATION Sales Organization Data tab and perform the
following tasks:
a. Choose Edit and select inputs for the fields as described in the table:
Field Description
Sales Office
Sales Group
b. Choose Save.
7. To add installation location information, select INFORMATION Installation Location tab and perform
the following tasks:
a. Choose Edit and enter the fields as described in the table:
Field Description
Contact Person Enter the contact person details for the location.
Note
Optionally you can specify the geo coordinates us
ing the visual map.
b. Choose Save.
8. You can view the successor to the current model information under INFORMATION Life Cycle
Information .
9. You can view the list of systems to which the equipment is assigned under INFORMATION Systems .
○ All parent systems are displayed.
○ A piece of equipment can be part of one or more systems. The equipment page now displays the
associated system information.
For example, a compressor can be a part of the compressed air system in a plant.
10. To add the equipment to a group, go to INFORMATION→ GROUPS → Add.
You can view the list of groups to which the equipment is added.
Context
You can add, view, edit, or delete equipment components, spare parts, and visual parts to a piece of equipment.
Procedure
1. Highlights: You can view the highlight cards and also set their visibility using the Settings button.
2. To add equipment components, navigate to STRUCTURE AND PARTS Structure Edit and perform
the following tasks:
You can also filter the equipment based on Source and Product Relevance.
c. Choose Add.
d. To add systems, choose Assign Systems
e. From the Select Systems dialog box, select the appropriate system.
f. Choose Assign.
g. Choose Save.
Note
You can now inherit the address from the location. You can publish a component directly from the
Structure section. Select the component and use the Publish button.
3. To add equipment spare parts, navigate to STRUCTURE AND PARTS Spare Parts Assign and
perform the following tasks:
a. From the Assign Spare Parts dialog box, select the appropriate spare parts.
b. Choose Provide Quantity to specify the quantity of each spare part. You can also enter a comment if
necessary.
c. Choose Assign.
Assign new spare parts or maintain existing spare parts for an equipment using the Edit and Remove
buttons. Similarly, you can view the associated documents when a spare part is being shared.
Note
If you have integration with SAP Commerce Cloud, then you can also view the Add to Cart button for
each spare part. Currently, you can only add one spare part for each order request.
4. To view Visual Parts for an item of equipment, upload a relevant 3D visual file in the DOCUMENTATION
DOCUMENTS section and view them under STRUCTURE AND PARTS Visual Parts .
Prerequisites
Procedure
Results
Context
Procedure
1. Highlights: You can view the highlight cards and also set their visibility using the Settings button.
2. To add, or assign, or edit an existing document to the equipment, choose the Documentation
Documents tab, and perform the following tasks:
In the Documents section, choose Add menu to upload a new document, and perform the following steps.
Note
This selection is only one of the metadata information for the document. Currently, there
are no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
3. Choose Upload.
You can use Check and Upload to check if there are any duplicates that exist in the system. If
duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then
can Continue Uploading the New File or you can select a file from the duplicate file list and Use
Selected File option to upload it.
b. Choose Add Add Document to add a document.
1. In the Add Document popup browse for a file.
Note
Note
This selection is only one of the metadata information for the document. Currently, there
are no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
3. Choose Upload.
You can use Check and Upload to check if there are any duplicates that exist in the system. If
duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then
can Continue Uploading the New File or you can select a file from the duplicate file list and Use
Selected File option to upload it.
c. Choose Add Add Link to add a document link.
1. In the Add Link popup, provide a URL link to the document along with a Display Name.
Note
Note
This selection is only one of the metadata information for the document. Currently, there
are no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
3. Choose Upload.
You can use Check and Upload to check if there are any duplicates that exist in the system. If
duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then
can Continue Uploading the New File or you can select a file from the duplicate file list and Use
Selected File option to upload it.
Note
2. In the Additional Information section, enter a Description for the document. You can also enter a
long description, if necessary.
3. Choose Upload.
3. In the Documents section, from the Add menu choose Assign to upload an existing document and perform
the following steps:
a. In the Select Documents dialog box, search for an appropriate file.
b. From the Documents search results list, select a document.
c. Choose OK.
You can also use Remove and Download to remove or download any of the documents assigned to the
equipment.
5. To assign failure modes to the equipment, go to DOCUMENTATION Failure Modes and perform the
following tasks:
a. Choose Assign.
b. Select a failure mode.
c. Choose OK.
You can select a failure mode and choose Remove to unassign the failure mode.
Note
You cannot remove failure modes that are inherited from the model. Only failure modes assigned to the
equipment instance can be removed.
If you have write access to the equipment even though you do not have write access to the failure mode,
you can still edit the failure mode instance page of the equipment.
When you copy a failure mode and Save & Publish it:
○ A new failure mode is created with the same causes and instructions from the source failure mode
○ The newly created failure mode is directly assigned to the object
○ The new failure mode is in published state
○ You navigate to the new failure mode instance page that includes all the copied failure mode instances:
effects, causes, instructions, and detection method
You can view the failure mode instance, which is directly assigned (at the same time), you can now view
different object icons in the <From> field of the failure mode section if the failure mode is inherited or
assigned directly to the equipment.
You can now flag inherited failure modes to not relevant using the Not Relevant button. This excludes the
failure modes from any assessments relevant to the equipment. Inherited failure modes that are marked as
Not Relevant, when assigned explicitly, will be set to Relevant.
6. You can view the alert types associated with the equipment under DOCUMENTATION Alert Types
You can also view the list of rules or create rules using the Manage Rule.
Baselines are snapshot that is used as a reference point. Multiple snapshots can be created over a period
of period to view and monitor the full extent of the data change over time. Baselines provide you the ability
to travel back in time to see how the equipment data was, and where & when data has changed.
Note
You need to have the BASELINE_EDIT role to view and create baselines, and BASELINE_READ role to
view baselines.
10. You can view the list of functions assigned to the equipment under DOCUMENTATION Functions .
a. Choose Assign.
b. Select a function.
c. Choose OK.
Note
You cannot remove functions that are inherited from the model. Only functions assigned to the
equipment instance can be removed.
11. You can also view the list of fingerprints assigned to the equipment under DOCUMENTATION
Fingerprints .
You can also directly access fingerprints using the Fingerprints [page 185] app.
Note
Context
1. You can view and configure the list of indicators inherited from the model or equipment templates under
Monitoring.
You can add/remove an indicator to the favorites list using the star icon in the <My Favorites>.
For numeric and numeric flexible datatypes, <Reset>, <Normal>, <Max>, and <Min> fields are available
while definition the threshold. You can also define threshold value range for these datatypes (only threshold
value not range is available for other data types). The Reset button is functional only for these two
datatypes and will delete all the existing values and insert the reset value wherever applicable.
Note
○ You can set upto a maximum of 10 thresholds. In the case of indicators of data type Boolean, the
maximum number of thresholds selected must be 2 with values True and False. By default, its set
to 0. Anything else can lead to inconsistency.
○ You can personalize the indicator filters and columns in the Indicator section. When you logon again
the same filters and columns are displayed.
○ If you are assigned the role AC_CUSTOMER_ADMIN, then a new variant Default Indicators is
available to display the indicators marked as default at model and equipment level in the Indicators
section.
○ You can select a maximum of 4 Primary Thresholds. The primary threshold is mainly used in the
indicator chart of SAP Predictive Asset Insights.
○ Values of indicator are displayed based on Display UoM that is maintained at the template level.
If the same indicator is assigned to the model and also to the equipment, you can define different threshold
values for the indicator at the model level and at the equipment level. If the values are defined both at the
equipment and model level, the values defined at the equipment level will be considered. If not, the values
defined at the model level are considered.
To map the indicators of your item of equipment with an external system, follow the procedure in Mapping
Indicators with an External System [page 119].
You can maintain a manual entries for the indicators by selecting an indicator and choosing New Manual
Entry. You can edit or delete these manual entries by selecting the indicator and choosing Manage
Manual Entry Edit or Manage Manual Entry Delete .
Note
If URL is provided by the source application (using API), then the value in Context column will be a
hyperlink. Click on the hyperlink to open the underlying URL in a new tab.
2. You can also view Alerts and Indicator Chart under Monitoring.
Context
Procedure
1. Highlights: You can view the highlight cards and also set their visibility using the Settings button.
2. View Notifications
Note
You can also create notifications using the New button. You can also create new notifications using
Manage New Notifications .
You can view a list of completed, planned and pending work orders for the equipment.
5.1.1.1.7 Timeline
Context
Procedure
Note
For the nested structure attributes, timeline and completeness is not yet supported.
You can update information such as installation information, installation location, and documents that relate to
an existing item of equipment.
Prerequisites
● To view an item of equipment, your user ID has the roles EQUIPMENT_READ assigned.
● To update an item of equipment, your user ID has the roles EQUIPMENT_DELETE or EQUIPMENT_EDIT
assigned.
Procedure
○ Request Model
○ Publish
○ Group
○ Assess
○ Delete
3. Search for an item of equipment that you want to update using the search filters.
4. Select the item of equipment from the search results.
5. You can perform the following actions using the Manage button in the published equipment:
○ New Revision
○ View Lifecycle Changes
○ Delete
○ Request Model
Note
Note: This option is available only if the equipment is in Published state, the <IoT Sync Flag> is
set to Yes and SAP Cloud Platform Internet of Things 4.0 system is configured.
6. If you choose an item of equipment that is in a published state, choose Manage New Revision from
the Equipment screen.
7. View and navigate to the open model request for the equipment from the icon in the <Model ID> under
INFORMATION Model Information
○ You can view only the icon in <Model ID> for a piece of equipment if it not assigned to any model.
○ If the equipment is assigned to a model or if you have entered a free text, you can view the icon
together with the model ID or free text.
Note
You can only assign model request for items of equipment that are published at least once.
8. To update additional attributes related to an item of equipment, select tab INFORMATION Data
Sheet and perform these substeps.
a. Choose Edit.
b. You can reorder the attribute groups using Reorder Groups.
c. You can assign equipment templates using Add Template after the equipment is created.
d. You can select templates from the list and choose Remove Template to remove the template.
e. You can display the alternate unit of measure using Show Alternate UoM.
You can set the default unit of measurement system in the Unit of Measure Variant under User
Account(icon on the left corner of the launchpad) Settings Unit of Measure .
f. Choose Save.
10. To view the parent systems associated with the equipment, select tab INFORMATION Systems .
11. To assign Documents, Instructions, and Announcements, choose the DOCUMENTATION tab.
a. To add documents related to the item of the equipment, choose the tab DOCUMENTATION
DOCUMENTS and perform the following tasks:
Note
If you are unable to see the Assign button, change your browser zoom and retry.
You can view the causes and effects of the failure modes assigned to the equipment in this section.
If you have write access to the equipment even though you do not have write access to the failure
mode, you can edit the failure mode instance page of equipment.
When you copy a failure mode and Save & Publish it:
○ A new failure mode is created with the same causes and instructions from the source failure mode
○ The newly created failure mode is directly assigned to the object
○ The new failure mode is in published state
○ You navigate to the new failure mode instance page that includes all the copied failure mode
instances: effects, causes, instructions, and detection method
○ The new failure mode appears in the failure mode section list
You can view the failure mode instance which is inherited and directly assigned (at the same time), you
can now view different object icons in the <From> field of the failure mode section if the failure mode is
inherited or assigned directly to the equipment.
You can now flag inherited failure modes to not relevant using the Not Relevant button. This excludes
the failure modes from any assessments relevant to the equipment.
e. View the improvement requests assigned to the equipment.
To create an improvement request for the equipment, perform the following tasks:
1. Choose New Improvement Request.
2. Enter the relevant details in the New Improvement Request dialog box.
3. Choose OK.
f. You can view the alert types associated with the equipment under DOCUMENTATION Alert
Types
g. You can view the list of functions assigned to the equipment under DOCUMENTATION
Functions .
You can assign functions using the Functions app. For more information, refer to Functions [page 175].
12. You can perform the following activities in the MONITORING tab:
a. View the indicators related to the equipment in the Indicators section.
To define, model, and edit additional properties of the indicators and their thresholds, select an
indicator and choose Configure.
Use Add Evidence to assign/add improvement requests. You can also create notifications using the
New button.
b. View work orders related to the equipment in the Work Orders section.
c. View the list of fingerprints assigned to the equipment under Fingerprints.
You can click the equipment time range to perform the following the Filter By dialog box:
○ Show Timeline Events for: Select if you want to view the changes only on the equipment or the model
associated with the equipment or all the changes made on the equipment data.
○ Time Range: Select a time range to view only the changes during that timeframe.
Note
You can track addition and removal of component and parent equipment. Sharing activities are also
tracked in the timeline.
When you have more items of Equipment created using public APIs provided by SAP Predictive Asset Insights,
you can view these items of equipment using the Equipment application and also publish multiple equipment.
Prerequisites
You can delete an item of equipment that you do not want to have on the network.
Prerequisites
Procedure
You perform this activity to retrieve the indicator values of your equipment from an external system of type SAP
Internet of Things. When you have equipment data or machine data existing in an external system, you can
retrieve that data by mapping your equipment with the external system.
Prerequisites
● The external system is configured with SAP Predictive Asset Insights. For more information, see
Configuring External Systems.
Note
If this flag is set to "Yes", refer to the help portal under SAP Predictive Asset Insights Application
Help SAP Internet of Things Synchronization .
Context
In this procedure, you map indicators of equipment between an external system and SAP system.
Procedure
Field Description
6. Under the Indicators section, select an indicator and choose the corresponding indicator from the listed
equipment indicators (external system) by choosing Map.
7. Choose Save.
You see that the new indicator values appear on the Equipment object page.
Note
In order to unmap an indicator go to, Monitoring Indicators Map Indicators select the indicator
form the indicator list, and choose the corresponding delete/close icon.
Visualize all the alerts related to the top equipment and the relevant equipment.
Prerequisites
● View only alerts for the equipment for which you are authorized.
● You need to have Edit authorization to perform action on alerts.
Context
Using this option, it is also possible to sort and filter the alerts and columns that should display on the screen.
Click the respective icons to perform these actions. Click an alert to view the same on the indicator chart. This
chart displays the alert in a time-based line chart together with contributing sensor or score values.
You can view the following alert details: status, type, severity, code, code description, source and indicator.
Note
By default, the default variant displays. It is possible to override the default variant. On navigating from this
page or relogging, the user selected variant persists.
It is also possible to create notification for an alert. Select the alerts for which you want to create notifications
and click the Create Notification button. The newly created notification displays as <Notification ID>
within the Alerts details. For more details of the newly created notification, click the Notification ID hyperlink.
Using the Add Evidence button, it is possible to create a new improvement request or edit an existing
improvement request.
Click the Set to In Process and Set to Completed button to change the status of alerts. The change in status do
not result in change in processor. To change the processor, click the Set Processor button. The sequence of
status is from New --> In Process --> Completed and from New → Completed. The change in alert status do
not change the processor. And, click Set Processor to change the processor.
Note
Only users with the role, AlertProcessor can change the alert status.
The role AlertProcessorAdmin can set/change the processor and change the alert status.
Use the Manage Rules button to navigate to the Rules page. You can view all the rules related to the model. For
more information, refer Rule Management [page 312].
This analysis tool enables you to visualize data across one or more indicators for one hierarchy. By default, the
indicators selected as favorite for a user displays on the chart.
Prerequisites
Context
The analysis tool, indicator chart enables you to visualize time series data across one or more indicators for an
equipment hierarchy. You can also view the alerts, notifications, work orders, threshold, and indicator forecast
related to a particular equipment.
By default, the first variant displays. You can override the existing variant by selecting from the dropdown. On
navigating from this page or relogging, the user selected variant persists.
Note
For more information about indicator chart, refer to Features in Indicator Chart [page 51].
Procedure
You can view all the notifications associated with a piece of equipment and also create a notification.
Prerequisites
You must have the role EQUIPMENT_READ assigned to your user ID in the SAP BTP account.
Context
Using this option, it is also possible to sort, filter, group notifications, and create notifications. Click the
respective icons to perform these actions. Depending on the action performed on these notifications, the
progress status - completed, planned, and pending displays against each notification. It is also possible to
create an improvement request or edit an improvement request using the Add Evidence button. Also, create a
notification using the <New> option.
Click a notification ID to view more details of the same in the object page. A indicator chart displays with the
notification details. You can view the start and end date of notifications. If these dates are not available, the
current date of notification is plotted on the chart, with the measurement point time series data.
Note
In case of notifications that do not have an assigned equipment, then the indicator chart will not work.
For more information about indicator chart, refer Viewing Time Series Data (Indicator Chart) of an Equipment
[page 122].
To view the details of notification, click the respective notification ID. The progress of notifications is as below:
Procedure
Viewing Notifications
1. Open the Equipment application.
2. From the Equipment list screen, select the equipment for which you want to view notifications.
3. In the MAINTENANCE & SERVICE tab, select Notifications.
You can view a list of notifications associated with the piece of equipment.
Creating a New Notification
You are navigated to the New Notification dialog box. Enter the following details:
Fields Description
Malfunction Start Date Select the start date when the malfunction occurred.
User Proposed Failure Mode Select a failure mode. If no relevant failure mode is availa
ble, you can select No appropriate failure mode available.
Note
5. Choose Create.
The notification is displayed in the notification section. Choose the notification to view details.
Related Information
You can use this procedure to view a list of work orders related to an equipment.
Prerequisites
To view a piece of equipment, your user ID has the roles EQUIPMENT_READ assigned to it.
Context
You can view the following work orders details: work order ID, order short description, order status, order type,
order priority, order long description, start date, end date, actual duration, or planned duration.
Click a work order ID to view more details of the same in the object page. A indicator chart displays with the
work order details. You can view the start and end date of work orders. If these dates are not available, the
current date of work order is plotted on the chart, with the measurement point time series data.
Note
In case of work orders that do not have an assigned equipment, then the indicator chart will not work.
For more information about indicator chart, refer Viewing Time Series Data (Indicator Chart) of an Equipment
[page 122].
● Sort the work orders by - Ascending, Descending, Type, Priority, Start Date, or End Date.
● Group work orders by- Ascending, Descending, Type, or Priority.
● Filter work orders by - Type or Priority.
You can have more than one service provider for a piece of equipment. Multiple business partners can have the
same role.
Note
If the order status is <TECO> or closed, then the actual duration is displayed, otherwise the planned
duration is displayed.
Procedure
You can view and edit the indicators associated with a piece of equipment and its relevant components and add
additional properties to it.
Context
Note
Component indicators section displays all the indicators associated with the equipment components
(components of the equipment in the Structure section of the equipment object page) and cannot be
edited.
Procedure
You can maintain values for the indicators for which you have defined the properties by using New Manual
Indicator.
5. To view indicators associated with the equipment component, go to Component Indicatorssection.
○ Component Indicators are displayed only if any indicators are assigned to the equipment
component and cannot be edited.
Use this procedure to view and analyze the leading indicators for a piece of equipment.
Prerequisites
● You have trained a model in the Leading Indicators Model Management application. For more information,
see Managing Models for Leading Indicators [page 399].
● The roles AC_ORG_DATA_EXPERT and DataScienceRead are assigned to your user.
Context
To monitor and predict the performance of your equipment, you can view and analyze leading indicators for a
piece of equipment of an equipment model.
Leading indicators are the indicators whose conditions are most related to failures of the piece of equipment.
The leading indicators are automatically determined by a machine learning algorithm using historical sensor
data and notification data as input. Identifying these leading indicators and their conditions helps you to
prevent upcoming failures by proactively maintaining the piece of equipment and creating effective condition-
based maintenance (CBM) rules to monitor the performance and predict upcoming failures.
Example
Rose, a reliability engineer, suspects potential failures for her Pump-0054 due to overheating. She reviews
the leading indicators for the failure mode OHE (Overheating) of her pump. From the top indicators table,
she sees that the temperature has the highest influence on failures. To get a better understanding, she
reviews the most related conditions and sees that a temperature higher than 70 degrees has the highest
influence. To prevent failures from occurring, she creates a rule for the condition to get notified when the
pump is about to fail because of the condition and she can proactively maintain the pump.
Procedure
3. To view and analyze the leading indicators, choose ANALYTICS Leading Indicators .
The leading indicators for the piece of equipment are displayed as follows:
○ For the piece of equipment regardless of any failure mode: By default, the leading indicators are
displayed for the piece of equipment regardless of any failure mode. In this case, all failures that
occurred in the past are included.
○ For a failure mode related to the piece of equipment: If there are one or more failure modes available
for the piece of equipment, you can also display the leading indicators for a specific failure mode by
selecting the failure mode. You can choose from all failure modes that are assigned to the piece of
equipment.
The indicators are ranked by their strength indicating which indicators have the highest influence on
failures. You can view details about the strength threshold values by clicking the strength link.
4. To view and analyze the conditions for the leading indicators, choose Conditions.
The top conditions for the selected indicator are displayed. The conditions are ranked by their strength
indicating which conditions have the highest influence on failures. You can view details about the strength
threshold values by clicking the strength link.
Note
Only conditions whose strength is above 50% are displayed. Conditions below this strength are
considered as having no influence on failures and the piece of equipment is operating under normal
conditions.
5. To create a new rule for one condition, select the condition and choose New Rule. For more information
about rules and how to create rules, see Rules [page 307].
Results
You have viewed and analyzed the leading indicators for your piece of equipment.
Related Information
You can view the alert type groups assigned to a model of an equipment.
Prerequisites
Context
Note
It is not possible to assign or unassign alert type groups to an equipment template or an equipment.
Procedure
Related Information
Use this procedure to view a failure curve with different insights for a piece of equipment.
Prerequisites
● The model configuration has been trained and scored successfully at least once. For more information, see
Failure Curve Analytics Model Configuration Management [page 405].
● One of the following roles is assigned to your user:
○ FailureCurveAnalyticsUser
○ FailureCurveAnalyticsRead
○ FailureCurveAnalyticsEdit
○ FailureCurveAnalyticsDelete
● (Only relevant for configuring the sections of the equipment page): The role EQUIPMENT_EDIT or
EQUIPMENT_DELETE is assigned to your user.
Procedure
○ Open the failure curve using the Failure Curve Analytics Model Configuration Management
application:
1. In the application, navigate to the details screen of the model configuration.
2. On the details screen of the model configuration, choose Input Data Sets Equipment .
3. From the list, choose the piece of equipment for which you want to view the failure curve with
different insights.
○ Open the failure curve using the Equipment application:
1. On the SAP Fiori launchpad, open the Equipment application.
2. From the list, choose the piece of equipment for which you want to view the failure curve with
different insights.
3. On the equipment page, choose ANALYTICS Failure Curve .
Per default, the failure curve is displayed for the latest scored model configuration and for the failure mode
with the most notifications. If multiple failure modes have the same notification count, the alphabetically
earliest is selected.
Note
If the failure curve is not displayed, choose (Configure Sections) and activate the Analytics and
Failure Curve checkboxes. On the main screen again, choose ANALYTICS Failure Curve . The role
that is required to configure the sections is listed in the prerequisites.
The Current Selection dialog box with the selected age, the PoF, and the confidence interval is displayed.
Note
The actual age value of the data point may have decimals, for example, 27.6. In the Current Selection
dialog box, a rounded version of the value is displayed, for example, 28. That has the effect that
sometimes the age in the Current Selection dialog box slightly differs from the age on the x-axis.
3. To view the failure curve and the insights for a different model configuration or failure mode, select the
respective model configuration and failure mode from the dropdown lists.
Note
If you select another model configuration, the related failure mode with the most notifications is
automatically selected.
Results
The failure curve with the different insights for the selected model configuration or failure mode is displayed.
5.2 Models
A model is an abstract representation from the manufacturer that defines all maintenance and specification
information related to a new or existing product. A physical equipment is an instance of a model.
A model is based on a template and allows users to add values to the definitions used in the underlying
template.
● Instruction:
An instruction is a collection of steps from the manufacturer that make up a procedure on how to carry out
a service by an operator. An instruction consists of information that help the operator to maintain the
equipment better. There are five types of instructions: Planned Maintenance Instruction, Troubleshooting
and Breakdown Instruction, Installation instructions, Operations instruction, Disposal instruction.
● Announcement:
An announcement is a way of communicating structured information from a manufacturer to an operator,
or a set of operators.. For example: change in instruction
● Parts
A part is a single piece of an equipment. A manufacturer provides a list of parts used in the model along
with the visual representation of each one of them. An operator can select a specific part of the model from
● Unpublished
● In Revision
● Published
You use the Models app to work with a model. You can perform the following operations using the Models app:
Context
● Create a model and assign business entities such as in Creating a Model [page 133]
structions, documents, announcements, parts informa
tion of the model.
● Update successor model information.
● Add hotspots to the images of a model.
● Old and new images are shown on the timeline if image-
relevant fields are updated on model and equipment
level.
● Create a model request to contact another business
partner when you do not find respective models for
equipment in the network. The newly-created model re
quest is saved with the status <Draft>. While in Draft
status, the model request is not visible to the provider.
You can edit the model request and save the changes.
Changes or updates saved are logged in the timeline.
Add and remove model components. Adding Model Components [page 141]
View details of an existing model and update an existing Updating a Model [page 142]
model.
Delete a model to clean up the data that is not required to be Deleting a Model [page 144]
on the network.
View and analyze leading indicators for a model. Viewing and Analyzing Leading Indicators for a Model
View an analytics dashboard for a model. Viewing a Dashboard on Object Pages [page 76]
Configure indicator forecasting to forecast indicator values Configuring Indicator Forecasting for a Model
for your equipment of an equipment model.
View the top failure modes for a model. Using Failure Mode Analytics on the Equipment or Model Pa
ges
You can create a system using Manage Create System option. You can also create multiple systems from a model as
components.
You can view all the indicators associated with a model using the Indicators section under Monitoring. You can define,
model, and edit additional properties of the indicators and their thresholds using the Edit option in the Indicators section.
You use this procedure to: create a model and add business entities to it such as instructions, documents,
announcements, parts information, hotspots to the images uploaded as documents for a model.
Prerequisites
Procedure
Note
Note
This field is not relevant when creating models for functional location.
If you select more than one template, then the Primary Template field is displayed where you need to
select one of the templates as the primary template.
You can assign one or more parent subclasses or model templates to a model. If you enter more than
one parent subclass/model template, you must additionally select a primary template in the dropdown
of field <Primary Template>. This primary template is used for class/subclass/template display in
the breadcrumb as well as in the model list. The assignment of the primary template can later be
changed in the Data Sheet section of the model.
Note
All assigned templates and subclasses (as well as associated classes) are available in the Model
Information section. If there are more than one class/subclass/template, count values are
displayed in the respective fields. When clicking on one of the count values, you can view the
complete template hierarchy for your model.
Note
This field is not relevant when creating models for functional location.
h. Choose OK.
4. To add values to the attributes of the underlying templates, choose INFORMATION Data Sheet and
perform the following steps:
a. Choose Edit and enter values for the attributes as defined by the underlying templates.
b. You can reorder the attribute groups using Reorder Groups.
c. You can display the alternate unit of measure using Show Alternate UoM.
You can set the default unit of measurement system in the Unit of Measure Variant under User
Account(icon on the left corner of the launchpad) Settings Unit of Measure .
If there are multiple templates assigned, you get filtering options on the data sheet:
○ All = displays all attribute groups and attributes
○ <Industry Standard> = displays all attribute groups and attributes that have the respective
industry standard maintained
○ <Custom> = displays all attribute groups and attributes that are coming from customer-created
model templates
e. If there are multiple Subclasses and Templates assigned, you can change the Primary Template using
Update Primary Template.
f. If there are multiple Subclasses and Templates assigned, you can remove assigned objects using
Remove Template.
Note
It is mandatory to have at least one parent object assigned, that is, it is not possible to remove all
assigned objects.
g. Choose Save.
You can now add model templates with nested structures, but will not be able to maintain the values. You
can only maintain the values using the value PUT API. In case you have added nested structure templates
and templates with flat structure attributes (old kind of template), then also you can only maintain the
values using the API.
5. To add model-specific information, choose INFORMATION Model Information and perform the
following steps:
a. Choose EditAs a manufacturer, you want and enter the following fields:
Field Description
Safety Risk Select a recommended safety risk for the model during
its operating condition.
Model Release Date Enter a date by which the model will be released.
You can assign such tags that logically categorize model information, maintenance, and other model-
relevant data.
e. Choose Save.
If consumer or operator is sharing equipment based on the model relation, the usage is linked to the
related equipment and operators.
Note
When the model is published, you can also create an equipment using this model from the Create
Equipment button.
7. To update a model as the successor to the current model, choose INFORMATION Life Cycle
Information and perform the following steps:
a. Choose Assign in the Successor Model section.
b. In the Assign Successors popup, select the model you want to assign as successor.
c. Choose OK.
Note
The successor model you want to assign must have the same subclass as the current model.
You can view the list of groups to which the model is added.
9. To add model components, perform the following:
The viewer search is extended to search for part name, description, manufacturer part number, and
EAM number. You can select search result and display it in the viewer window.
Note
You can assign instructions that are in a published state only to a model.
d. Choose OK.
You can view the different instruction types in the following tabs: Planned Maintenance, Breakdown,
Installation, Operations, and Disposal.
13. To add, or assign, or edit an existing document to the model, choose the Documentation Documents
tab, and perform the following tasks:
In the Documents section, choose Add menu to upload a new document, and perform the following steps.
Note
This selection is only one of the metadata information for the document. Currently, there
are no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
3. Choose Upload.
You can use Check and Upload to check if there are any duplicates that exist in the system. If
duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then
can Continue Uploading the New File or you can select a file from the duplicate file list and Use
Selected File option to upload it.
b. Choose Add Add Document to add a document.
1. In the Add Document popup browse for a file.
Note
Note
This selection is only one of the metadata information for the document. Currently, there
are no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
3. Choose Upload.
You can use Check and Upload to check if there are any duplicates that exist in the system. If
duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then
can Continue Uploading the New File or you can select a file from the duplicate file list and Use
Selected File option to upload it.
c. Choose Add Add Link to add a document link.
1. In the Add Link popup, provide a URL link to the document along with a Display Name.
Note
Note
This selection is only one of the metadata information for the document. Currently, there
are no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
3. Choose Upload.
You can use Check and Upload to check if there are any duplicates that exist in the system. If
duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then
can Continue Uploading the New File or you can select a file from the duplicate file list and Use
Selected File option to upload it.
d. You can add a new version of a document by selecting the document from the list and choose Add
Add New Version .
1. In the Add New Version popup browse for a file.
2. In the Additional Information section, enter a Description for the document. You can also enter a
long description, if necessary.
3. Choose Upload.
14. In the Documents section, from the Add menu choose Assign to upload an existing document and perform
the following steps:
a. In the Select Documents dialog box, search for an appropriate file.
b. From the Documents search results list, select a document.
c. Choose OK.
You can also use Remove and Download to remove or download any of the documents assigned to the
model.
15. To assign a failure mode, choose Documentation Failure Modes perform the following steps:
a. Choose Assign.
b. In the Select Failure Modes dialog box, select the failure modes that you want to assign to the model.
c. Choose OK.
Note
When you copy a failure mode and Save & Publish it:
○ A new failure mode is created with the same causes and instructions from the source failure
mode
○ The newly created failure mode is directly assigned to the object
○ The new failure mode is in published state
○ You navigate to the new failure mode instance page that includes all the copied failure mode
instances: effects, causes, instructions, and detection method
○ The new failure mode appears in the failure mode section list
If you have write access to the model even though you do not have write access to the failure mode,
you can edit the failure mode instance page of the model.
16. In the Documentation Alert Types section, you can, Assign or Remove alert type group.
17. To add an announcement to the model, choose the Documentation ANNOUNCEMENTS tab and
perform the following steps:
a. In the Announcements section, choose Assign to assign an existing announcement and perform the
following steps.
b. In the Assign Announcements to a Model dialog box, search for an appropriate announcement using
the filters – Announcement Type, or Priority, or Status.
c. From the Announcements search results list, select an announcement.
d. Choose OK.
18. You can create an improvement request for the model using Documentation Improvement Requests
New Improvement Requests .
You can enter the details in the New Improvement Request dialog box. Choose OK.
You are navigated to the new improvement request object page where you can further edit the request and
save it.
Note
This section is not available for models created for functional location.
19. You can view the list of functions assigned to the model under DOCUMENTATION Functions .
a. Choose Assign.
b. Select a function.
c. Choose OK.
20.In the Monitoring Indicators section, you can view the list of indicators associated with the model.
You can select an indicator from the list and use Configure to define the Threshold values for the indicator.
For Numeric and Numeric Flexible datatypes, you can also define the <Reset>, <Min>, <Max>, and
<Normal> values. You can also define threshold range for these datatypes. Reset button is functional only
for these two datatypes and will delete all the existing values and insert the reset value wherever applicable.
○ You can set upto a maximum of 10 thresholds. In the case of indicators of data type Boolean, the
maximum number of thresholds selected must be 2 with values True and False. Anything else can
lead to inconsistency.
○ You can personalize the indicator filters and columns in the Indicator section. When you log in again
the same filters and columns are displayed.
○ If you are assigned the role AC_CUSTOMER_ADMIN, then a new variant Default Indicators is
available to display the indicators marked as default at model and equipment level in the Indicators
section.
○ You can select a maximum of 4 Primary Thresholds. The primary threshold is mainly used in the
indicator chart of SAP Predictive Asset Insights.
○ Values of indicator are displayed based on Display UoM that is maintained at the template level.
21. In the Monitoring Nested Structure Indicators section, you can view the list of indicators inherited by
the model from the associated nested structures.
22. To publish model, choose Publish.
System publishes the model and creates a first revision of the model in SAP Predictive Asset Insights.
Users of your organization can view the published model. If you navigate away from the Models application
without saving the model, the model remains in the unpublished state and is not visible to any users in the
organization until you publish the model.
23. You can view the changes made on the model data in the Timeline section.
You can click the model date range to open the Filter By dialog box. You can select to show the event for a
particular object and define the time range during which you want to see the changes.
For each change entry, you can view changes made in other languages on the timelines using the Show
Details button.
Note
For the nested structure attributes, timeline and completeness is not yet supported.
You perform this activity when you need to alter the model components to customize to your requirement.
Prerequisites
● You have already created a model in SAP Predictive Asset Insights. For information about creating a model,
see Creating a Model [page 133].
● The model is in status Unpublished or In Revision.
● Ensure that the component you want to add already is created in the network as a model.
You use this procedure to update an existing model that has either incorrect or missing information.
Prerequisites
● You have created a model that is either in an unpublished state, or in the in revision state.
● Your user ID has the roles MODEL_DELETE or MODEL_EDIT assigned.
Procedure
5. To update additional attributes related to the model, select INFORMATION Attributes tab and
perform the following tasks:
Note
You must have instructions created in the SAP Predictive Asset Insights.
When you have more models created using public APIs provided by SAP Predictive Asset Insights, you can view
these models using the Models application and perform a mass publish of such models.
Prerequisites
Procedure
You can delete a model that you do not want to have on the network.
Prerequisites
Procedure
Prerequisites
Context
On assigning an alert type group, the alert types are automatically assigned to a model.
Note
Note
You can assign the same alert type group to more than one model.
You can view details of the alert type such as category, severity, alert type group, indicator, origin, and
failure modes.
○ If rules are maintained for the alert type, the message Rules Maintained display against the alert type.
This is visible within the Documentation section in the model and equipment page.
The message Rules not maintained displays if rules are not maintained for the alert type. You can
navigate to the Rules page and view the list of rules related to a model using the Manage Rules option.
For more information, refer Rule Management [page 312].
○ It is not possible to unassign an alert type group from a model, if its alert types are used in the rules.
Note
○ Make sure that you add only the alert groups having alert types that have indicators matching with
the indicators of the model. In case this criteria is not met, the rules created using these alert types
will not be functional.
For example, indicator I1 and I2 are assigned to alert types A1 and A2, respectively. These alert
types are grouped within an alert type group, AG1. This alert type group (AG1) can be assigned to a
model only if the indicators I1 and I2 are already part of the model.
This is not applicable to failure modes.
○ Do not delete indicators that are assigned to a model and used in an alert type. Considering the
above example, I1 or 12 should not be deleted as these indicators are used in the alert type groups,
as well.
○ Alert types without indicators can be assigned to models with or without indicators.
Related Information
Use this procedure to view and analyze the leading indicators for an equipment model.
Prerequisites
● You have trained a model in the Leading Indicators Model Management application. For more information,
see Managing Models for Leading Indicators [page 399].
● The roles AC_ORG_DATA_EXPERT and DataScienceRead are assigned to your user.
Context
To monitor and predict the performance of your equipment, you can view and analyze leading indicators for all
your equipment of an equipment model.
Leading indicators are the indicators whose conditions are most related to failures of the equipment. The
leading indicators are automatically determined by a machine learning algorithm using historical sensor data
and notification data as input. Identifying these leading indicators and their conditions helps you to prevent
upcoming failures by proactively maintaining the equipment and creating effective condition-based
maintenance (CBM) rules to monitor the performance and predict upcoming failures.
Example
Rose, a reliability engineer, is interested in activating data-driven condition-based maintenance (CBM) for
all her equipment of a specific equipment model to prevent failures. She reviews the leading indicators for
her equipment model EM202 and sees that output voltage has the highest influence on failures. To get a
better understanding, she reviews the most related conditions and sees that an output voltage less than
600 volt has the highest influence. To prevent failures from occurring and activate condition-based
maintenance (CBM), she creates a rule for the condition to get notified when any of her equipment of the
equipment model is about to fail because of the condition so she can proactively maintain all equipment of
the equipment model.
Procedure
3. To view and analyze the leading indicators, choose ANALYTICS Leading Indicators .
The leading indicators for the equipment model are displayed as follows:
The top conditions for the selected indicator are displayed. The conditions are ranked by their strength
indicating which conditions have the highest influence on failures. You can view details about the strength
threshold values by clicking the strength link.
Note
Only conditions whose strength is above 50% are displayed. Conditions below this strength are
considered as having no influence on failures and the equipment of the equipment model are operating
under normal conditions.
5. To create a new rule for one condition, select the condition and choose New Rule. For more information
about rules and how to create rules, see Rules [page 307].
Results
You have viewed and analyzed the leading indicators for your equipment model.
Related Information
Use this procedure to configure indicator forecasting to forecast indicator values for the equipment of an
equipment model.
Prerequisites
Context
To get insights about the expected behavior of your equipment of an equipment model in the future, you can
forecast indicator values for a certain time period in the future by configuring indicator forecasting. This helps
you to recognize any potential issues with your equipment early, for example, breakdowns and proactively
maintaining your equipment.
Note
● You can only configure indicator forecasting for indicators, which have the Continuous category.
● Once you have configured indicator forecasting, the configuration cannot be deleted, you can only
deactivate it. This is also the case if the indicators are not assigned to equipment any more or the
equipment model and indicators are deleted.
● When you create new indicator forecasting configurations, the current configuration is overwritten by
the new configuration.
The indicator values are forecasted based on historical indicator time series data within a defined time range.
This data is aggregated within the time range in a certain aggregate interval. The aggregate interval is
determined automatically. The aggregated data is then used to calculate averages. Each average is calculated
based on the aggregated data within the time interval, for example, 2 minutes and then divided by this time
interval. The collection of these averages is then used as input for a linear regression algorithm to calculate the
indicator values. For more information about the linear regression algorithm, see Simple Linear Regression .
The forecasted indicator values are then displayed in the indicator chart.
Example
Rose, a maintenance planner, wants to get insights about the operating hours of her equipment and wants
to see the future behavior of the operating hours. She forecasts the indicator values. In the indicator chart,
she views the forecasted operating hours values for the next two weeks and she sees that the operating
hours will decrease and may reach a threshold in the next days, which can lead to a potential breakdown. To
prevent the breakdown from occurring, she can then perform follow-up tasks based on her analysis.
Procedure
The list with all configured indicators for the equipment model is displayed.
4. From the list, select the indicator for which you want to forecast indicator values.
Note
If the button is not enabled, create a new revision of the model by choosing Manage and then New
Revision . For more information about creating revisions, see Updating a Model [page 142].
Activate Indicator Forecasting Activate this checkbox to forecast indicator values. You
can later also deactivate already created configuration.
Data Range
Data from within the last Define the time range of the historical time series data
that you want to use for forecasting.
Reset Option
Example
You have defined 10 days as a time range for the indi
cator forecasting. On the 8th day, a notification was
collected indicating an end of failure. This means that
only the data from the last 2 days is used for the fore
casting because only within this time the equipment
is up and the 8 days before the equipment was down
due to a breakdown and this data is useless.
Failure Mode Select the failure mode for which the assigned notifica-
tions should be included in the calculation.
8. Choose OK.
Results
The indicator forecasting is configured, and the indicator values are forecasted.
You can now view the forecasted indicator values for a specific piece of equipment of the equipment model in
the indicator chart. For more information, see Features in Indicator Chart [page 51].
A functional location represents the area at which a piece of equipment can be installed. Functional location
represents a place in which a maintenance task has to be performed.Structuring the maintenance hierarchy of
assets is very much necessary for the organization. Functional locations are created in hierarchical structures
and thus allow a functional or process-oriented structuring of your systems.
Location is used to represent actual geo-physical locations. Every location that is not associated with any
functionality can be represented using a lightweight object - Locations [page 165]. For example, India, EMEA,
and so on.
Functional location is an area where equipment and other functional locations can be installed. It is helpful to
understand the history of what happened there and the ability to capture functional requirements or impose
any specific restrictions.
For example, compressor station in located at building ABC where one can install 2 motors and this station
should operate at the given temperature. Here there is functional requirement and also mentions only 2 motors
can be installed. If one of the motors breakdown and gets replaced, then functional location will still be same
and helps us to understand what happened there, what is the maintenance cost, and so on.
Note
You can assign a model to the functional location if you have already created models of type For Functional
Locations using the Models app.
You create a functional location based on an existing model, and add additional information such as operator,
functional location information, and assign equipment or systems relevant to the functional location.
Prerequisites
Step # Description
2 Choose New.
1. You can optionally assign a model for the funnctional location. Select the model in the Model ID.
In the Model ID dropdown, select an existing model from which you want to inherit the properties
for the functional location.
Note
Only those models of type For Functional Location will be displayed in the drop-down list.
If SAP Predictive Asset Insights is available, once the model template is selected the <IoT Sync>
field is enabled. This field enables you to replicate the selected object in SAP Internet of Things for
the Cloud Foundry environment and maintain connection between these systems. You can choose
a <Yes> or <No>. By default, the sync is always set to <Yes>. In this case, you also need to select a
Gateway.
Note
For more information, see https://help.sap.com/viewer/
067e3d8253654398996ec49271b7441a/latest/en-US/
ac5129f13f6c43eb99025ebdd079f83b.html.
2. In the Functional Location ID field, enter a unique name for a functional location.
3. In the Description field, enter a short description for a functional location.
4. In the Functional Location Template field, select an existing functional location template from which
you want to inherit the properties for the functional location.
5. In the Product Relevance, you can select the relevant products in which you intend to use this func
tional location:
○ Asset Network
○ Strategy and Performance Management
○ Predictive Maintenance
6. In the Long Description field, enter a long description for a functional location, if necessary.
7. In the Operator field, enter an operator for the functional location. Your company is selected as de
fault value.
8. In the UID field, enter the unique ID that could be used to identify the functional location in any
system.
Note
○ UID must be in the following format: <Unique company identifier>/<Model-ID>/<Serial
No>.
4 Add values/infomation to the attributes of the underlying templates in the functional location informa
tion, business partner information, sales organization data, or installation location. Choose Edit to add
values. Refer to Adding Data in the Information Section [page 154]
5 Add structure components, you can add equipment, systems,and other functional locations as compo
nents. If the Single Installation field under Functional Location Information is set to YES, you can assign
only one equipment. If it is set to NO, then you can assign multiple equipment and systems to the func
tional location.
Location
2. From the Select Component dialog box, select the appropriate component.
3. Choose Add.
4. Choose Save
8 You can view and configure the list of indicators inherited from the model template under Indicators.
You can add/remove an indicator to the favorites list using the star icon in the <My Favorites>.
For numeric and numeric flexible datatypes, <Reset>, <Normal>, <Max>, and <Min> fields are availa
ble while definition the threshold. You can also define threshold value range for these datatypes (only
threshold value not range is available for other data types). The Reset button is functional only for these
two datatypes and will delete all the existing values and insert the reset value wherever applicable.
Note
● You can set upto a maximum of 10 thresholds. In the case of indicators of data type Boolean,
the maximum number of thresholds selected must be 2 with values True and False. By default,
its set to 0. Anything else can lead to inconsistency.
● You can personalize the indicator filters and columns in the Indicator section. When you logon
again the same filters and columns are displayed.
● You can select a maximum of 4 Primary Thresholds. The primary threshold is mainly used in
the indicator chart of SAP Predictive Asset Insights.
● Values of indicator are displayed based on Display UoM that is maintained at the template
level.
You can maintain a manual entries for the indicators by selecting an indicator and choosing New Manual
Entry. You can edit or delete these manual entries by selecting the indicator and choosing Manage
Note
If URL is provided by the source application (using API), then the value in Context column will be a
hyperlink. Click on the hyperlink to open the underlying URL in a new tab.
System publishes the functional location and creates a first revision of the functional location.
12 To create revisions of a functional location and to switch between the published and revision states, see
the steps provided in the procedure Creating Revisions and Switching Between Revisions and Published
State [page 315].
Context
Procedure
2. To add values to the attributes of the underlying templates, choose INFORMATION Data Sheet and
perform the following steps:
a. Choose Edit and enter values for the attributes as defined by the underlying templates.
You can select the values if codelist are defined for the attributes. You can do multiple selections for
datatypes of type String and Date.
b. You can reorder the attribute groups using Reorder Groups.
c. If you have not assigned any functional location template while creating the functional location, you
can add it later using Add Template. You can add or remove multiple functional location templates.
d. You can display the alternate unit of measure using Show Alternate UoM.
You can set the default unit of measurement system in the Unit of Measure Variant under User
Account(icon on the left corner of the launchpad) Settings Unit of Measure .
e. Choose Save.
3. To add functional location information, select the INFORMATION Functional Location Information tab
and perform the following tasks:
a. Choose Edit and enter the fields as described in the table:
Field Description
Functional Location Tag Number Specify the tag number issued by your organization.
Technical Identification Number Enter the Technical Identification Number for the func
tional location.
Single Installation If the Single Installation field is set to YES, you can as
sign only one equipment as component under
Structure. If it is set to NO, then you can assign multiple
equipment to the functional location.
4. To add business partner information, select the INFORMATION Business Partners tab and perform
the following tasks:
a. Choose Edit and enter the fields as described in the table:
Field Description
Source Business Partner Role Update the source business partner role, if necessary.
5. To add Sales Organization Data, select INFORMATION Sales Organization Data tab and perform the
following tasks:
a. Choose Edit and select inputs for the fields as described in the table:
Field Description
b. Choose Save.
Field Description
Object Address Enter an address of the functional location and any ad
ditional information.
Contact Person Enter the contact person details for the location.
Note
Optionally you can specify the geo coordinates us
ing the visual map.
b. Choose Save.
Context
You can add, view, edit, or delete functional location components, and visual parts assigned to the functional
location.
You can also view the functional location hierarchy using the button.
Procedure
1. To add functional location components, navigate to STRUCTURE AND PARTS Structure Edit and
perform the following tasks:
You can manually arrange the functional location components in the hierarchy by selecting the component
Note
These buttons will be displayed only after you select a component. The same heirarchy will also reflect
2. To view Visual Parts for a functional location, upload a relevant 3D visual file in the DOCUMENTATION
DOCUMENTS section and view them under STRUCTURE AND PARTS Visual Parts .
The viewer search is extended to search for part name, description, manufacturer part number, and EAM
number. You can select search result and display it in the viewer window.
Context
Procedure
1. To add, or assign, or edit an existing document to the functional location, choose the Documentation
Documents tab, and perform the following tasks:
In the Documents section, choose Add menu to upload a new document, and perform the following steps.
Note
This selection is only one of the metadata information for the document. Currently, there
are no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
3. Choose Upload.
You can use Check and Upload to check if there are any duplicates that exist in the system. If
duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then
can Continue Uploading the New File or you can select a file from the duplicate file list and Use
Selected File option to upload it.
c. Choose Add Add Document to add a document.
1. In the Add Document popup browse for a file.
Note
Note
This selection is only one of the metadata information for the document. Currently, there
are no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
3. Choose Upload.
You can use Check and Upload to check if there are any duplicates that exist in the system. If
duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then
can Continue Uploading the New File or you can select a file from the duplicate file list and Use
Selected File option to upload it.
d. Choose Add Add Link to add a document link.
1. In the Add Link popup, provide a URL link to the document along with a Display Name.
Note
This selection is only one of the metadata information for the document. Currently, there
are no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
3. Choose Upload.
You can use Check and Upload to check if there are any duplicates that exist in the system. If
duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then
can Continue Uploading the New File or you can select a file from the duplicate file list and Use
Selected File option to upload it.
e. You can add a new version of a document by selecting the document from the list and choose Add
Add New Version .
1. In the Add New Version popup browse for a file.
Note
2. In the Additional Information section, enter a Description for the document. You can also enter a
long description, if necessary.
3. Choose Upload.
You can select the instructions from the list and choose Remove to unassign the instructions.
Context
Procedure
1. View Notifications
You can view a list of completed, planned and pending notifications for the functional location.
Note
You can also create notifications using the New button. You can also create new notifications using
Manage New Notifications .
You can view a list of completed, planned and pending work orders for the functional location.
5.3.1.5 Timeline
Context
Procedure
To view changes on the fields, template, models, components, header information, document assignment/
unassignment, and business partner information, choose the Timeline tab.
○ Maintain comments or tags for a timeline event.
If a comment is owned by your organization, you can delete it. You can also see the person's name if the
user belongs to your organization, otherwise the company name is displayed as the creator of the
comment.
You can use this process to add new manual entries and update the existing indicator values.
Procedure
Note
Values of indicator are displayed based on Display UoM that is maintained at the template level.
3. To edit the manual entry, select it and choose Manage Manual Entry Edit .
4. To delete the manual entry, select it and choose Manage Manual Entry Delete .
You can update information such as data sheet, functional location information, installation location, structure,
documents and notifications that relate to an existing functional location.
Prerequisites
● To view a functional location, your user ID has the roles FLOC_READ assigned.
● To update an item of equipment, your user ID has the roles FLOC_DELETE or FLOC_EDIT assigned.
Procedure
○ Publish
6. If you choose a functional location that is in a published state, choose Manage New Revision from
the Functional Location screen to edit or update the data.
7. If you have assigned a model to the functional location, then you can view and navigate to the model
assigned to the functional location by choosing the link <Model ID> under INFORMATION Model
Information
○ You can view the Model Information section for a functional location only if it is assigned to a model. In
case you have not assigned a model when creating the functional location, choose Manage Add
Model to view this section.
8. To update additional attributes related to the functional location, select tab INFORMATION Data
Sheet and perform these substeps.
a. Choose Edit.
b. You can reorder the attribute groups using Order and Visibility.
c. You can display the alternate unit of measure using Show Alternate UoM.
You can set the default unit of measurement system in the Unit of Measure Variant under User
Account(icon on the left corner of the launchpad) Settings Unit of Measure .
d. Choose Save.
9. To update information about the functional location like tag number, UID, and so on, select tab
INFORMATION Functional Location Information and perform the following tasks:
a. Choose Edit in the Functional Location Information section.
b. Choose Save.
10. To update business partner information, select tab INFORMATION Business Partners .
a. Choose Edit in the Business Partners section.
b. Choose Save.
11. To update sales organization information, select tab INFORMATION Sales Organization Data .
a. Choose Edit in the Sales Organization Data section.
b. Choose Save.
12. To update installation information, select tab INFORMATION Installation Information and perform
the following tasks:
a. Choose Edit in the Installation section.
b. Choose Save.
You can also view the aggregated indicator value and trend for the indicators in this section.
16. You can perform the following activities in the MAINTENANCE & SERVICE tab:
a. View notifications related to the functional location in the Notifications section.
Use Add Evidence to assign/add improvement requests. You can also create notifications using the
New button.
b. View work orders related to the functional location in the Work Orders section.
17. Choose Publish to publish the updated functional location.
Prerequisites
● View only alerts for the functional location for which you are authorized.
● You need to have Edit authorization to perform action on alerts.
Context
Using this option, it is also possible to sort and filter the alerts and columns that should display on the screen.
Click the respective icons to perform these actions. Click an alert to view the same on the indicator chart. This
chart displays the alert in a time-based line chart together with contributing sensor or score values.
You can view the following alert details: status, type, severity, code, code description, source and indicator.
Note
By default, the default variant displays. It is possible to override the default variant. On navigating from this
page or relogging, the user selected variant persists.
Note
Only users with the role, AlertProcessor can change the alert status.
The role AlertProcessorAdmin can set or change the processor and change the alert status.
This analysis tool enables you to visualize data across one or more indicators for one hierarchy. By default, the
indicators selected as favorite for a user displays on the chart.
Prerequisites
Context
The analysis tool, indicator chart enables you to visualize time series data across one or more indicators for a
functional location hierarchy. You can also view the alerts and threshold related to a particular functional
location.
By default, the first variant displays. You can override the existing variant by selecting from the dropdown. On
navigating from this page or relogging, the user selected variant persists.
Note
You can use the Select Indicators option to select or deselect the indicators.
Procedure
5.4 Locations
Using the Locations application, you can create a location and assign it to your item of equipment. This
assignment is made based on the functionality of the items of equipment.
A location is based on a template and allows users to add values to the definitions used in the underlying
template.
● Unpublished
● In Revision
● Published
You can perform the following operations using the Locations app:
Note
You can remove a child location from a parent location and assign it to a different location.
You use this procedure to create a location where an item of equipment is installed, and add location-specific
attributes to the location.
Prerequisites
Procedure
Note
Field Description
Short and Long Description Provide a description denoting the functional nature of the
unit.
SAP ERP/ S/4HANA Sync Enable the switch in case of external system relevance. By
default, the switch is disabled.
Note
You can inherit subclass information from location
template.
Note
You can change the subclass by using Manage
Change Subclass .
Note
○ The <Address> field autopopulates by inheriting the address from the functional unit or
organization. You can retain the same address or modify as necessary.
○ In the Template dropdown, choose the location template you have created. For more information,
see Creating a Location Template [page 298].
4. To update additional attributes related to a location, select INFORMATION Data Sheet tab and
perform these substeps.
a. Choose Edit.
b. You can assign templates using Add Template.
c. You can select the assigned templates and choose Remove Template to remove the template.
d. You can display the alternate unit of measure using Show Alternate UoM.
You can set the default unit of measurement system in the Unit of Measure Variant under User
Account(icon on the left corner of the launchpad) Settings Unit of Measure .
e. Choose Save.
5. In the Locations object page, navigate to INFORMATION Location Information and choose Edit.
a. In the Location Information field autopopulates by inheriting the address from the section, enter details
as necessary.
In the <Designed Operating State> dropdown, specify the operational state of the location.
You can also specify the <Criticality> and <Safety Risk> for the location.
b. Choose Save.
You can enter the relevant <Object Address>, <Contact Person>, and <Geospatial Data>.
In the Geospatial Data section, specify the latitude and longitude coordinates of the location.
b. Choose Save.
○ You can choose to add the location to an existing group using Add Existing . You can view the list
of groups to which the location is added.
○ You can choose to add the location to a new group using Add New . Fill in the required details to
create a new group.
○
8. To assign a piece of equipment to the functional location, choose STRUCTURE Equipment Assign .
a. From the Select Equipment dialog box, select the equipment. You can also inherit the address of the
location to the equipment. Choose OK.
10. To add, or assign, or edit an existing document to the location, choose the Documentation
Documents tab, and perform the following tasks:
In the Documents section, choose Add menu to upload a new document, and perform the following steps.
Note
This selection is only one of the metadata information for the document. Currently, there
are no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
3. Choose Upload.
You can use Check and Upload to check if there are any duplicates that exist in the system. If
duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then
can Continue Uploading the New File or you can select a file from the duplicate file list and Use
Selected File option to upload it.
b. Choose Add Add Document to add a document.
1. In the Add Document popup browse for a file.
Note
This selection is only one of the metadata information for the document. Currently, there
are no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
3. Choose Upload.
You can use Check and Upload to check if there are any duplicates that exist in the system. If
duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then
can Continue Uploading the New File or you can select a file from the duplicate file list and Use
Selected File option to upload it.
c. Choose Add Add Link to add a document link.
1. In the Add Link popup, provide a URL link to the document along with a Display Name.
Note
Note
This selection is only one of the metadata information for the document. Currently, there
are no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
3. Choose Upload.
Note
2. In the Additional Information section, enter a Description for the document. You can also enter a
long description, if necessary.
3. Choose Upload.
11. In the Documents section, from the Add menu choose Assign to upload an existing document and perform
the following steps:
a. In the Select Documents dialog box, search for an appropriate file.
b. From the Documents search results list, select a document.
c. Choose OK.
You can also use Remove and Download to remove or download any of the documents assigned to the
model.
12. To add instructions to the location, choose DOCUMENTATION Instructions Assign and perform
the following tasks:
a. From the Select Instructions dialog box, select the appropriate instruction.
b. Choose OK.
13. To add Failure Modes to the location, choose DOCUMENTATION Failure Modes Assign and perform
the following tasks:
a. From the Select Failure Modes dialog box, select the appropriate failure modes.
b. Choose OK.
If you have write access to the location even though you do not have write access to the failure mode, you
can edit the failure mode instance page of the location.
When you copy a failure mode and Save & Publish it:
○ A new failure mode is created with the same causes and instructions from the source failure mode
○ The newly created failure mode is directly assigned to the object
○ The new failure mode is in published state
○ You navigate to the new failure mode instance page that includes all the copied failure mode instances:
effects, causes, instructions, and detection method
○ The new failure mode appears in the failure mode section list
You can now flag inherited failure modes to not relevant using the Not Relevant button. This excludes the
failure modes from any assessments relevant to the location.
In the failure mode instance page, you can Add Effect Details like:
14. You can view the list of functions assigned to the location under DOCUMENTATION Functions .
a. Choose Assign.
b. Select a function.
c. Choose OK.
Results
● You can view the list of child locations under Structure Locations
● You can view notifications and work orders, which are associated with the location under Maintenance and
Service. Notifications and work orders can be uploaded from an external system using available public
APIs.
○ View the Maintenance Plans associated with the location.
You can view the maintenance plans based on the following categories as well:
○ Single Cycle
○ Multiple Counter
○ Strategy
○ View Task Lists associated with the location.
You use this procedure to update information such as location information, installation location, and
documents that relate to an existing location.
Prerequisites
4. If you choose a location that is in status Published, choose Manage New Revision from the Locations
object page.
5. Edit the Location Information section, Installation Location section and the Documents section as
necessary.
For more information about field descriptions in each section, see Creating a Location [page 166].
6. Choose Save.
7. Choose Publish.
You use this procedure to delete a location that you do not want to have on the network.
Prerequisites
Procedure
You can use this procedure to view a list of work orders related to a location.
Prerequisites
To view a location, your user ID has the roles FUNCTIONAL_LOCATION_READ assigned to it.
Context
You can view the following work orders details: work order ID, order short description, order status, order type,
order priority, order long description, start date, end date, actual duration, or planned duration.
Click a notification ID to view more details of the same in the object page. An indicator chart displays with the
notification details. You can view the start and end date of notifications. If these dates are not available, the
current date of notification is plotted on the chart, with the measurement point time series data.
Note
In case of work orders that do not have an assigned equipment, then the indicator chart will not work.
For more information about indicator chart, refer Viewing Time Series Data (Indicator Chart) of an Equipment
[page 122].
● Sort the work orders by - Ascending, Descending, Type, Priority, Start Date, or End Date.
● Group work orders by- Ascending, Descending, Type, or Priority.
● Filter work orders by - Type or Priority.
You can have more than one service provider for a location. Multiple business partners can have the same role.
Note
If the order status is <TECO> or closed, then the actual duration is displayed, otherwise the planned
duration is displayed.
Procedure
You can view the list of work orders associated with the location. Select and open a work order to view
more details of work order.
You use this procedure to visualize all the notifications associated with alocation.
Prerequisites
You must have the roles FUNCTIONAL_LOCATION_READ assigned to your user ID in the SAP BTP account.
Context
Using this option, it is also possible to sort, filter, group notifications, and create new notifications. Click the
respective icons to perform these actions. Depending on the action performed on these notifications, the
progress statuses - completed, planned, and pending displays against each notification. It is also possible to
create an improvement request or edit an improvement request using the Add Evidence button. Also, create a
notification using the <New> option.
Click a work order ID to view more details of the same in the object page. A indicator chart displays with the
work order details. You can view the start and end date of work orders. If these dates are not available, the
current date of work order is plotted on the chart, with the measurement point time series data.
Note
In case of work orders that do not have an assigned equipment, then the indicator chart will not work.
For more information about indicator chart, refer Viewing Time Series Data (Indicator Chart) of an Equipment
[page 122].
To view the details of notification, click the respective notification ID. The progress of notifications is as below:
Procedure
5.5 Functions
Functions are used to define how the assigned objects are intended to operate. You can assign functions to
equipment, models, locations and systems.
You can currently use this feature in the Reliability Centered Maintenance (RCM) assessment.
Note
Context
Procedure
Field Description
Type (*) Select the type for the function from the list.
4. Choose Save.
5. Once saved, the function is listed in the list page.
There is no status for functions, once saved the function is directly published.
6. Choose the function from the list, the Basic Information section lists all the details that you have entered
while creating a function.
You can use Remove to remove any existing document and download the documents using Download.
8. In the Assignments section, you can assign equipment, models, locations, or systems to the function.
Procedure
A failure mode is a probable failure that could occur to piece of equipment. In case SAP Asset Intelligence
Network is available, the manufacturer shares the failure modes with the operator; else the operator has to
upload or enter the failure modes on their own. The failure mode keeps the operator informed about possible
failures and helps them to handle the failure modes efficiently.
A failure mode is always associated with a subclass and may have more than one category.
The following types of failure modes can occur to any of the following business objects associated with a piece
of equipment (equipment, models, spare parts, locations, groups):
You can now view the Reliability, Availability, Maintainability, and Safety (RAMS) figures for the failure modes.
You can perform various operations; such as creating a failure mode, viewing a failure mode, updating a failure
mode, deleting a failure mode, and assigning models, pieces of equipment, spare parts, groups, and locations
to a failure mode.
Context
You use the Failure Modes application to perform the following operations:
Note
A failure mode can be in any status when you assign a business object to it.
You use this procedure to create a failure mode and assign business objects such as models, items of
equipment, spare parts, groups, and locations to the failure mode.
Prerequisites
Field Description
Category (*) Select one or more categories relevant for the failure
mode.
Note
By default, Others is selected.
Type (*) Select the type of failure mode. The following list pro
vides the descriptions for each type of failure mode:
○ 1 - Designed function is not obtained
○ 2 - Specified function lost or outside accepted op
erational limit
○ 3 - Non critical failures
Note
As a default, 3 - Non Critical failures
is selected.
Note
Note
You can choose New to add new causes or Assign to add existing causes.
b. From the Select Causes dialog box, select the relevant cause or create a new cause using the Create
Cause dialog box.
c. Choose Assign.
13. To add instructions, follow these steps:
Results
When you copy a failure mode and Save & Publish it:
● A new failure mode is created with the same causes and instructions from the source failure mode
● The newly created failure mode is directly assigned to the object
● The new failure mode is in published state
● You navigate to the new failure mode instance page that includes all the copied failure mode instances:
effects, causes, instructions, and detection method
● The new failure mode appears in the failure mode list
You can view a failure mode to verify whether the information contained in a failure mode is appropriate.
Prerequisites
● To publish a failure mode, your user ID has the roles FAILURE_MODE_DELETE or FAILURE_MODE_EDIT
assigned to it.
● To view a failure mode, your user ID has the role FAILURE_MODE_READ assigned to it.
Context
If you have assigned a business object to a failure mode, you can navigate to the business object details and
work on the business object.
Procedure
For more information about working with models, see Models [page 131].
b. Choose Equipment to view the pieces of equipment assigned to the failure mode.
For more information about working with equipment, see Equipment [page 95].
c. Choose Locations to view the locations assigned to the failure mode.
For more information about working with locations, see Locations [page 165].
d. Choose Spare Parts to view the spare parts assigned to the failure mode.
For more information about working with spare parts, see Spare Parts [page 189].
e. Choose Groups to view the group assigned to the failure mode.
For more information about working with groups, see Groups [page 199].
5. On the Failure Mode screen, choose the Causes tab to view all the possible causes related to the failure
mode.
If you want to view details of the relevant business object, double-click it.
You can delete or update existing information within a failure mode or add missing information to a failure
mode.
Prerequisites
● You have identified the failure mode that you want to update.
● To update a failure mode, your user ID has the roles FAILURE_MODE_DELETE or FAILURE_MODE_EDIT
assigned to it.
Context
You can add possible causes or create new causes for a failure mode.
Procedure
You can delete a failure mode that you no longer want to have on the network.
Prerequisites
To delete a failure mode, your user ID has the role FAILURE_MODE_DELETE assigned to it.
Procedure
You can select more than one failure mode for deletion.
4. On the Failure Mode List screen, choose Delete.
You can copy a failure mode to create a new failure mode similar to the existing failure mode.
Prerequisites
To copy a failure mode, your user ID has the role FAILURE_MODE_DELETE and FAILURE_MODE_EDIT
assigned to it.
Procedure
You can use this procedure to assign a business object to a failure mode.
Prerequisites
● You have identified the business object that you want to assign.
● Your user ID has the roles FAILURE_MODE_DELETE or FAILURE_MODE_EDIT assigned to it.
Context
● Models
● Equipment
● Locations
● Spare Parts
● Groups
● Systems
● Instructions
Note
For simplicity's sake, we will describe the procedure for assigning a failure mode to a model.
Procedure
You can select one or more models from the list and choose Assign.
Fingerprint is defined as a collection of snapshot of indicator chart derived from a set of indicators and
metadata (type, data & time, description, equipment state, documents) for a specific time period. It describes
the reference state of a single piece of equipment that can be used for further process steps, for example,
equipment documentation.
Fingerprints help operators and manufacturers to define normal, reference, or failure states for equipment.
They can use these states at a later point in time to detect deviations/distances/trends from the normal
behavior and plan actions to get the equipment back to the normal state.
Prerequisites
Procedure
Enter the <Fingerprint Name> and <Short Description> in the Create New Fingerprint dialog
box.
e. Go to SNAPSHOTS.
f. Click New.
g. Go to Select Indicators. Select the indicators that you want to record the fingerprint for.
h. Choose Capture.
You can adjust the capture screen to select a specific period in the indicator chart.
i. Choose OK and provide the snapshot description.
j. Choose Save.
k. You can also provide any relevant comments in the Comments section.
2. From Fingerprints app:
You can adjust the capture screen to select a specific period in the indicator chart.
g. Choose OK and provide the snapshot description.
h. Choose Save.
i. You can also provide any relevant comments in the Comments section.
Results
Note
● You can capture multiple snapshots with different indicator set and time-periods in a fingerprint.
● Once you have created a snapshot, you cannot edit them.
Prerequisites
Procedure
Results
You can view the snapshot and perform basic functions like sort, filter on the snapshot. Any changes on the
fingerprint will be recorded in the Timeline section.
Prerequisites
Procedure
Note
Once the status is set to Approved, you can no longer edit the fingerprint. However, you can still post
relevant comments.
You can use the Edit Header to edit the header information.
Prerequisites
Procedure
With SAP Predictive Asset Insights, you can create and maintain a record of these spare parts. Also, if these
spare parts are fitted into the physical item of equipment, you can assign these spart parts to the
corresponding model on the network.
In SAP Predictive Asset Insights, you can record the spare part's manufacturing information, dimensions,
quantity, shelf life, to name a few. A spare part inherits attributes from a subclass. You can assign a spare part
to a model.
Note
After the spare part is assigned to a model, we refer to the spare part as "Part".
Context
You can use the Spare Parts application to perform the following operations:
Note
You perform this procedure to maintain manufacturing information, technical data, and assignment
information pertaining to spare parts.
Prerequisites
Procedure
2. To create a single spare part, navigate to New Single Spare Part . To create spare parts by mass
upload, follow these substeps:
Note
The CSV file must be in UTF-8 format in order to consider all the special characters.
Field Description
Short (*) and Long Description Provide a description for the spare part
Manufacturer (*) Choose the name of the manufacturer of the spare part
4. Choose Save.
5. In the Spare Parts details screen, to add the unit of measure and long description perform the following
steps:
a. Go to the INFORMATION section and choose Edit.
b. Select the unit of measure from Unit of Measure.
You can set the default unit of measurement system in the Unit of Measure Variant under User
Account(icon on the left corner of the launchpad) Settings Unit of Measure .
e. Choose Save.
In the ASSIGNMENTS section, you can view the details of models, equipment, locations, or instructions
that are assigned to the spare part.
○ By assigning models to the spare part, the model owner can provide specific information about Default
Delivery Quantity and Advised Stock Quantityof the spare part.
○ Instructions are for the operator about the spare part use.
10. In the Spare Parts Details screen, to add the spare part to a group perform the following steps:
a. Go to INFORMATION section.
b. Choose Add and select if you want to add a spare part to a new group or to an existing group. Similarly,
you can remove a spare part from a group by using Remove.
c. Choose Save.
11. In the Spare Parts Details screen, to view or assign spare part successor information about, perform the
following steps:
a. Go to the INFORMATION Life Cycle Information Successor Spare Part section and choose
Assign.
b. Select one or more spare parts in the Assign Successor dialog box.
c. Choose Assign.
If you have write access to the spare part even though you do not have write access to the failure mode,
you can edit the failure mode instance page of the spare part.
When you copy a failure mode and Save & Publish it:
○ A new failure mode is created with the same causes and instructions from the source failure mode
○ The newly created failure mode is directly assigned to the object
○ The new failure mode is in published state
○ You navigate to the new failure mode instance page that includes all the copied failure mode instances:
effects, causes, instructions, and detection method
○ The new failure mode appears in the failure mode section list
In the failure mode instance page, you can Add Effect Details like:
○ Local Effect Description: describes the direct effect on the equipment or the how it affects the
equipment it is part of.
○ Higher-Level Effect Description: describes how is the system affected the equipment is part of.
○ End Effect Description: describes the ultimate effect that the failure has on safety and/or the
environment (if any) and any impact on production or operational capability.
○ Potential Worst-Case Effect Description: specifies what would happen in case no measures would be
taken to anticipate, prevent, or detect the failure.
Results
If you have integration with SAP Hybris Commerce, then you can also view the Add to Cart icon on the page.
You perform this activity when you want to remove a spare part from the network.
Prerequisites
Procedure
Context
To get familiar with SAP 3D Visual Enterprise Author tool. Please refer https://help.sap.com/viewer/
8e4c65bb3a6c4ef6b56dc27d1d95cde6/9.0.0.4/en-US
To maintain spare part metadata according to the relevant product standards, please go through following
steps:
Procedure
3. Export the current metadata of VDS Viewer to maintain spare parts metadata according to product
standards. Refer to https://help.sap.com/viewer/67c291fba1bd10148bea8dce7b0caa3e/9.0.0.4/en-US/
0fd8ec37c0574419bb7a7487f5f47741.html
Note
Before exporting select all the spare parts of the VDS to see all the metadata with respect to each node
by moving to Display panel and pressing CTRL+A .
4. Open excel and try to open the file, which you have just exported as .txt file.
0 These are the unique Locator ID for each spare part of the
VDS. This is already provided as part of the VE document.
VE Name This is the Name of the spare part and is already provided
as part of the VE document.
AIN / Manufacturer It describes the manufacturer of the spare part and will
also play vital role in mapping these spare part to any AIN
object.
AIN / ManufacturerDescription This describes any additional description about the Manu
facturer of the spare part.
AIN / EANNumber It describes the standard bar code symbology and num
bering system used in global trade to identify a specific
spare part in VDS.
AIN / PartName It describes any other part name given to the spare part
AIN / Quantity It describes how many of these spare parts are used in a
certain VDS.
AIN / UOM It describes what will be the unit of measure for this spare
part.
AIN / ShortDescription_XX It describes the short description for spare parts. Here XX
can be any valid language code.
Example: en, de
AIN / LongDescription_XX It describes the long description for spare parts. Here XX
can be any valid language code.
Example: en, de
6. Import the excel created with the product-specific data to the same VDS. Refer to https://help.sap.com/
viewer/67c291fba1bd10148bea8dce7b0caa3e/9.0.0.4/en-US/
3569c3003f0f443da3f702a2c25268ee.html
5.9 Groups
You can group together different business objects for multiple purposes.
● Criticality Assessment
Allowed object types: Equipment, Locations
● Fleet
Allowed object types: Equipment
● FMEA (Failure Mode Effect Analysis)
Allowed object types: Equipment, Locations
● Training
Allowed object types: Equipment, Models, Instructions, Locations, Spare Parts, Templates, Documents,
Announcements
● Handover and Commissioning
Allowed object types: Equipment, Models, Instructions, Locations, Spare Parts, Templates, Documents,
Announcements
● Maintenance Planner
Allowed object types: Equipment, Locations, Notifications, Work Orders, Work Order steps
● Organization
Allowed object types: Equipment, Models, Locations
● Project
Allowed object types: Equipment, Models, Instructions, Locations, Spare Parts, Templates, Documents,
Announcements
● Spare Parts Kit
Allowed object types: Spare Parts
● Variant
Allowed object types: Models, Spare Parts
A group moves from one state to another during its process of creation and maintenance. The different states
that a group goes through are listed here:
● Unpublished
● Published
● In Revision
You can perform various operations on a group such as creating, viewing, updating, and deleting a group. You
can also assign equipment, models, instructions, locations, spare parts, templates, documents, and
announcements to a group.
Context
You can perform the following operations using the Groups application:
You use this procedure to create a group and assign business objects such as equipment, models, instructions,
locations, spare parts, templates, documents, and announcements to the groups.
Prerequisites
Procedure
Field Description
Allowed Member Types(*) Lists the type of business objects that can be assigned
to the group type.
Note
To create a revision of a group or to work with the last published group, or last revision of group, see
Creating Revisions and Switching Between Revisions and Published State [page 315].
You can view a group to verify whether the information contained in a group is appropriate.
Prerequisites
● To publish a group, your user ID has the roles GROUP_DELETE or GROUP_EDIT assigned.
● To view a group, your user ID has the role GROUP_READ assigned.
If you have assigned a business object to a group, you can navigate to the business object details and work on
the business object.
Procedure
To publish one or more unpublished groups, select the groups from the list and choose Publish.
3. Choose a group from the search list and double-click to view details.
4. In the Group screen, choose the Group Information tab to view the details that are specific to the group.
5. In the Group screen, choose the Members tab to view the business objects assigned to the group.
6. In the Group screen, choose the Analytics tab to view the graphical representation of equipment assigned
to the group based on population and age.
7. View the failure modes assigned to a group under Failure Modes.
Note
8. In the Group screen, choose the Timeline tab to view the relevant changes made on the group.
You can correct the information within a group, or add any missing information to a group.
Prerequisites
Context
● Properties of a group such as – group type, group ID, created by, or allowed object types.
● Business objects assigned to the group.
You can delete a group that you no longer want to have on the network.
Prerequisites
Procedure
You can copy a group to create a new group similar to an existing group.
Prerequisites
To copy a group, your user ID has the role GROUP_DELETE and GROUP_EDIT assigned to it.
Procedure
You can use this procedure to assign business objects, such as equipment, models, instructions, locations,
spare parts, templates, documents, and announcements to a group.
Prerequisites
● You have created a group to which you want to assign a business object.
● You have created a business object that you want to assign to the group.
● To copy a group, your user ID has the role GROUP_DELETE and GROUP_EDIT assigned.
Context
Procedure
5.10 Systems
A system is defined as a set of interrelated equipment or subsystems that regularly interact or are
interdependent. In a defined context, they are considered whole and separated from their environment serving
a common purpose. For example, control system, transmission system, brake system, and so on.
You can define a system based on a system model and assign system template to it.
● Information
You can view the following information in this section:
○ Data Sheet
○ Model Information
○ Installation Information
○ Installation Location
○ Lifecycle Information
● Structure
You can view a list of subsystems and equipment associated with the system.
● Documentation
You can view the documents and instructions assigned to a system.
You can create, view, update, and delete a system. You can share a system using the Authorizations app.
Context
You can perform the following operations on the system data using the Systems app:
● Create a system and assign additional information such as installation information, location information,
and attach documents and instructions to it.
● Assign or remove equipment or subsystems.
● Assign, update or remove spare parts.
● Add and remove documents or instructions.
● Publish a system.
You use this procedure to create a system based on an existing system model, and add additional information
such as system installation information, and related equipment and subsystems to the system. You can also
assign documents and instructions relevant to the system.
Prerequisites
Context
For simplicity purpose, we describe the procedure to create a system for your own operations.
Procedure
You can now create a system without assigning a model to it. You can also remove a model assigned to
a system by using Manage Remove Model .
b. In the <System ID> field, enter a unique name for a system.
c. In the <Short Description> field, enter a short description for the system.
d. In the <System Templates> dropdown, choose the system template you have created.
For more information about creating an equipment template, see Creating a System Template [page
301].
e. In the <Long Description> field, enter a long description for the system.
f. In the <Operator> field, select an operator for the equipment. Your company is selected as default
value.
4. To update additional attributes related to a system, select INFORMATION Data Sheet tab and
perform these substeps.
a. Choose Edit.
b. You can add a template using Add Template.
c. You can select a template and choose Remove Template to remove the template.
d. You can display the alternate unit of measure using Show Alternate UoM.
You can set the default unit of measurement system in the Unit of Measure Variant under User
Account(icon on the left corner of the launchpad) Settings Unit of Measure .
e. Choose Save.
5. To add installation information, select the INFORMATION Installation Information tab and perform
the following tasks:
a. Choose Edit and enter the fields as described in the table:
Field Description
Source Business Partner Role Update the source business partner role, if required.
Service Provider Select the name of the service provider for the system.
To assign a tag, choose Add/Remove Tags and enter your tags. You can use tags to help you logically
categorize activities, information, or reminders about your system.
6. To add system components, navigate to STRUCTURE Structure tab and perform the following tasks:
a. To add systems:
1. Go to Systems tab.
2. Choose Assign Systems .
3. Select the systems in the Select Systems dialog box.
4. Choose OK.
b. To add equipment:
You can reorder the system components by using the ordering buttons on the structure in the edit
mode.
1. In the Structure section, choose Edit.
2. Select a system or equipment from the list.
3. Choose Move to Top, Move Up, Move Down, or Move to Bottom to reorder.
7. To view the system topology, navigate to STRUCTURE AND PARTS Topology . For more information,
refer to Viewing System Topology [page 215].
8. To add system spare parts, navigate to STRUCTURE AND PARTS Spare Parts Assign and perform
the following tasks:
a. From the Assign Spare Parts dialog box, select the appropriate spare parts.
b. Choose Provide Quantity to specify the quantity of each spare part. You can also enter a comment if
necessary.
c. Choose Assign.
The spare parts are by default inherited from the model assigned to the system. You can also directly
assign, or maintain existing spare parts for system using the Edit and Remove buttons. Similarly, you can
view the associated documents when a spare part is being shared.
Note
If you have integration with SAP Commerce Cloud, then you can also view the Add to Cart button for
each spare part. Currently, you can only add one spare part for each order request.
9. To add instructions to the system, go to DOCUMENTATION Instructions and perform the following
tasks:
a. Choose Assign.
b. From the Select Instructions dialog box, select the appropriate instruction.
c. Choose OK.
10. To add, or assign, or edit an existing document to the system, choose the Documentation
Documents tab, and perform the following tasks:
In the Documents section, choose Add menu to upload a new document, and perform the following steps.
This selection is only one of the metadata information for the document. Currently, there
are no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
3. Choose Upload.
You can use Check and Upload to check if there are any duplicates that exist in the system. If
duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then
can Continue Uploading the New File or you can select a file from the duplicate file list and Use
Selected File option to upload it.
b. Choose Add Add Document to add a document.
1. In the Add Document popup browse for a file.
Note
Note
This selection is only one of the metadata information for the document. Currently, there
are no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
3. Choose Upload.
You can use Check and Upload to check if there are any duplicates that exist in the system. If
duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then
can Continue Uploading the New File or you can select a file from the duplicate file list and Use
Selected File option to upload it.
c. Choose Add Add Link to add a document link.
1. In the Add Link popup, provide a URL link to the document along with a Display Name.
Note
Note
This selection is only one of the metadata information for the document. Currently, there
are no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
3. Choose Upload.
You can use Check and Upload to check if there are any duplicates that exist in the system. If
duplicate files exist, you will then view the files in the Similar Files Detected dialog box. You then
can Continue Uploading the New File or you can select a file from the duplicate file list and Use
Selected File option to upload it.
d. You can add a new version of a document by selecting the document from the list and choose Add
Add New Version .
1. In the Add New Version popup browse for a file.
Note
2. In the Additional Information section, enter a Description for the document. You can also enter a
long description, if necessary.
3. Choose Upload.
11. In the Documents section, from the Add menu choose Assign to upload an existing document and perform
the following steps:
a. In the Select Documents dialog box, search for an appropriate file.
b. From the Documents search results list, select a document.
c. Choose OK.
You can also use Remove and Download to remove or download any of the documents assigned to the
system.
12. You can assign, copy, or remove failure modes relevant to the system in the DOCUMENTATION Failure
Modes section.
a. To assign failure modes:
1. Choose Assign.
2. Select the failure modes from the Select Failure Modes dialog box.
3. Choose OK.
b. To copy a failure mode, select the failure mode from the list and choose Copy.
If you have write access to the system even though you do not have write access to the failure mode, you
can edit the failure mode instance page of the system.
When you copy a failure mode and Save & Publish it:
○ A new failure mode is created with the same causes and instructions from the source failure mode
○ The newly created failure mode is directly assigned to the object
○ The new failure mode is in published state
○ You navigate to the new failure mode instance page that includes all the copied failure mode instances:
effects, causes, instructions, and detection method
○ The new failure mode appears in the failure mode section list
You can view the failure mode instance which is directly assigned (at the same time), you can now view
different object icons in the <From> field of the failure mode section if the failure mode is inherited or
assigned directly to the system.
13. You can view the list of functions assigned to the system under DOCUMENTATION Functions .
a. Choose Assign.
b. Select a function.
c. Choose OK.
Note
You cannot remove functions that are inherited from the model. Only functions assigned to the system
instance can be removed.
You use this procedure to view and update information such as installation information, instructions, and
documents that are related to a system.
Prerequisites
Procedure
4. If you choose a system that is in a published state, choose Manage New Revision from the System
object page.
a. To add a document, choose DOCUMENTATION Documents and perform the following tasks:
You can view any changes in the sharing activities in the timeline section. You can also selecta time period
to view only the changes during that timeframe using the Filter By dialog box.
You can also choose to view all the changes or only changes made on the associated model or system data
using the Filter By dialog box. By default, it shows changes on system data only in the timeline.
9. View the system toplogy under the Topology section. You can also save a topology for future reference.
10. Choose Publish to publish the updated system.
Prerequisites
● To update a system, your user ID has the roles SYSTEM_DELETE or SYSTEM_EDIT assigned.
● You have created systems in any of the following states:
○ Unpublished
○ Published
○ In Revision
Context
You can view the list of systems using the Systems app and perform a mass publish when you have to publish
many systems.
You can delete a system that you do not want to have on the network.
Prerequisites
● To update a system, your user ID has the roles SYSTEM_DELETE or SYSTEM_EDIT assigned.
● You have created systems in any of the following states:
○ Unpublished
○ Published
○ In Revision
Procedure
The system topology displays the network of equipment and subsystems, and how these are connected within
this specific system.
EQ1 to EQ10 are part of a system called Bottling Machine and are displayed in the topology according to their
connections.
Prerequisites:
Procedure
Note
○ Ports communicated in the configuration API call are considered active, any ports that were
defined in a previous configuration API call, but have removed ports in a subsequent
configuration API call are considered inactive.
Example:
configuration API call 1 communicates: Interface 1 – Port 1 and Port 2 (i.e. Port 1 and Port 2 are
considered active);
2. Go to the Systems app and open the system into which you loaded the topology data.
3. Select the Topology tab to view the topology after initial load.
1. View the Connection Details by clicking on a connection line between 2 pieces of equipment.
This will show you:
○ the Equipment ID and Equipment Short Description
○ the interface and port information for each of the connected pieces of equipment for the selected
connection
2. Open the detailed information in the side panel by clicking on an equipment in the topology.
This will show you:
○ the Equipment ID and Equipment Short Description
○ Equipment Status
○ Manufacturer
○ Path information of parent objects of the Equipment
○ List of all interfaces and all (that is, connected as well as disconnected) ports for each interface for
the selected equipment.
Note
By clicking on the Equipment links in the side panel you open the Equipment Details quick view
where you can get additional information for the selected equipment.
You can also navigate to the Equipment object page from quick view (via Display Equipment
Details).
You can save a planned topology for future reference using the Save as Reference button. The API always refer
to the actual topology. The APIs always compare an actual topology with a planned/reference topology that
was saved as reference and display the differences between the two topologies. The following legends are used
to depict the differences:
● All the new equipment and their networks are displayed in green.
5.11 Documents
● View all the documents that are used by your organization in your product.
● Upload new documents and assign the document to business objects such as models, items of equipment,
announcements, requests, locations, spare parts, and instructions (see Uploading a Document [page 219]
and Assigning Documents to Business Objects [page 229])
● Edit attributes of multiple documents centrally so that the changes apply to all associated business objects
(see Editing Document Attributes [page 225])
● Delete documents that are not required on the network (see Deleting a Document [page 230])
● Upload a link as document and assign the document to business objects such as models, items of
equipment, announcements, requests, locations, spare parts, and instructions.
Documents with links allow reference to documents in external DMS and other document systems.
● Add the documents to different groups.
● Search for a document based on origin, phase category, file type, and so on.
● Download the documents using the Download option. You can also opt to download all the versions of a
document.
● You can view the number of available versions in the Version field on the list page. If there are more than
one version of the file in the same or different languages, you can view and download these versions by
choosing the version number. It will open a dialog box with the file details.
● Improved SAP ERP synchronization of documents:
○ Mapping document content to DIRs considering the version and language assignments.
○ Synchronizing various changes, including versioning between the DIRs and document files in asset
central foundation.
Note
You must have configured a prefix for the object ID of your organization to perform above operations on the
documents. For more information, refer to Configuring the Prefix for the Object ID of your Organization
[page 436].
● Overwrite any language file of a document record for business partner with write permission.
● Delete any language files even if uploaded by another business partner, except for the last remaining
language file of the document record. The last remaining language file for a document record can only be
deleted by the owner of the overall document record.
You can upload a document up to 25 MB. To upload a document of a higher size, configure using the
Application Settings app. For more details, see Configuring Document Upload Size [page 437]
Prerequisites
● The document you want to upload is among the supported document formats and the configured file size.
For more details, see Documents [page 218]
Procedure
Note
This selection is only one of the metadata information for the document. Currently, there are
no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
c. Choose Upload.
You can also run a duplicate check and if no duplicates, only then upload a document using the Check
and Upload button.
Note
Note
This selection is only one of the metadata information for the document. Currently, there are
no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
c. Choose Upload.
You can also run a duplicate check and if no duplicates, only then upload a document using the Check
and Upload button.
Note
Note
This selection is only one of the metadata information for the document. Currently, there are
no other actions performed based on the different value selected for this field.
○ Select the language from the dropdown that corresponds to the documents.
○ Enter a description. You can also enter a long description, if necessary.
○ Select the confidentiality of the document if it’s not shared with everyone.
c. Choose Upload.
Results
The following table lists the MIME types and the MIME groups.
MIME Groups
cedocument.wordprocessingml.docu
ment
ment.macroenabled.12
cedocument.wordprocessingml.tem
plate
cedocument.presentationml.presenta
tion
ment.spreadsheet
ment.text
nary.macroenabled.12
cedocument.spreadsheetml.template
cedocument.spreadsheetml.sheet
Prerequisites
● The document you want to upload is among the supported document formats and the configured file size.
For more details, see Documents [page 218]
Procedure
When uploading a new document, you can upload the document directly without checking for duplicate
documents in the system.
You can use Check and Upload to check if there are any duplicates that exist in the system. If duplicate files
exist, you’ll then view the files in the Similar Files Detected dialog box. You then can Continue Uploading the
New File or you can select a file from the duplicate file list and Use Selected File option to upload it.
You can select an existing language file and use Add New Version to create a new version of the
document.
You can view the number of available versions in the Version field on the list page. If there are more than one
version of the file in the same or different languages, you can view and download these versions by choosing
the version number. It will open a dialog box with the file details.
Prerequisites
Procedure
○ To add new files, choose Add Add File . For more information, see Maintaining Different
Language Versions of a Document [page 224].
○ To add new description, select a file from the list, choose Add Add Description . You can add
language, description, long description. Choose Add.
○ To add a new version, select a file from the list, choose Add Add New Version . You can add a file,
description, long description. Choose Upload.
○ To edit a file, select a file from the list, choose Edit. You can add a file, description, long description.
Choose Upload.
○ To delete a file, select a file from the list, choose Delete. For more information, see Deleting a
Document [page 230].
○ To delete a file description, select a file from the list, choose Delete Delete Description . A
confirmation message is displayed, choose OK.
○ To download a file, select a file from the list, choose Download. You can also download all the versions
of the file using Download Download All Versions .
Prerequisites
Procedure
The following table lists the MIME types and the MIME groups.
MIME Groups
.deb
.tar
.tgz
.msz
Prerequisites
● You have the identified the business object that you want to assign to and the business object is in either an
Unpublished state, or in In Revision state.
● Your user ID has the roles DOCUMENT_DELETE or DOCUMENT_EDIT assigned.
Context
● Models
● Announcements
● Equipment
● Instruction steps
● Locations
● Improvement cases
● Spare Parts
● Systems
● Functional Locations
Note
You can assign multiple documents to a spare part using this application. The where used list of a
document displays the assigned spare part.
Procedure
Prerequisites
Procedure
Note
○ When you choose to delete a document, the system deletes the document from the SAP Predictive
Asset Insights permanently.
○ When you choose to delete a document that is assigned to an improvement case, the document
gets deleted from the improvement case without a warning.
A hotspot is an area on the visual image that is of more interest. A hotspot allows you to view detailed
information of a model component in a pictorial way. You can assign additional information to a hotspot such
as model, equipment, and instruction to which users can navigate to. A published object can be tagged to a
hotspot, allowing you to tag supported objects without the need to create a new revision for the object. You can
assign hotspots to models, equipment, instruction steps, documents, locations, spare parts, and szstems and
include relevant specifications.
Prerequisites
Note
You can also select multiple images while editing. All the images you have selected queue up in the
image viewer for editing.
System adds the image file that has the hotspots to the Document section of the above mentioned objects.
Note
If you want to unassign the image files that has the hotspots from the Document section of these
objects, you must remove the hotspot attributes.
Procedure
Note
The document you are about to add might already exist in your organization’s library. Use the search to
sweep for similar documents first.
3. Two different sources for adding a new document are provided. You can either browse for a file or provide a
URL link to the document along with a display name.
Note
○ The name of the uploaded file will be displayed as the file name in Asset central.
○ You cannot upload private domains such as .corp as links.
document.
6. You can assign a phase if desired. Assigning a phase specifies the document and helps other users to find
relevant documents.
7. If you want the document to be confidential, you can tick the checkbox. With classifying the document as
confidential, the document will stay within your application and will not be shared with other business
partners at any time.
Note
○ If you are a premium account holder, all the private documents uploaded by your invitees can be
accessed by you. Your invitees cannot have private documents without your knowledge.
○ Confidentiality set by your invitee for a particular document applies to the you as well.
Note
To add a new language version, you need to navigate back to the document list.
Context
We will take you through the process of assigning documents to business objects. You can assign documents to
the following objects:
● Models
● Announcements
● Equipment
● Instruction steps
Procedure
4. To assign the selected documents to an Equipment, choose <Assign> and <Equipment> from the list of
all business objects.
Context
We will take you through the process of maintaining different language versions of an already existing
document.
Procedure
2. Select the desired document you want to maintain a different language version for by ticking the check
box.
4. In the pop-up a list of all existing language versions is displayed. Choose <Add> to add a new language file.
6. Select the language from the dropdown that corresponds to the document.
8. Choose Upload.
5.12 Announcements
An announcement is an information record that can communicate between the various business partners that
have a relationship with a Model or an Equipment. For example: an existing instruction has been updated, or
An announcement moves from one state to another during its process of creation and maintenance. The
different states that an announcement goes through are listed below:
● Unpublished
● Published
● In Revision
You can perform various operations on an announcement such as creating an announcement, viewing an
announcement, updating an announcement, deleting an announcement, and assigning documents, models,
items of equipment and locations (of type Availability) to an announcement.
Context
You use the Announcements application to work with an announcement. You can perform the following
operations using the Announcements application:
You use this procedure to create an announcement and assign entities such as documents, instructions, and
models to an announcement.
Prerequisites
● If you want to assign a new or an existing document, you have identified the file that you want to attach.
● Your user ID has the roles ANNOUNCEMENT_DELETE or ANNOUNCEMENT_EDIT assigned.
Procedure
Field Description
4. For an announcement of type Availability, you must assign an equipment or location. To assign an item of
equipment, follow these steps:
a. In the Equipment section, choose Assign.
b. From the Select Equipment pop-up, select the relevant equipment.
c. Choose Assign.
Note
You now have the Fully Available for the announcement type Availability. You can now announce if a
piece of equipment is available or not available.
Note
Field Description
File Name Browse for a file name that you want to upload.
b. Choose Upload.
Note
8. In the Documents section, if you want assign an existing document, choose Add Assign and perform
the following tasks:
a. In the Assign Documentspop-up, search for an appropriate document using the filters Phase, or
Category.
b. From the search results list, select an appropriate document.
c. Choose OK.
9. To add a hotspot to image file, see Creating Hotspots [page 230].
10. In the Models section, to assign a model to the announcement choose Assign and perform the following
tasks:
a. In the Assign Models pop-up, search for an announcement using the filters Class Name, Subclass
Name, Manufacturer, or Source.
b. From the search results list, select a model.
c. Choose OK.
11. To save the announcement, choose Save.
12. To publish the announcement, choose Save and Publish.
13. To create a revisions of an announcement, or to work with the last published or last revision
announcement, see Creating Revisions and Switching Between Revisions and Published State [page 315].
You can view an announcement to verify if the information contained in an announcement is appropriate or not.
Prerequisites
Context
When you create many announcements using public APIs provided by SAP AIN, you can view these
announcements using the Announcements app and perform a mass publish of such announcements. In
addition, if you have assigned a model to an announcement, or an instruction to an announcement, you can
navigate to the model details or the instruction details and work with a model or an instruction.
The following procedure applies to all types of announcements (Instruction change, Service Bulletin, RecallNew
Policy, New Model, Document Change, Spare Parts Change, Model Information Change, New Firmware,
Availability). For simplicity, we only describe the Instruction Change procedure.
Procedure
Note
To publish one or more unpublished announcements that are created either using APIs, or using the
Announcements application, select the announcements from the list and choose Publish.
3. Choose an announcement from the search list and select View Details.
4. In the Announcement screen, choose the Information tab to view the details that are specific to the
announcement. These details can include Name, Type, Priority, and Description.
5. In the Announcement screen, choose the Instructions tab to view the instructions assigned to the
announcement.
For more information on working with instructions, see Instructions [page 251].
6. In the Announcement screen, choose the Documents tab to view the relevant documentation available for
an announcement.
If you want to view details of a model, select the model and choose View Details.
For more information on working with models, see Models [page 131].
You update an announcement to correct the information within an announcement, or add any missing
information.
Prerequisites
Context
Procedure
You can delete an announcement that you no longer want to have on the network. For simplicity, we only
describe the procedure to delete an instruction change announcement.
Prerequisites
Procedure
Prerequisites
● You must have created an announcement, to which you want to assign a model. (see Creating an
Announcement [page 245].)
● You must have created a model that you want to assign to the announcement. (see Creating a Model [page
133])
● Your user ID has the roles ANNOUNCEMENT_DELETE or ANNOUNCEMENT_EDIT assigned.
Procedure
5.13 Instructions
An instruction is a set of steps that help the user to carry out a specific task. The instructions help the operator
to maintain the equipment better. The following instruction types are available:
● Planned maintenance instruction: An instruction that has information about a task that the operator has
to perform at regular intervals. However, these are not mandatory instructions and the operator can
choose to apply them based on local conditions such as climatic conditions.
● Breakdown instruction: An instruction that has information about a task that the operator has to perform
when dealing with unplanned situations such as an item of equipment fails to open on demand, or an item
of equipment fails to operate due to an internal leak.
● Installation instruction: An instruction that provides information while installing an equipment.
● Operations instruction: An instruction that provides information on how to use an equipment.
● Disposal instruction: An instruction that provides information on how to dispose of an equipment.
In addition, you can use the following key information to define an instruction:
● Activity type: Defines the primary context where the instruction is applicable.
An instruction moves from one state to another during its process of creation and maintenance. The different
states that an instruction goes through are listed below:
● Unpublished
● Published
● In Revision
Note
Multiple languages are supported for instruction texts and safety rule comments so that users can read this
information in their preferred language.
You can perform various operations on an instruction such as creating an instruction, viewing an instruction,
updating an instruction, deleting an instruction, and assigning models to an instruction.
Context
You use the Instructions app to work with an instruction.You can perform the following tasks:
Procedure
Using the Instructions application you can create five types of instructions - planned maintenance, breakdown,
installation, operations, and disposal. You can also specify useful key information such as activity type, failure
mode, frequency, document, safety rule, preconditions, steps, and post checks for an instruction.
Prerequisites
Note
You must use the same subclass as the model uses to which you assign the instruction.
● If you want to assign a model to an instruction, you must ensure that models already exist in SAP
Predictive Asset Insights.
Context
For simplicity, we only describe the planned maintenance instruction and a breakdown instruction procedure.
In addition, you can assign a model to the instruction so that the operator using the model can use the
instruction information for equipment maintenance.
Procedure
Note
Use the same subclass as the model uses to which you assign the instruction.
Field Description
Expected Duration Enter the total time required to execute the instruction
and also the unit of time.
Field Description
Note
System captures a snapshot of the 3D visual file to
use it as a preview image for the instruction.
Note
5. On the Safety Rules screen area, choose Add to add a new safety rule and perform the following tasks:
a. In the Safety Rules dialog box, select a safety rule and choose OK.
For example, if you want the user to wear safety boots while performing the step in the instruction,
choose Safety boots must be worn.
Note
Note
To unassign a model to the instruction, select the model in the Models section and choose
Unassign.
7. In the Equipment screen area, to assign an equipment, choose Assign and perform the following tasks:
a. In the Select Equipment, select the appropriate equipment.
b. Choose Assign.
8. In the Functional Locations screen area, to assign a functional location, choose Assign and perform the
following tasks:
a. In the Select Functional Locations, select the appropriate functional location.
b. Choose Assign.
9. In the Preconditions screen area, choose Add to add an activity that must be performed before executing
the instruction.
10. In the Steps screen area, to add individual instructions to the overall instruction, choose Add.
11. In the Post Checks screen area, to add an activity that needs to be performed after the instruction
execution, choose Add and enter values in the Post Checks field.
12. Save the instruction, or Save and Publish the instruction.
13. To add the instruction to a group, go to the instruction detail page and navigate to GROUPS → Add.
14. To create a new revision, and to switch between published and revision states, see Creating Revisions and
Switching Between Revisions and Published State [page 315].
You use this procedure to add a set of steps to an instruction. Each steps consists of information such as
documents, 3D visual file, or spare parts that help the operator during the maintenance of an item of
equipment.
Prerequisites
● If you want to add spare parts information to an instruction, you must have uploaded 3D visual files into
SAP Predictive Asset Insights for a model, a piece of equipment, an instruction, or an announcement.
● Your user ID has the roles INSTRUCTION_DELETE or INSTRUCTION _EDIT assigned.
● You have created an instruction. For more details see Creating an Instruction [page 253]
Field Description
Field Description
Expected Work Enter the total time required to complete the step.
Note
You must press the enter button after you enter a
tool.
c. In the Parts section, to add new parts choose Add and perform the following tasks:
1. Choose the drop-down for Material.
2. In the Select Parts pop-up, select an appropriate spare part that is relevant to the instruction and
choose OK.
3. In the Quantity field, enter the quantity for the spare part.
d. In the Documents section, to add a new document choose Add and perform the following tasks:
1. In the Add Document screen, browse for a file name in the File Name field.
2. In the Phase drop down, choose a phase in the lifecycle of the item of equipment.
3. In the Category drop down, choose a category that corresponds to a phase.
4. In the Description field, enter a description for the document.
5. Choose Upload.
Note
To remove a document that is assigned to a step, select the assigned document from the list in the
Documents screen area, and choose Remove.
4. Choose Save.
5. Choose Save and Publish to publish the updated instruction.
You use this procedure to create an instruction by reusing an existing instruction. For simplicity the procedure
below describes the planned maintenance instruction.
Prerequisites
Procedure
System creates a new instruction reusing the characteristics of the underlying instruction.
5. In the Header section, you must update name of the instruction as instruction names must be unique.
The app displays a dialog box to check if you want to create an announcement for the instruction. In the
Create Announcement pop-up, choose yes and then OK.
You can view an instruction to verify if the information contained in an instruction is appropriate or not.
Prerequisites
● To publish an instruction, your user ID has the roles INSTRUCTION_DELETE or INSTRUCTION _EDIT
assigned.
● To view an instruction, your user ID either belongs to the group ORG_DATA_READ, or has the roles
INSTRUCTION_READ assigned.
Context
When you have more instructions created using public APIs provided by SAP Predictive Asset Insights, you can
view these instructions using the Instructions app and perform a mass publish of such instructions.
In addition, if you have assigned a model to an instruction, or an announcement to an instruction you can
navigate to the model details, or the announcement details and work with a model or an announcement.
The following procedure applies to all types of instructions (Planned Maintenance, Breakdown, Installation,
Operations, or Disposal). For simplicity, we only describe the planned instruction procedure.
Procedure
Note
To publish one or more unpublished instructions created either using APIs, or using the Instructions
app, select multiple instructions from the list and choose Publish.
3. Choose an instruction from the search list and select View Details.
4. In the Planned Maintenance Instruction screen, choose the Information tab to view the details that are
specific to the instruction. These details can include activity type, failure mode, frequency, documents,
preconditions, steps, and post checks.
5. Choose the Safety Rules tab for any information about safety measures to follow.
You can update a planned maintenance instruction or a troubleshooting and breakdown instruction.
Prerequisites
Context
The following procedure applies to all types of instructions. For simplicity, we only describe the planned
instruction procedure.
Procedure
The app displays a pop-up to check if you want to create an announcement for the instruction. In the
Create Announcement pop-up, choose Yes and then OK.
Note
For more information about creating a revision for an instruction and switching between a revision and
a published version, see Creating Revisions and Switching Between Revisions and Published State
[page 315]
You can delete an instruction that you no longer want to have on the network. For simplicity, we only describe
the procedure to delete planned instruction.
Prerequisites
Procedure
You can assign a model to an instruction so that the operator can use the instruction information for the items
of equipment that are based on the model.
Prerequisites
Context
The following procedure applies to all types of instructions. For simplicity, we only describe the planned
instruction procedure.
Procedure
5.14 Templates
A template is an object created by SAP Predictive Asset Insights organization (for example, manufacturer,
operator, or service provider) to maintain metadata, that is, attributes and attribute groups, related to a model,
equipment, location, system, or spare part. A template inherits metadata from its parent objects, for example,
parent subclass templates or other parent templates, and can have additional attribute groups and attributes.
Example:
A model template inherits the structure from a parent model template, a parent subclass template, other
related parent subclasses, and the parent class.
Classes and subclasses are provided by SAP Predictive Asset Insights or classification standard providers.
The classification structure as well as assigned attributes and attribute groups are based on a classification
industry standard. Classes and Subclasses can be reused, but not edited.
Classes and subclasses for the following industry standards are predelivered:
● ISO 14224
● ISO 15926
● ISO 15380
If you want to add classes and subclasses of your own, please raise an incident with Asset Networks
operations to set your account as content provider.
Note
A template in SAP Predictive Asset Insights is identified by a unique name and is composed of attribute groups
and attributes. An attribute group is a logical grouping of related attributes of the equipment, model and
location, and an attribute is a qualifier to define the equipment.
Example for a classification structure and the relationship to model and equipment
The following example explains how classification objects delivered by SAP Predictive Asset Insights,
classification objects that can be created by customers, and type and instance information also created by
customers relate.
1. Class – delivered by SAP Predictive Asset Insights based on an industry standard or by a classification
standard provider – can be considered the top-node of the classification used in SAP Predictive Asset
Insights.
A class does not have a parent object, but can have multiple subclasses as child objects.
2. Subclasses – also delivered by SAP Predictive Asset Insights based on an industry standard or by a
classification standard provider – are the child objects of a class. It is possible to model multiple
Note
Similar to the model template it is possible to have multiple equipment templates under the top-level
equipment template. Each child equipment template will inherit attribute or attribute groups from its
parent object, that is, equipment templates.
In the example:
○ Equipment was created in reference to Model, and therefore this equipment would have all
attributes /attribute groups associated with the model, that is, inherit from Model Template 2
(SDT-100x), Model Template 1 (SDT), Subclass 2 (Dry-type transformer), Subclass 1 (Power
transformer), and Class (Transformer)
○ Since Equipment was also created in reference to Equipment Template, this equipment would
additionally have all attributes or attribute groups associated with the equipment template.
You use the Templates app to work with a template. The templates are grouped as cards by <Template> types,
<Attribute Groups>, and <Attributes>. This provides easier visualization of the template hierarchy. You
can drill down the template hierarchy using the navigation on the cards.
You can perform the following operations using the Templates app:
● Create a model template to define the attributes and attribute groups related to a model. For more
information, see Creating a Model Template [page 290].
Note
Dependencies display latest 50 objects created using this template for each of the different business
objects.
● You ncan view the external ERP system name in the header information for templates, attributes and
attribute groups.
You can create code lists to be used in string, numeric, and date data types.
Context
You can create, update, or delete code lists using the following procedure.
Procedure
a. In the New Code List Code List Details window, enter the values for the fields as described in the
table:
Note
○ There are no spaces allowed in the ID.
○ You cannot change the ID of the code list once
it has been created.
Note
You should always have a code description in a code
list before assigning the indicator to a piece of
equipment. There is no possibility to update the
code description later once it is been used for an In
dicator. In case the code description is not pro
vided, it will be empty and user will not be able to
update it later.
Data Type (*) Select the data type from the list:
○ Date
○ String
○ Numeric
○ Numeric Flexible
Values (*) Enter the values for the code list using +.
Note
b. You can add industry standards by choosing Add Industry Standard under New Code List Industry
Standards .
c. Choose OK.
3. To edit a code list, select the code list from the Code List Details page. Choose Edit from the code list object
page.
4. You can delete a code list by:
○ selecting the code lists from the Code List Details page and choosing Delete.
○ choosing Delete form the code list object page.
You perform this procedure to add attributes and attribute groups either directly on a template object or from
the Attribute Groups tab or Attributes card.
Context
Using this procedure, you can add attribute groups/attributes directly on a template object.
Note
You can use this approach for the creation of attribute groups or attributes on a template object.
SAP Operations can now deliver attribute groups & attributes that can be commonly reused:
● Global attribute groups & attributes are displayed in the attribute group/attribute lists with Source = SAP
● Global attribute groups & attributes can be reused, but not edited
Procedure
1. Select a template and choose Add Attribute Groups . In the Add Attribute Groups window, to add new
attribute group, select New and perform the following tasks:
a. In the New Attribute Group window, enter the values for the fields as described in the following table:
Field Description
Note
○ There are no spaces allowed in the ID.
○ You can’t change the ID of the attribute group
once it has been created.
b. Choose OK.
c. You can add the attributes and also the industry standards by selecting the attribute group and
choosing the Edit button.
2. In the Add Attribute Groups window, to edit an existing attribute group, search for an existing attribute
group, and perform the following tasks:
a. From the search results, select an appropriate attribute group.
b. Choose OK.
3. To save the attribute group, choose Save in the <Name of the Attribute Group> section.
Note
Each time you save the attribute group of a template, system updates the template automatically. You
don’t have to save the template explicitly.
4. To remove the attribute group, choose Remove in the <Name of the Attribute Group> section.
Note
Each time you remove an attribute group from a template, system updates the template automatically.
Field Description
Note
○ There are no spaces allowed in the ID.
○ You can’t change the ID of the attribute
group once it has been created.
Note
If you want the string data type to be lan
guage-dependent, under the Attribute Con
ditions section, choose Yes from the Lan
guage Dependency radio button.
Note
You can create code lists for Numeric data
type and assign the code list to attributes
based on data type, scale, and precision
match.
Note
You cannot use the Multi Select op
tion in combination with any of
other attribute conditions like
Threshold, Dependent Dimension,
and Relational Operator. However,
Multi Select can be used with
Dimension attribute condition.
Note
Numeric attributes can also be cre
ated without dimension and with
out an associated unit of measure.
Note
Business objects that are using attributes of
data type enum can still be read/displayed
on the UI.
Note
enum data type is currently still usable via
API, but API use will also be deprecated and
won’t be available from the next release.
Note
You can create code lists for Numeric Flexi
ble data type and assign the code list to at
tributes based on data type, scale, and pre
cision match.
Note
You cannot use the Multi Select op
tion in combination with any of
other attribute conditions like
Threshold, Dependent Dimension,
Note
Total length of the number must be
greater than zero.
Note
○ The allowed number of deci
mal places can’t be greater
than the total length of the
number.
○ Decimal places can’t be less
than zero.
Note
○ To accommodate attributes that are al
ready shared, the difference between
new and old value of decimal places
must not be greater than difference be
c. To assign an existing attribute, choose <Name of the Attribute Group> Attributes Add . In the
Add Attributes pop-up, to use an existing attribute from SAP Predictive Asset Insights, search for an
existing attribute using the Search text box and perform the following tasks:
a. From the search results list, select an appropriate attribute.
b. Choose OK.
You perform this procedure to add indicators and indicator groups either directly on a template object or from
the Indicator Groups or Indicators card.
Prerequisites
Context
Using this procedure, you can add indicator groups or indicators directly on a template object.
You can use this approach for the creation of indicator groups or indicators on a template object.
SAP Operations can now deliver indicator groups and indicators that can be commonly reused:
● Global indicator groups & indicators are displayed in the indicator group or indicator lists with Source =
SAP
● Global indicator groups & indicators can be reused, but not edited.
Procedure
1. Select the template and choose Add Indicator Groups . In the Add Indicator Groups window, to add
new Indicator group, select New and perform the following tasks:
a. In the New Indicator Group window, enter the values for the fields as described in the table:
Field Description
Note
○ There are no spaces allowed in the ID.
○ You cannot change the ID of the indicator
group once it has been created.
Note
b. Choose OK.
c. You can add the attributes by selecting the attribute group and choosing the Edit button.
2. In the Add Indicator Group option from the template object window, to use an existing indicator group,
search for an existing indicator group, and perform the following tasks:
a. From the search results, select an appropriate indicator group.
b. Choose OK.
3. To save the indicator group, choose Save in the relevant indicator group section.
Each time you save the indicator group of a template, system updates the template automatically. You
do not have to save the template explicitly.
4. To remove the indicator group, choose Remove in the relevant indicator group section.
Note
Each time you remove an indicator group from a template, system updates the template automatically.
1. In the Add Indicators dialog box, to add new indicator, select New.
2. In the New Indicator window, enter values for the fields as described in the table:
Field Description
Note
○ There are no spaces allowed in the ID.
○ You cannot change the ID of the indicator
group once it has been created.
Note
○ Indicator Type: select the indicator type.
It can measured, calculated, and as
sessed.
○ Code List: Assign code list for the indi
cator.
Note
○ Indicator Type: select the indicator type.
It can measured, calculated, and as
sessed.
○ Code List: Assign code list for the indi
cator.
Note
○ Dimension: Select an appropriate di
mension from the dropdown.
○ Default Unit of Measure: Select an ap
propriate Unit of Measure (UoM) as de
fault from the dropdown.
○ Expected Behaviour(*): Specify if the
expected behaviour of the new indicator
is Increasing, Decreasing, Unknown, or
None.
○ Indicator Type: select the indicator type.
It can measured, calculated, and as
sessed.
Note
For a numeric flexible data type you can de
fine additional properties.
Note
Total length of the number should
be greater than zero.
Note
○ The allowed number of deci
mal places cannot be greater
than the total length of the
number.
○ Decimal places cannot be less
than zero.
Note
○ To accommodate attributes that are al
ready shared, the difference between
new and old value of decimal places
must not be greater than difference be
tween new and old value of total length
of the number.
○ Data type Integer is covered by the
newly introduced data type Numeric
Flexible if the Decimal Places
Allowed is equal to 0.
Note
○ Aggregation Concept: Aggregation concept is only applicable if the values for the
indicators are derived from multiple applications or the same application through different
methods.
○ Minimum: Minimum of the values is displayed
○ Maximum: Maximum of the values is displayed
○ Average: Average of the values is displayed
○ Sum: Sum of the values is displayed
○ Last Available Value: latest value is displayed
○ Expected Behaviour: Is only relevant for suggesting the color codes for threshold values.
For the number of thresholds available for the indicator, the relevant color codes are
defined by default. You can also customize the color codes for the thresholds.
For suggested colors in case of <Expected Behaviour> as Increasing, refer to the
below diagram:
○ Code Lists: You can specify a list of predefined values for the attribute or indicator
datatype. You can create codelists using the Codelist feature, see Adding, Updating, and
Deleting Code Lists [page 265].
○ Color: This color is used in the indicator chart (SAP Predictive Asset Insights specific
feature). You can define a color for each indicator and the relevant lines in the indicator
chart will be of that color.
○ Indicator Category: This is used in the indicator chart (SAP Predictive Asset Insights
specific feature). According to the category selected the way the indicator values are
plotted in indicator chart differs.
○ Flow: These variables are visible as continuous variations on the chart. Flow is line
graph, the indicator values in the indicator chart are connected by line.
○ Level: These variables remain unchanged until a new value exists, that is, level
variables are not interpolated linearly between indicators, but a step function is used
(the last value is repeated until a new value exists). An example of a level variable is
stock inventory. It is displayed similar to a step chart.
○ Discrete: Displays the state of the equipment as a horizontal bar on top of the chart.
3. Choose OK.
6. In the Add Indicators dialog box, to use an existing indicator from SAP Predictive Asset Insights, search for
an existing indicator using the Search text box and perform the following tasks:
a. From the search results list, select an appropriate indicator.
b. Choose OK.
Results
1. Go to the relevant app Equipment or Models. You have created the indicators. To instantiate the indicators:
2. Select a piece of equipment or a model from the list.
3. Choose Indicators under the Monitoring tab.
A set of most common and widely accepted indicator are available as predefined indicators.
Preshipped indicators with a suggested definition as Templates are available. The Indicators are available to all
the business objects based on the template selection.
● All global indicators are published/available in all accounts regardless of if you have the license for SAP
Asset Intelligence Network, SAP Asset Strategy and Performance Management, or SAP Predictive Asset
Insights.
● Global indicator groups & indicators are displayed in the indicator group or indicator lists with Source =
SAP
● Global indicator groups & indicators can be reused, but not edited.
Expected Behav
ID Description Long Description Data Type Dimension iour
MTTF Mean time to fail Expected time be numeric Time decreasing
ure fore the asset fails.
Note
The connec
tion status
only works if
you are using
SAP-managed
data persis
tence and
streaming.
Nested structures is a data model that can comprise of child attributes, indicators, or nested structures.
● Support complex data modeling of assets by introducing multiple cardinality with name association.
You can assign the nested structures to model or equipment templates. The equipment or models created
using these templates will inherit the nested structures similar to attributes and indicators.
Procedure
Field Description
Note
○ There are no spaces allowed in the ID.
○ You cannot change the ID of the code list once
it has been created.
Note
You should always have a code description in a code
list before assigning the indicator to a piece of
equipment. There is no possibility to update the
code description later once it is been used for an In
dicator. In case the code description is not pro
vided, it will be empty and user will not be able to
update it later.
Note
b. Choose Save.
3. To edit a nested structure, select the nested structure from the Nested Structure details page, choose Edit
from the nested structure object page.
In the Structure section, you can add attributes, indicators, and nested structures. Use the icon to
assign child nested structure, attribute or indicator. In the Assign dialog box, choose New <Attribute/
Indicator/Nested Structure> to add new attribute, indicator, or nested strutcure to the parent structure
hierarchy.
If you are adding a child nested structure, then the subsequent hierarchy for the same will be enabled and
you can assign existing attribute, indicator, or nested strutcures to the hierarchy.
Note
○ You cannot assign the parent nested structure as the child structure in the nested structure
hierarchy under Structure. It will return an error message.
○ You can add a maximum of 10 levels in the hierarchy after which you cannot add more levels.
You can add multiple instances of same nested structure node (could be a child nested structure or
Attribute or Indicator) by using the New Instance button and associate semantic meaning with each
instance by providing the Named Association Text to each instance of the added child node. The Named
Association Text is autopopulated with the attribute/indicator/nested structure name suffixed with:
○ Attribute: _AT. For example Carcolour_AT.
○ Indicator:_IND. For example Carcolour_IND.
○ Nested Structures:_NS. For example Carcolour_NS.
Tip
For example, if you add an attribute named 'WheelPressure' 4 times inside a nested structure called
'WheelStructure', then while adding the WheelPressure attribute, you can provide an additional
semantic meaning to each instance of that attribute such as 'WheelPressure_FrontRight',
'WheelPressure_FrontLeft', 'WheelPressure_BackRight', 'WheelPressure_BackLeft'.
○ selecting the nested structure from the Nested Structure list page and choosing Delete.
○ choosing Delete from the nested structure object page.
You perform the following procedure to add alert types directly on a template object page. The alert type
definition allows you to define the alerts that are based on equipment error codes or based on certain
computation on the data for example by applying Rules on the data. The definition can also define associations
with an indicator and possible failure modes. The association with failure mode data allows you to identify
associations like instructions.
Prerequisites
● To update a template, your user ID must have the scopes TEMPLATE_DELETE or TEMPLATE_EDIT
assigned.
● To view a template, your user ID has the scope TEMPLATE_READ assigned.
● You have identified the template that you want to update.
Context
In the Template Explorerwindow, to add new alert type, select the New button and perform the following tasks:
Procedure
1. In the Template Explorer window, enter the values for the fields as described in the following table:
Field Description
Note
1. No spaces allowed in the ID.
2. Only the following characters are supported:
○ Uppercase and lowercase alphabets a
through z and A through Z.
○ Numeric digits 0 through 9
○ Punctuation marks underscore (_), hyphen
(-), colon (:), and full-stop (.)
○ Maximum number of characters allowed is
29
Note
Maximum number of characters allowed is 255.
Indicator Assign indicator to the alert type by selecting from the list.
Origin This allows you to differentiate between the alert type that
is defined for the alert arising from a machine or rule.
Error Code Enter an error code. This field is available only if you select
Machine as origin.
Note
Maximum number of characters allowed is 32.
Failure Modes Assign failure modes to the alert type by selecting from
the list.
Note
Multiple failure codes can be assigned to an alert type.
2. Choose Save.
Note
You cannot create same alert type with the same ID.
An alert type will get external ID only after it is assigned to a model, equipment is created out of that model
and the equipment is published.
If corresponding external ID is not populated, SAP Internet of Things replication of alert type has failed. In
such a scenario, republish an equipment.
Results
In the Alert Type window, the newly created alert type displays. You can search and sort, group by alert types,
filter, and export details in an excel.
You can:
● Edit the Alert Type Detailsunder Information and Settings. Under the Settings, you can manage settings like
deduplication, allowing updates, auto close, and so on. The Allow Updates flag is available only if the
Deduplication field is enabled. You can enable the allow updates flag to decidethe update strategy based on
the updates received. For example, in case you have subscribed to SAP Predictive Assets Insights, you may
have machine alarms generated alerts, so you can use this flag to decide the update startegy based on the
incoming updates from the alarm.
You can also reassign failure modes to the alert types. To view the instructions assigned with the failure mode,
click the number visible within the <Instructions> column.
Note
● Alert type cannot be deleted if assigned to an alert type group. Unassign from alert type group to delete
an alert type.
● Shared indicators are not available to be used for creating a new alert type.
● Shared alert types will also be displayed in the list page. Shared alert types are read-only, you cannot
edit/delete them. You can only edit the description of the alert type.
● Alert types must be explicitly shared along with relevant failure mode, indicator group, and indicator
while sharing a model. Also, such shared alert types can be used in rules. Shared alert types can be
added to another alert type group but you cannot edit a shared alert type group.
● For Alert Type modification changes are not synchronized immediately to reuse alert.
● For equipment that has alert type associated, you can view the modified alert type only after the alert
type is Published.
Related Information
5.14.1.5.1 Deduplication
Deduplication option allows the user not to create duplicate alerts for an existing alert type and equipment ID.
Duplicate alerts are created or generated once the stipulated deduplication period is over or the status of
existing alert of that alert type is marked as completed.
During the deduplication period, in a scenario where a new alert instance of an existing not completed alert is
generated, the count will increase, and a new alert is not generated. The timestamp of last occurrence of alert
is visible.
When creating a new alert type, the deduplication switch is on with the default period of 30 days. If you create
an alert with this alert type and same equipment ID, first alert is generated. If you create a second alert within
30 days, a new alert will not be generated. Only the count of first alert increases.
You perform the following procedure to add alert type groups directly on a template object page. Alert type
group is a grouping of alert types and can be assigned to a model.
Prerequisites
● To update a template, your user ID has the scope TEMPLATE_DELETE or TEMPLATE_EDIT assigned.
● To view a template, your user ID either belongs to the group ORG_DATA_READ role template
AssetCoreReader; or has the scope TEMPLATE_READ assigned.
In the Template Explorer window, to add new alert type group select the New Alert Type Group button and
perform the following tasks:
Procedure
1. In the Template Explorer window, enter the values for the fields as described in the following table:
Field Description
Note
○ No spaces allowed in the ID.
○ Only the following characters are supported:
○ Uppercase and lowercase alphabets a
through z and A through Z.
○ Numeric digits 0 through 9.
○ Punctuation marks underscore (_), hyphen
(-), colon (:), and full-stop (.).
○ Maximum number of characters allowed is
32
.
Note
Maximum number of characters allowed is 255.
Long Description Enter a details description, if any, for the alert type group.
Note
The maximum number of characters allowed is 5,000.
2. Choose Save.
Note
You cannot create the same alert type group with the same ID.
In the Alert Type Group window, the newly created alert type group displays. You can search and sort, group by
alert type group, filter, and export details in an excel.
Click the respective alert type group to edit details. You can also assign new alert types to the selected alert
type group using the Assign option in the Edit mode. You can also edit the details of assigned alert type. For
this, select the alert type within the Alert Types list and click Edit.
It is also possible to create alert type from the Assign Alert Type dialog box.
Note
Related Information
You use this procedure to create a model template that helps you to define the attributes and attribute groups
related to a model.
Prerequisites
● You have identified the subclass template provided by SAP Predictive Asset Insights, or a model template
created within your organization or shared by a different organization, from which you can create the
template.
Note
A model template can also be created without a parent object (subclass/another model template), in
this case the model template acts as a top node.
Field Description
Note
○ There are no spaces allowed in the Template
ID.
○ You cannot change the ID of the template once
it has been created.
Data Modeling With ○ Nested Structures: You can use this option to cre
ate complex data modeling and include nested
structures in the template.
○ Indictaor Group/Attribute Group: You can use this
option if you want to include just indicator groups
or attribute groups in the template.
Note
You can create a model template without a parent
template.
Note
○ This field is scope-specific.
○ Template objects can have only one industry
standard assigned to them. They can also have
no industry standards assignments.
○ If an industry standard is assigned to a tem
plate object, you can change or delete it.
Note
b. Choose OK.
3. To edit the description of the template, choose Edit Description in the template header and perform the
following tasks:
a. In the Edit <Name of the Model Template> popup, enter suitable description in the Description text
box.
b. Choose Save.
4. Depending on the type of data modeling selected when creating the template, you can have the following
options:
○ If you select Nested Structures, you can view the Nested Structures tab.
To add child attributes, indicators or nested structures:
1. You can choose Add and select the attributes, indicators, and nested structures from the Assign
dialog box.
2. Choose Continue.
3. The Named Association Text is auto-populated with the attribute/indicator/nested structure name
suffixed with:
○ Attribute: _AT. For example Carcolour_AT.
○ Indicator:_IND. For example Carcolour_IND.
○ Nested Structures:_NA. For example Carcolour_NA.
You can add multiple instances of same nested structure node (could be a nested structure or
Attribute or Indicator) by using the Add Instance button and associate semantic meaning with
each instance by providing the Named Association Text to each instance of the added child node.
You can also choose an instance and remove it using Remove Instance button.
Note
The Named Association Text can be the same for attributes/indicators/nested structures with
different parent hierarchy. For example, if you have 2 child nested structures NS1 and NS2
assigned. You have assigned the attribute AT1 to both NS1 and NS2 and another attribute AT2
Tip
For example, if you add an attribute named 'WheelPressure' 4 times inside a nested structure
called 'WheelStructure', then while adding the WheelPressure attribute, you can provide an
additional semantic meaning to each instance of that attribute such as
'WheelPressure_FrontRight', 'WheelPressure_FrontLeft', 'WheelPressure_BackRight',
'WheelPressure_BackLeft'.
Note
○ If you select Indictator Group/Attribute Group, you can view the Attribute Groups and Indicator Groups
tab:
○ To add attribute groups and attributes to a template, choose Add Attribute Groups from the
template header.
For more information, see Adding Attribute Groups and Attributes [page 267].
Note
Each time you save the attribute group of a template, system updates the template
automatically. You do not have to save the template explicitly.
○ To add indicator groups and indicators to a template, choose Add Indicator Groups from the
template header.
For more information, see Adding Indicator Groups and Indicators [page 273].
Note
○ Each time you save the indicator group of a template, system updates the template
automatically. You do not have to save the template explicitly.
○ If you have maintained dimesions for indicators, then you can set the Display UoM apart
from the Default UoM that is defined for the indicator. The Display UoM is consumed to
display the indicator value in the relevant object page.
Note
The display Unit of Measure is reset to default, when you edit the definition of
indicator/indicator group.
Optionally, you can enter a standard ID or code as defined in an industry standard. You can only
assign one industry standard for an object.
Note
○ Template objects can have only one industry standard assigned to them. They can also have
no industry standards assignments.
○ If an industry standard is assigned to a template object, you can change or delete it.
a. To add to an existing attribute, select the attribute and choose Edit Attribute.
b. In the Edit Attribute popup, choose Industry Standards Add Industry Standard .
c. To add to a new attribute, choose Add Attribute New Attribute and enter all attribute-relevant
information.
d. In the Industry Standards section, and Add Industry Standard .
e. In the Industry Standards popup, select an industry standard and enter an industry Standard ID.
f. Choose OK.
Results
● You can update the model template with new attribute groups and attributes.
For more information, see Viewing and Updating a Template [page 306].
● You can create a model using the model template.
For more information, see Creating a Model [page 133].
● You can add the template to a group using the Group button. For more information, see Groups [page 199].
● You can reorder the attribute groups/ indicator groups using the Reorder button on the details screen.
● You can delete a template using the Delete button on the details page or multiple templates using the same
button on the list page.
You use this procedure to create an equipment template that helps you to define the equipment-specific
attributes and attribute groups related to an item of equipment. This template allows you to create new
attributes and attribute groups that need not be inherited from a class, subclass or a model template.
Prerequisites
2. On the Templates object page, choose New Equipment Template and proceed as follows:
a. In the New Equipment Template pop-up, enter values for the fields as described in the table below:
Field Description
Note
○ There are no spaces allowed in the ID.
○ You cannot change the ID of the template once
it has been created.
Data Modeling With ○ Nested Structures: You can use this option to cre
ate complex data modeling and include nested
structures in the template.
○ Indictaor Group/Attribute Group: You can use this
option if you want to include just indicator groups
or attribute groups in the template.
Note
You can also create an equipment template without
a parent template.
Note
○ This field is scope-specific.
○ Template objects can have only one industry
standard assigned to them. They can also have
no industry standards assignments.
○ If an industry standard is assigned to a tem
plate object, you can change or delete it.
b. Choose OK.
3. To edit the description of the template, choose Edit Description in the template header and proceed as
follows:
a. In the Edit pop-up, enter a suitable description in the Description text box.
b. Choose Save.
4. Depending on the type of data modeling selected when creating the template, you can have the following
options:
○ If you select Nested Structures, you can view the Nested Structures tab.
To add child attributes, indicators and nested structures:
1. You can choose Add and select the attributes, indicators, and nested structures from the Assign
dialog box.
2. Choose Continue.
3. The Named Association Text is auto-populated (only for the first instance) with the attribute/
indicator/nested structure name suffixed with:
○ Attribute: _AT. For example Carcolour_AT.
○ Indicator:_IND. For example Carcolour_IND.
○ Nested Structures:_NS. For example Carcolour_NS.
You can add multiple instances of same nested structure node (could be a another nested
structure or Attribute or Indicator) by using the Add Instance button and associate semantic
meaning with each instance by providing the Named Association Text to each instance of the
added child node. You can also choose an instance and remove it using Remove Instance button.
Note
The Named Association Text can be the same for attributes/indicators/nested structures with
different parent hierarchy. For example, if you have 2 child nested structures NS1 and NS2
assigned. You have assigned the attribute AT1 to both NS1 and NS2 and another attribute AT2
to NS1 only. Now NS1-> AT1 and NS2-> AT1 can have the same Named Association Text like
AT1_AT.
Tip
For example, if you add an attribute named 'WheelPressure' 4 times inside a nested structure
called 'WheelStructure', then while adding the WheelPressure attribute, you can provide an
additional semantic meaning to each instance of that attribute such as
'WheelPressure_FrontRight', 'WheelPressure_FrontLeft', 'WheelPressure_BackRight',
'WheelPressure_BackLeft'.
Note
○ Each time you save the attribute group of a template, system updates the template
automatically. You do not have to save the template explicitly.
○ Multi-level inheritance is supported, that is:
○ you can create equipment templates under another equipment template
○ you can create an equipment template with reference to a subclass
○ To add indicator groups and indicators to a template, choose Add Indicator Groups from the
template header.
For more information, see Adding Indicator Groups and Indicators [page 273].
Note
○ Each time you save the indicator group of a template, system updates the template
automatically. You do not have to save the template explicitly.
○ If you have maintained dimesions for indicators, then you can set the Display UoM apart
from the Default UoM that is defined for the indicator. The Display UoM is consumed to
display the indicator value in the relevant object page.
Note
The display Unit of Measure is reset to default, when you edit the definition of
indicator/indicator group.
Note
Optionally, you can enter a standard ID or code as defined in an industry standard. You can only
assign one industry standard for an object.
Note
○ Template objects can have only one industry standard assigned to them. They can also have
no industry standards assignments.
○ If an industry standard is assigned to a template object, you can change or delete it.
a. To add to an existing attribute, select the attribute and choose Edit Attribute.
b. In the Edit Attribute popup, choose Industry Standards Add Industry Standard .
c. To add to a new attribute, choose Add Attribute New Attribute and enter all attribute-relevant
information.
d. In the Industry Standards section, and Add Industry Standard .
Results
● You can update the equipment template with new attribute groups and attributes.
For more information, see Viewing and Updating a Template [page 306].
● You can create equipment using the equipment template.
For more information, see Creating a Piece of Equipment [page 97].
● You can add the template to a group using the Group button. For more information, see Groups [page 199].
● You can reorder the attribute groups using the Reorder button on the details screen.
You use this procedure to create a location template that helps you to define the location-specific attributes
and attribute groups related to a location.
Prerequisites
Procedure
2. On the Templates object page, choose New Location Template and proceed as follows:
a. In the New Location Template pop-up, enter values for the fields as described in the table below:
Field Description
Note
○ There are no spaces allowed in the ID.
○ You cannot change the ID of the template once
it has been created.
Note
You can also create a location template without a
parent template.
Note
○ This field is scope-specific.
○ Template objects can have only one industry
standard assigned to them. They can also have
no industry standards assignments.
○ If an industry standard is assigned to a tem
plate object, you can change or delete it.
b. Choose OK.
3. To edit the description of the template, choose Edit Description in the template header and proceed as
follows:
a. In the Edit pop-up, enter a suitable description in the Description text box.
b. Choose Save.
4. To add attribute groups and attributes to a template, choose Add Attribute Group from the template
header.
For more information, see Adding Attribute Groups and Attributes [page 267].
Note
Next Steps
You use the location template while creating a location from the Locations application.
You use this procedure to create a spare part template that helps you to maintain manufacturing information,
technical data, and assignment information pertaining to spare parts.
Prerequisites
Procedure
2. On the Templates object page, choose New Spare Part Template and proceed as follows:
a. In the New Spare Part Template dialog box, enter values for the fields as described in the table below:
Field Description
Note
○ There are no spaces allowed in the ID.
○ You cannot change the ID of the template once
it has been created.
Parent Subclass/Spare Part Template Select a subclass template, or another spare part tem
plate as parent template.
Note
You can also create a spare part template without a
parent template.
Note
○ This field is scope-specific.
○ Template objects can have only one industry
standard assigned to them. They can also have
no industry standards assignments.
○ If an industry standard is assigned to a tem
plate object, you can change or delete it.
b. Choose OK.
Note
3. To edit the description of the template, choose Edit Description in the template header and proceed as
follows:
a. In the Edit dialog box, enter a suitable description in the Description text box.
b. Choose Save.
4. To add attribute groups and attributes to a template, choose Add Attribute Group from the template
header.
For more information, see Adding Attribute Groups and Attributes [page 267]
You use this procedure to create a system template that helps you to maintain system information, attribute
groups, industry standards, and groups assignment information pertaining to system.
Prerequisites
Field Description
Note
○ There are no spaces allowed in the ID.
○ You cannot change the ID of the template once
it has been created.
Parent Subclass/System Template Select a subclass or another system template as the pa
rent template.
Note
You can also create a system template without a pa
rent template.
Note
○ This field is scope-specific.
○ Template objects can have only one industry
standard assigned to them. They can also have
no industry standards assignments.
○ If an industry standard is assigned to a tem
plate object, you can change or delete it.
b. Choose OK.
Note
You use this procedure to create a functional location template that helps you to maintain system information,
attribute groups, industry standards, and groups assignment information pertaining to system.
Prerequisites
Procedure
Field Description
Note
○ There are no spaces allowed in the ID.
○ You cannot change the ID of the template once
it has been created.
Parent Functional Location Template Select another system template as the parent template.
Note
You can also create a functional location template
without a parent template.
Note
○ This field is scope-specific.
○ Template objects can have only one industry
standard assigned to them. They can also have
no industry standards assignments.
○ If an industry standard is assigned to a tem
plate object, you can change or delete it.
b. Choose OK.
Note
3. To edit the description of the template, choose Edit Description in the selected template header and
proceed as follows:
a. In the Edit dialog box, enter a suitable description in the Description text box.
b. Choose Save.
4. To add attributes to the template, choose Add Add Attribute Groups in the object page header and
proceed as follows:
a. In the Add Attribute Groups dialog box, select existing attribute groups from the list or add new
attribute group using New .
For more information, see Adding Attribute Groups and Attributes [page 267].
Note
○ Each time you save the attribute group of a template, system updates the template
automatically. You do not have to save the template explicitly.
b. Choose OK.
5. To add indicator groups and indicators to a template, choose Add Indicator Groups from the
template header.
a. In the Add Indicator Groups dialog box, select existing indicator groups from the list or add new
indicator group using New .
Note
○ Each time you save the indicator group of a template, system updates the template
automatically. You do not have to save the template explicitly.
○ If you have maintained dimesions for indicators, then you can set the Display UoM apart from
the Default UoM that is defined for the indicator. The Display UoM is consumed to display the
indicator value in the relevant object page.
Note
The display Unit of Measure is reset to default, when you edit the definition of indicator/
indicator group.
b. Choose OK.
6. To add an industry standard to the template, perform the following tasks:
a. Go to the Industry Standard section on the template and choose Add Industry Standard.
b. In the Industry Standard popup, select the industry standard you want to assign to the template object.
Note
Optionally, you can enter a standard ID or code as defined in an industry standard. You can only
assign one industry standard for an object.
Note
○ Template objects can have only one industry standard assigned to them. They can also have
no industry standards assignments.
○ If an industry standard is assigned to a template object, you can change or delete it.
a. To add to an existing attribute, select the attribute and choose Edit Attribute.
b. In the Edit Attribute popup, choose Industry Standards Add Industry Standard .
c. To add to a new attribute, choose Add Attribute New Attribute and enter all attribute-relevant
information.
d. In the Industry Standards section, and Add Industry Standard .
e. In the Industry Standards popup, select an industry standard and enter an industry Standard ID.
f. Choose OK.
Results
● You can update the functional location template with new attribute groups and attributes.
For more information, see Viewing and Updating a Template [page 306].
● You can create a model using the model template.
For more information, see Creating a Model [page 133].
● You can add the template to a group using the Group button. For more information, see Groups [page 199].
Prerequisites
● To update a template, your user ID has the roles TEMPLATE_DELETE or TEMPLATE_EDIT assigned.
● To view a template, your user ID has the role TEMPLATE_READ assigned.
● You have identified the template that you want to update.
Procedure
Note
The search result displays the number of templates by the template types.
4. Choose a template type to view more details of the templates displayed in the search results.
5. Choose a template.
The template details are displayed in a flexible column layout and as a side-by-side view of the selected
template in the list view or card view, and the template details in the template object page.
Note
The quick view (small and medium detailed view) only provides limited editing options. In the full
screen view you have the full editing functionalities.
For more information, see Adding Attribute Groups and Attributes [page 267]
Note
○ You cannot update the attributes that have been inherited from a class, subclass, or another
model template.
○ You cannot update the attributes that have been used in creating any child objects such as
models, items of equipment or locations.
b. Choose OK.
9. To remove the attributes of the attribute group, in the <Name of the attribute group> section, choose
Remove Attribute and perform the following tasks:
a. In the Warning pop-up, choose OK if you are sure that you want to remove the attribute to the attribute
group.
b. Choose Save.
Note
○ You cannot remove attribute groups and attribute that have been inherited either from a class
template, subclass, template, or a model template.
10. To add new attribute groups and attributes to the template, choose Add Attribute Group from the template
header.
More information, see Adding Attribute Groups and Attributes [page 267].
Note
Each time you save the attribute group of a template, system updates the template automatically.
Results
You have created a template that you can update with additional attribute groups or attributes.
5.15 Rules
Use
You use the Rules application to manage and create rules so that the service technician is notified about
possible alerts. You can set up rules for a model or equipment with this application. These rules, based on the
You can perform additional actions such as sending emails with rule execution status to the selected users.
It is also possible to view a list of existing and newly created rules. In addition, edit and delete a rule and view
rules for models and equipment.
Procedure
1. Define alert type. Navigate to Templates Alert Types New . The origin should be Rules.
Note
You can also define the deduplication configuration to reduce the duplication of similar alerts. For more
information, refer Adding Alert Types [page 285].
2. Define alert type groups for an alert type created. For more information, refer Adding Alert Type Groups
[page 288].
3. Assign the alert type group to the model that will assign all the alert types to the model. These are available
for equipment derived from model. For more information on assigning, refer Assigning Alert Type Groups
to a Model [page 144].
4. Create a rule for model or equipment by defining rule. You can create scheduled based rules or trigger-
based rules using the Rules list page. The scheduled rules are triggered at defined frequency and trigger-
based rules are executed based on the trigger created by the equipment alarms. For more information,
refer Creating Rules [page 309].
5. You can view the rules defined for the model or equipment using the Rules list page. In case of equipment,
you can also view the rules defined at model level and inherited to equipment. For more information, refer
Rule Management [page 312].
6. You can also navigate to the Rules list page to view all the rules created against a model or equipment.
Note
In case you have also subscribed to SAP Asset Intelligence Network, the shared alert types can be
synchronized and used while defining rules.
Related Information
Prerequisites
You must have the authorized role RULES_READ, RULES_DELETE, and RULES_EDIT.
Context
When a specified event occurs, for example, engine temperature exceeding a threshold, and the rule's
conditions are met, an alert is triggered. Also possible to send emails (optional).
Procedure
Note
○ All the published equipment and equipment in revision status with associated model are available
in the list.
○ Rules will only run for equipment from the same organization. Shared equipment/shared model of
equipment is not supported.
5. Choose Save
6. You are navigated to the rules object page. You can edit the long description, if necessary.
Rule Details
7. Within When, if the user wants to schedule events, use Schedule Event within the Event Type option to set
up an event to check for the rule conditions at a specified time interval.
Note
The rule is executed based on Central European Time zone and not based on users time zone.
8. Within When, if the user wants to configure machine-generated alerts, use the Triggered Event within the
Event Type option to create a rule. The rule is configured for a triggered event based on the selected alert
type and is executed when a machine generated alert of the selected alert type occurs for the selected
model.
○ Only alert type with origin as Equipment are listed for the triggered events. The same alert type is
automatically populated as a default alert type in the Then option. You can change the alert type in
the Then option, if necessary.
○ In a scenario where trigger-based rule exists for the alert type that is valid for an equipment, the
rule is triggered instead of an alert creation. The condition in this rule is evaluated to create an
alert.
Note
○ If the duration or the time stamp of the data captured differs for different indicators used to define a
condition, chances are that the results obtained are not as expected. To obtain desired results,
aggregation must be used on the respective indicator so that the value obtained for the bigger duration
can be used if data values are low.
Example
The machine running status is captured every hour and its vibration is captured every minute. To
use the running status in a condition, define an hourly aggregation to return the last value so that
the last value captured is used to evaluate the rule.
○ Equipment or model used in a rule must have minimum one indicator assigned to it to execute the rule.
○ If you choose attribute, you can specify a constant value.
Note
○ Add aggregators, indicators, and attributes as required, modifying the operators (AND, OR)
between them to define the condition.
○ Rules will run for numeric, numeric flexible, string, and boolean type indicator only. For a condition
<Indicator of type string or boolean> equal <constant> constant value should be in quotes ("" -
double quotes). For a condition <Indicator of type numeric or numeric flexible> equal <constant>
constant value should not have any quotes.
○ Supported values for boolean type Indicators or Attributes are "True" and "False".
○ Threshold comparisons for aggregates are not supported in conditions.
Note
○ The notification description is obtained from the description provided for the alert types. This
description will appear truncated if the alert type description exceeds 40 characters.
○ The notification description is always in English. However, the Alert Type description is used to
create the Notification description. For example, if Alert Type description is in English, the
notification description uses the alert type English description. If the Alert Type Description is
not present in English, then the system selects a random language description.
○ E-mail generated from Rules displays the violated indicators.
Note
The rules assigned at the model will not be activated for the equipment initially. To activate, you can
use the Rules page by clicking data within the <Total Pieces of Equipment> column. From the
popup, select and activate rule for equipment created from the model.
Results
● List of rules created for model or equipment (in case of equipment, it is only rules created against them)
Note
○ View rules for an equipment (created for an equipment or inherited from model) within the
Equipment tab. Select the equipment to view all the rules defined for an equipment.
○ Rules are grouped according to equipment.
○ Change the status of only rules created for an equipment.
○ Activate or deactivate rules inherited from model.
● Search option
● Sort, filter and group rules using Settings option
● Number of activated equipment.
Last execution time and status of rules. Statuses are Not executed, Execution Failed, Executed (for All),
and Executed (for Few).
● Execution logs for failed rules.
Note
You can edit and delete the existing rule by clicking the Rule name on the Rules List page.
Note
Changes made within this page will be visible after saving or deleting the details.
Note
By default, all the rules created against a model are executed automatically as rules are deactivated for
the equipment. You must activate the rules for the equipment to execute it.
Note
By default, all the rules created at the model level are in inactivated state (deactivated) at the
equipment level.
Note
● No overlap between ingested data and the period considered for rule execution. This can cause due to
delayed data ingestion like rule executed every 2 min and data ingestion delayed more than 2 mins.
● Rule Aggregation only considers the data points from the aggregation period. For example, Rules
executed every 24 hours (1 day), using aggregation on bearing temperature on every hour, then the rule
engine will only consider data for last one hour and first 23-hour data gets ignored.
● IoT Sync for equipment has to be enabled for rules to trigger alerts (Alert type sync).
● Triggered events are only for machine alarms and not for normal time series data.
Note
● This application is only available on SAP BTP, Cloud Foundry environment (Amazon Web Services
(AWS) and Azure).
● If you update model header data, this will not reflect in the equipment unless you make an update on
the equipment data.
● Search on attribute values from location, which are assigned to the equipment are not supported. You
can search equipment based on the model attributes. You can also search equipment based on
attribute codelist values.
● Filter on attributes of type picture, enum, attributes with codelists of type date, numeric, and numeric
flexible having multiselect option and along with unit of measure are not supported.
● Multilanguage string attribute won't be displayed as per your logon language.
A business object such as a model, or an equipment undergoes state transitions during its creation and
maintenance in SAP Predictive Asset Insights.
Business objects such as models and items of equipment move to an unpublished state as soon as you create
either a new model or a new item of equipment. You do not have to save these business objects explicitly.
However, business entities such as instructions and announcements move to unpublished state on explicit
save. When you further publish these business objects or business entities they move to a published state.
When the business object or entity is in its published state, and you select new revision the business object or
business entity moves from published state to the in revision state. You can toggle between published state and
the in revision states by choosing the View Last Published option, and View Last Revision on the UI.
You can create revisions of a business object such as a model, piece of equipment, functional location, system
and so on. Additionally, you can create revisions for business entities such as an instruction, or an
announcement.
Procedure
1. To create a new revision of the business object or the business entity, open the business object or the
business entity in the published state and choose the link New Revision.
System creates the next higher revision than the published state of the business object or the business
entity.
2. To switch from in revision to the last published state of the business object or the business entity, open the
business object or the business entity in the revision state and choose the link View Last Published.
3. If multiple revisions for the business object or the business entity exists and you want to switch from last
published to the last in revision state of the business object or the business entity, open the business
object or the business entity in its published state, choose View Last Revision.
Irrespective of the number of published models and the number of revisions that exist for a business object
or a business entity, SAP Predictive Asset Insights allows you to switch between the last published state or
the last revision of the business object or the business entity.
This feature enables you to export the data to an excel for offline reference.
For easier understanding, the document refers to the exporting equipment data to an excel.
The tiles under Machine Learning Engine on the SAP Fiori launchpad support you in data science tasks.
Health Indicator Data Set Configuration [page 317] Configure data sets that you can use as input data when
training and scoring models for equipment health indicators.
Health Indicator Model Management [page 324] Configure models for equipment health indicators, and train
and score them.
Failure Mode Analytics Model Management [page 379] Configure models for failure mode analytics, and train and
score them.
Failure Mode Analytics Validation [page 396] Perform validation tasks to improve failure mode analytics.
Leading Indicators Model Management [page 399] Configure models for leading indicators, and train them.
Failure Curve Analytics Model Configuration Management Create model configurations for failure curve analytics, and
[page 405] train and score them.
This topic describes how to configure data sets for models used for equipment health indicators.
Prerequisites
The role DataScienceUser or the two roles DataScienceRead and DataScienceWrite are assigned to
your user.
Note
If the required role or roles are not assigned to your user, you cannot see the application on the launchpad.
Contact your Identity Management Administrator if the role or roles have not been assigned to your user
yet.
You need to configure data sets that you can then use as training input and scoring input for your models for
equipment health indicators.
Note
Once you have configured a data set and you use this data set in a model, you cannot delete the data set as
long as it is in use.
Procedure
1. On the SAP Fiori launchpad, go to the Machine Learning Engine group and open the Health Indicator Data
Set Configuration application.
2. To configure a data set, you can choose between the following options:
○ Configure a new data set based on an existing configuration: Select the base data set and choose
Copy. The new data set contains all settings of the base data set.
A feature is a combination of a certain indicator group with indicators, an aggregation function, and an
aggregation period. Each feature together with a specified range represents a new column in the data set.
Note
The maximum number of features that you can add to the data set is limited. This limit is determined
by the way the features are calculated. For more information, see Calculation of Features [page 322].
Select the indicators that you want to include in the data set such as pressure, temperature, or
humidity. Each indicator belongs to an indicator group.
Note
Select the aggregation functions that need to be executed on the indicators over the aggregation
period. The aggregation functions are provided by SAP Internet of Things. You can choose from the
following functions:
○ COUNT
○ FIRST
○ LAST
○ MIN (minimum)
○ MAX (maximum)
○ SUM
○ AVG (average)
○ STDDEV (standard deviation)
c. Define the aggregation period values:
○ For the aggregation period, enter the time frame within which indicator data are aggregated. The
aggregation period is a multiple of the step size.
○ For the period offset, define how much the aggregation period is moved in the past from a certain
timestamp.
Example
You set the aggregation period to 2 Days and the period offset to 4 Days. Your timestamp is
October 22nd, 2017 at 1:30 p.m. This means that the aggregation of indicator data begins on the
16th of October at 1:30 p.m. and ends on the 18th of October at 1:30 p.m. (4 days before the
timestamp and 2 days of aggregation).
If you want to use default values for the aggregation period and period offset, activate the Use Default
Values checkbox. The default value of the aggregation period is the value of the step size. The default
value of the period offset is 0, which means that the aggregation period is not moved at all.
d. Specify a range.
With a range, you can exclude values for the aggregation by selecting a minimum and a maximum
value. For all values outside this range, the selected NULL value strategy is applied.
Note
If you choose Apply, your features are added and the dialog box remains open so that you can
select further features. Once you have selected further features and you choose Apply, the already
added features are ignored and only the new features are added to the feature table.
5. (Only relevant if you decided to include labels in your data set): Configure the label for the data set:
a. Define the lead time.
With the lead time, you define a buffer before the prediction window to react to a failure that might
occur during the prediction window.
b. Specify the prediction window.
With the prediction window, you define the length of the time frame within which a failure can occur in
the future. The prediction window begins when the lead time ends and is a multiple of the step size.
If you enter 1 Day with 0 as the lead time, the data of the next 24 hours will be looked at. During this
time frame, you can expect a failure.
○ For notifications, you can choose from all notifications that are related to your equipment. By
default, all values are selected. If filter values exist, you can also filter the notifications by selecting
a specific status, priority or the header level failure mode (failure mode ID) to which the
notification is assigned.
Note
Only notifications with a valid malfunction start date are later collected during the model
training and scoring.
○ For alerts, you can choose from alert types that are defined in the Templates application. For more
information, see Adding Alert Types [page 285].
Note
To use an alert type in a data set, the alert type first needs to be added to an alert type group,
and then the alert type group needs to be assigned to the respective equipment model that is
used in the data set. For more information, see Adding Alert Type Groups and Assigning Alert
Type Groups to a Model.
Results
Your data set is configured and added to the Data Set Configurations pane.
If you have configured multiple data sets and you want to get information about a specific data set, select the
data set from the Data Set Configurations pane and use the URL of the selected data set to directly link to this
data set.
Related Information
Note
You need to use labeling for the fol
lowing algorithms of the learner
type CLASSIFICATION:
Depending on how many features you want to add to a data set, it is important to know how the maximum
number of features is calculated. This topic provides you with an overview of how features are calculated
including examples.
Calculation
The maximum number of features is based on the bucket size per added feature. The bucket size is calculated
by the aggregation period divided by the step size. For the maximum number of features, all bucket sizes are
aggregated over all added features. The allowed maximum sum is 2100.
Maximum number of features = (Sum of bucket sizes (aggregation period/step size) over all added
features) < = 2100
This means, depending on the bucket size, you can add more or less features. If you have a bucket size of 1, you
can add 2100 features to the data set. If you have a greater bucket size, you can add less features to the data
set. A bucket size of 2100 only allows you to add one feature to the data set.
Examples
The following examples show you some feature calculations based on different bucket sizes:
Bucket Size = 1
Example
Example
Example
You have added 650 features with a bucket size of 1 and greater than 1 as follows:
Example
You have added 800 features with a bucket size greater than 1 as follows:
Example
You have added 200 features with a bucket size greater than 1 as follows:
This topic describes how to manage models for equipment health indicators.
Prerequisites
The role DataScienceUser or the two roles DataScienceUser and DataScienceRead are assigned to your
user.
Note
If the required role or roles are not assigned to your user, you cannot see the application on the launchpad.
Contact your Identity Management Administrator if the role or roles have not been assigned to your user
yet.
Context
To calculate the health status and predict failures for your equipment, you need to configure, train, and score
models in the Health Indicator Model Management application.
Procedure
1. To train and score a model, you first need to configure a model. For more information, see Configuring a
Model [page 325].
This topic describes how to configure models for equipment health indicators.
Prerequisites
At least one data set has been configured in the Health Indicator Data Set Configuration application.
Context
Procedure
1. On the SAP Fiori launchpad, go to the Machine Learning Engine group and open the Health Indicator Model
Management application.
2. To configure a model, you can choose between the following options:
○ Configure a new model based on an existing model: Select the base model and choose Copy. The
new model contains all settings of the base model.
Results
If you have configured multiple models and you want to get information about a specific model, select the
model from the Models pane and use the URL of the selected model to directly link to this model.
General Information
Note
You can use the following charac
ters:
Training Input x Select the data set that you want to use
to train the model. You can choose from
all configured data sets.
Scoring Input x Select the data set that you want to use
to score the model. You can use the pre
selected data set from the training in
put or select a different data set and
choose from all configured data sets.
Note
The data set is only preselected
when you configure a new model,
not when you edit or copy a model.
● CLASSIFICATION
This learner type is used to predict
a category, for example, to classify
between good and defective.
Dependent variable: Mandatory
● REGRESSION
This learner type is used to predict
a value, for example, a health
score.
Dependent variable: Mandatory
● SURVIVAL
This learner type is used to predict
the expected length of time until a
certain event, such as the break
down of a piece of equipment, will
happen.
Dependent variable: Mandatory
● RULES
This learner type is used to include
rules in the machine learning proc
ess.
Dependent variable: Not allowed
● UNSUPERVISED
This learner type is used to organ
ize data or to describe its struc
ture.
Dependent variable: Not allowed
● OTHER
Dependent variable: Optional
Note
Depending on the algorithm that
you have selected, this field is dis
played or hidden.
Note
The dependent variable must differ
from the independent variables.
Note
If you have selected the algorithms
Automatic Failure Prediction (AFP)
or Automatic Anomaly Detection
(AAD), no parameters are dis
played. These algorithms find the
most suitable parameters and val
ues for the provided data set in the
background.
Note
Consider the following:
Use Case
Before you explore the details of anomaly detection with principal component analysis (PCA), you should first
know when to use this algorithm. A typical use case would be the following:
Example
A railway operator uses sensors in locomotives. Four motors each have four temperature sensors. If the
motors are working correctly, all 16 sensors send data about a synchronous increase or decrease of
temperature. PCA notes when this behavior changes. You would use this algorithm to monitor this behavior
and to detect if sensors send temperature data that differ from other sensors, which might indicate that a
motor is damaged and needs to be maintained.
For more information, see Anomaly Detection with Principal Component Analysis (PCA) [page 336].
Use Case
Before you explore the details of distance-based failure analysis using earth mover’s distance (EMD) as known
in computer science,(also known as the Wasserstein metric in mathematics), you should first know when to
use this algorithm. A typical use case would be the following:
Example
An airplane contains electric devices that have batteries inside. These electric devices are equipped with at
least two sensors that send data. Sensor A sends data about measurements of electric current, sensor B
sends data about voltage measurements. An electric device could also have a sensor C that sends data
about temperature measurements. The data sent by the three sensors not only depends on the electric
device itself, but also on other factors that affect the electric device and its batteries. These factors could
be the weather conditions at heights of several kilometers, how often the device is used in the cockpit,
under which conditions the pilot uses the device, and so on. It is therefore normal that data sent from the
three sensors might vary around a certain mean score. The data from each sensor can be visualized in a
one-dimensional histogram. For multidimensional visualizations, scatterplots are used. This visualization is
like a fingerprint of each battery in the airplane. To compare the sensor data of different batteries without
looking at and comparing each visualization, a distance measure for probability distributions is needed.
One of these measures is the Wasserstein metric, or EMD. It can be used to measure deviation from a
known good reference fingerprint of a battery, or to measure differences between several batteries of the
same type, for example.
For more information, see Distance-Based Failure Analysis Using Earth Mover’s Distance (EMD) [page 338].
Use Case
The algorithm for multivariate autoregression (MAR) can detect dependencies between different kinds of
sensors even if the influence of one sensor by another one is delayed over time.
Example
An example might be the changes in the outflow temperature of a system, which after a while is also
reflected in the inflow temperature of a downstream system. MAR can handle different kinds of sensor
values, and autonomously ranks their influence on each other. The algorithm can therefore handle noisy or
random signals.
MAR produces good results if abnormal behavior is detected for systems with various different kinds of
sensors that (partly) depend on and influence each other.
For more information, see Anomaly Detection Using Multivariate Autoregression (MAR) [page 340].
Use Case
The TEC algorithm can be used whenever the following applies:
Example
For a rotating engine, sensors measure vibrations at different positions of the housing. A frequency analysis
of these vibrations has been performed and, as a result, an SAP HANA fusion view (only valid for on-
premise edition) has been created. This fusion view contains several calculated columns per sensor that
express the strength of certain characteristic frequencies of the equipment within the vibrations. From an
algorithm point of view, these columns represent the features. In this setting, the TEC algorithm can be
used to learn to distinguish unhealthy from healthy vibration patterns from historical labeled data. That is
data that includes one additional column specifying whether the system was healthy or not at the time in
the past when the vibrations were observed. The model created by TEC can then be applied to detect
engine problems early on.
For more information, see Failure Prediction Using Tree Ensemble Classifier (TEC) [page 342].
Use Case
Before you explore the details of SVM, you should first know when to use this algorithm. A typical use case
would be the following:
Example
In an aircraft, the turbines’ condition is monitored using sensors measuring values such as temperature
and air flow. Sensor records from flights where the aircraft’s turbines are known to have worked correctly
are used to train One-Class-SVM models for different operating modes such as take-off, landing, or
constant cruise. Using these models, it can be told whether an aircraft turbine of the former type is running
properly, needs repair, or maybe even needs to be replaced.
For more information, see One Class Support Vector Machine (SVM) for Anomaly Detection [page 344].
Use Case
Logistic regression (LOR) for failure prediction can be used whenever the following applies:
Example
The job of an ATS box is to capture and burn off (regenerate) the particulate matter (soot) in the engine’s
exhaust gas. When an ATS box is replaced, a primary failed part is identified which may either be the ATS
box itself or an upstream component. In this case, the logistic regression can be used to predict if the
process is still okay or near to failing, and what the main influencers are, that is if the ATS box or some
upstream componentis the problem.
For more information, see Logistic Regression (LOR) for Failure Prediction [page 345].
Use Case
Before you explore the details of anomaly detection using interquartile range (IQR), you should first know when
to use this algorithm. A typical use case would be the following:
Example
You want to monitor a motor using a sensor measuring its temperature. If the motor is too cold, it is not
operating effienctly and an overheating of the motor should also be avoided. The algorithm automatically
determines thresholds for the normal range of the sensor and can identify issues based on the sensor
being out of range.
For more information, see Anomaly Detection Using Interquartile Range (IQR) [page 347].
Use Case
Failure prediction using automatic failure prediction (AFP) can be used whenever the following applies:
Example
You monitor a pump within a production process by the use of multiple sensors such as pressure, voltage,
and temperature. By using automatic failure prediction, you create a model that uses data from the
different sensors to predict breakdowns of the pump.
For more information, see Failure Prediction Using Automatic Failure Prediction (AFP) [page 348].
Use Case
Before you explore the details of anomaly detection using automatic anomaly detection (AAD), you should first
know when to use this algorithm. A typical use case would be the following:
Example
You want to monitor a welding robot using multiple sensors measuring its current, voltage, and resistance.
By using the algorithm, an anomaly detection model is created from the sensors. By monitoring the
behavior of the sensors, anomalies are detected that can indicate a potential failure.
For more information, see Anomaly Detection Using Automatic Anomaly Detection (AAD) [page 349].
The principal component analysis (PCA) can be used to detect anomalies in mulitvariate sensor data.
The algorithm basically transforms data readings from an existing coordinate system into a new coordinate
system. This concept is depicted in the following sequence of graphics:
1.
2.
The closer data readings are to the center of the new coordinate system, the closer these readings are to an
optimum value.
Model Configuration
To configure a model for anomaly detection with PCA, use the Health Indicator Model Management application.
For more information, see Managing Models for Equipment Health Indicators [page 324].
Do not use all observations for model training. Rather, use observations from known equipment with normal
behavior for the model training instead of random observations where possible. A small amount of abnormal
data normally has no effect on the model performance.
This algorithm cannot handle missing values in a data set. If your data set contains such NULL values, you
cannot train and score your model. To train and score your model, you need to remove or replace existing NULL
values by using the NULL value strategy. For more information, see Fields for Configuring a Data Set [page 321].
Model Training
Model training for PCA means calculating the eigenvectors and eigenvalues of the covariance matrix of the
training data.
Note
The model size depends only on the number of dimensions (that is, the sensors) that go into the model, not
on the number of training examples.
To train a model for anomaly detection with PCA, use the Health Indicator Model Management application. For
more information, see Managing Models for Equipment Health Indicators [page 324].
After a training, a model summary of the trained model is displayed in the Trainings table. For more
information, see Model Summary [page 374].
Model Scoring
Anomaly Score
The anomaly score is calculated using the Mahalanobis distance between a sensor reading and the mean of all
readings, which is the center of the transformed coordinate system.
Smoothing
In some cases, anomaly scores can be high but only for a few seconds. This phenomenon is not usually critical,
and can represent normal behavior (if a machine is started, for example). Smoothing algorithms added to the
anomaly score prevent anomaly alerts caused by sporadic anomalies. The smoothing of algorithms is done
using the running median.
To score a model for anomaly detection with PCA, use the Health Indicator Model Management application. For
more information, see Managing Models for Equipment Health Indicators [page 324].
To explain what the algorithm does, we can use a figurative example: The algorithm solves a linear optimization
problem, in this case a transportation problem. Suppose you want to transform a sandcastle A into a
sandcastle B. Both sandcastles consist of the same amount of sand. EMD measures how much sand you have
to transport across which distance. The algorithm compares the locations of both sandcastles: Are they
located close to each other, or does the sand have to be transported a long way from sandcastle A to
sandcastle B? The algorithm also compares how the two sandcastles are shaped, for example. If they have a
similar shape, no or little rebuilding work needs to be done. If their shapes differ significantly, considerable
effort is required to rebuild sandcastle A so that it looks like sandcastle B. The conclusion is that the closer and
more similar the sandcastles are, the lower the work effort and transport costs are.
Similar to the example, the histogram of a battery A, for example, is compared to the histogram of a well
functioning battery B. The lower the score calculated with EMD, the more similar the histograms are (battery A
is working like battery B). The higher the score, the more different the histgrams are.
To configure a model for distance-based failure analysis using earth mover's distance, use the Health Indicator
Model Management application. For more information, see Managing Models for Equipment Health Indicators
[page 324].
Before training and scoring, data scientists need to configure a model. In the configuration, they need to
specify the names of one or more columns that contain values by which the data need to be grouped. These
grouping columns are used for scoring. You can define as many grouping columns as required for your
business case. The grouping columns are included in scoring only. In training, the grouping columns are used
to exclude these columns from training.
This algorithm cannot handle missing values in a data set. If your data set contains such NULL values, you
cannot train and score your model. To train and score your model, you need to remove or replace existing NULL
values by using the NULL value strategy. For more information, see Fields for Configuring a Data Set [page 321].
Model Training
To train a model for distance-based failure analysis using earth mover's distance, use the Health Indicator
Model Management application. For more information, see Managing Models for Equipment Health Indicators
[page 324].
After a training, a model summary of the trained model is displayed in the Trainings table. For more
information, see Model Summary [page 374].
Model Scoring
To score a model for distance-based failure analysis using earth mover's distance, use the Health Indicator
Model Management application. For more information, see Managing Models for Equipment Health Indicators
[page 324].
A multivariate autoregressive model can be used to detect anomalies in a univariate or multivariate series of
sensor data records varying over time.
Based on the training data, which in this case is a time series of data records, the algorithm trains a model. If
trained on regular data (data without anomalies present), the model is capable of learning the regular behavior
of a system. Based on a window of recently observed data records, the model can then predict the data record
for one time step into the future. Once the actual values for this point in time are available, the model prediction
can be compared to the actual observations. An anomaly score is then assigned based on the distance
between the prediction and the observation. If large deviations appear, this can indicate abnormal behavior of
the underlying system.
The following graphic illustrates the predictive model for one input variable:
Note
The implemented algorithm computes one multivariate predictive model per input variable, and aggregates
the deviations for the equipment from each model.
To configure a model for multivariate autoregression, use the Health Indicator Model Management application.
For more information, see Managing Models for Equipment Health Indicators [page 324].
This algorithm cannot handle missing values in a data set. If your data set contains such NULL values, you
cannot train and score your model. To train and score your model, you need to remove or replace existing NULL
values by using the NULL value strategy. For more information, see Fields for Configuring a Data Set [page 321].
For a correct training and scoring, the number of records in the provided data time series used for training
needs to be at least window.size +1 per group (typically per piece of equipment).
Tip
For more robust models and, thus, more reliable anomaly scores, we recommend using a training data size
at least one or two orders of magnitude larger than the window size.
Tip
We generally recommend creating one distinct model per group of input variables for which a tight,
time-varying dependency can be assumed, rather than modeling a joint model of all input variables.
Example
An example of a tightly coupled group of input variables could be battery voltage and charging current
for the system of a rechargeable battery.
Tip
If it is clear from the system context that the sensor dependency is directed (the battery voltage is
influenced by the charging current, but the charging current is typically not directly influenced by
battery voltage), we recommend specifying prediction targets (battery voltage in this example)
manually using the corresponding model-specific parameters.
Model Training
To train an MAR model, the provided data is used to fit one autoregressive multivariate linear model for each
target variable. By default, each provided input variable is also a target variable, but the model-specific
parameter target.columns can be used to select only specific input variables as target variables.
To train a model for multivariate autoregression, use the Health Indicator Model Management application. For
more information, see Managing Models for Equipment Health Indicators [page 324].
Model Scoring
Scoring is applied to a series of window.size + 1 consecutive records referring to the order of their
timestamps. The first n of these records are used as input for the linear models established during training to
produce predictions for each target of the record number window.size + 1.
Each prediction is compared to the actual values of the first window.size + 1 record. An anomaly score is
derived based on the distance between predictions and observations, and on other influencing factors such as
model uncertainty.
To score a model for multivariate autoregression, use the Health Indicator Model Management application. For
more information, see Managing Models for Equipment Health Indicators [page 324].
Based on records of sensor data, a tree ensemble model can learn to predict future system failures from past
failures.
The algorithm trains a boosted decision tree model, which is a series of decision trees, that encodes
characteristics of data records with regards to failure. Based on the values of features of a given data record,
the model is trained in such a way that each tree can decide which set of record groups the given record
belongs to. An appropriate weight is then assigned to each record, indicating evidence for or against the record
belonging to a failing system. The model aggregates the evidence weights of all trees and outputs a probability
of failure. Thus, the model reflects the certainty that the given data record is an indication of a failing system.
Model Configuration
To configure a model for the tree ensemble classifier, use the Health Indicator Model Management application.
For more information, see Managing Models for Equipment Health Indicators [page 324].
This algorithm is a supervised learning method. This means that it requires training data records featuring a
column that indicates for each record whether a record belongs to a regular or a failing system.
Model Training
Model training for TEC means using the provided historical training data to learn the following:
Together, these make up the model as referred to in the context of this algorithm.
The aim is to find a model that well represents the data set used for training. Internally, this algorithm splits the
data into a train and test set, using 90% of the data for the training. After a training, quality metrics calculated
The contribution of each feature (independent variable) of a trained model, i.e the feature importance, can be
found in the Log Summary in the Trainings table.
To train a model for the tree ensemble classifier, use the Health Indicator Model Management application. For
more information, see Managing Models for Equipment Health Indicators [page 324].
Model Scoring
To score a record, the TEC model determines for each decision tree the group that the record belongs to based
on the feature values of this record. Next, the assigned evidence weights of each tree are aggregated for this
record.
Example
Referring to the graphic above, these weights could be -41.83 (taken from group 1.4 of tree 1), and -99.04
(taken from group 2.2 of tree 2). Which weights of a tree are aggregated depends on the decision result of a
tree.
To score a model for the tree ensemble classifier, use the Health Indicator Model Management application. For
more information, see Managing Models for Equipment Health Indicators [page 324].
In order to identify anomalous behaviour of equipment, the current sensor values of this particular piece of
equipment are compared with sensor values of a period when the equipment is working correctly. This is done
by training a model using sensor data from when the equipment was working correctly, which is then used to
classify the current sensor values as normal or anomalous accordingly.
An n-dimensional set of data points, considered as normal by the user, is supplied to the algorithm. The
algorithm classifies the data by spatially separating the region containing the set from the rest of the n-
dimensional space. This, in most of the cases, is done by finding a hyperplane in a higher dimensional space,
which is enclosing the data when projecting back to the initial n dimensions. The hyperplane is characterized
by so-called support vectors, lying at the edge of enclosed region of as normal classified data. If a new data
point needs to be classified, the distance between the data point and any of the support vectors is computed.
From this, it can uniquely be told whether the data point lies within the region of normal data, so is a member of
the learned 'normal' class, or is anomalous.
To configure a model for this type of anomaly detection, use the Health Indicator Model Management
application. For more information, see Managing Models for Equipment Health Indicators [page 324].
This algorithm cannot handle missing values in a data set. If your data set contains such NULL values, you
cannot train and score your model. To train and score your model, you need to remove or replace existing NULL
values by using the NULL value strategy. For more information, see Fields for Configuring a Data Set [page 321].
Model Training
To train a model for this type of anomaly detection, use the Health Indicator Model Management application.
For more information, see Managing Models for Equipment Health Indicators [page 324].
Note
The Support Vector Machine algorithm is sensitive to the number of rows in training data. The run time of
the training methods exponentially grows with the number of rows of input data. While for a data set with
ten columns and 10k rows training takes about 15 sec, training on a table with ten columns and 100k rows
already takes more than half an hour. On the other hand, SVM has performance advantage in case of
increased number of features, which is columns.
After a training, a model summary of the trained model is displayed in the Trainings table. For more
information, see Model Summary [page 374].
Model Scoring
To score a model for this type of anomaly detection, use the Health Indicator Model Management application.
For more information, see Managing Models for Equipment Health Indicators [page 324].
This algorithm uses logistic regression to perform supervised binary classification, meaning the algorithm is
able to predict either 0 or 1 corresponding to a healthy or unhealthy state. Logistic regression, similar to Tree
The algorithm fits a multi-dimensional logistic function to the input data. For this, a label column, specified as
dependent, is required containing only the values 0 and 1. The logistic function gets fitted to these values, using
the predictor values as arguments. In scoring, the value of the fitted function obtained during training is
computed. This value is interpreted as failure probability. Each data with a score larger than the cutoff is
classified as 1, otherwise 0.
Model Configuration
To configure a model using LOR, use the Health Indicator Model Management application. For more
information, see Managing Models for Equipment Health Indicators [page 324].
This algorithm cannot handle missing values in a data set. If your data set contains such NULL values, you
cannot train and score your model. To train and score your model, you need to remove or replace existing NULL
values by using the NULL value strategy. For more information, see Fields for Configuring a Data Set [page 321].
Model Training
Internally, this algorithm splits the data into a train and test set, using 90% of the data for the training. After a
training, quality metrics calculated on the test set are displayed in a model summary in the Trainings table. For
more information, see Model Summary [page 374].
To train a model using LOR, use the Health Indicator Model Management application. For more information, see
Managing Models for Equipment Health Indicators [page 324].
Model Scoring
To score a model using LOR, use the Health Indicator Model Management application. For more information,
see Managing Models for Equipment Health Indicators [page 324].
This algorithm uses the interquartile range test for determining anomalies on univariate timeseries. During the
training, the normal range is determined for each piece of equipment by using the interquartile range (upper
quartile – lower quartile). The interval between lower quartile – n * inter-quartile range and upper quartile + n *
interquartile range is considered as the normal range. All data points in this range receive scores between 0
and 1. All data points outside that range receive scores greater than 1.
Model Configuration
To configure a model for anomaly detection using IQR, use the Health Indicator Model Management application.
For more information, see Managing Models for Equipment Health Indicators [page 324].
Model Training
To train a model for anomaly detection using IQR, use the Health Indicator Model Management application. For
more information, see Managing Models for Equipment Health Indicators [page 324].
After a training, a model summary of the trained model is displayed in the Trainings table. For more
information, see Model Summary [page 374].
Model Scoring
To score a model for anomaly detection using IQR, use the Health Indicator Model Management application. For
more information, see Managing Models for Equipment Health Indicators [page 324].
Note
If the trained model is based on a constant value, a deviating value from this constant receives an infinite
value in scoring. In this case, the value is set to MAX_FLOAT.
Based on records of sensor data, a tree ensemble model can learn to predict future system failures from past
failures.
This algorithm uses a black box approach to learn a classification model for failure prediction.
Model Configuration
To configure a model for failure prediction using AFP, use the Health Indicator Model Management application.
For more information, see Managing Models for Equipment Health Indicators [page 324].
This algorithm is a supervised learning method. This means that it requires training data records featuring a
column that indicates whether each record belongs to a regular or a failing system.
Model Training
Model training for AFP means using the provided historical training data to learn a classification model for
failure prediction.
The aim is to find a model that well represents the data set used for training. Internally, this algorithm splits the
data into a train and test set, using 90% of the data for the training. After a training, quality metrics calculated
on the test set are displayed in a model summary in the Trainings table. The algorithm may also generate
additional features (independent variables) internally based on the training data. After the training, these may
also appear in the model summary. For more information about the model summary, see Model Summary
[page 374].
To train a model for failure prediction using AFP, use the Health Indicator Model Management application. For
more information, see Managing Models for Equipment Health Indicators [page 324].
Model Scoring
To score a record, the model found in the training is applied to the scoring data.
This algorithm may also generate additional features (independent variables) internally based on the scoring
data. After the scoring, these may appear in the log summary.
To score a model for failure prediction using AFP, use the Health Indicator Model Management application. For
more information, see Managing Models for Equipment Health Indicators [page 324].
This algorithm trains and scores multiple anomaly detection models and compares their score distribution to
find the most appropriate unsupervised anomaly detection model. The model that best separates anomalies
from normal behavior is considered the most appropriate unsupervised anomaly detection model.
The following graphic illustrates the difference between an inappropriate and appropriate anomaly detection
model. In the diagram of the inappropriate anomaly detection model, the scores are overlapped and a
separation of anomalies from normal scores is not possible. In the diagram of the appropriate anomaly
detection model, the scores are split and anomalies can be separated from normal data:
Model Configuration
To configure a model for anomaly detection using AAD, use the Health Indicator Model Management
application. For more information, see Managing Models for Equipment Health Indicators [page 324].
For the model training, use training data that includes normal data and anomalies. The percentage of the
included anomalies is assumed to be a maximum of 10%.
This algorithm cannot handle missing values in a data set. If your data set contains such NULL values, you
cannot train and score your model. To train and score your model, you need to remove or replace existing NULL
values by using the NULL value strategy. For more information, see Fields for Configuring a Data Set [page 321].
Model Training
To train a model for anomaly detection using AAD, use the Health Indicator Model Management application. For
more information, see Managing Models for Equipment Health Indicators [page 324].
After a training, a model summary of the trained model is displayed in the Trainings table. For more
information, see Model Summary [page 374].
Model Scoring
To score a model for anomaly detection using AAD, use the Health Indicator Model Management application.
For more information, see Managing Models for Equipment Health Indicators [page 324].
Depending on the algorithm that you have selected, different parameters are displayed. The following sections
provide you with an overview of the parameters with their descriptions and default values, sorted by the
algorithms:
Note
If you have selected the algorithms Automatic Failure Prediction (AFP) or Automatic Anomaly Detection
(AAD), no parameters are displayed. These algorithms find the most suitable parameters and values for the
provided data set in the background.
Parameter Description
● Quantile (default)
Internally calculates an effective threshold value based
on the training data. Raw scores and normalized scores
are generated.
● Threshold
Uses the given value. Raw scores and normalized scores
are generated.
● None
Does not do any normalization of the values. Only raw
scores are generated.
Note
For more information about the normalization of scores,
see Normalization of Scores [page 363].
normalizer.value The value used for the normalization. For quantile, a value
between 0 and 1 is valid; for threshold, a value larger than 0.
Note
To use this parameter, enter Timestamp as a value in
the group.by parameter in addition to a value in the
alignment.interval parameter. Otherwise, the
scores are not calculated by the
alignment.interval parameter.
Parameter Description
cutoff Cutoff for the binary classes. Data with score below is classi
fied 0, above is classified 1.
Parameter Description
Note
As nu specifies the fraction of training samples which
you assume to be outliers and, for
normalizer.type, normalizer.value speci
fies the fraction of training samples which you assume
to be normal, these two values should always add up to
one. If you set nu to 0.01, you are advised to set the
normalizer.value to 0.99 if you use the
normalizer.type quantile.
● Quantile (default)
Internally calculates an effective threshold value based
on the training data. Raw scores and normalized scores
are generated.
● Threshold
Uses the given value. Raw scores and normalized scores
are generated.
● None
Does not do any normalization of the values. Only raw
scores are generated.
Note
For more information about the normalization of scores,
see Normalization of Scores [page 363].
normalizer.value The value used for the normalization. For quantile, a value
between 0 and 1 is valid; for threshold, a value larger than 0.
Note
As nu specifies the fraction of training samples which
you assume to be outliers and, for
normalizer.type, normalizer.value speci
fies the fraction of training samples which you assume
to be normal, these two values should always add up to
one. If you set nu to 0.01, you are advised to set the
normalizer.value to 0.99 if you use the
normalizer.type quantile.
Parameter Description
Note
You need to enter the exact name of the columns be
cause this field is case-sensitive.
Note
If windowing is applied, the algorithm uses the data of
the window_size parameter former rows (based on
the timestamp). In order to ensure a proper functional
ity, an equidistance is recommended.
● Quantile (default)
Internally calculates an effective threshold value based
on the training data
● Threshold
Internally calculates an effective threshold value based
on the training data. Raw scores and normalized scores
are generated.
● None
Does not do any normalization of the values. Only raw
scores are generated.
Note
For more information about the normalization of scores,
see Normalization of Scores [page 363].
normalizer.value The value that is used for the normalization. For quantile, a
value between 0 and 1 is valid; for threshold, a value larger
than 0.
Parameter Description
group.by Name(s) of the column(s) used for grouping data rows. This
parameter is mandatory.
sort.by Name(s) of the column(s) used for sorting data rows. This
parameter is mandatory.
Note
This value must be an odd number.
Note
If windowing is applied, the algorithm uses the data of
the window_size parameter former rows (based on
the timestamp). In order to ensure a proper functional
ity, an equidistance is recommended.
● Quantile (default)
Internally calculates an effective threshold value based
on the training data. Raw scores and normalized scores
are generated.
● Threshold
Uses the given value. Raw scores and normalized scores
are generated.
● None
Does not do any normalization of the values. Only raw
scores are generated.
Note
For more information about the normalization of scores,
see Normalization of Scores [page 363].
normalizer.value The value that is used for the normalization. For quantile, a
value between 0 and 1 is valid; for threshold, a value larger
than 0.
Parameter Description
records.subsampling.ratio Defines the share of records (that is,. rows of the training
data) to be used to train each tree of the ensemble model.
The number of records corresponding to the specified share
is chosen randomly (without replacement) from the training
data set. Specifying a value strictly smaller than 1 for this pa
rameter can increase the robustness of the model (that is, it
is less likely to overfit) if .number.of.trees is set to a suffi-
ciently large value (problem-dependent) at the same time.
On the downside, a smaller value for this parameter may
lead to lower overall model accuracy and confidence, and
may (indirectly) require higher computational effort due to a
need for larger values for .number.of.trees. Also, a relatively
large training data set may be required for subsampling to
be successful. Permitted value range is numbers greater
than 0 and less than or equal to 1. Note that a value of 1 ef
fectively means that no subsampling is performed.
features.subsampling.ratio Defines the share of features (that is, columns of the training
data) to be used to train each tree of the ensemble model.
The number of columns corresponding to the specified
share is chosen at random (without replacement) from the
given training data set. Similarly to .records.subsampling.ra
tio, specifying a value strictly smaller than 1 can be used to
increase the robustness of the model, but may come at thea
price: lower accuracy and model confidence, and choosing a
smaller value for .features.subsampling.ratio may reduce the
ability to capture complex relationships in the data success
fully. It can be helpful, however, to tune this parameter if the
given data set contains highly correlated features (for exam
ple, variants obtained through feature engineering). The per
mitted value range is numbers greater than 0 and less than
or equal to 1. Note that a value of 1 effectively means that no
subsampling is performed.
max.weight.contrib.per.leaf Defines how much weight each leaf of a tree may contribute
maximally to the ensemble model. Within the algorithm, this
parameter is used as a threshold to cap xgboost's gradient
step in norm (that is, in absolute length). Choosing a smaller
value for this parameter may help deal with unbalanced data
sets (i.e. data sets where the occurrence of one class is only
a fraction of the occurrence of the other class) by preventing
"highly confident" leaves dominating "less confident" leaves
as a result of sheer sample majority. The permitted value
range is numbers greater than or equal to 0. Note that 0
means that no limit is specified on the maximum weight con
tribution of each leaf, while every strictly positive number
specifies a weight threshold.
learning.rate Defines the step size of the updates calculated through each
tree on the ensemble learning objective function. In this spe
cific algorithm, this parameter can be interpreted as the level
of trust the ensemble model gives to each tree before calcu
lating the next tree on the score residuals of the previously
calculated trees. Choosing a smaller value will mean that ob
jective functions of subsequently computed trees will look
more alike and, as a consequence, the ensemble model
tends to feature more trees per problem facade (at the cost
of covering fewer facades if the overall number of trees is not
increased). It is generally recommended to increase num
ber.of.trees when decreasing learning.rate. Reducing this pa
rameter can be used to increase number.of.trees when de
creasing learning.rate. Reducing this parameter can be used
to prevent overfitting, but it comes at the price of typically
requiring a higher number.of.trees to achieve comparable
model accuracy and confidence. The permitted value range
is numbers greater than 0 and less than or equal to 1.
initial.guess.bias Allows you to introduce a bias into the classifier. This param
eter serves as the inital guess (score) to which the tree mod
els are iteratively added. Assuming that result scores (of the
ensemble model) smaller than 0.5 are interpreted as pre
dicting class '0' and scores greater than or equal to 0.5 are a
prediction of class '1', code.initial.guess.bias can be used to
require more tree weight to predict one class compared to
the other, and thus naturally favor one class. Tuning this pa
rameter may help to find a desirable tradeoff between so-
called "false positives" and "false negatives" among incor
rectly classified records. Permitted value range is numbers
greater than or equal to 0 and less than or equal to 1. A value
of 0.5 means no bias in either direction.
● error (default)
The error rate for the binary classification that is calcu
lated as #(wrong cases)/#(all cases). For
the predictions, the evaluation regards the instances
with prediction value larger than 0.5 as positive instan
ces, and the others as negative instances.
● error@t
A different than 0.5 binary classification threshold value
could be specified by providing a numerical value
through "t", where t is a decimal between 0 and 1. A
possible example is "[email protected]".
● auc
Area under the ROC curve.
Note
For more information about the parameter
evaluation.metric and the ROC curve, see
XGBoost Parameters and ROC curve .
scale.pos.weight Controls the balance of positive and negative weights, for in
stance if it is desired to weight the positive cases more than
negative ones. This scenario is useful for unbalanced classes
that are typical in predictive maintenance. Any positive real
number can be entered by the user.
Note
If it is not desired to weight classes differently, the value
1 should be used.
Parameter Description
● Quantile (default)
Internally calculates an effective threshold value based
on the training data
● Threshold
Internally calculates an effective threshold value based
on the training data. Raw scores and normalized scores
are generated.
● None
Does not do any normalization of the values. Only raw
scores are generated.
Note
For more information about the normalization of scores,
see Normalization of Scores [page 363].
normalizer.value The value that is used for the normalization. For quantile, a
value between 0 and 1 is valid; for threshold, a value larger
than 0.
Normalizing scores enables you to compare scores computed for different equipment using different anomaly
detection algorithms.
You can use the normalization type threshold to score a model if you know the threshold for your data set that
distinguishes normal data from abnormal data.
You can compare scores that were computed using different algorithms. The following table provides you
with an example of how normalized scores are calculated:
Algorithm 1 Algorithm 2
Raw Score Normalized Score Interpreta Raw Score Normalized Score Interpreta
Score tion Score tion
Without normalizing the raw scores of the algorithms 1 and 2, a comparison of the scores of these two
algorithms would hardly be possible. Using the threshold, which represents a percentage of 100, the
normalized scores are set in relation to this percentage and can therefore be compared across different
anomaly detection algorithms.
You can use the normalization type quantile to train a model if you do not know the threshold for your data set.
However, you know the data set itself very well, and you know that a certain percentage of your raw scores are
outliers.
Example
You do not have a training set of normal data that is below a certain threshold. You cannot therefore train
your model against a training data set. However, you know that 90 % of your raw scores are normal and
10 % of your raw scores are abnormal. You also know which scores represent normal values and which
values represent abnormal values. What you need to do before you can score your model is to get to a
threshold that distinguishes normal from abnormal scores.Without normalizing the raw scores of the
algorithms 1 and 2, a comparison of the scores of these two algorithms would hardly be possible. Using the
threshold, which represents a percentage of 100, the normalized scores are set in relation to this
percentage and can therefore be compared across different anomaly detection algorithms.
Afteryour model has been trained with the empirical quantile process, the calculated effective threshold is used
to score your model. The scoring process is then executed as described in the section Normalization Type:
Threshold:
Depending on the algorithm that you have selected, different outputs are displayed. The following sections
provide you with an overview of the outputs with their descriptions, data type and dimension, sorted by the
algorithms:
This topic describes how to train models for equipment health indicators.
Prerequisites
Context
Note
After the first successful training of a model, you can only edit the name, description, and tags of the
model.
Procedure
1. On the SAP Fiori launchpad, go to the Machine Learning Engine group and open the Health Indicator Model
Management application.
2. To train a model, you can choose between the following options:
○ Set up a regular training for the model. For more information, see Scheduling Regular Training of a
Model [page 371].
○ Set up a manual training for the model. For manual training, proceed as described in the following
steps:
3. From the Models pane, select the model you want to train.
4. Define the time frame of the data that is used for training. You can choose between the following options:
○ Select a date and time in the New Training From and To fields by choosing .
○ Select a time frame by using the training data preview. For more information, see Selecting Training
Data Using Training Data Preview [page 372].
5. Choose Start Training.
The training run starts, showing the status in the Trainings table. The status refreshes every 5 seconds.
Once the training run is completed, you can see detailed information and the training job ID by clicking on
the log entries in the Log Summary column. You can also view a model summary with multiple metrics by
choosing . For more information about the model summary and the metrics, see Model Summary
[page 374].
If the role DataScienceDataExporter is assigned to your user, you can download your configured
data set for the latest successful training of your model by choosing Download Input Data. The
downloaded file includes the independent variables you selected as input for your model within the
defined time frame for the training. The file is available for 30 days after the training and is only for
information purposes.
Results
Related Information
This topic describes how to schedule a regular training of models used for equipment health indicators.
Prerequisites
Context
In the Health Indicator Model Management application, you can configure a schedule, update an existing
schedule, and activate or deactivate a schedule for the periodical execution of training.
Procedure
1. On the SAP Fiori Launchpad, go to the Machine Learning Engine group and open the Health Indicator Model
Management application.
2. From the Models pane, select the model you want to train.
Start Select the start date and time of the training schedule.
Recurrence Pattern Define whether the training job should run once or fre
quently at certain intervals.
Data Range Define a limited data set coming in during a certain time
period before the training.
5. Choose OK.
Results
You can later edit or also deactivate the training schedule if required.
Related Information
This topic describes how to select training data using the training data preview.
Context
In the Health Indicator Model Management application, you have different options to select a time frame for
training models. One option is to select the time frame by using the training data preview. This preview displays
the available training data for a certain period of time.
1. In the Health Indicator Model Management application, select the model that you want to train from the
Models pane.
The training data preview including a data preview histogram and a data preview slider is displayed under
Training Data Preview.
If the model is already trained, the data preview histogram and the data preview slider is visible by
choosing Show Data Preview and Training Runs.
Note
The data preview histogram shows an estimated number of all aggregated data of the training input.
The actual available data may differ from the displayed number of data in the chart depending, for
example, on the null strategy you have chosen or which independent variables you have selected.
2. Select a time frame. You can choose between the following options:
○ Click on the data preview slider.
○ Drag the frame to any point on the data preview slider.
○ Pull the left or right side of the frame to any point on the data preview slider.
Note
Only data within the past year is displayed in the data preview slider. If you want to select a time frame
with an earlier start date, select the time frame by using the New Training From and To fields.
Results
The selected training data is displayed in the data preview histogram in an enlarged view and the New Training
From and To fields are filled.
Related Information
After each training of a model, you can view a model summary. This model summary contains multiple metrics,
which help you to understand the trained model better and evaluate and compare the quality of different
trained models.
Background Information
When you train a model, metrics containing multiple numeric measurements and diagrams are calculated
automatically. These numeric measurements and diagrams are calculated in different ways:
● Based on all training data. This is typical for for the numeric measurements and diagrams for anomaly
detection, such as score distribution.
● Based on dedicated test data. In this case, a test set, representing 10% of the training data is automatically
split from the data, and is excluded from the training. The numeric measurements and diagrams are
calculated by using the test set to compare the model predictions with the actual outcomes of the test data
after the training. This is typical for the numeric measurements and diagrams for failure prediction, such as
accuracy.
● Based on the learned model. This is typical for the feature importance for failure prediction.
Depending on the algorithm that you have selected for the model training, a different combination of numeric
measurements and/or diagrams is displayed. The following tables provide you with an overview of the metrics
with their descriptions, and show the algorithms to which they apply:
Numeric Measurements
Accuracy This metric displays the overall fraction ● Logistic Regression (LOR)
of the correctly classified data. ● Automatic Failure Prediction (AFP)
● Tree Ensemble Classifier (TEC)
For this metric, values between 0 and 1
are possible. The value 1 refers to a per
fect model.
Note
This metric can be misleading for
highly imbalanced data sets.
Kappa This metric adjusts the accuracy based ● Logistic Regression (LOR)
on the expected accuracy provided by ● Automatic Failure Prediction (AFP)
the class distribution. ● Tree Ensemble Classifier (TEC)
Matthews Correlation Coefficient This metric takes class imbalance into ● Logistic Regression (LOR)
(MCC) ● Automatic Failure Prediction (AFP)
account.
● Tree Ensemble Classifier (TEC)
For this metric, values between -1 and 1
are possible. The value 0 refers to a ran
dom prediction. The value 1 refers to a
perfect prediction.
Sensitivity This metric displays the fraction of cor ● Logistic Regression (LOR)
rectly classified positive cases. ● Automatic Failure Prediction (AFP)
● Tree Ensemble Classifier (TEC)
For this metric, values between 0 and 1
are possible. The value 1 refers to a per
fect classification of all positive cases.
Specificity This metric displays the fraction of cor ● Logistic Regression (LOR)
rectly classified negative cases. ● Automatic Failure Prediction (AFP)
● Tree Ensemble Classifier (TEC)
For this metric, values between 0 and 1
are possible. The value 1 refers to a per
fect classification of all negative cases.
Test set size This metric displays the amount of data ● Logistic Regression (LOR)
that was used to calculate the metrics. ● Automatic Failure Prediction (AFP)
● Tree Ensemble Classifier (TEC)
Estimated Anomaly Fraction This metric displays the fraction of ab Automatic Anomaly Detection (AAD)
normal training data. The abnormal
training data are classified by the Auto
matic Anomaly Detection (AAD) algo
rithm.
Diagrams
Confusion Matrix This diagram displays the number of ● Logistic Regression (LOR)
correctly and incorrectly classified posi ● Automatic Failure Prediction (AFP)
tive and negative cases in the test set as
● Tree Ensemble Classifier (TEC)
separate tiles. Large numbers on the
green tiles on the diagonal indicate a
good classification. Large numbers on
the red tiles on the off-diagonal indicate
a bad classification.
Feature Importance This diagram displays the importance ● Automatic Failure Prediction (AFP)
of each feature for the model in a bar ● Tree Ensemble Classifier (TEC)
chart based on the gain provided by the
feature. The feature with the highest
value is considered to be the most im
portant feature.
Note
The feature importance is only dis
played for the 20 most important
features.
Score Distribution This diagram displays the distribution ● Automatic Anomaly Detection
of the training scores in a histogram. (AAD)
The distribution indicates how well you ● Interquartile Range (IQR)
can separate anomalies from normal
● Support Vector Machines (SVM)
scores. The scores are separated by dif
● Principal Component Analysis
ferent colors. Green indicates normal
(PCA)
data and red indicates anomalies.
● Multivariate Autoregression (MAR)
● Earth Mover’s Distance (EMD)
This topic describes how to score models for equipment health indicators.
Prerequisites
Context
Once you have trained a model, you can score the latest trained model to score data.
Note
1. On the SAP Fiori launchpad, go to the Machine Learning Engine group and open the Health Indicator Model
Management application.
2. To score a model, you can choose between the following options:
○ Set up a regular scoring for the model. For more information, see Scheduling Regular Scoring of a
Model [page 378].
○ Set up a manual scoring for the model. For manual scoring, proceed as described in the following
steps:
3. From the Models pane, select the model you want to score.
4. To define the time frame of data that is used for scoring, select a date and time in the Score Data From and
To fields by choosing .
5. Choose Start Scoring.
The scoring run starts, showing the status in the Scorings table. The status refreshes every 5 seconds.
Once the scoring run is completed, you can see detailed information and the scoring job ID by clicking on
the log entries in the Log Summary column.
Results
Next Steps
You can now check the scores in the indicator chart by choosing in the Scorings table. From the equipment
list, select a piece of equipment to display the algorithm scores over the scoring time for this piece of
equipment. This provides you with insights about the health and performance of your equipment.
Example
You have scored a model using the Multivariate Autoregression (MAR) algorithm. From the scores in the
indicator chart, you see that the MAR scores for your pump increased in the last week within the scoring
time frame. This means that the algorithm has detected a probable anomaly and you can expect a failure.
Note
● The icon for the indicator chart is only displayed when the scoring run was completed successfully.
● The scores in the indicator chart are only displayed when data for the equipment was collected during
the scoring run. You can view this information in the log entries of the scoring run.
This topic describes how to schedule a regular scoring of models used for equipment health indicators.
Prerequisites
Context
In the Health Indicator Model Management application, you can configure a schedule, update an existing
schedule, and activate or deactivate a schedule for the periodical execution of scoring.
Procedure
1. On the SAP Fiori launchpad, go to the Machine Learning Engine group and open the Health Indicator Model
Management application.
2. From the Models pane, select the model you want to score.
3. To configure the scoring schedule, choose Set Schedule.
Start Select the start date and time of the scoring schedule.
Recurrence Pattern Define whether the scoring job should run once or fre
quently at certain intervals.
Note
When you select the option to include all data since
the last execution, consider that only the data since
the last successful execution is taken into account.
5. Choose OK.
Results
You can later edit or also deactivate the scoring schedule if required.
Related Information
This topic describes how to manage models for failure mode analytics.
Prerequisites
● You have performed the configuration steps before configuring, training, and scoring a failure mode
analytics model. For more information, see Configuring Failure Mode Analytics [page 461].
● The role FMA_MODEL_MANAGER is assigned to your user.
Note
If the required role is not assigned to your user, you cannot see the application on the launchpad. Contact
your Identity Management Administrator if the role has not been assigned to your user yet.
To get insights and analytics about the patterns of failures for your equipment and equipment models, your
notifications need to be analyzed by configuring, training, and scoring models in the Failure Mode Analytics
Model Management application.
In this process, you first configure and train an unsupervised model and then configure, train, and score a
supervised model. The unsupervised model is the basis for the supervised model. The unsupervised model
identifies the characteristics of notification texts and maps the notification texts to the characteristics found in
standard failure modes. After the training, it suggests the most appropriate failure mode for each notification.
Tip
You can perform validation tasks to validate and improve the suggestion. For more information, see
Validating Failure Mode Analytics [page 396].
The supervised model learns from this suggestion by performing text classification. This means, it learns the
characteristics of individual failure modes from the mapped notification texts for upcoming notifications during
the training. After the scoring, it maps the most appropriate failure modes to upcoming notifications.
Procedure
1. To train an unsupervised model, you first need to configure it. For more information, see Configuring a
Model [page 380].
2. Once you have configured the unsupervised model, you can train it. For more information, see Training a
Model [page 390].
3. Once you have trained the unsupervised model, you can configure the supervised model. For more
information, see Configuring a Model [page 380].
4. Once you have configured the supervised model, you can train it. For more information, see Training a
Model [page 390].
5. Once you have trained the supervised model, you can use the latest trained model to score data. For more
information, see Scoring a Model [page 393].
This topic describes how to configure models for failure mode analytics.
Context
You start with first configuring a model of unsupervised learner type, and then a model of supervised
learner type.
Procedure
1. On the SAP Fiori launchpad, go to the Machine Learning Engine group and open the Failure Mode Analytics
Model Management application.
2. To configure a model, you can choose between the following options:
○ Configure a new model based on an existing model: Select the base model and choose Copy. The
new model contains all settings of the base model.
Results
Related Information
General Information
Note
The model name must not contain
whitespaces.
Algorithm
● LDA
Unsupervised topic modeling using
Latent Dirichlet Allocation for fail
ure mode assignment
● TextClassEnsemble
Failure mode analytics with super
vised TextClassEnsemble
● UNSUPERVISED
This learner type is displayed if you
have selected the algorithm name
LDA.
● SUPERVISED
This learner type is displayed if you
have selected the algorithm name
TextClassEnsemble.
Note
This field is visible only when you
create an unsupervised model.
Note
This field is visible only when you
create a supervised model.
Use Case
Before you explore the details of this algorithm, you should first know when to use this algorithm. Unsupervised
Topic Modeling applies for the following scenarios:
● The goal is to auto-assign labels to documents, given known behavior of the labels in the form of text.
● A text corpus related to the document that needs label assignment is available.
● A text corpus related to the labels whose underlying topic needs to be inferred needs to be available,
thereby allowing for-auto assignment of the label to the notification based on the mutual topic assignment.
Example
An example use case is notifications that have rich text data, but are missing failure modes. In this case,
unsupervised topic modeling can be applied to learn latent topics in the notifications. Scoring is then used
on the text corpus related to standard failure modes to infer underlying topics, thereby giving the ability to
assign standard failure mode labels to the topics learned.
For more information, see Unsupervised Topic Modeling Using Latent Dirichlet Allocation for Failure Mode
Assignment [page 385].
Use Case
Before you explore the details of this algorithm, you should first know when to use this algorithm. Supervised
Text Classification applies for the following scenarios:
Example
An example use case would be auto-assigning failure modes to new notifications on the basis of text
classification model learned on historical data. If notifications that have rich text data, have been assigned
failure modes either using automated techniques using NLP or manually via hand labeling, a text
classification model can be learned. New notifications are auto-assigned failure modes based on the text
classification models learned.
For more information, see Failure Mode Analytics with Supervised TextClassEnsemble [page 386].
This algorithm uses Latent Dirichlet Allocation, which is a generative probabilistic method for modeling a
corpus. Corpus here could be text from notifications. Latent Dirichlet Allocation assigns topics to documents
and generates topic distributions over words given a collection of texts, thus providing a way of automatically
discovering topics those documents contain.
The LDA model is a Bayesian mixture model for discrete data where topics are assumed to be uncorrelated.
LDA assumes that each document can be represented as a probabilistic distribution over latent topics, and that
topic distribution in all documents share a common Dirichlet prior. Each latent topic in the LDA model is also
represented as a probabilistic distribution over words and the word distributions of topics share a common
Dirichlet prior as well.
The algorithm fits a topic model to the input text data. For this, text data that makes up the corpus is specified.
Training a model extracts the latent topics given a set of documents (notification texts).
Likewise, scoring would essentially be to infer underlying topics that explain a specific document based on the
generative process which was used to train the model; basically infer the conditional distribution (posterior) of
the hidden variables given the observed variables.
Model Configuration
To configure a model for failure mode analytics, use the Failure Mode Analytics Model Management application.
For more information, see Managing Models for Failure Mode Analytics [page 379].
The algorithm takes text data as an input. Thus, each row of text must belong to a homogenous set, which
might have several latent categories.
Example
Model training for LDA means using the provided historical training text data to learn a topic model for failure
mode assignment.
The aim is to find a model that well represents the data set used for training. Internally, this algorithm splits the
data into a train and test set, using 90% of the data for the training. After a training, a quality metric calculated
on the test set is displayed in the Log Summary in the Trainings table. For more information, see Model
Summary [page 392].
To train a model for failure mode analytics, use the Failure Mode Analytics Model Management application. For
more information, see Managing Models for Failure Mode Analytics [page 379].
Model Scoring
To score a model for failure mode analytics, use the Failure Mode Analytics Model Management application. For
more information, see Managing Models for Failure Mode Analytics [page 379].
This algorithm conducts automatic supervised classification on text data using ensemble agreement between
multiple classification algorithms that makes a prediction concerning the label/class given a document. The
train function uses an ensemble of three algorithms: random forest, cart, and knn to generate a consensus on
assigning categories to documents.
Scoring makes predictions from the fitted ensemble model to predict the class (label) of new documents.
Model Configuration
To configure a model for failure mode analytics, use the Failure Mode Analytics Model Management application.
For more information, see Managing Models for Failure Mode Analytics [page 379].
The algorithm takes text records that are classified as an input. Thus, each row is expected to have text data
represented as a document that must have a class or label associated with it.
Model Training
To train a model for failure mode analytics, use the Failure Mode Analytics Model Management application. For
more information, see Managing Models for Failure Mode Analytics [page 379].
Model Scoring
To score a model for failure mode analytics, use the Failure Mode Analytics Model Management application. For
more information, see Managing Models for Failure Mode Analytics [page 379].
Depending on the algorithm that you have selected, different parameters are displayed. The following sections
provide you with an overview of the parameters with their descriptions and default values, sorted by the
algorithms:
Parameter Description
Note
To enter own stopwords, you can use the following char
acters:
Tip
If you already have a list of stopwords and you want to
add them in one move, perform the following steps: ei
ther use a text editor and put each word on a separate
line separated by paragraphs, or use a spreadsheet ap
plication and put each word in a column of cells. Then,
use the clipboard function and copy all words, and paste
them into the Values field of the stopwords parameter.
best If TRUE, only the model with the maximum (posterior) likeli
hood is returned
Example
You enter the value 2. The Document Term Matrix then
contains two word phrases as its entries for terms. Dur
ing the training and scoring, only notifications that con
tain two word phrases, for example, bearing overheating
are analyzed. After the scoring, only results based on
these notifications and the belonging top words are dis
played in the failure mode analytics results.
Parameter Description
Example
You enter the value 2. The Document Term Matrix then
contains two word phrases as its entries for terms. Dur
ing the training and scoring, only notifications that con
tain two word phrases, for example, bearing overheating
are analyzed. After the scoring, only results based on
these notifications and the belonging top words are dis
played in the failure mode analytics results.
This topic describes how to train models for failure mode analytics.
Prerequisites
Note
You start with first training a model of unsupervised learner type, and then a model of supervised learner
type.
Note
After the first successful training of a model, you cannot edit your model configuration any longer or delete
your model. You can only copy the model and adjust the copied model.
Procedure
1. On the SAP Fiori launchpad, go to the Machine Learning Engine group and open the Failure Mode Analytics
Model Management application.
2. From the Models pane, select the model you want to train.
3. To define the time frame of data that is used for training, select a date and time in the New Training From
and To fields by choosing .
Note
For training a supervised model, in addition to the aspects above, select a time frame that is a subset of
the time frame used in the unsupervised model that is referred to in the created supervised model.
The training run starts, showing the status in the Trainings table.
Once the training run is completed, you can see detailed information, a model summary with multiple
metrics, and the training job ID by clicking on the log entries in the Log Summary column. For more
information about the model summary and the metrics, see Model Summary [page 392].
Results
Related Information
After each training of a model, you can view a model summary. This model summary contains multiple metrics,
which help you to understand the trained model better and evaluate and compare the quality of different
trained models.
Background Information
When you train a model, metrics containing multiple numeric measurements are calculated. These metrics are
calculated based on dedicated test data. This means, a test set, representing 10% of the training data is
automatically split from the data, and is excluded from the training. The numeric measurements are calculated
by using the test set to compare the model predictions with the actual outcomes of the test data after the
training.
Depending on the algorithm that you have selected for the model training, different numeric measurements are
displayed. The following tables provide you with an overview of the metrics with their descriptions, and show
the algorithm to which they apply:
Accuracy This metric displays the overall fraction Supervised Text Classification Using
Ensemble Techniques
of the correctly classified data.
Note
This metric can be misleading for
highly imbalanced data sets.
Kappa This metric adjusts the accuracy based Supervised Text Classification Using
Ensemble Techniques
on the expected accuracy provided by
the class distribution.
Recall This metric displays the fraction of cor Supervised Text Classification Using
Ensemble Techniques
rectly classified positive cases.
Precision This metric displays the fraction of cor Supervised Text Classification Using
Ensemble Techniques
rectly classified negative cases.
F1 Score This metric is a measure that combines Supervised Text Classification Using
precision and recall and is the harmonic Ensemble Techniques
mean between precision and recall.
Perplexity This metric indicates how well a proba Unsupervised Topic Modeling Using La
tent Dirichlet Allocation
bility model predicts a sample and is
used by the convention in language
modeling.
This topic describes how to score models for failure mode analytics.
Prerequisites
Once you have trained a supervised model, you can score the latest trained model to score data.
Note
Procedure
1. On the SAP Fiori launchpad, go to the Machine Learning Engine group and open the Failure Mode Analytics
Model Management application.
2. To score a model, you can choose between the following options:
○ Set up a regular scoring for the model. For more information, see Scheduling Regular Scoring of a
Model [page 395].
○ Set up a manual scoring for the model. For manual scoring, proceed as described in the following
steps:
3. From the Models pane, select the model you want to score.
4. To define the time frame of data that is used for scoring, select a date and time in the Score Data From and
To fields by choosing .
5. Choose Start Scoring.
The scoring run starts, showing the status in the Scorings table.
Once the scoring run is completed, you can see detailed information and the scoring job ID by clicking on
the log entries in the Log Summary column.
Results
Next Steps
You can now check the scoring results for failure mode analytics as follows:
● On the equipment or model pages. For more information, see Using Failure Mode Analytics on the
Equipment or Model Pages [page 61].
● In the Failure Modes or Failure Mode Analytics applications. For more information, see Using Failure Mode
Analytics in the Failure Modes Application [page 67] and Using the Failure Mode Analytics Application
[page 68].
This topic describes how to schedule a regular scoring of models used for failure mode analytics.
Prerequisites
Context
In the Failure Mode Analytics Model Management application, you can configure a schedule, update an existing
schedule, and activate or deactivate a schedule for the periodical execution of scoring.
Procedure
1. On the SAP Fiori launchpad, go to the Machine Learning Engine group and open the Failure Mode Analytics
Model Management application.
2. From the Models pane, select the model you want to score.
3. To configure the scoring schedule, choose Set Schedule.
Start Select the start date and time of the scoring schedule.
Recurrence Pattern Define whether the scoring job should run once or fre
quently at certain intervals.
5. Choose OK.
Results
You can later edit or also deactivate the scoring schedule if required.
Related Information
Prerequisites
● Your unsupervised model has been trained successfully once at least. For more information, see Managing
Models for Failure Mode Analytics [page 379].
● The role FMA_VALIDATION_EXPERT is assigned to your user.
Note
If the required role or roles are not assigned to your user, you cannot see the application on the
launchpad. Contact your Identity Management Administrator if the role or roles have not been
assigned to your user yet.
To improve the accuracy of the text analysis that maps topics with top words from notification texts to the most
appropriate failure modes, we recommend you perform validation tasks.
Validation tasks are generated based on a trained unsupervised model and are displayed on the Failure Mode
Analytics Validation application. For each trained unsupervised model, one validation task is generated. The
validation is assumed to be a one-time activity for each training run.
Once you have performed a validation task, you can apply your validation to the next supervised model training
and scoring run in the Failure Mode Analytics Model Management application and check the validation results
for failure mode analytics.
Procedure
1. On the SAP Fiori launchpad, go to the Machine Learning Engine group and open the Failure Mode Analytics
Validation application.
The Validation Tasks table is displayed. The table lists all available tasks.
2. To begin a validation task, choose Start.
The Topics and Failure Mode Assignments table is displayed. The table lists all topics with the most relevant
top words for each failure mode.
3. In the table, check if each topic is assigned to the most relevant failure mode based on the top words of the
topic and your own experience. You can see the top words by clicking on a topic.
Note
4. (Relevant only if there is a more relevant failure mode): Reassign the topic to a different failure mode by
using the failure mode selection dialog.
Note
If you change the failure mode, the relevance score changes to reflect the new relevance of the topic to
the failure mode.
If you change the failure mode, the relevance score is replaced with N/A and a new training is required
to generate a new score.
Note
The task is completed and removed from the Validation Tasks table and the Failure Mode Analytics
Validation application.
A new validated model is displayed on the Failure Mode Analytics Model Management application.
10. To apply the validation, go to the Machine Learning Engine group and open the Failure Mode Analytics
Model Management application.
11. Configure a supervised model based on the unsupervised model that you validated, train, and score it. For
more information, see Managing Models for Failure Mode Analytics [page 379].
Results
For the chosen equipment model, the validation results are applied.
Next Steps
You can now check the validation results for failure mode analytics as follows:
● On the equipment or model pages. For more information, see Using Failure Mode Analytics on the
Equipment or Model Pages [page 61].
● In the Failure Modes or Failure Mode Analytics applications. For more information, see Using Failure Mode
Analytics in the Failure Modes Application [page 67] and Using the Failure Mode Analytics Application
[page 68].
Related Information
Prerequisites
The role DataScienceUser or the roles DataScienceRead and DataScienceWrite are assigned to your
user.
Note
If the required role or roles are not assigned to your user, you cannot see the application on the launchpad.
Contact your Identity Management Administrator if the role or roles have not been assigned to your user
yet.
Context
To view and analyze the leading indicators that have the highest influence on failures for your equipment and
equipment models, you need to determine the leading indicators by configuring and training models in the
Leading Indicators Model Management application.
In this process, you configure a model based on the equipment model and optionally failure mode for which
you later want to view and analyze the leading indicators. You can do this either for a one piece of equipment or
all equipment of the equipment model. You then train the model.
Procedure
1. To train a model, you first need to configure a model. For more information, see Configuring a Model [page
400].
2. Once you have configured a model, you can train it. For more information, see Training a Model [page 403].
Context
Note
Once you have configured a model, you can only edit the name and the description of the model. If you
delete a configured model, the used data set of the model is deleted if the data set is not used in other
models.
Procedure
1. On the SAP Fiori launchpad, go to the Machine Learning Engine group and open the Leading Indicators
Model Management application.
2. To configure a model, you can choose between the following options:
○ Configure a new model based on an existing model: Select the base configuration and choose Copy.
The new configuration contains all settings of the copied configuration.
Results
Related Information
Data Set - Select the data set that you want to use
to train the model. You can choose be
tween the following options:
Note
The included indicator values are
within the retention period. The re
tention period is maintained for the
SAP Internet of Things store and
can have a maximum range of 5
years. For more information, see
Create Retention Period for Time
Series Data Store.
Note
This field is visible only when you
have selected the option to gener
ate a data set.
Note
If you want to include a specific fail
ure mode, select a failure mode in
the field below. If you don't want to
select a specific failure mode and
determine the leading indicators
for all failures that occurred in the
past, choose Generate Data Set to
generate the data set. The gener
ated data set is then displayed in
the Training Input field.
Note
This field is visible only when you
have selected the option to gener
ate a data set.
Note
Once you have selected a failure
mode, choose Generate Data Set to
generate the data set. The gener
ated data set is then displayed in
the Training Input field.
Prerequisites
Context
For more information about the algorithm that is used for the model training, see Decision Tree .
Note
Once you have trained a model and you delete the trained model, the used data set of the model is deleted
in case the data set is not used in other models and the leading indicators with their conditions on the
Procedure
1. On the SAP Fiori launchpad, go to the Machine Learning Engine group and open the Leading Indicators
Model Management application.
2. From the Models pane, select the model that you want to train.
3. To define the time frame of data that is used for training, select a date and time in the New Training From
and To fields by choosing .
4. Choose Start Training.
The training run starts, showing the status in the Trainings table.
Once the training run is completed, you can see detailed information and the training job ID by clicking on
the log entries in the Log Summary column.
Results
Next Steps
You can now view and analyze the leading indicators as follows:
● On the equipment page for one piece of the equipment of the equipment model. For more information, see
Viewing and Analyzing Leading Indicators for Equipment [page 127].
● On the models page for all your equipment of the equipment model. For more information, see Viewing and
Analyzing Leading Indicators for a Model [page 146].
Related Information
Failure curve analytics lets you view the age at which your equipment may fail within an age range and the
likeliness of the failure by using a failure curve with different insights. This helps you detect potential failure
risks early and plan actions to prevent failures.
The failure curve with the different insights is calculated per failure mode for a group of equipment (fleet group)
with similar operating conditions. You can view the failure curve and the insights for each piece of equipment of
the group. The insights include the following:
You can view the PoF and the confidence interval for any age within the age range.
The following graphic shows an example of a failure curve with the insights:
Rose, a reliability engineer, spots a problematic piece of equipment, pump-0054. She lets the system
calculate the failure curve and reviews the failure curve for the failure mode OHE (Overheating). On the
failure curve, she sees that the piece of equipment has a current age of 43 days and that the probability of
failure for this age is 80%. Above the failure curve, she sees that the predicted time to failure is less than 15
days. To prevent the failure from occurring, she creates a maintainance request to get the pump repaired.
For calculating the failure curve and the insights, machine learning is used. In that process, model
configurations are trained and scored using a Weibull distribution algorithm. The model configuration contains
different input data that is used by the algorithm to produce outputs (results). You can have multiple model
configurations with similar or different input data.
The input data is separated into configuration parameters and data sets.
Configuration Parameters
First, you enter the configuration parameters of the model configuration. Besides the ID and the description of
the model configuration, you select the following parameters:
● Fleet Group: The fleet group defines the group of equipment. You can either use an existing fleet group or
create a new group and select the equipment using the fleet builder. The fleet builder includes searching
and filtering. Besides basic filters, for example, the model, you can also add and define additional attributes
as filter. The additional attributes include, for example, the data type.
● Age for the Conditional Probability of Failure: This age is used for calculating the conditional probability of
failure. For example, you enter 100 days as the age and your equipment has a current age of 50 days, then
the conditional probability of failure is calculated for the age of 100 days given that the equipment has not
failed until the age of 50 days. If you leave the field empty, then the probability of failure is calculated.
● Whether the Installation Date is Maintained and Reliable: If your installation dates are maintained and
reliable, they are used to calculate the age of the equipment at its first failure. If your installation dates are
not maintained or reliable, the first malfunction end date is used to calculate the age of the equipment at
its next failure. For equipment that has failed or been replaced, the date of the replacement is used as the
installation date and the age is set to 0.
● Whether the Equipment is Repairable: If your equipment is repairable, it is restored to a "like-new" condition
and set to the age of 0 once it has been repaired. This age is then used to calculate the age of the
equipment at its next failure. If your equipment is not repairable, the installation dates are used to calculate
the age of the equipment at its failure.
Data Sets
Based on the selection, the system collects the notifications and failure modes for the fleet group that you can
adapt according to your needs:
Note
If a breakdown notification has no failure mode assigned, the notification will only be used by the
algorithm to calculate the time the equipment was down and is otherwise not taken into account.
● Failure Modes: The failure modes are collected from the equipment or the equipment models they belong
to. For each failure mode, the number of breakdown notifications is displayed. You can keep the failure
modes or remove failure modes and add them back. With the failure modes, you can filter the breakdown
notifications so that the results are only calculated for certain failure modes. To get meaningful results, you
should select at least one failure mode.
Note
The algorithm will only use the failure modes for which breakdown notifications exist.
● Equipment: The equipment is used from the selected fleet group or a new fleet group. You can keep the
selection of equipment or add equipment using the fleet builder and remove equipment.
During the training of the model configuration, the Weibull distribution algorithm uses the breakdown
notifications and failure modes together with the information of the first installation date and equipment
repairability to calculate the uptime and downtime of the fleet group. For more information about what is an
uptime and downtime, see the related information link below. The uptimes and downtimes are then used to
produce a Weibull model. The Weibull model includes the shape and scale of the failure curve for the fleet
group.
During the scoring of the model configuration, the algorithm uses the output of the training to calculate the
probability of failure and the other insights, for example, the predicted failure date. With this, the calculation of
the final curve and the insights is complete for the fleet group and the failure modes.
The following graphic illustrates how the input data is used during the training and scoring and what outputs
are produced:
Note
If you edit the reccurence or turn it off, the insights on the failure curve are not updated by default anymore
on a daily basis.
You can also edit the input data of the model configuration after the training and scoring again. In this case, you
need to repeat the training and scoring of the model configuration so that the failure curve and the insights are
updated.
● Inactive: The model configuration has been created, but not yet trained and scored.
● Review: The model configuration has been created and trained successfully at least once, but not yet
scored.
● Active: The model configuration has been trained and scored successfully at least once.
Besides the main statuses, a model configuration can also be in any of the following statuses:
● Collecting Data: The model configuration has been created and the system is collecting the equipment
together with the failure modes and notifications of the equipment.
● Collection Failed: The collection of the failure modes failed because of a technical error. In this case, you
should delete the model configuration and create a new one again. If the issue persists, you need to create
a support ticket.
● Pending: A training or scoring run for the model configuration is in progress.
You can delete a model configuration as long as no training has been started for the model configuration or the
model configuration has not been trained successfully. After the first successful training, you can only copy the
model configuration.
Related Tasks
Related Information
This topic provides you with an overview of all steps for managing model configurations for failure curve
analytics.
Prerequisites
Procedure
1. Create a model configuration. For more information, see Creating a Model Configuration [page 410].
Remember
If you need to delete the model configuration, consider that you can only delete the model
configuration as long as no training has been started for the model configuration or the model
configuration has not been trained successfully. For more information, see Deleting a Model
Configuration [page 417].
2. Train and score the model configuration. For more information, see Training and Scoring a Model
Configuration [page 413].
The workflow has been completed and the results for failure curve analytics are calculated.
You can always repeat the training and scoring to produce latest results. You can also edit the model
configuration after the scoring again and retrain and rescore the model configuration. For more information
about editing a model configuration, see Editing a Model Configuration [page 415] .
Next Steps
You can now view the failure curve with the different insights for your equipment. For more information, see
Viewing a Failure Curve for Equipment [page 130].
Related Information
Prerequisites
● You have created failure modes and assigned the failure modes to the relevant equipment or equipment
models that you want to use for failure curve analytics. For more information, see Creating a Failure Mode
[page 177] and Assigning Failure Modes to Business Objects [page 184].
● The notifications for your equipment meet all of the following requirements:
○ The breakdown attribute of the notification is set to True or the notificationTypeDescription
attribute is set to Breakdown.
○ The notification has a valid malfunction start and end date.
○ The notifications have a failure mode assigned.
For more information about all these attributes and how to view and create a notification, see Viewing and
Creating Equipment Notifications [page 123] and Notifications.
1. On the SAP Fiori launchpad, open the Failure Curve Analytics Model Configuration Management application.
The Model Configurations screen is displayed. The screen lists all created model configurations with further
information, for example, the status.
2. To create a model configuration, choose between the following options:
○ Create a new configuration based on an existing configuration: Select an existing configuration and
choose Copy. The new model configuration contains all settings of the base configuration.
○ Create a new configuration from scratch: Choose New.
Note
You can use the following characters:
○ Uppercase and lowercase letters from a to z
○ Numbers from 0 to 9
○ Most of the special characters
○ Spaces in combination with the other characters
Fleet Group Select the group of equipment (fleet group). You can
choose from the following options:
Note
Consider the following:
○ When you create a new group, do not
include equipment that was sold or shared
before the 2011 release. Otherwise, the
creation of the group may not work.
○ We recommend to only include equipment
used in similar operating conditions.
Age for Conditional Probability of Failure Enter an age for the conditional probability or leave the
field empty.
Installation Date is Maintained and Reliable Select whether the installation date for the group of
equipment is maintained or not.
Note
If you have non-repairable equipment and a piece of
equipment has been replaced by a new one, ensure
that you add the new piece of equipment to the fleet
group.
4. Choose Save.
The model configuration is created and you are forwarded to the details screen of the configuration where
you can refine the data sets to complete the model configuration.
5. On the details screen, choose Input Data Sets Notification Data Ranges to view the notification date
ranges:
a. To edit the suggested date range, select the range and choose Edit.
b. To define an additional date range, choose Add, select the date and time and save it.
c. To remove a date range, select the range and choose Delete.
6. To view the failure modes, choose Input Data Sets Failure Modes :
All failure modes of the equipment or equipment models are displayed in the list. That means you can only
add a failure mode after you have excluded that failure mode.
Note
It can take a short while to collect all failure modes. During this time, the failure modes table will be
empty and the respective status for the collection is displayed. Once all failure modes are collected, the
status changes again and the failure modes are displayed in the table. For more information about the
statuses, see Failure Curve Analytics Model Configuration Management [page 405].
a. To exclude failure modes from the analysis, select the failure mode or modes and choose Remove.
b. To include additional failure modes in the analysis, choose Add and select the desired failure mode or
modes.
7. To view the equipment of the fleet group, choose Input Data Sets Equipment :
Note
a. To include additional equipment in the analysis, choose Add and select the desired equipment. You can
choose any equipment.
b. To exclude equipment from the analysis, select the equipment and choose Remove.
Results
Per default, all created model configurations are sorted in descending order by the latest training date. You can
sort the model configurations in a different way or search for created model configuration. To sort the model
configurations, choose (Sort). You can later reset the sorting again to the default criteria. To search for a
model configuration, enter the first characters of the name in the search field.
Related Information
Prerequisites
Procedure
1. (Only relevant if the details screen of the model configuration is not displayed yet): Navigate to the
details screen:
a. On the SAP Fiori launchpad, open the Failure Curve Analytics Model Configuration Management
application.
b. Choose the model configuration that you want to train and score.
The training run starts showing the status In Progress at the top of the screen, and the logs for the training
run are being created. The status and the logs refresh every 5 seconds.
3. To view the logs and further details, choose Trainings.
Tip
If you just want to view the status without further details and the logs, you can also go back to the
Model Configurations screen and choose (Refresh). Every time you choose the button, the status
and all other data are refreshed, except for the equipment count.
The logs are displayed in the Last Training Run Logs table. For more information about logs, see Logs [page
415].
Further details, for example, the date range are displayed in the Training Runs table.
Once the training run has finished, the status changes to (Completed) or (Failed).
If the training run has failed, you need to analyze the logs and then start the training and scoring again. If
the training run has been completed, the scoring run automatically starts showing the status (In
Progress) and the logs for the scoring run are being created. The status and the logs refresh every 5
seconds.
4. To view the logs and further details, choose Scorings.
The logs are displayed in the Last Scoring Run Logs table. For more information about logs, see Logs [page
415].
Further details, for example, the date range are displayed in the Scoring Runs table.
Once the scoring run has finished, the status changes to (Completed) or (Failed).
If the scoring run has failed, you need to analyze the logs and then start the training and scoring again.
Results
The model configuration is trained and scored. The scoring repeats based on the recurrence.
You can later edit the scoring date range or the recurrence by choosing Scorings and then Edit under Scoring
Date Range. To turn the recurrence off, set the value of the recurrence to 0.
If you have multiple training and scoring runs for your model configuration and you want to view the logs or
details about a specific run, choose the respective run in the Training Run or Scoring Run tables.
Related Information
During a training or scoring run, different log entries are created. The log entries are always displayed for the
currently running training or scoring run or the last training or scoring run.
Log Entry
A log entry provides you with information about the steps that are executed during a training and scoring run
and whether a step has been completed successfully or not.
Depending on whether a step has been completed succesfully or not, different types are displayed:
● Information
This type is displayed if a step has been completed successfully, for example, all data has been collected
and processed successfully.
● Warning
This type is displayed if a step has been completed with an exception, for example, if some data has been
excluded or if the conditional probability could not be calculated for all equipment.
● Error
This type is displayed if a step has failed, for example, if the data could not be collected. If an error is
displayed, the training or scoring run fails.
The correllation ID is displayed for any type and can be used to create a support ticket, for example, for errors
where further clarification is required.
Prerequisites
You have created a model configuration or trained and scored the model configuration.
1. (Only relevant if the application is not open yet): On the SAP Fiori launchpad, open the Failure Curve
Analytics Model Configuration Management application.
4. To edit the notification date range, choose Input Data Sets Notification Data Ranges :
a. To edit the suggested date range, select the range and choose Edit.
b. To define an additional date range, choose Add, select the date and time and save it.
c. To remove a date range, select the range and choose Delete.
5. To edit the failure modes, choose Input Data Sets Failure Modes :
All failure modes of the equipment or equipment models are displayed in the list. That means you can only
add a failure mode after you have excluded that failure mode.
Note
It can take a short while to collect all failure modes. During this time, the failure modes table will be
empty and the respective status for the collection is displayed. Once all failure modes are collected, the
status changes again and the failure modes are displayed in the table. For more information about the
statuses, see Failure Curve Analytics Model Configuration Management [page 405].
a. To exclude failure modes from the analysis, select the failure mode or modes and choose Remove.
b. To include additional failure modes in the analysis, choose Add and select the desired failure mode or
modes.
6. To edit the equipment of the fleet group, choose Input Data Sets Equipment :
Note
a. To include additional equipment in the analysis, choose Add and select the desired equipment. You can
choose any equipment.
b. To exclude equipment from the analysis, select the equipment and choose Remove.
Related Information
Prerequisites
Remember
You can only delete the model configuration as long as no training has been started for the model
configuration or the model configuration has not been trained successfully.
Procedure
1. To delete a model configuration, you can choose between the following options:
○ Delete a single model configuration directly on the details screen: Choose Delete and confirm the
displayed dialog box.
○ Delete a single or multiple model configurations on the Model Configurations screen: Proceed as
described in the steps below:
2. (Only relevant if the application is not open yet): On the SAP Fiori launchpad, open the Failure Curve
Analytics Model Configuration Management application.
Related Information
The tiles under Administration on the SAP Fiori launchpad give you access to the various administration
functions.
Tile Use
Company Profile [page 419] Create/display a company profile. You can add locations of
your organization, subsidiaries and specify industry IDs.
Application Settings [page 430] Execute configuration tasks for roles and users and config-
ure the Explorer and analysis tools.
User Authorizations [page 438] Define a more granular user authorizations to access SAP
Predictive Asset Insights.
Data Protection and Privacy (DPP) [page 446] View details regarding your personal data like e-mail ad
dress, first name, last name, and user ID and the objects that
you have created or modified.
As an organization administrator, you can edit your organization’s company profile, add locations of your
organization, add subsidiaries and maintain Industry IDs of your organization in SAP Predictive Asset Insights.
You can search for organizations using the industry member names. You can also create locations, contact
persons and industry ID's for a subsidiary.
Prerequisites
Your organization and the users of your organization are successfully registered with SAP Predictive Asset
Insights and you have received the necessary information to logon to the SAP Predictive Asset Insights and use
the applications of SAP Predictive Asset Insights .
Context
You use the Company Profile application to work with the company profile of your organization.
Prerequisites
Procedure
Field Description
Street/Number Enter the street and house number information for your
location.
Postal Code/City Enter the postal code and city information for your loca
tion.
2. For Contact Person Details, enter the values for the fields as described in the table below:
Note
If you want to use the primary contact person details of your base location, select the checkbox
Reuse Primary Contact Person Details.
Field Description
Note
The information you enter for your contact person will be visible for other companies when they are
viewing your company profile.
Therefore, make sure that your contact person is aware of this system behavior, and you only enter a
contact person whose tasks include to represent your company location to external business partners.
If you change a contact person, the previously entered contact person data gets overwritten with the
new contact person information and cannot be restored.
5. Choose Save.
Prerequisites
● You have at least one location of your organization in SAP Predictive Asset Insights.
● Your user ID has the roles COMPANYPROFILE_DELETE, COMPANYPROFILE_EDIT assigned.
For more information, see Roles.
Procedure
Prerequisites
● You have at least one location of your organization in SAP Predictive Asset Insights.
● Your user ID has the role COMPANYPROFILE_DELETE assigned.
For more information, see Roles.
Procedure
You perform this procedure to add your subsidiary company details to the network.
Prerequisites
Procedure
Field Description
Street/Number Enter the street and house number information for the
subsidiary
Postal Code Enter the postal code information for the subsidiary
Web Site (*) Enter the URL of the subsidiary Web site
Note
Yes/No is a toggle button. If Yes, specify the date
you acquired the subsidiary company.
Contact Person Details Enter the contact person title, first name, last name,
phone number, and e-mail address
2. For Contact Person Details enter the values for the fields as described in the table below:
Note
The information you enter for subsidiary contact person will be visible for other companies when
they are viewing the subsidiary information in your company profile.
Therefore, make sure that your subsidiary organization is aware of this, and you only enter a
subsidiary contact person whose tasks include to represent the subsidiary externally.
If you change a subsidiary contact person, the previously entered subsidiary contact person data
gets overwritten with the new subsidiary contact person information and cannot be restored.
Field Desccription
First Name Enter the first name of the subsidiary contact person
Last Name Enter the last name of the subsidiary contact person
Phone Number Enter the phone number of the subsidiary contact per
son
Email Address Enter the Email address of the subsidiary contact per
son
5. Choose Save.
Results
The subsidiary company, as a separate entity, cannot create or access business objects in the network.
Note
You can also create locations and industry IDs for subsidiaries. To do so, open the subsidiary and choose
Locations or Industry IDs to maintain the respective information.
Prerequisites
Procedure
Choose Industry IDs to view or search for member IDs or member name as SAP Asset Intelligence Network
account has in a specific industry group.
You perform this activity to maintain the unique reference number (for example, a vendor ID, a manufacturer
ID) your company has with a standard organization that issues such unique IDs.
Prerequisites
Procedure
This procedure allows you to maintain the external organizations along with external IDs.
Prerequisites
Procedure
Enter the external organization details like company name, logo, address, roles, country, phone number,
website, and so on.
4. Choose Save.
Results
You can maintain the external IDs for each of these external organizations by selecting the organization and
choosing External IDs. You can add, edit, or delete external IDs here.
Note
● Only you can view your external organizations. No other organizations can see External Organizations
tab when they visit my company profile.
● Premium as well as invitee accounts can now create external organizations within their account. These
external organizations are only visible to the account holder.
● On business object lists and business object details, you can view the name of external organizations
that do not belong to your organization, but you cannot navigate to the details of such a foreign
external organization.
● You can now create more than one external organizations with the same name for a given premium or
invitee in SAP Asset Intelligence Network.
Prerequisites
Procedure
a. In the Edit Company Profile Company Details dialog box, enter the values for the fields as
described in the table below:
Field Description
Web Site (*) Enter the URL of your company Web site
Company Logo Browse for and upload the logo of your company.
Note
The logo will be displayed on the Company Profile,
on the Company Details, as well as on list views/
grid views that show company information.
Note
This short name will be displayed in list/grid views
(for example, in Business Partner app), and value
helps (for example, Manufacturer/Operator/Serv
ice Provider value helps) if it is mainatined.
Roles (*) Select additional roles for your company from the drop
down.
Note
The selected roles will indicate to your business
partners in which roles you participate in SAP
Predictive Asset Insights .
Example:
Street/Number Enter the street and house number information for your
company.
Postal Code/City Enter the postal code and city information for your com
pany
State/Region Enter the state and region information for your com
pany
b. In the Edit Company Profile Primary Contact Person Details dialog box, enter the values for the
fields as described in the table below:
Note
The information you enter for your primary contact person will be visible for other companies when
they are viewing your company profile.
Therefore, make sure that your primary contact person is aware of this system behavior, and you
only enter a primary contact person whose tasks include to represent your company to external
business partners.
Field Description
First Name Enter the first name of your primary contact person
Last Name Enter the last name of your primary contact person
Phone Number Enter the phone number of your primary contact per
son
Email Address Enter the Email address of your primary contact person
3. Choose Save.
To ensure complete documentation for assets such as models, or equipment, an SAP administrator configures
the significance of a document category at the subclass level. As an organization admin, you can set the
preference of the document category at the subclass level.
Prerequisites
Context
The preference set by the organization administrator overrides the preference set by the SAP administrator for
the document category.
Procedure
You must be an organization administrator to perform the activities using Application Settings.
● Users
○ Create user information (see Creating User Details [page 432]).
○ Update user information (see Updating User Details [page 435]).
○ Delete user information (see Deleting User Details [page 435]).
○ Granting Access to Invitee Users in
● External Systems
● Object Types
The object types are used for external systems integration.
To support external object ID mapping, you are provided with a capability to add custom object type, in
case a relevant object type is missing in the standard list using Application Settings Object type
Add .
You can use it later for corresponding External ID mapping in Company Profile app.
● You can add new object types using the Add button.
Note
You will not be able to add a new object type, if the name of object type that you create is the same as
an existing SAP delivered object type. Before you create your own object, please use the External ID API
to check the SAP delivered object types.
Note
Only premium account holders can maintain prefix. The prefix is valid for its invitees as well. Prefix
maintenance section is made noneditable for the invitee administrators.
Note
Retention period for business objects is set by the Premium account only, that is, the
maintained period is also applied to the Premium’s Invitees’ business objects.
Note
○ This feature is applicable only for dev and test tenants and not for production.
○ Tenant data deletion of equipment will not delete equipment data that is synced to IoT
services.
Object page configuration will not be the same for all the users. As each user can override it as a
personalization with the Confgure Sections in the relevant object page, in which case that is given
preference. You can reset the deafult settings configured in the Object Page Configurations for the
user by choosing Configure Sections Reset to Default in the relevant object pages. Please
note that this setting has to be done by individual users and cannot be set by an administrator.
● Extensions
● Header Status
○ You can maintain 2 default indicator names in the header information of all the equipment in your
organization using the Header Status section.
● Explorer and Analysis Tools Configuration
○ Configure the Explorer and analysis tools (see Explorer and Analysis Tools Configuration [page 489]).
The following list provides the list of tasks that an administrator performs:
As an administrator you can add the details of the users of your organization to SAP Predictive Asset Insights.
Prerequisites
By mapping the role collections with the user groups, you ensure that the users you assign to a user
group have the respective set of role templates assigned that allow them to perform their intended
actions in SAP Intelligent Asset Management.
For more information on the trust configuration, refer to the process steps described in Configuring Trust
Configuration.
● Your user ID has the role CONFIGURATION_DELETE, CONFIGURATION_EDIT assigned. For more
information, see Roles and Role Collections.
Procedure
Enter the user ID, first and last name, email address and organization name.
Note
The user IDs you assign depends on the SAP Identity Authorization Service (IAS) configuration
within your subaccount. The NameID format used for SAML authorization decides whether the
user ID has to be the email address or the user ID available in SAP IAS.
Note
Note
The user IDs you assign depends on the Identity Provider configuration within your
subaccount. The NameID format used for SAML authorization decides whether the user ID has
to be the email address or the user ID available in SAP IAS.
You want to add a new user - Jane Doe - as Administrator with additional DPP tasks for your own organization
My Org.
Note
You can flexibly define your role collections based on the delivered role templates for your
subscribed applications.
○ (Under Security Trust Configuration <your default identity provider> Role Collection
Mappings ). You’ve mapped your role collection with your user group:
○ Role Collection: MY_ORG_ADMINS_DPP
○ Attribute: Groups
○ Operator: equals
○ Value: MY_ORG_ADMINS_DPP
○ In the Administration console for Identity Authentication
○ (Under Users & Authorizations Users )
You’ve created a user for Jane Doe (for example, [email protected]).
You’ve assigned the user group = MY_ORG_ADMINS_DPP to Jane Doe’s user.
● In SAP Intelligent Asset Management
○ Choose Application Settings Users Add Add Single User .
Enter the relevant information for Jane Doe:
○ First Name: Jane
○ Last Name: Doe
○ Organization Name: <select your own organization> (for example, My Org)
○ User ID: <select the User ID in the format expected by your identity provider configuration> (for
example, [email protected])
○ Email Address: [email protected]
Result: Jane Doe can access the SAP IAM applications for her company (= My Org) and do her tasks
based on the role collection assigned to her user.
Related Information
https://help.sap.com/viewer/d89bac86aa294f75afdc40dca457dd7b/latest/en-US/
1dea2469d10a4788bb28d91a6b92828a.html
If your organization possesses a premium account, as an administrator you can update the details of the users
of your organization and your supplier organization in SAP Predictive Asset Insights.
Prerequisites
Procedure
You perform this procedure to remove the user from SAP Predictive Asset Insights.
Prerequisites
Procedure
You perform this activity to configure the Instruction ID, Document ID, Announcement ID, Notification ID, and
Work Order ID for your organization. Setting a prefix from the Application Settings app determines the object ID
while you are creating an instruction, document, announcement, notification, and work order from the
respective applications for your organization.
Prerequisites
Procedure
Note
○ This is a one-time activity and you cannot modify or delete the prefix at a later point in time.
○ Only premium account holders can maintain prefix. The prefix is valid for its invitees as well. Prefix
maintenance section is made non-editable for the invitee administrators.
You perform this activity using the Application Settings application to set the document size limit for upload.
This setting determines the document upload size in Documents application.
Prerequisites
Procedure
You perform this activity to display default indicators in the header status of a piece of equipment. You can
maintain 2 default indicator names in the header information of all the equipment in your organization.
Prerequisites
Context
You can have exceptions for the default header status based on the subclass used by a piece of equipment. You
can define a different set of indicators to be displayed for a listed subclass instead of the default using the Class
Configurations.
Note
The indicators are visible in the header information of a piece of equipment only if the indicators are
assigned to the equipment and values are defined for the indicators.
You use this feature to define a more granular access to SAP Predictive Asset Insights business objects for
users within your organization.
Role collections get assigned to one or more nodes in the organization hierarchy. Users who are part of a user
group that is mapped to a role collection (which is assigned to a node in the organizational hierarchy) have
access to:
● The business objects and groups assigned to the relevant node in the hierarchy.
● The business objects and groups assigned to the sub-nodes of a relevant parent node in the organizational
hierarchy.
● The administrator of your organization must be assigned to the root node or parent organizational level
in your organizational hierarchy to have access to all the business objects in your organization.
● The level of authorization for each user is defined under <Privilege>.
● If a role collection is assigned to multiple nodes in the organizational hierarchy, then the privilege
maintained on the highest level is by default inherited to the sub-nodes. If required you can also edit an
inherited privilege on a sub-node.
Prerequisites
The following objects and object relationships have been configured in SAP Identity Services and SAP BTP
cockpit:
Note
Note
All these set-up steps are not specific to User Authorization but should already have been done
during the setting up of roles and onboarding of users to your account.
For more details on these steps, refer to https://help.sap.com/ under Security Guide User
Onboarding Setting up Roles and Onboarding Users .
Process Overview
● Enable User authorization in Application Settings General Application Settings Organizational
Configurations .
● Create an organizational hierarchy for your organization in User Authorization app.
Note
Currently, you can have only one organizational hierarchy for your organization.
● Assign role collections to the nodes in your organizational hierarchy in User Authorization app.
● Assign business objects to the nodes in your organizational hierarchy in User Authorization app. You can
directly assign business objects to the nodes in your organizational hierarchy in User Authorization app,
create a group in Groups app and assign business objects to this group, and then assign the group to a
node in your organizational hierarchy in User Authorization app.
Example
Company B wants to provide a more granular access to business objects for their internal users, so that their
users can only access business objects that are assigned to their area of responsibility. In the example:
Note
The following example is based on a simple country or region structure, but you can flexibly model other
structural elements as well according to your needs.
1. Authorized user at Company B enables user authorization in Application Settings General Application
Settings Organizational Configurations .
2. Authorized user at Company B creates an organizational hierarchy in User Authorization app:
1. Create root node Company B.
2. Create child node Company B Germany .
3. Create 2 child nodes Company B Germany Germany North and Company B Germany
Germany South
4. Create a second child node under the root node Company B Switzerland .
5. Create 2 child nodes Company B Switzerland Switzerland North and Company B
Switzerland Switzerland South
3. Authorized user at Company B assigns role collections to the respective nodes in the organizational
hierarchy:
1. Assign an admin role collection (= role collection to which your admin user group is assigned) to the
root node Company B and provide respective privileges, which the user is to have on the business
objects
Users assigned to the user group which is mapped to the role collection that is assigned to the root
node can access all of the business objects assigned to the child nodes with the maintained privilege.
Note
It is recommended to add at least one admin user as well as substitutes to the admin user group
assigned to the root node to ensure that there is always at least one user in the organization who
has full access to all objects.
2. Assign other role collections to the respective nodes in the organizational structure and provide
respective privileges the users in the associated user group are to have on the business objects.
Role collections can be assigned to one or more nodes in the organizational structure. If a role
collection is assigned to a node, which has further child nodes, the users in the associated user group
can access the business objects assigned to the current node as well as all of the child nodes with the
maintained privilege.
Result: Authorized user of Company B created their organizational hierarchy and assigned role collections.
Once a business object was assigned to a node in the organizational hierarchy, this business object is only
visible to the users assigned to the user groups which are mapped to one or more role collections that are
assigned to the respective node in the organizational hierarchy.
Business objects that are not assigned to the organizational hierarchy, are still accessible to everyone in the
organization.
Example:Equipment 2 was assigned to hierarchy node Company B Germany, so only users who belong to a
user group that is mapped to the role collections assigned to hierarchy node Company B Germany and have
either EQUIPMENT_READ or EQUIPMENT_EDIT or EQUIPMENT_DELETE privileges can now view, edit, or
delete this equipment.
Equipment 10 was not/neither directly assigned to a node in the authorization hierarchy nor belongs to any
group which is assigned to a node in the authorization hierarchy, so all users of Company B with
EQUIPMENT_READ or EQUIPMENT_EDIT or EQUIPMENT_DELETE privileges can view, edit, or delete this
equipment.
Prerequisites
Note
○ Root organization is an organization that does not have any parent organization unit. It is
mandatory for every organization to have parent organization except for root organizations.
○ You can have only one root organization.
○ You cannot maintain duplicate organization entries
Note
Upload CSV can only be used if there is no organizational units created or maintained in the
organization structure.
Results
System creates a node or multiple nodes in the organizational hierarchy to which you can add users, business
objects, and groups.
Context
You perform this activity to assign the relevant business objects to the selected node in the organizational
hierarchy.
Procedure
Select the dependent objects that you want to assign. You can share the following business objects:
○ Models
○ Equipment
○ Functional Locations
○ Announcements
○ Templates
○ Documents
○ Instructions
○ Locations
○ Spare Parts
○ Systems
○ Failure Modes
You can only assign published failure modes to the selected node in the organizational hierarchy.
○ Attributes
○ Attribute Groups
○ Indicators
○ Indicator Groups
○ Code Lists
○ Work Orders
Note
You perform this activity to assign the relevant groups to the selected node in the organizational hierarchy.
Prerequisites
You have created one or more groups in the Groups app. You have assigned the business objects that you want
to use for user authorization to these groups.
Procedure
Note
Context
You perform this activity to delete an existing node from the organizational hierarchy.
Procedure
Context
Note
This topic is only relevant for SAP BTP, Cloud Foundry environment.
You perform this activity to add role collections to the selected node in the organizational hierarchy.
Note
All the assigned role collections have authorizations to access all the business objects and groups
associated with the node in the organizational hierarchy at this level and all the subnodes of this level.
Procedure
Data protection is associated with numerous legal requirements and privacy concerns. In addition to
compliance with general data privacy regulation, it is necessary to consider compliance with industry-specific
legislation in different countries. SAP provides specific features and functions to support compliance with
regards to relevant legal requirements, including data protection.
Introduction
The Data Protection and Privacy (DPP) application can be used by data subjects and data admins. As a data
subject, you can view your own personal data stored in SAP Predictive Asset Insights. A data admin can view
and delete one's own personal data and personal data of any other data subject.
Related Information
The DPP application supports you to be compliant with the Information Report section of Data Privacy and
Protection.
You can view details regarding your personal data like e-mail address, first name, last name, and user ID and
the objects that you have created or modified.
If you have an admin role, then you can view the list of users, their personal data, and the list of objects that
each user has created or modified. If the user is a functional location or company profile contact person, then
you can view their personal data as well as relevant address details.
In SAP Predictive Asset Insights, a user can view the personal data whereas a user with the admin role can
delete or remove own personal data or personal data of any other data subject.
Related Information
You can view a list of jobs triggered for the mass API. The details of the successful and failed request is also
displayed.
You can view a list of successful and failed status for a request.
You can use this feature to check the current or intermediate status of all equipment that is in the process of
being synchronized with SAP Internet of Things.
By default, the logs display the synchronization status of a piece of equipment for the last one hour. The
various synchronization statuses are as below:
● SYNC IN PROGRESS: This status appears when the events are being processed.
● SYNC FAILURE: This status appears for a failed synchronization.
● SYNC COMPLETED: This status appears after the synchronization completes successfully.
SAP Workflow Service lets you build, run, and manage workflows, from simple approvals to end-to-end
processes that span across organizations and apps. With an inbox app and custom-built UIs, you involve end
users into business processes for decision making and data entry. The service comes with web-based tools for
workflow modeling, APIs for consumption in custom apps, monitoring tools, and Fiori-based apps for end-user
access. You can use JavaScript to embed custom business logic.
The asset central foundation app only provides event-based integration with workflows that are modeled using
the SAP Workflow service.
Based on the action that has to be performed in asset central foundation, the relevant events are triggered. For
example, upon publishing a piece of equipment, a workflow can be created for further actions or assessments.
We can configure SAP Workflow Service in asset central foundation based on the following events:
● Equipment:
○ Create
○ Publish
○ Delete
○ Share
● Models:
○ Create
○ Publish
Configuring a Workflow
Prerequisite:
You must have a separate subscription to SAP Workflow to model workflows and use the asset central
foundation workflow application. Refer to SAP Workflow Service .
You can configure theSAP Workflow Service for the asset central foundation by following the steps explained in
this topic:
The workflow instance used to create the destination must include the WORKFLOW_DEFINITION_GET
and WORKFLOW_INSTANCE_START roles. See sample code:
Sample Code
{"authorities": ["WORKFLOW_DEFINITION_GET","WORKFLOW_INSTANCE_START"]}
The workflow_rest_url, clientid, clientsecret, and url are used to configure the destination.
3. Create workflow destination
○ Go to subaccount and create new destination with <name>_workflow.
○ It is of basic authentication and user, password is client id secret we got in previous step.
○ An additional property content-endpoint also needs to be added. The value for the field would be
workflow_rest_url (from step 2)
These are the only configurations required for asset central foundation to access the workflow service.
Configuring Workflow Applications for SAP Intelligent Asset Management Fiori launchpad
Optionally, you can configure the Monitor Workflow apps in the SAP Fiori launchpad. For more information, see
Create Workflow and My Inbox Tiles on SAP Fiori Launchpad.
1. Download the relevant FLP content. Refer to the 'Upgrade Custom FLP Content' in the Update Guide.
2. You can use Create Workflow and My Inbox Tiles on SAP Fiori Launchpad to integrate the workflow
applications in the relevant asset central foundation fiori launchpad that you have downloaded.
3. You have to add a configuration code for workflows apps in CommonDataModel.json under the portal
portal-site file of the relevant product content that you have downloaded.
Use
To automate the process of triggering a workflow (directly from asset central foundation), you can configure
asset central events like publish, delete to initiate the workflow. The workflow is initiated when the event is
performed. The workflow can be modeled to meet various business scenarios.
Note
Only the workflows that are available in the subaccount where you have configured the destination will
be displayed here.
4. Choose Save.
Sample Code
{
"id": "1eccfbd1-057f-4aa6-8ba4-ec63deba7ae1",
"source": "com.sap.dsc.ac.equipment",
"specversion": "1.0-rc1",
"type": "header.update",
"datacontenttype": "application/json",
"time": "1576125244",
"objectid": "C030AA04F27446E2A8710D399A614534",
"objectownerid": "D1080120A941602F16006F0265F15AD4",
"correlationid": "2a6dab34-58d5-48d7-8345-58421d9fa75a",
Field Description
source the relevant business object that the workflow is initiated for
like, equipment, model, and so on.
datacontenttype json
objectid specifies the id of the object for which the workflow is initi
ated
● id:
● source
Result
Wherever the event is performed, the relevant workflow is triggered.
Related Information
https://help.sap.com/viewer/product/WORKFLOW_SERVICE/Cloud/en-US
https://developers.sap.com/group.cp-workflow-cf.html
https://help.sap.com/viewer/e157c391253b4ecd93647bf232d18a83/Cloud/en-US/
60ae81179050478caa4212fad4ba50f2.html
This topic describes the steps to create a sample app and trigger from asset central foundation.
Sample Scenario:
1. Create a workflow application using SAP Web IDE Full-Stack. For more information, see Enablе the
Workflow Editor in SAP Web IDE.
Once the mapping is complete, the event action triggers the workflow, that user can see in its workflow
SAP Fiori launchpad bound to application. The URL of workflow SAP Fiori launchpad is basically the
endpoint of app router URL, which is used while developing workflow app.
3. Launch workflow SAP Fiori launchpad.
You can go to the cockpit or cloud foundry app to view SAP Fiori launchpad app router URL.
4. Publish equipment.
As per the previous configurations, any publish of equipment triggers asset workflow. Based on the API
call, it fetches the data and displays in the inbox to be approved or rejected based on data.
Based on your requirement, you can add any custom logic to the workflow.
Optionally, you can configure the Monitor Workflow apps in the SAP Fiori launchpad. For more information, see
Create Workflow and My Inbox Tiles on SAP Fiori Launchpad.
Context
To configure SAP Predictive Asset Insights, it is recommended to follow the configuration order described in
this chapter.
Procedure
1. Configure the application settings. For more infromation, see Application Settings [page 430]
2. Configure equipment modeling capabilities. For more information, see Equipment Modelling.
3. Create and publish your required equipment. For more information, see Creating a Piece of Equipment
[page 97] and Important Information When Creating Equipment in SAP Predictive Asset Insights.
4. Create alert types for alerts. For more information, see Adding Alert Types [page 285].
5. For the alert type created using step 4, the alerts can be created.
6. Configure data sets and manage models for equipment health indicators.. For more information, see
Configuring Data Sets for Equipment Health Indicators [page 317] and Managing Models for Equipment
Health Indicators [page 324].
7. Configure failure mode analytics. For more information, see Configuring Failure Mode Analytics [page 461].
8. Manage model configurations for failure curve analytics. For more information, see Failure Curve Analytics
Model Configuration Management [page 405].
9. Manage models for leading indicators. For more information, see Managing Models for Leading Indicators
[page 399].
10. Configure the Explorer and analysis tool variants. For more information, see Explorer and Analysis Tools
Configuration [page 489].
11. Perform all required configuration steps to enable the creation of analytics dashboards in SAP Predictive
Asset Insights. For more information, see Enabling Analytics Dashboards [page 468].
Note
● While creating an equipment, the IoT sync button should be set to Yes,by default.
● Once the equipment is published, one external ID is created. The external ID is only created if you are
using SAP-managed data persistence and streaming.
Related Information
Once a piece of equipment is created and published in SAP Predictive Asset Insights, it is synchronized and
objects are created in SAP Internet of Things.
In order that the synchronization works, you need to set up SAP Internet of Things as an external system. For
more information, see Configuring External Systems. If you are an existing customers with an SAP Internet of
Things license, you need to perform additional steps prior to the configuration of the external system. For more
information, see Setting Up SAP Cloud Platform Internet of Things.
While the publishing to SAP Internet of Things, the following points need to be considered:
● Only equipment with model in asset central foundation is synchronized with SAP Internet of Things. This
means that lean equipment will not be synchronized with SAP Internet of Things.
● The equipment create API should have the following properties for the scenarios given below:
○ Both IoT services 4.0 and PdMS sync enabled
○ objectsSync: [{externalSys: "HCP IoT 4.0", status: true}, {externalSys: "PdMS", status: true}]
○ gateWayID: "2"
○ Both IoT services 4.0 and PdMS sync disabled
○ objectsSync: [{externalSys: "HCP IoT 4.0", status: false}, {externalSys: "PdMS", status: false}]
○ gateWayID: "2"
○ Only IoT services 4.0 sync is enabled
○ objectsSync: [{externalSys: "HCP IoT 4.0", status: true}]
○ gateWayID: "2"
○ Only PdMS sync is enabled
○ objectsSync: [{externalSys: "HCP IoT 4.0", status: false}, {externalSys: "PdMS", status: true}]
○ gateWayID: null
● For every equipment a device is created. The device will be associated with capabilities corresponding to
indicator groups, the indicators coming from both model templates and equipment templates in SAP
Predictive Asset Insights.
● When you have created a piece of equipment based on a template in SAP Predictive Asset Insights, for
every template a sensor type is created.
● To support update of capabilities with the new properties from asset central foundation, default
capabilities, for example, IG_EDGE_CONFIG and MachineAlarmPST are created inside a sensor type. The
Note
If umlauts or special characters are used in indicators or indicator groups, the indicators and indicator
groups are still considered while the synchronization to SAP Internet of Things, but with the object IDs as
the names. The object IDs have the prefix I_ for indicators and the prefix IG_ for indicator groups.
The following graphic displays the mapping between objects and the corresponding naming conventions for
SAP Predictive Asset Insights:
On the SAP Fiori launchpad under Master Data you can find all the functions you need to create equipment and
its associated data.
To create equipment, you use a model template to create a model and assign the model to the equipment.
These prerequisites are described below. For information about creating equipment, see Creating a Piece of
Equipment .
Note
Once you have created your equipment do not forget to publish it.
● Create a model template. A model template is used to define metadata for a model. It inherits a subclass
template or other model template and has additional attribute groups and attributes. For information
about creating a model template, see Creating a Model Template [page 290]. For more general information
about templates, see Managing Templates [page 264].
● Create a model. A model is an abstract representation from the manufacturer that defines all maintenance
and specification information related to a new or existing product. A physical equipment is an instance of a
model.
A model is based on a model template and allows users to add values to the definitions used in the
underlying template. For information about creating a model see Creating a Model [page 133]. To add
model components, refer to Adding Model Components [page 141]. For more general information, see
Managing Models [page 132].
Related Information
Alerts can also be created by alarms raised by machine. The configuration for the machine alarms mapping
details allow the machine to send alerts. In a scenario where validation is required with alarms to raise an alert,
a trigger based rule must be defined.
Procedure
1. Define alert type for error codes: Navigate to Templates → Alert Types → New. The origin should be
Machine. You can also define the deduplication configuration to reduce the duplication of similar alerts. For
more information, refer Adding Alert Types [page 285]
2. Define alert type groups for the alert type created. For more information, refer Adding Alert Type Groups
[page 288]
3. Assign the alert type group to the model, which in turn will assign all alert types to the model and available
for equipment derived from model. For more information, refer Assigning Alert Type Groups to a Model
[page 144]
4. Create configuration file for the equipment, that have configured required to setup a specific connector
instance.
5. You can also define a rule if any other condition need to be checked during alert generation from the
equipment alarm. In such a scenario, you can define a trigger based alarrm using the Rules creation page.
Add a condition that will be validated before creating the alert. For more information, refer Creating Rules
[page 309]
Alerts
Creating Rules [page 309]
Prerequisites
● You have created an equipment model with equipment and assigned the equipment model to the
equipment. For more information, see Creating Equipment [page 459].
● You have created failure modes and assigned the failure modes to the equipment model or the piece of
equipment for which you want to analyze the patterns of failures. For more information, see Creating a
Failure Mode [page 177] and Assigning Failure Modes to Business Objects [page 184].
Note
Make sure that the failure modes are in the same language as the language that you configure in step 2.
Context
Procedure
1. (Optional): Configure the periodical calculation for the mean time global indicators and define the included
failures. By default, the periodical calculation is enabled for critical failures. For more information, see Mean
Time Indicators Configuration [page 462].
2. Configure the language in which the notifications are later displayed in the failure mode analytics results.
You can choose between different options. For more information, see Notification Language Configuration
[page 464].
3. Configure, train, and score a failure mode analytics model. For more information, see Managing Models for
Failure Mode Analytics [page 379].
To improve the accuracy of the text analysis that maps topics with top words from notification texts to
the most appropriate failure modes, we recommend you perform validation tasks. For more
information, see Validating Failure Mode Analytics [page 396].
Related Information
The configuration for the mean time indicators is useful for making better maintenance planning decisions.
With the mean time indicators configuration, the global indicators Mean Time To Repair (MTTR), Mean Time To
Failure (MTTF), and Mean Time Between Failures (MTBF) are calculated every month based on historical data
for your equipment model. In addition, you can also define for which failure mode types the mean time global
indicators are calculated. By default, the periodical calculation is enabled for all critical failures. For more
information about the global indicators, see Global Indicators [page 281].
Note
The mean time indicators configuration is only valid for the global indicators of the equipment model. It is
independent from the mean time KPIs calculation for the failure modes. For more information about the
calculation for the failure modes, see Calculation of Mean Time KPIs [page 63].
For the calculation, all your notifications are collected, extracted, and the failure modes are assigned based on
your machine learning inputs. For each failure mode, the indicator value is then calculated. For the global
indicators values for the equipment model, the calculated indicator values are then aggregated and determined
as follows:
● For MTTF and MTBR, the indicator values are aggregated for the failure modes and the minimum value is
taken as the global indicator value.
● For MTTR, the indicator values are aggregated for the failure modes and the maximum value is taken as the
global indicator value.
If you have defined that you only include certain failure mode types, then only the indicator values for all the
selected types are aggregated.
Once the calculation is complete, you can view the indicator values on the INDICATOR tab on the model object
page. The values are updated after each scoring of your failure mode analytics model. For more information
about the scoring, see step 3 in the topic Configuring Failure Mode Analytics.
For more information about configuring the mean time global indicators, see Configuring the Mean Time
Indicators [page 463].
This topic describes how to configure the mean time indicators for failure mode analytics.
Prerequisites
● You have created and assigned the relevant business objects. For more information, see Configuring Failure
Mode Analytics [page 461] and check the prerequisites.
● You have added and instantiated the global indicators for the desired equipment model or piece of
equipment. For more information, see Adding Indicator Groups and Indicators [page 273].
● The role ConfigUser is assigned to your user.
Procedure
1. On the SAP Fiori launchpad, go to the Administration group and open the Application Settings application.
2. To configure the mean time global indicators, choose (Failure Mode Analytics).
Remember
If you no longer need the periodical calculation, you
can later disable it. The calculation is then disabled
and the latest indicator values on the model object
page are not updated.
Failure Mode Types Select the failure mode types for which the mean time
KPIs are calculated. You can choose from the following
types:
○ Type 1 - Design function is not obtained
○ Type 2 - Specified function lost or outside acceptable
limit
Results
You can later edit your configuration. Once you have edited the configuration, you need to repeat the scoring of
your failure mode analytics model as mentioned in step 3 in the topic Configuring Failure Mode Analytics to
apply your changes.
Related Information
By default, when you run a failure mode analysis, only English is supported for all your notifications and the
notifications are not translated in the failure mode analytics results. With the notification language
configuration, you can define the language in which the notifications are later displayed in the results by doing
the following, regardless of your current system language:
Note
Language Selection
The language selection is useful if all your notifications are in English or all your notifications are in German.
With the language selection, all your notifications for the selected language are collected and extracted based
on your machine learning inputs during the failure mode analysis. Once the analysis is complete, the extracted
notifications are then displayed as the top words and related notifications in the selected language in the failure
mode analytics results.
Language Translation
The language translation is useful if your notifications are in multiple languages or are in the same language,
which is not however English or German, for example, Italian. With the language translation, all your
notifications are collected and translated into the configured language. The translation is performed using your
own key from the Google Cloud translation service. The translated notifications are then extracted during the
failure mode analysis based on your machine learning inputs. Once the analysis is complete, the extracted
notifications are displayed as the top words and related notifications in the translated language in the results.
Caution
The translation feature for failure mode analytics is an optional feature and is based on Bring Your Own
Account (BYOA). That means that you must have a private account with Google for translation services,
and you must have your own Google API key. You alone are responsible for all required contracts with
Google, including important aspects such as privacy data (especially customer data transferred to Google
servers or other third party servers), costs for translation services, and so on.
SAP is under no obligation to provide this feature now or in the future. The feature may be enhanced or
discontinued at any time, without notice.
For more information about configuring the language translation, see Configuring a Notification Language
Translation [page 466].
Related Information
This topic describes how to select the notification language for failure mode analytics.
Prerequisites
● You have created and assigned the relevant business objects. For more information, see Configuring Failure
Mode Analytics [page 461] and check the prerequistes.
● (Optional): You have configured the mean time indicators configuration. For more information, see
Configuring the Mean Time Indicators [page 463].
Procedure
1. On the SAP Fiori launchpad, go to the Administration group and open the Application Settings application.
Results
You can later also select a different language. Once you have selected a different language, you need to repeat
step 3 in the topic Configuring Failure Mode Analytics to apply your changes.
Related Information
This topic describes how to configure the notification language for failure mode analytics.
Prerequisites
● You have created and assigned the relevant business objects. For more information, seeConfiguring Failure
Mode Analytics [page 461] and check the prerequistes.
● (Optional): You have configured the mean time indicators configuration. For more information, see
Configuring the Mean Time Indicators [page 463].
● The role ConfigUser is assigned to your user.
● You have performed the following steps related to Google:
Caution
The translation feature for failure mode analytics is an optional feature and is based on Bring Your Own
Account (BYOA)
SAP is under no obligation to provide this feature now or in the future. The feature may be enhanced or
discontinued at any time, without notice. . That means that you must have a private account with
Google for translation services, and you must have your own Google API key. You alone are responsible
for all required contracts with Google, including important aspects such as privacy data (especially
customer data transferred to Google servers or other third party servers), costs for translation
services, and so on.
Procedure
1. On the SAP Fiori launchpad, go to the Administration group and open the Application Settings application.
Enable Translation Move the slider to Yes to enable the language translation.
Remember
If you no longer need the translation, you can later
disable it. However, if you want the translation to take
place, do not disable the language translation before
you have performed all of the steps in the topic
Configuring Failure Mode Analytics. Otherwise, you
receive an error when you manage your failure mode
analytics model in step 3 and your translation is not
applied.
Google Cloud API Key Paste the string from your created Google Cloud API key.
Note
The selection is displayed under Language Selection.
You can later edit your configuration. Once you have edited the configuration, you need to repeat step 3 in the
topic Configuring Failure Mode Analytics to apply your changes.
Related Information
The business user can create dashboards against different data sources. For an overview, see Analytics
Dashboards [page 70].
For each type and data source, the technical implementation is different. With this, different requirements need
to be met in order that the business user can view and create the dashboards in SAP Predictive Asset Insights.
This topic describes the technical implementation and requirements, and links to the related configuration
procedures.
Custom Live
Note
The custom live option is only available with Amazon Web Services (AWS).
This option allows you to use "live" data from SAP Predictive Asset Insights in the dashboard together with your
own data. To use this option, you need the following:
Caution
The connection to the analytics database is only allowed to be used for displaying data in SAP Analytics
Cloud as described in this guide. Any other usage is beyond the scope of this feature and not allowed
nor supported by SAP.
● Virtual tables and cube calculation views in your own SAP HANA database for the required data tables of
the analytics database and other databases
In your own SAP HANA database, you can combine the data from the SAP Predictive Asset Insights together
with your own data from other databases and perform calculations on this data, and so on. The data from SAP
Predictive Asset Insights is stored in the SAP Predictive Asset Insights analytics database. For more
information about the analytics database and the data, see Analytics Database [page 484].
Custom Offline
This option allows you to copy data from SAP Predictive Asset Insights into the dashboard. To use this option,
you need the following:
● An import data connection between SAP Analytics Cloud and SAP Predictive Asset Insights
● A license for SAP Analytics Cloud and active account
● An own story in SAP Analytics Cloud based on an SAP Analytics Cloud model
As the data source for the model in SAP Analytics Cloud, you use OData Services. The APIs of the OData
services then fetch the data. For an overview of all the APIs, see OData Services for SAP Analytics Cloud.
For creating the model and story in SAP Analytics Cloud, you can choose whether you create your own model
and story or import a package with business content. This package is called SAP Predictive Asset Insights and
contains a sample OData connection, seven sample models, and two sample stories. One story is for the
Analytics Dashboards application and one story is for the equipment page. As data for the models and the
stories, the package contains sample data, which you also overwrite. You can also combine the options, which
means that you can use a sample model and a sample story or use a sample model and create your own story.
The graphic below displays again the technical implementation of the types and data sources. The table below
the graphic summarizes again the main aspects.
Type of data that can be used ● Master data: Most of the ● Header data of equipment
attributes for equipment (without custom attributes),
(including custom attributes), models, locations, spare parts,
models, locations, installation notifications, and work orders
locations, notifications, and alerts ● Last indicator values
● Time series data: non-numeric
indicators, hourly aggregated data
for numeric indicators, and last
indicator values
● Own data from other databases
Place where data is stored In your own SAP HANA database with a In SAP Analytics Cloud with a copy of
reference to the SAP Predictive Asset the data from SAP Predictive Asset
Insights analytics database Insights
Possibility to use data "live" Yes No, the data gets copied to SAP
Analytics Cloud, but you can schedule
an hourly data replication job.
Related Tasks
Related Information
This topic lists all the configuration steps to enable the creation of custom live dashboards in SAP Predictive
Asset Insights.
Prerequisites
● You have a license for SAP Analytics Cloud and an active account. For more information, see SAP Analytics
Cloud .
● You are using SAP Predictive Asset Insights on Amazon Web Services (AWS).
● You have your own SAP HANA database with a license that allows you to create virtual tables and
calculation views.
Note
If you want to use time series data, you also need to create a support ticket and receive a response before
you can start with the procedure. The information that you need to provide for creating the ticket are:
● Component: IOT-PDM-OPS
● Title: Custom Analytics
● Description: Please enable the use of time series data for analytics, per <link of this SAP Help Portal
page>.
● Tenant ID
● Subdomain
Note
For the Extra Adapter Properties field, you need to paste the string encrypt=TRUE;sslTrustStore=
in front of the certficate and put the certificate in quotation marks. The field looks then as follows:
encrypt=TRUE;sslTrustStore="certificate text".
5. In your own SAP HANA database, create virtual tables based on the tables of the analytics database and
save them in the schema of choice. You can also join the virtual tables with other virtual tables of your own
data tables. For more information about the analytics database, see Analytics Database [page 484].
Note
Every time a new dynamic table is created in the analytics database based on the loaded data and you
want to use the table, you need to create a virtual table for this table and the calculation views as
explained in the next step.
6. In SAP HANA Studio or SAP Web IDE, create cube calculations views based on the virtual tables. For more
information, see Create Graphical Calculation Views.
7. (Only relevant if you want to create geo maps in SAP Analytics Cloud): In SAP HANA Studio, create
location dimension views in the SAP_BOC_SPATIAL package. For more information, see Creating Geo
model from Live HANA Calculation View .
Steps related to SAP Analytics Cloud:
8. Create a live data connection in SAP Analytics Cloud to your own SAP HANA database. For more
information, see Live Data Connection to SAP HANA Using a Direct Connection with Password
Authentication.
9. Create a model in SAP Analytics Cloud based on the live data connection. For more information, see
Creating a Model from a Live Data Connection.
10. Create a story in SAP Analytics Cloud based on the model. For more information, see Creating Your First
Story and Creating a New Story.
11. Assign the BI Content Viewer role with read privileges to the users from SAP Analytics Cloud who want
to view analytics dashboards. For more information, see Assigning Roles to Users.
12. Share the story with the users. For more information, see Sharing Stories or Bookmarks.
Tip
To easily share a story with multiple users, we recommend to create teams and share stories with
teams including different users. For more information about creating teams, see Creating Teams.
Results
Next Steps
The business user can now create custom live dashboards in SAP Predictive Asset Insights.
Related Information
This topic explains how to create credentials for the remote source.
Prerequisites
You have made sure that the Master Data Analytics service plan is added to your subaccount in SAP BTP
cockpit. For more information, see the Configure Entitlements and Quotas from Your Subaccount section in
Configure Entitlements and Quotas for Subaccounts.
The new instance is created and added to the service instances list.
8. From the list, choose the new instance.
9. To create a service key with the credentials, choose (Actions) Create Service Key on the upper
right corner.
12. To view the credentials, select the service key from the list and choose (Actions) View .
A new dialog box with the service key JSON file is displayed. In the 'hana' section of the JSON file, the
following information for the remote source are displayed:
○ Username
○ Password
○ Certificate (for the extra adapter properties)
○ Host
○ Port
Results
This topic describes how to configure object pages for analytics dashboards in SAP Predictive Asset Insights.
Prerequisites
● You have shared the story with the users. For more information, see Sharing Stories or Bookmarks.
● One of the following roles is assigned to your user:
○ CONFIGURATION_EDIT
○ CONFIGURATION_DELETE
Context
By default, the tabs and subsections in which the analytics dashboards are displayed are not activated for the
equipment and model pages. In order that the created dashboards are displayed on the tabs and subsections,
you need to configure the settings and activate the tabs and subsections for the object pages.
Procedure
1. On the SAP Fiori launchpad, go to the Administration group and open the Application Settings application.
2. To configure the equipment and model page, choose (Object Page Configurations).
Results
This topic lists all the configuration steps to enable the creation of custom offline dashboards in SAP Predictive
Asset Insights.
Prerequisites
You have a license for SAP Analytics Cloud and an active account. For more information about SAP Analytics
Cloud, see SAP Analytics Cloud .
Procedure
Note
2. Define a model in SAP Analytics Cloud. You can choose between the following options:
○ Import the SAP Predictive Asset Insights package with the sample models and the sample data. For
more information, see Importing Business Content and Overwriting Sample Data in SAP Analytics
Cloud [page 478].
○ Create your own model. To create your own model, proceed as follows:
○ Configure a data connection to use data from SAP Predictive Asset Insights. For more information
about configuring a data connection, see Configuring a Data Connection in SAP Analytics Cloud
[page 479].
○ Create a model and import the data. For more information, see Creating a Model in SAP Analytics
Cloud [page 481].
Remember
To use a sample story, you need to have imported the package in step 2 and used one of the
sample models.
○ Create your own story. For more information, see Creating Your First Story and Creating a New Story.
5. Assign the BI Content Viewer role with read privileges to the users from SAP Analytics Cloud who want
to view analytics dashboards. For more information, see Assigning Roles to Users.
Tip
6. Share the story with the users. For more information, see Sharing Stories or Bookmarks.
Tip
To easily share a story with multiple users, we recommend to create teams and share stories with
teams including different users. For more information about creating teams, see Creating Teams.
Results
Next Steps
The business user can now create custom offline dashboards in SAP Predictive Asset Insights.
Related Information
This topic describes how to import business content and overwrite the sample data in SAP Analytics Cloud.
Prerequisites
You have enabled your custom identity provider from SAP Predictive Asset Insights in SAP Analytics Cloud. For
more information, see Enabling a Custom SAML Identity Provider.
Context
When you use the SAP Predictive Asset Insights package, you have the option to only import the business
content with the included sample data and view this data in a story and analytics dashboard or you can
overwrite the imported sample data with your own data.
Note
Consider that the usage of the sample data only fully works for the analytics dashboard in the Analytics
Dashboards application. For the analytics dashboard in the equipment page, it shows the dashboard but
without data because the data is filtered by the equipment of the page.
Procedure
The sample models and stories are imported together with the sample OData connection and the sample
data. If you would only like to use the sample data, you can skip the remaining steps of the procedure. If
you would like to overwrite the data with your own data, proceed with step 3.
3. Navigate to the Connection screen, select the sample OData connection for SAP Predictive Asset Insights
(ID: SAP__PAI_GEN_CONNECTION) and update or fill in the required fields that point to the connection of
your data source. For more information about the fields, see Configuring a Data Connection in SAP
Analytics Cloud [page 479].
4. Choose (Main Menu) Browse Files Public Models and open the model that you want to use.
The model names start with SAP_PAI.
5. For each openend model, perform the following steps:
a. Choose Data Management.
b. Choose the import job.
Results
Related Information
This topic describes how to configure a data connection in SAP Analytics Cloud.
Prerequisites
You have enabled your custom identity provider from SAP Predictive Asset Insights in SAP Analytics Cloud. For
more information, see Enabling a Custom SAML Identity Provider.
Context
Procedure
OAuth Client ID Enter the client ID that you received during the
subscription to the asset central foundation.
Secret Enter the client secret that you received during the
subscription to the asset central foundation.
6. Choose Create.
Results
Related Information
Prerequisites
You have configured a data connection in SAP Analytics Cloud. For more information, see Configuring a Data
Connection in SAP Analytics Cloud [page 479].
Context
For general information about creating models, Building Your First Model and Creating a New Model.
Note
Consider the following when you create a model using the following OData APIs:
IF([dataType]="numeric" OR [dataType]="numericflexible",
[value],
[Null]
)
This step copies all numeric values into the new field and you can use it in charts.
4. Make the new Numeric Values column the measure.
5. Ensure that the original Value field is a dimension, not a measure.
IF([dataType]="numeric" OR [dataType]="numericflexible",
[value],
[Null]
)
● Equipment API:
The longitude and latitude values for the geo coordinates are provided together in the coordinates
source column separated by a comma. In order that SAP Analytics Cloud can use it, you need to split
the values into two columns:
1. Switch to the grid view to open the source data table by choosing .
2. (Optional) duplicate the column to preserve the original column.
3. Select the duplicated column and split the column by creating a transformation. The following
For more information about creating calculated columns, peforming column actions, transformations, and
data types, see Video: Create Calculated Columns and the Improving data quality section in Preparing Data.
Procedure
SAP Analytics Cloud retrieves data from the OData Service. Once the data is received, the New Query for
OData Services dialog box is displayed.
7. In the dialog box, select the object that you want to add and choose Next.
On the top bar of the application, the query for the object is displayed and loaded.
The New Model screen is displayed, where you can modify the model before creating it.
11. Choose Create.
Results
Related Information
This topic describes how to configure object pages for analytics dashboards in SAP Predictive Asset Insights.
Prerequisites
● You have shared the story with the users. For more information, see Sharing Stories or Bookmarks.
● One of the following roles is assigned to your user:
○ CONFIGURATION_EDIT
○ CONFIGURATION_DELETE
Context
By default, the tabs and subsections in which the analytics dashboards are displayed are not activated for the
equipment and model pages. In order that the created dashboards are displayed on the tabs and subsections,
you need to configure the settings and activate the tabs and subsections for the object pages.
Procedure
1. On the SAP Fiori launchpad, go to the Administration group and open the Application Settings application.
2. To configure the equipment and model page, choose (Object Page Configurations).
Results
Related Information
The analytics database stores master data and time series data from SAP Predictive Asset Insights. Depending
on the type of data, the data is stored in different tables.
Note
When you are using the data of the analytics database, you need to consider multiple aspects. For more
information, see Important Information When Using the Analytics Database [page 488].
The master data in the analytics database contains, for example, equipment, models, locations, alerts, and so
on, and custom attributes for equipment and models.
The time series data in the analytics database contains numeric indicators and non-numeric indicators.
Numeric indicators are indicators of the type Numeric, Numeric Flexible, and Boolean where true is set to 1 and
false is set to 0. Non-numeric indicators are indicators of the data type String. The numeric indicators are
stored as aggregated values and the non-numeric indicators are stored as raw data.
The aggregated values are calculated in an hourly interval based on indicator data collected from SAP
Predictive Asset Insights. The aggregated values include the following:
The master data and time series data is stored in static and dynamic tables.
The master data and the latest average values of the numeric indicators are stored in static tables. The rest of
the time series data and the custom attributes are stored in dynamic tables. Static tables are included in the
analytics database by default. Dynamic tables are only created in the analytics database if you have indicators,
indicator groups, attributes or attribute groups for equipment and models.
The tables have different naming conventions. For an overview of the tables and their naming conventions, see
the Overview of Tables and Data section below.
Initially, the analytics database is empty and only contains the static tables without any data. For the data to
initial load into the static tables and the dynamic tables to create, several objects need to be created and/or
published in SAP Predictive Asset Insights:
● For alerts and notifications, the respective alerts and notifications need to be created in SAP Predictive
Asset Insights.
● For models and locations, the respective models and locations need to be published in SAP Predictive
Asset Insights.
● For installation locations, the respective locations or equipment need to be published in SAP Predictive
Asset Insights.
● For the rest of the master data including the custom attributes, and for the time series data, the respective
equipment need to be published in SAP Predictive Asset Insights. If you want to use time series data, you
need to request the usage via a support ticket before the publishing.
After the initial load of the data, the data gets loaded and updated in the following ways:
● The aggregated values of the numeric indicators are generally loaded and updated within every hour after
each calculation. If indicator data arrives later in SAP Predictive Asset Insights than the usual calculation
window, for example, because of connection issues, then the data from SAP Predictive Asset Insights is
included in the next calculation and the aggregated values will be added to the respective time range to
which they belong to in the analytics database.
Note
For the latest average values, the values are not added to a respective time range because the table
only includes one row for each indicator where only the latest value is stored and updated.
● The raw data of the non-numeric indicators is loaded and updated every couple of minutes.
● Alerts and notifications are loaded and updated every time an alert or notfication is changed or created in
SAP Predictive Asset Insights.
● Models and locations are loaded and updated every time a model or location is published in SAP Predictive
Asset Insights.
Depending on the data that is loaded into the database, the static and dynamic tables are updated in different
ways:
● For the master data, either the data in the existing row of the respective static table is updated, or a new
row for new data is added.
● For the latest average values of the numeric indicators, the value in the respective row of the static table is
updated with the newly calculated value.
● For the rest of the time series data including the custom attributes, either the data in the rows of the
dynamic tables are updated, or new dynamic tables for new data are created. For example, if you create a
new attribute group for a piece of equipment and you republish the piece of equipment, then a new
dynamic table for this attribute group is created.
The following table provides you with a summary of the static and dynamic tables that exist in the database
with the included data and how this data is stored in the tables:
Note
The indicator internal ID
is used for the column
names.
Note
The indicator internal ID
is used for the column
names.
Note
The attribute internal ID
is used for the column
names.
When you are using the data of the analytics database in your own SAP HANA database, you need to consider
several aspects.
Caution
The connection to the analytics database is only allowed to be used for displaying data in SAP Analytics
Cloud as described in this guide. Any other usage is beyond the scope of this feature and not allowed nor
supported by SAP.
General
● Currently, instance-based authorization capabilities are not supported. That means that every user within
your organization who is authorized to access your company’s dashboards can also view the master data
and time series data for the respective equipment.
● You can only store data up to 10 GB in the database, which is sufficient in most use cases.
● You can only use time series data that is created after the confirmation of the support ticket. That means
you cannot include time series data from the past in the database.
● We only store the last 180 days of time series data.
● You can only use indicator groups with a maximum number of 249 indicators for SAP Analytics Cloud.
● Since the aggregated values for the numeric indicators are calculated every hour, there is a slight delay
when the aggregated values are available in the database. In general, the aggregated values are available in
the hour after the individual time series reading have been ingested. The aggregated values are calculated
shortly after the hour based on all indicator data that was ingested in the previous hour or since the last
aggregation. In certain cases, it can take up to 2 hours for some indicator data to be included in the
calculation. This can, for example, happen when indicator data has been ingested closely before the
calculation happens or if the indicator data is late arriving data.
● Since the non-numeric indicators are stored as raw data, we recommend to isolate the non-numeric
indicators in separate indicator groups and limit the ingestion of readings. Otherwise, it can happen that if
you ingest a high volume of non-numeric indicators, the analysis in the analytics dashboards slows down.
Master Data
● You can only use master data for analytics that is published after the onboarding. That means after you are
onboarded as an analytics user, you need to republish the respective equipment, models, and locations to
Configuration options for analysis tool variants and the Explorer can be found in a dropdown within Application
Settings.
Prerequisites
Go to the SAP Fiori launchpad under Administration Application Settings Explorer and Analysis Tools
Configuration .
Preconfigured Variants
In addition to variants that you configure, we also deliver preconfigured variants. For more information, see
Preconfigured Variants [page 491].
Alerts Fields for Configuring Alerts [page 492] Analysis tool with multiple variants
Equipment Indicators Fields for Configuring Equipment Indi Analysis tool with multiple variants
cators [page 494]
Explorer Global Filter Fields for Configuring the Explorer Filter with multiple variants
Global Filter [page 496]
Indicator Chart Fields for Configuring the Indicator Analysis tool with multiple variants
Chart [page 497]
Map Fields for Configuring the Map [page Analysis tool with multiple variants
500]
Notifications Fields for Configuring Notifications Analysis tool with multiple variants
[page 507]
Work Orders Fields for Configuring Work Orders Analysis tool with multiple variants
[page 508]
Transformer Health Analytics Fields for Configuring Transformer Analysis tool with one variant
Health Analytics [page 510]
Function Description
Copy Copy an existing variant and adjust the copied variant as you
require.
Note
In the Explorer and transformer health analytics configuration, the following functions do not exist, as the
Explorer and the transformer health analytics analysis tool have only one variant:
● Add
● Copy
● Delete
● Restore Default
For information on the supported user interface (UI) languages, refer SAP Predictive Asset Insights [page
7]
Related Information
With every release, we deliver preconfigured variants in addition to the variants that you can configure. This
allows a business user to immediately start working with the Explorer.
● A preconfigured variant for each analysis tool including a preconfigured model variant for the indicator
chart
Note
Preconfigured variants for the analysis tools and the Ex SAP Standard
plorer global filter
Preconfigured model variant for the indicator chart SAP Standard for a Model
Preconfigured variant for the Explorer No title because the Explorer has only one variant
Preconfigured Variant for Each Analysis Tool and for the Explorer Global Filter
● You can copy the preconfigured variants for the analysis tools and the preconfigured variants for the
Explorer global filter and then edit the copy.
● If one of the preconfigured variants for the analysis tools or the preconfigured variant for Explorer global
filter is not required, you can delete it. The deleted preconfigured variant is then not available for the
business user in the Explorer.
● If you have deleted one of the preconfigured variants and you need it again, you can restore it.
You can edit the preconfigured variant for the Explorer by changing the preconfigured settings.
Note
If you edit the preconfigured variant for the Explorer, we recommend that you note down the preconfigured
settings before changing them so that you can later bring them back if required. Also, if you edit the
preconfigured variant, the edited variant persists in the upcoming release and is not overwritten by the new
delivered preconfigured variant.
Related Information
You can define variants of this analysis tool. These variants can then be selected by business users from the
Explorer.
Preconfigured Variant
SAP also delivers a preconfigured variant. For more information about preconfigured variants, see
Preconfigured Variants [page 491].
In this section you define which columns business users see by default when they choose this variant of the
Alerts analysis tool to add it to the Explorer. You can choose from a predefined list of columns.
Filters
In this section you define the default filter values that are displayed in the list of alerts for the variant.
Sorting
In this section you define which columns are displayed under Sort in the View Settings of the Alerts analysis
tool and whether the column should be sorted in ascending or desending order. The first entry in this list is the
default in the alert list.
Field Description
Language Select the language in which you want to maintain text val
ues.
Variant Name Enter a name for the variant. The name is visible when you
select a variant for the analysis tool in the Explorer.
Variant Description Enter a description to provide more details about the variant.
The description is visible in the Variants pane in the configu-
ration screen.
Related Information
You can define variants of this analysis tool. These variants can then be selected by business users from the
Explorer.
Preconfigured Variant
SAP also delivers a preconfigured variant. For more information about preconfigured variants, see
Preconfigured Variants [page 491].
Column Selection
In this section, you define which columns/fields business users see by default when they choose this variant of
the Equipment Indicators analysis tool in the Explorer. You can choose from a predefined list of columns.
Field Description
Column Width Width defined here will be the default column width in the
Equipment Indicators analysis tool. By default, the width is
200 pixels.
Filters
In this section, you define the default filter for the columns. The analysis tool display the contents according to
these filters. The values are
● Contains
● Equal
Sorting
In this section, you define the default sorting of the columns. You can sort the columns in the ascending or
desending order.
Field Description
Language Select the language in which you want to maintain text val
ues
Variant Name Enter a name for the variant. The name is visible when you
select a variant for the analysis tool in the Explorer.
Variant Description Enter a description to provide more details about the variant.
The description is visible in the Variants pane in the configu-
ration screen.
Related Information
Here you configure what your business users will see in the Explorer when they log on for the first time. After
the very first logon, SAP Predictive Asset Insights preserves the order of analysis tools made by business
users in the Explorer.
Preconfigured Variant
The preconfigured variant for the Explorer contains a predefined order of all analysis tools with their
preconfigured variants.
For more information about preconfigured variants, see Preconfigured Variants [page 491].
Content
Field Description
Analysis Tool Select the analysis tool that is displayed by default, for ex
ample, Alerts.
Variant Select the variant of the analysis tool that is displayed by de
fault, for example, Work Orders - Pump Variant.
Field Description
Language Select the language in which you want to maintain text val
ues.
Variant Name Enter, for example, a role suitable for this Explorer variant if
required.
Variant Description Enter a description to provide more details about, for exam
ple, the role that uses this Explorer variant if required.
You can define variants including various filters. These variants can then be selected by business users in the
Explorer.
Preconfigured Variant
The preconfigured variant for the Explorer global filter contains no filters so that the analysis tools show data
for all top equipment.
For more information about preconfigured variants, see Preconfigured Variants [page 491].
Filters
Field Description
Class Select the underlying class template used while creating the
model/piece of equipment or functional location. The char
acteristics of a piece of equipment and functional location
can be defined by the underlying class and subclass tem
plate.
Field Description
Language Select the language in which you want to maintain text val
ues.
Variant Name Enter a name for the variant. The name is visible when you
select a variant for the Explorer global filter in the Explorer.
Variant Description Enter a description to provide more details about the variant.
The description is visible in the Variants pane in the configu-
ration screen.
When navigating to the Indicator Chart from Alerts, the indicator chart displays the first variant defined in the
Indicator Chart configuration.
Data Points
In this section, you can define the number of data points per indicators that you want to be displayed in the
chart.
A maximum of 600 data points in total can be displayed in the indicator chart. This is entered in the Data
Points for Each Indicator on the Chart column. The default number of data points is 240 and can range
between 30 and 600. The more the number of data points, the more the accuracy of chart. But, the
response time may be affected.
Preconfigured Variants
SAP delivers two preconfigured variants. They appear in the variant selection dialog in the indicator chart. They
are:
● SAP Standard: This variant stores default settings for an indicator chart. As an end user of the application,
you can select indicators as favorites in the indicator list. On choosing this variant, the indicators thus
selected appear as default indicators.
● SAP Standard for a Model:This variant stores default settings for an indicator chart. As an administrator
with the required role, you can select indicators as default for a model in the indicator list. On choosing this
variant, the indicators thus selected appear as default indicators.
Note
The default indicator for a model is set in indicator list for a model and default indicator for equipment
template is set in indicator list for equipment.
For all variants, except SAP Standard for a Model, the user selected favourite indicators are loaded by default.
For more information about preconfigured variants, see Preconfigured Variants [page 491].
Time Filters
Field Description
Text Label of the time interval that is displayed on the UI of the in
dicator chart
Example
48 Hours, Today
Example
48 for a time interval of 48 hours
Example
hour for a time interval of 48 hours
● hour
● day
● week
● month
● year
Field Description
Lang Select the language in which you want to maintain text val
ues.
Key / Text Choose the key of the text. Enter the time filter text you
would like to be displayed on the UI.
Variant Name Enter a name for the variant. The name is visible when you
select a variant for the analysis tool in the Explorer.
Variant Description Enter a description to provide more details about the variant.
This description is visible in the Variants pane in the configu-
ration screen.
Related Information
You can define variants of this analysis tool. These variants can then be selected by business users in the
Explorer.
Preconfigured Variant
The preconfigured variant for the map includes a sample base map so that business users can immediately
start working with the map. It does not include preconfigured settings related to equipment and functional
locations (for which models to show the technical objects on the map). These settings are customer-specific
and therefore cannot be added to the preconfigured variant.
For more information about preconfigured variants, see Preconfigured Variants [page 491].
Map Settings
In the map settings, you configure the initial position and displayed area for the map variant when you open it in
the Explorer.
Zoom Level Enter a value for the initial zoom level. The map variant is
then displayed with this initial zoom level.
Note
Only enter integer as values.
Latitude Enter a value for the initial latitude. The map variant is then
displayed centered on this geographical coordinate.
Longitude Enter a value for the initial longitude. The map variant is then
displayed centered on this geographical coordinate.
Layers
In the layers settings, you configure the base layer and overlay layer settings for the map variant.
Note
You can use any map provider of your choice. Fill in the fields below according to the map provider.
Note
Field Description
Layer Name Enter the name for the base layer. The name is later dis
played in the overlay dropdown menu in the top right hand
corner of the map variant.
Note
Enter a name that is unique for each layer.
Layer Type Enter the type for the base layer. The type depends on the
map provider that you want to use.
● xyz
This type is used for many map providers. It defines the
layer using an URL with the following format /z/x/
y.png. The png is the image for the tile of the map, z
defines the zoom level, and x and y identity the tile. If
you choose this type, make sure you fill in the Layer URL
field.
● esri
One map provider uses a separate type to construct
maps. If you choose this type, make sure you fill in the
Layer Parameters field.
Layer URL (Only relevant if you have entered xyz as the base Enter the URL of the map provider. The URL defines the style
layer type) of the baser layer type.
Note
Activate the Mandatory checkbox if you have filled in this
field.
Layer Parameters (Only relevant if you have entered esri as Enter the base map value. The base map value defines the
the base layer type) style of the base layer type. You can choose between differ-
ent values, for example, satellite.
Note
Activate the Mandatory checkbox if you have filled in this
field.
Attribution Enter the attribution for the map variant. The attribution is a
string that defines the copyright of the map provider, for ex
ample, © <map provider>. You can also include an HTML link
that leads to the copyrights of the map provider.
Note
Activate the Mandatory checkbox if you have filled in this
field.
Application ID (Only relevant if your map provider provides Paste the application ID for the map provider.
an application ID)
Note
Activate the Mandatory checkbox if you have filled in this
field.
Application Code (Only relevant if your map provider pro Paste the application code for the map provider.
vides an application code)
Note
Activate the Mandatory checkbox if you have filled in this
field.
Subdomains (Only relevant if your map provider is using a Enter the subdomain for the map provider.
subdomain)
Note
Activate the Mandatory checkbox if you have filled in this
field.
Map ID (Only relevant if your map provider is using map ver Enter the map version that you want to use.
sions)
Note
Activate the Mandatory checkbox if you have filled in this
field.
Base (Only relevant if your map provider is using base map Enter the base map type for the base layer, for example,
types) traffic.
Note
Activate the Mandatory checkbox if you have filled in this
field.
Initial Base Layer Select the option for the initial base layer. This field is useful
if you create multiple layers. You can choose between True
and False:
● If you select True for one layer, this base layer is set as
the default layer. This means it is later the first layer in
the overlay dropdown menu in the top right hand corner
of the map variant.
● If you select True for all layers, they are displayed in the
overlay dropdown menu according to the order in which
you created them.
● If you select False for all layers, they are also displayed
in the overlay dropdown menu according to the order in
which you created them.
Hide Logo Activate this checkbox if the logo of the map provider should
not be visible on the map variant.
Overlay Layers
The base layer can be overlaid by the overlay layers to define specific attributes, for example, how the
equipment or functional locations on the map are displayed.
Note
To add an overlay layer, choose (Add new column), and then select the model or multiple models for
which you want to display the equipment or functional locations on the map variant. For each selected
model, a layer is added.
Field Description
Model Type Displays the type of the selected model. The following types
are available:
● Equipment
● Functional Locations
Clustering Select the clustering method for the map variant. You can
choose from the following methods:
Note
Consider the following:
○ Select Cluster for larger sets of equipment and
functional locations. Otherwise, you encounter
performance issues with the map when you
have larger sets.
○ Spider leg only works when you have selected
Cluster as the method.
○ Spider leg only works with clusters at the maxi
mum zoom level. This means when you add a
new model to the map variant, the initial value
for Remove Cluster at Zoom Level is 0. To en
sure that spider leg works, you need the same
value as the maximum zoom level possible for
your map provider.
Remove Cluster at Zoom Level (Only relevant when you have Define at which zoom level clusters are removed and the top
selected Cluster as the clustering option) equipment and top functional locations are displayed sepa
rately.
Note
Enter a value that is one higher than the maximum zoom
level possible for your map provider. Otherwise, spider
leg does not work.
Note
Field Description
Language Select the language in which you want to maintain text val
ues.
Variant Name Enter a name for the variant. The name is visible when you
select a variant for the analysis tool in the Explorer.
Variant Description Enter a description to provide more details about the variant.
The description is visible in the Variants pane in the configu-
ration screen.
Related Information
You can define variants of this analysis tool. These variants can then be selected by business users from the
Explorer.
Preconfigured Variants
SAP also delivers a preconfigured variant. For more information about preconfigured variants, see
Preconfigured Variants [page 491].
Columns
In this section, you define which columns/fields business users see by default when they choose this variant of
the Notifications analysis tool in the Explorer. You can choose from a predefined list of columns.
Filters
In this section, you define the filter field values for the notifications variant.
Sorting
In this section, you define which columns are displayed under Sort in the View Settings of the Notifications
analysis tool and whether the column should be sorted in ascending or descending order.
Table Details
In this section, you configure the Notifications analysis tool for more information about a particular notification.
When you click a notification, you navigate in-place to more information about that notification.
You define the tabs containing this further information and enter an ID for the tab under Tab Title (you later
map a label to this ID under Labels and Translations). Each of these tabs can have up to 3 columns and you can
define which fields are displayed in each column.
Field Description
Language Select the language in which you want to maintain text val
ues.
Variant Name Enter a name for the variant. The name is visible when you
select a variant for the analysis tool in the Explorer.
Variant Description Enter a description to provide more details about the variant.
The description is visible in the Variants pane in the configu-
ration screen.
Related Information
You can define variants of this analysis tool. These variants can then be selected by business users from the
Explorer.
Preconfigured Variant
SAP also delivers a preconfigured variant. For more information about preconfigured variants, see
Preconfigured Variants [page 491].
Columns
In this section you define which columns/fields business users see by default when they choose this variant of
the Work Orders analysis tool in the Explorer. You can choose from a predefined list of columns.
Filters
In this section you define the filter field values for the work orders variant.
In this section you define which columns are displayed under Sort in the View Settings of the Work Orders
analysis tool and whether the column should be sorted in ascending or desending order. The first entry in this
list is the default in the alert list.
Table Details
In this section you configure the Work Orders analysis tool for more information about a particular work order.
When you click on a work order you navigate in-place to more information about that work order.
You define the tabs containing this further information and enter an ID for the tab under Tab Title (you later
map a label to this ID under Labels and Translations). Each of these tabs can have up to 3 columns and you can
define which fields are displayed in each column.
Field Description
Language Select the language in which you want to maintain text val
ues.
Variant Name Enter a name for the variant. The name is visible when you
select a variant for the analysis tool in the Explorer.
Variant Description The variant description you enter here is visible in the analy
sis tool catalog after you have selected the variant by its
name.
Related Information
You can configure the analysis tool. The analysis tool can then be selected by business users in the Explorer
and viewed on the Equipment page.
Equipment
In this section, you select for which set of equipment the analysis should be performed.
Note
To select the equipment, choose (Add new column). You at least need to select one set of equipment.
Field Description
Model ID Select the equipment model for which the analysis should
be performed. You can choose from all equipment models
that were created in the Models application.
Attribute Select the attribute that has a value, which defines that this
piece of equipment is eligible for transformer health
analytics, for example, Oil Type. You can choose from all
attributes that were created in the Templates application.
Attribute Value Enter the attribute value of the equipment or model. You
can enter any value for this field, for example, Mineral.
Time Filters
Per default, all latest oil samples for the eligible equipment are selected for the analysis in the Explorer. In this
section, you can define time ranges for the Explorer to only include the oil samples for a certain number of last
days, for example, the oil samples of the last five days. The business user can later switch between these time
ranges in the Explorer. You can define up to three time ranges.
Note
Field Description
1st Time Range in Days Enter the first time range. Per default, the number of days is
set to 30. You can use any whole number greater than zero.
2nd Time Range in Days Enter a second time range if required. You can use any
whole number greater than zero.
3rd Time Range in Days Enter a third time range if required. You can use any whole
number greater than zero.
In this section, you define the calculation schedule. The calculation schedule is needed to regularly process
new oil sample data and calculate the coordinates of the fault points in the Duval triangles based on the data.
The oil samples data includes the defined set of equipment, the data of the gases, and the oil sample date.
Note
If you later change the set of equipment, this new set will be used in the next scheduled calculation.
Field Description
Start Select the start date and time of the calculation schedule.
In this section, you select the indicators for the five gases of an oil sample. In the indicators, the gas
concentration values for the gases are stored.
Field Description
Indicator Group Select the indicator group of the selected template. You can
choose from all groups that are assigned to the template.
Indicator For each of the gases, select the indicator of the indicator
group that should be the source for the gas concentration
values. You can choose from all indicators that were created
in the Templates application.
In this section, you can enter lowest valid gas concentrations for the five gases of an oil sample. If one or more
gas concentrations of an oil sample fall below the entered lowest valid gas concentrations, the oil sample is
marked as Limited in the oil sample details table on the Equipment page. The limited oil sample is not used in
Field Description
Lowest Valid Gas Concentration in ppm Enter a lowest valid gas concentration for a gas. You can use
any whole number greater than zero. If you leave the field
empty for a gas, all gas concentrations of this gas are valid.
Note
Field Description
Language Select the language in which you want to maintain text val
ues.
Variant Name Enter a name for the variant. The name is visible when the
business user selects the variant in the Explorer.
Variant Description Enter a description to provide more details about the variant.
Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:
● Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your
agreements with SAP) to this:
● The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
● SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
● Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering a SAP-hosted Web site. By using such
links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this
information.
Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax
and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of
example code unless damages have been caused by SAP's gross negligence or willful misconduct.
Gender-Related Language
We try not to use gender-specific word forms and formulations. As appropriate for context and readability, SAP may use masculine word forms to refer to all genders.
SAP and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP
SE (or an SAP affiliate company) in Germany and other countries. All
other product and service names mentioned are the trademarks of their
respective companies.