"How the Usage Reporting feature works How to customize the consent screen How to further instrument the Wizard app How to add code to enable auto-upload of usage data based on the client policy"

"What do I need before I start?"

" You completed Try Out the SAP BTP SDK Wizard for Android. "

Use Usage Reporting in Your Android Application

See how the Usage Reporting feature can help provide information on how your app is being used.

🎓beginner ⏱30 min SAP BTP Sdk For Android Beginner Android Mobile Odata SAP Business Technology Platform 0/4

Overview

🎓 beginner ⏱ 30 min. SAP BTP Sdk For AndroidBeginnerAndroidMobileOdataSAP Business Technology Platform

You will learn

✔How the Usage Reporting feature works
✔How to customize the consent screen
✔How to further instrument the Wizard app
✔How to add code to enable auto-upload of usage data based on the client policy

B Bruce Meng January 7, 2026

Created by April 26, 2024

Contributors

Prerequisites

You completed Try Out the SAP BTP SDK Wizard for Android.

Steps

Open all Close all

Step 1 Manual upload of usage data

—

As shown in the tutorial, Try Out the SAP BTP SDK Wizard for Android, ensure that Enable Usage Reporting is checked when creating the app.

When the app is first installed, a consent screen will automatically be shown to users.

The app must first receive permission to collect usage information from the user.

Tap ALLOW to allow the app to record how the app is being used.
Consent Screen
If DENY was selected, the user’s choice can later be changed in the app’s Settings screen.
Usage in Settings
Once you try to enable Consent to Usage Collection, the consent screen will be displayed again to confirm your choice.
The Consent to Usage Collection will be disabled and cannot be enabled if usage was not enabled in the Mobile Services cockpit.
To review this policy setting, in the Mobile Services cockpit, access Client Usage and User Feedback by navigating to Mobile Applications > Native/MDK > btp.sdk.wizapp > Client Usage and User Feedback.
Access Client Usage and User Feedback
The Client Usage Configuration specifies whether uploads of usage data are allowed and the time interval between automatic usage report uploads.
The preset value for Upload Report After is 0 (usage reports will not be uploaded automatically), which we will use in the implementation of automatically uploading usage reports to the server. Finally, click Save to save any changes.
Enable Usage in Client Policies
From the Settings screen, tap Upload Usage Data.
Click Upload Usage
If an empty usage report notification is shown when Upload Usage Data is selected, navigate away from the app by going to your phone’s Home screen and re-entering the app. Then try uploading the usage report again. Placing the app in the background will complete or end the current usage session. Partial sessions can not be uploaded.
Empty Usage Report Upload Attempt
If Upload Usage Data was successful, then a Toast message should pop up informing you that the usage information has been uploaded to the server.
Successful Usage Upload

Step 2 Examine uploaded usage data

To view the application usage report, go to your management cockpit under Analytics > User Data.
View usage report
Different charts become available when you select between Sessions, Demographics, and Behavior in the drop-down (green) box. The mark in the yellow box controls whether to display filters that are in the red box right below.
To download the usage report, go to Mobile Applications > Native/MDK > btp.sdk.wizapp > Client Usage and User Feedback. You can filter the data by changing the value of the Last 7 Days dropdown. Click the Download icon to export the filtered data to a .csv file.
Download Usage From Management Cockpit

Open the downloaded clientUsage_uploads.csv. The file contains usage entries from the app that record different actions, such as button taps and timers.

Column	Description
`APPLICATIONID`	Identifies the app the usage report events were generated from
`DEVICEMODEL`	Device type (Samsung, Android Emulator, etc.)
`DEVICEPLATFORM`	Android or iOS
`DEVICEVERSION`	Device software version
`REGISTRATIONID`	A unique ID generated when you first register your device
`USERSESSIONID`	A unique ID generated every time the application is re-opened
`RECORDKEY`	What kind of information is being described (information about the device (`DeviceInfo`), an event within the application (`BehaviorEvent`), etc.)
`RECORDTYPE`	`BehaviorEvent` type (e.g. `viewDisplayed`, `userInteraction`)
`TIMERSTART`	Time the event began
`TIMERDURATION`	How long an event ran for, in seconds
`I_SCREEN`	Screen resolution of the device using the current `OSLifecycle` state as the key
`I_VIEW`	The name of the Screen/View where `BehaviourEvents` are generated
`I_ELEMENT`	UI element or screen control that was interacted with
`I_ACTION`	Action that the user performed
`I_VALUE`	Value related to the interaction, if applicable

