Use Usage Reporting in Your Android Application

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

UsageService usageService = SDKInitializer.INSTANCE.getService(JvmClassMappingKt.getKotlinClass(UsageService.class));
if (usageService != null) {
    usageService.eventBehaviorViewDisplayed(EntitySetListActivity.class.getSimpleName(),
            "elementId", "onCreate", "called");
}

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

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

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

2. On Windows, press Ctrl+F12, or, on a Mac, press command+F12, and type onCreate, to move to the onCreate method in the same file.

3. Find the following line:

   super.onCreate(savedInstanceState);
   

4. Then add the following code segment immediately after:

   UsageService.getInstance().eventBehaviorUserInteraction(ProductsCreateFragment.class.getSimpleName(), "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.

5. On Windows, press Ctrl+F12, or, on a Mac, press command+F12, and type onOptionsItemSelected to move to the onOptionsItemSelected method. Add the following code segment before the default: case in the same file:

   case android.R.id.home:
     UsageService.getInstance().eventBehaviorUserInteraction(ProductsCreateFragment.class.getSimpleName(), "elementId", "onBackPressed", "Create or Edit Product Cancelled");
     return super.onOptionsItemSelected(item);
   

   This generates the usage event record whenever the user navigates away from an editing screen without saving.

6. Build and run the app.

7. Generate usage information by accessing Products.

   

8. Tap the floating Add button to create a product.

   

9. Press the Back button to exit the page without saving.

   

10. Repeat these steps two more times to generate multiple entries for the usage report.

11. Select an existing product and tap its Edit button.

    

12. Then immediately tap the check mark button to save the information.

    

13. End the usage session by placing the app in the background. Navigate back into the app.

14. Upload the usage by going to Settings and tap on Upload Usage Data.

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

    

16. In 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:

    =COUNTIF(R:R, "*createOrEditProductClicked*")
    

17. 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:

    =COUNTIF(R:R, "*onBackPressed*")
    

    In the example, the user tried to create a product four times, but cancelled three times.

    

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

2. On Windows, press Ctrl+F12, or, on a Mac, press command+F12 and type onCreate, to move to the onCreate method in the same file.

3. Find the following line:

   super.onCreate(savedInstanceState)
   

4. Add the following code segment immediately after:

   UsageService.getInstance().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.

5. On Windows, press Ctrl+F12, or, on a Mac, press command+F12 and type onOptionsItemSelected, to move to the onOptionsItemSelected method. Add the following code segment before the else case in the same file:

   android.R.id.home -> {
     UsageService.getInstance().eventBehaviorUserInteraction(ProductsCreateFragment::class.java.simpleName, "elementId", "onBackPressed", "Create or Edit Product Cancelled")
     super.onOptionsItemSelected(item)
   }
   

   This generates the usage event record whenever the user navigates away from an editing screen without saving.

6. Build and run the app.

7. Generate usage information by accessing Products.

   

8. Tap the floating Add button to create a product.

   

9. Press the Back button to exit the page without saving.

   

10. Repeat these steps two more times to generate multiple entries for the usage report.

11. Select an existing product and tap its Edit button.

    

12. Then immediately tap the check mark button to save the information.

    

13. End the usage session by placing the app in the background. Navigate back into the app.

14. Upload the usage by going to Settings and tap on Upload Usage Data.

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

    

16. In 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:

    =COUNTIF(R:R, "*createOrEditProductClicked*")
    

17. 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:

    =COUNTIF(R:R, "*onBackPressed*")
    

    In the example, the user tried to create a product four times, but cancelled three times.

    

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

   

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

3. Add the following variables to the top of the WizardFlowStateListener class:

   private static boolean isUsageEnabled;
   private static int uploadInterval;
   

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

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

   if (policies.getUsagePolicy() != null) {
       isUsageEnabled = policies.getUsagePolicy().getDataCollectionEnabled();
       uploadInterval = policies.getUsagePolicy().getUploadDataAfterDays();
       if (isUsageEnabled) {
           UsageBroker.setDataCollectionEnabled(true);
           uploadUsage();
       }
   }
   

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

6. Add the following method in the file:

   private void 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(new AppUsageUploader.UploadListener() {
               @Override
               public void onSuccess() {
                   Toast.makeText(application,
                           application.getString(R.string.usage_upload_ok),
                           Toast.LENGTH_LONG).show();
               }
   
               @Override
               public void onError(@NotNull Throwable error) {
                   // make sure to import com.sap.cloud.mobile.foundation.networking.HttpException;
                   if (error instanceof HttpException) {
                       logger.debug("Usage Upload server error: {}, code = {}",
                               ((HttpException) error).message(), ((HttpException) error).code());
                   } else {
                       logger.debug("Usage Upload error: {}", error.getMessage());
                   }
                   String errorMessage = application.getString(R.string.usage_upload_failed);
                   logger.error(errorMessage, error);
               }
   
               @Override
               public void onProgress(int i) {
                   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.

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

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

   UsageBroker.upload(getContext(), false);
   

9. Change false to true.

   This will allow the user to upload the usage report via 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.

10. To test this feature, in Settings > System > Date & time from the emulator, toggle Use network-provided time to off.

11. Change the Date to a day in the future and re-run the app (quit first). The usage report should be uploaded automatically.

    

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

   

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

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

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

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

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

   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.

6. Add the following method in the file:

   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.

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

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

   UsageBroker.upload(requireContext(), false)
   

9. Change false to true.

   This will allow the user to upload the usage report via 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.

10. To test this feature, in Settings > System > Date & time from the emulator, toggle Use network-provided time to off.

11. Change the Date to a day in the future and re-run the app (quit first). The usage report should be uploaded automatically.