Reward Points Lite User Guide

From MageWorld Wiki
(Redirected from RewardPointsLite-user-guide)
Jump to: navigation, search

Contents

Configuration

From the backend panel, the administrator can easily configure the Reward Points Lite module at System => Configuration => Mage World => Reward Points Lite or Promotions => Reward Points => Configuration

General

  • Enable the module by selecting Yes in the Enable Reward Points Lite field
  • In the Points/Currency Exchange Rate field, insert a value with the type of x/y to define the exchange rate.
  • In the Extend Shopping Cart Page field, select Yes for the cart page to be overridden. In the case you have other modules work on the cart page, you can insert the code manually (Please see more details at Display Reward Points in Shopping cart page in the Theme integration section).
  • In the Redeem points in increments of field, the default number is 1. You can insert any integer which will be used for spending points on cart.
  • In the Add reward points to account balance when order status is field, choose the status of the order. If the order is switched to this status, the points will be added to the account balance.
  • In the Subtract earned points when order is refunded field, select Yes for automatically subtracting points when the order is refunded.
  • In the Restore Redeemed Reward Points to balance when order is refunded field, select Yes for automatically restoring redeemed points back to balance on refunded orders.
  • In the Minimum points required to be redeemed per purchase and Maximum points allowed to be redeemed per purchase field, define the minimum and maximum points (or USD) which customers can use for each purchase.


caption

Set Specific Reward Points
The Set Specific Reward Points tab allows the store owner reward customers for their activities on the site such as registration, inviting friend, reviewing products, liking fan page and so on.

caption

Display Configuration

caption
  • You can choose to display Unit names of reward points, Reward points Icon on the frontend.
caption
  • In the reward icon field, you can upload reward icon and specify the link that it will direct to in the Link Reward Icon to field.

Facebook Configuration

The Reward Points Lite extension allows shop owner to reward customers for clicking Like button. Please enter the Application ID and Key into this field.

caption

Email Notification
The Reward Points Lite offers email templates for notifying customers of balance changes and sending point transactions. The administrator can enable this feature in the Enable notifications field.

caption

Individual Reward Points

The administrator can set reward points for particular products by inserting manually or importing points via CSV.
From the Admin Panel, go to Promotions => Reward Points => Individual Reward Points

caption
  • Insert points into the Reward Points Earned column, then save products or click on Import product reward points to upload the CSV file.

Here is a sample of CSV file (attached in the package, named rewardpoints_product.csv).

caption

In the shopping cart page, the Reward Points will be showed as below:

caption


Adding/Subtracting points by the administrator

From the Admin Panel, go to Promotions => Reward Points => Customer Account, you can see lists of customers and their balances.

caption

The administrator can add or subtract points for the customers manually or import points via CSV.

Manual

  • Select a customer by double-clicking the mouse.
caption
  • Insert a value for the Amount field and select the necessary action.
  • The comment that you inserted will be updated in the transaction history as well.

Also, you can check the customer’s transaction details by navigating to the Transaction History tab.

caption

Via CSV

From the Admin Panel, go to Promotions => Reward Points => Customer Reward Points, click the button “Import Reward Points”, upload the CSV file, and then click the button “Import”.

caption

A sample of the CSV file (attached in the package – rewardpoints.csv):

caption

All Transaction history

From the Admin page, go to Promotions => Reward Points => All Transaction History, this page lists all transaction history.

caption

Theme Integration

Display points in Create an account page

caption

Please go to 2 files:

app/design/frontend/your_package/your_theme/template/customer/form/register.phtml

and

app/design/frontend/your_package/your_theme/template/persistent/customer/form/register.phtml

Find the syntax code below:

 
<div class="account-create"> 
<--! INSERT CODE HERE-->

Copy the code below into the section

<--! INSERT CODE HERE-->
<?php echo Mage::helper('core/mwrewardpoints')->pointsCreateAccountRewardPoints(); ?>

Display points in product reviews page

caption

Please go to the file::

app/design/frontend/your_package/your_theme/template/review/form.phtml

Find the syntax code below:

 
<?php if ($this->getAllowWriteReviewFlag()): ?> 
<--! INSERT CODE HERE-->

Copy the code below into the section <--! INSERT CODE HERE-->:

<?php echo Mage::helper('core/mwrewardpoints')->pointsProductReviewRewardPoints(); ?>

Display points in Submit polls block

caption

Please go to the file:

app/design/frontend/your_package/your_theme/template/poll/active.phtml

Find the syntax code below:

<button type="submit" title="<?php echo $this->__('Vote') ?>" class="button"><span><span><?php echo $this->__('Vote') ?></span></span></button>
<--! INSERT CODE HERE-->

Copy the code below into the section <--! INSERT CODE HERE-->:

<?php echo Mage::helper('core/mwrewardpoints')->pointsSubmitPollRewardPoints(); ?>

Display points in Subscribe to the newsletter page

caption

Please go to 2 files:

app/design/frontend/your_package/your_theme/template/customer/form/register.phtml
app/design/frontend/your_package/your_theme/template/persistent/customer/form/register.phtml

Find the syntax code below:

<?php if ($this->isNewsletterEnabled()): ?>
<--! INSERT CODE HERE-->

Copy the code below into the section <--! INSERT CODE HERE-->:

<?php echo Mage::helper('core/mwrewardpoints')->pointsSignUpNewLetterRewardPoints(); ?>

