Developer

Supported infoType Properties

The info parameter of both the log and timeEnd APIs takes an infoType object that exposes 12 supported infoType properties. You can use the properties to add context and additional detail to a particular record.

When the usage data is exported as a .csv file, the values supplied to these properties are output in the record’s row.

The supported property names are:
  • Action
  • Behavior
  • Case
  • Category
  • Element
  • Measurement
  • Result
  • Screen
  • Type
  • Unit
  • Value
  • View
These infoType properties are designed to cover a broad set of typical use cases. Although not enforced, SAP recommends to use these properties according to their use case:

Use Case

Relevant Properties

Identifying user interface (UI) elements

  • Element
  • Screen
  • View

Describing user actions

  • Action
  • Behavior

Recording metrics or KPIs

  • Measurement
  • Result
  • Unit
  • Value

Generic filters

  • Case
  • Category
  • Type

Example Usage

Consider an application where end users can navigate to a Help Menu. You can track which active screen a user left to reach the Help Menu to identify screens that contain errors or that exhibit unexpected behvior. Also, you can record the ways in which a user accesses the Help Menu. For example, when a user navigates to the home icon on the navigation bar or uses the double-tap gesture for the touch screen feature. You can add this additional context information to helpMenuEvent by adding two dimension details to the Screen and Behavior properties:
var info = new sap.Usage.InfoType();
info.setScreen("CustomerDetailScreen”);
info.setBehavior(“TapGesture”);
sap.Usage.log(“helpMenuEvent”, info, “myHelpMenuPlugin”);

The above API call results in the following additional data being inserted in a row:
| Column name |         Value          |
| ----------- | ---------------------- |
| SCREEN      | “CustomerDetailScreen” |
| BEHAVIOR    | “TapGesture”           |