Skip to content

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
menu2 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 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.
newspaper About View information about the platform. 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 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.
bell 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.
feedback 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.
headset 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.
sys-help 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. See Guided Tours.
log Log Out Log out of the application. Click your login name in the upper-right corner to see the option.
add Create Configure a new resource for a feature, such as a new destination.
action-settings Action Settings View available actions, such as customizing table columns.
add New Add a new item, for example, a destination, a provider, or a feature restriction policy.
Ping Ping Ping a destination.
show-edit 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.
popup-window 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 Sort a list based on criteria you choose, such as ascending or descending order, or the column name.
upload Upload Upload an object.
download Download Download an object.
menu Details See details about the selected resource.
copy 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 ( sys-help ). 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 headset 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 hint 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 search . 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 hint to access the onboarding screens, watch video tutorials and access help for built-in support, set cookie preferences, and more.

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

      • Select decline 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).

Application Administration

Use SAP mobile service cockpit and other tools to manage and monitor native, hybrid, and Web 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 Web 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 running 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 Web site 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 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 Mobile AppRouter, as described below for the Event Log tab.

For multiple-services apps (those that have not been migrated to single 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 or SAP Mobile Cards.

    You can view a list of applications with summary information such as name, application ID, vendor, application state, creation date, and so forth. Use the search and sort options to locate the applications in which 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.
    Name The application name.
    Vendor The vendor that supplied the application.
    License Type The application plan that was in place when the application was created, for example, "free", "standard", "resources", "b2c" or "lite". The "lite" plan is only available for trial subaccounts. The license determines capabilities and charges. You can change your license plan from "free" to "standard", "resources", or "b2c", enabling you to migrate your app without losing your work. However, keep in mind that the "standard (Users)" and "b2c (Consumer Edition) service plans are deprecated, so "resources" is the best choice. Migration is not reversible. You cannot switch from "standard", "resources", or "b2c" to "free". See Service Plans for additional information.
    State The current state of the application, such as:
    • Started ‒ the application is running normally.
    • Inconsistent ‒ applications may become inconsistent if they are deleted or changed using the SAP Business Technology Platform Cockpit. From SAP mobile service cockpit, you can either delete or restore the application.
    • Deleted from SAP Business Technology Platform Cockpit ‒ the application was deleted. You can restore or delete it in the 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,

    • Info provides a summary of settings for the selected application. To set the information on this tab, see Creating Applications. In the Cloud Foundry environment you can also configure a custom domain. See Editing an Application and Managing Custom Domains.

      The list under Assigned Features identifies the features that are currently assigned to the application, and enables you to add and delete more. For more information, see Configuring Assigned Features.

    • APIs provides onboarding and API features.

      Under Onboarding, 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, 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 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 ( copy ), 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.

    • You can use Application Links to 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. See Creating Application Links.

    • Users enables you to export or delete data for a user, and to block one or more users from using a Native/MDK or SAP Mobile Cards application.

    • Security enables you to manage security for the selected application. For details see Configuring App Security.

    • Alert lets you configure settings for server failures in various categories. Once configured, implement the SAP Business Technology Platform Alert Notification Service to receive notifications. See Configuring Alert Settings and Subscribe to Mobile Service Alerts for information.

    • 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. See Enabling Event Logs at the App Level. You can continue to view event logs as described in Viewing Event Logs.

Creating an Application

Create a new application definition, which enables you to use the SAP mobile service cockpit to manage the application. When you define an application, choose a configuration template. Keep in mind:

  • When you select a Native, Hybrid, Web, 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 Mobile Settings Exchange, are required, so you cannot remove them.

  • Other features have dependencies, so you either cannot remove them, or must remove them in a particular order. For example, Mobile Offline Access requires Connectivity, and Mobile Cloud Build requires Mobile App Catalog.

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

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

    Note that some service plans impose a limit on the number of applications that you can implement. When you reach the limit, a message appears, such as "The current activity cannot be performed due to limitations on the current plan". To mitigate, delete one of the applications. See Service Plans for information about service plan limits.

  2. In New Application, the Basic Info page, enter the application properties, followed by Next.

    Application Properties

    Field Value
    Application 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, and periods
    • Can contain up to 64 characters
    • Cannot include spaces
    • Cannot begin with a period, and cannot contain two consecutive periods
    We recommend that you assign IDs that contain a minimum of two periods, 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 using Web IDE.
    Name The application name can contain only alphanumeric characters, spaces, underscores, and periods, and can be as many as 80 characters long.
    Description (Optional) The description can contain up to 255 alphanumeric and special characters.
    Vendor (Optional) Vendor that developed the application. The vendor name can contain only alphanumeric characters, spaces, underscores, and periods, and can be up to 255 characters long.
    License Type The license type that you want to use for your account: "free", "standard (Users)" (default), "resources" or "b2c (Consumer Edition)". The "lite" plan is available only for trial subaccounts. The license determines capabilities and charges. You can change your service plan from "free" to "standard (Users)", "resources" or "b2c (Consumer Edition)", enabling you to migrate your app without losing your work. However, keep in mind that the "standard (Users)" and "b2c (Consumer Edition) service plans are deprecated, so "resources" is the best choice. Migration is not reversible. You cannot switch from "standard (Users)", "resources", or "b2c (Consumer Edition)" to "free". See Service Plans for additional information.
    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
  3. On the Security Settings page, 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. See Application Security Descriptor Configuration Syntax for additional information.
    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. See Application Security Descriptor Configuration Syntax for additional information.
    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. See Application Security Descriptor Configuration Syntax for additional information.
    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. See Reference Information for the Identity Service of SAP BTP for additional information.
    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. See Reference Information for the Identity Service of SAP BTP for additional information.
    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. See Reference Information for the Identity Service of SAP BTP for additional information.
  4. On the Role Settings page, 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 Orgs, 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.

  5. In Assign Features, select one of the configuration templates.

    • Native – applications built using the native SDKs for iOS or Android.
    • Mobile Development Kit - metadata-based applications.
    • Web – applications that run in a Web browser.
    • Hybrid – Kapsel container-based applications.

    The features selected for the template appear. You can select additional features and remove features (except for required features) at this time. Later you can make further changes as described in Managing Application Features.

    Basic Features

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

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 click edit on any tab to make modifications. See Defining Applications for application properties.

  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 or SAP Mobile Cards.
  2. Select an application and click Delete.
  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. For SAP Mobile Cards, the card template is deleted, not the cards.

Managing App Users

Manage users at the application level.

You can delete or export data for a selected user, and block users.

  1. In SAP mobile service cockpit, select Mobile Applications > Native/MDK.
  2. Select Users.
  3. (Optional) Under User Data you can export or delete data for an individual user.
    1. Enter the user name. Valid entries include alphanumeric characters, numbers, period, underscore, and hyphen.
    2. (Optional) Select Export to download user data to a JSON file.
    3. (Optional) Select Delete, to delete user data, and select OK. The message "Delete user data successfully" indicates success.
  4. (Optional) Under Blocked Users, you can block one or more users from using the selected Native/MDK or SAP Mobile Cards application.
    1. Select add .
    2. Add the user you want to block.
    3. Click OK to confirm.

Managing Registered Users

Manage user registrations for the app from the Mobile Settings Exchange feature. SAP Mobile Services uses Mobile Settings Exchange to exchange general settings and user registration information between mobile client and server. Use this information to manage user registrations.

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

  2. Select an application, then select Mobile Settings Exchange under Assigned Features.

  3. Select User Registrations to manage registered application users.

  4. Under Automatic Removal, select Automatic Removal to indicate whether application registrations should be automatically removed after a specified number of days.

  5. Under Summary, view the number of current application registrations.

  6. 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).

  7. You can view the search results to see registered users.

    Registered Users

    Column Description
    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.
    User Name (Blocked in Red) Registered user for the app.
    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 (UT+0000) The date, time, and time zone when the application was registered, in the format YYYY-MM-DD HH:mm:ss.
    Wipe Whether the application connection is set to be wiped.
    Compliance Status Whether the mobile services has determined that a client device meets compliance requirements. Options include: (1) Compliant - the device has undergone compliance checking, and was found to not be jailbroken (iOS) or rooted (Android). (2) Compromised - the device has undergone compliance checking and was found to be jailbroken (iOS) or rooted (Android). The compromised device status is also reported as an Error in the Event Log (use the Mobile Device Security filter). Once the compliance problem is fixed and rechecked, the status changes. (3) Unknown - the device has not undergone compliance checking, so its status is not yet known.
    Actions Actions to take, if any. Actions include sending a push message to a registered user, blocking a user, locking a user and wiping the device, deleting a registration and revoking an OAuth token.
  8. Send a Push Notification to a User

    Select message-popup to send a message to a user. 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.

  9. Block a User

    Select employee-rejections to block a user. Blocking prevents a user from registering the Native/MDK application or receiving traffic. The Confirm Block User Action message appears, informing you that by blocking user access, the user is logged out of the application and cannot log back into the application unless removed from the list of blocked users. Select OK to confirm. The message User Blocked appears and a check mark appears to the right of the icon employee-approvals indicating the user is blocked.

    Select the icon to unblock the user. The Confirm Unblock User Action message appears, informing you that by unblocking user access, the user regains access to the application and can log in through any device. Select OK to confirm. The message User Unblocked appears and an X appears to the right of the icon employee-rejections indicating the user is unblocked.

    See Managing App Users for related information.

  10. Lock a User and Wipe Device

    The Lock User and Wipe Device button locked is designed to enhance the security and management of registered users and their devices in the system. When this button is clicked, the system logs out the selected users from the application on the specified devices and wipes all data managed by the app on those devices. This action is irreversible, meaning that any previously wiped data managed by the app is not restored.

    The Unlock User button unlocked allows administrators to regain access for a user on a specific device after they have been locked out and their data has been wiped. This button disables the Wipe function for the selected registration and unlocks the user, allowing them to log back into the application on the same device. However, it is important to note that any previously wiped data managed by the app is not restored.

    See Defining Lock and Wipe Policy for related information.

  11. Delete a User Registration

    Select delete to delete a registered user. You can also select the check box to the left of the Registration ID for one or more rows, and then the f-delete: button that is on the Registered Users row (not the f-delete: button for individual user rows). Select OK to confirm. The selected registered users are removed.

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

    • If the user has only one registration in the list: when it's deleted, the user registration is revoked and the user registration no longer appears in the list.

    • If the user has multiple registrations in the list: when one is deleted, the other user registrations are also revoked and the user 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 helps ensure that only the latest OAuth tokens are used and that old tokens are deleted.

  12. Revoke an OAuth Token

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

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:

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.

  • You can change your service plan from "free" to "resources", enabling you to migrate your app without losing your work.

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

