Developer Documentation. etracker plugin for the Magento online shop software. Status: January 2014 Version 1.1

Transcription

1 Developer Documentation etracker plugin for the Magento online shop software Status: January 2014 Version 1.1

2 We would like to thank justselling Germany Ltd. for the development and delivery of this plugin. Please note that etracker GmbH does not assume any guarantee, warranty and liability for this plugin. etracker has exercised the greatest possible care when preparing the documentation. Nonetheless, we cannot fully exclude errors. We are thankful at all times for information regarding any errors and for improvement suggestions. We draw attention to the fact that the software and hardware names used in the documentation as well as brand names belonging to the respective companies are generally subject to legal trademark, brand or patent protection. We reserve all rights, in particular the right to duplicate and circulate or translate this documentation. No part of this work may be reproduced or stored using electronic systems, processed, copied or circulated in any form whatsoever (by photocopy, microfilm or other processes) without express written approval. Important note: We convey the software provided here to the user free of charge and without assuming further obligations. Unless otherwise defined, you shall be granted a simple, non-exclusive, non-transferable and non-sublicensable right to use the software for own purposes. Editing and, as far as it is not in accordance with the purpose of the contract, duplication and/or the making available to the public and/or other usage remain prohibited without the consent of the holder of rights. There is no warranty by etracker and/or other holders of rights for the software and/or its usage insofar as this is legally admissible. If not otherwise confirmed in writing, we and/or the holders of rights provide the software as is, under exclusion of any liability for material defects or defects of title. Particularly excluded are the guarantee of an accurate programme operation, the guarantee of compatibility with other hardware and software, the guarantee of fitness for a particular purpose as well as any guarantee for the exclusion of any negative effects on other systems and programmes. The entire risk as to the software s quality and performance is with the user. In no event we and/or the respective holders of rights will be liable for damages or consequential damages resulting from the use or the inusability of the software (including, but not limited to, data loss, defective processing of data, losses that have to be born by you or others, or the software s inability to cooperate with any other programme). Our liability for damages is excluded. The only exceptions to this rule are compensation claims arising from injury to life, body or health, or claims arising from the violation of essential contractual obligations (cardinal obligations), as well as the liability for other damages based on an intentional or grossly negligent breach of duty by us, our legal representatives or vicarious agents. Essential contractual obligations are those whose fulfillment is necessary to achieve the goal of the contract as well as those which a contractual partner may regularly rely on being performed. The foregoing restrictions apply also in favour of our legal representatives and vicarious agents and accordingly to claims for the reimboursement of expenses. The provisions of the German product liability laws and our liability for any contractual guarantees remain unaffected. We grant guarantees only in writing using the term Warranty. etracker GmbH, Hamburg 2014 Page 2 of 9

3 etracker GmbH Erste Brunnenstraße 1 D Hamburg Hotline: Switchboard: Fax: Web: info@etracker.com Copyright 2014, etracker GmbH etracker GmbH, Hamburg 2014 Page 3 of 9

4 Contents 1 Prerequisites and goals of this documentation Function and purpose of the etracker Magento plugin etracker Magento Plugin Compatibility Install the etracker Magento Plugin Configure the etracker Magento Plugin... 8 etracker GmbH, Hamburg 2014 Page 4 of 9

5 1 Prerequisites and goals of this documentation This documentation describes how to install and configure the etracker plugin for the Magento online shop software. In order to understand this, we assume programming knowledge in the field of Internet techniques. 2 Function and purpose of the etracker Magento plugin The etracker Magento plugin is used to set up the etracker tracking code in your Magento online shop software. The plugin offers many etracker functions directly. Apart from fully integrating Web Analytics, Page Optimizer, Page Feedback and Campaign Control the plugin can also fill the product performance report. etracker GmbH, Hamburg 2014 Page 5 of 9

6 3 etracker Magento Plugin 3.1 Compatibility The Magento plugin for etracker is compliant with Magento CE , 1.4.2, 1.5.x, 1.6.x, 1.7.x and 1.8.x. It is not compliant with Magento EE and any pre Magento CE release. 3.2 Install the etracker Magento Plugin The installation of the Magento etracker plugin is done via the Magento Connect interface. Please make sure that the file permissions are set correctly according to the Magento Connect requirements. 1. Login to your Magento Admin Panel and choose System > Magento Connect > Magento Connect Manager. 2. Login with your admin password again. etracker GmbH, Hamburg 2014 Page 6 of 9

7 3. In the Magento Connect Manager go to the section Install New Extensions and click on the Magento Connect link to download the package. 4. Paste one of the following extension keys into the section Install New Extensions :! Magento version earlier than 1.4.2: magento-community/etracker_connect! Magento version and later: 5. Click on the Install button. The system will check the current version of the plugin on Magento Connect and display the information. Click on Proceed to finally install the extension. 6. Go back to the Magento Admin Panel. Log out and re-login. Now you can start to configure the plugin. Note: If you already have a local version of the extension package available on your system, you may also go to the section Direct package file upload and click on Choose file. Your default file dialog of the operating system will be shown and you can choose the plugin s archive. After clicking on Upload you will see a Procedure completed message and you can go back to the Magento Admin Panel to log out and re-login. etracker GmbH, Hamburg 2014 Page 7 of 9

8 3.3 Configure the etracker Magento Plugin You can configure the plugin easily in the Magento Admin Panel. 1. Log in to the Magento Admin Panel and choose System > Configuration in the main menu. 2. Choose etracker in the GENERAL pane of the left-hand vertical menu General Settings! Account Key 1 Please enter the account key 1 here to overall enable tracking. You'll find the key online in your etracker account on Browse to Settings > Setup/Tracking code > etracker account key 1.! Account Key 2 To be able to use additional etracker API functionality you will need the account key 2. Please request this key from etracker on Submit prices/amounts You can transmit all prices and amounts either including tax (gross) or excluding tax (net) from Magento to etracker. etracker GmbH, Hamburg 2014 Page 8 of 9

9 3.3.2 Tracking Settings! Integrate tracking code 4.0? Tracking Code 4.0 offers more failure safety than earlier versions and is absolutely necessary for using etracker Page Optimizer. Please remove any other etracker code from your website prior to the integration. When choosing 'No' please ensure integrated standard tracking OR existing tracking code equal or greater version 3.0.! Activate StoreView code as area prefix? Should the StoreView code be set as prefix to the area path? Example: 'UK/products/product_a' instead of 'products/product_a', if your StoreView code is 'UK' Developer! Activate logging? If activated, log will be written to the file 'etracker.log'. You can find the etracker.log file in the /var/log folder of your Magento installation.! Activate debug? If set to Yes, debug data is printed to the browser console (instead of submitting it to etracker). Please check the documentation of your Internet browser for how to enable the console. etracker GmbH, Hamburg 2014 Page 9 of 9