AppSuite:Metrics-Adapters: Difference between revisions

From Open-Xchange
(Created page with "== Adapters == === PIWIK === **source** //io.ox/metrics/adapters/default.js// **hint** Be aware to not use a name for your javascript files that matching common patterns...")
 
No edit summary
 
(23 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Version|7.8.0}}
== Adapters ==
== Adapters ==


=== PIWIK ===
The content on this page has moved to https://documentation.open-xchange.com/latest/ui/features/metrics/02-adapters.html.
 
**source**
 
//io.ox/metrics/adapters/default.js//
 
**hint**
 
Be aware to not use a name for your javascript files that matching common patterns of adblockers. For example in case we would name default.js PIWIK.js the adblocker would block the request and an error ocurred in the the browser.
 
**consider settings**
 
please add at first a line into the code that checks for the user setting to prevent registering the adapter (more precisecly to extend the extension point)
 
<code javascript>
if (!settings.get('tracking/[add-your-id-here]/enabled', false)) return;
</code>
 
**extend**
 
Now you will have to extend ‘io.ox/metrics/adapter’ to register your adapter. The metrics module will run through all registered adapters and calls existing functions.
 
<code javascript>
ext.point('io.ox/metrics/adapter').extend({
        id: 'piwik',
        setup: function () {
          // called once
        },
        trackVisit: function () {
          // called for each tracked visit (usually called once)
        },
        trackEvent: function (baton) {
          // called for each tracked event
        },
        trackPage: function (baton) {
          // called for each opened application/module
        },
        trackVariable: function (baton) {
          // usually called once
        }
    });
</code>
For further questions please take a look at the PIWIK adapter in the source code.
 
=== Console ===
 
You can activate a special debugging adapter that writes events to console and tracks all events in browers localstorage. To activate/deactivate simply paste this code into your console when you are logged in at appsuite:
 
<code javascript>
// enable
require('settings!io.ox/core').set('tracking/console/enabled', true).save();
// disable
require('settings!io.ox/core').set('tracking/console/enabled', false).save();
</code>
You can see all tracked events by using the browers console again:


<code javascript>
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.
//directly accessing to the data
metrics.hash
// please use the following only in chrome cause it is using console.table
metrics.show()
</code>


[[Category:AppSuite]]
[[Category:AppSuite]]
[[Category:UI]]
[[Category:UI]]
[[Category:Metrics]]
[[Category:Metrics]]

Latest revision as of 10:21, 12 July 2016

This information is valid from 7.8.0

Adapters

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

Retrieved from "https://wiki.open-xchange.com/wiki/index.php?title=AppSuite:Metrics-Adapters&oldid=22170"