To change plans:

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

  2. Select an application and in the Application Details section, click edit to make modifications.

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

  4. Select the target license from the License Type 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.

Managing a Single 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, and SAP Mobile Cards. 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, the License Type does not appear, and Custom Domain is read only.

  • 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.

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, such as application ID, application name, application type, vendor, application state, whether outdated, and the creation date. Use the search and sort options to locate the applications that you are 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.

    • Info provides a summary of settings for the selected application.

      Under Application Details is a summary of client app information. You can edit some of the values.

      The list under Assigned Features identifies the features that are currently assigned to the application. You cannot add or delete features. For more information, see Managing Application Features.

      In the Cloud Foundry environment you can also configure Custom Routes.

    • APIs 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 ( copy ), to copy the entire value.

      • Under API, you can view a list of frequently used API URLs. Use Copy to Clipboard ( copy ), 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.

    • You can use Application Links to 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.

    • Users enables you to export or delete data for a user, and to block one or more users from using an SAP Build Apps application

    • Security enables you to manage security for the selected application. For details, see Configuring App Security.

    • Log Settings enables 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. See Enabling Event Logs for Apps. You can continue to view event logs as described in Viewing Event Logs.

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.

    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.
    Vendor The vendor that supplied the Micro App.
    License Type 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.

    • Info provides a summary of settings for the selected Micro App. The list under Assigned Features identifies the features that are currently assigned to the Micro App, and enables you to add and delete more. You can also create custom routes.

    • 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 ( copy ), to copy read-only URLs to the clipboard]. Note that the Server URL is also the <mobile_services_host> name.

    • Security enables you to manage security for the selected Micro App. For additional security details see Configuring App Security.

    • 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). See Configuring Alert Settings and Subscribe to Mobile Service Alerts for information.

    • 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. See Enabling Event Logs at the App Level. You can view event logs as described in Viewing Event Logs.

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.
    Vendor (Optional) Vendor who developed the application. The vendor name can contain only alphanumeric characters, spaces, underscores, and periods, and can be up to 255 characters long.
    License Type The license type that you want to use for your account: "standard" (default), "b2c", "free", and "resources"; "lite" is used only for trial subaccounts. The license determines capabilities and charges. 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. Keep in mind that changing service plans is not reversible. You cannot switch from "standard", "resources" or "b2c" to "free". See Service Plans for additional information.
    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 Info tab.

  3. Under Assigned Features, you can view the list of features assigned to the selected application. These features are included by default:

    • Mobile Connectivity – define a data endpoint for the application, enable the detailed event log, and view feature details.

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

    • Mobile Settings Exchange – manage user registrations, send notifications, view feature details, and export SAP Mobile Services data in JSON format.

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

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

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

  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. Select Mobile Micro App under Assigned Features.

  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. Select Mobile Micro App under Assigned Features.

  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. Select Mobile Micro App under Assigned Features.

  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 Mobile Settings Exchange under Assigned Features, then User Registrations.

  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 Mobile Settings Exchange, you must also manually delete the device registration from Mobile 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:

To send Micro App notifications:

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

  2. Select Mobile Settings Exchange under Assigned Features, then User Registration.

  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 Users, 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.

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

    2. Select the file, and then Open.

    For News, specify one or more articles to send:

    1. Select add to add one or more news articles.

    2. 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.

    See WeCom Message Handler API and WeCom Push API for details.

    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.


Last update: January 11, 2024