Introduction

This howto explains the technical integration of the rateit.cool service in your magento installation version 1.9.x

These steps to install and configure the plugin:

  1. . Download the Plugin and install it
  2. . Activate the Plugin
  3. . Register an rateit.cool account
  4. . Connect the service to the shop
  5. . Verify your shop
  6. . Add the GTIN field
  7. . Add GTIN to all Attributes Sets
  8. . Add the product review form
  9. . Add the shop review form

Activate the plugin

Steps to activate the plugin in your shop

  • Login as admin
  • Select from the top menu System -> Configuration
  • Select from the right menu Advanced -> Advanced
  • Disable the Plugins “Mage_Rating” and “Mage_Review”
  • Enable the Plugin “RateItCool_ProductReviews”

Connect the service

Steps to connect the service to your shop

  • Login at rateit.cool
  • Select from the menu Shop
  • Copy the “username”, “apikey” and “serverapikey”
  • Login at magento administration
  • Select from the top menu System -> Configuration
  • Select from the right menu Catalog
  • Open the tab “Product Reviews from rateit.cool”
  • Paste the “username” to the field “Api User”
  • Paste the “apikey” to the field “Api Key”
  • Paste the “serverapikey” to the field “Server Api Key”
  • Clear all caches

Verify your shop

Steps to activate the verify your shop

  • Login at rateit.cool
  • Select from the menu Shop
  • Register a new shop
    • Fill out the field “Name” with your shopname. It’s only for display in the shop list.
    • Fill out the field Shop-Url with the baseurl of your shop “http://example.shop.com”
    • Click the verify and register button
  • Your Shop is in the list of registered shops

Add the attribute GTIN

Add the GTIN field to product data (if necessary).

    • Login as admin at your shop
    • Select from the top menu Catalog -> Attributes -> Manage Attributes
    • Click the button “Add New Attribute”
    • Fill out the fields
      Attribute Properties
      Attribute Codegtin
      ScopeStore View
      DefaultValue
      Unique ValueNo
      Values Required(Yes or No)
      Input ValidationLetters (a-z,A-Z) or Numbers (0-9)
      Apply ToAll Product Types
Frontend Properties
Use in Quick Search(Yes or No) optional
Use in Advanced Search(Yes or No) optional
Comparable on Front-endYes
Use In Layered NavigationNo
Use In Search Results Layered NavigationNo
Use for Promo Rule ConditionsNo
Position0
Allow HTML Tags on FrontendNo
Visible on Product View Page on Front-end(Yes or No) optional
Used in Product ListingYes
Used for Sorting in Product ListingNo
  • Save it by clicking the “Save Attribute” button

Add GTIN to all attribute sets

Add the GTIN field to all Attributes Sets (if necessary)

  • Login as admin at your shop
  • Select from the top menu Catalog -> Attributes -> Manage Attributes Sets
  • Select each Attributes Sets you defined and Drag and Drop the new field GTIN to each set
  • Save each set by clicking the “Save Attribute Set”

Add the product review form

