E-Compass Piwik Plugin

From E-COMPASS_Info_Guide
Revision as of 16:32, 14 January 2016 by Tobias (talk | contribs) (Installation of the Plugin)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The E-Compass Piwik Plugin needs at least Piwik 2.15 and PHP 5.5 to run properly.

Piwik Web Server Software Requirements

Required Software for running Piwik with the E-Compass Piwik Plugin
Software License Download
Apache HTTP Server 2.4 Open Source / Apache License 2.0 httpd.apache.org
PHP 5.5 Open Source / PHP License 3.01 php.net/downloads.php
MySQL Community Server 5.6 Open Source / GPL 2.0 dev.mysql.com/downloads/mysql

Installation of the Plugin

prerequisites: all Plugin files need to be compressed into one .zip-file. (e.g. ECompass_v1_0_0.zip)

  1. Log in to your Piwik. Use an account with administration rights.
  2. Go to Administration > Plugins.
  3. Click on "Install new plugins" (above the table).
  4. Click on "upload a plugin" in .zip format.
  5. Choose your E-Compass Plugin zip-file and upload it.
  6. Go to Settings > Plugin Settings to configure the plugin.

Configuration of the Plugin

Configuration is done in Piwik.

  1. Log in to your Piwik. Use an account with administration rights.
  2. Go to Settings > Plugin Settings to configure the plugin.
Settings of the E-Compass Piwik Plugin
Setting Description
URL of the CEP-Engine URL of the receive service of the Notification & Action Engine (ReST endpoint). To this URL the click data collected by Piwik is sent. E.g. https://e-compass.iao.fraunhofer.de/processengine/receiveClickEvent.do
File name of the ssl/https certificate If you want to use SSL for the connection to the CEP-Engine, you need to upload the certificate in the folder of the E-Compass Piwik Plugin (e.g. /webroot/piwik/plugins/ECompass/). The file name of the certificate has to provided here (e.g. e-compass.iao.fraunhofer.de_with_chain.crt).

Plugin Logs

The plugin generates a log file called ECompass.log inside the piwik root folder (e.g. /webroot/piwik/ECompass.log).

Limitations of the service / Service scaling

The maximum scaling is achived by providing one piwik web server per E-Shop. Usually one piwik web server will serve serveral E-Shops.