In the following example, there are three different Android devices with varying software versions.

CSV Information on Device Specifications

In the next example, the timer recorded how long the user kept the application active on their device before exiting for five different sessions. Recording how long users spend in the application is a typical measurement. You can also specify other processes to time, such as application startup, data requests, or the time taken to open an offline store.

A session is typically defined as how long the app has been open for in the foreground, but different records within the application can also be modified to act as sessions.

A single REGISTRATIONID can be associated with multiple USERSESSIONIDs. REGISTRATIONID is independent of your username. In the following example the same user registered on two different devices and ran three user sessions.
Session Descriptive Information

When the application is initially launched, the report will contain entries that describe the device screen, memory and networking capabilities in a condensed form in four columns, marking the end of a session.

`I_VALUE`	Description
`EnterApplication`	Screen resolution of the device (`I_SCREEN`)
`device`	Reiterates the screen resolution (`I_SCREEN` and `I_VIEW`), device platform (`I_ELEMENT`), and specifies the device language (`I_ACTION`)
`memory`	Device RAM (`I_SCREEN`), internal storage (`I_VIEW`), and available space on the SD card (`I_ELEMENT`)
`networking`	Device network connected status (`I_SCREEN`), device Wifi connected status (`I_VIEW`), and device cell data connected status (`I_ELEMENT`) with carrier name (`I_ACTION`) if cell data connected

`I_VALUE`	Description
`EnterApplication`	Screen resolution of the device (`I_SCREEN`)
`location`	Location permission for the application (denied or authorized); if authorized then it will list the latitude (`I_VIEW`), longitude (`I_ELEMENT`), and city (`I_ACTION`)
`device`	Reiterates the screen resolution (`I_SCREEN` and `I_VIEW`), device platform (`I_ELEMENT`), and specifies the device language (`I_ACTION`)
`memory`	Device RAM (`I_SCREEN`), internal storage (`I_VIEW`), and available space on the SD card (`I_ELEMENT`)
`networking`	Device network connected status (`I_SCREEN`), device Wifi connected status (`I_VIEW`), and device cell data connected status (`I_ELEMENT`) with carrier name (`I_ACTION`) if cell data connected

The app also records a few of the screens that user opens, and more usage reporting statements can be added in the code to track other specific screens.

In the example below, the user navigated to the Entity List screen, accessed the categories at positions 6 and 1, then entered the Settings screen.

The code segment that records EntitySetListActivity is in the onCreate method in EntitySetListActivity.kt.

Kotlin
SDKInitializer.getService(UsageService::class)?.eventBehaviorViewDisplayed(EntitySetListActivity::class.java.simpleName, "elementId", "onCreate", "called")

Step 3 Add further usage instrumentation

The Usage feature can be used to instrument an app to track things that might provide insight into a user’s behaviors.

The following steps record how often users start adding or updating products but cancel their changes. This is somewhat similar to a metric in a shopping cart type app, where it might be interesting to know how often items are added to a shopping cart, but the sale is not completed.

In Android Studio, on Windows, press Ctrl+N, or on a Mac, press command+O, and type ODataViewModel to open ODataViewModel.kt.
On Windows, press Ctrl+F12, or on a Mac, press command+F12 and type onUpdate, to navigate to the onUpdate method in the same file.

Add the following code segment to the very beginning of the method:

Kotlin
SDKInitializer.getService(UsageService::class)?.eventBehaviorUserInteraction(ODataViewModel::class.java.simpleName, "elementId", "edit${(this as EntityViewModel).entityType.localName}Clicked", "Begin Edit ${entityType.localName}")

This generates a usage event record for when a user taps the Edit icon within any entity screen.

On Windows, press Ctrl+F12, or on a Mac, press command+F12 and type onCreate, to navigate to the onCreate method. Add the following code segment to the very beginning of the method:
Kotlin
```
SDKInitializer.getService(UsageService::class)?.eventBehaviorUserInteraction(ODataViewModel::class.java.simpleName, "elementId", "create${(this as EntityViewModel).entityType.localName}Clicked", "Begin Create ${entityType.localName}")
```
This generates a usage event record for when a user taps the Add icon within any entity screen.
On Windows, press Ctrl+N, or on a Mac, press command+O, and type EntityViewModel to open EntityViewModel.kt.
On Windows, press Ctrl+F12, or on a Mac, press command+F12 and type exitCreation, to navigate to the exitCreation method. Add the following code segment to the very beginning of the method:
Kotlin
```
SDKInitializer.getService(UsageService::class)?.eventBehaviorUserInteraction(EntityViewModel::class.java.simpleName, "elementId", "onBackPressed", "Create ${entityType.localName} Cancelled")
```
This generates the usage event record whenever the user navigates away from a creating screen without saving.

