Custom Properties

Apart from the pre-set values that Usage Intelligence collects, such as OS version, product version, edition, language, and license type, you also have the ability to collect any custom value that is relevant to your specific application.

Typical examples where you can benefit from custom properties include storing the download source or marketing campaign from where the user downloaded your software or some other status in your application. These custom properties will then be available inside the filters panel on every report so you may use them as part of your report filtering criteria.

Custom properties are intended to store values that are not very dynamic for a particular installation since the reporting granularity provided by Usage Intelligence is on a daily basis. This means if you use this API to register multiple values inside the same custom property (for the same user), Usage Intelligence will only store the latest known property value for that user on that particular day.

The setCustomProperty() function sets the value of a custom property. For more information, see Setting Custom Property Data.