This is the ReadMe.txt on how to install Reward Point on zen cart v1.5.0
!!!BACKUP!!! ALWAYS MAKE SURE YOU HAVE AN UP TO DATE BACKUP OF YOUR FILES and MySQL DATABASE BEFORE INSTALLING
!!!WARNING!!! YOU NEED AT LEAST MySQL VERSION 5.1 OR HIGHER TO RUN THIS MOD
- This Reward Points Module works fine, but if you have a TEST SERVER try it out before going live.
- The 4 files in admin/includes/boxes/extra_boxes/ is obsolete and should be deleted or rename to something else until you are confident all is well.
- Added a define to admin/includes/extra_datafiles/reward_points_filenames.php and to
amin/includes/languages/english/extra_definitions/reward_points_definitions.php to make this work on zen cart 1.5.0. The define that was inserted is
define('BOX_CONFIGURATION_REWARD_POINTS', 'Reward Point Configuration');//moved from _dhtml.php for 1.5
- Go into phpmyadmin and BACKUP THE DATABASE BEFORE INSTALLING.
- Ensure you have carried out step 4)!
INSTALL/UPDATE
RE-UPLOAD ALL FILES. Some files has change. If you are 'UPDATING FROM ZEN CART V1.3.8, ZEN V1.3.9 TO ZEN CART V1.5.0
- Unzip the zip file into your Zen Cart root folder
1.1 IMPORTANT!!! READ EVERYTHING.....
- Copy all the files in folders named 'custom' to your corresponding custom folders.
2.1 Copy the files from includes/languages/english/extra_definitions/custom to includes/languages/english/extra_definitions/YOUR_CUSTOM_FOLDER
2.2 Copy the files from includes/modules/sideboxes/custom to includes/modules/sideboxes/YOUR_CUSTOM_FOLDER
2.3 Copy the files from includes/templates/custom to includes/templates/YOUR_CUSTOM_FOLDER
- Run the appropriate sql file using Admin->Tools->Install SQL Patch
3.1 If you are installing this mod for the first time use 'new.sql' and all the menus will be installed for you.
If you are updating from zen cart v1.3.8 and zen cart v1.3.9 you will have to Register the Admin Page manually
to Register the configuration page to show on the menu for zen cart v1.5.0. 'See Below'
3.2 If you use table prefixes in ZenCart you will need to manually rename 2 Reward Point Mod tables:
3.2.1.1 Rename 'yourprefix_reward_product_points' to 'yourprefix_reward_master'
3.2.1.2 Rename 'yourprefix_reward_point_history' to 'yourprefix_reward_status_track'
- Switch on the 'Shopping Cart with Rewards' sidebox using Admin->Tools->Layout Box Controller
4.1. There is also a "Reward Points" sidebox which displays points in cart and points earned (if logged in)
- Install the Reward Point Order Total module using Admin->Modules->Order Total
5.1. There is also a "Reward Points earned" module which displays the points earned at checkout
-
You can edit Global/Category/Product reward points using Admin->Catalog->Reward Points
-
You can change the Reward Point configurations using Admin->Configuration->Reward Points
-
You can set global and group Reward Point redeem ratios using Admin->Customer->Group Reward Redeem
-
You can set and change earned and pending points for each customer using Admin->Customer->Reward Points
SKIP NUMBER 10 IF YOUR MENU INSTALLED............................................................................
- If your configuration menu doesn't show in Admin after installing the new.sql statement you will have to install it manually.
10.1 After you install the SQL Patch Go to your phpMyAdmin Database, click on your database name to the right. At the top
click search when you come to that page enter Reward Points in the search box, tick all words, scroll down to
configuration_group and click go, click Browse, when you come to the configuration_group page look and get the configuration_group_id
number for the next step.
10.2 Log in to your store Admin go to Admin->Admin Access Management->Admin Page Registration
to Register the configuration page to show on the menu.
Copy and Paste
Page Key = configRewardPoints
Page Name = BOX_CONFIGURATION_REWARD_POINTS
Page Filename = FILENAME_CONFIGURATION
Page Parameters = gID=32 Replace the number with your phpMyAdmin Database configuration_group_id number.
Menu = Configuration
Display on Menu? = tick box for yes
Sort Order = the higher the number the lower it will display in the menu.
Run this sql statement below in your store Admin->Tools->Install SQL Patch to display the menu in
Admin->Catalog->Reward Points
Admin->Configuration->Reward Points
Admin->Customer->Group Reward Redeem
INSERT INTO admin_pages (page_key, language_key, main_page, page_params, menu_key, display_on_menu, sort_order) VALUES ('GroupRewardRedeem', 'BOX_GROUP_REWARD_POINTS_REDEEM', 'FILENAME_ADMIN_GROUP_REWARD_POINTS_REDEEM', '', 'customers', 'Y', 35);
INSERT INTO admin_pages (page_key, language_key, main_page, page_params, menu_key, display_on_menu, sort_order) VALUES ('RewardPoints', 'BOX_REWARD_POINTS', 'FILENAME_ADMIN_REWARD_POINTS', '', 'catalog', 'Y', 36);
INSERT INTO admin_pages (page_key, language_key, main_page, page_params, menu_key, display_on_menu, sort_order) VALUES ('CustomerRewardPoints', 'BOX_CUSTOMER_REWARD_POINTS', 'FILENAME_ADMIN_CUSTOMER_REWARD_POINTS', '', 'customers', 'Y', 37);
Quick run through on how it works.
The Point Ratio is the number of reward points you award per unit of base price.
So a Point Ratio of 1 will award 10 reward points for every $10, €10, £10 etc spent.
The currency used is decided by how the prices are stored for the products.
The Global Point Ratio is used for every product, unless overwritten by a Category Point Ratio (if set).
The Category Point Ratio is overwritten by a Product Point Ratio (if set).
If you install the Reward Points Order Total Module you can also set a Redeem Ratio. This is set to 0.01
as default so each point redeemed is worth 1 cent/pence.
The Global Reward Point Redeem setting is found under Customers->Group Reward Redeem
From 1.20a: admin can set a Mode configuration item to select whether points are rewarded by product or are
rewarded by order (sub)total.
From 1.27a: admin can fine tune how points are awarded or redeemed against based against other Order Total modules
such as Group Pricing and Gift Vouchers.
Version History:
2.1
Resolved issue with Reward Points not installing on
zen cart version 1.5.0
The 4 files in admin/includes/boxes/extra_boxes/ is obsolete
Added a difine in admin/includes/extra_datafiles/reward_points_filenames.php
Added a define in admin/includes/languages/english/extra_definitions/reward_points_definitions.php
Updated admin/customers_reward_points.php
Updated admin/group_reward_points.php
Updated admin/reward_points.php