Add the following imports if they are not auto-added:

Kotlin
import com.sap.cloud.mobile.foundation.mobileservices.SDKInitializer
import com.sap.cloud.mobile.foundation.usage.UsageService

Build and run the app.
Generate usage information by accessing Products.
Access Products
Tap the floating Add button to create a product.
Create a New Product Item
Press the Back button to exit the page without saving.
Press Back Button
Repeat these steps two more times to generate multiple entries for the usage report.
Select an existing product and tap its Edit button.
Edit Product
Then immediately tap the check mark button to save the information.
Save Product
End the usage session by placing the app in the background. Navigate back into the app.
Upload the usage by going to Settings and tap on Upload Usage Data.
After downloading the clientUsage_uploads.csv file from the Mobile Services cockpit, you should be able to see new entries with I_VIEW values of ODataViewModel and I_ACTION values of onBackPressed, createProductClicked and editProductClicked.
New Entries in the Client Upload csv
In the four empty cells on the Excel spreadsheet, label two of them with Product Create or Edit Clicked and Cancelled Product Create respectively. Next to Product Create or Edit Clicked, use the following formula to find the number of times the user intended to add/update a product:
Excel
```
=COUNTIF(R:R, "*createProductClicked*")+COUNTIF(R:R, "*editProductClicked*")
```
Next to Cancelled Product Create, use the following formula to find the number of times the user cancelled an add product action:
Excel
```
=COUNTIF(R:R, "*onBackPressed*")
```
In the example, the user tried to create a product three times but cancelled three times, and edited it once.
Counting Product Creation and Cancellations with Excel Formulas

In Android Studio, on Windows, press Ctrl+N, or on a Mac, press command+O, and type ProductsCreateFragment to open ProductsCreateFragment.kt.
On Windows, press Ctrl+F12, or on a Mac, press command+F12 and type onCreate, to navigate to the onCreate method in the same file.
Find the following line:
Kotlin
```
super.onCreate(savedInstanceState)
```

Add the following code segment immediately after:

Kotlin
SDKInitializer.getService(UsageService::class)?.eventBehaviorUserInteraction(ProductsCreateFragment::class.java.simpleName, "elementId", "createOrEditProductClicked", "Begin Create or Edit Product")

This generates a usage event record for when a user taps the Add or Edit icon within Products.

On Windows, press Ctrl+F12, or on a Mac, press command+F12 and type onMenuItemSelected, to navigate to the onMenuItemSelected method. Add the following code segment before the else case in the same file:
Kotlin
```
android.R.id.home -> {
    SDKInitializer.getService(UsageService::class)?.eventBehaviorUserInteraction(ProductsCreateFragment::class.java.simpleName, "elementId", "onBackPressed", "Create or Edit Product Cancelled")
    super.onMenuItemSelected(menuItem)
}
```
This generates the usage event record whenever the user navigates away from an editing screen without saving.
Build and run the app.
Generate usage information by accessing Products.
Access Products
Tap the floating Add button to create a product.
Create a New Product Item
Press the Back button to exit the page without saving.
Press Back Button
Repeat these steps two more times to generate multiple entries for the usage report.
Select an existing product and tap its Edit button.
Edit Product
Then immediately tap the check mark button to save the information.
Save Product
End the usage session by placing the app in the background. Navigate back into the app.
Upload the usage by going to Settings and tap on Upload Usage Data.
After downloading the clientUsage_uploads.csv file from the Mobile Services cockpit, you should be able to see new entries with I_VIEW values of ProductsCreateFragment and I_ACTION values of onBackPressed and createOrEditProductClicked.
New Entries in the Client Upload csv
In the four empty cells that are not in the R ( I_ACTION ) column on the Excel spreadsheet, label two of them with Product Create or Edit Clicked and Cancelled Product Create or Edit respectively. Next to Product Create or Edit Clicked, use the following formula to find the number of times the user intended to add/update a product:
Excel
```
=COUNTIF(R:R, "*createOrEditProductClicked*")
```
Next to Cancelled Product Create or Edit, use the following formula to find the number of times the user cancelled an add/update product action:
Excel
```
=COUNTIF(R:R, "*onBackPressed*")
```
In the example, the user tried to create a product three times but cancelled three times, and edit it once.
Counting Product Creation and Cancellations with Excel Formulas

