PUBLIC

SAP Mobile Platform 3.0 SP13Document Version: 1.0 – 2016-08-07

Installation: SAP Mobile Platform SDK for Windows

Content

1 Installation: SAP Mobile Platform SDK for Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

2 Installing SAP Mobile Platform SDK. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42.1 Acquiring the Installer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42.2 Preparing for Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52.3 Running the Installer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62.4 Verifying the Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3 Adding Components to an SDK Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4 Uninstalling SAP Mobile Platform SDK. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

5 Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115.1 Quick Fixes to Simple Problems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Installation Error Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115.2 Issues Requiring Product Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Product Support Engagement Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Creating an Incident on SAP Service Marketplace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

6 Postinstallation Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

7 Installation Directories. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

2 P U B L I CInstallation: SAP Mobile Platform SDK for Windows

Content

1 Installation: SAP Mobile Platform SDK for Windows[d1]

SAP Mobile Platform SDK development tools leverage common open source technologies and standards to increase your productivity and reduce development time.

Installing SAP Mobile Platform SDK includes verifying system requirements, acquiring and running the installer, and verifying the installation.

After you install SAP Mobile Platform SDK, you can add components to the installation.

The Postinstallation Tasks documentation explains how to develop applications with the components you install.

Related Information

Acquiring the Installer [page 4]Preparing for Installation [page 5]Running the Installer [page 6]Verifying the Installation [page 7]Adding Components to an SDK Installation [page 9]Postinstallation Tasks [page 14]

d1 concept id: loiocc9c215fcf084c308c4d3e7deeeea9a9 - srcFile: /content/authoring/mdx1459272390932.xml

Installation: SAP Mobile Platform SDK for WindowsInstallation: SAP Mobile Platform SDK for Windows P U B L I C 3

2 Installing SAP Mobile Platform SDK[d2]

Install SAP Mobile Platform SDK components so you can develop, deliver, and manage mobile applications.

1. Acquiring the Installer [page 4]The SAP Mobile Platform SDK installer is available as physical media and as a Web download.

2. Preparing for Installation [page 5]Ensure that the host on which you are installing SAP Mobile Platform SDK meets the system requirements and is ready for you to begin the installation.

3. Running the Installer [page 6]Start the SAP Mobile Platform SDK installer, accept the end user license agreement, specify the installation directory and components to install, and launch the installation process.

4. Verifying the Installation [page 7]After you complete the installation, verify that it succeeded.

2.1 Acquiring the Installer[d3]

The SAP Mobile Platform SDK installer is available as physical media and as a Web download.

Context

Either insert the physical installation media, or follow the steps below to download the software.

Procedure

1. Navigate to SAP Software Download Center .2. Under Support Packages and Patches, select Software Downloads.3. Expand By Alphabetical Index (A-Z), click M, and select SAP MOBILE PLATFORM SDK.4. Select SAP MOBILE PLATFORM SDK 3.0.5. Choose the operating system, then select the file to download.6. Extract the contents of the .zip file to a temporary directory on a local disk on the target host.

Use a short path, preferably a folder directly below the root directory. The path can include only ASCII alphanumeric characters, underscores, hyphens, and periods. Two consecutive period characters are not allowed.

d2 task id: loio7c04f56770061014882becf78b8ed293 - srcFile: /content/authoring/i841441038464315.xmld3 task id: loio7c04f56770061014882becf78b8ed293 loio7c052829700610148910ea8b23abe391 - srcFile: /content/authoring/qng1467136920596.xml

4 P U B L I CInstallation: SAP Mobile Platform SDK for Windows

Installing SAP Mobile Platform SDK

Task overview: Installing SAP Mobile Platform SDK [page 4]

Next task: Preparing for Installation [page 5]

Next task: Preparing for Installation [page 5]

2.2 Preparing for Installation[d4]

Ensure that the host on which you are installing SAP Mobile Platform SDK meets the system requirements and is ready for you to begin the installation.

Procedure

1. Verify that the target system meets the system requirements for SAP Mobile Platform SDK.

See the SAP Product Availability Matrix (PAM) https://support.sap.com/release-upgrade-maintenance/pam.html . Click the Mobile link at the top of the page. Scroll to find the appropriate product and version in the product list.

NoteAccess to PAM requires an SAP Service Marketplace login: http://service.sap.com/request-user

2. If User Account Control (UAC) is present in the version of Windows where you are installing, disable it. Restart the system for this change to take effect.

1. Access the Control Panel option that manages User Account Control on your version of Windows.2. Set the user account to never be notified about changes to your computer.

Reenable UAC after completing this installation.3. Verify that you have Administrator privileges on the installation target host.4. Remove the JAVA_TOOL_OPTIONS environment variable.

Check for JAVA_TOOL_OPTIONS in both User Variables and System Variables panes of the Environment Variables dialog.a. Right-click My Computer and select Properties.b. Select Advanced System Settings.c. Click the Advanced tab.d. Click Environment Variables.e. Select JAVA_TOOL_OPTIONS and click Delete.f. Click OK to exit all dialogs.

5. If there is an earlier version of SAP Mobile Platform SDK installed on the same computer where you are installing this version, back up any workspace directories that were used by SAP Mobile WorkSpace.

d4 task id: loio7c04f56770061014882becf78b8ed293 loio7c04f9bf70061014b50ce1f5252638d4 - srcFile: /content/authoring/i841439830254518.xml

Installation: SAP Mobile Platform SDK for WindowsInstalling SAP Mobile Platform SDK P U B L I C 5

6. Verify that the target host has Microsoft Visual Studio C++ Runtime 2005 installed.You can install this from the \modules\redist\vcruntime2005 folder in the installer image.

Task overview: Installing SAP Mobile Platform SDK [page 4]

Previous task: Acquiring the Installer [page 4]

Previous task: Acquiring the Installer [page 4]

Next task: Running the Installer [page 6]

Next task: Running the Installer [page 6]

2.3 Running the Installer[d5]

Start the SAP Mobile Platform SDK installer, accept the end user license agreement, specify the installation directory and components to install, and launch the installation process.

Procedure

1. Browse to the root directory of the SAP Mobile Platform installer, right-click the setupAMD64.exe file and select Run as Administrator.

A terminal window runs in the background.

NoteThe installer displays an Initializing wizard... message while it verifies the integrity of the installation image. It may take a few minutes for the first installer panel to appear.

2. On the installer welcome page, click Next.3. On the end-user license agreement page, select your country, accept the terms of the license agreement

and click Next.4. Specify the absolute path to the installation location, which must reside on a local drive on the target host.

The total length of the path must be 29 characters or less.

The path can include only ASCII alphanumeric characters, underscores, hyphens, and periods. Two consecutive period characters are not allowed.

5. Select the installation type, based on the SDK components you want to install:○ Standard – installs all the components available.

d5 task id: loio7c04f56770061014882becf78b8ed293 loio7c04fe7770061014af7ab35b314322a0 - srcFile: /content/authoring/qru1448993595467.xml

6 P U B L I CInstallation: SAP Mobile Platform SDK for Windows

Installing SAP Mobile Platform SDK

○ Custom – lets you select the specific components to install.6. If you selected Custom on the installation type panel, select the specific components to install.

Be sure to select the components that are required for the type of development you plan to do:

SDK Component Description

Native SDK Provides an open and flexible framework for native OData application development for both online and offline applications. Components are implemented as independent static runtime libraries. Includes Interactive Local OData (ILOData) command-line utility.

Kapsel SDK Provides SAP plug-ins that enhance the Apache Cordova application container, allowing it to seamlessly integrate with SAP Mobile Platform Server.

Agentry Toolkit Supports metadata-driven applications that enable maintenance and service technicians to access SAP Business Suite software, online or offline, from a broad range of devices.

SMS Toolkit Supports creation of SMS applications using predefined and custom application states. Use the application states as basic building blocks you link sequentially to model application task flows.

7. Click Next.On the summary information panel, verify the installation features and click Install.8. Click Finish.

Task overview: Installing SAP Mobile Platform SDK [page 4]

Previous task: Preparing for Installation [page 5]

Previous task: Preparing for Installation [page 5]

