How to add a tracker in your XWiki using JavaSriptExtension object?
How to add a tracker tool to your XWiki using JavaScript extension
Some examples of trackers that can be added in XWiki
Google Analytics . The extension is included by default with the XWiki platform which provides a dedicated section in the wiki preferences page for activating the Google Analytics tracking. You can find more about the extension here.
All you need to do is to go to Administration > Other > Google Analytics and add you google account.
Matomo. It can be installed both on-premise or cloud.
The installation guide for the on-premise Matomo server is available on their dedicated website: https://matomo.org/docs/installation/.
The next step, on the XWiki side, is to install the Matomo extension from the wiki Administration section with Extension Manager.If you choose to use Matomo cloud services you can integrate in XWiki using JavaScript extension object.
- Google Tag Manager The tracker can be added in XWIki by using JavaScript extension object .
- Albacross . The tracker can be added in XWIki by using JavaScript extension object .
Creating a JavaScript extension
To learn more about how to add a JavaScriptExtension Object, check out the official documentation.
Where should they be injected?
- Trackers like Matomo Cloud (Install the JavaScript Tracking Tag) or Google Tag Manager (Quick Start Guide) need to be in added immediately before your closing </head> tag.
- Others like Albacross (How to install Albacross tracking code ) need to be in added immediately before your closing </body> tag of all pages of your website.
Add JavaScript extension object:
We'll use the example of the Albacross tool to give an example for how to integrate it in XWiki.
Example with the Albacross tool
- Create a page, e.g. MyCode.AlbacrossTracker.
- And edit the page with the Object editor. The page itself can be any XWiki page - an existing page or a new page.
- From the "New Object" drop-down list of the object editor choose XWiki.JavaScriptExtension. Then, click the "Add" button. We will name it "Albacross Tracker", give it a default cache policy, ask it to parse the content, and write the following code:document.observe('xwiki:dom:loaded', function() {
var script = document.createElement('script');
script.type = 'text/javascript';
script.innerHTML = "(function(a,l,b,c,r,s){_nQc=c,r=a.createElement(l),s=a.getElementsByTagName(l)[0];r.async=1;r.src=l.src=('https:'==a.location.protocol?'https://':'http://')+b;s.parentNode.insertBefore(r,s);}) (document,'script','serve.albacross.com/track.js','__REPLACE_THIS_WITH_YOUR_CLIENT_ID__')";
document.body.appendChild(script);
});Replace this placeholder __REPLACE_THIS_WITH_YOUR_CLIENT_ID__ with your unique Client ID.
You can ask to have it used "Always on this wiki". For this to happen however, you need to save the extension document with programming rights. - Just click "Save and View" .
Example with Google Tag Manager tracker
An other example how to integrated Google Tag Manager.
You need to create a JavaScriptExtension Object as explained above. Because it needs to be injected immediately before your closing </head> tag, the code will be the following:
// Add Global site tag (gtag.js) - Google Analytics
var script = document.createElement('script');
script.type='text/javascript';
script.src='https://www.googletagmanager.com/gtag/js?id=UA-REPLACE_THIS_WITH_YOUR_CLIENT_ID-Y';
script.async = true;
document.head.appendChild(script);
window.dataLayer = window.dataLayer || [];
function gtag() {
dataLayer.push(arguments);
}
gtag('js', new Date());
gtag('config', 'UA-REPLACE_THIS_WITH_YOUR_CLIENT_ID-Y');
});
Replace this placeholder REPLACE_THIS_WITH_YOUR_CLIENT_ID with your unique Client ID.
- Just click "Save and View" .
