ekomimeetsmage Manual for version 1.0.0, 1.1.0, 1.2.0, 1.3.0, 1.4.0

Transcription

1 ekomimeetsmage Manual for version 1.0.0, 1.1.0, 1.2.0, 1.3.0, Version 0.6 Last edit:

2 Overview 1 Introduction Requirements Function Overview Installation Important notes before installing Installing the test version Preparation Installation of ioncube Registering a test license Installing the extension Adding the test license Installling the full version Using the extension Configuration Magento CronJob ekomi API Data ekomimeetsmage Lifecycle Existing ekomi clients Review Overview Status Frontend...12 (c) 2013 meets-ecommerce Online Agentur GmbH Page 2 of 13

3 1 Introduction In this manual you will find all information required to install and use ekomimeetsmage. If you need additional support, please do not hesitate to send us an Requirements LexMeetsMage requires: PHP version 5.3.x, 5.4.x Magento Commerce Community Edition 1.4.2, 1.5.x, 1.6.x, 1.7.x ekomi Account (ekomi.de) 1.2 Function Overview Function Automated import Simple configuration Automated distribution Review overview Description All reviews will be automatically imported from ekomi into Magento. You can view and edit your ekomi account data by using the Magento admin panel. Customers of your shop will receive an to provide feedback for your shop. You can check, activate and deactivate all reviews in the review overview section. If you need additional features, please do not hesitate to contact us via 2 Installation The installation of ekomimeetsmage is very similar to the Magento standard procedure. This section will explain all necessary steps for installing the extension. (c) 2013 meets-ecommerce Online Agentur GmbH Page 3 of 13

