AppSuite:Metrics: Difference between revisions

From Open-Xchange
No edit summary
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
== Metrics ==
== Metrics ==


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


The Metrics module provides a very flexible and extendible way to track user behaviour and conditions within OX Appsuite.
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.
 
A common set of events is tracked by default. Out of the box PIWIK is supported as reference analytics framework. Every other analytics framework can be added easily by registering a new adapter within the metrics module where data and events are mapped to the special needs of the target analytics framework.
 
=== Setup/Installation ===
Please follow [[AppSuite:Metrics-Analytics-Solutions#Install_PIWIK | these steps ]] to install PIWIK first.
 
=== Basics ===
 
The metrics framework is located in Appsuite’s front end and can be [[#backend|configured]] by backend properties. The components and their tasks are listed as follows:
  * listener/handler: waiting for events and call metrics module
  * metrics module: provides a central API for tracking and propagate events to enabled adapters
  * adapter: maps generic event data for a concrete analytics framework and calls their API
 
 
==== Frontend ====
 
The parts a separated by their role/task with high flexibility and extendability in mind.
 
===== Components =====
 
  - metrics listener: waiting for a event (example: click on an ‘mail reply’)
  - metrics handler: submits data to the metrics module
  - metrics module: central facade with a generic API as connecting piece between event handlers and adapters
  - metrics adapter: communicates with a concrete analytics framework API
 
===== Source code =====
 
<code>
  // core module
  io.ox/metrics/main.js
 
  // adapter for each target analytics framework
  io.ox/metrics/adapters
 
  // adapter for PIWIK
  io.ox/metrics/adapters/default.js
 
  // global listeners/handlers
  io.ox/metrics/extensions.js
</code>
 
==== Backend: properties ====
 
Use the following setting properties to enhance/adjust usage. Please be aware of the double slashes that are used as separator for the namespaces.
 
===== Global =====
 
<code>
  // global switch [true/false]
  // current default: true
  io.ox/core//tracking/enabled
</code>
 
<code>
  // consider doNotTrack-flag in front end [true/false]
  // current default: false
  io.ox/core//tracking/donottrack
</code>
 
===== Adapterspecific =====
 
For more details visit the [[AppSuite:Metrics-Adapters | adapter article]].
<code>
  // ADAPTER BLOCK PIWIK: START
  // adapter switch (PIWIK) [true/false]
  // current default: true
  io.ox/core//tracking/piwik/enabled
 
  // platform base url [url]
  // current default: https://[insert-your-host-here]/piwik/
  io.ox/core//tracking/piwik/url
 
  // platform page id [url]
  // current default: 1
  io.ox/core//tracking/piwik/id
 
  // ADAPTER BLOCK PIWIK: END
 
</code>


=== Further reading ===
=== Further reading ===


* [[AppSuite:Metrics-Details |  Details ]]: the metrics framework components in detail
* [https://documentation.open-xchange.com/latest/ui/features/metrics/01-details.html Details]: the metrics framework components in detail
* [[AppSuite:Metrics-Adapters | Adapters ]]: connections between Appsuite metrics and the Analytics solutions
* [https://documentation.open-xchange.com/latest/ui/features/metrics/02-adapters.html Adapters]: connections between OX App Suite metrics and the Analytics solutions
* [[AppSuite:Metrics-Analytics-Solutions | Analytics Solutions]]: details and how to setup
* [https://documentation.open-xchange.com/latest/ui/features/metrics/03-analytics-solutions.html Analytics Solutions]: details and how to setup
* [[AppSuite:Metrics-Events | Events ]]: list of tracked events so far
* [https://documentation.open-xchange.com/latest/ui/features/metrics/09-events.html Events]: list of tracked events so far




Latest revision as of 10:20, 12 July 2016

This information is valid from 7.8.0

Metrics

The content on this page has moved to https://documentation.open-xchange.com/latest/ui/features/metrics.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.

Further reading

  • Details: the metrics framework components in detail
  • Adapters: connections between OX App Suite metrics and the Analytics solutions
  • Analytics Solutions: details and how to setup
  • Events: list of tracked events so far
Retrieved from "https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Metrics&oldid=22168"