Next task: Verifying the Installation [page 7]

Next task: Verifying the Installation [page 7]

2.4 Verifying the Installation[d6]

After you complete the installation, verify that it succeeded.

Procedure

1. Use a text editor to open the <SMP_HOME>\InstallLogs\SMPSDKInstall<date-time>.log file.

d6 task id: loio7c04f56770061014882becf78b8ed293 loio9eb7abe7ca5b476cb3345684e7fe8f9b - srcFile: /content/authoring/i841439834346558.xml

Installation: SAP Mobile Platform SDK for WindowsInstalling SAP Mobile Platform SDK P U B L I C 7

NoteBy default, SAP Mobile Platform SDK components are installed in the C:\SAP\MobileSDK<XXX> directory, which is represented in this guide by <SDK_HOME>.

2. Search for "error"—no search results indicates that the installation completed successfully.

Task overview: Installing SAP Mobile Platform SDK [page 4]

Previous task: Running the Installer [page 6]

Previous task: Running the Installer [page 6]

Next task: Adding Components to an SDK Installation [page 9]

8 P U B L I CInstallation: SAP Mobile Platform SDK for Windows

Installing SAP Mobile Platform SDK

3 Adding Components to an SDK Installation[d7]

You can add components to an existing SAP Mobile Platform SDK installation.

Procedure

1. Run the installer.2. On the component selection panel, select additional components that you want to add.

Previous task: Verifying the Installation [page 7]

Next task: Postinstallation Tasks [page 14]

d7 task id: loio9e96f915242b4e08af7fabd6e53d61d6 - srcFile: /content/authoring/i821417652498677.xml

Installation: SAP Mobile Platform SDK for WindowsAdding Components to an SDK Installation P U B L I C 9

4 Uninstalling SAP Mobile Platform SDK[d8]

Uninstall SAP Mobile Platform SDK using the Control Panel option to remove programs, which launches the uninstaller.

Prerequisites

● Back up any user-created files and log files you want to keep from the installation directories to another location.

● Prevent virus scans, backups, and system updates from interfering with the uninstallation by either excluding the SAP Mobile Platform SDK installation directory from these processes, or by temporarily disabling these processes.

Procedure

1. From the Control Panel, select the appropriate option for adding or removing programs (the exact name of the option depends on your Windows version), then select SAP Mobile Platform SDK 3.0 SP13.

2. Click Next in the welcome window.3. Select the components to be uninstalled and click Next.4. On the summary information panel, click Uninstall to start uninstalling the selected SAP Mobile Platform

SDK components.5. Click Finish when you see:

The InstallShield Wizard has successfully uninstalled SAP Mobile Platform SDK <version>.

6. Manually delete any folders and files remaining in the <SDK_HOME> tree.

d8 task id: loio7c04ebc8700610149e089089c602d6f8 - srcFile: /content/authoring/i841430518572352.xml

10 P U B L I CInstallation: SAP Mobile Platform SDK for Windows

Uninstalling SAP Mobile Platform SDK

5 Troubleshooting[d9]

Determine the cause of common problems and apply the recommended solution.

5.1 Quick Fixes to Simple Problems[d10]

Quick fixes are usually common, single-cause problems that you can solve with minimal overhead or additional support.

5.1.1 Installation Error Message[d11]

Problem[d11]

After you complete or cancel the installation process, you see this message in the Windows Program Compatibility Assistant: This program might not have installed correctly.

Workaround[d11]

1. In the Program Compatibility Assistant window where the message appears, click This program installed correctly to close the window without further action.

2. If you see this message after canceling the installation, it is probably because the User Account Control (UAC) is enabled. To disable UAC, access the Control Panel option that manages User Account Control on your version of Windows.

3. If appropriate, restart the installer.4. Reenable UAC after the installation.

d9 task id: loio7c05155b700610148147f2eae57b77d1 - srcFile: /content/authoring/i821401812017929.xmld10 reference id: loio7c05155b700610148147f2eae57b77d1 loio7c28a22b70061014a0f8bc9e7a817854 - srcFile: /content/authoring/i841435856484373.xmld11 reference id: loio7c05155b700610148147f2eae57b77d1 loio7c28a22b70061014a0f8bc9e7a817854 loio7c2870f370061014aa6dbba7d0eb148d - srcFile: /

