E-Compass Piwik Plugin - Revision history

Tobias: /* Installation of the Plugin */

2016-01-14T14:32:41Z

‎Installation of the Plugin

Tobias at 17:11, 12 January 2016

2016-01-12T17:11:14Z

Tobias: /* Installation of the Plugin */

2016-01-12T17:10:23Z

‎Installation of the Plugin

Tobias: /* Piwik Web Server Software Requirements */

2016-01-12T17:06:13Z

‎Piwik Web Server Software Requirements

Tobias: /* Configuration of the Plugin */

2016-01-12T17:05:16Z

‎Configuration of the Plugin

Tobias: /* Installation of the Plugin */

2016-01-12T17:04:50Z

‎Installation of the Plugin

Tobias: /* Limitations of the service / Service scaling */

2016-01-12T17:03:15Z

‎Limitations of the service / Service scaling

Tobias at 17:02, 12 January 2016

2016-01-12T17:02:44Z

Tobias: Created page with "{{Hardware | model = | cpu = | ram = | hdd = | network = | hypervisor = | balancing = }} === Service Environment and Set-up === {| class="wikitable" |+ Required Softwar..."

2016-01-12T16:00:41Z

Created page with "{{Hardware | model = | cpu = | ram = | hdd = | network = | hypervisor = | balancing = }} === Service Environment and Set-up === {| class="wikitable" |+ Required Softwar..."

New page

{{Hardware | model =
| cpu =
| ram =
| hdd =
| network =
| hypervisor =
| balancing =
}}

=== Service Environment and Set-up ===
{| class="wikitable"
|+ Required Software
! Software
! Download
|-
| Software-Name
| [http://url Software-Link]
|-
| Software-Name
| [http://url Software-Link]
|-
| Software-Name
| [http://url Software-Link]
|}

==== Software Licenses ====

==== OS Environment Variables ====
…

==== Installation ====
…

==== Preparation ====
…

=== Service Configuration ===

==== Configuration script ====
{{comment| availability / location}}

==== README / User Manual ====
{{comment| availability / location}}

==== Configuration steps ====
…

Configuration of REST endpoints at:

=== Operation ===
==== Service startup procedure ====
…

==== Restarting the service ====
…

==== Service Logs ====
…

==== Recurring Manual Actions / Maintenance Tasks ====
…

=== Other ===
…

=== Limitations of the service ===
; With which parameters does the service scale?
{{comment|How many concurrent E-Shops, how many concurrent products and how many users/E-Shop customers are possible without causing loss in quality/speed for the hardware described above?}}
: …
; If higher scaling was wanted, which of the hardware parameters would need to be increased?
: …
; What else would be adjusted for higher scalability?
: …
; Which further configuration would be necessary?
: …

@@ Line 22: / Line 22: @@
 == Installation of the Plugin ==
-prerequisites: all Plugin files need to be compressed into one <code>.zip</code>-file. (e.g. [[File:ECompass_v1_0_0.zip]])
+prerequisites: all Plugin files need to be compressed into one <code>.zip</code>-file. (e.g. <code>ECompass_v1_0_0.zip</code>)
 # Log in to your Piwik. Use an account with administration rights.
 # Go to Administration &gt; Plugins.

@@ Line 22: / Line 22: @@
 == Installation of the Plugin ==
-prerequisites: all Plugin files need to be compressed into one <code>.zip</code>-file. (e.g. [[ECompass_v1_0_0.zip]])
+prerequisites: all Plugin files need to be compressed into one <code>.zip</code>-file. (e.g. [[File:ECompass_v1_0_0.zip]])
 # Log in to your Piwik. Use an account with administration rights.
 # Go to Administration &gt; Plugins.

@@ Line 22: / Line 22: @@
 == Installation of the Plugin ==
-prerequisites: all Plugin files need to be compressed into one <code>.zip</code>-file.
+prerequisites: all Plugin files need to be compressed into one <code>.zip</code>-file. (e.g. [[ECompass_v1_0_0.zip]])
 # Log in to your Piwik. Use an account with administration rights.
 # Go to Administration &gt; Plugins.

@@ Line 16: / Line 16: @@
 | [https://secure.php.net/downloads.php php.net/downloads.php]
 |-
-| MySQL Community Server
+| MySQL Community Server 5.6
 | 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]

@@ Line 33: / Line 33: @@
 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.
+# Go to Settings &gt; Plugin Settings to configure the plugin.
 {| class="wikitable"

@@ Line 24: / Line 24: @@
 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.
+# Go to Administration &gt; 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.
+# Go to Settings &gt; Plugin Settings to configure the plugin.
 == Configuration of the Plugin ==

@@ Line 50: / Line 50: @@
 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 / Service scaling ===
+== 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.

@@ Line 1: / Line 1: @@
-{{Hardware | model =
+The E-Compass Piwik Plugin needs at least Piwik 2.15 and PHP 5.5 to run properly.
-=== Service Environment and Set-up ===
+== Piwik Web Server Software Requirements ==
 {| class="wikitable"
-|+ Required Software
+|+ Required Software for running Piwik with the E-Compass Piwik Plugin
 ! Software
 ! Download
 |-
-| Software-Name
+| Apache HTTP Server 2.4
-| [http://url Software-Link]
+| Open Source / [http://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0]
 |-
-| Software-Name
+| PHP 5.5
-| [http://url Software-Link]
+| Open Source / [http://www.php.net/license/3_01.txt PHP License 3.01]
 |-
-| Software-Name
+| MySQL Community Server
-| [http://url Software-Link]
+| Open Source / [http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GPL 2.0]
 |}
-==== Software Licenses ====
+== Installation of the Plugin ==
-==== OS Environment Variables ====
+{| class="wikitable"
-…
+|+ Settings of the E-Compass Piwik Plugin
+! Setting
-==== Installation ====
+! Description
-…
+|-
+| URL of the CEP-Engine
-==== Preparation ====
+| 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
-=== Service Configuration ===
+| 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>).
+|}
-=== Other ===
+== 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 ===
-; With which parameters does the service scale?
+The maximum scaling is achived by providing one piwik web server per E-Shop. Usually one piwik web server will serve serveral E-Shops.