Integration Guide for SAP Asset Intelligence Network · PDF fileThis section describes the...
Transcript of Integration Guide for SAP Asset Intelligence Network · PDF fileThis section describes the...
Integration Guide
SAP Asset Intelligence Network
Document Version: 1.0 – 2018-01-02
CONFIDENTIAL
Integration Guide for SAP Asset Intelligence Network
2
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
Typographic Conventions
Type Style Description
Example Words or characters quoted from the screen. These include field names, screen titles,
pushbuttons labels, menu names, menu paths, and menu options.
Textual cross-references to other documents.
Example Emphasized words or expressions.
EXAMPLE Technical names of system objects. These include report names, program names,
transaction codes, table names, and key concepts of a programming language when they
are surrounded by body text, for example, SELECT and INCLUDE.
Example Output on the screen. This includes file and directory names and their paths, messages,
names of variables and parameters, source text, and names of installation, upgrade and
database tools.
Example Exact user entry. These are words or characters that you enter in the system exactly as
they appear in the documentation.
<Example> Variable user entry. Angle brackets indicate that you replace these words and characters
with appropriate entries to make entries in the system.
EXAMPLE Keys on the keyboard, for example, F2 or ENTER .
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 3
Document History
Version Date Change
1.0 <2017-11-15> Draft Document created
1.0 <2017-11-20> Technical review
1.0 <2017-01-02> Document updated
4
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
Contents
1 About............................................................................................................................................... 6
2 SAP Asset Intelligence Network (AIN) Integration with SAP Enterprise Asset
Management (EAM) ...................................................................................................................... 7 2.1 Prerequisites ................................................................................................................................... 8
2.1.1 Prerequisites for Integration between SAP AIN and SAP EAM ....................................... 8 2.1.2 Important SAP Notes ....................................................................................................... 8
2.2 Authentication Between SAP ERP and SAP AIN ............................................................................. 9 2.2.1 Client Certificate .............................................................................................................. 9 2.2.2 OAuth 2.0 ....................................................................................................................... 10
2.3 Assumptions and Implementation Considerations ...................................................................... 24 2.3.1 Authorization in SAP EAM ............................................................................................. 24
2.4 Link SAP EAM Object to SAP AIN Model ....................................................................................... 24 2.4.1 Master Data Prerequisites ............................................................................................. 24 2.4.2 Link EAM Objects to AIN Models ................................................................................... 25
2.5 Display SAP AIN Model Information in SAP EAM Side Panel........................................................ 26 2.5.1 Authorization in SAP AIN ............................................................................................... 26 2.5.2 Authorization in SAP EAM ............................................................................................. 27 2.5.3 View SAP AIN Model Information in SAP EAM Side Panel ............................................ 27
2.6 AIN Equipment Creation and Synchronization for EAM Objects .................................................. 27 2.6.1 Setup and Configurations .............................................................................................. 28 2.6.2 Master Data Prerequisites ............................................................................................. 35 2.6.3 Import of AIN Model or Equipment Templates ............................................................. 36 2.6.4 Equipment Creation and Synchronization .................................................................... 37
2.7 Document Creation and Synchronization ..................................................................................... 40 2.7.1 Global Configuration Settings ....................................................................................... 41 2.7.2 Mapping of DMS Doc Type and AIN Doc Category ....................................................... 42 2.7.3 Characteristics and Class .............................................................................................. 42 2.7.4 Create and Synchronize Documents............................................................................. 43
2.8 AIN Announcement Processing in EAM ........................................................................................ 45 2.8.1 Global Configuration Settings ....................................................................................... 46 2.8.2 Import Announcements from AIN ................................................................................. 49 2.8.3 AIN Announcement Processing POWL ......................................................................... 52 2.8.4 Closing of Announcement Work Items .......................................................................... 57
2.9 Replicate Work Orders from SAP EAM to SAP AIN system .......................................................... 59 2.9.1 Value Mapping Configuration: ....................................................................................... 59 2.9.2 Replicate Work orders ................................................................................................... 61
2.10 Replicate Notifications from SAP EAM to SAP AIN system.......................................................... 63 2.10.1 Value Mapping Configuration: ....................................................................................... 63 2.10.2 Replicate Notifications................................................................................................... 64
3 SAP Asset Intelligence Network with SAP Cloud Platform Internet of Things ................. 66 3.1 Configuring HANA Cloud Integration System in SAP Asset Intelligence Network ....................... 66
3.1.1 Prerequisites .................................................................................................................. 66
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 5
3.1.2 Procedure.......................................................................................................................66 3.2 Maintaining User Credentials ........................................................................................................ 67
3.2.1 Prerequisites .................................................................................................................. 67 3.2.2 Procedure....................................................................................................................... 67
3.3 Retrieving Links from the Internet of Things Services Cockpit .................................................... 68 3.3.1 Context ........................................................................................................................... 68 3.3.2 Procedure....................................................................................................................... 68
3.4 Configuring External Systems in SAP Asset Intelligence Network ............................................... 70 3.4.1 Context ........................................................................................................................... 70 3.4.2 Prerequisites .................................................................................................................. 70 3.4.3 Procedure....................................................................................................................... 70
3.5 Mapping Measuring Points with an External System .................................................................... 71 3.5.1 Prerequisites .................................................................................................................. 71 3.5.2 Context ........................................................................................................................... 71 3.5.3 Procedure....................................................................................................................... 72
4 SAP Asset Intelligence Network with SAP Hybris Cloud for Customer ............................... 73 4.1 Configuring SAP Hybris Cloud for Customer System................................................................... 73
4.1.1 Prerequisites .................................................................................................................. 73 4.1.2 Procedure....................................................................................................................... 73
4.2 Maintaining User Credentials ........................................................................................................ 74 4.2.1 Prerequisites .................................................................................................................. 74 4.2.2 Procedure....................................................................................................................... 75
4.3 Configuring External Systems in SAP Asset Intelligence Network ............................................... 75 4.3.1 Context ........................................................................................................................... 75 4.3.2 Prerequisites .................................................................................................................. 75 4.3.3 Procedure....................................................................................................................... 76
4.4 Mapping External IDs for Objects with SAP Hybris Cloud for Customer System ........................ 76 4.4.1 Prerequisites .................................................................................................................. 77 4.4.2 Procedure....................................................................................................................... 77
5 SAP Asset Intelligence Network with SAP Hybris Commerce .............................................. 79 5.1 Configuring SAP Hybris Commerce as an External System in SAP Asset Intelligence Network . 79
5.1.1 Context ........................................................................................................................... 79 5.1.2 Prerequisites .................................................................................................................. 79 5.1.3 Procedure.......................................................................................................................80
6
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
1 About
Purpose
This integration guide is the starting point for the technical implementation of the SAP Asset Intelligence Network
application. This document describes the following concepts;
• SAP Asset Intelligence Network (AIN) Integration with SAP Enterprise Asset Management (EAM)
• SAP Asset Intelligence Network with SAP Cloud Platform Internet of Things service
• Configuring SAP Hybris Cloud for Customer System
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 7
2 SAP Asset Intelligence Network (AIN) Integration with SAP Enterprise Asset Management (EAM)
This section describes the concept of how the SAP Asset Intelligence Network (SAP AIN) is integrated with SAP
Enterprise Asset Management (SAP EAM). You can find cross-scenario implementation information as well as
scenario-specific information in this guide.
Note
The central starting point for the SAP Asset Intelligence Network application is the administration and
operations guide, which you can find on the SAP User Assistance Content Platform at
https://uacp2.hana.ondemand.com/viewer/p/SAP_ASSET_INTELLIGENCE_NETWORK.
This integration guide consists of the following main sections:
• Link SAP EAM object to AIN model
• Display SAP AIN model information in EAM side panel
• AIN Equipment Creation and Synchronization for EAM Objects
• Document Creation and Synchronization between EAM and AIN
• AIN Announcement processing in EAM
• View/Display EAM work orders associated with equipment in AIN
The integration information that is presented here serves as an example of how you can use the SAP Asset
Intelligence Network application in your company. The scenarios are only intended as examples and do not
necessarily run the way they are described here in your customer-specific system landscape. Ensure that you
check your requirements and systems to determine how this can be used productively at your site.
Furthermore, we recommend that you test these scenarios thoroughly in your test systems to ensure they are
complete and free of errors before going live.
This integration guide primarily discusses the overall technical implementation of SAP Asset Intelligence
Network and its associated components. However, additional software dependencies might exist without
being mentioned explicitly in this document.
8
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
2.1 Prerequisites
2.1.1 Prerequisites for Integration between SAP AIN and SAP EAM
Component Description
SAP ERP Central Component • ERP EHP 6 and above
• Not applicable for S/4 HANA releases
Roles in SAP Asset
Intelligence Network
Group AIN_ORG_ADMIN has the following predefined roles:
• AIN_ORG_ADMIN
• AIN_ORG_DATA_EXPERT
• AIN_ORG_DATA_READ
2.1.2 Important SAP Notes
You must read the following SAP Notes as it contains the most recent information as well as any necessary
corrections.
Make sure that you have the up-to-date version of each SAP Note, which you can find on the SAP Service
Marketplace at http://service.sap.com/notes.
SAP Note
Number
Component Title
2382303 CA-AIN-PM AIN-EAM Integration Overview
2327152 CA-AIN-PM Linking of EAM objects to AIN Models
2366582,
2417919
CA-AIN-PM Display of AIN model information in EAM side panel
2405095 CA-AIN-PM Common objects for AIN-EAM Release 2.0
2413805 CA-AIN-PM AIN Equipment Creation and Synchronization for
EAM Objects
2422598 CA-AIN-PM Document Creation and Synchronization
2405074 CA-AIN-PM AIN Announcement Processing in EAM
2382489 CA-AIN-PM AIN Authentication Client Certificates
2526795 CA-AIN-PM Preparatory note for AIN-EAM Integration Release
3.0
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 9
SAP Note
Number
Component Title
2487706 CA-AIN-PM AIN Authentication-OAuth 2.0
2488386 CA-AIN-PM Common objects for AIN-EAM Release 3.0
2487705 CA-AIN-PM Replicate Work orders from EAM to AIN
2485457 CA-AIN-PM AIN Equipment Creation and Synchronization for
EAM Objects- Background Mode
2552580 CA-AIN-PM Common objects for AIN-EAM Release 4.0 - Batch 1
2552577 CA-AIN-PM Document Creation and Synchronization - Version 2
2568695 CA-AIN-PM Common objects for AIN-EAM Release 4.0 - Batch 2
2553257 CA-AIN-PM AIN Equipment Creation and Synchronization for
EAM Objects - Version 2
2568696 CA-AIN-PM Replicate Notifications from EAM to AIN
2.2 Authentication Between SAP ERP and SAP AIN
You can use the client certificate or OAuth 2.0 for authentication between SAP AIN and SAP ERP systems.
Note: OAuth 2.0 is not applicable for SAP ERP EHP 6 release.
2.2.1 Client Certificate
You use the SSL certificate for authentication between the SAP AIN application on SAP Cloud Platform and SAP
ERP. For SAP AIN authentication, you use the entire certificate comparison mapping mode. This requires a
keystore containing the ERP client certificate that will be uploaded into the SAP Cloud Platform account. SAP
Cloud Platform supports multiple mapping modes that define how the received client certificate is interpreted.
This setup involves the following steps:
1. Upload root CA of the SAP Cloud Platform server certificate in the SAP ERP system
2. Map client certificates at SAP Cloud Platform side
3. Manage keystore in SAP Cloud Platform
4. Export client certificate from the SAP ERP system
5. Maintain AIN system information in SAP ERP
10
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
Prerequisites
• Authorization in ERP
The ERP system user should have authorization for the following transactions:
o STRUST: To upload a certificate
o SM59: To create an RFC destination
• Authorization in HCP
o The SAP Cloud Platform user should have the admin role to perform SAP Cloud Platform activities such
as uploading the key store using console commands
o See also:
https://help.hana.ondemand.com/help/frameset.htm?0d7cf63b75a94f869895186a2d38db41.html
o SAP Note 2382489
2.2.2 OAuth 2.0
The authentication between SAP ERP system and SAP Asset Intelligence Network application on SCP can occur
through OAuth 2.0 client.
You can perform the following the steps to set up the authentication:
1. Upload Root Certificate Authority (CA) of the SCP Server Certificate to the SAP ERP system
2. Register OAuth 2.0 Client in SAP Asset Intelligence Network Tenant
3. Create OAuth Client Profile in SAP ERP
4. Configure OAuth Client in SAP ERP
5. Request OAuth 2.0 Access token
2.2.2.1 Authorizations
2.2.2.1.1 Authorizations in SAP ERP
You must have authorization for the following transactions to perform the following activities on SAP ERP.
• STRUST (To upload a certificate)
• SM59 (To create a RFC destination)
• SE80 (To create OAuth 2.0 client profile)
• OA2C_CONFIG (To configure OAuth 2.0 Client)
• OA2C_GRANT (To Request OAuth 2.0 Access token)
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 11
2.2.2.1.2 Authorization in SAP Cloud Platform
The SAP Cloud Platform user should have the admin role to create or register a new OAuth 2.0 Client.
2.2.2.2 Steps
1. Upload Root CA of the SAP Cloud Platform Server Certificate to the SAP ERP system.
To upload the root CA of the SAP Cloud Platform server certificate to the SAP ERP system, follow these steps:
1. Import the root CA of the SAP Cloud Platform server certificate from the browser by launching any of the
SAP AIN SCP applications.
12
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
1. Choose Baltimore CyberTrust Root and click View Certificate.
2. Click Copy to File to export the certificate.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 13
Note:
Alternatively,
root CA
certificate
(Baltimore
CyberTrust
Root) can be
exported from
Internet
Explorer by
navigating to
Menu Tools ->
Internet
Options ->
Choose
Content Tab -
> Certificates-
> Choose
Trusted Root
Certification Authorities.
14
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
2. The SAP Cloud Platform root CA certificate can be uploaded to the SAP ERP system via transaction code
STRUST.
1. Choose the PSE (SSL client) which will be used for SSL communication between SAP ERP and SAP
Cloud Platform.
2. Import the above downloaded SAP Cloud Platform root certificate into the selected PSE.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 15
3. Add the imported certificate to the list.
16
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
4. Save the PSE changes.
2. Register OAuth 2.0 Client in AIN Account:
A new OAuth Client needs to be registered to access the SAP Asset Intelligence Network application from
SAP ERP via OAuth based authentication.
Procedure:
• A new OAuth 2.0 client can be registered via SAP Cloud Platform cockpit.
• Logon to SAP Cloud Platform cockpit and select the SAP Asset Intelligence Network account.
• Navigate to Security -> OAuth Section, go to the Clients tab.
• Choose Register new client.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 17
• Enter the following client data as required.
Field Description
Name The client name.
Description A free-text description of the client.
Subscription
Choose the SAP Asset Intelligence Network application which is subscribed from the
provider account.
ID
Required. The ID of the client authorized to access the resource server running on SAP Cloud
Platform. If you already have a client with a defined ID at the client device, enter its value
here. Otherwise, you can choose Generate ID and Secret to use a system-generated ID, or
enter a custom value. In that case, you must provide that value to the user of the client
device. Note: The client ID must be globally unique within the entire SAP Cloud Platform.
Confidential
Check/Mark this box, the client ID will be protected with a password. You will need to supply
the password here, and provide it to the ERP client while configuring.
Secret
A secret (password) that allows the authorization server to authenticate before the client on
behalf of the resource owner (user). It will also be needed by the ERP OAuth client.
Redirect URI
The application URI to which the authorization server will connect the client with the
authorization code. This can be picked from the ERP system while configuring the OAuth
client.
Token Lifetime The token lifetime. This value applies to the access token and authorization code.
Refresh Token
Lifetime The refresh token lifetime.
18
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
• Save the client.
Please refer to the below SCP help portal link for details.
https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-
US/7e658b3e4cea4a79b035d0f1d2798c1f.html#loio61d8095aa39547c7b30d9aeda771497f
3. Create OAuth 2.0 Client Profile in SAP ERP:
A new OAuth 2.0 Client Profile is required to connect the SAP ERP system with the SAP Asset Intelligence
Network system.
Procedure:
• Start the object navigator (transaction SE80).
• Choose a development package under which the Client Profile need to be created.
• To create the Client Profile, right click and then choose Create > More > OAuth 2.0 Client Profile in the
context menu of the object name.
• Enter the object name in the Client Profile field of the popup.
• Choose the type of the service provider as HANA_CLOUD_PLATFORM.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 19
• Save your OAuth 2.0 client profile.
Providing OAuth 2.0 scope information is optional. This is required only if the scope is defined in the Provider
account of the AIN tenant.
Please refer to the below SCP help portal link for details.
https://help.sap.com/viewer/3c4e8fc004cb4401a4fdd737f02ac2b9/7.5.6/en-
US/76cb524e55b0492db48d4468876f6ddc.html
4. Configuring an OAuth 2.0 Client in ERP:
The OAuth 2.0 Client in SAP ERP system need to be configured with the OAuth client information of the SAP
Asset Intelligence Network system.
Procedure:
• Start transaction OA2C_CONFIG (OAuth 2.0 Clients).
• To create an OAuth 2.0 client, choose Create.
A popup with the configuration UI appears.
• Choose the OAuth 2.0 client profile you created earlier. The OAuth 2.0 client profile already contains the
service provider type.
20
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
• Enter the OAuth 2.0 client ID and choose OK. The Client ID should be the ID of the SAP Asset Intelligence
Network OAuth client.
• Provide the Client secret password which is provided while registering a new OAuth client in SAP Asset
Intelligence Network account.
• Choose Grant Type as “Authorization Code”.
• Adjust the Authorization and token endpoints by providing the SAP Asset Intelligence Network account ID.
This can also be copied from the OAuth section of SAP Cloud Platform Cockpit. (Account => OAuth =>
Branding => OAuth URLs)
Make sure that the “https://” prefix is removed from the URL in the OAuth 2.0 Client Configuration.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 21
• The redirect URI available here should be copied and maintained as the redirect URI of the registered SAP
Asset Intelligence Network OAuth client.
• Save your changes.
• Please refer to the below SAP Cloud Platform help portal link for details.
https://help.sap.com/viewer/3c4e8fc004cb4401a4fdd737f02ac2b9/7.5.6/en-
US/2e5104fd87ff452b9acb247bd02b9f9e.html.
5. Requesting OAuth 2.0 Access token:
To authorize the SAP ERP system to access the SAP Asset Intelligence Network endpoints, request an OAuth
2.0 access token need to be requested.
Procedure:
• Start transaction OA2C_GRANT (OAuth 2.0 Configuration).
• Choose the OAuth 2.0 client you created earlier and clink on Request OAuth 2.0 Tokens.
• The end user’s browser will be now redirected to the authorization endpoint of the SAP Asset Intelligence
Network Authorization server. (End user should authenticate the Authorization endpoint by providing SAP
Asset Intelligence Network login credentials.)
• Click on Authorize to so that the Access token can be granted from SAP Asset Intelligence Network.
• Once the end-user gives his consent and authorizes the clients request, the browser will be redirected back to
the AS ABAP and the OAuth 2.0 Authorization Code flow is completed.
22
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
Please refer to the below SCP help portal link for details.
https://help.sap.com/viewer/3c4e8fc004cb4401a4fdd737f02ac2b9/7.5.6/en-
US/0b5cbbddd1e741f39dcb7dcc0ef13c51.html.
6. Maintaining SAP Asset Intelligence Network system Information in SAP ERP:
To maintain SAP Asset Intelligence Network system information:
1. Create a new RFC destination via transaction code SM59 using the following details:
Name: AIN_CONNECTION
Connection type: G (HTTP Connection to External Server)
Target host: AIN system host details. i.e. Java Application URL
e.g. --------.hana.ondemand.com
2. Under Security Options, set SSL to Active and choose the relevant SSL certificate from the certificate list.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 23
7. General/Global Configuration Settings:
The following general settings must be defined in SAP ERP system to enable OAuth 2.0 Authentication
between SAP ERP system and SAP Asset Intelligence Network system:
Transaction code: SM30
Table/View Name: AIN_V_GEN_CONFIG
Config Name Value/Description
AIN_AUTHENTICATION_MODE OAUTH
AIN_OAUTH_PROFILE Name of the created OAuth 2.0 Client profile
24
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
2.3 Assumptions and Implementation Considerations
2.3.1 Authorization in SAP EAM
The code delivered by SAP does not check any authorizations. It is the sole responsibility of the customer or
partner to have their own authorizations assigned to the program.
Note
You will find information on specific prerequisites and roles in the relevant sections.
2.4 Link SAP EAM Object to SAP AIN Model
2.4.1 Master Data Prerequisites
You must create classes and characteristics to be able to display details for the SAP AIN models linked to SAP
EAM objects.
Note
If classification is already being used, then the ability to have multiple classes per EAM object must be
allowed. For more information, refer to IMG node Classification System Maintain Object Types and
Class Types. The checkbox Multiple classification must be checked.
2.4.1.1 Characteristics and Classes
• Create a characteristic group for SAP_AIN and assign them to classes
• Define a class for both class types 002 Equipment and 003 Functional Location.
Note
See SAP Note 2327152
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 25
2.4.2 Link EAM Objects to AIN Models
1. Execute program AIN_MODEL_MAPPER. This can be done from the transaction AIN_MAPPER or alternatively
via SE38/SA38.
The program allows mapping of either equipment or functional locations.
2. If choosing equipment (or functional locations) then the list of objects to be mapped should be limited using
the selection options of:
• Equipment Number /(Functional location)
• Maintenance plant
• Valid from Date
3. The checkbox Skip AIN Linked Objects means that the program will exclude any object that already has a
mapping to an AIN model.
4. The checkbox Match based on Construction Type means that the program will also select potential matches
based on the construction type material.
• By default, the Construction material type is HERS but other material types, for example, a customer-specific
type can be used.
The program attempts to determine potential AIN model matches for the EAM objects in AIN and then allows the
user to select the best match and to create the link between the EAM object and the AIN model (by adding
classification details to the EAM object).
2.4.2.1 Matching Logic
This program will utilize the following two matching methods:
• Match on construction type
• Match on EAM object manufacturer and model number
2.4.2.1.1 Match on Construction Type
If the checkbox Match based on Construction Type is selected, then the program will attempt to find a matching
model in AIN based on the manufacturer part number and the vendor name from the construction material.
2.4.2.1.2 Match on EAM Object Manufacturer and Model No.
In this matching process, the manufacturer and model number from the EAM object is used. If there are no model
details, then no attempt to match will occur. However, if the model is provided but the manufacturer is not, then
an attempt to find a matching AIN model will occur.
26
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
2.4.2.2 Edit or Delete a Link Between EAM Object and AIN Model
The link can only be deleted by using the mapping program, since the classification information is used only to
show the user to which AIN object the object is mapped.
Alternatively, if the mapping needs to be changed, the program can be run again, a different match chosen and a
new link created. This will remove the existing match and classification details.
Note
If the link is deleted, it will also remove the link to the relevant document management system record for
the model.
2.5 Display SAP AIN Model Information in SAP EAM Side Panel
The side panel can be used to display additional context-sensitive information for existing transactions in a
separate screen area without modifying the corresponding transaction.
The delivered side panel will display information for linked AIN models.
Please refer to the below note for the implementation of this functionality.
o SAP Note 2382489
o SAP Note 2417919
See also:
o http://scn.sap.com/community/erp/blog/2013/02/25/side-panel-for-sap-business-suite
o http://scn.sap.com/community/netweaver-business-client/blog/2013/11/21/nwbc-side-panel-demo-
combining-a-sap-gui-transaction-with-an-html5-based-fpm-chart-guibb
2.5.1 Authorization in SAP AIN
The authentication user (RFC user) should have model read access in AIN so that the user can access the model
search API from EAM.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 27
2.5.2 Authorization in SAP EAM
The SAP EAM user should have the role SAP_AIN_MODEL_DETAILS (or equivalent) to view the side panel content
from the NetWeaver business client (NWBC).
2.5.3 View SAP AIN Model Information in SAP EAM Side Panel
The AIN model side panel can be displayed in the following objects using the following:
Function Transaction ID
Change equipment IE02
Display equipment IE03
Change functional location IL02
Display functional location IL03
Change Service notification IW52
Display Service notification IW53
Change Maintenance notification IW32
Display Maintenance notification IW33
Change work order IW32
Display work order IW33
Note
For visual enterprise (.vds) files the Visual Enterprise Viewer needs to be installed. The Visual Enterprise
Viewer is available from the SAP Store.
2.6 AIN Equipment Creation and Synchronization for EAM Objects
The SAP EAM Equipment or Functional location that needs to be synchronized to SAP AIN can be performed
using this application.
28
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
2.6.1 Setup and Configurations
2.6.1.1 Global Configuration Settings
The following SAP AIN integration general settings must be defined for the equipment creation or synchronization
functions.
Execute transaction SM30 and Table/View Name AIN_V_GEN_CONFIG
Setting Value or Description
AIN_RFC_NAME RFC as configured for the AIN destination system
AIN_FLP_URL AIN Fiori Launchpad URL
AIN_ERP_SYSTEM_NAME ERP system name as defined in the AIN Applications Setting,
Systems section. Used to define the External ID for an AIN
equipment record.
AIN_LEAN_EQUIPMENT Value – “X” or “Blank”
If set (“X”) then the user has the option of creating lean
equipment records in AIN (Equipment records with no model).
If not set (Blank) then user will not get this option.
AIN_SYNC_HIERARCHY Value – “X” or “blank”
Defines whether the AIN Equipment Component Hierarchy is to
be synchronized with EAM.
AIN_HIERARCHY_MASTER Value – “EAM” or “AIN”
Defines whether the EAM or AIN is the master system for the
synchronization of the component hierarchy.
AIN_EQUI_SOURCEBPROLE Defines the source business partner role of the equipment
Possible values are:
1 - For my operations
2 - For Service
3 - For Customer
From plant maintenance integration perspective, it’s always
treated as “For my operations”.
AIN_EQUI_LIFECYCLE Defines whether the AIN equipment is actual or planned.
Possible Values are
1 - Planned
2 - Actual
From plant maintenance integration perspective, it’s always
treated as Actual equipment.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 29
2.6.1.2 Mapping Configuration
The mapping configuration defines the mapping between the SAP AIN equipment record and SAP EAM technical
objects (Equipment and Functional Locations) for the AIN Equipment header information and the AIN Equipment
attributes (for both Model and Equipment templates).
To execute this, use view cluster AIN_VC_TMPL_MAP via transaction code AIN_EQUI_CONFIG.
2.6.1.2.1 Equipment Header Mapping
You use this for:
• Mapping of the AIN Equipment object header fields to EAM object fields.
• Separate mapping for EAM equipment and EAM functional location object.
Master system for the mapping fields can be defined. This determines the flow of the value during
synchronization.
• Overwrite AIN => Yes. EAM acts as Master and the value flow is from EAM to AIN.
• Overwrite EAM => Yes. AIN acts as Master and the value flow is from AIN to EAM.
The Equipment Header mapping is a mandatory configuration to create AIN Equipment and below is the default
Mapping configuration considering EAM as master. This can be changed by the operator accordingly.
Object Type AIN Field Name EAM Structure
Name
EAM Field
Name
Overwrite
EAM
Overwrite
AIN
Equipment BUILDDATE BAPI_ITOB ACQDATE No Yes
Equipment DESCRIPTION-
SHORT
BAPI_ITOB DESCRIPT No Yes
Equipment INTERNALID BAPI_ITOB_PARMS EQUIPMENT No Yes
Equipment SERIALNUMBER BAPI_ITOB MANSERNO No Yes
Functional
Location BUILDDATE BAPI_ITOB ACQDATE No Yes
Functional
Location
DESCRIPTION-
SHORT BAPI_ITOB DESCRIPT No Yes
Functional
Location INTERNALID BAPI_ITOB_PARMS FUNCLOC_INT No Yes
Functional
Location SERIALNUMBER BAPI_ITOB MANSERNO No Yes
30
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
The Equipment create public API from AIN is used to create an AIN equipment from EAM and the payload fields of
the API should be mapped with the corresponding EAM BAPI structure fields.
The mapping is to the fields of the structures are as follows:
• BAPI_ITOB_PARMS, BAPI_ITOB and BAPI_ITOB_EQ_ONLY for Equipment
• BAPI_ITOB_PARMS, BAPI_ITOB and BAPI_ITOB_FL_ONLY for Functional Locations.
For more details of the fields supported please see the details of these structures.
• The BAPI’s BAPI_EQUI_GETDETAIL and BAPI_FUNCLOC_GETDETAIL are used to fetch the EAM object
information and the above-mentioned structures are part of these BAPI’s.
Note:
Serial number is mandatory for creation of equipment in AIN from EAM objects. Mapping to the AIN Serial
No. field is required and entry in the EAM object field is mandatory.
2.6.1.2.2 Model Templates
This section is used for mapping of AIN model templates to:
• EAM Equipment Characteristics
• EAM Functional Location characteristics
• Providing a default AIN equipment template for an AIN model template.
The AIN model templates can be imported using the program AIN_TEMPLATES_PULL (using transaction SE38).
Alternatively, you can manually enter the entries for the template.
Equipment Characteristics Mapping
You use this for mapping of model template attributes to EAM equipment characteristics. Once the template is
imported, you can define the mapping for the AIN attribute to the relevant EAM class and characteristic.
For more details on the considerations and limitations on the mapping of AIN attributes to EAM characteristics,
see the AIN Attributes and EAM Characteristics Mapping section.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 31
The mapping of a characteristic will cause the value in EAM to be overwritten from the model in AIN.
Functional Location Characteristics Mapping
You use this for mapping model template attributes to EAM functional location characteristics. Once the template
is imported, the user can define the mapping for the AIN attribute to the relevant EAM classification and
characteristics.
The mapping of a characteristic will cause the value in EAM to be overwritten from the model in AIN.
32
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
Default Equipment Template
This configuration allows the User to define a default AIN equipment template for an AIN model template. If no
default equipment template is mapped, then, the user will need to select the relevant Equipment Template in AIN
for the copied Equipment records.
The value help for the Equipment Template will display all AIN Equipment Templates, for which there has been a
successful import.
2.6.1.2.3 Equipment Templates
You use this for mapping of AIN equipment templates to:
• EAM Equipment Characteristics
• EAM Functional Location characteristics
The AIN equipment templates can be imported using the program “AIN_TEMPLATES_PULL” (using transaction
SE38). Alternatively, the entries for the template can be manually entered.
Equipment Characteristics Mapping
You use this for mapping AIN equipment template attributes to EAM equipment characteristics. Once the
template is imported, the User can define the mapping for the AIN attribute to the relevant EAM class
and characteristic.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 33
The user can define whether the AIN or the EAM system is the master. If the AIN system is to be the master, then
the setting “Owrite EAM” should be used or if the EAM system is to be the master, then the “Owrite AIN” should
be used. This can be defined at each attribute independently. This means for some attribute values, the AIN
system can be the master and for others the EAM system can be the master.
Functional Location Characteristics Mapping
You use this for mapping AIN Equipment template attributes to EAM functional location characteristics. Once the
template is imported, the user can define the mapping for the AIN attribute to the relevant EAM classification and
characteristics.
The user can define whether the AIN or the EAM system is the master. If the AIN system is to be the master, then
the setting “Owrite EAM” should be used or if the EAM system is to be the master, then the “Owrite AIN” should
be used. This can be defined at each attribute independently (i.e. For some attribute values, the AIN system can
be the master and for others the EAM system can be the master).
34
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
2.6.1.3 Managing Differences Between the Two Systems
It is required to understand the differences between the mapping of AIN attributes to EAM Characteristics. The
below table explains how these differences are handled.
AIN Attribute Type Supported
(Yes/No)
Comment
Boolean Yes Must be mapped to “characteristic with data type
“Character format” with values “True” and “False”
Date Yes Supported.
Enum Yes With AIN Enum attributes, the values in the AIN attribute
must also be in the EAM characteristic with the same
characteristic value.
Multiple values are supported if the EAM characteristic is
also defined as allowing multiple values.
Numeric Yes For numeric attributes the ISO code is used in matching
UoM at time of copying values between AIN/EAM.
For the AIN numeric values that store multiple values
such as:
Min/Max or Min/Max/Normal
“x at y”
The mapping in EAM is to multiple characteristics (One
per “value” to be stored. Example, Min/Max would
require two characteristics). The “value type” field in the
mapping is used to identify the specific AIN value as
shown below.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 35
ECC Characteristic
Type
Supported
(Yes/No)
Comment
Currency Yes Must be mapped to an AIN Currency attribute type.
The ISO currency code is used in matching currency at
time of copying values between AIN/EAM.
Character Yes In AIN string is 256 characters, in ECC Characteristics
have a maximum of 30 characters. Hence the first 30
characters only will be supported in ECC.
Date Yes Supported
Time No Not supported as no equivalent AIN attribute type.
Numeric Yes For numeric attributes the ISO code is used in
matching UoM at time of copying values between
AIN/EAM.
Custom No Custom data types for characteristics are not
supported.
Note
ISO Codes should be maintained for the UoMs and currency codes in ERP system. Values are case
sensitive.
2.6.2 Master Data Prerequisites
In addition to the creation of the necessary program elements, there are some prerequisite classes and
characteristics that must be created. These are used to store details of the linked AIN model against the EAM
objects. The following class and characteristics must be defined:
2.6.2.1 Characteristics
Characteristic Description Valid from Data Type Number of
characters
Value
Assignment
Case
Sensitive
SAP_AIN_01 AIN: Model 01.04.2016 Character
format
30 Single Value Yes
SAP_AIN_02 AIN:
Manufacturer
01.04.2016 Character
format
30 Single Value Yes
36
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
Characteristic Description Valid from Data Type Number of
characters
Value
Assignment
Case
Sensitive
SAP_AIN_03 AIN:
Equipment
01.04.2016 Character
format
30 Single Value Yes
Note
We recommend that a characteristic group of “SAP_AIN” be created and allocated to the characteristics
to assist with management of the AIN characteristics.
2.6.2.2 Classes
For both class types 002 Equipment and 003 Functional Location a class must be defined as shown below.
Class name Description Valid from Same Classification
ZSAP_AIN SAP AIN class for linking EAM to AIN 01.04.2016 Do not check
For the class the flowing characteristics must be assigned:
Characteristic Description
SAP_AIN_01 AIN: Model
SAP_AIN_02 AIN: Manufacturer
SAP_AIN_03 AIN: Equipment
Note
We recommend that a class group of “SAP_AIN” be created and allocated to the classes to assist with
management of the AIN classes.
2.6.3 Import of AIN Model or Equipment Templates
Execute program AIN_TEMPLATES_PULL sing the transaction SE38 or SA38. The program can be used to import
the model and equipment templates from AIN to the EAM. The selection screen is shown below.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 37
The complete template attribute information gets imported from AIN and the mapping entries for Equipment and
Functional location gets created. You can map the AIN attribute and the EAM Characteristics for EAM Equipment
and Functional Location individually using the configuration transaction AIN_SYNC_CONFIG. The mapping will be
done during the creation and synchronization of AIN Equipment.
In execution, the program uses the AIN API’s to import the template information. As a result, the following import
log screen will be presented to the user.
2.6.4 Equipment Creation and Synchronization
Execute the program AIN_EQUIPMENT_MAPPER using transaction AIN_EQUI_SYNC. Alternatively, you can use
transaction SE38 or SA38.
You use this program to create and synchronize the AIN Equipment based on EAM Equipment or Functional
Location. The selection screen is shown below.
38
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
The program is designed to be run online and you can select either Equipment or Functional location. Both
technical objects are always created as “Equipment” in AIN. The following screen is displayed once the selection
screen is executed.
Below are options or buttons available in the Equipment Creation and Synchronization program.
Link Model
The Link Model button can be used to link the selected EAM technical object (Equipment or Functional location) to
an AIN Model.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 39
Propose Equipment:
Propose Equipment does a search in AIN to find out relevant/matching Equipment based on the selected search
field and the results are proposed as “AIN Equipment ID”.
Currently, search can be performed based on one of the below AIN fields.
• Internal ID
• Serial Number
The search functionality looks for a 100% match based on the mapping configuration. The mapping between the
AIN and EAM fields will be picked from the Equipment Header Mapping configuration.
Link Equipment
The Link Equipment button can be used to link the selected EAM technical object to an existing AIN Equipment.
The following activities takes place during the linking process:
• AIN Equipment ID will be updated in the classification of the EAM technical object.
• EAM technical object ID will be set as External ID of the AIN Equipment.
• AIN model attributes will be copied to EAM technical object characteristics based on the Model template
mapping configuration.
• EAM technical object characteristics will be copied to/from the AIN Equipment attributes based on the
Equipment template mapping configuration.
Delink Equipment
The Delink Equipment button can be used to remove the link between the EAM technical object with an already
transferred or linked AIN Equipment.
The following activities will happen during the delinking process:
• AIN Equipment ID will be removed from the classification of the EAM technical object.
• External ID of the AIN Equipment holding EAM technical object will be removed.
Create Equipment
The Create Equipment button can be used to create the equivalent AIN Equipment from the selected EAM
technical objects. This will use the Equipment header mapping and Template mapping configurations to identify
the source for the data during creation process.
The following activities takes place during the creation process:
• AIN Equipment is created based on the EAM technical object considering all the configurations.
• EAM technical object ID is set as External ID of the AIN Equipment.
40
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
• AIN model attributes are copied to EAM technical object characteristics based on the model template
mapping configuration.
• EAM technical object characteristics are copied to the AIN equipment attributes based on the equipment
template mapping configuration.
• Lean Equipment (equipment without link to model) creation is supported. The AIN Equipment is set to
Published. The logging is enabled for the Equipment create action.
Synchronize Data
The Sync data button can be used to synchronize the data between the two systems for already linked / created
Equipment based on the various mapping configurations. This button will also synchronize the Equipment
hierarchy between the two systems, if the global configuration allows this.
The following activities takes place during the synchronization process:
• Equipment header information will be updated from AIN to EAM or EAM to AIN based on the header mapping
configurations.
• AIN model attribute changes will be updated to EAM technical object characteristics based on the Model
template mapping configuration.
• Equipment specific characteristics/attributes will be updated from AIN to EAM or EAM to AIN based on the
Equipment template mapping configuration.
• Equipment Hierarchy gets synchronized from AIN to EAM or EAM to AIN based on the global configuration
setting.
The AIN Equipment should be in Published state to run the synchronization process. The data between the two
systems are compared and the update will happen only if change identified. A new revision of AIN Equipment
created to update changes from EAM. The logging is enabled for the Equipment synchronization action.
View Log
The View Log button can be used to view the log of the Equipment creation and synchronization action. The SLG1
log is fetched for the selected EAM technical object AIN_INT and sub-object: EQUI
2.7 Document Creation and Synchronization
This allows you to replicate the relevant AIN model documents to the on premise system and the EAM Equipment
documents to the AIN system.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 41
AIN Model documents from AIN to EAM
The AIN model documents get copied from AIN to EAM. A DMS record will be created for each AIN model, the
documents stored against the DMS record and this DMS record will be linked to the relevant EAM objects.
EAM Equipment documents from EAM to AIN
The EAM Equipment documents gets copied from EAM to AIN. A new document will be created in AIN for each file
and this will be linked to the relevant AIN Equipment.
AIN Equipment documents from AIN to EAM
The AIN equipment documents are copied from AIN to EAM. A DMS record will be created for each AIN
equipment, the documents are stored against the DMS DIR record and the DIR record will be linked to the relevant
EAM objects.
Prerequisites and Required Configurations
The following configuration and master data setup is required for documents synchronization between AIN and
EAM:
• Global Configuration Settings
• Mapping of DMS Doc Type to AIN Document Category
• Characteristics and class for the DMS records
2.7.1 Global Configuration Settings
The following AIN integration general settings must be defined using transaction SM30 for the document creation
or synchronization functionality to operate:
Table or View Name: AIN_V_GEN_CONFIG
Setting Value/Description
AIN_MODEL_DMS_TYPE DMS Document Type to be used for the AIN model documents DIR.
AIN_EQUI_DMS_TYPE DMS Document Type to be used for the AIN equipment documents
DIR.
AIN_DMS_STORAGE_TYPE Value – “DMS_C1_ST”. DMS storage category for storing the AIN
model documents.
AIN_DEFAULT_LANGUAGE Value – “en”. The default language will be used while creating a
document in AIN.
42
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
2.7.1.1 DMS Document Type
New document types can be created to store the AIN model documents and AIN Equipment documents or
existing types can be used. It is recommended to have a new document type as “AIN” for model documents and
“AEQ” for equipment documents so that the AIN specific documents can be stored in separate doc types.
Define a new document type AIN/AEQ under “Define document types” using IMG Cross Application
Components Document Management Control Data.
2.7.2 Mapping of DMS Doc Type and AIN Doc Category
The mapping between the DMS Doc type and the AIN Doc Category required for the document creation in AIN
must be defined using transaction SM30 and table or view name AIN_V_DOC_CONFIG
2.7.3 Characteristics and Class
The classes and characteristics that must be created as these are used to store details of the linked AIN model
against the DMS objects.
The following class and characteristics must be defined:
2.7.3.1 Characteristics
The following characteristics must be defined. See also, SAP Note 2327152 Linking of EAM objects to AIN Models
Characteristic Description Valid From Data Type Number of
characters
Value
Assignment
Case
Sensitive
SAP_AIN_01 AIN: Model 01.04.2016 Character
format
30 Single
Value
Yes
SAP_AIN_02 AIN:
Manufacturer
01.04.2016 Character
format
30 Single
Value
Yes
SAP_AIN_03 AIN:
Equipment
01.04.2016 Character
format
30 Single
Value
Yes
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 43
Note
We recommend that a characteristic group of “SAP_AIN” be created and allocated to the characteristics
to assist with management of the AIN characteristics.
2.7.3.2 Classes
For both class type 017 Documents a class must be defined:
Class Name Description Valid from Same Classification
ZSAP_AIN SAP AIN class for linking
DMS rec to AIN
01.04.2016 Do not check
Assign the following characteristics to the class:
Characteristic Description
SAP_AIN_01 AIN: Model
SAP_AIN_02 AIN: Manufacturer
SAP_AIN_03 AIN: Equipment
Note
We recommend that a class group of “SAP_AIN” be created and allocated to the classes to assist with
management of the AIN classes.
2.7.4 Create and Synchronize Documents
The program to create or synchronize the documents can be executed using transaction AIN_DMS using
transaction SE38, program AIN_DMS_PULL. The program copies document attachments from AIN to EAM or AIN
to EAM.
The following selection screen is displayed.
44
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
The program is designed to be run online and allows selection based on either equipment or functional locations.
If choosing equipment (or functional locations) then the list of objects to be mapped should be limited using the
selection options of:
• Equipment Number
• Maintenance Plant
• Valid From Date
The AIN public API’s are used to read, write, assign and un-assign documents from/to AIN. The program has two
options in the selection screen:
Pull Model Documents from AIN
The EAM technical object must have a link with the AIN Model. The program determines the documents attached
to the latest published version of the linked model. It then creates a new DMS record or compare these to any
that may have already been created and load the delta. This means it may create new documents, update
documents or remove documents. The DMS record will be then linked to the EAM object that is linked to that AIN
model.
Pull Equipment Documents from AIN
The EAM technical object must have a link with the AIN Equipment. The program determines the documents
attached to the latest published version of the linked equipment. It then creates a new DMS record or compare
these to any that may have already been created and load the delta. This means it may create new documents,
update documents or remove documents. The DMS record will be then linked to the EAM object that is linked to
that AIN equipment.
Push Documents to AIN
The EAM technical object must have a link with the AIN Equipment. The program will determine the documents
attached to the EAM object and pushes it to AIN. It will also compare these to any of the existing AIN Equipment
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 45
document that may have already been pushed (i.e. It may create new documents, update existing documents or
removed documents).
The screenshot below shows successful synchronization of documents for object 10012528.
2.7.4.1 Execution of the Program in Background
Initially we recommend that the program be run in foreground. Once it has been correctly run it may be
appropriate to run the program in background on a regular frequency. For example, once per week.
Depending on the number of assets linked to AIN models and the batch window of the system it may be
appropriate to create a number of jobs to complete the updates.
2.8 AIN Announcement Processing in EAM
The Announcements from the AIN models are imported to EAM and the work items are created for the imported
announcements based on the BRF+ ruleset. The BRF+ ruleset determines the number of work items to be created
for an AIN Announcement and the position of the person to whom to send the work item (work item processor)
based on the combination of:
• Announcement Type
• Manufacturer
• Plant
The AIN Model Announcements can only be imported or processed. A separate POWL application is available to
view the AIN Announcement specific work items. The POWL application provides details of the affected models,
equipment, functional location and the announcement documents.
The intention is that the processor can review the announcement work item and then decides as to what may be
required. The processor can either create PM notifications or complete the work item with his comments. The PM
notifications can be created from the AIN Announcement processing view and the permitted notification types
can be configured. The Work Item can be completed once all notifications are completed.
46
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
2.8.1 Global Configuration Settings
The following AIN integration general settings must be defined using transaction SM30 for the AIN Announcement
Processing functionality to operate:
Table or View Name: AIN_V_GEN_CONFIG
Setting Value/Description
AIN_ANNOUNCEMENT_DEFAULT Default/fall back user to be sent Announcement work
items in case of errors with BRF+ setup or where
positions are not filled or persons do not have a valid
User ID (in IT0105, subtype 0001).
2.8.1.1 Maintain PM Notification Type
The PM notifications types to be used for creation PM notification from Announcement processing must be
maintained using transaction SM30 defined in table AIN_V_NOTIF_TYPE.
2.8.1.2 BRF+ Entries
The creation of the Announcement Processing work items is based on the extraction of relevant announcements
from AIN and the utilization of a BRF+ ruleset to determine what work items to create and who to send them to.
The BRF+ application AIN_ANNOUNCEMENTS_WI_RECIPIENT is the basis for this process. The BRF+ work set
needs to have the relevant entries maintained for the organization.
The key points of the use of the work set are that it allows flexibility to determine whom to send an announcement
processing work item based on:
• Type of the announcement (Service Bulletin or Recall)
• Manufacturer of the equipment (as identified for the model in AIN)
• Plant for the equipment for the model(s) included in the announcement
• Position to whom the work item is to be sent.
BRF+ decision table name AIN_DT_ANNOUNCEMENTS
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 47
The entries in the table can be defined such as to allow for business requirements such as:
• All recall-type announcements must be sent to holder of position A or
• All announcements for a particular manufacturer must be sent to holder of position B or
• All announcement for equipment at plant X are to be sent to holder of position Y whilst at plant Z they are to
go to the holder of position W.
2.8.1.2.1 Example Entries for the BRF+ Scenarios
All recall-type announcements must be sent to holder of position A
All announcements for a particular manufacturer must be sent to holder of position B
All announcement for equipment at plant X are to be sent to holder of position Y whilst at plant Z they are to go to
the holder of position W.
48
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
If the BRF+ entries are not maintained or if there is no valid entry found for a particular combination, then the
default user (as defined in the General Settings section) will be used.
The User to send the work item is derived from the position based on the holder of the position and their Infotype
105 (Communication), subtype 0001 (System user name). If there is no holder of the position or the holder’s
personnel record does not have a user-id maintained, then the default user will be used instead.
• Position 500014814;
• Holder of the position is Person 2000 (Albus Dumbledore)
• Employee Record – Infotype 105 (Communication)
• Sub-type 0001
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 49
• Maintain the User ID.
2.8.2 Import Announcements from AIN
Execute the program AIN_ANNOUNCEMENT_PULL using transaction AIN_ANN_PULL or alternatively using
transaction SE38 or SA38. The program can be used to import the AIN model Announcements from AIN to the
EAM. The selection screen is shown below.
50
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
The work items are created for the imported announcements based on the BRF+ ruleset. The BRF+ ruleset is
used to determine the number of work items to be created for an AIN Announcement and the position of the
person to whom to send the work item (work item processor) based on the combination of:
• Announcement Type
• Manufacturer
• Plant
In execution, the program will use the AIN API’s to import the Model Announcements. The following scenarios are
catered for in the program logic:
• New Announcement
• Model(s) in announcement have EAM technical object(s) mapped
Result: New work item created
• Model(s) in announcement do not have EAM technical object(s) mapped.
• Result: No work item created
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 51
Import of existing Announcement
If an Announcement is re-imported, then if there are no changes (i.e. no revision to the announcement has been
made) then no action will be taken.
Revision to Announcement
Change only to Description/Priority/Documents
If the work item(s) are still in progress, then the Recipient will be notified of a change in the announcement via a
message to their work inbox. They will then need to assess the impact of the change.
If the work item(s) are complete then a new work item will be created.
Addition of a Model(s)
If the Model added does not have any impact on the work items that need to be created, then the Recipient will be
notified of a change in the announcement via a message to their work inbox. They will then need to assess the
impact of the change.
52
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
If the Model added does have an impact on the work items to be created, then the new work item(s) will be
created and the new recipient notified.
Removal of a Model(s)
If a model is removed and the work item(s) are still in progress, then the Recipient will be notified of a change in
the announcement via a message to their work inbox. In the case of a work item being solely for the Model
removed from the Announcement then the user will see that the work item now does not have any model
included.
2.8.3 AIN Announcement Processing POWL
The work items created will be available in the workflow inbox of the relevant user as well as in the AIN
Announcement Processing POWL.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 53
From the POWL the user can then process the item (by clicking on the work item ID). The Announcement
processing screen is shown below.
The intention is that the user reviews the change (including using link to the announcement in AIN) and then
decides as to what may be required. A comment is then required in the Assessment/Comment field as shown
below (Note: Work items cannot be closed without a comment).
54
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
The assessment of the impact may mean that some EAM notification(s) are required.
The user can either create a notification without reference to an EAM object by using the “Create PM Notification”
button.
The intention here is that it may be that some broader action is required not specific to a particular item of
equipment.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 55
Note
The notification types available are based on an AIN integration config table.
If more notifications are required, then the process can be repeated. If the user needs to create notifications for
one or more of the affected equipment or Functional Locations, then they can simply select the object that they
wish to create a notification for and then “Equipment/Functional location Notification”.
56
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
A separate notification will be created for each selected EAM object.
The notifications created can be seen on the “EAM Action Details” tab as shown below
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 57
Note
The user can also use the Add button option to create more notifications. If the created notification is not
correct, then it can be cancelled using the Cancel Notification option.
2.8.4 Closing of Announcement Work Items
Announcement work items can only be closed if:
• A comment has been saved and
o There are no outstanding notifications.
• Notifications are outstanding if they are:
o Not completed or cancelled
o Have Work Orders that that are not cancelled or completed (System status is not TECO, DLFL and CLSD)
Work items can either be completed manually or using the transaction AIN_ANN_COMP.
2.8.4.1 Manually Complete a Work Item
From the work item itself ensure the criteria are met to allow the work item to be completed and then press the
“Complete work item” button
58
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
From the POWL select the work item and press the “Complete” button.
2.8.4.2 Automatically Complete a Work Item
Work items can be set to automatically complete using transaction AIN_ANN_COMP
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 59
Enter the appropriate selection criteria and execute. Any work items that can be closed will be closed and for
others explanation of why they cannot be closed will be provided.
2.9 Replicate Work Orders from SAP EAM to SAP AIN system
2.9.1 Value Mapping Configuration:
The SAP ERP on-premise system comes with more customizable/configurable data whereas the SAP Asset
Intelligence Network system comes with the predefined value set. Hence a value mapping is required between
SAP ERP and SAP Asset Intelligence Network system values. The following are customizable fields which requires
value mapping:
• Order Type
• Priority
• Status
Predefined value set in the SAP Asset Intelligence Network system for the above fields:
SAP ERP Customizable
Field Name
Field Description SAP Asset Intelligence
Network Value
Description
ORDERTYPE
Order Type 1 Breakdown
2 Inspections
3 Installation
60
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
4 Planned
5 Disposal
6 Operations
PRIORITY
Priority 5 Low
10 Medium
15 High
20 Very High
25 Emergency
STATUS
Status NEW New
PBD Published
CPT Completed
CSD Closed
The value mapping can be done using the maintenance view AIN_V_VALUE_MAP.
The object type should be selected as Work order and the field name can be one of the field listed above.
The SAP EAM values are customer specific and it can be mapped to one of the above listed SAP Asset Intelligence
Network value.
Transaction code: SM30
Table/View Name: AIN_V_VALUE_MAP
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 61
An example for the value mapping configuration table is shown below for reference.
2.9.2 Replicate Work orders
The program to push the work orders from SAP ERP to SAP Asset Intelligence Network can be executed using the
transaction AIN_ORDER_POST (or using SE38, program AIN_WORKORDER_POST).
The work orders having reference to equipment as reference object will be pushed to SAP Asset Intelligence
Network based on the selection filter. Also, the reference object equipment should have an equivalent SAP Asset
Intelligence Network equipment so that the work orders can be assigned accordingly.
1. In your SAP EAM system, use the transaction AIN_ORDER_POST to open the Selection Criteria for
Workorder Push to AIN
62
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
The selection criteria have got two filter sections:
o Equipment
o Work Order
2. Select/Provide the appropriate inputs and execute the report to push the work orders into AIN.
The following log will display the relevant posting status of the work orders.
The Equipment objects are fetched based on the selection options and then the associated work orders of the
Equipment are fetched based on the work order filter.
The SAP Asset Intelligence Network API’s are used to post and update work orders in AIN. The work order
information like work order number, description, long text, priority, status, order type, start and finish date, time
consumed are pushed from SAP EAM to SAP Asset Intelligence Network.
Execution of the Program in Background
The program can be scheduled as a batch job and it is recommended to run in background.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 63
2.10 Replicate Notifications from SAP EAM to SAP AIN system
2.10.1 Value Mapping Configuration:
The SAP ERP on-premise system comes with more customizable/configurable data whereas the SAP Asset
Intelligence Network system comes with the predefined value set. Hence a value mapping is required between
SAP ERP and SAP Asset Intelligence Network system values. The following are customizable fields which requires
value mapping:
• Notification Type
• Priority
• Status
Predefined value set in the SAP Asset Intelligence Network system for the above fields:
SAP ERP Customizable
Field Name
Field Description SAP Asset Intelligence
Network Value
Description
NOTITYPE
Notification Type M1 Maintenance
M2 Breakdown
PRIORITY
Priority 5 Low
10 Medium
15 High
20 Very High
25 Emergency
STATUS
Status NEW New
PBD Published
CPT Completed
The value mapping can be done using the maintenance view AIN_V_VALUE_MAP.
The object type should be selected as Notification and the field name can be one of the field listed above.
The SAP EAM values are customer specific and it can be mapped to one of the above listed SAP Asset Intelligence
Network value.
Transaction code: SM30
Table/View Name: AIN_V_VALUE_MAP
An example for the value mapping configuration table is shown below for reference.
64
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
2.10.2 Replicate Notifications
The program to push the notifications from SAP ERP to SAP Asset Intelligence Network can be executed using the
transaction AIN_NOTI_POST (or using SE38, program AIN_NOTIFICATION_POST).
The notifications having reference to equipment as reference object will be pushed to SAP Asset Intelligence
Network based on the selection filter. Also, the reference object equipment should have an equivalent SAP Asset
Intelligence Network equipment so that the notifications can be assigned accordingly.
3. In your SAP EAM system, use the transaction AIN_NOTI_POST to open the Selection Criteria for
Notification Push to AIN
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 65
The selection criteria have got two filter sections:
o Equipment
o Notification
4. Select/Provide the appropriate inputs and execute the report to push the notifications into AIN.
The following log will display the relevant posting status of the notifications.
The Equipment objects are fetched based on the selection options and then the associated notifications of the
Equipment are fetched based on the notification filter.
The SAP Asset Intelligence Network API’s are used to post and update notifications in AIN. The notification
information like notification number, description, long text, priority, status, notification type, start and finish date,
malfunction start and end date are pushed from SAP EAM to SAP Asset Intelligence Network.
Execution of the Program in Background
The program can be scheduled as a batch job and it is recommended to run in background.
66
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
3 SAP Asset Intelligence Network with SAP Cloud Platform Internet of Things
You perform this procedure as a prerequisite to configuring external systems, such as SAP Hybris Cloud for
Customer, SAP Cloud Platform Internet of Things with SAP Asset Intelligence Network.
3.1 Configuring HANA Cloud Integration System in SAP Asset Intelligence Network
3.1.1 Prerequisites
o You have the ORG_ADMIN role assigned to your user ID.
o You have access to the HANA Cloud Integration (HCI) account.
o You have the link to access the Integration Flow file.
3.1.2 Procedure
1. Log on to your HCI account.
2. On the HCI landing page, click Discover (icon with spectacles).
3. From the HCI Content Hub, choose the SAP Asset Intelligence Network Integration Scenarios package.
4. Choose AIN IoT Integration for HCP IoT systems. Choose C4C Service Requests Integration for SAP
Hybris Cloud for Customer integration.
5. Click Import.
6. From the HANA Cloud Integration landing page, choose the Design tab.
7. From the Integration Flow Package, choose Actions Deploy .
The Integration_Flow file is deployed to the HCI system.
To check the deployment status, choose the Monitor tab and verify.
8. Log on to SAP Asset Intelligence Network.
9. Launch the Application Settings app.
10. Navigate to Systems Add HCI .
Note: You can configure only one HCI system in SAP Asset Intelligence Network.
11. In the Add System dialog box, fill in the following:
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 67
Field Description
System Type HCI (autopopulated)
System Name Enter a unique system name
System Status Set to Active
URL Information Provide the host URL of the HCI system. For
example: https://cd2ain1-
iflmap.hcisb.hana.ondemand.com/
Additional Information Fill in additional information as necessary
Is System Primary Not relevant for this procedure
12. Choose OK.
You have configured the HCI system in SAP Asset Intelligence Network. In the next steps, you can
configure SAP Hybris Cloud for Customer and SAP HCP IoT systems in SAP Asset Intelligence
Network.
3.2 Maintaining User Credentials
You perform this procedure to maintain user credentials of an external system in HCI.
Note: The credentials name is used while creating external system in AIN.
3.2.1 Prerequisites
You have access to a SAP HANA Cloud Integration (HCI) account.
3.2.2 Procedure
1. Log on to your HCI account.
2. From the HCI landing page, choose Monitor Manage Security Material .
3. Choose Add User Credentials ..
4. In the Add User Credentials dialog box, enter the following:
Field Description
68
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
Name Enter a name denoting the system you are going to
configure. For example: HCP IoT
Description Provide a meaningful description
User Provide the external system ID
Password Provide the external system password
5. Choose Ok.
3.3 Retrieving Links from the Internet of Things Services Cockpit
You perform this procedure to be able to enter the URL information while configuring the SAP Cloud Platform
Internet of Things with SAP Asset Intelligence Network.
3.3.1 Context
Using this procedure, you can retrieve the Remote Device Management Service (RDMS) and Message
Management Service (MMS) links from the Internet of Things Services cockpit.
3.3.2 Procedure
1. Log on to Internet of Things Services Cockpit.
2. Navigate to MyUser About IoT Services .
The SAP HCP Internet of Things Services screen is displayed.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 69
3. Under the section, Device Management API, you can find the RDMS link.
4. Go to the Application Data screen and select OData API.
The link corresponding to Service Root pertains to the MMS link.
Note: You use the preceding links while configuring the SAP Cloud Platform Internet of Things with
SAP Asset Intelligence Network.
70
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
3.4 Configuring External Systems in SAP Asset Intelligence Network
You use this procedure to configure external system in SAP Asset Intelligence Network using Application Settings
app.
3.4.1 Context
For simplicity, this procedure explains configuring SAP Cloud Platform Internet of Things in SAP Asset Intelligence
Network. Use the same procedure to configure other external systems such as SAP Hybris Cloud for Customer.
3.4.2 Prerequisites
o You have the privileges of an organization administrator.
o You have already integrated the external system with SAP Asset Intelligence Network. For details,
see: Admin Guide at www.help.sap.com/ain.
3.4.3 Procedure
1. Log on to SAP Asset Intelligence Network.
2. Launch the Application Settings app.
3. Choose the Systems tab.
4. Choose Add.
5. Choose the external system. For example: SAP HCP IoT.
6. In the Add System dialog box, provide these details:
Field Description
System Name Provide a unique system name
Credential name As provided when you added user credentials to your
HCI account.
System Status Active or Inactive
URL Information URL of the external system.
Note
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 71
While configuring the SAP HCP IoT Services, enter
the RDMS and MMS links. For more information,
you can refer to section 1.3 of this document.
Additional Information If required.
7. Choose OK.
The external system with details is populated in the Systems list in the Application Settings window.
3.5 Mapping Measuring Points with an External System
You perform this activity to retrieve the measuring point values of your equipment from an external system. When
you have equipment data or machine data in an external system, you can retrieve that data by mapping your
equipment to the external system.
3.5.1 Prerequisites
o The external system in question is already configured with SAP Asset Intelligence Network.
o Your user ID either belongs to the group AIN_ORG_ADMIN or AIN_ORG_DATA_EXPERT, or has the
roles EQUIPMENT_DELETE or EQUIPMENT_EDIT assigned to it.
o You have created an item of equipment. For more information, see AIN application Help - Creating an
Item of Equipment.
o You have added Measuring Point as an attribute from the Templates app, and the equipment in
question has inherited this template. For more information, see AIN application Help - Adding
Measuring Point as an Attribute.
3.5.2 Context
In this procedure, you map measuring points of equipment between an external system and SAP Asset
Intelligence Network.
72
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
3.5.3 Procedure
1. Launch the Equipment application.
2. Open the item of equipment in question.
3. Scroll down to the Measuring Points section.
4. Select the relevant measuring point and select Map Measuring Point.
Note: You will see the measuring point item in this section only if you have already added it as an
attribute in the Templates application. For more details, see AIN application Help - Adding Measuring
Point as an Attribute.
5. In the Map Measuring Point window, enter the following:
Field Description
System Name Choose the name of the external system. For
example:
SAP HCP IoT
Machine Name The corresponding equipment name in the external
system.
6. Under the AIN Measuring Points section, select a measuring point and choose the corresponding
measuring point under External System Measuring Points by selecting Map.
7. Choose Save.
You see the new measuring point values appear on the Equipment object page.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 73
4 SAP Asset Intelligence Network with SAP Hybris Cloud for Customer
4.1 Configuring SAP Hybris Cloud for Customer System
You perform this procedure as a prerequisite to configuring external systems such as SAP Hybris Cloud
for Customer, with SAP Asset Intelligence Network.
4.1.1 Prerequisites
You have the administrator role configured to your user in the SAP Hybris Cloud for Customer
system.
4.1.2 Procedure
Integration settings for Contract Services
• Setting up a new system in SAP Hybris Cloud for Customer:
1. Log on to your SAP Hybris Cloud for Customer account.
2. On the landing page, go to Administrator section.
3. Under Integration section, choose Communication Systems.
4. Choose New.
5. In the New Communication System window, enter the following:
Tab Field Description
General ID Provide a unique ID
Host Name Enter Host name
74
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
System Access Type Always maintain as “Internet”
Technical Details Enter your name, e-mail, phone, and fax
System
Instances
Add new-> System instance ID
Preferred Application Protocol
Enter a system instance
Web Services
6. Choose Save.
7. Choose Set to Active from the Actions section.
• Setting up a Communication Arrangement:
1. Log on to your SAP Hybris Cloud for Customer account.
2. On the landing page, go to Administrator section.
3. Under Integration section, choose Communication Arrangements.
4. Choose New.
5. In the New Communication Arrangement window, select a communication scenario Query Contracts from
the list in the Select Scenario.
6. In the Define Business Data page, select a System Instance ID.
Note : System Instance ID should be the same as that you have created earlier.
7. In the Define Technical Data page, enter the following:
Field Description
Communication Method Select a communication method
Application Protocol Always maintain ‘Web Service’
Authentication Method User ID and Password
User ID You can edit your user credentials
8. Review and activate the communication arrangement.
9. You can now view the newly created communication arrangement in the Communication Arrangement
List.
4.2 Maintaining User Credentials
You perform this procedure to maintain user credentials of an external system in HCI.
4.2.1 Prerequisites
You have access to the SAP HCI account.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 75
4.2.2 Procedure
1. Log on to your HCI account.
2. From the HCI landing page, choose Monitor Manage Security Material .
3. Choose Add User Credentials .
4. In the Add User Credentials dialog box, enter the following:
Field Description
Name Enter a name denoting the system you are going to
configure. For example: C4C_USER
Description Provide a meaningful description
User Provide the external system ID
Password Provide the external system password
5. Choose Ok.
4.3 Configuring External Systems in SAP Asset Intelligence Network
You use this procedure to configure external system in SAP Asset Intelligence Network using Application
Settings app.
4.3.1 Context
For simplicity, this procedure explains configuring SAP Hybris Cloud for Customer in SAP Asset Intelligence
Network.
4.3.2 Prerequisites
• You have the privileges of an organization administrator, CONFIGURATION_DELETE or
CONFIURATION_EDIT.
• You have already integrated the external system with SAP Asset Intelligence Network. For details, see: Admin
Guide at www.help.sap.com/ain.
76
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
4.3.3 Procedure
1. Log on to SAP Asset Intelligence Network.
2. Launch the Application Settings app.
3. Choose the Systems tab.
4. Choose Add.
5. Choose the external system of type SAP C4C.
6. In the Add System dialog box, provide the details as listed:
Field Description
System Name Provide a unique system name
Credential Name As provided while adding user credentials in your HCI
account.
System Status Active or Inactive
URL Information URL of the external system.
Additional Information If required.
7. Choose OK.
The external system with details gets populated in the Systems list in the Application Settings window.
4.4 Mapping External IDs for Objects with SAP Hybris Cloud for Customer System
You as an equipment manufacturer are mapping external IDs for an equipment and the corresponding operator
with the SAP Hybris Cloud for Customer system. When you have a registered product existing in SAP Hybris
Cloud for Customer system, you can:
• Create, edit or view the relevant tickets for the corresponding equipment in AIN.
• View the relevant contracts for the corresponding equipment in AIN.
Note:
o Registered product in SAP Hybris Cloud for Customer correspond to equipment to AIN. The serial ID
of the registered product must be mapped to corresponding AIN equipment as External IDs. The SAP
Hybris Cloud for Customer account ID must be mapped in the corresponding AIN company profile as
External IDs.
o In case the equipment owner (Source) is different from the equipment manufacturer in AIN, share the
equipment with the manufacturer of the equipment with “Write” access. In case you need more
information on how to connect with business partners, see Managing your Business Partners. For
more information on sharing equipment, see Sharing Business Objects from Object Pages.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 77
4.4.1 Prerequisites
• The external system in question is already configured with SAP Asset Intelligence Network.
• Your user ID either belongs to the group AIN_ORG_ADMIN or AIN_ORG_DATA_EXPERT, or has the roles
EQUIPMENT_DELETE or EQUIPMENT_EDIT or EQUIPMENT_READ assigned.
Note: The mapping is not supported for lean equipment, where there is no model associated to the
equipment.
4.4.2 Procedure
• The manufacturer of the model associated with the equipment maps the External ID on the equipment.
1. Launch the Equipment application.
2. Open the item of equipment in question.
3. Go to External IDs and choose Add.
4. In the Add External ID window, enter the following:
Field Description
System Name
Choose the name of the c4c system that you have
defined earlier as an external system.
Object Type ‘Registered Product’
External ID Enter a registered product’s Serial ID
5. Choose OK.
You see the new External IDs listed on the External IDs page.
• The Manufacturer of the model associated with the equipment maps the External ID for the equipment owner
(Source) in the company profile.
1. Launch the My Company Profile application.
2. Go to External IDs, choose Add.
3. In the Add External ID window, enter the following:
Field Description
System Name
Choose the name of the c4c system that you have
defined earlier as an external system.
Object Type Not required
External ID Enter the C4C customer account ID of the Source of
the equipment
78
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
4. Choose OK.
You see the new external IDs listed on the External IDs page.
Integration Guide for SAP Asset Intelligence Network
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved. 79
5 SAP Asset Intelligence Network with SAP Hybris Commerce
5.1 Configuring SAP Hybris Commerce as an External System in SAP Asset Intelligence Network
You use this procedure to configure external system in SAP Asset Intelligence Network using Application
Settings app.
5.1.1 Context
For simplicity, this procedure explains configuring SAP Hybris Commerce in SAP Asset Intelligence Network.
5.1.2 Prerequisites
• In SAP Hybris Commerce System
o You have the administrator role configured to your user in the SAP Hybris Commerce system.
o Omni Commerce Connect (OCC) v2 must be enabled.
o Download and unzip the sapjumpinurl addon.
Steps to download the addon:
1. Download file from from https://help.sap.com/http.svc/download?deliverable_id=20575991.
2. Unzip the sapjumpinurl.zip from the downloaded folder.
3. Install the files from sapjumpinurl or __MACOSX
o Note: After downloading the file, you must extract the zip file again.
o Install the addon on SAP Hybris Commerce system using the following command addon installation
procedure: ant addoninstall -Daddonnames="sapjumpinurl" -
DaddonStorefront.yacceleratorstorefront=<enter store front name in the hybris system>
• In SAP AIN system
o You must have the privileges of an organization administrator, CONFIGURATION_DELETE or
CONFIURATION_EDIT.
o You have already integrated the external system with SAP Asset Intelligence Network. For details, see:
Admin Guide at www.help.sap.com/ain.
80
CONFIDENTIAL
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
Integration Guide for SAP Asset Intelligence Network
5.1.3 Procedure
5. Log on to SAP Asset Intelligence Network.
6. Launch the Application Settings app.
7. Choose the Systems tab.
8. Choose Add.
9. Choose the external system of type SAP Hybris.
10. In the Add System dialog box, provide the details as listed:
Field Description
System Name Provide a unique system name
Credential Name As provided while adding user credentials in your HCI
account.
System Status Active or Inactive
URL Information URL of the external system.
Base Site ID Base site ID maintained in the Hybris system
Webroot Webroot of the store front name in the Hybris
system
Note: If you have maintained a webroot in your
Hybris system, then it is mandatory to maintain the
same in AIN system as well.
Additional Information If required.
11. Choose OK.
The external system with details gets populated in the Systems list in the Application Settings window.
Note: After the configuration is in place, you can view the "Add to Cart" icon for the relevant spare parts
in the Equipment and Models app.
www.sap.com/contactsap
© 2017 SAP SE or an SAP affiliate company. All rights reserved.
No part of this publication may be reproduced or transmitted in any
form or for any purpose without the express permission of SAP SE
or an SAP affiliate company.
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. Please see http://www.
sap.com/corporate-en/legal/copyright/index.epx#trademark for
additional trademark information and notices.
Material Number: