Managing Apps

Administrators interact with SAP Mobile Services (mobile services) to ensure the production environment works efficiently.

Administrator tasks fall into two main categories:

• Application administration for configuring applications for deploying to users and monitoring application in the user community.
• Security administration for determining the SAP Business Technology Platform security features used for mobile applications.

User Interface

Frequently used icons in the SAP mobile service cockpit. Actual icon styles may vary slightly.

Icon	Purpose	Description
	Toggle Menu	Toggle between showing and hiding the navigation menu in the left pane. Display the menu for fast navigation; hide it to maximize the window area.
	Home	The SAP mobile service cockpit home screen shows the last five apps that were accessed, a summary of alerts from the last 24 hours, and relevant KPIs for new registrations and push messages. If Preview appears in the title, you are accessing the preview system instead of the production system. Preview enables you to test new features for a week or so before they are released for production, but the preview landscape is not intended as a development or production environment. Your login name appears in the upper right corner. Select your name to view a drop-down menu. If Helpdesk appears after your name, you are in read-only mode. Some buttons and features will be grayed out or not available.
	Mobile Applications	Create a new application definition, which enables you to use the SAP mobile service cockpit to manage the application.
	Analytics	View analytic charts for the SAP Mobile Applications.
	About	View information about SAP mobile service cockpit. Click your login name in the upper-right corner to see the option. Build: The date and time of the software build, in the format YYYYMMDD-HHMM. For example: 20230114-0832 indicates that the build was made on January 14, 2023 at 08:32 AM. Version: The SAP mobile service cockpit software version. The format YYMM indicates the general availability year and month, such as 2301. The format PLxx indicates a patch version, such as PL10.
	Settings	Select your login name, then User Setting to change your settings and then Save. Theme: select your preferred color and contrast option from the list, which includes Default, High Contrast Black, or High Contrast White. The SAP mobile service cockpit user interface reloads in the new theme. Language: select the language to use for the SAP mobile service cockpit. The user interface reloads in the new language. For supported languages, such as Arabic, the primary calendar is reloaded in right-to-left format and the Gregorian calendar is used as secondary. Note that business logic, such as calculating by periods and running business processes, is still based on the Gregorian calendar. Time Zone: select either the local or UTC time zone format. Reports are also displayed in local or UTC format, depending on your selection.
	Legal Information	You can find important links for Legal Disclosures, Privacy, Terms of Use, Copyright, and Trademarks.
	Notifications	Select to view notifications. For example, you may be alerted if a service plan limit has been reached or if you should check log files for information. Notification may provide useful information when configuring and using mobile services.
	Give Feedback	Respond to a short survey and provide free-form text. Your feedback is anonymous and used to improve SAP Mobile Services. No personal data is collected. The survey changes periodically and is currently in English only.
	Support	Select to access built-in support without leaving the SAP Mobile Services cockpit. You have access to blogs, articles, videos, and tutorials. You can also create support tickets and use Expert Chat, if you are authorized and sign in with your SAP Universal ID.
	Help	Toggle embedded help on and off. You can expand and collapse the Help Topics pane to view and hide the topics while you work. Note that for a few languages, such as Simplified Chinese and Japanese, embedded help has been translated. Embedded help that has not been translated appears in English. If a Guided Tour icon appears, select it and then the guided tour name.
	Guided Tours	Guided Tours walk you through the basic steps of a procedure from within the SAP Mobile Services cockpit, such as configuring the Mobile Network Trace feature. For more information, see Guided Tours.
	Log Out	Log out of the application. Click your login name in the upper-right corner to see the option.
	SAP BTP Cockpit	Clicking this takes you to your BTP Subaccount.
	SAP BTP Space	Clicking this takes you to your BTP Space.
	Profile	Your login name appears in the upper right corner. Select your name to view a drop-down menu.
	User Information	You can view the User Name, ID, and Email of logged-in user.
	Privacy Statement	The Privacy Statement from SAP outlines their commitment to data protection and privacy, detailing how they process personal data. This document is useful for understanding how SAP handles personal information and for managing cookie preferences on their site. To access the Privacy Statement, go to Profile, choose Privacy Statement. Alternatively, you can find it by navigating to Legal Information under Toggle Menu and choose Privacy Statement.
	Create	Configure a new resource for a feature, such as a new destination.
	Action Settings	View available actions, such as customizing table columns.
	Refresh	To retrieve fresh copies of data.
	New	Add a new item, for example, a destination, a provider, or a feature restriction policy.
	OData Destination Quality Test	OData destination quality testing ensures data accuracy and reliability. It is essential for ensuring that OData destinations are functioning properly and delivering high-quality data for use in various applications and systems.
Ping	Ping	Ping a destination.
	OData Application Destination Test, or Launch Web App	Depends on the context. When setting up a destination, use to test an OData application destination. When working with the ESPM sample data in SAP mobile service cockpit, use to launch a Web user interface to test your app.
	Launch in Browser	Test a destination for scenarios that do not work from SAP mobile service cockpit, such as Cloud Connector SSO Forward, and OAuth2 User Token exchange, because they require a business user (end user) login.
	Sort	Sort a list based on criteria you choose, such as ascending or descending order, or the column name.
	Upload	Upload an object.
	Reset Filter	To reset the applied filters.
	Download	Download an object.
	Locked	The application is locked, so you can't make any edits.
	Unlocked	The application is unlocked and can make edits.
	Details	See details about the selected resource.
	Copy URL	Copies a URL string to the clipboard, enabling you to paste the complete URL elsewhere.

Guided Tours

Guided Tours may be available to walk you through the basic steps of a procedure in the SAP Mobile Services cockpit.

1. Select the help icon ( ). A Guided Tour icon appears only if a Guided Tour is available.

2. Select the Guided Tour icon. One or more Guided Tours may be listed.

3. Select a Guided Tour (this is required even if only one is available).

4. The first Guided Tour dialogue appears. Follow the instructions.

   Note

   Behavior may differ based on screen type and size. If necessary, you can drag a dialogue to a new location to see text or user interface elements.

Getting Support From the Cockpit

Get built-in support for SAP Mobile Services without leaving the cockpit. You have access to blogs, articles, videos, and tutorials, and can use Expert Chat and create a support ticket if authorized.

If you plan to create support tickets and use Expert Chat, you must sign in with your SAP Universal ID. If you are not authorized for these activities, these options are not available.

1. In SAP Mobile Services cockpit, select the headset icon to access embedded support.

   The first time you access embedded support, the Welcome to Built-In Support screen appears with onboarding screens to help you get started. Select Next to view the screens and then Get Started to access the Built-In Support screen.

   Alternatively, you can select Skip to bypass the onboarding screens and go directly to the Built-In Support page. You can revisit the onboarding screens at any time by selecting from the Built-In Support screen.

2. From the Built-In Support screen you can do the following:

   • Enter a topic and select the search icon . For example, enter logs or XSUAA to search for information about the topic.

   • Under Our Recommendations for This Page, access useful links such as the What's New for SAP Business Technology Platform, information about managing apps from the SAP Mobile Services cockpit, the SAP community, and the SAP Mobile Services product page.

   • From the banner:

     • Select to access the onboarding screens, watch video tutorials and access help for built-in support, set cookie preferences, and more.

     • Select to sign in with your SAP Universal ID and access your system context information.

     • Select to close the Built-In Support screen.

3. Select Sign In to sign in with your SAP Universal ID to get access to built-in support functions like case creation and Expert Chat.

   You are informed if no S-user is authorized and prompted to link your existing accounts like S/P user IDs to get access to all built-in support options. If you are eligible, you can follow the prompting. To learn more, see SAP Note 2617792 - Digital Support Experience Troubleshooting Guide (login required).

Accessing BTP Cockpit and Dev Space Manager

From the SAP mobile service cockpit, you can navigate to the associated BTP Account and Dev Space Manager.

1. Go to the SAP mobile service cockpit.

2. On the Home screen, choose from the top right corner.

3. Choose SAP BTP Cockpit to access the associated SAP BTP Cockpit Subaccount.

4. Choose Dev Space Manager to access the associated Dev Space.

5. The SAP BTP Cockpit wizard opens in the new browser window. Choose your global account and choose Continue.

Creating an Application

Create a new application definition, which enables you to use the SAP mobile service cockpit to manage the application.

• When you select a SAP Application, Native, Hybrid, or Mobile Development Kit template, the most typical features for the application type are selected automatically. You can add or remove features at this time, or take care of it later.

• Some features, such as Client Settings and Connectivity are required, so you cannot remove them.

• Other features have dependencies, so you either need to remove them in a specific order or cannot remove them at all. For example, Offline Access requires Connectivity, and Cloud Build requires App Catalog.

After you define the application, configure the assigned features, or add more features. For more information, see Managing Application Features and Configuring Assigned Features.

1. In SAP mobile service cockpit, select Mobile Applications > Native/MDK, and choose New.

   Note

   lite and free service plans impose a limit on the number of applications that you can implement. If you reach the limit, you'll see a message and you'll have to delete an application to continue. For more information, see Service Plans.

2. On the Type of Application screen, select the application type. We support the following application types:

   • SAP Application: Customizable applications shipped by SAP, like SAP Service and Asset Manager.
   • Mobile Development Kit (MDK): Single-Source, metadata-based applications that can be deployed on web or mobile clients.
   • Native: Applications built using SDKs that run natively on iOS or Android.
   • Hybrid: Applications built using Hybrid Application Toolkit.

