--- parser: v2 auto_validation: true primary_tag: software-product>mobile-development-kit-client tags: [ software-product>mobile-development-kit-client, tutorial>beginner, operating-system>ios, operating-system>android, topic>mobile, software-product>sap-business-technology-platform, software-product>sap-mobile-services, software-product>sap-build-code, software-product>sap-build, software-product>sap-business-application-studio ] time: 35 author_name: Jitendra Kansal author_profile: https://github.com/jitendrakansal slug: cp-mobile-dev-kit-cbs-client canonical_url: https://developers.sap.com/tutorials/cp-mobile-dev-kit-cbs-client --- # Build Your Mobile Development Kit Client Using Cloud Build Service Build a standard or a customized mobile development kit client using cloud build service and connect to your SAP mobile app. ## Prerequisites - **Tutorial**: [Set Up Initial Configuration for an MDK App](https://developers.sap.com/tutorials/cp-mobile-dev-kit-ms-setup.html) - **Apple ID**: A paid Apple developer account is required ## You will learn - How to generate platform specific configurations required for your MDK client - How to build a standard MDK client - How to upload your local `.mdkproject` to the Cloud Build service to build a customized MDK client - How to install the binary on your device ## Intro Cloud Build Service provides 2 options for creating a mobile development kit client: 1. Create a standard MDK client by providing your own app icon and app logo. 2. Create a customized MDK client by importing your local `.mdkproject` similar to what you might have done via MDK SDK locally on your machine. You need to: - Add Cloud Build service feature to your MDK app configuration - Upload signing profiles and/or app information - Upload your local `.mdkproject` (applies for custom MDK client) - Initiate the build After a successful build, you can download the APK or IPA file. --- ### Generate required configuration to build the MDK client >Make sure you are choosing the right device platform tab above. [OPTION BEGIN [Android]] > This step is required only if you will be using Push notification in your Android MDK client. If not using the Push, proceed to next step. 1. Open the [Firebase console](https://console.firebase.google.com/u/0/?pli=1), login with your Google account and click **Create a new Firebase Project**. ![Firebase Console Create New Project](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.1.png) 2. Provide a Project Name, click **Continue**. ![Firebase Project Name Entry](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.2.png) 3. Uncheck **Enable Gemini in Firebase** option and click **Continue**. ![Disable Gemini In Firebase Option](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.2.1.png) 3. Uncheck **Enable Google Analytics for this project** option and click **Create Project**. ![Disable Google Analytics Create Project](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.3.png) 4. Once the project is ready, click **Continue**. ![Firebase Project Ready Continue](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.4.png) 5. Click **Add app** and click **Android** icon to add Firebase to your Android app. ![Firebase Add Android App](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.5.png) 6. Provide a unique name to Android package name, click **Register app**. ![Firebase Android Package Name Registration](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.6.png) 7. Download `google-services.json` file, click **Next**. ![Download google-services.json File](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.7.png) 8. In **Add Firebase SDK** step, click **Next**. 9. In the following step, click **Next** and then click **Continue to console**. ![Firebase Continue To Console](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.8.png) [OPTION END] [OPTION BEGIN [iOS]] In order to implement Push Notifications, a paid Apple developer account is required. Students or other developers with a personal Apple ID for their team will not be able to use push notifications, because they will not have access to the Developer Portal to generate the required certificate. To enable your app for push notifications, you need to carry out the following tasks: * Obtain a certificate signing request * Create a new development certificate `.cer` file * Install the `.cer` file and create the .p12 file * Register an iOS App ID * Register your device * Create a development provisioning profile 1. Obtain a certificate signing request In order to use the **Apple Push Notification service**, you need to create a **CSR file**. On your Mac, open the **Keychain Access** application, and navigate to **Keychain Access > Certificate Assistant > Request a Certificate From a Certificate Authority...** ![Keychain Access Certificate Request Menu](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.9.png) In the dialog, enter the email address which is associated with your Apple Developer account. Also, make sure you check the **Request is saved to disk** option. ![CSR Email Request Saved To Disk](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.10.png) Click **Continue**. Choose a folder to store the certificate -- it is good practice to store generated files in a separate folder for each project -- and click **Save**. Once you see a dialog saying the certificate is saved successfully, click **Done** to finish. ![Certificate Saved Successfully Done Dialog](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.11.png) 2. Create a new development certificate `.cer` file Go to your [Apple Developer Account](https://developer.apple.com/account) and Click **Certificates**. ![Apple Developer Certificates Section](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.12.png) Click **+** icon to create a **Certificate** for your app. ![Apple Developer Add Certificate Icon](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.13.png) Select **Apple Development** and click **Continue**. ![Select Apple Development Certificate Type](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.14.png) Click **Choose File** and browse to the downloaded Signing Request `CSR` file, click **Continue**. Apple will now create a `.cer` file for you which is issued by the **Apple Worldwide Developer Relations Certification Authority**. ![Apple Certificate CSR Upload Continue](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.15.png) Click **Download** to download your certificate. ![Apple Developer Certificate Download](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.16.png) 3. Install the `.cer` file and create the .p12 file In order to create a signing profile on **SAP Mobile Services**, you need to install the `.cer` file and create the needed `.p12` file. >A `.p12` file is a encrypted container for the certificate and private key. This file is needed by Mobile Services for creating a signing profile. Locate your downloaded `.cer` file and double-click it in order to install the certificate. >In case the **Add Certificate** dialog pops up make sure to choose **Login** from the dropdown and click **Add**. If the certificate is added correctly to the Keychain you should see it in the `MyCertificates` section, make sure you selected **login** as keychain. ![Keychain MyCertificates Installed Certificate](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.17.png) Select the certificate as well as the private key and right-click to export those 2 items. ![Keychain Export Certificate And Private Key](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.18.png) Make sure that in the dropdown **Personal Information Exchange (.p12)** is selected and click **Save**. You will be prompted to enter a password, click **OK** to export the files. ![Export P12 Certificate Save Dialog](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.19.png) 4. Register an iOS App ID Click **+** icon to register a unique **Identifiers** for your app. ![Apple Developer Add App Identifier](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.20.png) Select **App IDs** and click **Continue**. ![Select App IDs Registration Type](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.21.png) Provide a unique **Bundle ID** name, **Description** and click **Continue**. ![Bundle ID And Description Entry](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.22.png) In the following screen, select option for **Deployment Details** and then click **Continue**. Confirm your App ID by clicking on **Register**. 5. Register your device Click **+** icon to register your iOS device. ![Apple Developer Register iOS Device](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.23.png) Provide **Device Name** & **Device ID (UDID)** and then click **Continue**. ![Device Name And UDID Entry](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.24.png) 6. Create a development provisioning profile Click **+** icon to create a development provisioning profile. ![Apple Developer Add Provisioning Profile](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.25.png) Select **iOS App Development** to create a provisioning profile to install development apps on test devices and click **Continue**. ![iOS App Development Provisioning Profile](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.26.png) Select an App ID from the dropdown list and click **Continue**. ![Select App ID For Provisioning Profile](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.27.png) Select the required certificate to include in this provisioning profile and click **Continue**. ![Select Certificate For Provisioning Profile](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.28.png) Select the device to include in this provisioning profile and click **Continue**. ![Select Device For Provisioning Profile](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.29.png) Provide a unique name to the profile and click **Generate**. ![Provisioning Profile Name Generate](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.30.png) In next step, download the generated provisioning profile on your local machine. ![Download Generated Provisioning Profile](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-1.31.png) [OPTION END] ### Compress your .mdkproject (Required for a customized client) If you haven't created your local `.mdkproject`, have a look at step 3 from [Build Your Mobile Development Kit Client Using MDK SDK](https://developers.sap.com/tutorials/cp-mobile-dev-kit-build-client.html) tutorial. Compress your `.mdkproject` folder, the resulting zip file will be used to create a build job for a customized mobile development kit client in Mobile Services admin UI. ### Configure device platform signing profile in Mobile Services >Make sure you are choosing the right device platform tab above. [OPTION BEGIN [Android]] 1. Open the [SAP Mobile Services admin UI](https://developers.sap.com/tutorials/cp-mobile-dev-kit-ms-setup.html) and navigate to **Settings** | **Cloud Build**. Initialize the **Cloud Build Settings** if not done before. 2. You have an option to generate a new signing profile in the Mobile Services admin UI by providing mandatory info like Profile Name, Validity, Common Name (user name). Other information are optional. ![Generate New Android Signing Profile](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-3.2.png) Or you have an option to to upload an Android Signing profile, if you already have one. ![Upload Android Signing Profile](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-3.3.png) [OPTION END] [OPTION BEGIN [iOS]] 1. Open the [SAP Mobile Services admin UI](https://developers.sap.com/tutorials/cp-mobile-dev-kit-ms-setup.html) and navigate to **Settings** | **Cloud Build**. Initialise the **Cloud Build Settings** if not done before. 2. Click **Upload** to upload iOS Signing profile and provide below information: | Property | Value | |----|----| | `Platforms`| `iOS` | | `Profile Name`| `provide a name of your choice` | | `Signing Certificate`| `Browse to .p12 certificate` | | `Private Key Passphrase`| `Enter the password that you chose while exporting .p12 certificate` | | `provisioning Profile`| `Browse to .mobileprovision file` | Click **OK**. ![Upload iOS Signing Profile Details](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-3.4.png) [OPTION END] You can find more details about Cloud Build service in [help documentation](https://help.sap.com/doc/f53c64b93e5140918d676b927a3cd65b/Cloud/en-US/docs-en/guides/features/cloud-build/overview.html). ### Create a build job in Cloud Build service >Make sure you are choosing the right tab above to build a MDK client as per your requirement. [OPTION BEGIN [Standard Client]] 1. Navigate to **Mobile Applications** **→** **Native/MDK** **→** `myapp.mdk.demo` **→** **Cloud Build**. > If you do not see **Cloud Build** feature in the **Assigned Features** list, click the **+** icon to add it. 2. Click **Create Build Job** to build your first build job. ![Cloud Build Create Build Job](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.0.png) 3. In the **Basic Information** step, select **Mobile Development Kit Client** from **Client Type** dropdown. ![Basic Information Client Type Selection](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.2.png) 4. Provide required values and click **Next**. ![Build Job Required Values Entry](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.3.png) >Bundle ID (iOS)/ Package Name (Android) is a unique app identifier used to sign mobile development kit clients. For iOS, make sure to provide the same bundle ID while registering an iOS App ID in step 1. 5. In the **Platform** step, provide a unique value to the **URL Scheme**. If you have a Firebase configuration for your client, browse to select the `google-services.json` file and click **Next**. ![Platform Step URL Scheme Configuration](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.4.png) >**Google Services JSON File**: The Firebase Android configuration file associated with your app in your Firebase project. >For Android builds: The packaging format to use for the build, including APK (Android Package Kit, the default) or AAB (Android App Bundle). Since Google requires applications uploaded to the Google Play Store be built in the AAB format, select this option if that is your plan. To install an AAB binary without using Google Play Store, you must download the AAB and use Google's `bundletool` to extract an install-ready binary from the AAB and to install that binary. Refer to their documentation on `bundletool` for more details. 6. In the **Multimedia** step, you may upload an image to use for the app logo and click **Next**. ![Multimedia Step App Logo Upload](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.5.png) 7. In the **Build Options** step, select respective Signing profile(s), set minimum platform version, select a supported SDK version and click **Finish**. ![Build Options Signing Profile SDK Selection](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.6.png) >The default version is always recommended (it will vary over time), but you can select an older SDK version. 8. Click **Build** to start the Build job. ![Cloud Build Start Build Job](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.7.png) After few minutes, Build should be completed. You can select each cloud build history row to view its current state, install, and download binaries. ![Cloud Build Completed History Row](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.8.png) You can find more details about packaging details in [help documentation](https://help.sap.com/doc/f53c64b93e5140918d676b927a3cd65b/Cloud/en-US/docs-en/guides/features/cloud-build/admin/customization.html#packaging-details-overview). [OPTION END] [OPTION BEGIN [Custom Client]] 1. In Mobile Services admin UI, navigate to **Mobile Applications** **→** **Native/MDK** **→** `myapp.mdk.demo` **→** **Cloud Build**. > If you do not see **Cloud Build** feature in the **Assigned Features** list, click the **+** icon to add it. 2. Click **Create Build Job** to build your first build job. ![Cloud Build Create Build Job](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.0.png) 3. In the **Basic Information** step, select **Customized Mobile Development Kit Client** from **Client Type** dropdown. ![Customized MDK Client Type Selection](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.9.png) >The build includes functionality to run customized extensions, application resources, and onboarding, and to include demo mode in your application. 4. Browse to your compressed MDK project as previously created. ![Browse Compressed MDK Project Upload](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.10.png) Upon upload, Cloud Build service starts validating the ZIP file. If the ZIP file doesn't conform to the `.mdkproject` structure, you may see build failures. Check the [documentation](https://help.sap.com/doc/f53c64b93e5140918d676b927a3cd65b/Cloud/en-US/docs-en/guides/features/cloud-build/admin/create.html#creating-a-build-job-for-customized-mobile-development-kit-clients) for more details. Once validation is successful, you will notice the values like Device App Name, Device App Display Name, Device App Version, Device App Details, Bundle ID, and Encrypt Database have been auto-filled/selected. These values were provided in your `MDKProject.json` and `BrandedSettings.json` as part of your local `.mdkproject`. ![Auto-Filled MDK Project Values After Validation](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.11.png) Click **Next**. 5. In the **Platform** step, URL Scheme has been retrieved from the MDKProject.json. Click **Next**. If you have a Firebase configuration for your client, browse to select the `google-services.json` file and click **Next**. ![Platform Step Firebase Configuration Upload](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.12.png) >**Google Services JSON File**: The Firebase Android configuration file associated with your app in your Firebase project. If the google-services.json is available in the uploaded ZIP file, you will see option _Show Contents_ to view the contents of the JSON file. If it is not the right file, click _Remove File_ and then you can upload a new google-services.json file to override it. >For Android builds: The packaging format to use for the build, including APK (Android Package Kit, the default) or AAB (Android App Bundle). Since Google requires applications uploaded to the Google Play Store be built in the AAB format, select this option if that is your plan. To install an AAB binary without using Google Play Store, you must download the AAB and use Google's `bundletool` to extract an install-ready binary from the AAB and to install that binary. Refer to their documentation on `bundletool` for more details. 6. In the **Multimedia** step, you may upload an image to use for the app logo and click **Next**. ![Multimedia Step App Logo Upload](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.5.png) 7. In the **Build Options** step, select respective Signing profile(s), set minimum platform version, select a supported SDK version and click **Finish**. ![Build Options Signing Profile SDK Selection](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.6.png) >The default version is always recommended (it will vary over time), but you can select an older SDK version. 8. Click **Build** to start the Build job. ![Cloud Build Start Custom Client Build](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.13.png) After few minutes, Build should be completed. You can select each cloud build history row to view its current state, install, and download binaries. ![Cloud Build Completed History Row](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-4.8.png) You can find more details about packaging details in [help documentation](https://help.sap.com/doc/f53c64b93e5140918d676b927a3cd65b/Cloud/en-US/docs-en/guides/features/cloud-build/admin/customization.html#packaging-details-overview). [OPTION END] ### Install/download binary [OPTION BEGIN [Android]] You can install this new custom MDK client app either by scanning QR code from Android phone camera app (click **Install**) or download binary (APK) locally and install in your device via IDEs like Android Studio or via other means. ![Android QR Code Or APK Install Option](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-5.1.png) ![Android Client Installation Step 2](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-5.2.png) ![Android Client Installation Step 3](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-5.3.png) [OPTION END] [OPTION BEGIN [iOS]] You can install this new custom MDK client app either by scanning QR code from iPhone phone camera app (click **Install**) or download binary (IPA) locally and install in your device via IDEs like Xcode or via other means. ![iOS QR Code Or IPA Install Option](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-5.1.png) ![iOS Client Installation Step 2](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-5.4.png) ![iOS Client Installation Step 3](https://raw.githubusercontent.com/sap-tutorials/sap-mobile-development-kit/main/tutorials/cp-mobile-dev-kit-cbs-client/img-5.5.png) [OPTION END] ---