Step 4 Auto-upload of usage data

Mobile Services provides a Client Usage Configuration under Mobile Client Usage and User Feedback specifying whether uploads to Mobile Services are allowed and how often they should occur. The following instructions demonstrate how to modify the app to read and store the configuration (same as the concept of the following policy) and upload the usage data to Mobile Services using the specified interval.

Input the number of days after which a report should automatically be uploaded and click Save. For the purposes of this tutorial, use the value 1 to simplify testing later on.
Set Auto Upload of Usage Report
In Android Studio, on Windows, press Ctrl+N, or on a Mac, press command+O, and type WizardFlowStateListener to open WizardFlowStateListener class.

Near the end of the class, add the following companion objects:

Kotlin
private var isUsageEnabled: Boolean = false
private var uploadInterval: Int = 0

On Windows, press Ctrl+F12, or on a Mac, press command+F12, and type onClientPolicyRetrieved to navigate to the onClientPolicyRetrieved method.

At the end of the method, add the following code:

Kotlin
policies.usagePolicy?.also {
    isUsageEnabled = it.dataCollectionEnabled
    uploadInterval = it.uploadDataAfterDays
    if (isUsageEnabled) {
        UsageBroker.setDataCollectionEnabled(isUsageEnabled)
        uploadUsage()
    }
}

This code gets the usage policy information from the server client policy and stores it inside global variables.

Add the following method in the class:

Kotlin
private fun uploadUsage() {
    UsageBroker.setDaysToWaitBetweenUpload(uploadInterval)

    //if uploadInterval is greater than 0 then auto-upload is considered to be enabled on Mobile Services
    if (uploadInterval > 0) {
        // The upload will only occur if the last upload was more than newDays ago
        AppUsageUploader.addUploadListener(object: AppUsageUploader.UploadListener {
            override fun onSuccess() {
                Toast.makeText(application, application.getString(R.string.usage_upload_ok), Toast.LENGTH_LONG).show()
            }

            override fun onError(error: Throwable) {
                // make sure to import com.sap.cloud.mobile.foundation.networking.HttpException;
                if (error is HttpException) {
                    logger.debug("Usage Upload server error: {}, code = {}", error.message(), error.code())
                } else {
                    logger.debug("Usage Upload error: {}", error.message)
                }

                val errorMessage = application.getString(R.string.usage_upload_failed)
                logger.error(errorMessage, error)
            }

            override fun onProgress(i: Int) {
                logger.debug("Usage upload progress: $i")
            }
        })
        UsageBroker.upload(application, false)
    }
}

This code sets the upload interval for the application’s UsageBroker object and then requests an upload of usage. If the amount of days between uploading is sufficient, it will upload the data and, if not, it will delay the upload. If the Upload Report After interval is 0 it will not upload any usage.

There may be an error on HttpException. Select it and press Alt+Enter on Windows, or, press option+Enter on Macs, to import the related class from com.sap.cloud.mobile.foundation.networking.

In Android Studio, on Windows, press Ctrl+N, or on a Mac, press command+O, and type SettingsViewModel to open SettingsViewModel.kt.

On Windows, press Ctrl+F, or on a Mac, press command+F, to find:

Kotlin
usageService.uploadUsageData(forceUpload = true, owner = lifecycleOwner,

When forceUpload is set to true, the user can upload the usage report through the app’s settings screen, regardless of the number of days specified in the policy.
When the app is run and the number of days in the policy has passed, there should be a Toast notification showing that the usage report has been uploaded successfully.
To test this feature, in Settings > System > Date & time from the emulator, toggle Set time automatically to off.
Change the Date to a day in the future and re-run the app (quit first). The usage report should be uploaded automatically.
Usage Report Successfully Uploaded Toast Message

See Client Usage and Step by Step with the SAP BTP SDK for Android — Part 8 — Client Usage for further information on usage.

Congratulations! You have learned how the usage feature can provide insights into how a deployed application is being used!

Resources

Next Steps

TUTORIAL Add New Languages to Your Android Application ⏱ 20 min. +

Discussion

Share feedback on this tutorial or join the conversation in SAP Community.

Submit detailed feedback

Discuss in Community

Steps

1. Manual upload of usage data

2. Examine uploaded usage data

3. Add further usage instrumentation

4. Auto-upload of usage data

Use Usage Reporting in Your Android Application

Overview

You will learn

Prerequisites

Prerequisites

Steps

Resources

Next Steps

Related Tutorials

Discussion

Joule

AI Notice