3. On the Basic Info screen, enter the application properties, and then choose Next.

   Application Properties

   Field	Value
   Type of Application	Displays the application type selected in the previous step. You can go back to the previous step to change the Type of Application.
   SAP Application	Choose the SAP shipped applications that you want to customize, like SAP Service and Asset Manager.
   Service Plan	Select the service plan for your account: resource: Use this for custom application development. Billing is based on active resources, which are user identifiers (or device identifiers for anonymous users). build-code: Use this for custom application development. Billing is based on capacity units, which is calculated based on active resources. build-default: This is dedicated plan for SAP Build, which allows AI-based development and automation. For more information, see Active Services Plans for SAP Mobile Services basic-plus-app: The plan offers a comprehensive feature set. It is ideal for SAP mobile applications. free: You can start using the service for free with no feature limits. When you reach the quota limits, you can switch to the paid version. lite: This plan is only for trial accounts. It has no feature limits, but it is subject to quota limits and cannot be upgraded to production. b2c (consumer edition) (deprecated): The billing for Consumer Edition is based on active users, with no feature limitations. You can have unlimited users and apps. standard (deprecated): The billing for the standard plan is based on the number of registered users. There are no feature limitations. kernel-service: This plan is used for an application that is managed in a single-app cockpit (Software as a Service, or SaaS). These properties are only visible when the correct license has been configured in the subaccount's entitlements. The license determines capabilities and charges. Each resource/user is charged only once for global accounts. For more information, see Service Plans and Changing Service Plans at the App Level.
   ID	Unique identifier for the application, in reverse-domain notation. This is the application or bundled identifier that is assigned or generated by the application developer. The administrator uses the application ID to register the application with mobile services, and client applications use the application ID when sending requests to the server. An application ID: Must be unique Must start with an alphabetic character Can contain only alphanumeric characters, underscores, dashes and periods Can contain up to 64 characters Cannot include spaces Cannot begin with a period, and cannot contain two consecutive periods Cannot begin with com.sap or sap Cannot be the keyword com.sap.mobile.platform.cards and com.sap.mobile.mtb If you are building an Android application, its ID must follow the rules defined below; otherwise, the Android build process fails: The ID must have at least two segments (one or more periods). Each segment must start with a letter. All characters must be alphanumeric or an underscore [a-zA-Z0-9_]. We recommend that you assign IDs that contain a minimum of two periods, for example, sample.com.sap.mobile.app1.
   Name	The application name can contain only alphanumeric characters, spaces, underscores, and periods, and can be up to 80 characters long.
   Description	(Optional) The description can contain up to 255 alphanumeric and special characters.
   Supplier	(Optional) Supplier that developed the application. The supplier name can contain only alphanumeric characters, spaces, underscores, and periods, and can be up to 255 characters long.
   Domain of Application Route	In regions that support multiple domains, select the application route through which end users can reach the application. Routes are associated with a space, and are configured in SAP Business Technology Platform cockpit. The drop-down list shows all shared and custom domains that are available for the customer organization. If you want to use a custom domain, you can create one according to information in What Is Custom Domain.

4. On the Security Settings screen, enter configuration values and then select Next.

   For environments where Identity Authentication service (IAS) has been configured, you have the option to select either the IAS or XSUAA (extended UAA) security configuration when you create a new mobile application. See Configuring IAS Security for information about configuring the Identity Authentication service.

   • XSUAA Settings - select this option to use the SAP Authorization and Trust Management service method for authentication.

   • IAS Settings - select this option to use the Identity Authentication service method for authentication (also called Authentication).

   See the following tables for configuration values, depending on your selection. You can modify these values later on the Security tab, as described in Configuring App Security.

   XSUAA Settings

   Field	Value
   XSUAA Service	Select the XSUAA authentication and authorization service to use. You can select Default Instance to create a new instance, or you can select an existing service from the list. Using an existing XSUAA instance is useful if you already have a Cloud Foundry application deployed and want to connect from mobile services to this application. In this case it can be handy to re-use an existing XSUAA instance. Select the default instance for other scenarios.
   xs-security.json	A JSON file that defines the authentication methods and authorization types used to access your application. For more information, see Application Security Descriptor Configuration Syntax.
   Token Lifetime	Enter the token lifetime and select the units (Hours or Minutes). The default token lifetime is 15 minutes, and the allowed range is 10 minutes to 24 hours. For more information, see Application Security Descriptor Configuration Syntax.
   Refresh Token Lifetime	Enter the refresh token lifetime, and select the units (Days, Hours, or Minutes). The value must be greater than the Token Lifetime value. For more information, see Application Security Descriptor Configuration Syntax.
   Approved Providers	Indicate whether the app should support all approved providers or only selected providers.
   System Attributes in Token	Indicate groups, role collections or both.

   IAS Settings

   Field	Value
   IAS Settings	Select the Identify Authentication service to use. You can select Default Instance to create a new instance, or you can select an existing service from the list.
   Security-config.json	A JSON file that defines the authentication methods and authorization types used to access your application. For more information, see Reference Information for the Identity Service of SAP BTP.
   Token Lifetime	Enter the token lifetime, and select the units (Hours or Minutes). The default token lifetime is 15 minutes, and the allowed range is 10 minutes to one hour. For more information, see Reference Information for the Identity Service of SAP BTP.
   Refresh Token Lifetime	Enter the refresh token lifetime, and select the units (Days, Hours, or Minutes). The default refresh token lifetime is 30 days, and the allowed range is 1 hour to 180 days. For more information, see Reference Information for the Identity Service of SAP BTP.

5. On the Role Settings screen, enter roles and then select Next.

   The Enable Role Settings option is selected by default. When selected you must add one or more roles to the list. Only users who are assigned these roles can access the app, which helps ensure better security. SAP recommends enabling roles.

   Enter one or more role names, separated by either commas or the Return/Enter key, for example Developer, Sales, Manager. To learn more about default Cloud Foundry roles, see Org, Spaces, Roles and Permissions.

   Once the roles have been entered, you can maintain them through the Security tab for the app as described in Configuring App Security.

6. On the Assign Features screen, a set of features is selected by default. Here you can customize these features according to your requirements. The following table displays the features enabled by default for the different types of applications. You can disable the features that aren't required. You can make further changes as described in Managing Application Features.

   Features Selected by Default	SAP Application	Mobile Development Kit	Native	Hybrid
   App Catalog	Yes*	Yes*	No	No
   App Update	Yes	Yes	No	Yes
   Client Log Upload	Yes	Yes	Yes	Yes
   Client Settings	Yes*	Yes*	Yes*	Yes*
   Client Usage and User Feedback	No	No	Yes	No
   Cloud Build	Yes	Yes	No	No
   Connectivity	Yes*	Yes*	Yes*	Yes*
   Offline Access	Yes	Yes	Yes	Yes
   Push Notification	Yes	Yes	Yes	Yes

   Note

   * indicates that this feature is mandatory and cannot be unselected

   The following is the list of basic features.

   Feature	Description
   App Catalog	Upload mobile application artifacts for beta testing, and for deployment to external services.
   App Update	Upload new versions of a hybrid or Mobile Development Kit application.
   Augmented Reality	Manage client augmented reality resources that can be accessed from mobile applications.
   Setting Exchange	Handles device registrations and provides exchange of general settings between mobile client and server, such as client policies.
   Client Resources	Add client resources to an application.
   Connectivity	Allows you to define the connectivity to back-end systems that the application can use.
   Offline Access	Enable secure, offline access to data on the device.
   Push Notification	Register devices to receive native push notifications.
   Client Log Upload	Enable application to upload application log files and to analyze them on the server.
   Network Trace	Enable application to trace network activity based on user name or content type.
   Sample OData ESPM	Use OData sample service during development and testing.
   Client Usage and User Feedback	Enable application to upload client usage and feedback information and analyze it on the server.
   Cloud Build	Build binaries for your Fiori Launchpad or individual SAP Fiori business apps, and enable them to use the SAP Mobile Platform SDK.

7. On the Review screen, you can verify the details of the application definition that you are creating. Make sure all the details are correct. Choose Edit to make any necessary modifications to the section.

8. Choose Finish to create the application definition. The Info tab displayed with the current settings.

   Note

   If you don't select Enable Role Settings on the Role Settings screen while defining the application, a warning message appears. You can choose OK to continue creating the application definition.

Application Administration

Use SAP mobile service cockpit and other tools to manage and monitor native, hybrid, and Mobile Development Kit mobile applications. Managing includes defining and configuring applications, monitoring applications and application usage, viewing statistics and logs, checking system health, and troubleshooting problems.

Native (online and offline), hybrid (Kapsel - offline), and Mobile Development Kit applications are developed using a variety of tools and methods. SAP tools facilitate the development of mobile apps, with modularized methods for downloading, logging on, push notification, and error reporting. During the development process, a unique application identifier is generated for each application, and the application is deployed to an application download site or to SAP Mobile Services. Web applications are run on-premise, but securely exposed through SAP Mobile Platform or mobile services.

The administrator creates an application definition in SAP mobile service cockpit, which includes the unique application identifier,plus the connection to its back-end data source in the production system, the security configuration, and application-specific entries.

The administrator provisions applications to devices through native application stores, or through enterprise Website downloads. When a user logs in to an application (or accesses the application as an anonymous user), the application+user+device combination is registered in SAP mobile service cockpit. This registration enables you to manage and monitor device applications in the field using SAP mobile service cockpit, and to take advantage of individual and aggregate usage statistics.

You can perform the following:

• You can add, edit, or delete applications, and export and import applications.
• You can view all applications, or retrieve a filtered subset of applications.
• You can sort by column, and refresh the list. From the list of applications, you can drill down to see summary and detailed information for a particular application.
• You can lock an application to prevent accidental changes. If an app is locked, you must unlock it to modify it.

For apps that have been migrated to single-service apps, enable detailed event logging at the application level. You can select individual services to include and the Mobile AppRouter, as described in the Log Settings in the below section.

