Difference between revisions of "E-Compass Piwik Plugin"
Jump to navigation
Jump to search
(Created page with "{{Hardware | model = | cpu = | ram = | hdd = | network = | hypervisor = | balancing = }} === Service Environment and Set-up === {| class="wikitable" |+ Required Softwar...") |
|||
| Line 1: | Line 1: | ||
| − | + | The E-Compass Piwik Plugin needs at least Piwik 2.15 and PHP 5.5 to run properly. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | + | == Piwik Web Server Software Requirements == |
{| class="wikitable" | {| class="wikitable" | ||
| − | |+ Required Software | + | |+ Required Software for running Piwik with the E-Compass Piwik Plugin |
! Software | ! Software | ||
| + | ! License | ||
! Download | ! Download | ||
|- | |- | ||
| − | | | + | | Apache HTTP Server 2.4 |
| − | | [http:// | + | | Open Source / [http://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0] |
| + | | [https://httpd.apache.org/download.cgi#apache24 httpd.apache.org] | ||
|- | |- | ||
| − | | | + | | PHP 5.5 |
| − | | [http:// | + | | Open Source / [http://www.php.net/license/3_01.txt PHP License 3.01] |
| + | | [https://secure.php.net/downloads.php php.net/downloads.php] | ||
|- | |- | ||
| − | | | + | | MySQL Community Server |
| − | | [http:// | + | | Open Source / [http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GPL 2.0] |
| + | | [http://dev.mysql.com/downloads/mysql/ dev.mysql.com/downloads/mysql] | ||
|} | |} | ||
| − | ==== | + | == Installation of the Plugin == |
| + | prerequisites: all Plugin files need to be compressed into one <code>.zip</code>-file. | ||
| + | # Log in to your Piwik. Use an account with administration rights. | ||
| + | # Go to Administration / Plugins. | ||
| + | # Click on "Install new plugins" (above the table). | ||
| + | # Click on "upload a plugin" in .zip format. | ||
| + | # Choose your E-Compass Plugin zip-file and upload it. | ||
| + | # Go to Settings / Plugin Settings to configure the plugin. | ||
| + | == Configuration of the Plugin == | ||
| + | Configuration is done in Piwik. | ||
| + | # Log in to your Piwik. Use an account with administration rights. | ||
| + | # Go to Settings / Plugin Settings to configure the plugin. | ||
| − | = | + | {| class="wikitable" |
| − | + | |+ 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. <code>https://e-compass.iao.fraunhofer.de/processengine/receiveClickEvent.do</code> | |
| − | + | |- | |
| − | + | | 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. <code>/webroot/piwik/plugins/ECompass/</code>). The file name of the certificate has to provided here (e.g. <code>e-compass.iao.fraunhofer.de_with_chain.crt</code>). | |
| − | + | |} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | + | == Plugin Logs == |
| − | + | The plugin generates a log file called <code>ECompass.log</code> inside the piwik root folder (e.g. <code>/webroot/piwik/ECompass.log</code>). | |
| − | === Limitations of the service === | + | === 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. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 19:02, 12 January 2016
The E-Compass Piwik Plugin needs at least Piwik 2.15 and PHP 5.5 to run properly.
Contents
Piwik Web Server Software Requirements
| 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 | 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.
- Log in to your Piwik. Use an account with administration rights.
- Go to Administration / Plugins.
- Click on "Install new plugins" (above the table).
- Click on "upload a plugin" in .zip format.
- Choose your E-Compass Plugin zip-file and upload it.
- Go to Settings / Plugin Settings to configure the plugin.
Configuration of the Plugin
Configuration is done in Piwik.
- Log in to your Piwik. Use an account with administration rights.
- Go to Settings / Plugin Settings to configure the 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.
