plgJPiwik - Administration Guide

  1. The Idea
  2. Installation Instructions
  3. Basic Configuration
  4. Tracking with Custom Variables
  5. Page Title Customization
  6. Advanded Settings for subdomains cookies

 

The plgJPiwik is a Joomla! Plugin producing Piwik tracking code for every pages of your Joomla! Website.

This plugin not just track the address of your pages, but it takes advantage of Piwik potentialities to register addictional info about every click of your users.
With plgLTPA for example you can track the Actvive Menu of the page and the Active Component loaded. Moreover you can track the Logged User visiting your wibsites or the Title of the Joomla! article he is visiting.

And it is absolutely simple to install and configure: you just need to know your Piwik Installation URL and your ID Site ... no piwik tracking code is required !!!

Intended audience

The intended audience of this document are Joomla! administrators who wants to track visits to their websites using Piwik Analytics Software.

The idea

Piwik is a powerful Open Source Web Analitycs Software providing complete data about visits to your websites. Piwik tracks requests thanks a tiny tracking script you have to add to every pages. plgJPiwik automatically adds this tracking script ... you just need to provide your Piwik installation URL and your ID site.

Piwik tracks a lot of info related to the page visited, the referrer and about the browser and the operating system of the guests, but of course nothing about Joomla! related info of your pages. For example you should be interested in what is the most read Joomla! article? Or what is the most used menù item or the most used component? And what about the logged users visited today your websites? plgJPiwik takes advantage of all Piwik Tracking code potentialities to track these and other information related to your Joomla! website visits.

Moreover you can personalize tracking behaviour in case your website is a subdomain or if you do not want track as outlink visits to specific websites. 

So the idea of plgJPiwik is not just to provide 'standard' info about your guest visitors, but to fully exploit Piwik tracking potentialities in order to provide a really integration with Joomla! using Piwik powerful features as Custom Variables and Page Title Customization.

Installation Instructions

The plgJPiwik is really simple to install. Just download it plgJPiwik page and install it using Joomla! Extensions Manager. After installation plgJPiwik is disabled and you must enable and configure it in order to begin tracking your website visits. Here is the plugin just installed:

 

plgJPiwik install

Basic Configuration

Beginning to track your site visits is really simple with plgJPiwik. Just provide you Piwik installation URL (HTTP and/or HTTPS) and your ID Site and enable the plgJPiwik plugin as in the next figure

plgJPiwik basic conf

In the example we installed Piwik in http://www.example.org/piwik and we assigned to our first website the ID site number 1. For more detail about Piwik ID site and installation URL yor can refer to Piwik User Guide.

Tracking with Custom Variables

Custom Variables are a powerful instrument provided by Piwik in order to add personalized info about tracked visit. plgJPiwik use this feature to track info related to Logged User, Joomla! Active Component and Joomla! Active Menu. So the site administrator have statistics about the user logged in Joomla!, what components are most used and what is the most used item menù. The next figure show options related to the use of Custom Variables with plgJPiwik

plgJPiwik custom variables


Active Menu, Active Component and Logged User tracking are enabled by default, but you disable them when you need. The tracked info can be visualized in Piwik under the menù Visitors -> Custom Variables as showed here

plgJPiwik pw custom variables

In this example only the admin user has been logged and the other visits are executed by not logged users. The component used are Joomla! Content and Kunena and the item menù used are Home and Forum.

Page Title Customization

Another powerful Piwik feature is the Page Title Customization that gives the possibility to set a page title of every tracked page with just tracking purpose. plgJPiwik tries to guess a meaningful page title from every pages and first of all it loads the Joomla! article title and set it (included the category path if you want) as the page title. It the page do not display any Joomla! article you can choose if you want to set as page title the Joomla! site name or the document.title with Javascript.

Also in this case the configuration is absolutely simple as showed here

plgJPiwik page title

and here is the result in Piwik, with the Joomla! article title "plgJPiwik" and "plgJPiwik - Administration Guide" tracked under the "plgjpiwik" Joomla! category.

plgJPiwik pw page title

Advanced Settings for subdomains cookies

In case your site is in a subdomain, for example host1.example.com, and you do not want track link to *.example.com as outlinks or you want to consider the same visit if one user wondering in *.example.com, you can consider to configure the advanced settings of plgJPiwik. For instance you could set plgJPiwik to set the Piwik cookies not in host1.example.com but in *.example.com with the option "Set domain cookie", or you can set a list of sites or domain to not consider for outlinks statistics or moreover you can choose to not consider outlinks and download at all with the options "Ignore outlinks for" and "Download and outlink tracking". For more detail consider to read Piwik JavaScript Tracking Documentation.

Wednesday the 17th. Joomla 2.5 templates.