SSAM Installation 2210
SSAM Installation 2210
Before you begin reading this guide, be sure that you have the latest version. Find the latest version at https://
help.sap.com/docs/SAP_SERVICE_ASSET_MANAGER.
The following table provides an overview of the most important document changes.
SAP Business Technology Platform enables customers and partners to rapidly build, deploy, and manage
cloud-based enterprise applications that complement and extend your SAP or non-SAP solutions, either
on-premise or on-demand.
Note
For more information on prerequisites and procedures for setting up customer accounts on SAP Business
Technology Platform, see the topic Getting Started with a Customer Account: Workflow in the Neo and
Cloud Foundry environment.
SAP Business Technology Platform is an in-memory cloud platform based on open standards. It provides
access to a feature-rich, easy-to-use development environment in the cloud. The platform includes a
comprehensive set of services for integration, enterprise mobility, collaboration, and analytics.
As a Platform-as-a-Service operated by SAP, our product frees your administrators from any infrastructure and
IT costs and offers state-of-the art quality of service.
Scenarios
Application development
You can use the following programming models to build highly scalable applications:
• Java - SAP Business Technology Platform is Java EE 6 Web Profile certified. You can develop Java
applications just like for any application server. You can also easily run your existing Java applications
on the platform.
• SAP HANA - you can use the SAP HANA development tools to create comprehensive analytical models and
build applications with SAP HANA programmatic interfaces and integrated development environment.
• HTML5 - you can easily develop and run lightweight HTML5 applications in a cloud environment.
• SAPUI5 - use the UI Development Toolkit for HTML5 (SAPUI5) for developing rich user interfaces for
modern Web business applications.
Solutions
In the context of SAP Business Technology Platform, a solution is comprised of various application types and
configurations created with different technologies, and is designed to implement a certain scenario or task
flow. You can deploy solutions by using the Change and Transport System (CTS+) tool, the console client,
or by using the cockpit, where you can also monitor your solutions. To describe and technically realize the
solutions, SAP Introduces the multi-target application (MTA) model. It encompasses and describes application
modules, dependencies, and interfaces in an approach that facilitates validation, orchestration, maintenance,
and automation of the application throughout its lifecycle.
Applications developed on SAP Business Technology Platform run in a modular and lightweight runtime
container. The platform provides a secure, scalable runtime environment with reusable platform services.
Virtual machines allow you to install and maintain your own applications in scenarios not covered by the
platform. A virtual machine is the virtualized hardware resource (CPU, RAM, disk space, installed OS) that
blends the line between Platform-as-a-Service and Infrastructure-as-a-Service.
Services
You can consume a set of services provided by SAP Business Technology Platform according to the technology
you prefer and the use cases of your scenarios.
SAP Business Technology Platform facilitates secure integration with on-premise systems running software
from SAP and other vendors. Using the platform services, such as the connectivity service, applications can
establish secure connections to on-premise solutions, enabling integration scenarios with your cloud based
applications.
In-memory persistence
SAP Business Technology Platform includes persistence powered by SAP HANA, taking full advantage of its
real-time, in-memory computing technology and built-in analytics.
Secure data
Comprehensive, multilevel security measures have been built into SAP Business Technology Platform. This
security is engineered to protect your mission critical business data and assets and to provide the necessary
industry standard compliance certifications.
Free trial
You can start by getting a free SAP Business Technology Platform developer license on SAP Business
Technology Platform Developer Center that also gives you access to our community and all the free technical
resources, tutorials, blogs, support you need.
SAP Business Technology Platform Mobile Services, or SAP BTP services, provides services to mobile
applications, such as application analytics, app resources, onboarding, and HTTP/HTTPS configuration.
• Application analytics: Usage statistics that are displayed graphically in the SAP BTP cockpit
• App resources: Containers of dynamic configurations, styles, or content that are downloaded by native
applications
• Onboarding: Authentication of users who are registering through SAP Mobile Place
• HTTP/HTTPS configuration: Open standards for client communications
• Life cycle management: Managing and deploying multiple versions of an application
• Offline oData service: Optimizes data transport between the back end and the client offline store
• Push notifications: Native notifications sent from back-end systems to the server, which forwards them on
to the clients
• SAP BTP cockpit: Deploys, manages, and monitors applications
SAP BTP services can expose on-premise back end services through Cloud Connector, and on-demand back
end services directly.
SAP BTP services security enables you to use an on-premise identity management system for on-demand
applications. You can use basic authentication using LDAP, or form-based application authentication using
SAML.
The SAP Business Technology Platform SDK includes well defined layers (SDK frameworks, components, and
platform services) that simplify development of enterprise-ready mobile native apps that take full advantage of
the mobile platform features.
The SAP Business Technology Platform SDK is tightly integrated with the SAP Business Technology Platform
Mobile Services Cockpit to provide the following:
Note
For more information about the SAP Business Technology Platform SDK, see SAP Business Technology
Platform documentation.
SAP Service and Asset Manager is an MDK-based solution using a three-tier architecture:
In addition, the Cloud Connector is used for establishing secure communication between SAP BTP and the SAP
system. An SAP Netweaver Gateway is used for OData services provisioning.
An MDK metadata development tool is used for client application development. OData services developed in
ABAP provides the consolidated integration services for the solution.
Note
Procedure
3. Activate HTTP Services by using transaction SICF (HTTP Service Hierarchy Maintenance)
Activate HTTP services for the ConfigPanel and the Administration and Monitoring tool using the following
information:
4. Define user roles and authorizations through transaction PFCG (Role Maintenance)
Define the user role with required authorization for SAP Service and Asset Manager and MAIF using the
following information:
Authorization Description
Authorization object: /MERP/SAM Regular SAP Service and Asset Manager user
Activity: Execute
Authorization object: /SMFND/A01 Admin user who can run system purge utility programs
Activity: Delete
Task overview: SAP S/4HANA, SAP ERP, or MAIF Setup [page 10]
Depending on the version of SAP Service and Asset Manager, the following versions of the SAP Mobile Add-On
are available for compatible SAP ECC 6.0 EHP7 SP14 systems and newer:
Ensure that the corresponding SAP Mobile Add-On and service packs are installed for the SAP Service and
Asset Manager application you wish to run. For detailed information and instructions regarding the installation
• 2577248 : Release Information Note - Mobile Add-On for ERP 6.30 and Support Packages
• 2660361 : SAP Asset Manager Mobile Add-On for ERP Installation Primary Note
• 2660862 : SAP BTP Mobile Services Setup Info for SAP Service and Asset Manager with SAP ERP
System
For detailed information and instructions regarding the configuration of SAP Mobile Add-On, see the SAP
Service and Asset Manager Configuration Guide.
After downloading the files for the SAP Mobile Add-On desired support packages from the SAP Software
Download Center, load the mobile add-on onto your system through the add-on manager, using the transaction
code SAINT. Once the add-on is installed, load the support packages into your system through the Support
Package Manager (accessed through transaction code SPAM).
See the checklist found in Installing the SAP Mobile Add-On for SAP ERP [page 13] for detailed information on
installing the SAP Mobile Add-On for SAP ERP
Parent topic: SAP S/4HANA, SAP ERP, or MAIF Setup [page 10]
Once the SAP Mobile Add-On and requisite support packages have been installed, follow the Post Installation -
Required topic to fully configure the SAP Mobile Add-On for ERP. Ensure that the OData Service is assigned in /
IWFND/MAINT_SERVICE and the B/C set is activated for the given version of SAP Service and Asset Manager.
After following the topic, use thefollowing checklist to ensure that the mobile application integration framework
is properly installed and configured:
1. Ensure that the requisite Web Dynpro that controls the behavior of the SAP Mobile Add-On are properly
activated.
1. Transactions /SYCLO/CONFIGPANEL and /SYCLO/ADMIN open the Mobile Application Integration
Framework Configuration Panel and Administration Panel for the desired back end SAP ERP system.
2. Ensure that the requisite B/C sets related to the desired version of the SAP Mobile Add-On are installed
and activated.
1. If these B/C sets have been properly activated, application configuration for the desired SAP
Service and Asset Manager version appears in the transaction /SYCLO/CONFIGPANEL under Mobile
Application Parameters.
3. Ensure that the OData service for the desired SAP Service and Asset Manager application is activated and
assigned to the Mobile Application OData Service Assignment.
1. The requisite OData service appears in the Mobile Application OData Service Assignment in the
transaction /SYCLO/CONFIGPANEL and is assigned to the mobile application.
2. The requisite OData service will also appear in the listing of OData services provided by the SAP
Gateway system, found in transaction /IWFND/MAINT_SERVICE.
1. Configure the alias assignment in the /IWFND/MAINT_SERVICE transaction. By selecting the
desired OData service, the bottom-right panel informs administrators which back end connection
alias is used for the connection to the backend SAP Mobile Add-On services.
2. Perform a quick test of the OData service to ensure the proper OData service document is being
returned by the service:
After selecting the OData service, the bottom-right panel includes a link to an internal test using
the gateway client. By using the internal gateway client tool with the HTTPS connection option,
system administrators can ensure that their connections are properly reaching the correct back-
end system from the SAP gateway and retrieving data for the proper data service providers for
SAP Service and Asset Manager.
3. Ensure that the idempotency jobs are set up from the SPRO configuration of the SAP gateway system,
as SAP Service and Asset Manager relies on idempotency in HTTP OData services to ensure data
integrity.
4. Ensure that the SAP back-end system is set up to allow authentication of HTTPS calls from the Cloud
Connector via principal propagation.
When the SAP Mobile Add-On has been set up correctly, the OData service starts returning data in the SAP
Gateway client, accessible from transaction /IWFND/GW_CLIENT.
1. Ensure that the requisite Web Dynpro that controls the behavior of the SAP Mobile Add-On are properly
activated.
1. Transactions /SYCLO/CONFIGPANEL and /SYCLO/ADMIN open the Mobile Application Integration
Framework Configuration Panel and Administration Panel for the desired back end SAP ERP system.
2. Ensure that the requisite B/C sets related to the desired version of the SAP Mobile Add-On are installed
and activated.
1. If these B/C sets have been properly activated, application configuration for the desired SAP
Service and Asset Manager version appears in the transaction /SYCLO/CONFIGPANEL under Mobile
Application Parameters.
3. Ensure that the OData service for the desired SAP Service and Asset Manager application is activated and
assigned to the Mobile Application OData Service Assignment.
1. The requisite OData service appears in the Mobile Application OData Service Assignment in the
transaction /SYCLO/CONFIGPANEL and is assigned to the mobile application.
2. The requisite OData service will also appear in the listing of OData services provided by the SAP
Gateway system, found in transaction /IWFND/MAINT_SERVICE.
1. Configure the alias assignment in the /IWFND/MAINT_SERVICE transaction. By selecting the
desired OData service, the bottom-right panel informs administrators which back end connection
alias is used for the connection to the backend SAP Mobile Add-On services.
2. Perform a quick test of the OData service to ensure the proper OData service document is being
returned by the service:
After selecting the OData service, the bottom-right panel includes a link to an internal test using
the gateway client. By using the internal gateway client tool with the HTTPS connection option,
system administrators can ensure that their connections are properly reaching the correct back-
end system from the SAP gateway and retrieving data for the proper data service providers for
SAP Service and Asset Manager.
3. Ensure that the idempotency jobs are set up from the SPRO configuration of the SAP gateway system,
as SAP Service and Asset Manager relies on idempotency in HTTP OData services to ensure data
integrity.
4. Ensure that the SAP back-end system is set up to allow authentication of HTTPS calls from the Cloud
Connector via principal propagation.
When the SAP Mobile Add-On has been set up correctly, the OData service starts returning data in the SAP
Gateway client, accessible from transaction /IWFND/GW_CLIENT.
Add the SAP Mobile Add-On for SAP S/4HANA systems alongside the requisite service packs in order to
provide the required OData services for specific versions of SAP Service and Asset Manager.
The following versions of Mobile Add-On for SAP S/4HANA are available for compatible SAP S/4HANA 1610
FPS01 systems and newer:
SAP S/4HANA on-premise edition 1610 Feature Pack Stack (FPS) 01 or higher
SAP S/4HANA on-premise edition 1909 (see Note) 1909 (see Note)
Note
Running SAP Service and Asset Manager in SAP S/4HANA on-premise edition 1909 or later doesn’t require
SAP Mobile Add-On installation. The Mobile Application Integration Framework used by SAP Service and
Asset Manager is included as part of SAP S/4HANA 1909 on-premise.
See the checklist found in Installing the SAP Mobile Add-On for SAP S/4HANA 1909 and Earlier Versions [page
15] for detailed information on installing for 1909 or earlier versions.
Parent topic: SAP S/4HANA, SAP ERP, or MAIF Setup [page 10]
Ensure that the corresponding SAP Mobile Add-On and service packs are installed for the SAP Service and
Asset Manager application you wish to run. For detailed information and instructions regarding the installation
of the SAP Mobile Add-On for 1610 FPS01 systems, see the Mobile Add-On for S/4HANA Installation Guide,
or check primary note 2493602 and 2977434 . For detailed information and instructions regarding the
configuration of SAP Mobile Add-On, see the SAP Service and Asset Manager Configuration Guide.
After downloading the files for the SAP Mobile Add-On desired support packages from the SAP Software
Download Center, load the mobile add-on onto your system through the add-on manager, using the transaction
code SAINT. Once the add-on is installed, load the support packages into your system through the Support
Package Manager (accessed through transaction code SPAM).
1. Ensure that the requisite Web Dynpro that controls the behavior of the SAP Mobile Add-On are properly
activated.
1. Transactions /SYCLO/CONFIGPANEL and /SYCLO/ADMIN open the Mobile Application Integration
Framework Configuration Panel and Administration Panel for the desired back end SAP S/4HANA
system.
2. Ensure that the requisite B/C sets related to the desired version of the SAP Mobile Add-On are installed
and activated.
1. If these B/C sets have been properly activated, application configuration for the desired SAP
Service and Asset Manager version appears in the transaction /SYCLO/CONFIGPANEL under Mobile
Application Parameters.
3. Ensure that the OData service for the desired SAP Service and Asset Manager application is activated and
assigned to the Mobile Application OData Service Assignment.
1. The requisite OData service appears in the Mobile Application OData Service Assignment in the
transaction /SYCLO/CONFIGPANEL and is assigned to the mobile application.
2. The requisite OData service will also appear in the listing of OData services provided by the SAP
Gateway system, found in transaction /IWFND/MAINT_SERVICE.
1. Configure the alias assignment in the /IWFND/MAINT_SERVICE transaction. By selecting the
desired OData service, the bottom-right panel informs administrators which back end connection
alias is used for the connection to the backend SAP Mobile Add-On services.
2. Perform a quick test of the OData service to ensure the proper OData service document is being
returned by the service:
After selecting the OData service, the bottom-right panel includes a link to an internal test using
the gateway client. By using the internal gateway client tool with the HTTPS connection option,
system administrators can ensure that their connections are properly reaching the correct back-
end system from the SAP gateway and retrieving data for the proper data service providers for
SAP Service and Asset Manager.
3. Ensure that the idempotency jobs are set up from the SPRO configuration of the SAP gateway system,
as SAP Service and Asset Manager relies on idempotency in HTTP OData services to ensure data
integrity.
4. Ensure that the SAP back-end system is set up to allow authentication of HTTPS calls from the Cloud
Connector via principal propagation.
When the SAP Mobile Add-On has been set up correctly, the OData service starts returning data in the SAP
Gateway client, accessible from transaction /IWFND/GW_CLIENT.
See the Enabling MAIF topic in the Mobile Application Integration Framework (MAIF) Installation Guide for
further information.
Procedure
Navigate to IMG SAP Netweaver SAP Gateway OData Channel Configuration Activate or
Deactivate SAP Gateway to check if the Gateway is active.
2. Maintain system alias through transaction SPRO.
Navigate to IMG SAP Netweaver SAP Gateway OData Channel Configuration Connection
Settings SAP Gateway to SAP System Manage SAP System Alias to check if the Gateway is active.
3. Register and activate the OData service through transaction /IWFND/MAINT_SERVICE
a. Click Add Service and search for the following technical service name:
Note
<XXXX> is the release version of the application.
For example, 2010.
Note
Prerequisites
• HTTP Configuration: SAP Business Technology Platform Mobile Services communicates with the back
end using HTTP/OData service
• Principal Propagation: Principal propagation to an ABAP system must be configured
• Certificate User Mapping in ABAP system: X.509 certificate must be mapped to named user in the SAP
ABAP system
Context
For detailed information on installing and configuring the Cloud Connector, see the following links:
Procedure
1. Find your subaccount ID: To set up your subaccount, you must know the subaccount ID.
a. Open the SAP Business Technology Platform Cockpit.
b. Navigate to the subaccount list of the global account containing your subaccount: choose Home
<Your Global Account> Subaccounts .
c. Find your subaccount in the list. Choose the Info icon in the subaccount tile to display the subaccount
ID.
Note
Enter the subaccount ID as <Subaccount>, rather than its actual (technical) name. See the
previous step to determine your subaccount ID. As <Subaccount User> provide your Login
E-mail instead of a user ID.
c. (Optional) You can define a <Display Name> that allows you to easily recognize a specific subaccount
in the UI compared to the technical subaccount name.
d. (Optional) You can define a <Location ID> that identifies the location of this Cloud Connector for a
specific subaccount.
e. (Optional) You can provide a <Description> of the subaccount that is shown when clicking on the
Details icon in the Actions column.
f. Save your changes.
3. Configure access control: to allow your cloud applications to access a certain backend system
through HTTP, specify this system in the Cloud Connector.
a. Choose Cloud To On Premise from your Subaccount menu in the SAP Business Technology Platform
Cockpit. Then choose Add.
Note
Find your internal host and internal port through the SAP GUI by running transaction SMICM and
navigating to go to Service (ICM Monitor) - Service .
The Status icon is now a green square, indicating the resource is active.
5. Perform an initial Cloud Connector configuration. See Initial Configuration - SAP Help Portal for detailed
information.
• Region
• Subaccount: SAP S/4HANA account name
• Subaccount user: SAP BTP connection user
• Password
6. Generate a CA certificate. See Installation of a System Certificate for Mutual Authentication for more
information.
7. Set up the trust store with your backend system.
8. Set the System Certificate.
• Common Name
• Organizational Unit
• Organization
• Country
9. Set the Principle Propagation Subject Pattern.
10. Establish the connection between the cloud subaccount and the Cloud Connector.
11. Establish a connection to the on-premise back end system.
12. Establish a Cloud Connector connection for the on-premise system.
Results
The SAP Business Technology Platform Cloud Connector serves as the link between on-demand applications in
the SAP Business Technology Platform and existing on-premise systems.
For general Cloud Connector set up and configuration, see the SAP Business Technology Platform Cloud
Connector documentation, specifically Configure Access Control (HTTP). The following topic addresses
specific SAP Service and Asset Manager Cloud Connector configurations to make in the Cloud Connector
cockpit. Perform these additional configuration modifications after the initial Cloud Connector installation and
configuration.
1. Click the Cloud to On-Premise link, and in the Access Control tab, add your on-premise system in your
Cloud to On-Premise mapping as follows:
• Protocol: HTTPS
• Back-End Type: ABAP
• Virtual Host: Your choice
• Virtual Port Your choice
• Internal Host: SAP back-end system
• Internal Port: SAP back-end system
• Principle Type: X.509 Certificate
2. Add a resource to your Cloud to On-Premise account:
• URL Path: /sap/opu/odata
• Click the Path and all sub-paths radio button
3. Click the Principle Propagation tab and set each of the Trust Configurations to Trusted (checked).
SAP Service and Asset Manager requires the SAP Business Technology Platform Mobile Service to provide user
onboarding, user authentication, mobile application lifecycle management, and OData offline support.
Note
Enable OAuth 2.0 based user authentication for SAP Business Technology Platform as required by SAP
Service and Asset Manager.
For more information about SAP Business Technology Platform security, see SAP Business Technology
Platform documentation.
To allow principal propagation of users from non-SAP managed identity providers, see the instructions at the
Establish Trust and Federation of Custom Identity Providers for Platform Users topic.
For more information about the SAP Business Technology Platform Mobile Service, see SAP Business
Technology Platform Mobile Services Overview .
Remember
SAP Business Technology Platform, Neo environment will sunset on December 31, 2028, subject to terms
of customer or partner contracts.
SAP Business Technology Platform offers an OAuth 2.0 user authentication service that communicates with
an Identity Provider or local trust store to provide a secure method of passing valid credentials through HTTP
calls.
Once you set the Identity Provider, configure the OAuth service to generate tokens for requests accepted by the
Identity Provider. Configure the requests using standard OAuth 2.0 token retrieval methods through the URLs
on the bottom of the Branding tab:
When you create a mobile services application to provide OData services to client applications, you can secure
the application by using the SAP Business Technology Platform as the authorization server through the oAuth
service it provides. To secure the application, enable the Security feature of the mobile service application.
Then, configure it to use the oAuth service of the SAP Business Technology Platform that was previously set
up. Finally, add the client to the security settings of the application.
Inside of the security features of the application, set the Security Configuration to <OAuth> to use OAuth 2.0
tokens to authenticate to the application. Setting this field ensures that users can repeatedly authenticate into
the application for the life of the OAuth token without having to contact the Identity Provider to enter their
credentials again. The OAuth service tracks the identity of the token and uses the token to authenticate users
into the application, as the token is passed in with the connection attempts. You can add individual clients to
include individual redirect URLs or token expiration dates if necessary.
Authentication to an individual component served by Mobile Services does not ensure authentication to a
backend service. To propagate the authentication information of the application to the backend service, turn on
principle propagation of the destination that is set as the backend connection of the application.
Configure the security method of the connection for Principle Propagation. If it is not configured for principle
propagation, it will not provide the credentials from the application to the on-premise back-end system that is
providing the data service for the SAP Mobile Add-On / Mobile Add-On Integration Framework.
To edit the connection to the backend, edit it in the Destinations tab of the Mobiles Services Cockpit.
To edit the connection, select the connection, click Edit, and navigate through the wizard to the SSO
Mechanism page. Change the SSO Mechanism to <Principal Propagation>.
If user authentication services are not required, use the Basic Authentication setting to allow connections
to the back-end system to log in as a single, predefined, set of credentials for every user that accesses the
connection.
To install the SAP Service and Asset Manager application, you must follow a specific order for certain steps in
the installation process. Some objects in the installation rely on previously installed objects for IDs or URLs, or
other data.
Use the following high-level process table for information on the process steps to take when installing the SAP
Service and Asset Manager.
Prerequi- Before you can install the SAP Service and Asset Manager
sites application, ensure that the following SAP components are
installed:
1 Creation or update of SAP Business Technology Platform SAP Business Tech- Must be first step
account nology Platform ad-
ministrator
Use the default subaccount or create a subaccount within
your SAP Business Technology Platform account.
2 On-premise Cloud Connector setup. See the Cloud Connec- IT administrator Relies on Step 1
tor Installation topic.
3 Mobile Add-On for SAP S/4HANA: See Installing the Mobile SAP S/4HANA ad- None
Add-On for SAP S/4HANA ministrator or SAP
Mobile Add-On for SAP ERP: See Installing the Mobile Add- ERP (ECC) adminis-
On for ERP trator
Neo
5 Build the mobile application using the App Create program. Administrator Relies on Application
security settings in
For detailed information, see the and Using the SAP Busi-
Step 4
ness Technology Platform Mobile Services App Creator to
Create an Application topics and subtopics.
Note
For Neo installations, see SAP BTP services - Setting Up
a Neo Environment [page 59].
6 Import the metadata definitions into the SAP Web IDE Business expert Relies on Steps 4–5
7 Launch the SAP Service and Asset Manager application Administrator Relies on Steps 1–6
using the onboarding URL. Navigate through the launch
screens and perform the initial sync.
Note
If you're using MAIF, see the Upgrade Mobile Application Integration Framework (MAIF) Using SAP Note
Transport-based Correction Instructions (TCI) in S/4HANA System blog post.
Read the following SAP Notes before you begin installation. The SAP Notes contain the most recent
information about the installation, as well as any corrections to the installation process.
Make sure you have the most recent version of each SAP Note. Find SAP Notes on the SAP Service
Marketplace at SAP ONE Support Launchpad .
Release Information Note - Mobile SAP S/4HANA Information and references to additional SAP
2495578
Add-On for SAP S/4HANA 1.0 and Notes in the context of applying the Mobile
Support Packages Add-On for S/4HANA 1.0 and support pack-
ages to an SAP S/4HANA on premise system
SAP Asset Manager Mobile Add-On SAP S/4HANA Release and Information (RIN) note about
2493602
for SAP S/4HANA Installation Pri- planning the installation and upgrades of the
mary SAP Note ABAP Add-On for the SAP Asset Manager ap-
plication
SAP Business Technology Platform SAP S/4HANA Information on how to set up SAP Busi-
2566071
Mobile Services Setup Info for SAP ness Technology Platform Mobile Services
Asset Manager with an SAP S/ (SCPms) to run the SAP Service and Asset
4HANA On-Premise System Manager application
SAP Business Technology Platform SAP ERP Information on how to set up SAP Busi-
2660862
Mobile Services Setup Info for SAP ness Technology Platform Mobile Services
Asset Manager with an SAP ERP On- (SCPms) to run the SAP Service and Asset
Premise System Manager application
SAP Asset Manager - MDK Support Mobile Develop- Detailed information on SAP Service and As-
2933065
ment Kit
Matrix set Manager and Mobile Development Kit ver-
sion compatibility
MDK App Crash on Launch on Cer- Mobile Develop- Corrects issues with iOS 14 when building an
2970982
ment Kit
tain iOS 14 Devices iOS client
You can find additional information for the Mobile Development Kit in the following continually updated blog
post: Latest Mobile Development Kit Blogs and Videos .
The SAP Service and Asset Manager application supports the following languages:
• ar001 - Arabic
• bg_BG - Bulgarian
• zh_hans - Simplified Chinese
• zh_hant - Traditional Chinese
• csCZ - Czech Republic
• daDK - Danish
• nlBE - Dutch
• elGR - Greek
• enUS - English
• frFR - French
• deDE - German
• heIL - Hebrew
• hrHR - Croatian
• huHU - Hungarian
• inID - Indonesian
• itIT - Italian
• jaJP - Japanese
• koKR - Korean
• nbNO - Norwegian
• plPL - Polish
• ptBR - Portugese
• roRO - Romanian
• RuRU - Russian
• srSP - Serbian
• skSK - Slovak
• slSL - Slovenian
• esES - Spanish
• svSE - Swedish
• thTH - Thai
• trTR - Turkish
• viVN - Vietnamese
SAP Service and Asset Manager uses the oData service that is provided with the SAP Business Technology
Platform Mobile Services.
The oData service provides a universally available service for the SAP Service and Asset Manager application.
• Ensure that an SAP Business Technology Platform Mobile Services account with an active mobile services
account is available
• A Cloud Connector is required. For more information, see the Setting up the SAP Business Technology
Platform Cloud Connector System Mapping [page 22] procedure.
• The correct SAP Mobile Add-On for your system is already installed. For more information, see the
following topics:
• SAP Mobile Add-On for SAP ERP [page 11]
• Mobile Add-On for SAP S/4HANA [page 15]
Note
If you are using S4HANA 1909 SPS 03 or above, MAIF is included automatically. See the Mobile Application
Integratio Framework (MAIF) portal page for more information.
Note
Your organization may have multiple SAP BTP global accounts with different product licenses associated
with them. Please make sure one of those licenses is associated with the global account that end users
have access to. If a corresponding license that grants entitlements for SAP Service and Asset Manager is
not associated with the global account that end users have access to, SAP Service and Asset Manager will
not be a visible application available for use.
If the license for Mobile Execution and SAP Service and Asset Manager is not assigned to the correct global
account, please reach out to your account executive. They can correctly assign the product SKU to the
global account in which you wish to operate SAP Service and Asset Manager.
Software Prerequisites
For all prerequisite and installation information for the Mobile Development Kit, see the SAP Mobile Services,
mobile development kit portal page.
Note
To fully install and run the SAP Service and Asset Manager application, be sure to read all content and
perform all procedures found in the Deployment and Configuration of SAP Service and Asset Manager
chapter of this guide before starting the client setup.
1. SAP BTP services - Setting Up a Cloud Foundry Environment, Single Instance [page 34]
Establish an SAP Business Technology Platform Cloud Foundry account with the requisite individual
services.
2. Opening the SAP BTP services App Creator [page 37]
3. Using the SAP Business Technology Platform Mobile Services App Creator to Create an Application [page
41]
4. Configuring Customer Usage Metrics [page 53]
All applications using MAIF require reporting of customer usage metrics to ensure customers are not
exceeding their licensed user counts based on personas.
Establish an SAP Business Technology Platform Cloud Foundry account with the requisite individual services.
For detailed information on Cloud Foundry, see the Enabling Mobile Services page.
1. Navigate to the SAP BTP cockpit portal page. The SAP Business Technology Platform portal page is the
home page where you access your listing of global accounts. You must be logged on to access your
accounts.
2. Click your desired global account, for example, SAP Service and Asset Manager.
You’re taken to Global Account Cockpit page.
3. Click the Subaccounts tab. Your subaccounts appear. If you don't have any subaccounts created, use the
following substeps to create a subaccount:
• Click the New Subaccount button.
• In both the Display and the Subdomain fields, type a short, meaningful name.
• In the Provider field, select either AWS or Microsoft Azure. Currently, Google Cloud Platform isn’t
supported.
• Click Create.
A new subaccount is created.
4. Click the Subaccounts Assignment tab.
5. Select your desired subaccount.
6. Click the Configure Entitlements button, then click the Add Service Plan button.
The Entitlements window displays.
7. Select Mobile Services on the left to bring up the Mobile Services panel on the right.
8. Click the Standard checkbox to add it to your plan.
9. Click Application Runtime on the left. Then check the MEMORY checkbox on the right.
Application Runtime and Mobile Services appear at the bottom of the panel.
10. Click the Add [Number] Service Plans.
You’re returned to the Subassignment Accounts page.
Note
The amount of application runtime memory required is based on the number of applications you’re
setting up in the subaccount. For every 5 applications, you need at least 1 GiB of quota. For example,
10 mobile applications require 2 GiB of runtime. See the SAP Asset Manager Sizing Guide for detailed
information.
3. Navigate to the Service Marketplace in your newly created space and select one of the services related
to mobile.
Parent topic: Setting Up and Deploying an App in Cloud Foundry [page 34]
Next: Opening the SAP BTP services App Creator [page 37]
In the SAP GUI, use transaction /MERP/CPms_appcreate. Note that if the transaction is unavailable, reach the
application through transaction SE38 and execute the program /MERP/CORE_CPMS_APPCREATE_PROG.
Caution
Please note that currently standard mode is deprecated. This issue is planned to be fixed with 2410 release.
Note
For most applications, standard mode is sufficient for successful execution of mobile app generation.
If needed, open the list of variants available for the application and select a variant specific to the version of the
installed Mobile Application Integration Framework application.
Previous: SAP BTP services - Setting Up a Cloud Foundry Environment, Single Instance [page 34]
Next: Using the SAP Business Technology Platform Mobile Services App Creator to Create an Application
[page 41]
Before you use the App Creator, be sure you've read and are following 2978807 : MAIF to CPms Multi-
Virtualhost Support.
The Mobile Application Integration Framework (MAIF) includes a tool to automate the integration of SAP
BTP services on Cloud Foundry alongside SAP Service and Asset Manager on-premise definitions. The tool is
available in the following versions of MAIF:
See the following subtopics for detailed information on the fields shown in the App Creator program:
Parent topic: Setting Up and Deploying an App in Cloud Foundry [page 34]
Previous: Opening the SAP BTP services App Creator [page 37]
• Direct connection: If your back end system allows outbound HTTPs connections, you can connect directly
to SAP BTP services
• RFC connection: Use this method if your back end system is locked behind a firewall that disallows direct
outbound HTTs connections and needs to be routed through a proxy. Establishing an RFC connection
requires populating the Mobile Services Connection Information with the Middleware Server GUID.
Retrieve the Admin API from the Important Links section, regardless of which method you're using to connect.
Option 1: Directly Connecting to SAP BTP services from the Back End
System
For systems that do not require outbound proxies or special certificate configurations, you can copy the Admin
API directly from the Important Links section of SAP BTP services. Paste the Admin API into the MS Admin API
or MW Server GUID field.
Note
To correctly configure metrics reporting, complete the RFC Connection: Integrating SAP Cloud Reporting
for MAIF-Based Mobile Applications on SAP BTP services for Cloud Foundry [page 55] procedure before
establishing an RFC connection through the App Creator program.
An option is available to define the special settings in an RFC connection using transaction SM59 that wraps
the connection with the middleware server GUID to reference by the calling application. Use this option for
systems that require outbound proxies or special certificate configurations not captured by the standard direct
HTTPs outbound communication methods that SAP back end systems use.
The middleware server GUID is generated when a middleware server is defined in the Administration Portal.
The defined middleware server should point to the MS Admin API URL, with /app appended.
Your MAIF mobile app selection corresponds to an application that serves as an OData service to mobile
devices through the definitions defined in /syclo/configpanel.
Note
The MAIF mobile app must correspond to the application serving as an OData service for proper generation
of mobile app settings in SAP BTP services.
Standard or Advanced
Field Name Description View
MS Application Name Any text displayed on the SAP BTP cockpit for admin- Standard
istration
MS Application Description Any text displayed on the SAP BTP cockpit for admin- Standard
istration
MS Vendor Name Name of the vendor providing the application defini- Standard
tions
MDK Onboarding URI Schema Defines how the SAP BTP services app will generate Advanced
a QR code for onboarding of mobile devices to the
mobile application.
If the SAP Gateway connected to the back end SAP system is running as a parallelized gateway or a gateway
hub, select this option to ensure the proper generation of data is being sent to the mobile devices.
Standard or Advanced
Field Name Description View
Application Tag Application tag that is appended to all attempts at syn- Advanced
chronizing SAP mobile applications using the Mobile
Application Integration Framework and the SAP back
end system.
oDataOffline Destination The mobile services destination which the oDataOffline Advanced
service uses to sync local versions of mobile device da-
tabases that allow mobile applications to work offline.
This field must match the mobile destination name
as listed in Defining the Mobile Services Connection
Configuration [page 48]
oDataOffline Request Format Format with which mobile services requests data that Advanced
will be populated in the local mobile databases from
the back end SAP system. JSON is the standard value
for MAIF support applications.
oDataOffline Content ID Location The contentID type of files downloaded by the oDa- Advanced
taOffline Service. Choose either MIME or OPERATION
based on your system setup.
oDataOffline Delta Format Format with which mobile services requests data that Advanced
is populated in the local mobile databases from the
SAP back end systems during a delta sync (all subse-
quent syncs that occur after the mobile device has
completed onboarding).
oDataOffline Refresh in Order Determines whether or not mobile services will respect Advanced
the order of oData entities as defined by the MAIF con-
figuration.
oDataOffline Delta Resend Not used by MAIF applications. For more information, Advanced
see the max_delta_resends row in the Application Con-
figuration File topic.
oDataOffline Prepopulate DB Not used by MAIF applications. For more information, Advanced
see the prepopulate_offline_db row in the Application
Configuration File topic.
oDataOffline Case Sensitivity Determines whether or not data transmitted to mobile Advanced
services retains its case during data transmission.
oDataOffline DateTime Offset Not used by MAIF applications. For more information, Advanced
see the json_datetimeoffset_in_utc row in the Applica-
tion Configuration File topic.
oDataOffline Change Expiry Not used by MAIF applications. For more information, Advanced
see the local_change_expiry row in the Application
Configuration File topic.
oDataOffline Max Length Omit Not used by MAIF applications. For more information, Advanced
see the allow_omitting_max_length_facet row in the
Application Configuration File topic.
oDataOffline Refresh Interval Maximum amount of time to cache entities in the oDa- Advanced
taOffline sync database. Value is set to 1440 by default.
oDataOffline Cache Expiration Maximum amount of time to cache the oDataOffline Advanced
database
oDataOffline Delta Tracking Flag to determine whether or not mobile services Advanced
tracks changes between cached data on mobile serv-
ices and the SAP back end system.
The following topic only goes over the interaction of how the mobile services application creator bundled
with MAIF utilizes these definitions for use with supported mobile applications. For detailed information
regarding mobile services connectivity definitions, see the Defining Connectivity topic in the SAP Mobile
Services Administration guide.
Standard or Advanced
Field Name Description View
SCC X.509 Virtual Host The virtual host defined by the Cloud Connector that Standard
allows an SAP BTP resource to identify a specific SAP
Gateway server, configured with principal propagation
through x.509 certificate generation.
SCC X.509 Virtual Port Port assigned to the virtual host Standard
Cloud Connector Location ID Location ID used to identify a given connection be- Standard
tween a Cloud Connector and an SAP BTP subaccount.
Note
This is the location ID and not the cloud connector
ID
Gateway Service User Technical user allowed to perform an HTTPS ping Standard
against the SAP Gateway for connectivity testing pur-
poses.
Gateway Service Password Password for the Gateway Service User Standard
Offline Destination Only Does not create the online destination in the mobile Advanced
services application. For more information, see the Mo-
bile Services Offline Destination Configuration section
in this topic.
Offline and Online Destinations Creates both online and offline destinations. For more Advanced
information, see the Mobile Services Offline Destination
Configurationand the Mobile Services Online Destina-
tion Configuration sections in this topic.
Mobile applications supported by the Mobile Application Integration Framework support offline destinations
by default. Offline destinations are OData services provided by MAIF for complete download and sync with
The primary operation of applications connecting to offline destinations in SAP BTP services is through the
oDataOffline framework on the mobile device. Changes made to data on the local devices must be synced with
the back end database on demand.
Standard or Advanced
Field Name Description View
Username Propagation Enables the Username propagation flag on SAP Mobile Advanced
Services Connectivity
Use Cloud Connector Must be selected for on-premise back end servers Advanced
Mobile Destination Name Name of the mobile destination defined in the client Advanced
metadata. The name in this field must match the name
of the destination defined by the MDK metadata.
Destination Connection Timeout The longest amount of time expected for each request Advanced
to spend downloading from the destination
Destination Rewrite Mode Method used to rewrite mobile services URLs to back Advanced
end service URLs.
SSO Method The single sign-on method used to identify mobile ap- Advanced
plication users to the back end system. SCC is the
standard cloud connector principal propagation mode.
Destination Max Request Size The maximum size of a request for requests being sent Advanced
to the mobile device
Destination Rewrite Rules If the Destination Rewrite mode is set to custom, the Advanced
custom definitions for mobile services can be entered
here
Destination Header Custom headers can be inserted here for the connec- Advanced
tion. If the SAP Gateway system being connected to
the SAP BTP services instance does not have the de-
fault client set to the client hosting the data being re-
quested, the client can be overwritten.
Sample Code
{
"name": "sap-client",
"value": "001",
"overwrite": true
}
Mobile applications supported by MAIF have supported online destinations since October 2017. Online
destinations are OData services provided by MAIF for on-demand download and data sync with the mobile
applications. Online destinations are useful for a mobile application that frequently handles updating data that
must be downloaded in real time and can only be accessed while the mobile device has an internet connection.
Standard or Advanced
Field Name Description View
Username Propagation Enables the Username propagation flag on SAP Mobile Advanced
Services Connectivity
Use Cloud Connector Must be selected for on-premise back end servers Advanced
Mobile Destination Name Name of the mobile destination defined in the client Advanced
metadata. The name in this field must match the name
of the destination defined by the MDK metadata.
Destination Connection Timeout The longest amount of time expected for each request Advanced
to spend downloading from the destination
Destination Rewrite Mode Method used to rewrite mobile services URLs to back Advanced
end service URLs.
SSO Method The single sign-on method used to identify mobile ap- Advanced
plication users to the back end system. SCC is the
standard cloud connector principal propagation mode.
Destination Max Request Size The maximum size of a request for requests being sent Advanced
to the mobile device
Destination Rewrite Rules If the Destination Rewrite mode is set to custom, the Advanced
custom definitions for mobile services can be entered
here
Destination Header Custom headers can be inserted here for the connec- Advanced
tion. If the SAP Gateway system being connected to
the SAP BTP services instance does not have the de-
fault client set to the client hosting the data being re-
quested, the client can be overwritten.
Sample Code
{
"name": "sap-client",
"value": "001",
"overwrite": true
}
All applications using MAIF require reporting of customer usage metrics to ensure customers are not
exceeding their licensed user counts based on personas.
Executing this procedure in a production environment starts an automatic, periodic, transmission of usage
metrics to SAP. If the procedure fails to send usage metrics to SAP for longer than a period of 14 days, while
connecting to SAP Service and Asset Manager, the Mobile Application Integration Framework will prohibit any
further incoming connections.
To ensure that usage metrics are successfully transmitted, use transaction code SM37 to check the Job
Overview for a job created running ABAP Program Name /MFND/CORE_CLOUD_METRICS_PROG.
If you need support, open a support message at https://support.sap.com/incident using the MOB-APP-
MAO component.
Parent topic: Setting Up and Deploying an App in Cloud Foundry [page 34]
Previous: Using the SAP Business Technology Platform Mobile Services App Creator to Create an Application
[page 41]
Properly defining the mobile application provides a way to integrate MAIF with SAP Cloud Reporting.
Integration allows the collection of usage metrics.
Using a synchronization (sync) process, mobile devices utilize SAP BTP services as a proxy to download data
from the back end system through MAIF. A delta sync process attempts to keep data integrety between
the mobile device and the back end system where data changes are either uploaded or downloaded either
on-demand or periodically.
The mobile device sends an Open Sync Session command that identifies the technical product name used
in the mobile application starting the sync process using a value called the Application Tag or SAP Product
• Manually set in the .ini file using the /MERP/CORE_OFFLINE_CONFIG_PROG as shown in the following
example:
• Set automatically using the process defined in Defining the Mobile Service Offline OData Settings [page
46]
If the application is not defined correctly in a production environment, the application will cease to operate
after two weeks of failed attempts to connect.
For mobile applications using MAIF, usage metrics sent to SAP Cloud Reporting require the establishment of
a Unified Mobile Services API for every given application defined as a middleware server record in the /SYCLO/
Admin transaction.
Establish the middleware server record based on the landscape of the deployed MAIF-supported application
as well as the firewall rules for the SAP server on which MAIF or the Mobile Add-On is running. After
the middleware server record is established, schedule a periodic job to execute the ABAP report /MFND/
CORE_CLOUD_METRICS_PROG on a daily basis. The report details licensed user counts, aggregate usage by
functional usage equivalent type, and licensed applications to SAP Cloud Reporting.
Use one of the following methods to set up SAP Cloud Reporting integrations in MAIF:
• Direct Connection: Integrating SAP Cloud Reporting for MAIF-Based Mobile Applications on SAP BTP
services for Cloud Foundry [page 55]
• RFC Connection: Integrating SAP Cloud Reporting for MAIF-Based Mobile Applications on SAP BTP
services for Cloud Foundry [page 55]
For information on setting up SAP Cloud Reporting in a Neo environment, see Configuring Customer Usage
Metrics for Neo Environments [page 60].
Use the direction connection method if you're using SAP BTP services with a back end SAP system capable of
connecting directly to the internet without requiring outbound proxies or other special firewall rules.
Execute the instructions found in Using the SAP Business Technology Platform Mobile Services App Creator
to Create an Application. The App Creator program automatically generates the required connections to SAP
BTP services. The App Creator program also establishes the periodic job under the user who executed the App
Creator program to run the usage metrics integration with SAP Cloud Reporting.
Context
If you're using SAP BTP services on a back end SAP system that has requirements to invoke communications
with the internet outside of a corporate firewall, use RFC connectivity for usage metrics integration to SAP
Cloud Reporting in MAIF. You'll need to manually create and define the RFC destination.
Note
If the application is already created, update the middleware server record using the following procedure.
If the customer requires an RFC connection for outbounds rather than the direct HTTP connections for cloud
metrics, use the following procedure to utilize the RFC destinations:
Procedure
3. Add /mobileservices/service-key/metering to the Path Prefix field. Add 443 to the Service No field.
4. Set the SSL to Active in the Logon & Security tab. Save the RFC destination.
7. Find and copy the API key located in Connectivity Service Keys of SAP BTP services.
8. Return to the Middleware Server Management Additional Properties tab in the Admin Portal and add
the following properties:
a. Add the API key with the following properties:
• Property Group: METERING
• Property Name: X-API-Key
b. Add /mobileservices/service-key-metering with the following properties:
• Property Group: METERING
• Property Name: service_path
Next Steps
Continue using the App Creator program section found in Defining the SAP BTP services Connection
Information [page 42], section Option 2: Establishing RFC Connection Information for the SAP BTP services
App Creator.
Connecting the SAP Business Technology Platform to SAP BTP services Neo
1. Navigate to the Services tab of the SAP Business Technology Platform subaccount with Mobile Services
provisioned on it.
2. Enter the configuration for mobile services by selecting the Mobile Services, Users service. Ensure that the
status is set to Enabled.
3. Once the service is enabled, select the Configure Mobile Servies, Users option. Navigate to the Roles tab in
the configuration.
4. Add users that need access to the connection settings of the mobile application to the Administrator role
to allow them to manage the connection between the SAP Service and Asset Manager application and the
requisite components that it uses on the SAP Business Technology Platform.
For more information on setting up the SAP Service and Asset Manager application with the SAP Business
Technology Platform, see the official documentation for the SAP BTP Neo Environment.
To quickly get connected in SAP BTP services, some preset templates are provided for apps built on the Mobile
Development Kit, including SAP Service and Asset Manager:
1. In SAP BTP services, create a destination that utilizes the Cloud Connector to create a connection to the
SAP on-premise environment.
1. In the default metadata that is shipped with SAP Service and Asset Manager, the destination names
that the mobile application is looking for are DEST_SAM<version number>_PPROP. Therefore, use this
naming convention for destinations used with standard installations of the SAP Service and Asset
Manager application.
2. The SAP Service and Asset Manager application currently only supports connections to on-premise
environments. Ensure that the Cloud Connector is properly configured by creating the connection
based on the virtualhost information in the Cloud Connector.
3. The SAP Service and Asset Manager application has different performance and timing requirements
depending on the on-premise system being used:
1. For SAP ERP back ends and landscapes using the Gateway hub environment, set the timeout
settings for the connection to at least 20 minutes.
2. For SAP S/4HANA back ends with embedded SAP Gateways, set the timeout settings for the
connection to 10 minutes at a minimum.
4. In the custom header section, include the header sap-client = <on-premise gateway client
#> to prevent potential issues from a misconfigured default client configuration.
5. Manually configure URL rewriting only if the Cloud Connector is set with a virtualhost that differs from
the internal host. To manually configure URL rewriting, set the inbound and outbound rewrite rules to
Context
SAP Service and Asset Manager customers operating in a Neo environment must utilize RFC destinations to
define an open connection used by a manually-defined periodic job. Utilizing RFC destinations enables the
support of usage metrics integration with SAP Cloud Reporting.
6. Navigate to Administration Server Management . Search for the mobile application you're
configuring.
7. Create the unified server listing. Add the UI Host Name. Add /mobileservices/origin/hcpms/
metering/senddata to the Server URL (FQDN).
Restriction
Next Steps
Schedule the program for periodic execution using transaction SE36. Schedule the program for daily execution
and monitor for any failures. If a failure occurs, administrators have two weeks to repair issues befure the
applications cease to sync with the mobile application.
Reference information to help you understand the files and metadata in your project.
Structure of .mdkproject
• BrandedSettings.json: Runtime configurations such as security settings, URLs for connecting to the SAP
Business Technology Platform Mobile Services, and more
• MDKProject.json: Build time configurations such as the application name, version, and bundle ID
• App_Resources: Any custom resources used by the application, such as all of your action bar images that
are customized for your application.
• demo: To make an OData service available in demo mode, include the .udb and .rq.udb files for that
service in this directory
Currently the SAP Service and Asset Manager application can’t take the demo UDBs created by the most
recent SAP Business Technology Platform SDK and use them with an older SAP Business Technology
Platform SDK version.
The MDKProject.json file contains settings that you can only configure before running the create-
client.command:
• AppName: Determines the name of the application project and the app as it appears on a mobile device
• AppVersion: The client project application version
• BaseProject: The metadata subdirectory under the .mdkproject structure that contains the main
application metadata. The main application metadata is the MDK application, which includes one or
more component MDK applications. The component applications are only required if you are adding
components to your base application, such as Meter Management or Field Operations Worker.
• BundleID: Uniquely identifies the resulting MDK client application on the device. Only one instance of a
bundle ID can be installed on a device at a time. If you attempt to install a second application using the
same bundle ID, it will overwrite the existing application.
• Externals: A list of NPM nodules that should not be included in the application bundle. Use this option for
dependencies you expect to be in the environment when the application is built.
Note that the modules file-system and ui/dialogs are automatically used as externals as they are
already included in the client application.
• URLScheme: Allows you to specify a custom URL scheme that opens the client. If the URL includes
connection settings such as URL parameters, these settings override the settings used by the client.
Defaults to mdkclient.
The Mobile Development Kit client tracks several versions, which you can view in the iOS Settings menu. These
versions are identified as the application version, the definitions version, and the frameworks versions for the
frameworks used in the client build.
When generating a client project, you can specify the application version. Specifying the application version
allows you to version the client itself, which can be useful if you change extension controls or other branded
settings. To specify the application version, specify the AppVersion property in the MDKProject.json file
before running create.client.command.
To further customize the entry of your application in the iOS Settings menu, you can manually edit
<ProjectDirectory>/app/App_Resources/iOS/Settings.bundle/Root.plist after the script has
completed. You can add new entries, but do not remove existing entries or the application may not function
correctly.
Use the SAP Business Application Studio to edit application metadata and deploy the bundle to SAP BTP
services on Cloud Foundry.
Prerequisites
Context
See the SAP Business Application Studio portal page for detailed information.
Procedure
1. Navigate to the subaccount Entitlements tab . Select Configure Entitlements to add the ability to
subscribe to SAP Business Application Studio to the subaccount.
5. Navigate to the Role Collections tab in your subaccount to ensure that the SAP Business Application Studio
roles are created.
7. Navigate to the Instances and Subscriptions tab and click on the link for . To begin working, select the
Create Dev Space button to open a workspace.
Tip
Chrome works better than Safari when attempting to access your space.
The SAP Business Application Studio in SAP Business Application Studio is equivalent to the VS Code
extension (minus debugging), plus the graphical editors from the SAP Web IDE.
Note
By default, all Mobile Development Kit objects will open in the graphical editors. Select Code Editor if you
prefer the VS Code method of editing.
To create a new Mobile Development Kit application in SAP Business Application Studio, use the following
steps:
1. Select File New Project from Template . This opens up the Template page.
2. Select MDK Project and click Next.
3. Select from one of the Mobile Development Kit template types (Empty, Base, List Detail, or CRUD), and
proceed through the rest of the wizard.
Procedure
1. Log in to the SAP Business Technology Platform Cockpit and from Home Region , click the Region in
which your account is based.
2. Select your Global Account. From the Global Account page, select the Subaccounts tab on the left side.
Then select the subaccount where you wish to deploy your applications.
3. Find the SAP Web IDE Full-Stack tile. If it is not Enabled, enable it. Then click Go to Service.
The SAP Web IDE prompts to refresh. Refresh the SAP Web IDE to view the new tile.
6. Click the MDK Development icon. If the Mobile Development Kit icon does not appear, ensure it is enabled.
After enabling, refresh the SAP Web IDE.
Next Steps
Proceed to the Importing Metadata Definitions to the SAP Web IDE Mobile Development Kit procedure.
If the extension or installation of additional components onto your application is required, then the SAP Web
IDE is a required deployment.
Find more information at the documentation for the SAP Web IDE Full-Stack.
To deploy an application from the SAP Web IDE to the SAP BTP services instance:
1. Ensure that the mobileservices destination in the SAP Business Technology Platform subaccount has the
value mobile added to the WebIDEUsage property.
2. Ensure that the Mobile Services App Development Tools is enabled by checking the Settings tab in the
Extensions section in the SAP Web IDE.
Deploy SAP Service and Asset Manager from the out of the box configuration to set the cloud endpoint
authentication URL and the OData service URL. You can also set other configuration values.
Prerequisites
• Verify that your system is set up to build the SAP Service and Asset Manager application by running the
MDK Dependencies Installer. This tool detects all the components to install or update, allowing you to
update or install them instantly.
For more information and instructions on how to obtain the MDK Dependencies Installer, see the Building
Your MDK Client procedure.
• Complete the SAP Service and Asset Manager Client Setup.
Context
Restriction
Develop any customization on the app as a separate component in a Mobile Development Kit project.
Developing customizations as a component makes it easier to maintain customizations during upgrades,
as it isolates custom code. Isolating your custom code eliminates the chance of overwriting when you
implement a new release.
Use the following procedure to build and brand the SAP Service and Asset Manager application.
Procedure
1. Locate the required installation files from the SAP Download Center and navigating to:
Note
For detailed information on SAP Service and Asset Manager and Mobile Development Kit version
compatibility, see 2933065 .
See 2970982 for detailed information when building an iOS client using iOS 14.
1. Unzip the iOS subfolder found in the MDK PLUG- 1. Unzip the Android subfolder found in the MDK
IN SDK zip file. PLUG-IN SDK zip file.
2. Choose your architecture from one of the following 2. Copy the following folders from your
folders: Universal folder to the SAPAssetManager/
• Release-iphoneos SAM.mdkproject/extensions folder:
• Release-iphonesimulator • extension-PDF
• Release-fat (contains both the iphoneos and • extension-BarcodeScanner
the iphonesimulator architectures) • extension-FieldDataCapture
3. Copy the following folders from your selected
• extension-MapFramework
architecture folder to the SAPAssetManager/
• extension-HierarchyFramework
SAM.mdkproject/extensions folder:
• extension-PDF
• extension-BarcodeScanner
• extension-FieldDataCapture
• extension-MapFramework
• extension-HierarchyFramework
By default, the Server API has a / at the end of the endpoint URL. Do not add this / into your
connection settings.
• Neo:
• AuthorizationEndpointURL: Set to the oAuth authorization endpoint URL that you created in
Step 12 of the procedure.
• RedirectURL: Set to the callback URL that is automatically generated with the creation of the
oAuth client in Step 12 of the procedure.
• TokenURL: Set to the token URL that is automatically generated with the creation of the oAuth
client in Step 12 of the procedure.
• Cloud Foundry:
• AuthorizationEndpointURL: Set to the oAuth authorization endpoint URL that you created in
Step 11 of the procedure.
• RedirectURL: Set to the callback URL that is automatically generated with the creation of the
oAuth client in Step 11 of the procedure.
• TokenURL: Set to the token URL that is automatically generated with the creation of the oAuth
client in Step 11 of the procedure.
b. Choose your client configuration:
To preconfigure your client to connect to your mobile application, add the information retrieved in
the above step to the ConnectionSettings block. When adding additional entries, include a comma
after the existing EnableOverrides entry. An example is included in the table for reference when you’re
adding entries to your file.
If you want to use SAP Service and Asset Manager against different back-end mobile applications (ex:
DEV and QA), leave the ConnectionSettings as is, and build an onboarding URL for users using the
values found in Step 6a. See the example in the table for further information on how to connect a client
using either of the methods.
Note
If you are using the onboarding URL approach, note that all users must recieve an email with the
onboarding URL to connect applications to SAP Business Technology Platform Mobile Services.
To configure the client to connect to a specific You can generate an onboarding link to overwrite the val-
application, update the following values in the ues discussed in this substep on a device. Use the follow-
BrandedSettings.json file: ing format in a URI:
… samclient://?AppId=<Insert AppID
value here>
Note
An internet connection is required. If you’re connecting to the internet through a proxy, configure
your settings before running the ./install.command or ./install.cmd command.
Sample Code
on a Mac
$ ./create-client.command
? Enter the path of the .mdkproject directory. ../SAM.mdkproject
Using ../SAM.mdkproject
Using /Users/.../sdk for out directory
? Would you like to build for iOS or Android or All? ios
Building client for ios
? Would you like to build for device or simulator of iOS? device
Building client for device of iOS
Removing existing directory /Users/.../sdk/AssetManager
Creating application AssetManager
Sample Code
on a Windows PC
>create-client.cmd
? Enter the path of the .mdkproject directory. ..\SAM.mdkproject
Using ..\SAM.mdkproject
Using C:\...\mdk for out directory
Building client for Android
Removing existing directory C:\...\mdk\AssetManager
Creating application AssetManager
Results
After create-client.command for iOS or create-client.cmd for Windows finishes, you’re ready to run
the client either on the mobile device or on a simulator.
Next Steps
For iOS installations only, continue to the Allowing Custom URI Schemes [page 79] procedure, which allows
SAP Service and Asset Manager to open custom URIs.
If a custom SAP Service and Asset Manager build is needed for Cloud Foundry, see the Creating a Build Job for
Customized MDK Clients procedure.
Optional: If you are using custom map icons, follow the instructions in the Customizing Map Icons [page 82]
procedure.
Prerequisites
You have built and branded the SAP Service and Asset Manager application. For more information, see:
• Building and Branding the SAP Service and Asset Manager Application Client [page 72]
Context
Note
The following procedure is applicable for iOS installations only. You do not need to perform this procedure if
you are installing SAP Service and Asset Manager on Android.
By default, iOS allows third-party apps to specify a limited set of URI schemes:
• http:
• https:
• mailto:
• tel:
• sms:
• facetime:
Other applications, such as Microsoft Edge, can support custom URI schemes. For example, if the application
is installed, microsoft-edge-https://www.google.com, opens up Google in Microsoft Edge for iOS.
However, it will only work correctly from a non-third-party iOS application such as Safari.
For additional information on iOS URI schemes, see the Launch Services Keys documentation from Apple.
To allow SAP Service and Asset Manager to open custom URIs, use the following procedure.
Procedure
In the following example, the custom schemes microsoft-edge-https and microsoft-edge-http are
added. If Microsoft Edge is installed on the mobile device, these custom schemes allow the client to open
HTTP and HTTPS URLs in Microsoft Edge.
Results
Any custom URL attachments associated with your newly added schemes now open as expected.
Prerequisites
Build the SAP Service and Asset Manager. See Building and Branding the SAP Service and Asset Manager
Application Client [page 72] for more information.
Context
Restriction
Develop any customization on the app as a separate component in a Mobile Development Kit project.
Developing customizations as a component makes it easier to maintain customizations during upgrades,
as it isolates custom code. Isolating your custom code eliminates the chance of overwriting when you
implement a new release.
Add custom map icons to the App_Resources folder located in mdkproject. You can then reference the custom
map icons directly in the metadata.
Procedure
1. Navigate to the SAM.mdkproject folder and add your custom icons to the appropriate Android or iOS
folder.
Sample Code
"Symbol":{
"marker":"wo_red.png",
...
"onSelect":{
"marker":"wo_red_selected.png",
...
}
}
3. Set the custom image in a rule to control the image based on business logic:
Sample Code
"Symbol":{
"marker":".SAPAssetManager/Rules/Maps/Icons/WorkOrderIcon.js",
...
"onSelect":{
"marker":"/SAPAssetManager/Rules/Maps/WorkOrderIconSelected.js",
...
}
Sample Code
Instead of calling OData services directly, the OData service call is redirected to the offline OData feature, which
mimics a response using the latest synchronized data.
Context
Note
The configuration files are always needed, even if you don’t plan to change the default behavior of the
application.
Note
The following procedure is handled as part of the /MERP/CPMS_APPCREATE process and is only
necessary during updates or if you're manually creating an application.
If you change the OData model to add or remove entity sets, update the corresponding configuration file to
reflect the new data distribution rules associated with the model change.
These offline OData settings are created using the oDataOffline Configuration Builder. As the oData model in
the ConfigPanel changes, the file generated by the program reflects the changes in that system. You must
regenerate the file anytime you change the model.
See the following topics for additional configuration information needed for your offline settings:
• For detailed information on developing and modifying offline applications on the SAP Business Technology
Platform SDK, see the following guides:
• Developing Offline Applications and the associated subtopics
• For detailed information on developing and modifying offline applications on the SAP Business Technology
Platform SDK for Android, see the SAP Business Technology Platform SDK for Android portal page.
• For information on defining offline settings for mobile applications through the SAP BTP services, see
specifically Step 6 of the Defining Offline Settings for Applications topic and the associated subtopics.
1. Using the SAP GUI, enter transaction SE38, then the program /MERP/CORE_OFFLINE_CONFIG_PROG.
2. Tap the Variant Catalog icon. Choose SAP&SAM<version> from the list.
The OfflineOData Configuration Builder for SAP Service and Asset Manager displays. Some fields are
automatically filled in for you. The remaining empty fields are mandatory.
3. Fill in the empty fields in all sections. See the following list for details on how to obtain the information
required:
The following screenshot and information on all fields uses the Advanced Offline Configuration selection.
Choose the Standard Offline Configuration to view only the mandatory fields.
For detailed information on parameters listed in the ODataOffline Configuration Builder and found in
the Application Configuration file, see the topic Application Configuration File.
Default value is N
Default value is Y
• Case Sensitive Database Values: Set to N. If set to Y, alphabetical sorting in SAP Service and Asset
Manager does not work properly.
• ContentID Header Location: Default is operation. In a batch request, the header section of the OData
change set to put the ContentID header. The option that is supported depends on which version of
NetWeaver Gateway you're using.
• mime: The ContentID header is included in the mime header section of the OData change set
• operation: The ContentID header is included in the operation header section of the OData change
set. Use this option when the back end does not allow the ContentID header to be in the mime
header section
• Initial Sync Type: Recommended selection is Initial Sync with JSON. Whenever an initial sync is
performed, the client sends information back in either JSON or XML. If your Gateway system doesn't
handle json, select Initial Sync with XML.
• Delta Sync Type: Whenever a delta sync is performed, the client sends information back in either
JSON or XML. Default is Initial Sync with XML. XML is the only supported delta sync format for SAP
back ends.
• Indexing Options: Indexing pre-loads database values onto the mobile device with an index on the
values. Indexing database values renders the values faster on the device, however the sync process
becomes slower. The more indexes you add, the screen response becomes faster, but the sync time
becomes slower.
• Default Indexing: Recommended.
• Custom Indexing: You can index any entity set, up to 15 entity sets.
Your offline OData configuration file is created and is ready to upload using the SAP BTP cockpit.
5. Download the resulting .ini file to a local folder. Then upload the .ini file to the Offline tile in the SAP
BTP cockpit.
Use a template to create equipment and functional locations from the application in a similar way to using
transactions IE01 and IL01 through the SAP GUI.
Context
A template is required when creating a new equipment. A template is optional when creating a new functional
location. You can use any existing equipment or functional locations as a template.
You can copy classifications, measuring points, business partners, documents, install location (equpiment
only), and notes from the template. The description, maintenance plant, start date, manufacturer, date of
manufacture, model number, serial number, and room, are populated from the template object, and can be
overwritten through user input. A user can update equipment or functional locations before synching.
Note
For more information, see 3257633 : Mobile Services Application Create Refactoring.
Procedure
1. Click on Component Assignments from the home page of the ConfigPanel. Then, click on your application
in the table.
3. Return to the home page of the ConfigPanel and navigate to oData Mobile Data Object Configuration
Data Filter tab . Use the Mobile Application Filter to select your application. Then select the
<APPVERSION>_EQUIP_TEMPLATE from the oData Mobile Data Object by Mobile App list.
4. Add your desired rules to the EQUIP_TEMPLATE filter. Optionally, you can add rules to the
FLOC_TEMPLATE filter found in the <APPVERSION>_FLOC_TEMPLATE OMDO.
5. Update the PROPERTY_FLAG filter found in the <APPVERSION>_EQUIPMENT or
<APPVERSION>_FUNCLOC OMDO ff your app is customized with additional fields on the create page
for equipment or functional locations.
The filter determines which input fields to write to the equipment or functional location. By default, only
the standard fields on the create page of the app are active in the filter.
EQUIPDESCRIP corresponds to the Description field on the Create Equipment app screen.
FUNCLOCDESCRIP corresponds to the Description field on the Create Functional Location app screen.
When you first install and start the SAP Service and Asset Manager application, a demo version is loaded,
complete with demo data. Use the demo version to acclimate yourself to the app before connecting to the SAP
Business Technology Platform.
Prerequisites
• A connection to the internet is required so you can download the SAP Service and Asset Manager
application.
• iOS:
• Your iOS mobile device version must be 15.x or 16.x.
• We recommend iOS devices that have been released in the past two years.
• Android:
• Your Android mobile device version must be 11.x, 12.x, or 13.x.
• We recommend Android devices with the following specifications:
• At least 4 GB RAM.
• Quad-core or Octa-core processor.
• At least 64 GB storage.
• See 3342977 : Software Release Note - SAP Service and Asset Manager 2305, for a complete list of back
end and device requirements for the SAP Service and Asset Manager 2305 mobile application.
Context
Download the SAP Service and Asset Manager application to your mobile device from the App Store (iOS)
or SAP Software Download Center (Android). A demo version is initially loaded. When you are ready to begin
working with the true application, exit the demo, log in, and begin working.
Procedure
1. In the App Store Search box, type SAP Asset Manager and tap Search.
The SAP Service and Asset Manager client application is downloaded from the store. After the download,
an SAP Service and Asset Manager application icon appears on the mobile device.
Results
The SAP Service and Asset Manager client is installed on your mobile device. See the Initial Log In to the SAP
Service and Asset Manager Application [page 95] procedure for information on how to access the application
and begin work.
Note
To check the version of the client software, tap the Information icon on the Module screen of the mobile
device.
Next Steps
Dark mode is available for the SAP Service and Asset Manager client application. Access the Settings menu for
your iOS or Android device. Find the dark mode setting in the Display menu.
Context
Use the following procedure to generate an onboarding QR code for the SAP Service and Asset Manager. The
parameters needed for the procedure are as follows:
Procedure
1. Using the SAP Business Technology Platform Mobile Services Cockpit, navigate to the sap.sam<XXXX>
application, where <XXXX> is the release version.
The launch app QR codes are now available in the Onboarding section.
Next Steps
Continue to the Download the SAP Service and Asset Manager Mobile Application [page 93] procedure. When
prompted, scan the QR code using your mobile device, or copy and paste the URL to your device browser.
Prerequisites
A connection to the internet is required so you can download the SAP Service and Asset Manager application.
Download the SAP Service and Asset ManagerSAP Service and Asset Manager application to your mobile
device from the App Store (iOS) or SAP Software Download Center (Android). A demo version is initially
loaded. When you’re ready to begin working with the true application, exit the demo, log in, and begin working.
Procedure
The SAP Service and Asset Manager client application is downloaded from the store. After the
download, an SAP Service and Asset Manager application icon appears on the mobile device.
c. Tap the icon to open the application.
The SAP Service and Asset Manager client is installed on your mobile device. Continue to the next step
to access the application and begin work.
Note
To check the version of the client software, tap the Information icon on the Module screen of the
mobile device.
The SAP Service and Asset Manager application performs an initial transmit to bring down all of your jobs,
notifications, assets, equipment, and other objects. Depending on the size of your application, the transmit
could take several minutes. When finished, the main Overview screen is shown and you’re ready to explore
the application.
During the initial logon process, set a numerical passcode to unlock the application without having to enter
your user name and password each time the application or the mobile device is locked.
Context
To work with your application, first log in with a corporate user name and password. Then, set a secondary
personal passcode known only to you to easily unlock the application when it is locked on your device. You do
not need to enter your user name and password after the initial log on, only the passcode.
Touch ID is supported on iOS and Android models with the capability and with users who choose to implement
the Touch ID feature.
Procedure
Note
You can try out the app in demo mode before using it productively with your business data. To launch
the app in demo mode, tap on Try the Demo, and ignore the remaining steps.
2. On the initial screen of the application, read the End-User License Agreement and click Agree to accept.
3. Scan the QR code provided to you by your administrator.
Note
For Administrators: You can generate an application QR code through the APIs tab in the SAP BTP
cockpit.
4. Log in using your SAP BTP email address and password credentials.
5. Choose your device passcode. Reconfirm the passcode when prompted.
Results
The application performs an initial transmit to bring down all of your assigned objects, such as work orders,
notifications, or equipment. Depending on the size of your application, the transmit could take several minutes.
When finished, the main Overview screen is shown and you are ready to begin to work with the application.
If your customer site has enabled digital registration, a pop-up wizard appears. See the Registering Digital
Signature procedure for information on how to register.
Hyperlinks
Some links are classified by an icon and/or a mouseover text. These links provide additional information.
About the icons:
• Links with the icon : You are entering a Web site that is not hosted by SAP. By using such links, you agree (unless expressly stated otherwise in your
agreements with SAP) to this:
• The content of the linked-to site is not SAP documentation. You may not infer any product claims against SAP based on this information.
• SAP does not agree or disagree with the content on the linked-to site, nor does SAP warrant the availability and correctness. SAP shall not be liable for any
damages caused by the use of such content unless damages have been caused by SAP's gross negligence or willful misconduct.
• Links with the icon : You are leaving the documentation for that particular SAP product or service and are entering an SAP-hosted Web site. By using
such links, you agree that (unless expressly stated otherwise in your agreements with SAP) you may not infer any product claims against SAP based on this
information.
Example Code
Any software coding and/or code snippets are examples. They are not for productive use. The example code is only intended to better explain and visualize the syntax
and phrasing rules. SAP does not warrant the correctness and completeness of the example code. SAP shall not be liable for errors or damages caused by the use of
example code unless damages have been caused by SAP's gross negligence or willful misconduct.
Bias-Free Language
SAP supports a culture of diversity and inclusion. Whenever possible, we use unbiased language in our documentation to refer to people of all cultures, ethnicities,
genders, and abilities.
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.