4 2.1 Important notes before installing Manual installation Please note: meets-ecommerce will not be liable for any damages caused by an manual installation of ekomimeetsmage. We advise you to install and test the extention with a fresh Magento installation. Furthermore, we advise you to: Backup your database Backup your complete Magento store system Install the extension 2.2 Installing the test version Please follow the following steps in order to install the test version: Preparation In order to test the test version of ekomimeetsmage you have to download our test version. Please navigate to the product page of ekomimeetsmage to find your download link: Installation of ioncube In order to run the test version, you will need to install ioncube. ioncube is used to encrypt the sourcecode of the extension and does not save any data. Please download the ioncube Loader from the official ioncube homepage 1. The easiest way to install ioncube is by using the ioncube Loader Wizard. The installation of any extension requires access authorization of your PHP and web server settings. Please contact your hoster if you need further assistance. How to install the ioncube Loader: 1. Please download the latest ioncube Loader for your operating system: ( 2. Extract the archive 3. Copy the loader-wizard.php file into your web directory 1 (c) 2013 meets-ecommerce Online Agentur GmbH Page 4 of 13

5 4. Open the loader-wizard.php in your browser. For example: 5. Follow the instructions on the screen. Please contact your hoster or us if you have any problems. If you want us to help you with the installation, please contact us at Registering a test license 1. Create a new account at meets-ecommerce.de. 2. Log into your new account. 3. Please navigate to the license tab. a. You will automatically receive your license details if you have not created or bought your license yet. 4. Please select a license for the ekomimeetsmage v0.9.0 extension and save your selection. 5. You should see your license details and status on the screen Installing the extension 1. Please download the extension. You can find the download link at the product page of ekomimeetsmage 2. Extract the archive. 3. Please copy the contents of the src/ folder into your main Magento folder. 4. Please log in to your Magento backend and navigate to the meets-ecommerce tab. You might need to refresh your cache first. Please note: If you see a blank page or an error log your ioncube installation might have failed. Please refer tot he ioncube Loader section of this manual Adding the test license After you have created your test license at meets-ecommerce.de, please navigate tot he register your test license tab: 1. Please log in to you Magento backend. 2. Navigate to meets-ecommerce > license management 3. Enter the following data: (c) 2013 meets-ecommerce Online Agentur GmbH Page 5 of 13

6 a. License user: your b. License password: your password 4. Please press the update license data button at the top right. 5. After the transfer is successful, you should see a green notification window. 6. Your extension is ready to go! 2.3 Installling the full version 1. Download the extension (you will find the download link located in your user panel > downloads) 2. Extract the archive 3. Please copy the contents of the src/ folder into your main Magento folder. 4. Please log in to your Magento backend and navigate to the meets-ecommerce tab. You might need to refresh your cache first. Information: you can clear the cache in your Magento backend by navigating to System -> Cache Management delete. 3 Using the extension You will find all required configuration options in your Magento backend by navigating meets-ecommerce > ekomimeetsmage (figure 1). Figure 1: Structure of ekomimeetsmage Configuration Please enter your ekomi API data in the configuratino tab and the settings for your sending process. (c) 2013 meets-ecommerce Online Agentur GmbH Page 6 of 13

7 Review Overview You can access, edit and delete all imported customer feedback in the review overview tab. Status You can check the status of the automated service and resend rating s in the status tab. 3.1 Configuration ekomimeetsmage will import all required data from ekomi into Magento. To make sure that the extension is working flawlessly, please note the following configuration details Magento CronJob The Magento CronJob is required for ekomimeetsmage. You can find the manual for configuring the Magento CronJob here: _installation_and_configuration/how_to_setup_a_cron_job ekomi API Data You will need your own ekomi account in order to use this extension. Please create your account at When registering, please activate the API option of your ekomi account. If you have any questions about this step, please do not hesitate to contact us via Configuring the API data Please enter your API data in the Magento backend (c) 2013 meets-ecommerce Online Agentur GmbH Page 7 of 13

8 To do this, please navigate to meets-ecommerce > ekomimeetsmage > configuration. Please select the single store option (see figure 2) if you want to use one ekomi account with all Magento shops or select multi store if you want to use separate ekomi accounts with different shops. Figure 2: selecting the right ekomi modus Information: Since version we have released the Multi Store / Multi Account option as well. Please enter your account details which ekomi should provide you. Please enter the ekomi API ID and the matching ekomi API password (figure 3). Click on save configuration at the upper right of the screen. You should see your ekomi details being verified (figure 4). Figure 3: providing the API data Figure 4: ekomi account details The configuration of ekomimeetsmage is completed. (c) 2013 meets-ecommerce Online Agentur GmbH Page 8 of 13

9 If you have verified your account successfully you can configure the Sending Process. Per default the days, which are configured in the ekomi backend, will take until an gets send. To configure another mode just choose the option which fits for you at best. You choose on of the following options: Option Deactivated Sending if ekomi days passed Sending if order status valid Sending if ekomi days passed and order status valid Description This option deactivates the automatic sending. This option takes the configured days in the ekomi backend. If the days are passed the cron job sends the rating . Sends the if the order status of the order matches with the configured one. This mode is a mix out of the both above. It sends an if the days passed and the order has the configured status. At last just save the settings over the button in right top corner. Because of big log files of ekomimeetsmage, we have implemented in Version the possibility to turn on or of the logging. Figure 5: Turn on or off logging Since we have implement the support of Google Snippets. Figure 6: ekomimeetsmage with Google Rich Snippets Support You can easily turn on or off it in the configuration of ekomimeetsmage. (c) 2013 meets-ecommerce Online Agentur GmbH Page 9 of 13

10 Figure 7: Google Rich Snippet Activation Please note: This feature only works with the standard templates of ekomimeetsmage. If you want to modify them, don t forget to overtake all needed data. 3.2 ekomimeetsmage Lifecycle Before we are going on we want to explain how ekomimeetsmage works: Figure 8: Lifecycle ekomi and ekomimeetsmage Customer orders a product: the order data will get stored in ekomimeetsmage. ekomimeetsmage sends feedback to customer: ekomimeetsmage requests the ekomi feedback link. Customer provides feedback at ekomi.de: the customer provides feedback about the order and the shop. ekomi approves the customers feedback: ekomi processes the feedback. ekomimeetsmage imports feedback: the product feedback will get imported automatically into Magento. Customers can view feedback: the cycle is complete and your customers can check out your ratings and feedback. (c) 2013 meets-ecommerce Online Agentur GmbH Page 10 of 13

11 3.3 Existing ekomi clients If you are a previous user of ekomi you have to pay attention to the matching of the product ratings and the SKU. Please note: This means that ekomimeetsmage can only work with products that use the correct SKUs and article numbers. If you are not sure about that, please ask the support of ekomi ( Please contact us if you have further questions: support@meets-ecommerce.de 3.4 Review Overview In the review overview tab you can find important data such as customer ratings and customer feedback about your products. You can activate and deactivate ratings and reviews. Please navigate to meets-ecommerce -> ekomimeetsmage -> review overview Figure 9: Review Overview By checking multiple boxes you can activate or deactivate reviews. Just select the action you want to do and click on execute. Figure 10: deactivate / activate ratings 3.5 Status Every customer receives an automated after a few days of his purchase which asks him to provide feedback and rate the shop. (c) 2013 meets-ecommerce Online Agentur GmbH Page 11 of 13

12 Information: You can edit the content and the delay of the automated s in your ekomi interface. A cron job is used to process the s. Sometimes it can be difficult to check whether the s have been sent out or not. By checking the status tab of the ekomimeetsmage extension you can see further information about the sent status (see figure 11). Information: Since version you can resend failed s. Another new feature since version is the status canceled. If you canceled an order in your Magento Backend our extension will mark the review mail as canceled, too. If you still want to send the out, you can use the resend button. Figure 11: status The following status will be used: Option PENDING COMPLETE FAILED CANCELED Description The have not been send to the customer. The was send already. The sending process failed because of technical issues. The related customer was canceled and therefore the does not get send out. 3.6 Frontend ekomimeetsmage comes with a standard layout which fits most Magento store themes (see figure 12 and 13). (c) 2013 meets-ecommerce Online Agentur GmbH Page 12 of 13

13 Figure 12: ekomi rating below a product name Figure 13: detailed ratings You can easily change the design of the ekomimeetsmage extension by modifying these files. magento/app/design/frontend/default/default/layout/ekomimeetsmage.xml Frontend settings. magento/app/design/frontend/default/default/layout/template/ekomimeetsmage /product/name.phtml HTML of the rating view below the product name (figure 12). magento/app/design/frontend/default/default/layout/template/ekomimeetsmage /product/feedback.phtml HTML of the detailed (figure 13). magento/skin/frontend/default/default/css/ekomimeetsmage/style.css CSS definitions Information: If you do not want to modify ekomimeetsmage by yourself, feel free to send your enquiry to support@meets-ecommerce.de. (c) 2013 meets-ecommerce Online Agentur GmbH Page 13 of 13