Difference between revisions of "AppSuite:Metrics-Events"

 
(One intermediate revision by one other user not shown)
Line 3: Line 3:
 
== Metrics - Events ==
 
== Metrics - Events ==
  
A list of all tracked events identified with their composite id (app, ui element, action, detail). Please notice that words within box brackets are used as placeholders.  
+
The content on this page has moved to https://documentation.open-xchange.com/latest/ui/features/metrics/09-events.html.
  
For more information please visit he other metrics articles [[Category:Metrics]].
+
Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition.
 
 
=== General ===
 
 
 
''Placeholders''
 
 
 
  [action] the data-action property of the action node
 
 
 
==== Header/Logo ====
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| core/banner/title
 
| Click on header title
 
|-
 
| core/banner/logo
 
| Click on header logo
 
|}
 
 
 
==== File Viewer ====
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| core/viewer/toolbar/[action]
 
| User clicks on action while using the file viewer
 
|}
 
 
 
==== Settings ====
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| core/toolbar/[action]
 
| Upsell event triggered
 
|-
 
| settings/folder/select/[type]
 
| Click on a specific folder/part in the setting
 
|}
 
 
 
==== Help ====
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| core/toolbar/help/[type]
 
| Help action was clicked
 
|}
 
 
 
==== Guided Tours ====
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| core/toolbar/guided-tour/[type]
 
| Click on 'Start guided tour for this app'
 
|}
 
 
 
==== Loadtime ====
 
 
 
A event triggers when an app started. The measure time is between the click on the app launcher and the moment the app was loaded (via ox.launch) 
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| core/loadtime/[appname]/[time]
 
| Click on app launcher
 
|}
 
 
 
 
 
==== Client Onboarding ====
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| core/client-onboarding/platform/select
 
| Click on platform within wizard dialog (1. Step)
 
|-
 
| core/client-onboarding/device/select
 
| Click on device within wizard dialog (2. Step)
 
|-
 
| core/client-onboarding/scenario/select
 
| Click on scenario within wizard dialog (3. Step)
 
|-
 
| core/client-onboarding/action/select
 
| Click on action within wizard dialog (3. Step)
 
|-
 
| core/client-onboarding/action/execut
 
| Click on action button (3. Step)
 
|-
 
| core/client-onboarding/mode/toggle
 
| Toggle normal and expert mode
 
|}
 
 
 
==== Upsell ====
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| core/upsell/[upsell.type]/[upsell.id]
 
| Clicks (settings, my contact data, help, getting started, fullscreen, about, sign out) within the context menu of our settings icon at the top right.
 
|}
 
 
 
=== Apps ===
 
 
 
==== Portal ====
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| portal/toolbar/add/[type] 
 
| Click on “Add widget” button in upper right area of portal.
 
|-
 
| portal/toolbar/add/[type]
 
| Click on a specific widget to “install” it on the portal page.
 
|-
 
| portal/widgets/show-detail/[type]
 
| Click on the area of the widget, which gets displayed.
 
|-
 
| portal/widget/disable/[type]
 
| Click on the remove widget icon (“X”)
 
|-
 
| portal/widget/change-order/[type]
 
| Reordering a widget into another location on the screen.
 
|}
 
 
 
==== Mail ====
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| mail/list/[layout]/select/one<br> mail/list/[layout]/select/mulitple   
 
| Select mail by click on the list/grid (layout: vert, horiz, compact, list)
 
|-
 
| mail/toolbar/[action]<br>mail/detail/toolbar/[action]<br> mail/compose/toolbar/[action]
 
| Clicks on a email action
 
|-
 
| mail/folders/folder/select/[type] 
 
| Clicks on a folder in the mail folder tree (type: primary, external)
 
|-
 
| mail/folder/account/add
 
| Clicks on “Add new mail account”
 
|-
 
| mail/settings/account/add
 
| Clicks within “Social + Mail Accounts” on “Add account”
 
|}
 
 
 
==== Contacts ====
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| contacts/list/select/one<br> contacts/list/select/multiple 
 
| Select contact by click on the list/grid
 
|-
 
| contacts/folder/select/[type]
 
| Clicks on a folder in the contact folder tree (folder-type: private, public, shared)
 
|-
 
| contacts/toolbar/[action]
 
|  Clicks on a a contact action 
 
|}
 
 
 
==== Calendar ====
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| calendar/toolbar/[action] 
 
| Clicks on calendar toolbar action
 
|-
 
| calendar/[layout-mode]/select 
 
| Clicks on appointments within non-list layout modes
 
|-
 
| calendar/[layout-mode]/create 
 
| Clicks on blank space within non-list layout modes to create appointment
 
|-
 
| calendar/folder/select/[type]     
 
| Clicks on a folder in the contact folder tree (folder-type: private, public, shared)
 
|-
 
| calendar/folder/permissions
 
| Clicks on the “cloud” icon and the “User” icon next to the folder name     
 
|-
 
| calendar/folder/context-menu/[action]
 
| Clicks within the context menu, which pops up, when you click on a folder name and its menu icon
 
|-
 
| calendar/detail/toolbar/[action]
 
| Clicks on calendar detail view toolbar action       
 
|}
 
 
 
==== Tasks ====
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| tasks/folder/select/[type]
 
| Clicks on a folder in the contact folder tree (folder-type: private, public, shared)
 
|-
 
| tasks/folder/context-menu/[action]
 
| Clicks within the context menu, which pops up, when you click on a folder name and its menu icon
 
|-
 
| tasks/toolbar/[action]
 
| Clicks on tasks toolbar action 
 
|-
 
| tasks/detail/[action]
 
| Clicks on task detail view toolbar action   
 
|}
 
 
 
==== Drive ====
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| drive/folder/select/[type]       
 
| Clicks on a folder in drive folder tree (folder-type: [[HTTP_API#Get_root_folders|standard_folder_type]] + '.' + [[HTTP_API#Get_root_folders|folder_type]])
 
|-
 
| drive/folder/context-menu/[action]
 
| Clicks within the context menu, which pops up, when you click on a folder name and its menu icon
 
|-
 
| drive/toolbar/[action]
 
| Clicks on drive toolbar action   
 
|}
 
 
 
==== Text App (aka Text Portal)====
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| text-portal/toolbar/[action]
 
| Clicks on Text App toolbar action (text-newblank, text-open)
 
|-
 
| text-portal/recentlist/[action]
 
| Clicks on documents in the recent list (text-edit)
 
|-
 
| text-portal/templates/[action]
 
| Clicks on templates (text-newfromtemplate, text-newblank)
 
|}
 
 
 
==== Spreadsheet App (aka Spreadsheet Portal)====
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| spreadsheet-portal/toolbar/[action]
 
| Clicks on Spreadsheet App toolbar action (spreadsheet-newblank, spreadsheet-open)
 
|-
 
| spreadsheet-portal/recentlist/[action]
 
| Clicks on documents in the recent list (spreadsheet-edit)
 
|-
 
| spreadsheet-portal/templates/[action]
 
| Clicks on templates (spreadsheet-newfromtemplate, spreadsheet-newblank)
 
|}
 
 
 
==== Text Editor ====
 
 
 
{| class="wikitable"
 
! style="font-weight: bold;" | EventId
 
! style="font-weight: bold;" | Trigger
 
|-
 
| text-editor/toolbar/[action]
 
| Clicks on Text Editor toolbar nyi
 
|}
 
  
  

Latest revision as of 10:22, 12 July 2016

This information is valid from 7.8.0

Metrics - Events

The content on this page has moved to https://documentation.open-xchange.com/latest/ui/features/metrics/09-events.html.

Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition.