Supported Client Types, Packaging Details, and Build Options¶
The cloud build service supports different build types, client types, and build options.
Supported Build Types¶
Build Type | SDK Version | Supported Android Versions | Supported iOS Versions | Notes |
---|---|---|---|---|
Mobile Development Kit (MDK ) and Customized Mobile Development Kit |
MDK 23.12.0 (default version), 23.8.7, and 23.4.6 | MDK 23.12.0, 23.8.7, and 23.4.6: 14.0, 13.0, 12.0, 11.0, 10.0, 9.0, 8.1, 8.0 | MDK 23.12.0, 23.8.7 and 23.4.6: 17.2, 17.0, 16.7, 16.0, 15.7, 15.0, 14.8, 14.0 | MDK 23.12.0 and 23.8.7 use: NativeScript 8.6.3 and Node 16.14.2 MDK 23.4.6 uses: NativeScript 8.4.0 and Node 16.14.2 |
SAP Mobile Cards (MCK) | 21.1.8 | 11.0, 10.0, 9.0, 8.1, 8.0, 7.1 | 15.4, 15.0, 14.8, 14.0 | |
SAP Asset Manager (SAM) | SAM 2310.0.2 (default version), 2305.0.2, 2210.0.7 and 2205.0.3 | SAM 2310.0.2, 2305.0.2, 2210.0.7, and 2205.0.3: 14.0, 13.0, 12.0, 11.0 | SAM 2310.0.2, 2305.0.2, 2210.0.7, and 2205.0.3: 17.2, 17.0, 16.7, 16.0, 15.7, 15.0 | SAM 2310.0.2, 2305.0.2, 2210.0.7, and 2205.0.3 use: Mobile Development Kit 23.8.4, SAM Plugin 2310.0.200, Native Script 8.6.1, and Node 16.14.2 |
Note
For application error due to Could not find module 'tns-core-modules/file-system'
or similar messages, refer to Metadata / Client Project Migration for application metadata migration.
Supported Client Types¶
Client Type | Required Packaging Details | Supported Build Options |
---|---|---|
Mobile Development Kit client See SAP Mobile Services, Mobile Development Kit |
|
|
Customized Mobile Development Kit clients |
|
|
SAP Asset Manager See SAP Asset Manager |
|
|
Mobile Card Kit Client See SAP Mobile Cards. |
|
|
Packaging Details Overview¶
Field | Description |
---|---|
Build Job Name | (Customized Mobile Development Kit client only) A unique build job name to replace the default name. |
Mobile Development Kit Project ZIP File | (Customized Mobile Development Kit client only) The customized Mobile Development Kit project file to upload. The file must be in ZIP format, and meet validation rules. |
Device App Name | A user-friendly name for the device application that appears as label on the device, such as My Weather App . The Device App Name is not the same as the App Name or the application ID property you configured when you defined the app, and becomes the default for this field.Note: "Cordova" is a reserved word, so you cannot use it in the Device App Name. |
Device App Version | The application version. |
Device App Display Name | The label that appears on the welcome screen after you launch the app. This must be a String value with a maximum length of 128 characters. See the note below when building client type Mobile Development Kit Client with MDK 6.2 and later. |
Device App Details | The subtitle for the application, which appears on the app's welcome page. This must be a String value with a maximum length of 128 characters. |
Bundle ID (iOS) | The unique app identifier provided by the App Store. You can change the bundle ID to match the bundle ID of the provisioning profile that you uploaded while creating the signing profile used to sign the iOS Mobile Development Kit and SAP Asset Manager clients. |
Package Name (Android) | The unique app identifier. For Android apps, the package name used to sign Android Mobile Development Kit clients. |
URL Scheme | For iOS builds: The custom URL scheme that enables other apps to communicate with your app. For Mobile Development Kit, use the URL Scheme entry for both iOS and Android builds. |
Deep Link URL (Android) | For Android builds: A related web page URL for any card template, that enables the user to open the relevant web page for each card instance. For Mobile Development Kit, use the URL Scheme entry for Android builds, not Deep Link URL. |
Google Services JSON File | For Android builds: The Firebase Android configuration file associated with your app in your Firebase project. Use Browse to navigate to and select this file. The file is uploaded to the service when you save the Cloud Build configuration. To display the contents of the JSON file after upload, select Show Contents. To remove the uploaded Google Services JSON File, select Remove File. |
Binary Format | 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 that 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 the Google Play Store, you must download the AAB and use Google's bundletool to extract an install-ready binary from the AAB and install that binary. Refer to their respective documentation on bundletool for more details. For iOS builds, the packaging format is IPA (iOS App Store Package). |
Certificate Authentication for OAuth | Set OAuth to use certificate-based authentication. For Android builds: Certificate-based authentication that uses the SAP Mobile Cards client's user certificate to satisfy the OAuth challenge during onboarding. The user does not have to enter their credentials in the identity provider (IDP) screen. |
Secure Database Encryption | Whether the database must be encrypted. True indicates the database should be encrypted. False indicates the database should be encrypted with a known key MDK (MDK >=6.2) or unencrypted (MDK < 6.2). Use the False option to debug the database content (this is meant to be used for development, debugging or demonstration purposes only). |
Allow Certificate | Whether to allow Mobile Development Kit and SAP Asset Manager clients to request a certificate from the client device during onboarding for certificate-based authentication. The client type must implement the OAuth security configuration, and you must configure the Redirect URL (you cannot use the default). Both are configured in the application security settings. When Allow Certificate is checked and the selected redirect URL starts with When Allow Certificate is checked, the selected Client ID is valid, and URL Scheme (Platform page) is empty, Redirect URL is populated automatically with the URL Scheme prefix. Alternatively, you can input the value manually and save. When Allow Certificate is checked, the selected Client ID is valid, but the URL Scheme value (Platform page) doesn't match the Redirect URL prefix, an error appears for URL Scheme informing you that the URL Scheme must match the prefix of the redirect URL because Allow Certificate is selected. |
Client ID (OAuth only) | (Mobile Development Kit and SAP Asset Manager only) Select an existing client ID option or create a specific client ID for a client build configuration. The default configuration is "Always Use Default OAuth Client ID". This option follows the original behavior of triggering the build, which uses the default OAuth client to trigger build. You can create multiple OAuth client configurations in application security (the first configuration in the list becomes the default). This enables you to select a specific client ID for a client build option. You can use a temporary client ID while configuring a cloud build configuration, but must configure a valid client ID before running the cloud build job. |
Redirect URL (OAuth only) | (Mobile Development Kit and SAP Asset Manager only) Either select the automatically generated universal link or enter a valid redirect URL. For example, RedirectURL="myurlscheme://oauth2redirect" . |
Note
When building client type Mobile Development Kit Client with MDK
6.2 and later:
-
If a value is provided in the Device App Display Name field, the same value is also used as the launcher name, which is the text under the application icon on the device screen. When specifying this value, please consider the launcher naming recommendations made by various app stores, and possible consequences if they are not followed.
-
Otherwise, the launcher name uses the value of the Device App Name field.
Supported Build Options¶
Build Option | Description |
---|---|
Create Debug-enabled Binaries | Whether to build the binary with debug enabled. |
Signing Profile | The signing profile with which to sign the binary. |
SDK Version | Select the SDK version to use for the build, or use the SAP recommended version. |
Minimum Platform Version | The minimum device operating system version required to install the binary. |
Save Project | Whether to save the project so you can download it later using Download Project, if required. |