Skip to content

Installing the SAP BTP SDK for Android

Extract the contents of the SAP BTP SDK for Android software download file to a folder on your computer and run the installation script. The installation script copies the SDK libraries to the local Maven repository and installs the Android Studio plugin.

If you reset or lose your local maven repository, re-run the install script to ensure the SDK libraries are copied to your new local Maven repository.

If you need to uninstall the Wizard plugin, run the uninstall_wizard script in the same directory.

Requirements

You'll require Android Studio Chipmunk or Dolphin installed on your computer. You can download Android Studio here.

Android Studio includes the latest Android SDK. We recommend you use the Android SDK Manager to keep the Android SDK up to date. Refer to your Android Studio documentation for details on using this tool.

Procedure

  1. Download the SAP BTP SDK for Android software from the Software Download page.
  2. Extract the contents of the downloaded zip file to a folder on your computer.
  3. Run the installation script at the root of the extracted zip. The script installs the Android Wizard plugin in Android Studio and copies the SDK libraries to your local Maven repository.

    Warning

    Do not delete or move the folder where you extracted the program files. SDK tools are installed in this directory and are accessed from this location.

  4. (Recommended) Set the SAP_ANDROID_HOME environment variable to point to your installation folder.

Configuring the Wizard Plugin

When you install the SDK, the installation script copies the SDK libraries to the local Maven repository.

If required, you can specify a different Maven repository for the wizard to use when generating a new app. For example, if you select the Use SAP Cloud Shipment option, the wizard will use the URL of the SAP Cloud Shipment channel, which is a public customer-facing SAP Maven repository; if you select the Use other repository option, you can provide the network path or URL of a remote server. This allows all the developers on your team to use the same, central version of the SDK without any additional manual downloads.

  1. From Android Studio, select File > Settings to open the Settings window.
  2. In the left panel, select SAP BTP SDK for Android. In this configuration page, there are three options provided:

    • Use local SDK installation - If the SDK is installed in the local Maven repository or somewhere local, the Wizard adds mavenLocal(), or the directory of the SAP BTP SDK for Android defined in the system environment variable SAP_ANDROID_HOME + /m2repository, as appropriate, to the generated build.gradle file when you generate your app; otherwise, it adds a warning to the file.

    • Use SAP Cloud Shipment - For this option, you need to obtain a technical user from the SAP Repositories Management site, download the Basic Auth Password file, and then add the user name and password to your system environment variables as SAP_MAVEN_USER and SAP_MAVEN_PASSWORD, respectively. The Wizard adds the URL of the SAP Cloud Shipment channel and credentials information to the generated build.gradle file. When all of these settings are in place, Gradle can fetch the libraries of SAP Business Technology Platform SDK via the SAP infrastructure.

    Note

    The credentials of the technical user need to be regenerated every 6 months.

    • Use other repository - Type the URL for the required repository or use the Browse button to navigate to and select the desired folder. If you specify a location here, the Wizard adds this path to the your project's build.gradle file when you generate your app.
  3. To clear the custom location and revert to the default local maven repository, select Reset. If the SDK is not installed in the local Maven repository, the Wizard adds a warning to the generated build.gradle files.

Configuring JCEF to Support Sign-in SAML Authentication Type with Browser

To configure JCEF - Java Chromium Embedded Framework, you need to install Android Studio Arctic Fox or Bumblebee, and then change the Java Runtime to JetBrains Runtime (JBR). You can download JBR here. Unzip the downloaded package files to the Android Studio root folder, and then change the Java runtime as instructed in the appropriate guide listed below. Note that the method for changing the Java runtime of the IDE is different between Android Studio Arctic Fox and Bumblebee. Choose one of the following:

  1. For Android Studio Arctic Fox, follow the instructions located at https://www.jetbrains.com/help/idea/2020.3/switching-boot-jdk.html.
  2. For Android Studio Bumblebee, follow the instructions located at (https://www.jetbrains.com/help/idea/2021.1/switching-boot-jdk.html.

When you are finished, Android Studio will restart with the new runtime to enable JCEF in your IDE.

Note

This feature is not available for Windows.


Last update: September 14, 2022