Developer

Usage Plugin

(Android, iOS, Windows 8.1 and Windows 10) Collects information about how mobile end users interact with your mobile apps, details of the operating systems, and device platforms on which the apps are running.

How applications are being used is an important factor for making informed business decisions. For example, you can process usage data to calculate operation time, features or APIs invoked, and operation results, and use the data for preparing analytics.

User Consent

Beginning in SAP Mobile Platform SDK 3.0 SP14, in order for the usage plugin to initialize and collect information from the SAP Fiori Client, data collection must be enabled by the server administrator and the user must agree to the Terms and Conditions to consent to data collection.
  • The server administrator must enable data collection on the server in the Mobile Service for Development and Operations cockpit. For more information, see Defining Usage Report Policies.

  • In the SAP Fiori Client, the user must review the Terms and Conditions and consent to data collection. If the administrator has enabled data collection, the user will see an 'opt-in' screen when the SAP Fiori Client is configured. Once configured, the user can change their data collection settings at any time in the SAP Fiori Client application settings.

    For more information, see SAP Fiori Client User Guide.

When developing a kapsel application, the usage plugin will initialize after a successful application registration. If the administrator has enabled data collection, the user will see an 'opt-in' screen and can consent to data collection. Once configured, in order for the user to change their data collection settings, the kapsel application must call back the consent dialog. To call the consent dialog, usesap.Usage.showConsentDialog(consentCallback).

For example:

<button id="showConsent" onclick="sap.Usage.showConsentDialog(consentCallback)">Show Consent Dialog</button>