image/svg+xml
SAP Mobile Services Documentation
Overview
Initializing search
    • Overview
    • Guides
    • Sample Code
    • API Reference
    • Preview
      • Overview
        • Introduction
        • Solution Architecture
        • Enabling Mobile Services
          • Introduction
          • Installing the SAP BTP SDK for Android
          • Creating Apps with the Wizard
          • Widget Extensions
          • Creating Apps From Scratch
          • Creating Wearable Apps
          • Enabling OData for Your Own Project
          • Introduction
          • Installing the SAP BTP SDK for iOS
          • Creating Apps with the SAP BTP SDK Assistant for iOS
          • Widget Extensions
          • Machine Learning
          • Introduction
          • Setting Up Mobile Services for Mobile Development Kit
          • Creating Apps in Web IDE
          • Creating Apps in SAP Business Application Studio (Cloud Foundry)
          • Creating Apps in SAP Build
          • Creating Web Applications
          • Creating and Enhancing Mobile Development Kit Projects Using Joule
          • Support for Chat Completions Action
            • App Components
              • Binding
              • Object Binding
              • Target Path
              • Internationalization Formatter and Type Formatter
              • Platform Specific Binding
              • Default Value Binding
              • OData Media Binding
            • Create Pages
            • Create Fragments
            • Actions
            • Executing Actions
            • Create Services
            • Action Binding and Result
            • Create Rules
            • Client Data
            • `i18n` Files
            • Customizing with Advanced Rules
            • Customize Query Options with Data Query Builder
            • NativeScript Framework Modules
              • Extensions
              • Data Binding in Extension
              • Sectioned Table Extension
              • Form Cell Extension
              • Page Control Extension
              • Internationalization for Extension Module
              • Advanced Form Cell Extension
              • `UITableView` Based Extension for iOS
              • Registering Extension Control in Web IDE Editor
              • Registering Extension Control in SAP Business Application Studio
            • Creating Custom Clients
            • Branding Your Customized App
            • Custom Logo and Splash Screen
            • Custom Icon for Onboarding Screen in Android
            • Onboarding Customization
            • Overriding App Resources
            • Installing the App on a User's Device
            • Building Custom Client For Release
            • Introduction
            • Installing the Extension
            • Creating Apps
            • Editing Metadata
            • Validating Apps
            • Bundling Apps
            • Debugging Apps
            • Component Application Development
            • Creating and Bundling Metadata Extensions
            • User Settings
            • Deploying to Mobile Services
            • IntelliSense and Code Navigation Support for Metadata Extensions
            • Extending Subscribed Mobile Development Kit Apps in SAP Business Application Studio
          • Introduction
          • Installing the Tools
            • Creating an OData Service
            • Building the OData Service
            • Deploying the OData Service
            • Monitoring Generated Services
            • Service Generator Tool
            • Conventions for OData Metadata
            • Customizing Generated Services
            • Configuring Destinations
            • Configuring Multi-Tenancy
            • Defining Database Indexes
            • Enabling Change Tracking
            • Enabling Client Registrations
            • Caching Data in the Cloud
            • Working with Existing Database Tables
          • Change Tracking for CAP Services
          • Managing Mobile Services Instances
          • Manage
          • Features
          • Exporting and Importing Application Configurations
            • SAP Content Agent Service Integration
          • Managing Custom Domains
          • Managing Alerts
          • Introduction
          • Managing App Registrations
          • Create Capabilities Upon Registration
        • Getting Support
        • Administration Troubleshooting
          • Troubleshooting
          • Troubleshooting
          • Common Issues
        • Migration Overview
        • What's New
          • What's New in Release 26.1.1
          • Migration
          • Known Issues
          • What's New
          • What's New
          • Migration
          • Metadata / Client Project Migration
          • Migration From SAP Web IDE to SAP Business Application Studio
          • Migrating Mobile Development Kit App From SAP Business Technology Platform Neo to Cloud Foundry Environment
          • Known Issues
            • 4.2 Release Notes
            • 4.3 Release Notes
            • 5.0 Release Notes
            • 5.1 Release Notes
            • 5.2 Release Notes
            • 6.0 Release Notes
            • 6.1 Release Notes
            • 6.2 Release Notes
            • 6.3 Release Notes
            • 23.4 Release Notes
            • 23.8 Release Notes
            • 23.12 Release Notes
            • 24.4 Release Notes
            • 24.7 Release Notes
            • 24.11 Release Notes
            • 25.6 Release Notes
          • What's New
          • MBO Migration
      • Glossary
      • List of Acronyms
        • Developer
        • Mobile Development Kit
      • Build
        • Security Overview
        • Authenticate Applications Using SAML 2.0
          • Application Versioning
          • Authentication
          • Android Backup
          • Encryption Utility
          • Blocking Users
          • Security Recommendations
          • Secure Store
          • Signed QR Codes
            • Overview
            • Attestation
            • Clipboard Protection
            • Print Data and Opening URLs Restriction
            • Root Detection
          • Application Versioning
          • Authentication
          • Digitally Signed QR Codes
          • App Attestation
          • Lock and Wipe Configuration in SAP BTP SDK for iOS
          • Passcode Reuse Restriction
          • Device Compliance
          • Clipboard Protection
          • Print Data and Opening URLs Restriction
          • Securing the Generated Service
          • Configuring and Testing Authorized Access
          • Configuring Application-to-Application SSO Authentication
          • Service Keys
          • Logout Service
          • Token Introspect Endpoint
          • Authentication and Authorization
          • Client Policy & Security
          • Allowlist for Connection Settings
          • Certificate Authorities Trusted by Mobile Development Kit Android App
          • Mobile Development Kit Android App Permissions
          • Android Screen Sharing
          • Running Mobile Development Kit Web Apps in SAP Cloud Portal Service on BTP
          • Data Protection and Privacy (DPP) and Audit Logs
          • Transport Security
          • Signed QR Codes
        • Onboarding Overview
          • Configuration Provider
            • Introduction
            • Start Flow
            • Flow Configuration
            • Flow State Listener
            • Flow Action Handler
            • Write Your Own Flow
              • `PrimaryUserService`
              • Timeout Lock Service Documentation
              • Cross-Context SSO
            • Introduction
            • Start Flow
            • Extension Points
            • Flow Configuration
            • Theme and Style
            • Understanding Flow Capabilities
            • Write Your Own Flow
            • Introduction
            • Launch Screen
            • EULA Screen
            • Activation Selection Screen
            • Discovery Service Activation
            • QR Code Reader Screen
            • QR Code Reader Confirmation
            • Basic Authentication Screen
            • Passcode Creation Screen
            • Passcode Verification Screen
            • Biometric Screen
            • Sign-In Screen
            • User List Screen
            • Loading Screen
            • Consent Screen
            • Offline Synchronization Screen
            • Offline Network Issue Screen
            • Offline Transaction Issue Screen
            • Introduction
            • Launch Screen
            • Activation Screen
            • QR Code Reader Screen
            • QR Code Confirmation Screen
            • Basic Authentication Screen
            • Set Passcode Screen
            • Confirm Passcode Screen
            • Enter Passcode Screen
            • Enable Fingerprint Screen
            • Fingerprint Screen
            • Enable Biometric Screen
            • Confirm Biometric Screen
            • Consent Screen
            • EULA Screen
            • Sign In Screen
            • Offline Initialization Sync Screen
            • Offline Network Error Screen
            • Offline Transaction Issue Screen
          • Customizing SAPFioriFlows `FlowsLocalizedStrings`
          • Customizing App-Level Language
          • Onboarding to the Mobile Development Kit Client App
          • Multi User
        • Supported Onboarding Services
        • Back-End Connectivity Overview
        • The OData Component
        • Dynamic API
        • Using the Mobile Sample Service
        • The Data Value Hierarchy for Structural Type Value Classes
          • Back-End Connectivity
          • OData Overview
          • Service Initialization
          • Proxy Classes
          • Using the OData API
          • A Comparison of Proxy Classes and Dynamic API
          • Runtime Discovery of the Entity Data Model
            • Service Initialization with the Dynamic API
            • Parameters in Dynamic API
            • Parameter Construction
          • Metadata API
          • Asynchronous API
          • Cache
          • Sample Service Metadata
          • OData Debugging
          • Defining Connectivity
          • Testing OData Destinations
          • Propagating User IDs
          • URL Rewrite Modes
          • Accessing Services Through Proxy URLs
          • Retrieving Application Connection Metadata
          • Read destinations
          • Service document
          • OData Overview
          • OData Service Initialization
          • OData Operations
          • OData Media Stream
          • OData Change Set
          • Sample Service Metadata
        • Offline Overview
          • Overview
          • Version Support and Limitations
          • Sample OData Service Metadata
          • Setting Up an Application
            • Overview
            • Defining Queries
            • Performance Improvement with Delta Tracking and Caching
            • Group Defining Queries
            • Application Configuration File
            • Execution Order of Defining Queries
            • Overview
            • Creating and Deleting Entities
            • Modifying Entities
            • Managing Relationships Between Entities
            • Unmodifiable Requests
            • Local Information
            • Pending Information
            • Overview
            • Progress API
          • Working With Offline Stores
          • Querying The Offline Store
            • Overview
            • Accessing the `ErrorArchive`
            • `ErrorArchive` Entity Properties
            • Offline Errors Sorted By Name
            • Offline Errors Sorted By Code
            • Troubleshooting Synchronization Errors
            • Overview
            • Finding Entities in Error State
            • Reverting Error State
            • Fixing Requests in Error State
            • Applying Fixed Requests
          • Media Resources
          • Repeatable Requests
          • OData Singletons
            • Client-only Entities Overview
            • Client-only Metadata Definition
            • Using Client-only Entities
            • Local Draft Entity Set
            • Client-only Entities Limitations
            • Troubleshooting Client-only Entities Errors
            • Performance
            • Miscellaneous
          • Additional Features
          • Troubleshooting with ILOData
            • Handling Relationships in Offline OData
            • Sample Service Metadata
          • Defining Offline Settings for Applications
          • Checking OData Quality
          • Uploading Offline Stores
          • Initialization and Synchronization
          • Defining Request
          • Working with Offline OData
          • Error Handling
        • Managing and Upload Offline Stores
        • User Information Overview
          • User Information
          • GET User Roles
        • Storage Service Overview
          • Overview
          • Samples for Storage Service
          • Managing Storage Service
          • Accessing Storage Service
          • Storing Settings
          • Managing JSON Storage
        • SAP Fiori Overview
          • The Fiori Component
              • Form Cells
              • The Attachment Form Cell
              • Choice Form Cell
              • Date Time Picker Form Cell
              • Duration Picker Form Cell
              • The Filter Form Cell
              • The Filter Chip Form Cell
              • The Generic List Picker Form Cell
              • The List Picker Form Cell
              • The Note Form Cell
              • The Simple Property Form Cell
              • The Slider Form Cell
              • The Switch Form Cell
              • The Filter Dialog Fragment
              • The Sort and Filter Dialog Fragment
              • Sectioned Recycler View Adapter
              • Multi Sort Form Cell
              • The Signature Capture Form Cell
              • The Inline Signature Capture Form Cell
              • The Signature Form Cell
            • Contact Cell
            • Data Table
            • Grid Table Row
            • Grid Object Cell
            • Hierarchy View
            • The Inline Notice
            • Fiori Indicator
            • Linear Progress Bar
            • Circular Progress Bar
            • Key Value Cell
            • The Fiori List Popup Window (Dropdown Menu)
            • Object Cell
            • Object Header
            • Navigation Bar
            • Profile Header
            • Fiori Search User Interface
            • Collection View
            • Timeline
            • Theming and Styling
            • App Bar
            • Banner Messages
            • Chart Cards
            • Column Chart
            • Consent Form
            • Fast Filter View
            • Horizontal Bar Chart
            • KPI Headers
            • Chart Header
            • Line Chart
            • Donut Chart
            • Scatter Chart
            • Map Controls
            • Optical Character Recognition (OCR)
            • Barcode and QR Code Scan
            • Persistent Footer
            • Section Header Footer
            • Privacy Notice
            • AR Stickers
              • Fiori Horizon Data Table Cards
              • Fiori Horizon List Cards
              • Fiori Horizon Object Cards
            • Theming in Jetpack Compose
            • Feedback Sheet
            • Attachment
            • Barcode Scanner
            • Fiori Banner
            • Laser Scanner
            • Button
            • Fiori Calendar
            • Card Cell
            • Checkout Progress Indicator
            • Chip Form Cell
            • Circular Progress Indicator
            • Collection View
            • Date Picker
            • Date Time Picker Form Cell
            • Document Scanner
            • The Fiori Dropdown Menu
            • Filter Feedback Bar
            • Illustrated Message
            • Inline AI Feedback
            • The Inline Notice
            • Key Value Cell
            • KPI and Numeric Data
            • Linear Progress Indicator
            • List Picker
            • Card System
            • Multi Sort
            • Note Text Field
            • Native File Viewer
            • The Fiori Navigation Drawer in Jetpack Compose
            • Navigation Bar/Rail in Jetpack Compose
            • Fiori Object Cell
            • Object Header
            • Fiori Page Header
            • Painter Builder with Coil
            • PDF Viewer
            • Persistent Footer
            • Privacy Notice
            • Profile Header
            • Progress View KPI
            • Rating Control
            • Section Header Footer
            • Fiori Signature Capture
            • Signature Form Cell
            • Fiori Signature Capture Inline
            • Simple Text Field
            • Skeleton Loading
            • Slider
            • Sort and Filter
            • Status and Info Labels
            • Step Progress Indicator
            • Switch
            • Top App Bar
            • `TopBarMenu` Overview
            • AI Progress Indicator
            • Stepper
            • AI Writing Assistant Text Field
            • Fiori Required Field Configuration
          • The Fiori Component
            • List Floorplan (Tasks Example)
            • List Floorplan (Tools Example)
            • Object Detail Floorplan
            • List Floorplan
            • Object Floorplan
            • Onboarding Pattern
            • Welcome Screen
            • Activation Screen
            • Onboarding Scan View
            • Onboarding Scan Confirm View
            • Passcode Controller
            • Passcode Input Controller
            • Passcode Create Controller
            • Passcode Change Controller
            • MultiUser Passcode Controller
            • Whats New View
              • Basic Authentication
              • Dynamic Authentication
              • EULA View
              • Info View
              • User Consent View
              • Single Page User Consent Form
              • MultiPage User Consent Form
            • Object View
            • Object Cell
            • Object Table View Cell
            • Object Collection View Cell
            • Object Header
            • Object Header View
            • Object Header Chart View
            • Single Action Accessory View
            • Single Action Button
            • Single Action Progress Indicator
            • Collection View
            • Collection Item View
            • Image Collection Item View
            • Item Collection View Cell
            • Image Collection View Cell
            • Simple Property Collection View Cell
            • Hierarchy View
            • Hierarchy View Controller
            • Hierarchy Item View
            • Hierarchy Collection Item
            • Hierarchy Item Table View Cell
            • Hierarchy View Header
            • Grid View
            • Grid Row Header Item
            • Grid Table View Header
            • Activity Control
            • Contact Cell
            • Profile Header
            • Timeline View
            • Timeline Cell
            • Timeline Preview View
            • Timeline Preview Table View Cell
            • Timeline Collection View Cell
            • Timeline Marker Cell
            • Map Floorplan
            • Map View
            • Map Detail Panel
            • Editing Panel
            • Map Legend
            • Map Toolbar
            • Calendar View
            • Calendar Floorplan View Controller
            • KPI View
            • KPI Progress View
            • KPI Header
            • Analytics Card
            • Chart Card View
            • KPI Card View
            • KPI Progress Card View
            • Create and Filter Patterns
            • Branding and Theming
            • Attachments View
            • Signature Capture View
            • Banner Message View
            • Feedback Screen
            • Loading Indicator View
            • Modal Checkout View
            • Modal Loading Indicator
            • Modal Loading Indicator View
            • Modal Processing Indicator
            • Modal Processing Indicator View
            • Offline Banner Message View
            • Processing Indicator View
            • Progress Banner Message View
            • Progress Indicator
            • Toast Message
            • Search Bar
            • Search Controller
            • Search To Select View
            • Search To Select View Controller
            • Barcode Scan View
          • Toolbars
          • Grouping
            • Section Page
            • Multi-Selection
            • Card Collection
            • Calendar
          • Form Cell Page
          • Extension Page
          • Bottom Navigation and Tabs Page
          • Flexible Column Layout Page
          • Side Drawer
          • Fragments
          • Analytics Controls
          • Context Menu
          • Styling
          • Deep Link
            • Cross-Platform Considerations
            • Web Runtime Limitations
            • Language Support
            • Internationalization and Localization of App Metadata
            • Right to Left Language Layout
            • Dark Mode Support (Mobile)
          • Configuring Augmented Reality
        • Application Links Overview
        • Deep Linking
          • Creating Application Links
        • Application Themes Overview
          • Managing Application Themes
          • Application Themes
          • Custom Theme APIs
          • How to Use an Application Theme From a Client Application
          • SAP BTP SDK for iOS Theming Support
          • Multi-Window Support
      • Run
        • Push Overview
          • Push Notifications
          • Push Notifications
          • Push Notification Events
          • Push Notification Data
          • Push Notification for Multi User
          • Sending Push Notifications
          • Manage Mobile Push Notification Registrations via the REST API
            • Apple Remote Notification
            • Google/Firebase Cloud Messaging
            • Windows Notification Service
            • W3C Push Notifications
          • Configuring Push Notifications
        • Logging Overview
        • Logger Hierarchies
        • Logging Recommendations and Guidelines
          • Using Logging API
          • Uploading Logs
          • Logging
          • Configuring Mobile Client Log Upload
          • Viewing Event Logs
          • Configuring Alert Settings
          • Integration & Exception Monitoring in SAP Cloud ALM
          • POST Upload Client Logs
        • Tracing Overview
          • SAP Passport Support
          • Tracing Network Activity
        • Crash Reporting Overview
          • Crash Report
          • Managing Mapping Files (Android)
          • Managing Symbol File (iOS)
          • Viewing Crash Group Analytics
          • Collect and Upload Crash Reports
          • Debug Symbol (dSYM)
        • Client Resources Overview
          • Client Resources
          • Uploading Client Resources
          • Admin
          • Client
          • Downloading
        • Application Update Overview
          • Manage
          • Deploy
          • Uploading and Deploying Apps
          • App Update
        • Feature Restrictions Overview
          • Defining Client Policies and Feature Restrictions
            • Feature Flags (Feature Restriction Policy)
            • Feature Flags (Feature Vector Policy)
          • Managing Feature Restrictions
      • Scale
        • Usage Overview
          • Client Usage
          • Configuring Client Usage and User Feedback
          • Downloading or Exporting Client Usage and User Feedback Data
          • Viewing User Feedback Charts
          • Viewing Server Data Charts
          • Viewing User Data Charts
          • Viewing Audit Logs
          • Usage Metering
          • POST User Feedback Reports Upload
          • POST Client Usage Upload
        • Cloud Build Overview
          • Creating a Build Job
          • Configuring and Building Apps
          • Supported Client Types, Packaging Details, and Build Options
          • Create a Signing Profile
        • Discovery Service Overview
          • Adding Application Configurations
        • Mobile App Catalog Overview
          • Mobile App Catalog Artifacts
          • EMM Destinations
          • App Catalog Service Keys
          • Mobile App Catalog Settings
        • Translation Hub Overview
          • Localizing Android Apps
          • Localizing iOS Apps
        • CI/CD Overview
        • Shared Device Overview (Multiple User Mode)
          • Creating Shared Device Apps With The Wizard
          • Shared Devices Support
          • OData API Sample Code
          • Setup and Initialization
          • Querying and Modifying Data Using Proxy Classes
          • Metadata APIs
          • Asynchronous APIs
          • Foundation Sample Code
          • Authentication
          • Back End Connectivity
          • Cache
          • Client Usage
          • Configuration Provider
          • Logging
          • Push Notifications
          • Settings
          • User Information
      • Reference
        • Javadoc
        • Kdoc
      • iOS
      • Mobile Back-End Tools
      • Mobile Development Kit
      • SAP Mobile Services Preview
    Build awesome enterprise apps in a snap
    SAP Mobile Services helps you satisfy enterprise requirements so that you can focus on creating business value.

    Our Technology

    Android
    • Get Started
    • Tutorials
    • What's New
    iOS
    • Get Started
    • Tutorials
    • What's New
    Mobile Development Kit
    • Get Started
    • Tutorials
    • What's New
    Mobile Services
    • Get Started
    • Administration
    • What's New
    Mobile Back-End Tools
    • Get Started
    • What's New

    Our Features

    Build
    • 
      Security
      Cloud Foundry environment supported
      
      Android supported
      
      iOS supported
    • 
      Onboarding
      Cloud Foundry environment supported
      
      Android supported
      
    • 
      Back-end Connectivity
      Cloud Foundry environment supported
      
      Android supported
    • 
      Offline
      Cloud Foundry environment supported
      
      Android supported iOS supported
    • 
      User Information
      Cloud Foundry environment supported
      
      Android supported
    • 
      Storage Service
      Cloud Foundry environment supported
      
      Android supported
    • 
      Fiori for Android & iOS
      Android supported
      
    • 
      Application Links
      Cloud Foundry environment supported
      
      Android supported
    • 
      Application Themes
      Cloud Foundry environment supported Android supported iOS supported
    Run
    • 
      Push
      Cloud Foundry environment supported
      
      Android supported iOS supported
      
    • 
      Logging
      Cloud Foundry environment supported
      
      Android supported
      
    • 
      Tracing
      Cloud Foundry environment supported
      
    • 
      Crash Reporting
      Cloud Foundry environment supported Android supported iOS supported
    • 
      Client Resources
      Cloud Foundry environment supported
      
      Android supported
    • 
      Application Updates
      Cloud Foundry environment supported
      
      
    • 
      Feature Restrictions
      Cloud Foundry environment supported
      
    Scale
    • 
      Usage Analytics
      Cloud Foundry environment supported
      
      Android supported
    • 
      Cloud Build
      Cloud Foundry environment supported
      
    • 
      App Catalog
      Cloud Foundry environment supported
    • 
      Discovery Service
      Cloud Foundry environment supported
      
    • 
      Translation Hub
      
      Android supported iOS supported
    • 
      CI/CD
      Cloud Foundry environment supported
    Learn
    • Learning Journeys
    • Tutorials
    • Sample Apps
    Community
    • Product Overview
    • Continuous Influencing
    • Blogs
    • Questions & Answers
    Support
    • Product Support
    • SAP Business Accelerator Hub
    • SAP Notes
    Legal
    • Feature Scope
    • Copyright
    • Disclaimer
    • Privacy Statement
    • Impressum
    • Terms of Use
    © 2025 SAP SE. All rights reserved.
    • Copyright
    • Disclaimer
    • Privacy Statement
    • Legal Disclosure
    • Trademark
    • Terms of Use