content/authoring/mgm1452811770509.xmld11 section id: loio7c05155b700610148147f2eae57b77d1 loio7c28a22b70061014a0f8bc9e7a817854 loio7c2870f370061014aa6dbba7d0eb148d - srcFile: /

content/authoring/mgm1452811770509.xmld11 section id: loio7c05155b700610148147f2eae57b77d1 loio7c28a22b70061014a0f8bc9e7a817854 loio7c2870f370061014aa6dbba7d0eb148d - srcFile: /

content/authoring/mgm1452811770509.xml

Installation: SAP Mobile Platform SDK for WindowsTroubleshooting P U B L I C 11

5.2 Issues Requiring Product Support[d12]

Your SAP support ID gives you access to enterprise-level incident support as part of your support plan on SAP Service Marketplace.

Product Support can help you resolve new undocumented incidents with software installation, start-up, and overall use, as well as provide diagnostic and troubleshooting assistance for known problems with a new or undocumented cause.

5.2.1 Product Support Engagement Requirements[d13]

If you use SAP Service Marketplace to engage with Product Support, you must meet certain requirements.

Service Marketplace Case Creation Requirements[d13]

Be prepared to provide:

● A valid installation number for SAP Mobile Platform● A valid service contract with SAP● A valid system ID (S-User ID)● An enabled NetViewer connection.

SAP Mobile Platform Incident Requirements[d13]

● Configure all logs to an appropriate level for your issue. Product Support requires details from one or more of the system logs.

● Capture these basic incident details to help Product Support analyze the problem, and determine any next steps:○ Environment summary: product version, back end, client type (device and OS), proxy connections.

These details help isolate component that is causing the failure. If you have an architecture diagram, share it with SAP.

○ Problem description: what were the actions preceded the incident. Capture all details that allow Product Support to reproduce the issue.

● Locate the server version in the SMP_HOME\Server\version.properties file.

d12 reference id: loio7c05155b700610148147f2eae57b77d1 loio7bff348c7006101488ed8ec1d3a80ce9 - srcFile: /content/authoring/wnx1452716358952.xmld13 reference id: loio7c05155b700610148147f2eae57b77d1 loio7bff348c7006101488ed8ec1d3a80ce9 loio7bff302270061014ad4a81202b223fb5 - srcFile: /

content/authoring/oee1452716680866.xmld13 section id: loio7c05155b700610148147f2eae57b77d1 loio7bff348c7006101488ed8ec1d3a80ce9 loio7bff302270061014ad4a81202b223fb5 - srcFile: /

content/authoring/oee1452716680866.xmld13 section id: loio7c05155b700610148147f2eae57b77d1 loio7bff348c7006101488ed8ec1d3a80ce9 loio7bff302270061014ad4a81202b223fb5 - srcFile: /

content/authoring/oee1452716680866.xml

12 P U B L I CInstallation: SAP Mobile Platform SDK for Windows

Troubleshooting

5.2.2 Creating an Incident on SAP Service Marketplace[d14]

If you cannot resolve problems with the troubleshooting documentation for SAP Mobile Platform, go to SAP Service Marketplace for additional help.

Use SAP Service Marketplace to create an incident message for Product Support. Keywords from this message return related articles from the Knowledge Base. Before you submit a message, review these articles to see if they resolve your problem.

1. Go to http://support.sap.com/incident .2. Create a message using the wizard.

NoteYou must know the component ID for SAP Mobile Platform to return the correct scope of Knowledge Base Articles and to correctly route the message to Product Support. On-premise installations of SAP Mobile Platform use a different ID than cloud instances. See Knowledge Base Article 1915061- How to Choose a Component for SAP Mobile Platform 3.x in Service Marketplace .

3. Once the message is processed, you receive an e-mail notification of the solution.

d14 reference id: loio7c05155b700610148147f2eae57b77d1 loio7bff348c7006101488ed8ec1d3a80ce9 loio7bff2ab970061014b817861fd924b9f9 - srcFile: /content/authoring/tly1452716463288.xml

