Skip to content
image/svg+xml
SAP Mobile Services Documentation
The Data Value Hierarchy for Structural Type Value Classes
Initializing search
Overview
Guides
Sample Code
API Reference
Preview
image/svg+xml
SAP Mobile Services Documentation
Overview
Overview
Overview
Guides
Guides
Getting Started
Getting Started
Introduction
Solution Architecture
Enabling Mobile Services
Android
Android
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
iOS
iOS
Introduction
Installing the SAP BTP SDK for iOS
Creating Apps with the SAP BTP SDK Assistant for iOS
Widget Extensions
Machine Learning
Mobile Development Kit
Mobile Development Kit
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 Code
Creating Web Applications
Enhancing Mobile Development Kit Projects with Joule
Support for Chat Completions Action
Development
Development
App Components
Property Binding
Property Binding
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
Advanced Development
Advanced Development
Customizing with Advanced Rules
Customize Query Options with Data Query Builder
NativeScript Framework Modules
Create Extension Controls with TypeScript
Create Extension Controls with TypeScript
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
Custom Branded Client
Custom Branded Client
Creating Custom Clients
Branding Your Customized App
Onboarding Customization
Overriding App Resources
Installing the App on a User's Device
Building Custom Client For Release
Mobile Development Kit Extension for Visual Studio Code
Mobile Development Kit Extension for Visual Studio Code
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 Application
Extending Subscribed Mobile Development Kit Application
Extending Subscribed Mobile Development Kit Apps in SAP Business Application Studio
Mobile Back-End Tools
Mobile Back-End Tools
Introduction
Installing the Tools
Generating an OData Service
Service Generator Tool
Conventions for OData Metadata
Defining Database Indexes
Enabling Change Tracking
Enabling Client Registrations
Customizing Generated Services
Deploying the Generated Service
SAP Mobile Services License
Monitoring Generated Services
Caching Data in the Cloud
Change Tracking for CAP Services
Working with Existing Database Tables
Administration
Administration
Manage
Features
Exporting and Importing Application Configurations
Content Agent Service Integration
Content Agent Service Integration
SAP Content Agent Service Integration
Managing Custom Domains
Managing Alerts
API
API
Introduction
Managing App Registrations
Create Capabilities Upon Registration
Troubleshooting
Troubleshooting
Getting Support
Administration Troubleshooting
Android
Android
Troubleshooting
Mobile Development Kit
Mobile Development Kit
Troubleshooting
Common Issues
Releases & Migration
Releases & Migration
Migration Overview
What's New
Android
Android
What's New in Release 24.12.0
Migration
Known Issues
iOS
iOS
What's New
Mobile Development Kit
Mobile Development Kit
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
Previous Releases
Previous Releases
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
Mobile Back-End Tools
Mobile Back-End Tools
What's New
MBO Migration
Glossary
List of Acronyms
License
License
Developer
Mobile Development Kit
Build
Security
Security
Security Overview
Authenticate Applications Using SAML 2.0
Android
Android
Application Versioning
Authentication
Android Backup
Encryption Utility
Blocking Users
Security Recommendations
Secure Store
Signed QR Codes
Application Management
Application Management
Overview
Attestation
Clipboard Protection
Print Data and Opening URLs Restriction
Root Detection
iOS
iOS
Application Versioning
Authentication
Digitally Signed QR Codes
App Attestation
Lock and Wipe Configuration in SAP BTP SDK for iOS
Device Compliance
Clipboard Protection
Print Data and Opening URLs Restriction
Mobile Back-End Tools
Mobile Back-End Tools
Securing the Generated Service
Administration
Administration
Configuring and Testing Authorized Access
Configuring Application-to-Application SSO Authentication
Service Keys
API
API
Logout Service
Token Introspect Endpoint
Mobile Development Kit
Mobile Development Kit
Authentication and Authorization
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
Onboarding
Onboarding Overview
Android
Android
Configuration Provider
Onboarding with Compose Flows
Onboarding with Compose Flows
Introduction
Start Flow
Flow Configuration
Extension Points
Write Your Own Flow
Feature Integration
Feature Integration
`PrimaryUserService`
Timeout Lock Service Documentation
Onboarding with View-Based Flows
Onboarding with View-Based Flows
Introduction
Start Flow
Extension Points
Flow Configuration
Theme and Style
Understanding Flow Capabilities
Write Your Own Flow
Onboarding Compose Screens
Onboarding Compose Screens
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
Onboarding Screens
Onboarding Screens
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
iOS
iOS
Customizing SAPFioriFlows `FlowsLocalizedStrings`
Mobile Development Kit
Mobile Development Kit
Onboarding to the Mobile Development Kit Client App
Multi User
Supported Onboarding Services
Back-End Connectivity
Back-End Connectivity
Back-End Connectivity Overview
The OData Component
Dynamic API
Using the Mobile Sample Service
The Data Value Hierarchy for Structural Type Value Classes
Android
Android
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
Dynamic API
Dynamic API
Service Initialization with the Dynamic API
Parameters in Dynamic API
Parameter Construction
Metadata API
Asynchronous API
Cache
Sample Service Metadata
OData Debugging
Administration
Administration
Defining Connectivity
Testing OData Destinations
Propagating User IDs
URL Rewrite Modes
API
API
Accessing Services Through Proxy URLs
Retrieving Application Connection Metadata
Read destinations
Service document
Mobile Development Kit
Mobile Development Kit
OData Overview
OData Service Initialization
OData Operations
OData Media Stream
OData Change Set
Sample Service Metadata
Offline
Offline
Offline Overview
Developing Offline Applications
Developing Offline Applications
Overview
Version Support and Limitations
Sample OData Service Metadata
Setting Up an Application
Defining an Application Configuration File
Defining an Application Configuration File
Overview
Defining Queries
Performance Improvement with Delta Tracking and Caching
Group Defining Queries
Application Configuration File
Execution Order of Defining Queries
Modifying Offline Data
Modifying Offline Data
Overview
Creating and Deleting Entities
Modifying Entities
Managing Relationships Between Entities
Unmodifiable Requests
Local Information
Pending Information
Synchronizing Data
Synchronizing Data
Overview
Progress API
Working With Offline Stores
Querying The Offline Store
Handling Errors and Conflicts
Handling Errors and Conflicts
Overview
Accessing the `ErrorArchive`
`ErrorArchive` Entity Properties
Offline Errors Sorted By Name
Offline Errors Sorted By Code
Troubleshooting Synchronization Errors
Handling Failed Requests
Handling Failed Requests
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
Client Only Entities
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
Best Practices
Best Practices
Performance
Miscellaneous
Additional Features
Troubleshooting with ILOData
Offline Odata Handling Relationship
Offline Odata Handling Relationship
Handling Relationships in Offline OData
Sample Service Metadata
Administration
Administration
Defining Offline Settings for Applications
Checking OData Quality
Uploading Offline Stores
Mobile Development Kit
Mobile Development Kit
Initialization and Synchronization
Defining Request
Working with Offline OData
Managing and Upload Offline Stores
User Information
User Information
User Information Overview
Android
Android
User Information
API
API
GET User Roles
Storage
Storage
Storage Service Overview
Android
Android
Overview
API
API
Samples for Storage Service
Managing Storage Service
Accessing Storage Service
Storing Settings
Administration
Administration
Managing JSON Storage
Fiori for Android & iOS
Fiori for Android & iOS
SAP Fiori Overview
Android
Android
The Fiori Component
Views-Based Fiori Components
Views-Based Fiori Components
Form Cells
Form Cells
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
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
Jetpack Compose-Based Fiori Components
Jetpack Compose-Based Fiori Components
Legacy Components
Legacy Components
Fiori Horizon Data Table Cards
Fiori Horizon List Cards
Fiori Horizon Object Cards
Theming in Jetpack Compose
Attachment
Barcode Scanner
Button
Fiori Calendar
Card Cell
Checkout Progress Indicator
Chip Form Cell
Circular Progress Indicator
Collection View
Document Scanner
The Fiori Dropdown Menu
Filter Feedback Bar
Illustrated Message
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
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
iOS
iOS
The Fiori Component
Floorplan
Floorplan
List Floorplan (Tasks Example)
List Floorplan (Tools Example)
Object Detail Floorplan
List Floorplan
Object Floorplan
Onboarding
Onboarding
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
HCPms Compatibility
HCPms Compatibility
Basic Authentication
Dynamic Authentication
EULA View
Info View
User Consent View
Single Page User Consent Form
MultiPage User Consent Form
Object View
Object View
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 View
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
Hierarchy View
Hierarchy View Controller
Hierarchy Item View
Hierarchy Collection Item
Hierarchy Item Table View Cell
Hierarchy View Header
Grid View
Grid View
Grid View
Grid Row Header Item
Grid Table View Header
Contact View
Contact View
Activity Control
Contact Cell
Profile Header
Timeline View
Timeline View
Timeline View
Timeline Cell
Timeline Preview View
Timeline Preview Table View Cell
Timeline Collection View Cell
Timeline Marker Cell
Map View
Map View
Map Floorplan
Map View
Map Detail Panel
Editing Panel
Map Legend
Map Toolbar
Calendar View
Calendar View
Calendar View
Calendar Floorplan View Controller
KPI View
KPI View
KPI View
KPI Progress View
KPI Header
Analytics Cards
Analytics Cards
Analytics Card
Chart Card View
KPI Card View
KPI Progress Card View
UI Patterns
UI Patterns
Create and Filter Patterns
Branding and Theming
Attachments View
Signature Capture View
Feedback Indicators
Feedback Indicators
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 and Barcode Scan
Search Bar and Barcode Scan
Search Bar
Search Controller
Search To Select View
Search To Select View Controller
Barcode Scan View
Mobile Development Kit
Mobile Development Kit
Toolbars
Section Page
Section Page
Section Page
Multi-Selection
Card Collection
Form Cell Page
Extension Page
Bottom Navigation and Tabs Page
Flexible Column Layout Page
Side Drawer
Fragments
Analytics Controls
Context Menu
Styling
Deep Link
Platform Differences
Platform Differences
Cross-Platform Considerations
Web Runtime Limitations
Internationalization
Internationalization
Language Support
Internationalization and Localization of App Metadata
Right to Left Language Layout
Dark Mode Support
Dark Mode Support
Dark Mode Support (Mobile)
Administration
Administration
Configuring Augmented Reality
App Links
App Links
Application Links Overview
Deep Linking
Administration
Administration
Creating Application Links
Theming and Branding
Theming and Branding
Application Themes Overview
Administration
Administration
Managing Application Themes
Android
Android
Application Themes
Custom Theme APIs
How to Use an Application Theme From a Client Application
iOS
iOS
SAP BTP SDK for iOS Theming Support
Multi-Window Support
Multi-Window Support
iOS
iOS
Multi-Window Support
Run
Push
Push
Push Overview
Android
Android
Push Notifications
iOS
iOS
Push Notifications
Mobile Development Kit
Mobile Development Kit
Push Notification Events
Push Notification Data
Push Notification for Multi User
API
API
Sending Push Notifications
Manage Mobile Push Notification Registrations via the REST API
Providers
Providers
Apple Remote Notification
Google/Firebase Cloud Messaging
Windows Notification Service
W3C Push Notifications
Administration
Administration
Configuring Push Notifications
Logging
Logging
Logging Overview
Logger Hierarchies
Logging Recommendations and Guidelines
Android
Android
Using the SAP Logging API
Uploading Logs
Mobile Development Kit
Mobile Development Kit
Logging
Administration
Administration
Configuring Mobile Client Log Upload
Viewing Event Logs
Configuring Alert Settings
Integration & Exception Monitoring in SAP Cloud ALM
API
API
POST Upload Client Logs
Tracing
Tracing
Tracing Overview
Android
Android
SAP Passport Support
Administration
Administration
Tracing Network Activity
Crash Reporting
Crash Reporting
Crash Reporting Overview
Android
Android
Crash Report
Administration
Administration
Managing Mapping Files (Android)
Managing Symbol File (iOS)
Viewing Crash Group Analytics
iOS
iOS
Collect and Upload Crash Reports
Debug Symbol (dSYM)
Client Resources
Client Resources
Client Resources Overview
Android
Android
Client Resources
Administration
Administration
Uploading Client Resources
API
API
Admin
Client
Downloading
App Updates
App Updates
Application Update Overview
API
API
Manage
Deploy
Administration
Administration
Uploading and Deploying Apps
Mobile Development Kit
Mobile Development Kit
App Update
Feature Restrictions
Feature Restrictions
Feature Restrictions Overview
Administration
Administration
Defining Client Policies and Feature Restrictions
Android
Android
Feature Flags
Feature Flags
Feature Flags (Feature Restriction Policy)
iOS
iOS
Feature Flags
Feature Flags
Feature Flags (Feature Vector Policy)
API
API
Managing Feature Restrictions
Scale
Usage Analytics
Usage Analytics
Usage Overview
Android
Android
Client Usage
Administration
Administration
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
API
API
POST User Feedback Reports Upload
POST Client Usage Upload
Cloud Build
Cloud Build
Cloud Build Overview
Administration
Administration
Creating a Build Job
Configuring and Building Apps
Supported Client Types, Packaging Details, and Build Options
Create a Signing Profile
Discovery Service
Discovery Service
Discovery Service Overview
Administration
Administration
Adding Application Configurations
App Catalog
App Catalog
Mobile App Catalog Overview
Administration
Administration
Mobile App Catalog Artifacts
EMM Destinations
App Catalog Service Keys
Mobile App Catalog Settings
Translation Hub
Translation Hub
Translation Hub Overview
Android
Android
Localizing Android Apps
iOS
iOS
Localizing iOS Apps
Shared Device
Shared Device
Shared Device Overview (Multiple User Mode)
Android
Android
Creating Shared Device Apps With The Wizard
iOS
iOS
Shared Devices Support
Sample Code
Sample Code
Android
Android
OData
OData
OData API Sample Code
Setup and Initialization
Querying and Modifying Data Using Proxy Classes
Metadata APIs
Asynchronous APIs
Foundation
Foundation
Foundation Sample Code
Authentication
Back End Connectivity
Cache
Client Usage
Configuration Provider
Logging
Push Notifications
Settings
User Information
API Reference
API Reference
Reference
Android
Android
Javadoc
Kdoc
iOS
Mobile Back-End Tools
Mobile Development Kit
Preview
Preview
SAP Mobile Services Preview
The Data Value Hierarchy for Structural Type Value Classes
¶
Last update: April 14, 2021