wiki:analytics

Analytics Information

As of 2.1 (build 26) LogicMail now contains support for the  BlackBerry Analytics service. Since the open-source world is often weary of any application that tracks user activity, this page will attempt to document everything LogicMail is actually tracking through this service.

Library integration

  • Website:  BlackBerry Analytics
  • Library version: v0.9.3 Beta
  • Opt-out capability: There is a checkbox on both the accept-license screen and the global configuration screen

Collected data

All the collected data is fully anonymized. While the service does generate unique IDs for each device, there is no way to track these IDs back to user identities. Furthermore, any data actually collected will be listed here. If there is any doubt, the code is available for all to see. In any case where the specific analytics call could be tracking identifiable information, generic parameters are used instead. (For example, actual filenames are never used with media events.)

Prefix Collection method
AS  onApplicationStart()
AT  onApplicationTerminate()
AF  onApplicationForeground()
AB  onApplicationBackground()
AE  onApplicationError()
BC  onButtonClick()
SV onScreenView()
ME  onMediaEvent()
CE  onCustomEvent()

Application-level

  • AS: Startup
  • AT: Shutdown
  • AF: Foreground (UiApplication.activate())
  • AB: Background (UiApplication.deactivate())
  • AE: Any exceptions logged at the ERROR level. (Just the generic exception messages, not any user data that may be logged to the device's EventLogger.)

Screens

Note: If a screen uses a click or hotkey to perform the same action as a menu item, that click or hotkey is also tracked

Standard

  • All
    • SV: Screen name and basic properties (e.g. account type, composition type) when pushed onto the display stack
    • BC: App-wide menu items: config, about, close, exit
  • MailHomeScreen
    • BC: selectFolder - Default action on most items
    • BC: sendUnsent - Sends unsent items if the Outbox is highlighted
    • BC: refreshStatus - Account-level "Refresh status"
    • BC: refreshFolders - Account-level "Refresh folders"
    • BC: composition - "Compose E-Mail"
    • BC: disconnect
  • MailboxScreen
    • CV: onDisplay - tracks folder type (e.g. INBOX, Sent, etc.) and account type (e.g. Local, IMAP, POP)
    • BC: composition - "Compose E-Mail"
    • BC: requestMoreMessages - "Load more messages..." item
    • See MessageActions
  • MessageScreen
    • ME: displayableContent - Tracks MIME type of displayed message content
    • ME: attachmentField - Tracks MIME type of message attachments
    • ME: attachmentDownload - Tracks MIME type of downloaded attachments
    • BC: composition - "Compose E-Mail"
    • BC: saveAttachment - Saves the selected message attachment
    • See MessageActions
  • CompositionScreen
    • See MessageActions
  • MessageActions - Common message actions provided on different screens depending on context/applicability
    • BC: openMessage - Opens the selected message, typically a default MailboxScreen action
    • BC: openMessageProperties - Opens the message Properties dialog
    • BC: deleteMessage - Marks the message as deleted
    • BC: undeleteMessage - Removes the deleted flag from a message
    • BC: replyMessage - Opens the composition screen to reply to the current message
    • BC: replyAllMessage - Opens the composition screen to reply to all recipients of the current message
    • BC: forwardMessage - Opens the composition screen to forward the current message
    • BC: copyToMailbox - Opens the dialog for copying the message to another folder
    • BC: moveToMailbox - Opens the dialog for moving the message to another folder
    • BC: sendMessage - Sends the message currently being composed

Configuration

  • All
    • SV: Screen name and basic properties (e.g. account/config type) when pushed onto the display stack

Wizard

Dialogs