For multiple-service apps (apps that haven't been migrated to any service), you must enable detailed event logging at the service level. Select Enable Detailed Event Log to collect detailed messages. Select Disable Detailed Event Log to stop collecting detailed messages (error messages are still collected).

Access Analytics > Logs to view the event logs, as described in Viewing Event Logs.

1. In SAP mobile service cockpit, select Mobile Applications > Native/MDK.

   You can view a list of applications with summary information Application ID, Name, Supplier, Type of Application, Service Plan, State and Creation Date. Use the search and sort options to locate the applications you're interested.

   Note

   Apps managed by App Lab do not appear in the application list. To manage App Lab updates, see Mobile App Catalog Artifacts.

   Native/MDK Application Summary

   Column	Description
   Application ID	The unique application identifier. Locked applications are labeled as Locked.
   Name	The application name.
   Supplier	The supplier who supplied the application.
   Type of Application	Display the type of application.
   Service Plan	Display the service plan consumed for the application definition: resource: Use this for custom application development. Billing is based on active resources, which are user identifiers (or device identifiers for anonymous users). build-code: Use this for custom application development. Billing is based on capacity units, which is calculated based on active resources. build-default: This is dedicated plan for SAP Build, which allows AI-based development and automation. For more information, see Active Services Plans for SAP Mobile Services basic-plus-app: The plan offers a comprehensive feature set. It is ideal for SAP mobile applications. free: You can start using the service for free with no feature limits. When you reach the quota limits, you can switch to the paid version. lite: This plan is only for trial accounts. It has no feature limits, but it is subject to quota limits and cannot be upgraded to production. b2c (consumer edition) (deprecated): The billing for Consumer Edition is based on active users, with no feature limitations. You can have unlimited users and apps. standard (deprecated): The billing for the standard plan is based on the number of registered users. There are no feature limitations. kernel-service: This plan is used for an application that is managed in a single-app cockpit (Software as a Service, or SaaS). These properties are only visible when the correct license has been configured in the subaccount's entitlements. The license determines capabilities and charges. Each resource/user is charged only once for global accounts. For more information, see Service Plans and Changing Service Plans at the App Level.
   State	The current state of the application: Started ‒ the application is running normally. Inconsistent ‒ applications may become inconsistent if they are deleted or changed from the SAP Business Technology Platform Cockpit. You can either delete or restore the application from SAP mobile service cockpit Cockpit Deleted from SAP Business Technology Platform Cockpit -the application was deleted. You can restore or delete it in SAP mobile service cockpit. Restoring ‒ the application is being restored from an inconsistent state.
   Outdated	Whether the application is outdated. If checked, you are prompted to update the application to a newer version that contains fixes and improvements. Typically, you should update the application.
   Creation Date (UTC/local)	The application creation date, either in UTC or local format, depending on what you selected for your User Setting.

2. Select an application to view its details. To prevent accidental changes, you can lock an application once its configurations are complete. To make changes, you'll need to manually unlock the application.

   When the application is locked, the label Locked appears next to the Application Name. This prevents you from making any edits to its configuration.

   Note

   Unlocked applications are labeled as Unlocked.

   • Settings: This tab provides a general settings for the selected application. General settings includes Connectivity, Client Settings, Security, Log Settings, Alert, Application Links and Attestation. To set the information on this tab, see Creating Applications. In the Cloud Foundry environment, you can also configure a custom domain. For more information, see Editing an Application and Managing Custom Domains.

     • Connectivity: The Connectivity feature of SAP Mobile Services allows you to define the connectivity to back-end systems that the application can use. You can define any number of destinations to different back-ends. Those destinations are to be used exclusively by the application for which they are configured. You can restrict access to allowed paths. For more information, see Defining Connectivity.
     • Client Settings: Set client policies for the selected mobile application and manage its user registrations. For more information, see Defining Client Policy and Feature Restrictions and Managing JSON Storage.
     • Security: This tab enables you to manage security for the selected application. For more information, see Configuring App Security.
     • Log Settings is for apps that have been migrated to the single-service model, and is used to enable event logs at the application level. You can specify any of the individual services that are assigned to the app, as well as Mobile AppRouter. This gives you more control over the event log information you want to see at the application level. For more information, see Enabling Event Logs at the App Level. You can continue to view event logs as described in Viewing Event Logs.
     • Alert: This tab lets you configure settings for server failures in various categories. Once configured, implement the SAP Business Technology Platform Alert Notification Service to receive notifications. For more information, see Configuring Alert Settings and Subscribe to Mobile Service Alerts.
     • Application Links: This tab enable universal links for Apple and application links for Android apps. Apple universal links and Android application links enable users to open an application locally without downloading the app or using a browser container. For more information, see Creating Application Links.
     • Attestation: This tab enables attestation capabilities for the selected app, and lets you configure iOS or Android attestation settings. Device attestation enables developers and administrators to learn about the software and hardware environment of devices that are trying to connect to enterprise apps and workspaces. For more information, see Configuring iOS Attestation and Configuring Android Attestation.

     To configure additional features, navigate to the Settings > Add-On Features. Choose Add Feature, select required application and choose OK.

     The add-on feature appears under the Add-on Feature list. For more information, see Configuring Assigned Features.

     To remove an Add-on Feature, choose the feature to open the feature configuration screen, then choose Remove from Application. In the Cloud Foundry environment, you can also configure a Custom Domain. For more information, see Editing Application and Managing Custom Domains.

   • API: This tab provides onboarding and API features.

     Under Onboarding section, you can find one or two QR codes that can be used to configure the mobile application to connect to this mobile services instance.

     For In-app Scanning Code, the device user must first manually launch the app, then scan the QR code from within the app to initiate the onboarding process.

     For Default Configuration, native app developers can download a native-specific file containing the Discovery Service default configuration. Select iOS to download the configuration file in plist format, or select Android to download the file in JSON format. Add the file to your iOS or Android app project without further formatting.

     For Configuration, you can view any application routes that you've associated with the application. Select edit to make changes. See Creating Applications for information about the XSUAA property, Domain of Application Route.

     For Apple and Android Launch App Code, the device user can select the URL (or scan the QR code for Apple's Camera App or an Android application that allows reading QR codes) to find and launch the application installed locally. If the user enables Android app links, it also supports Android's camera app. The App-launch QR code is generated if you enable Apple Universal Links or Android App Links or both of them in the Application Links section; the label text of the QR code depends on which application links are enabled (Apple launch app code, Android launch app code, or Apple and Android launch app code.

     For Apple and Android Launch App Code with URI Scheme, the device user can scan the QR code or select the URL, to use an appLink URL to find and launch the application. This option only appears if you enabled Device Application URI Schemes in the Application Links tab. You must select one Device Type, and input the corresponding device application URI Scheme for iOS or Android.

     Note

     (Mobile Development Kit only) If you set up Apple and Android Device Application URI schemes in the Application Links tab, you see two separate QR codes, labelled Apple Launch App Code with URI Scheme and Android Launch App Code with URI Scheme.

     If the app security configuration changes, you must generate a new QR code. Also, please note that the URL can be very long and might be longer than the value shown on the screen. Use the copy to clipboard button to copy the complete value.

     Under API, you can view a list of frequently used API URLs. Use Copy URL ( ), to copy read-only URLs to the clipboard, to paste elsewhere, avoiding typing errors and ensuring accuracy.

     Note

     The Server URL is also the <mobile_services_host> name.

   • User and Device Management: This tab enables admins to perform one or more user and device related actions such as Block, Revoke, Lock, Export User Data, Send Push Notification, Wipe and Delete.

   • Discovery: This tab enables you to add application configurations at the application level. You can either add the domain or the onboarding code along with the configuration data to each app. You can add the same application configuration to multiple domains.

Editing an Application

Edit an existing application from the application list.

1. In SAP mobile service cockpit, select Mobile Applications > Native/MDK.

2. Select an application, and choose Edit to make modifications. You can edit the Service Plan, Name, Description and Supplier details. See Creating an Application for application properties.

   Note

   You cannot edit the application when it is locked.

3. Save your changes.

Deleting an Application

Delete an application from the application list. For any SAP Fiori or hybrid apps regenerated with the Cloud Build Service, deleting the application also permanently deletes any binaries that are associated with the application.

1. In SAP mobile service cockpit, select Mobile Applications > Native/MDK.
2. Select an application and choose .

3. Click OK to confirm.

   Note

   Once an application has been deleted, users won't be able to use it. All existing logs and traces are deleted and cannot be retrieved.

Managing App Users and Device Registrations

With User and Device Management, users can perform a variety of actions at the application level. This includes blocking and unblocking users, sending push notifications, revoke user access to the application, locking and unlocking users and exporting user data.

In addition, you can manage device-related actions such as wiping device registration data, and deleting device registrations.

1. In SAP mobile service cockpit, select Mobile Applications > Native/MDK.

2. Select an application, navigate to the Users and Device Management tab. This screen has 2 sections:

   • Registered Devices: This section shows numbers in parentheses, representing the current count of application registrations.
   • Blocked Users: This section shows numbers in parentheses, representing the current count of blocked user for the application.

3. The Registered Devices section you can perform various actions such as blocking, deleting, wiping, locking, and revoking access for individual users and devices.

4. Enter search criteria to narrow the focus to specific users or groups of users, and then select Go. You can search based on User Name, Registration Time Frame (either a predefined time frame, or a custom time frame using the calendar date-picker to define a range), Device Type, Email Address, Compliance Status (Compliant, Compromised, or Unknown), or Wipe Status (NOT Wiped or Wiped), or Lock Status (NOT Locked or Locked) or Block Status (NOT Blocked Users or Blocked Users).

5. View the search results to see registered users.

   Registered Devices

   Column	Description
   User Name (Blocked)	Name of the users who have registered to the application are listed. Users who are blocked carry the label Blocked.
   Registration ID	Unique identifier provided by the client application, or system-generated application registration ID. A selection box appears to the left of each registered user.
   Device ID	Device identification.
   Device Type	Type of device, such as Android or iPhone, sent by the device during registration/onboarding. Unknown indicates that the device type cannot be detected.
   Last Connection (UTC+0000)	The date, time, and time zone of when the application was last active and a request was received by SAP Mobile Services, in the format YYYY-MM-DD HH:mm:ss.
   Wipe	Whether the application connection is set to be wiped.
   Lock	Whether the application connection is set to be locked.
   Actions	Actions include sending a push message to a registered user and exporting user data.

6. In the Registered Devices section, you can perform various actions such as blocking, deleting, wiping, locking, revoking access for individual users and devices.

   • Lock a user and Wipe a device registrations

     The Lock (users) and Wipe (device registrations) enhances the security and management of registered users and their devices. Enabling Wipe toggle button logs out the selected users from the app on the specified devices and locks the user. It also wipes all app-managed data on those devices. This action is irreversible. The app doesn't restore any data it previously managed that's been wiped.

     The Unlock button lets administrators restore access for users on a specific device after an unlock. This button turns off the Wipe function for the chosen registration and unlocks the user. It lets them log back into the app on the same device. But, keep in mind, any data the app previously wiped isn't restored.

     See Defining Lock and Wipe Policy for related information.

     Note

     In the User Registration details screen, you can click Enable Lock button to lock the user, this action turns off the Enable Wipe button. Similarly, when you click Disable Lock button, it turns on the Enable Wipe, and vice-versa.

   • Delete User Registration(s)

     To delete one or more user registration(s), select the check box to the left of the User Name column. Then, click Delete User Registration(s).

     For apps configured for OAuth security, when you delete a user registration, all related OAuth tokens are automatically revoked. This applies regardless of whether the app is using the Admin API or the Client Runtime API.

     When a user has a single registration in the list and they delete it, their registration gets revoked. As a result, their registration no longer shows up in the list. On the other hand, if a user has multiple registrations in the list and they delete one, all their other registrations also get revoked. Consequently, their registrations no longer appear in the list.

     In either case, when the user registration is deleted, user registrations do not appear in the cockpit and are not included in metering data. When the user logs back in to the app, a new OAuth token is automatically generated, and old tokens are physically deleted. The user registration again appears in the list and is counted when sending metering data. This feature ensures that only the latest OAuth tokens are used and that old tokens are deleted.

   • Revoke an OAuth Token of a user

     Select Revoke to revoke all OAuth tokens used by a registered user. The next time the user logs in, a new OAuth token will be issued, ensuring that only the most current token is used. This feature is available only for applications that use OAuth Security Configuration, including those that use Identity Authentication Service (IAS) and Software as a Service (SaaS). For more information, see Revoking an OAuth Token for information. If the Revoke button does not appear, the feature is not supported for the configuration.

   • Enable Automatic Removal You can select this option to determine if application registrations should be removed automatically after a certain number of days. To adjust the number of days, simply click on the Edit icon. The inactivity period is counted from the last request in an authenticated session of that registration. This means the last access time of that registration.

   • Send Push Notification Choose Send Push Notification to a user by clicking on the 3 dots from the Actions column. In Send Push Notification, type your message and then click Send. The message The native push notification was sent successfully confirms that the message was sent.

   • Export User Data Choose Export User Data by clicking on the 3 dots from the Actions column.

   • Trigger Initial Download and Cancel Initial Download - Registration Level Trigger Initial Download: This triggers a full download of app data from the offline service for the selected registered device. Any local changes are kept during the re-download.
     To start a download, choose in the Actions column and choose Trigger Initial Download. In the warning pop-up, choose Trigger Initial Download.
     

     Cancel Initial Download: This action stops the full download of app data from the offline service for the selected registered device.
     To cancel download, choose in the Actions column and choose Cancel Initial Download. In the warning pop-up, choose Cancel Initial Download.

     Note

     In the User Registration details screen, you can choose and choose Trigger Initial Download to trigger full download or choose Cancel Initial Download to stop the full download.
     
     To trigger initial downloads at the application level, see Defining Offline Settings for Applications.

   • Block and Unblock a user To block a user, first select the user. This action opens a User Registration details screen for the chosen user. Here, click Block User button.

     Blocking a user prevents them from registering the Native/MDK application or receiving traffic. A Block User Access message pops up, letting you know that blocking user access logs the user out of the application. The user can't log back into the application unless they're removed from the list of blocked users. Click OK to confirm. A User Blocked message appears, and Blocked is written under the User Name column for that user.

     To unblock the user, click Unblock button. A Unblock User Access message pops up, letting you know that unblocking user access allows the user to regain access to the application. The user can then log in through any device. Click OK to confirm. A User Unblocked message appears.

     You can also unblock a user from another screen. Select User and Device Management > Blocked Users. A list of blocked users appears. From this view, you can unblock users by clicking on Unblock button from the Action column.

     Additionally, you can filter usernames as needed. Click icon to add existing unique users to the blocked user lists.

Changing Service Plans at the App Level

If you change Service Plans at the SAP Business Technology Platform level, you may also need to change service plan settings at the mobile services app level. The terms license type and service plan are used interchangeably. The license determines capabilities and charges.

Before you start, it is recommended that you have a good understanding of the service plans available, and your current service plan. You can check the SAP Business Technology Platform cockpit to see your current active mobile services service plans. Be aware of whether the mobile services app and Cloud Foundry Runtime are under the same Service Plans. To be billed properly, all existing services must be on the right service. For example, if the app is under the free plan, the Cloud Foundry Runtime must also be under the free plan or charges are incurred.

For more information, see:

• Service Plans
• Important Free Plan Information
• Upgrading the Cloud Foundry Runtime

Also keep in mind these guidelines:

• The standard (Users) and b2c (Consumer Edition) service plans are deprecated and are not a good long-term selection.

• The basic-plus-app offers a comprehensive feature set. It is ideal for SAP mobile applications, such as SAP Service and Asset Manager.

• You can change your service plan from free to resources or build-code or build-default, enabling you to migrate your app without losing your work.

• Migration is not reversible. You cannot switch from resources, build-code, build-default, standard (Users), or b2c (Consumer Edition) to free.

• The kernel-service license type is used for an application that is built by SAP and managed in a single-app cockpit (Software as a Service, SaaS). The license type is defined by SAP and thus, is read-only and cannot be selected or edited in the cockpit.

• If the basic-app license type is chosen, the Mobile Offline Access feature will be disabled.

To change plans:

1. In SAP mobile service cockpit, select Mobile Applications > Native/MDK.

2. Select an application, and choose Edit to make modifications.

3. In Edit Application Details, locate the Service Plan field. Its value represents the service plan that was in place at the time the app was created or deployed in mobile services cockpit. For example, you may have started with a free plan (non-trial landscape) or a lite plan (trial subaccounts).

4. Select the target service plan from the Service Plan drop-down list, keeping in mind guidelines and limitations. For example, if you currently have the free plan, you could select resources to change plans at the app level.

5. Save your changes. It is a good idea to monitor your billing to make sure it reflects the changes you intended to make.

Note

• It is a good idea to monitor your billing to make sure it reflects the changes you made.
• It is recommended to change service plans from your Mobile Services cockpit. Only purchased service plans are available for selection.
• Additionally, you can update the service plans from the SAP Business Technology Platform (SAP BTP). For more information, see Changing Service Plans.

Managing a Single (SaaS) or SAP Mobile Start Application

A single-app version of SAP mobile service cockpit is available for Cloud Foundry. This enables a Business User to manage a single Cloud Foundry application, for example, within a Software as a Service (SaaS) context. The scope of single-app support includes Native, Hybrid, Micro App. The feature is only available for Cloud Foundry, and requires that the application has been migrated to a single service.

The following roles are related to the SAP Business Technology Platform cockpit. To learn more about setting roles and role collections see Building Roles and Role Collections for Applications.

• Administrator ‒ read-write role. The Business User must be assigned the Administrator role.

• Helpdesk ‒ read-only role.

Access to the single-app SAP mobile service cockpit is via a specific cockpit URL. The URL is in the format: https://<mobile_application_url>/mobileservices/Admin

For example, if the URL for the com.sap.myApp application is http://mobile-tenant1-groupX-tenant-com-sap-myapp.cfapps.sap.hana.ondemand.com, then the application is accessible at: https://mobile-tenant1-groupX-tenant-com-sap-myapp.cfapps.sap.hana.ondemand.com/mobileservices/Admin.

Tip

You can find the <mobile_application_URL> by navigating to the APIs tab, and copying the server URL.

Regular SAP mobile service cockpit access is only possible as a Platform User. The Platform User can also log in to the SAP Business Technology Platform cockpit, and is a member of the sub-account, organization and space.

The Business User, on the other hand, is authenticated against the Trust provider that is configured in the SAP Business Technology Platform sub-account. The Business User does not require general access to SAP Business Technology Platform accounts.

The functionality of the Business User is restricted. Because the logged in user is not allowed to perform actions on SAP Business Technology Platform accounts, Mobile Services cannot run operations that require interaction with the SAP Business Technology Platform infrastructure and other services. For example, the Business User cannot create a new application, which installs a new application route in the space; or change security settings, which would re-create the XSUAA (Security) Service Instance.

You'll notice these differences when using SAP mobile service cockpit as a Business User:

• The left navigation pane no longer appears, and the navigation breadcrumbs are abridged, since there is only one app to manage.

• The Delete, Export, and Lock operations no longer appear.

• Several assigned features no longer appear, including Mobile App Catalog and Mobile Cloud Build.

• The Discovery tab no longer appears.

• On the Info tab under Application Details, Custom Domain is read only; and the License Type either does not appear or appears as kernel-service, depending on the app.

• On the Security tab, the OAuth Settings and Role Settings are read only.

• On the Logs tab, you can view event logs only for the single application.

Other than these basic differences, most SAP mobile service cockpit operations are the same for the single-app version.

1. Access the single-app SAP mobile service cockpit from a browser using the cockpit URL in the format: https://<mobile_application_url>/mobileservices/Admin, as described above in Context.

   For example, https://mobile-tenant1-groupX-tenant-com-sap-myapp.cfapps.sap.hana.ondemand.com/mobileservices/Admin. You are prompted to log in, and then SAP mobile service cockpit appears with the single application.

2. Use the SAP mobile service cockpit to manage the application and its assigned features, keeping in mind the differences and restrictions mentioned above in Context.

Changing Service Plans for Single (SaaS) Applications

If you change Service Plans at the SAP Business Technology Platform level, you may also need to change service plan settings at the mobile services single app level. The terms license type and service plan are used interchangeably. The license determines capabilities and charges.

Before you start, it is recommended that you have a good understanding of the service plans available, and your current service plan. You can check the SAP Business Technology Platform cockpit to see your current active mobile services service plans. Be aware of whether the mobile services app and Cloud Foundry Runtime are under the same Service Plans. To be billed properly, all existing services must be on the right service. For example, if the app is under the free plan, the Cloud Foundry Runtime must also be under the free plan or charges are incurred. For more information, see: Service Plans.

To change plans:

1. Access to the single-app SAP mobile service cockpit is via a specific cockpit URL. The URL is in the format: https://<mobile_application_url>/mobileservices/Admin

   For example, if the URL for the com.sap.myApp application is http://mobile-tenant1-groupX-tenant-com-sap-myapp.cfapps.sap.hana.ondemand.com, then the application is accessible at: https://mobile-tenant1-groupX-tenant-com-sap-myapp.cfapps.sap.hana.ondemand.com/mobileservices/ Admin.

   Tip

   You can find the <mobile_application_URL> by navigating to the APIs tab, and copying the server URL.

2. On the Application Details screen, choose Change Service Plan to change the service plan.

3. Upgrading Service Plan
   Choose Service Plan from the drop-down menu.

   1. Upgrade to build-default: Selecting the build-default service plan unlocks advanced features for the application. These features include Application Management Policies (include settings Restrict Print Data & Restrict Opening URLs) and Cloud Build feature will be added.

   2. Upgrade to resources: Selecting resources does not alter any feature sets. It remains the same.

4. Downgrading Service Plan
   You can also downgrade your service plan to kernel-service or resources from build-default.
   Downgrade to kernel-service or resources: Downgrading the service plan clears all advanced features data, including Application Management Policies and Cloud Build. 1. Application Management Policies: The settings Restrict Print Data & Restrict Opening URLs will be removed. 2. Cloud Build: Cloud Build service will be removed from the application and all Cloud Build related data will be cleared.

5. Choose Change Plan.

   Note

   To enable the Cloud Build service for SaaS applications after upgrading to the build-default service plan, providers must assign the Cloud Build service in advance. If the provider app hasn't assigned the Cloud Build service yet, SaaS applications can't access it, even after the upgrade to the build-default service plan.

Creating a Build Job for a Single (SaaS) Applications

As an administrator, you can create and manage cloud build jobs for iOS and Android applications.

Create a build job for the single (SaaS) application. A build job merges both project settings, and build settings, such as signing profiles. Select the Create Build Job button to create a build job for Mobile Development Kit Client, or SAP Asset Manager.

To create Build Job follow the below steps:

1. Access to the single-app mobile services cockpit. For more information, see Managing a Single (SaaS) or SAP Mobile Start Application.

2. On the application detail screen, navigate to the Settings tab, and select Cloud Build from Add-On Features section.

3. Navigate to Build Jobs tab to create new build job or to view existing build jobs. You can also edit or delete the build job from this screen.

   (Optional) To modify an existing build job, choose from the Actions column of the corresponding build job.

   (Optional) To delete an existing build job, choose from the Actions column of the corresponding build job.

4. Choose Create Build Job to create new build job.

5. In the Basic Info screen of Build Job Wizard, fill out the information.

   Basic Info Screen Details

   Field	Description
   Build Job Name	A unique build job name to replace the default name.
   App Short Name	The label that appears on the welcome screen after you launch the app.
   App Long Name	The label that appears on the welcome screen after you launch the app.
   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.
   Build Platforms	The platforms to build, such as Android and iOS.

6. On the Build Options screen, fill out the platform related information.

   • For iOS Builds: Select Signing Profile from the drop-down list.
   • For Android Builds: Fill out the below information:
     • Signing Profile: Select Signing Profile from the drop-down list.
     • Google Services JSON File: Enter the Google Services JSON File, or browse to find it. Choose Display to view the contents of the JSON file. If it is not the right file, click Delete and try again. Once saved, the JSON file is uploaded.
     • Binary Format: Select the binary format to use, either APK (Android Package Kit, the default) or AAB (Android App Bundle) or APK (Android Package Kit) & APK (Android Package Kit, the default).
     • Target Deployment: Select the target deployment Devices (ARM) and/or Emulator (X86).

7. On the App Icon screen, choose to add icons or images for the following information:

   For iOS APP Icon

   Icon Type	Description
   Main App Logo	(Required) Primary image representing an application.
   Welcome Screen Logo	An image or graphic displayed on the initial screen when an application launched.
   Image in Tinted Mode	Images in Tinted Mode are pictures that have a color overlay applied to them. This overlay changes the overall hue or tone of the image.
   Image in Dark Mode	Images in Dark Mode are visuals designed to be displayed with a dark background to reduce eye strain and improve visibility in low-light conditions.

   Note

   For iOS App Icons, use PNG files with a maximum size of 1MB. The recommended dimensions are 1024×1024 pixels. If you upload images with different dimensions, the system resizes them to 1024x1024 pixels during the build process. After you successfully upload an icon or image, a preview appears under the Image Preview column.

   For Android APP Icon

   Icon Type	Description
   Main App Launcher Logo Image	(Required) An icon used to open the main application on a device.
   Main App Launcher Background Image	An image displayed behind the app icons on the main screen of a device.
   Monochrome Image for Main App Launcher	A monochrome image is a picture that uses only one color or shades of that color.
   Logo Image on the Welcome Screen	An image representing a brand or company displayed on the initial screen of an application.
   Notification Icon	A small symbol on a device or application that indicates new or unread information.

   Note

   For Android App Icons, use Vector XML files with a maximum size of 1MB. The recommended dimensions are 1024×1024 pixels. If you upload images with different dimensions, the system resizes them to 1024x1024 pixels during the build process. After you successfully upload an icon or image, a preview appears under the Image Preview column.

   Choose to remove any added icons or images.

8. Choose Create Build Job.

Result Build Job is created successfully for the selected, Build Platform, Build Options with the App Icons.

Next Steps Once the Build Job is created, you can run the Build for created build job, Edit and Delete the build job.

Create a Signing Profile for Single (SaaS) Applications

As an administrator, you can create and manage signing profiles for iOS and Android applications.

In order to build and run a binary on Android and iOS, the binaries must be signed. As an administrator you can manage your enterprise signing profiles, which are used by the cloud build service to build the IPA and APK files. You can generate a new Android signing profile, and you can upload an existing Android or iOS signing profile.

To create signing profile follow the below steps:

1. Access to the single-app mobile services cockpit. For more information, see Managing a Single (SaaS) or SAP Mobile Start Application.

2. On the application detail screen, navigate to the Settings tab, and select Cloud Build from Add-On Features section.

3. Navigate to Signing Profiles tab to view the existing signing profiles already uploaded for Cloud Build service [the total number of signing profiles is indicated after Signing Profiles (#)]. You can search for specific profiles, or sort the existing profiles to see a subset of the total signing profiles. The profiles are presented by platform, including Android and iOS.

   Signing Profiles

   Column	Description
   Profile Name	The name assigned to the signing profile.
   Profile Status	Display the status of signing profiles. Below is a list of possible statuses: Valid: No action is required. Invalid (No File Selected): Upload a valid .mobileprovisioning file. Valid (Expiring): Renew or replace the provisioning profile before it expires. Invalid (Expired): Upload a renewed profile or select a different valid signing profile. If the Profile Status is Invalid (No File Selected) or Invalid (Expired), the profile is in an error state. This condition blocks the build.
   Created By	The identifier of the person who created the signing profile.
   Expiry Date (UTC+0000)	The date that the signing profile expires, in local or UTC time zone.
   Actions	The actions you can take, such as delete or edit.

4. Choose Upload to upload an existing iOS or Android signing profile, provide the following information:

   • For iOS Platform
   • Profile Name
   • Signing Certificate (in .p12 format)
   • Private Key Passphrase
   • MainApp Provisioning Profile
   • WatchKit App Provisioning Profile
   • WatchKit App Widget Provisioning Profile
   • Widget Provisioning Profile
   • Notification Service Provisioning Profile

   Note

   All the provisioning profiles must be in the .mobileprovisioning format.

   • For the Android Platform
   • Profile Name
   • KeyStore File (in .keystore or .jks format)
   • KeyStore Password
   • Key Alias
   • Key Password

5. You can edit an existing uploaded signing profiles for Android or iOS platforms.

   Choose from the Actions column of the corresponding Signing Profiles to edit existing signing profile.

6. You can delete an existing uploaded signing profiles for Android or iOS platforms.

   Choose from the Actions column of the corresponding Signing Profiles to delete existing signing profile.

7. Choose OK to save the changes to signing profile.

Enable Purge Settings for a Single (SaaS) Applications

As an administrator, you can set up a schedule for Purge Settings for cloud build logs and build output for your application.

Purging is at the single app level. Cloud build logs are kept for the number of days that you specify, and purged when the scheduler task runs. Output and artifacts are kept for the number of builds that you specify, and purged when the scheduler task runs.

To enable or modify purge settings follow below steps:

1. Access to the single-app mobile services cockpit. For more information, see Managing a Single (SaaS) or SAP Mobile Start Application.

2. On the application detail screen, navigate to the Settings tab, and select Cloud Build from Add-On Features section.

3. Navigate to Purge Settings tab to view current purge settings.

4. If Enable Purge Settings is disabled, choose to Enable Purge Settings and edit the purge settings.

   Settings	Description
   Clear logs of successful builds after	Identify when to clear logs for successful builds ‒ Immediately, or after 1, 3, 7, or 30 days. Default is 7 days.
   Clear logs of unsuccessful builds after	Identify when to clear logs for unsuccessful builds ‒ Immediately, or after 1, 3, 7, or 30 days. Default is 7 days.
   Keep output of last n successful builds per app	Identify how long to keep the artifacts from the last 1-5 successful app builds. Default is 3 successful builds.
   Keep output of last n unsuccessful builds per app	Identify how long to keep the artifacts from the last 1-5 unsuccessful app builds. Default is 3 unsuccessful builds.
   Last purge	Shows the last successful purge in the YYYY-MM-DD HH:MM format (local or UTC time zone).

5. Choose Save.

Next Steps The system retains data until the scheduler task executes. By default, this occurs every 12 hours. You can modify this interval through server-side configuration. Builds with a PENDING status are excluded from purge operations and remain unaffected by these settings.

Managing SAP Build Apps

Configure and manage an SAP Build App in SAP mobile service cockpit.

Currently you cannot create SAP Build Apps from SAP mobile service cockpit. The buildApps application type can only be created by the build apps team from their service.

SAP Build Apps provides an option for deploying a scaled-down mobile app and managing it using the cockpit. Currently, the buildApps application type can only be created by the build apps team from their service. Once it is created, the application appears in the SAP mobile service cockpit SAP Build Apps application list. Note that limited features and functions are available for buildApps applications. Only features that are available to SAP Build appear in the cockpit.

1. In SAP mobile service cockpit, select Mobile Applications > SAP Build Apps.

   You can view a list of applications with summary information, including Application ID, Name, Application Type, Supplier, Type of Application, Service Plan, State, and Creation Date. Use the search and sort options to locate the applications you're interested in.

   SAP Build Apps Application Summary

   Column	Description
   Application ID	The unique application identifier.
   Name	The application name.
   Application Type	SAP Build Apps
   Vendor	The vendor that supplied the application.
   State	The current state of the application, such as: (1) Started ‒ the application is running normally. (2) Inconsistent ‒ applications may become inconsistent if they are deleted or changed from the SAP Business Technology Platform cockpit. From SAP mobile service cockpit, you can either delete or restore the application. (3) Deleted from SAP `BTP`` cockpit ‒ the application was deleted. You can restore or delete it in the SAP mobile service cockpit. (4) Restoring ‒ the application is being restored from an inconsistent state.
   Outdated	Whether the application is outdated. If checked, you are prompted to update the application to a newer version that contains fixes and improvements. Typically, you should update the application.
   Creation Date (UTC+0000)	The application creation date, either in UTC or local format, depending on what you selected for your User Setting.

2. Select an application to view or modify its details, as described in Configuring SAP Build Apps.

3. Select Import to import a new app.

   1. In Import Application, enter a file name or select Browse to locate it.

   2. Click Save. The app is imported and added to the list of applications.

   3. Configure the app as described in Configuring SAP Build Apps.

Configuring SAP Build Apps

Configure and edit SAP Build Apps and manage the apps from mobile services cockpit. Only features that are available to SAP Build appear in the cockpit.

1. In SAP mobile service cockpit, select Mobile Applications > SAP Build Apps.

2. Select an application to view its details.

3. Configure or modify the SAP Build Apps application. To prevent accidental changes, you can lock an application once its configurations are complete. To make changes, you'll need to manually unlock the application.

   • Settings: This tab provides a general settings for the selected application. General settings includes Connectivity, Client Settings, Security, Log Settings, Alert, Application Links and Attestation. To set the information on this tab, see Creating an Applications. In the Cloud Foundry environment, you can also configure a custom domain. For more information, see Editing an Application and Managing Custom Domains.

     • Connectivity: The Connectivity feature of SAP Mobile Services allows you to define the connectivity to back-end systems that the application can use. You can define any number of destinations to different back-ends. Those destinations are to be used exclusively by the application for which they are configured. You can restrict access to allowed paths. For more information, see Defining Connectivity.
     • Client Settings: Set client policies for the selected mobile application and manage its user registrations. For more information, see Defining Client Policy and Editing JSON Storage.
     • Security: This tab enables you to manage security for the selected application. For more information, see Configuring App Security.
     • Log Settings is for apps that have been migrated to the single-service model, and is used to enable event logs at the application level. You can specify any of the individual services that are assigned to the app, as well as Mobile AppRouter. This gives you more control over the event log information you want to see at the application level. For more information, see Enabling Event Logs at the App Level. You can continue to view event logs as described in Viewing Event Logs.
     • Alert: This tab lets you configure settings for server failures in various categories. Once configured, implement the SAP Business Technology Platform Alert Notification Service to receive notifications. For more information, see Configuring Alert Settings and Subscribe to Mobile Service Alerts.
     • Application Links: This tab enable universal links for Apple and application links for Android apps. Apple universal links and Android application links enable users to open an application locally without downloading the app or using a browser container. For more information, see Creating Application Links.

     To configure additional features, navigate to the Settings > Add-On Features. Choose Add Feature, select required application and choose OK.

     The add-on feature appears under the Add-on Feature list. For more information, see Configuring Assigned Features.

     To remove an Add-on Feature, choose the feature to open the feature configuration screen, then choose Remove from Application. In the Cloud Foundry environment, you can also configure a Custom Domain. For more information, see Editing an Application and Managing Custom Domains.

   • API provides onboarding and API features.

     • Under Onboarding, you can find one or more QR codes that can be used to configure the mobile application to connect to this mobile services instance.

       For In-app Scanning Code, the device user must first manually launch the app, then scan the QR code from within the app to initiate the onboarding process.

       For Default Configuration, native app developers can download a native-specific file containing the Discovery Service default configuration. Select iOS to download the configuration file in plist format, or select Android to download the file in JSON format. You can add the file to your iOS or Android app project without additional formatting.

       For Configuration, you can view any application routes that you've associated with the application. Select Edit to make changes. See Creating an Application for information about the XSUAA property, Domain of Application Route.

       For Apple and Android Launch App Code, the device user can select the URL (or scan the QR code for Apple's Camera App or an Android application that allows reading QR codes) to find and launch the application installed locally. If the user enables Android app links, it also supports Android's camera app. The App-launch QR code is generated if you enable Apple Universal Links or Android App Links or both of them in the Application Links section; the label text of the QR code depends on which application links are enabled (Apple launch app code, Android launch app code, or Apple and Android launch app code).

       For Apple and Android Launch App Code with URI Scheme, the device user can scan the QR code or select the URL, to use an appLink URL to find and launch the application. This option only appears if you enabled Device Application URI Schemes in the Application Links tab. You must select one Device Type, and input the corresponding device application URI Scheme for iOS or Android.

       Note

       (Mobile Development Kit only) If you set up Apple and Android Device Application URI schemes in the Application Links tab, you see two separate QR codes, labeled Apple Launch App Code with URI Scheme and Android Launch App Code with URI Scheme.

       If the app security configuration changes, you must generate a new QR code. Also, please note that the URL can be very long and might be longer than the value shown on the screen. Use Copy to Clipboard ( ), to copy the entire value.

     • Under API, you can view a list of frequently used API URLs. Use Copy to Clipboard ( ), to copy read-only URLs to the clipboard, to paste elsewhere, avoiding typing errors and ensuring accuracy.

     Note

     The Server URL is also the name.

   • User and Device Management: This tab enables admins to perform one or more user and device related actions such as Block, Revoke, Lock, Export User Data, Send Push Notification, Wipe and Delete.

Managing a Micro App

Use SAP mobile service cockpit to configure and manage a Micro App, such as WeCom (enterprise), WeChat (social), and DingTalk. Note that Micro App support is available only in select countries/regions.

1. In the SAP mobile service cockpit, select Mobile Applications > Micro App.

   You can view a list of apps with summary information such as application ID, name, application type, vendor and so forth. Use the search and sort options to locate the apps in which you're interested.

   You can view a list of applications with summary information, including Application ID, Name, Application Type, Supplier, Type of Application, Service Plan, State, and Creation Date. Use the search and sort options to locate the applications you're interested in.

   Micro App Summary

   Column	Description
   Application ID	A unique identifier for the Micro App.
   Name	The Micro App name.
   Application Type	The Micro App type, such as WeCom, WeChat, or DingTalk.
   Supplier	The Supplier that supplied the Micro App.
   Service Plan	The application plan that was in place when the Micro App was created.
   State	The current state of the Micro App, such as Started, Inconsistent, Deleted or Restoring.
   Outdated	Whether the Micro App is outdated. If checked, you are prompted to update the Micro App to a newer version that contains fixes and improvements. Typically you should update the Micro App.
   Creation Date (UTC/local)	The Micro App creation date, either in UTC or local format, depending on what you selected for your User Setting.

2. Select a Micro App to view its details, and make changes.

   • Settings: This tab provides a general settings for the selected application. General settings includes Connectivity, Client Settings, Security, Log Settings, Alert, Application Links and Attestation. To set the information on this tab, see Creating Applications. In the Cloud Foundry environment, you can also configure a custom domain. For more information, see Editing an Application and Managing Custom Domains.

     • Connectivity: The Connectivity feature of SAP Mobile Services allows you to define the connectivity to back-end systems that the application can use. You can define any number of destinations to different back-ends. Those destinations are to be used exclusively by the application for which they are configured. You can restrict access to allowed paths. For more information, see Defining Connectivity.
     • Client Settings: Set client policies for the selected mobile application and manage its user registrations. For more information, see Defining Client Policy and Editing JSON Storage.
     • Security: enables you to manage security for the selected Micro App. For additional security details see Configuring App Security.
     • Log Settings is used to enable event logs for the Micro App. You can specify any of the individual services that are assigned to the Micro App, as well as Mobile Application. This gives you more control over the event log information you want to see Enabling Event Logs at the App Level. You can continue to view event logs as described in Viewing Event Logs.
     • Alert: lets you enable alerts for WeChat apps, and establish the message threshold and schedule for alerts. To receive notifications, configure Subscriptions and Alerts through the Alert Notification service (subscriptions and alerts cannot be managed through the mobile services cockpit). For more information, see Configuring Alert Settings and Subscribe to Mobile Service Alerts.

     To configure additional features, navigate to the Settings > Add-On Features. Choose Add Feature, select required application and choose OK.

     The add-on feature appears under the Add-on Feature list. For more information, see Configuring Assigned Features.

     To remove an Add-on Feature, choose the feature to open the feature configuration screen, then choose Remove from Application. In the Cloud Foundry environment, you can also configure a Custom Domain. For more information, see Editing an Application and Managing Custom Domains.

   • APIs provides a summary of some configuration options (select edit to make changes), and a list of frequently used API URLs [use Copy to Clipboard ( ), to copy read-only URLs to the clipboard]. Note that the Server URL is also the <mobile_services_host> name.

   • Users (WeChat only) enables you to export or delete data for a user, and to block one or more users from using a Micro App.

Creating a Micro App

Create a new application definition, which enables you to use SAP mobile service cockpit to manage the Micro App. Use templates to define a Micro App, and then configure its assigned features or add more features.

1. In the SAP mobile service cockpit, select Mobile Applications > Micro App, then select New.

2. In New Application, enter: Micro App Properties

   Field	Value
   Config Templates	Select a configuration template type: WeCom (enterprise), WeChat (social), or DingTalk.
   ID	(Required) Unique identifier for the application, in reverse-domain notation. This is the application or bundled identifier that is assigned or generated by the application developer. The administrator uses the application ID to register the application with SAP Mobile Services, and client applications use the application ID when sending requests to the server. See Application ID recommendations below.
   Name	(Required) The application name can contain only alphanumeric characters, spaces, underscores, and periods, and can be as many as 80 characters long.
   CorpID	(Required - WeCom, DingTalk only) Unique ID of the WeCom or DingTalk enterprise.
   AgentID	(Required - WeCom, DingTalk only) Unique ID of every enterprise application.
   WeChat AppID	(WeChat only - required) Unique ID for the WeChat application.
   Description	(Optional) The description can contain up to 255 alphanumeric and special characters.
   Supplier	(Optional) Supplier who developed the application. The vendor name can contain only alphanumeric characters, spaces, underscores, and periods, and can be up to 255 characters long.
   Service Plan	The service plan that you want to use for your account: resources (default), build-code, free, standard (Users), or b2c (Consumer Edition). The "lite" plan is available only for trial subaccounts. The license determines capabilities and charges. See Service Plans for additional information. Keep in mind that the standard (Users) and b2c (Consumer Edition) service plans are deprecated, so resources is the best choice. You can change your service plan from free to resources, enabling you to migrate your app without losing your work. Changing service plans is not reversible. You cannot switch from resources, standard, or b2c to free.
   Domain of Application Route	In regions that support multiple domains, select the application route through which end users can reach the application. Routes are associated with a space, and are configured in SAP Business Technology Platform cockpit. The drop-down list shows all shared and custom domains that are available for the customer organization. If you want to use a custom domain, you can create one according to information in What Is Custom Domain.

   Application ID recommendations:

   • Must be unique.
   • Must start with an alphabetic character.
   • Can contain only alphanumeric characters, underscores, and periods.
   • Can contain up to 64 characters.
   • Cannot include spaces.
   • Cannot begin with a period, and cannot contain two consecutive periods.
   • Cannot be any of these case-sensitive keywords: Admin, AdminData, Pushsmp_cloud, resource, test-resources, resources, Scheduler, odata, applications, Connections, public, lcm.

   We also recommend that you assign IDs that contain a minimum of two segments, for example, com.sap.mobile.app1.

   If you are building an Android application, its ID must follow the Google-defined rules, or the Android build fails:

   • The ID must have at least two segments (one or more periods).

   • Each segment must start with a letter.

   • All characters must be alphanumeric or an underscore [a-zA-Z0-9_].

   The prefix com.sap.webide is reserved for packaged apps created from SAP Web IDE.

3. Select Next to continue.

   Field	Value
   XSUAA Service	Select the XSUAA authentication and authorization service to use. You can select Default Instance to create a new instance, or you can select an existing service from the list. Using an existing XSUAA instance is useful if you already have a Cloud Foundry application deployed and want to connect from mobile services to this application. In this case it can be handy to re-use an existing XSUAA instance. Select the default instance for other scenarios.
   xs-security.json	A JSON file that defines the authentication methods and authorization types used to access your application. See Application Security Descriptor Configuration Syntax for additional information.
   Token Lifetime	Enter the token lifetime, and select the units (Days, Hours, or Minutes).
   Refresh Token Lifetime	Enter the refresh token lifetime, and select the units (Days, Hours, or Minutes).
   Approved Providers	Indicate whether the app should support all approved providers or only selected providers.
   System Attributes in Token	Indicate groups, role collections or both.

4. Click Finish and OK to confirm. The Info page appears with current settings.

Configuring Assigned Features for a Micro App

Configure features associated with a Micro App definition. You can add additional features, and delete features that are not required. Some features require coding in the application. In general, there should be no dependency between features.

1. In the SAP mobile service cockpit, select Mobile Applications > Micro App.

2. Select an application and access the Settings tab.

3. Select an application and under Settings tab you can view the list of features assigned to the selected application. These features are included by default:

   • Connectivity – The Connectivity feature of SAP Mobile Services allows you to define the connectivity to back-end systems that the application can use. You can define any number of destinations to different back-ends. Those destinations are to be used exclusively by the application for which they are configured. You can restrict access to allowed paths. For more information, see Defining Connectivity.

   • Client Settings – Set client policies for the selected mobile application and manage its user registrations. For more information, see Defining Client Policy and Editing JSON Storage.

   • Security – This tab enables you to manage security for the selected application. For more information, see Configuring App Security.

   • Log Settings – This tab is for apps that have been migrated to the single-service model, and is used to enable event logs at the application level. You can specify any of the individual services that are assigned to the app, as well as Mobile AppRouter. This gives you more control over the event log information you want to see at the application level. For more information, see Enabling Event Logs at the App Level. You can continue to view event logs as described in Viewing Event Logs.

   • Alert – This tab lets you configure settings for server failures in various categories. Once configured, implement the SAP Alert Notification Service to receive notifications. For more information, see Configuring Alert Settings and Subscribe to Mobile Service Alerts.

4. (Optional) Under Assigned Features, select the add icon to add the following features, and then select OK:

   • Sample OData ESPM – use the sample service during development and testing.

   • Network Trace – view network trace information collected from mobile applications for debugging.

   • Mobile Micro App – define WeCom, WeChat, or DingTalk settings and service keys, and view feature details.

5. Select an assigned feature, such as Mobile Micro App, to configure its settings, and then select Save.

6. (Optional) Select Reset to reset settings to default values.

7. (Optional) Select Remove from Application to remove the feature from the application.

Configuring WeCom Settings

Configure settings for a WeCom Micro App.

1. In the SAP mobile service cockpit, select Mobile Applications > Micro App, then choose an existing WeCom app or create one.

2. Navigate to the Settings tab and select Mobile Micro App from Add-On Features section (or add it first).

3. From the Configuration tab, define the following settings:

   Name	Description
   CorpID	(Required) Unique ID of the WeCom enterprise account. Find this information under WeCom Admin Panel > My Enterprise > Enterprise Info.
   AgentID	(Required) Unique ID of an enterprise application. Find this information under WeCom Admin Panel > Enterprise Application > Into the Application.
   App Secret	(Required) Enterprise application secret. Find this information under WeCom Admin Panel > Enterprise Application > Into the Application
   Message Handler Endpoint	Select the message handler endpoint from connection list. Copy the value (Message Handler URL) to edit the API receiving setting URL in the WeCom Admin Panel.
   Message Handler URL	The Message Handler URL appears, based on Message Handler Endpoint you selected. Use the copy icon to copy the URL to the clipboard, to paste elsewhere.
   Token	(Required) WeCom enterprise application message receiving token. Find this information in the WeCom Admin Panel > Specific App > Message Receiving > API Receiving Setting.
   EncodingAESKey	(Required) WeCom enterprise application message receiving message body encoding key. Find this information in the WeCom Admin Panel > Specific App > Message Receiving > API Receiving Setting.

4. From the Service Keys tab, for some features you can implement a service key, which enables an application to access a service instance using a service key as its credentials. See Service Keys.

5. On the Info tab, you can find additional information, including the feature description and documentation and support URLs.

Configuring WeChat Settings

Configure settings for a WeChat Micro App.

1. In the SAP mobile service cockpit, select Mobile Applications > Micro App, then choose an existing WeChat app or create one.

2. Navigate to the Settings tab and select Mobile Micro App from Add-On Features section (or add it first).

3. From the Configuration tab, define the following settings:

   Name	Description
   WeChat AppID	(Required) Unique ID for the WeChat application. In the WeChat Official Account Platform, after applying for an Official Account, you can find the WeChat AppId in Basic Configuration.
   App Secret	(Required) The application secret for the WeChat application. In the WeChat Official Account Platform, after applying for an Official Account, you can find the App Secret in Basic Configuration.
   Message Handler Endpoint	Select the message handler endpoint from connection list.
   Message Handler URL	The message handler URL appears, based on the Message Handler Endpoint you selected. Use the copy icon to copy the URL to the clipboard, to paste elsewhere.
   Token	(Required) The WeChat application message receiving token. Token and EncodingAESKey are used for developer server verification of message and autonomous settings in the WeChat Official Account Platform. In the WeChat Official Account Platform, you can find the Token information in Basic Configuration.
   EncodingAESKey	The WeChat application message receiving message body encoding key. Token and EncodingAESKey are used for developer server verification of message and autonomous settings in the WeChat Official Account Platform. In the WeChat Official Account Platform, you can find the EncodingAESKey information in Basic Configuration

4. From the Service Keys tab, for some features you can implement a service key, which enables an application to access a service instance using a service key as its credentials. See Service Keys.

5. On the Info tab, you can find additional information, including the feature description and documentation and support URLs.

Configuring DingTalk Settings

Configure settings for a DingTalk Micro App.

1. In the SAP mobile service cockpit, select Mobile Applications > Micro App. You can view existing DingTalk apps or create one.

2. Navigate to the Settings tab and select Mobile Micro App from Add-On Features section (or add it first).

3. From the Configuration tab, define the following settings:

   Name	Description
   CorpID	(Required) Unique ID of the DingTalk enterprise account. Find CorpID in DingTalk Development Platform Account Management.
   AgentID	(Required) Unique ID of an enterprise application. Find this information in DingTalk Web Admin Panel > Self-built application > Application Info.
   App Key	(Required) Enterprise application key. This value is auto-generated when the developer creates the application. Find this information in DingTalk Web Admin Panel > Self-built application > Application Info.
   App Secret	(Required) Enterprise application secret. This value is auto-generated when the developer creates the application. Find this information in DingTalk Web Admin Panel > Self-built application > Application Info.

4. From the Service Keys tab, for some features you can implement a service key, which enables an application to access a service instance using a service key as its credentials. See Service Keys.

5. On the Info tab, you can find additional information, including the feature description and documentation and support URLs.

Managing Micro App User Registrations

Manage multiple user registrations for a Micro App. Registrations are associated with an authenticated or an anonymous user on one or more devices.

Note that for WeChat only, you can export user data and block users from the Users tab (see Managing a Micro App).

1. In the SAP mobile service cockpit, select Mobile Applications > Micro App, then select the application.

2. Select an application, navigate to Settings tab and select Client Settings, then navigate to User Registrations tab.

3. Under Automatic Removal, you can enable automatic user removal, and indicate the time frame for removal in hours, days, and months.

4. Under Summary, view current number of users and registrations.

5. Under Registered Users, you can filter and sort user registrations.

   Column Descriptions

   Column	Description
   Registration ID	Unique identifier provided by the client application, or system-generated application registration ID.
   User Name	User name identified with the registered application.
   Last Connection	The date and time when the application was registered, in the format YYYY-MM-DD HH:MM:SS. The value appears in local or UTC format, depending on your user setting.
   Actions	You can delete the user registration.

   For some push providers, when you delete user registrations for auto registration in Users and Device Management, you must also manually delete the device registration from Push Notifications > Push Notifications. This is because the provider does not provide the information needed for automatic deletion in push. For these providers, you must perform the manual delete: Baidu, Custom, and W3C.

6. Select a registered user to view details. Categories may vary by application type.

   • User Registration – the unique ID assigned to the registered user.

   • Info – basic information about the registered user.

   • Device – known information about the device used by the registered user.

   • (WeChat only) WeChat User Mapping – the WeChat identifier, nickname, and profile photo, if provided by the registered user.

   • Push – any push notification settings for the registered user.

   • Custom – any custom items configured for the registered user.

7. (Optional) Select a registered user, then Send Notifications to send notification alerts to the user. See Sending Micro App Notifications.

Sending Micro App Notifications

(WeCom and DingTalk only) Send different types of notifications to a registered Micro App user. Keep in mind these guidelines when sending notifications.

For WeCom Micro App, the supported message types are:

• Text
• File
• Image
• Markdown
• News
• Text Card
• Video
• Voice
• WeCom News

For the Markdown option, a subset of the markdown syntax is supported:

• Headings ‒ heading levels 1 to 6:

  # Heading level 1
  ## Heading level 2
  ### Heading level 3
  #### Heading level 4
  ##### Heading level 5
  ###### Heading level 6
  

• Bold ‒ in the format:

  **bold**
  

• Links ‒ enclose link name in brackets, for example:

  [This is a link name](http://work.weixin.qq.com/api/doc)
  

• Code ‒ enclose in single quotes (one line only), in the format:

  `code`
  

• Block quotes ‒ in the format:

  > Quotes
  

• Font color ‒ up to three colors are supported:

  <font color="info">Green</font>
  <font color="comment">Gray</font>
  <font color="warning">Orange</font>
  

For details about the supported markdown elements, see:

• WeChat Supported Markdown Syntax (Simplified Chinese language only).

• Markdown Guide - Basic Syntax

To send Micro App notifications:

1. In the SAP mobile service cockpit, select Mobile Applications > Micro App, then select the application.

2. Select an application, navigate to Settings tab and select Client Settings, then select User Registrations tab.

3. Under Registered Users, use the filter and sort options to select one or more user registrations as described in Managing Micro App User Registrations.

4. Under Registered Devices, select a registered user, then select Send Notifications to send notification alerts to the user. In Send WeCom / DingTalk Push Notification, select a message type.

   For File, select a file to send that is no larger than 20MB.

   1. Select Browse and navigate to the file.

   2. Select the file, and then Open.

   For Image, select a .PNG or .JPG file that is no larger than 2MB.

   1. Select Browse and navigate to the image file.

   2. Select the file, and then Open.

      For Markdown, select a markdown file to send. The file must follow the guidelines described above.

   3. Select Browse and navigate to the .md file.

   4. Select the file, and then Open.

      For News, specify one or more articles to send:

   5. Select to add one or more news articles.

   6. Provide information to identify the article.

   News Article Properties

   Properties	Description
   Title	The article title.
   Description	A description of the article.
   URL	The article URL.
   News Cover URL	The news cover URL.
   Action	You can delete the article.

   For text messages, select Text, and compose the message text to send.

   For text cards, select Text Card, and define the text card properties:

   Text Card Properties

   Properties	Description
   Title	The text card title.
   Description	A description of the text card.
   URL	The data endpoint URL for the text card.
   Button Text	The text to appear on the text card button.

   For Video, select an .MP4 file that is no larger than 10MB, and define the video properties.

   Video Properties

   Properties	Description
   Title	The video title.
   Description	A description of the video.

   For Voice, select an .AMR file that is no larger than 2MB and no longer than 60 seconds.

   1. Select Browse and navigate to the video file.

   2. Select the file, and then Open.

   For WeCom News, send up to eight news articles in a batch. Each article can include a cover picture, a source URL, and other information. If you change your mind, you can delete one or more articles before you send it.

   WeCom News Properties

   Properties	Description
   Title	The title for the selected articles.
   Cover Picture	Browse to select a .PNG or .JPG image file no larger than 2MB.
   Author	Name of the author.
   Content Source URL	Provide the URL for the content source.
   Content	Provide the URL for the content source.
   Description	A description for the packet of news articles.

5. Select Send. The selected user receives the notification.

Micro App APIs

View a list of configured APIs for Micro Apps.

1. In the SAP mobile service cockpit, select Mobile Applications > Micro App, and select the application.

2. Select the APIs tab, and under API, view a list of frequently used API URLs.

   For WeCom:

   • WeCom Message Handler ‒ the API used to control messaging. This API appears only after the message handler endpoint has been configured in WeCom settings.

   • WeCom Push ‒ the API used to control push notifications.

   For more information, see WeCom Message Handler API and WeCom Push API.

   For WeChat:

   WeChat Message Handler ‒ the API used to control messaging. This API appears only after the message handler endpoint has been configured in WeChat Settings.

   For DingTalk:

   • DingTalk Push ‒ the API used to control push notifications.

WeCom Message Handler API

Use the WeCom Message Handler API for stand-alone WeCom Java application development and deployment to the Cloud Foundry environment. Use the WeCom Message Handler API to control WeCom message receiving. The API appears only after the message handler endpoint has been configured in WeCom settings.

This API is used to receive XML WeCom message from WeCom end users through the WeCom Server. The XML payload received from WeCom Server is documented in WeCom Doc (Simplified Chinese language only).

The response payload to the WeCom Server (which will be pushed back to the WeCom end users) should also follow the same XML format as receiving payload.

WeCom Push API

Use the WeCom Push API for stand-alone WeCom Java application development and deployment to the Cloud Foundry environment. Use the WeCom Push API to control push notifications.

We are supporting different message types for WeCom message Push feature. You can make the POST call to the WeCom Push API with following information for pushing WeCom messages to end user(s).

• Header X-API-Key: this is the API key generated from the Service Keys tab on WeCom Settings.

• Header Content-Type: application/json.

• Request body: the JSON message payload.

The JSON payload examples are provided in the following sections.

text

{
    "notification": {
        "wechat": {
            "createtime": "2019-12-17T06:24:26.451Z",
            "text": {
                "content": "hello world!"
            },
            "msgtype": "text"
        }
    },
    "users": ["P000001"]
}

textcard

{
     "notification": {
        "wechat": {
            "createtime": "2019-12-17T06:24:58.808Z",
            "textcard": {
                "btntext": "MoreInfo",
                "description": "Test for textcard msg type",
                "title": "title_textcard",
                "url": "http://www.abc.com"
            },
            "msgtype": "textcard"
        }
    },
    "users": ["P000001"]
}

markdown

{
    "notification": {
        "wechat": {
            "createtime": "2019-12-17T06:25:02.936Z",
            "markdown": {
                "content": "Meeting room already reserved. rn>**items**>Meeting<font color=" info ">meeting1</font> rn >john@abcdef rn>If required, please click [modify resource](https://abcde.com)"
            },
            "msgtype": "markdown"
        }
    },
    "users": ["P000001"]
}

image

The image file should be Base64-encoded.

• Image file size limit: 2 MB

• Supported format: .jpg, .png

{
    "notification": {
        "wechat": {
            "image": {
                "media_file_encoded": "data:image/jpeg;base64,XXXXXXXXXXXXXX",
                "media_file_name": "testimage.jpg"
            },
            "createtime": "2019-12-17T06:25:09.509Z",
            "msgtype": "image"
        }
    },
    "users": ["P000001"]
}

voice

The voice file should be Base64-encoded.

• Voice file size limit: 2 MB

• Voice time limit: 60 seconds

• Supporting format: only supporting .amr

{
    "notification": {
        "wechat": {
            "voice": {
                "media_file_encoded": "data:application/octet-stream;base64,XXXXXXXXXXXXX",
                "media_file_name": "test.amr"
            },
            "createtime": "2019-12-17T06:52:14.515Z",
            "msgtype": "voice"
        }
    },
    "users": ["P000001"]
}

video

Video file should be Base64-encoded.

• Video file size limit: 10 MB

• Supporting format: only supporting .mp4

{
    "notification": {
        "wechat": {
            "createtime": "2019-12-17T06:52:19.631Z",
            "video": {
                "media_file_encoded": "data:video/mp4;base64,XXXXXXXXXXXXXXXXX",
                "media_file_name": "test.mp4",
                "description": "video description",
                "title": "Video Title"
            },
            "msgtype": "video"
        }
    },
    "users": ["P000001"]
}

file

Push general file to user(s), the file should be Base64-encoded.

• File size limit: 20 MB

• No file extension name limit.

{
    "notification": {
        "wechat": {
            "createtime": "2019-12-17T06:52:23.417Z",
            "file": {
                "media_file_encoded": "data:application/x-zip-compressed;base64,XXXXXXXXXX",
                "media_file_name": "abc.zip"
            },
            "msgtype": "file"
        }
    },
    "users": ["P000001"]
}

WeCom news

{
    "notification": {
        "wechat": {
            "news": {
                "articles": [{
                        "picurl": "https://abc/def/pic1.jpg",
                        "description": "description for news1",
                        "title": "News1",
                        "url": "http://www.wechatnews1.com"
                    }, {
                        "picurl": "https://abc/def/pic2.jpg",
                        "description": "description for news2",
                        "title": "News2",
                        "url": "http://www.wechatnews2.com"
                    }, {
                        "picurl": "https://abc/def/pic3.jpg",
                        "description": "description for news3",
                        "title": "News3",
                        "url": "http://www.wechatnews3.com"
                    }
                ]
            },
            "createtime": "2019-12-17T06:52:25.765Z",
            "msgtype": "news"
        }
    },
    "users": ["P000001"]
}

WeCom mpnews

The thumb image file should be Base64-encoded.

• The limit of thumb image file is the same limit as the Image message.

{
    "notification": {
        "wechat": {
            "createtime": "2019-12-17T06:52:28.337Z",
            "mpnews": {
                "articles": [{
                        "thumb_media_file_name": "pic1.jpg",
                        "thumb_media_file_encoded": "data:image/jpeg;base64,XXXXXXXXX",
                        "author": "user1",
                        "digest": "digest1",
                        "content_source_url": "http://www.wechatmpnews1.com",
                        "title": "Title1",
                        "content": "content1"
                    }, {
                        "thumb_media_file_name": "pic2.jpg",
                        "thumb_media_file_encoded": "data:image/jpeg;base64,XXXXXXXXX",
                        "author": "user2",
                        "digest": "digest2",
                        "content_source_url": "http://www.wechatmpnews2.com",
                        "title": "Title2",
                        "content": "content2"
                    }
                ]
            },
            "msgtype": "mpnews"
        }
    },
    "users": ["P000001"]
}

Managing Application Themes

(Native/MDK only) As an administrator you can manage application themes from SAP mobile service cockpit and enable custom themes for the selected mobile app.

Themes change the appearance of the mobile client on the user's device. The mobile services server uses the settings to apply themes to the mobile app client. Each theme definition includes a light and dark version of the theme. Mobile client users can set the active theme from the device. Themes are managed at the space level.

Themes are created using the SAP Theme Designer, and distributed in ZIP format. Once uploaded, you can set the active theme. If you decide to deselect themes, the SDK application does not get the theme from the mobile services server.

Note that for a single application cockpit (Software as a Service, SaaS), only one customized theme is available for the user to use. The theme is automatically enabled for the application once the customized theme is enabled. You can update and delete themes. If the theme is deleted, the SDK application uses the initial default theme instead of getting the theme from the mobile services server. The appearance information is cleared, and you can import another theme.

Find more details in the respective guide Managing Application Themes.

Related Information

• Configuring Assigned Features
• Managing Application Themes
• Managing Application Versions Using App Catalog
• Managing Custom Domains
• Creating Application Links
• Administration Troubleshooting

---

Last update: January 16, 2026