Add the form calls to the “Order Views” template “app/design/frontend/default/template/sales/order/items/renderer/default.phtml”or“app/design/frontend/rwd/default/template/sales/order/items/renderer/default.phtml”

  • After the product-name add
    <!-- retait cool stars -->
    <div class="ratings rate-it-cool-product" data-gpnvalue="<?php echo $_item->getProduct()->getGpnValue(); ?>” data-gpntype=”<?php echo $_item->getProduct()->getGpnType(); ?>” data-language=””<?php" echo="" mage::app="">>getLocale()->getLocaleCode(); ?>” ></p>
    <div class="rating-box">
    <div class="rating rate-it-cool-review-summary-empty rate-it-cool-review-summary"></div>
    </div>
    </div>
    <!-- end retait cool stars -->
  • At the end of the first td
    <!-- retait cool open product review form -->
    <!--?php if (!$this->getPrintStatus() && $_item->getOrder()->getStatus() === 'complete'): ?-->
    <div class="rateit-cool-feedback-from"><a href="#" data-feedbackid="<?php echo $_item->getId() ?>”><!--?php echo Mage::helper('RateItCool_ProductReviews')->__('Review the product'); ?--></a> </div>
    <!--?php endif; ?-->
    <!-- end retait cool open product review form -->
  • At the end of the file Add
    <!-- rate-it-cool product review form -->
    <!--?php if (!$this->getPrintStatus() && $_item->getOrder()->getStatus() === 'complete'): ?-->
    <form class="rate-it-cool-feedback-form" name="productfeedbackform<?php echo $_item->getId() ?>”></p>
    <h2><!--?php echo Mage::helper('RateItCool_ProductReviews')->__('Review for the product'); ?--></h2>
    <p>       <input type="hidden" name="gpntype" value=""<?php" echo="" _item-="" />getProduct()->getGpnType(); ?>”/><br />
           <input type="hidden" name="gpnvalue" value=""<?php" echo="" _item-="" />getProduct()->getGpnValue(); ?>”/><br />
           <input type="hidden" name="language" value=""<?php" echo="" mage::app="" -="" />getLocale()->getLocaleCode(); ?>”/></p>
    <table>
    <tbody>
    <tr>
    <td class="label second"><!--?php echo $this->__('Global'); ?--></td>
    <td class="ratings">
                 <span class="reviewStars"><span class="reviewStars"><br />
                   <input type="hidden" class="stars" name="stars" value="0" /></span></span></p>
    <div class="rating-box oneStars" style="width: 13px; float: left;" title="<?php echo Mage::helper('RateItCool_ProductReviews')->__(‘not really ok’); ?>”></p>
    <div class="rating rate-it-cool-review-summary-empty rate-it-cool-review-summary"></div>
    </p></div>
    </td>
    </tr>
    </tbody>
    </table>
    </form>
    </li>
    </ul>
    </div>
    <p><span class="reviewStars"><span class="reviewStars"> <input type="hidden" class="stars" name="detail1" value="0" /></span></span></p>
    <div class="rating-box oneStars" style="width: 13px; float: left;" title="<?php echo Mage::helper('RateItCool_ProductReviews')->__(‘not really ok’); ?>”></p>
    <div class="rating rate-it-cool-review-summary-empty rate-it-cool-review-summary"></div>
    </div>
    </div>
    <p><span class="reviewStars"><span class="reviewStars"> <input type="hidden" class="stars" name="detail2" value="0" /></span></span></p>
    <div class="rating-box oneStars" style="width: 13px; float: left;" title="<?php echo Mage::helper('RateItCool_ProductReviews')->__(‘not really ok’); ?>”></p>
    <div class="rating rate-it-cool-review-summary-empty rate-it-cool-review-summary"></div>
    </div>
    </div>
    <p><span class="reviewStars"><span class="reviewStars"> <input type="hidden" class="stars" name="detail3" value="0" /></span></span></p>
    <div class="rating-box oneStars" style="width: 13px; float: left;" title="<?php echo Mage::helper('RateItCool_ProductReviews')->__(‘not really ok’); ?>”></p>
    <div class="rating rate-it-cool-review-summary-empty rate-it-cool-review-summary"></div>
    </div>
    <p><span class="reviewStars"><span class="reviewStars"> <input type="hidden" class="stars" name="detail4" value="0" /></span></span></p>
    <div class="rating-box oneStars" style="width: 13px; float: left;" title="<?php echo Mage::helper('RateItCool_ProductReviews')->__(‘not really ok’); ?>”></p>
    <div class="rating rate-it-cool-review-summary-empty rate-it-cool-review-summary"></div>
    </div>
    <div class="feedback-title"><input type="text" style="padding: 10px 0 10px 5px; width: 99%;" name="feedbackTitle" placeholder="<?php echo Mage::helper('RateItCool_ProductReviews')->__(‘Title of the review’); ?>” /></div>
    <div class="feedback-content"><textarea name="feedbackContent" style="width: 98%;" placeholder="<?php echo Mage::helper('RateItCool_ProductReviews')->__(‘Content of the review’); ?>”></textarea></div>
    <div class="feedback-recommend"><input name="recommend" type="checkbox" /> <!--?php echo Mage::helper('RateItCool_ProductReviews')->__('I recommend the product to a friend'); ?--></div>
    <div class="rateit-cool-send-feedback"><a href="#" class="button-middle small" data-formname="productfeedbackform<?php echo $_item->getId() ?>”><!--?php echo Mage::helper('RateItCool_ProductReviews')->__('Send the review'); ?--></a></div>
    <div class="rateit-cool-send-feedback-success" style="display: none;"><!--?php echo Mage::helper('RateItCool_ProductReviews')->__("Thank you for the review"); ?--></div>
    <div class="rateit-cool-send-feedback-error" style="display: none;"><!--?php echo Mage::helper('RateItCool_ProductReviews')->__("Can't send the review"); ?--></div>
    <p><!--?php endif; ?--> <!-- rate-it-cool product review form -->