Installation: SAP Mobile Platform SDK for WindowsTroubleshooting P U B L I C 13

6 Postinstallation Tasks[d15]

Continue with the developer documentation for the type of development supported by the SAP Mobile Platform SDK components you have just installed.

Procedure

See the Development Information topic in the applicable documentation from the list below. You can find the documentation on the SAP Help Portal. Select your SAP Mobile Platform SDK version, and navigate to the development topic of interest.

SDK Component Developer Documentation

Native SDK Native OData App Development

Kapsel SDK Kapsel Development

Agentry Toolkit Agentry App Development

Previous task: Adding Components to an SDK Installation [page 9]

d15 task id: copy0dc9beb07b1349598f44c1ab28917efc - srcFile: /content/authoring/i841439835390771.xml

14 P U B L I CInstallation: SAP Mobile Platform SDK for Windows

Postinstallation Tasks

7 Installation Directories[d16]

Find the component files that are necessary to develop different types of applications.

The following table shows the top-level subdirectories that are created when you install SAP Mobile Platform SDK. The directory names identify the type of application that the different components support.

By default, SAP Mobile Platform SDK components are installed in the C:\SAP\MobileSDK<XXX> directory, which is represented in this guide by <SDK_HOME>.

Table 1: SAP Mobile Platform SDK Installation Subdirectories

Directory Description

_smpjvm JVM used by the uninstaller.

AgentryToolkit Agentry Editor, Agentry Test Environment, and support files.

ClientHub Files for Client Hub applications, used for registering applications on iOS and Android devices.

InstallLogs Log files that are created each time the SAP Mobile Platform SDK installer is used. Use these logs to troubleshoot installer issues.

KapselSDK Kapsel framework files.

NativeSDK Native application files that support Mobile Application Framework (MAF) and OData Framework.

SMSToolKit Short Message Service (SMS) files, that support SMS Builder.

ThirdParty License terms of third-party components that are included in SAP Mobile Platform SDK.

Tools Interactive Local OData (ILOData) command-line utility lets you run OData requests against a local offline store.

Uninstaller SAP Mobile Platform SDK uninstaller files.

d16 reference id: loio7c1ca536700610149faaff84e809f953 - srcFile: /content/authoring/sgm1448993012616.xml

Installation: SAP Mobile Platform SDK for WindowsInstallation Directories P U B L I C 15

Important Disclaimers and Legal Information

Coding SamplesAny software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, unless damages were caused by SAP intentionally or by SAP's gross negligence.

AccessibilityThe information contained in the SAP documentation represents SAP's current view of accessibility criteria as of the date of publication; it is in no way intended to be a binding guideline on how to ensure accessibility of software products. SAP in particular disclaims any liability in relation to this document. This disclaimer, however, does not apply in cases of wilful misconduct or gross negligence of SAP. Furthermore, this document does not result in any direct or indirect contractual obligations of SAP.

Gender-Neutral LanguageAs far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed directly with "you", or a gender-neutral noun (such as "sales person" or "working days") is used. If when referring to members of both sexes, however, the third-person singular cannot be avoided or a gender-neutral noun does not exist, SAP reserves the right to use the masculine form of the noun and pronoun. This is to ensure that the documentation remains comprehensible.

Internet HyperlinksThe SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint about where to find related information. SAP does not warrant the availability and correctness of this related information or the ability of this information to serve a particular purpose. SAP shall not be liable for any damages caused by the use of related information unless damages have been caused by SAP's gross negligence or willful misconduct. All links are categorized for transparency (see: http://help.sap.com/disclaimer).

16 P U B L I CInstallation: SAP Mobile Platform SDK for Windows

Important Disclaimers and Legal Information

Installation: SAP Mobile Platform SDK for WindowsImportant Disclaimers and Legal Information P U B L I C 17

go.sap.com/registration/contact.html

© 2016 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. The information contained herein may be changed without prior notice.Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary.These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without representation or warranty of any kind, and SAP or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP or SAP affiliate company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.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 for additional trademark information and notices.