The W20 Extras addon provides various functionality such as website analytics.

Installation

bower install w20-extras

Configuration

To include the addon, declare it in the application manifest:

"bower_components/w20-extras/w20-extra.w20.json": {}

If you are using the w20-bridge addon, be sure to include the w20-extras module:

<dependency>
    <groupId>org.seedstack.addons.w20</groupId>
    <artifactId>w20-bridge-web-extras</artifactId>
</dependency>

Analytics

Analytical tools allow statistical reporting and data analysis for your web applications:

  • Counting and tracking visitor’s actions
  • Statistics on page viewed
  • Keyword searched
  • E-commerce specific report
  • Setting cookies for tracking visit
  • Displaying comprehensive and detailed reports

Analytics providers generally requires a script inclusion in all web pages to track user actions based on the URL. However, in SPA, since the routing is done at the front end, this integration is a bit more tricky. W20 uses Angulartics internally to provide an easy integration of a wide range of providers.

Fragment configuration

Include the extra fragment configuration in your fragment manifest and enable its analytics module. To configure you analytics provide, use the following properties:

  • provider (string): The name of the analytic provider to use. Supported providers are given below:
Class Description
'adobe' Adobe analytics
'chartbeat' Chartbeat analytics
'flurry' Flurry analytics
'ga' Google Analytics
'ga-cordova' Google Analytics for Cordova
'gtm' Google Tag Manager
'kissmetrics' Kissmetrics
'mixpanel' Mix Panel analytics
'piwik' Piwik analytics
'segmentio' Segment.io analytics
'splunk' Splunk
'woopra' Woopra
  • virtualPageViews (boolean): By default automatic virtual page view tracking is enabled, meaning the entire user navigation across the different routes of your application is tracked. You can turn it off with this property.

  • settings (object): If the chosen provider has a supported default configuration in W20, you can use this property to configure it.

Piwik

After deploying your Piwik server, you are provided with a site id for your registered website. Set it to the siteId property and paste the URL to the javascript tracker (piwik.js) into the jsUrl property and your Piwik PHP server address into the trackerUrl property.

    "path/to/extra/w20-extra.w20.json": {
        "modules": {
            "analytics": {
                "provider": "piwik",
                "virtualPageViews": true,
                "settings": {
                    "jsUrl": "url/or/path/to/piwik/javascript/tracker",
                    "trackerUrl": "url/to/piwik/javascript/tracker",
                    "siteId": 1
                }
            }
        }
    }

Your website visits should be monitored by Piwik. The trackPageView and enableLinkTracking options of Piwik are already applied. An angular service PiwikService can now be injected to configure Piwik. This service provide the following methods:

  • getAPI(): return the Piwik object
  • configure(settings): Called initially to configure the provider with the settings property configured in the manifest. It can be called programatically to change these settings later.