Add the shop review form

Add the shop review form to the “Sales Order View” template “app/design/frontend/base/default/template/sales/order/view.phtml”

Add before the “

<!--?php if ($this->getOrder()->getStatus() === 'complete'): ?-->
<div class="order-info-box rateit-cool-feedback-from">
<h2><!--?php echo Mage::helper('RateItCool_ProductReviews')->__('Shop Review Title'); ?--></h2>
<p><!--?php echo Mage::helper('RateItCool_ProductReviews')->__('Shop Review Hint', '<a href="#" class="" data-feedbackid="' . $this->getOrder()->getId() . '">', '</a>'); ?--></p>
<div class="order-info-box" style="display: none;" id="<?php echo $this->getOrder()->getId(); ?>”></p>
<form class="rate-it-cool-feedback-form" name="shopfeedbackform<?php echo $this->getOrder()->getId() ?>”></p>
<h2><!--?php echo Mage::helper('RateItCool_ProductReviews')->__('Review for the shop'); ?--></h2>
<p><input type="hidden" name="gpntype" value="shop" /> <input type="hidden" name="gpnvalue" value=""<?php" echo="" mage::getstoreconfig="" catalog="" rateitcool_productreviews="" api_user="" />“/> <input type="hidden" name="language" value=""<?php" echo="" mage::app="" -="" />getLocale()->getLocaleCode(); ?>”/> <input type="hidden" name="stars" value="0" /></p>
<div class="ratings">
<div class="rating-box oneStars" style="width: 13px; float: left;" title="<?php echo Mage::helper('RateItCool_ProductReviews')->__(‘not really ok’); ?>”></p>
<div class="rating rate-it-cool-review-summary-empty rate-it-cool-review-summary"></div>
</div>
<div class="rating-box twoStars" style="width: 13px; float: left;" title="<?php echo Mage::helper('RateItCool_ProductReviews')->__(‘hm ok’); ?>”></p>
<div class="rating rate-it-cool-review-summary-empty rate-it-cool-review-summary"></div>
</div>
<div class="rating-box threeStars" style="width: 13px; float: left;" title="<?php echo Mage::helper('RateItCool_ProductReviews')->__(‘ok’); ?>”></p>
<div class="rating rate-it-cool-review-summary-empty rate-it-cool-review-summary"></div>
</div>
<div class="rating-box fourStars" style="width: 13px; float: left;" title="<?php echo Mage::helper('RateItCool_ProductReviews')->__(‘cool’); ?>”></p>
<div class="rating rate-it-cool-review-summary-empty rate-it-cool-review-summary"></div>
</div>
<div class="rating-box fiveStars" style="width: 13px; float: left;" title="<?php echo Mage::helper('RateItCool_ProductReviews')->__(‘coolest’); ?>”></p>
<div class="rating rate-it-cool-review-summary-empty rate-it-cool-review-summary"></div>
</div>
</div>
<p><span class="rate-it-cool-star-text"></span></p>
<div class="feedback-title"><input type="text" style="padding: 10px 0 10px 5px; width: 99%;" name="feedbackTitle" placeholder="<?php echo Mage::helper('RateItCool_ProductReviews')->__(‘Title of the review’); ?>” /></div>
<div class="feedback-content"><textarea name="feedbackContent" style="width: 98%;" placeholder="<?php echo Mage::helper('RateItCool_ProductReviews')->__(‘Content of the review’); ?>”></textarea></div>
<div class="feedback-recommend"><input name="recommend" type="checkbox" /> <!--?php echo Mage::helper('RateItCool_ProductReviews')->__('I recommend the shop to a friend'); ?--></div>
<div class="rateit-cool-send-feedback"><a href="#" class="button-middle small" data-formname="shopfeedbackform<?php echo $this->getOrder()->getId() ?>”><!--?php echo Mage::helper('RateItCool_ProductReviews')->__('Send the review'); ?--></a></div>
</form>
<div class="rateit-cool-send-feedback-success" style="display: none;"><!--?php echo Mage::helper('RateItCool_ProductReviews')->__("Thank you for the review"); ?--></div>
<div class="rateit-cool-send-feedback-error" style="display: none;"><!--?php echo Mage::helper('RateItCool_ProductReviews')->__("Can't send the review"); ?--></div>
</div>
</div>
<!--?php endif; ?-->

Contact

Send us a message with questions and feedback. We will contact you immediately.