Display points in Category pages

caption

Please go to the file:

app/design/frontend/your_package/your_theme/template/catalog/product/list.phtml

Find the syntax code below:
- In List mode

<?php if($_product->isSaleable()): ?>
    <p><button type="button" title="<?php echo $this->__('Add to Cart') ?>" class="button btn-cart" onclick="setLocation('<?php echo $this->getAddToCartUrl($_product) ?>')"><span><span><?php echo $this->__('Add to Cart') ?></span></span></button></p>
     <?php else: ?>
     <p class="availability out-of-stock"><span><?php echo $this->__('Out of stock') ?></span></p>
 <?php endif; ?>
 
 <--! INSERT CODE HERE-->


- In Grid mode

<?php echo $this->getPriceHtml($_product, true) ?>
<--! INSERT CODE HERE-->


Copy the code below into the section <--! INSERT CODE HERE-->:

<?php echo Mage::helper('core/mwrewardpoints')->pointsProductListRewardPoints($_product); ?>

Display points in Products pages

Please go to the file:

app/design/frontend/your_package/your_theme/template/catalog/product/view.phtml

Find the syntax code below:

<?php if ($_product->getShortDescription()):?>
<--! INSERT CODE HERE-->

Copy the code below into the section <--! INSERT CODE HERE-->:

<?php echo Mage::helper('core/mwrewardpoints')->pointsProductDetailRewardPoints($_product); ?>


Display redeemed points on the checkout page (at the order review step)

Please go to the file:

app/design/frontend/default_package/your_theme/template/checkout/onepage/review/totals.phtml

Find the syntax code below:

<?php $_colspan = $this->helper('tax')->displayCartBothPrices() ? 5 : 3; ?>
<--! INSERT CODE HERE-->

Copy the code below into the section <--! INSERT CODE HERE-->:

<?php echo Mage::helper('core/mwrewardpoints')->earnPointsOnepageReviewRewardPoints(); ?>

Please go to this file

app/design/frontend/default_package/your_theme/template/checkout/onepage/review/totals.phtml

Find the syntax code below

 
<?php echo $this->renderTotals(null, $_colspan); ?> 
<--! INSERT CODE HERE-->

And paste the code below into the section <--! INSERT CODE HERE-->:

<?php echo Mage::helper('core/mwrewardpoints')->totalPointsRedeemOnepageReviewRewardPoints(); ?>

Display Reward Points in Shopping cart page

For the cart.phtml, you can automatically rewrite it by going to Reward Point Configuration and selecting Yes in the Extend shopping cart page field

caption

In case that you want to do this manually (avoid conflicting with other modules that also rewrite cart.phtml), you can follow these directions:

Please go to the file:

app/design/frontend/default_package/your_theme/template/checkout/cart.phtml 

Find the syntax code below:

<div class="cart-collaterals">
        <div class="col2-set">
<--!INSERT CODE HERE -->

Copy the code below into the section <--! INSERT CODE HERE-->:

<?php echo Mage::helper('core/mwrewardpoints')->formRewardShoppingCartRewardPoints(); ?>

Display points in My Account

caption

Please go to the file:

app/design/frontend/default_package/your_theme/template/page/template/links.phtml

Find the code:

<!--INSERT CODE HERE -->
<?php echo $_link->getAfterText() ?>

Copy the code below into the section <--! INSERT CODE HERE-->:

<?php echo Mage::helper('core/mwrewardpoints')->pointsTopLinkRewardPoints($_link); ?>


Display points balance in My Account tab

caption

Please go to the file:

app/design/frontend/your_package/your_theme/template/customer/account/navigation.phtml

'Find the code:

echo $_link->getLabel()

And replace it by the code:

echo $_link->getLabel().Mage::helper('core/mwrewardpoints')->pointsMyAccountRewardPoints($_link);

Display the Like button

This feature is to reward customers for liking your fan page. After you create a Facebook Like Behavior Rule, you need to show the “FaceBook Like” button on your page by inserting the code:

<?php echo Mage::helper('core/mwrewardpoints')->showFacebookRewardPoints(); ?>

Example: For integrating the FaceBook like button into your product page
Please go to the file:

app/design/frontend/default_package/your_theme/template/catalog/product/view.phtml

Then, insert the above code before this code:

<?php if ($_product->getShortDescription()):?>

On Frontend you will see as below

caption

Display the invitation block

The Reward Point Lite supports importing contacts from popular email services.
We provide a syntax code for adding to your template:

<?php echo Mage::helper('core/mwrewardpoints')->showInvitationRewardPoints(); ?>

From the client’s point of view

Manage reward points balance

The customer can view their balance and transaction history by going to My Account/ My Reward Points

caption

Refer a friend

From the frontend panel, go to My Account/ My Invitation, the module offers sharing tools for customers to refer their friends via social networks, website or email.

caption

Use Points

caption
Personal tools
Namespaces

Variants
Actions
Navigation
General
Free Gift
Onestep Checkout Pro
Reward Points Pro
Reward Points Lite
Affiliate Pro
Affiliate Lite
Help Desk Pro
Daily Deal
Easy Banner
Cms Pro
Mega Menu
Follow Up Email
Easy Testimonial
Easy FAQ
Store Credit Pro
Ajax Cart Pro
Promobox
Delivery Schedule
Social Gifts
Toolbox