Child pages
  • Magento Affiliate
Skip to end of metadata
Go to start of metadata

Icon

Having hard time finding an answer to your question?

Check out our Knowledge Base.

Extension page: http://ecommerce.aheadworks.com/magento-extensions/magento-affiliate.html


The Magento Affiliate extension allows you to organize automated advertising campaigns that will help promote your products or services round the clock. The charm of Magento Affiliate is that it allows you to build a team of sales reps which use their visitors and opt-in lists to advertise your products and services. You don’t have to pay them anything until they make a profit for you.

Installation

1. Backup your web directory and store database.

 Click to view details

You can make backup copies with any tool you find appropriate

If you are going to use the native Magento backup function, navigate to System -> Tools -> Backups and perform System and Database backups

 2. Log in to the Magento backend

 3. Disable compilation

 Click to view details

Navigate to System -> Tools -> Compilation.

If Compiler status is Disabled, you can skip to the next step

If Compiler is enabled, disable it.

IMPORTANT: after the extension is installed, you can enable the compilation again; IT IS CRUCIAL that you use "Run Compilation Process" function, not just "Enable button"

Icon

Installing an extension with the Compilation enabled will result in store downtime.

 4. Flush store cache

 Click to view details

You can flush the store cache in 2 ways:

  • via the backend:

Navigate to System -> Cache Management menu, and click Flush Magento Cache button

  • via filesystem:

On your server, navigate to Magento root folder, then proceed to /var/cache/; delete all the content there.

 5. Download the extension package from your account and extract the downloaded archive

 6. Copy the content of /Step_1/ folder to your store's root directory

If you are using a custom theme,

Icon
 read the instructions here.

The extension comes with 2 design packages: /base/default/ and /rwd/default/ .

In case you are using a custom theme, it is recommended to copy the design files to your current theme's folders. In case there are several themes in use at the same store, the design files must be copied to each of them.

  • Find this folder in the package: /step_1/app/design/frontend/base/default/ ; copy its content to /app/design/frontend/[your_package]/[your_theme]/
  • Find this folder in the package: /step_1/skin/frontend/base/default/ ; copy its content to /skin/frontend/[your_package]/[your_theme]/

 7. Copy the content of /Step_2/ folder to your store's root directory

 8. Flush store cache again; log out from the backend and log in again.

Configuration

Magento Affiliate Configuration

Go to the System → aheadWorks Extensions → Magento Affiliate backend page (or Magento Affiliate → Settings).

General

  1. Define whether affiliate cookie can be rewritten by another affiliate. If No is selected in the Rewrite affiliate cookie field, another affiliate is not paid when the customer follows the link to the same store as the first affiliate promoted. If Yes is selected in the Rewrite affiliate cookie field, another affiliate is paid when the customer follows the link.
  2. In the Consider taxes field, define whether to include tax amount in the earning calculation or not.

  3. Specify for which customer groups affiliates’ accounts will be created automatically.
  4. Click the Delete all transactions and withdrawals button if you want to set all affiliates’ balance to 0.

 

Notifications

The Magento Affiliate extension allows you to receive email notifications of new withdrawal requests.

  1. Enable the opportunity of sending email notifications of new withdrawal requests to your email address.
  2. Specify email address in the Send email to field, where all the notifications about new withdrawal requests will be sent to.
  3. In the Email sender field, specify the sender of emails notifying about new withdrawal requests.
  4. The templates in the New withdrawals request template, Withdrawals request succeed template, and Withdrawal request failed template fields are selected by default.

 

Withdrawals

  1. Define the minimum amount of the available affiliates’ balance to make them able to request withdrawals.
  2. In the Commissions holding period field, specify the quantity of days after the order placing when the affiliate will not be able to withdraw.

 

Campaigns

The Magento Affiliate extension allows you to create advertising campaigns that will help you to promote your products or services. Go to the Magento Affiliate → Campaigns backend page. Here you can view the full list of campaigns. From the Manage Campaigns page, you have the possibility to delete any campaign.

To add a new campaign, click the Add New button.

General

  1. In the Name field, specify the title of the campaign.
  2. In the Store field, specify the store where the campaign will be available.
  3. Define the time period in the Active From and Active To fields when the campaign will be active.
  4. Set the Status field to Active.
  5. Select customer group(s) of affiliates who can access the campaign.
  6. Proceed to setting up the campaign Rate as per next readme section.

 

Rate

In this tab, specify the way an affiliate is paid. Define the type of rating in the Type field. It can be: Fixed percent rateTier percent rateFixed amount (base currency), or Tier amount (base currency).

If you define the Fixed percent rate or Fixed amount (base currency) option, you should specify the amount or the percent which will be paid to affiliate per each earning.

If you define the Tier percent rate or Tier amount (base currency) option:

  1. Specify the calculation type: Last month or All time.
  2. Click the Add Tier button.
  3. Specify the amount of the earning.
  4. Choose customer group of affiliates who can access the campaign.
  5. Define the amount or the percent which will be paid to affiliate.
  6. Click the Save and Continue Edit button.

 

Conditions

In the Conditions tab, you can create different rules which will fetch commissions to affiliates if applied. If you don’t specify any conditions, the rule will be applied to all products purchased in your store.

 

 

 

Affiliates

The Magento Affiliate extension allows you to create a base of affiliates, who will promote your products over the Internet. You pay the affiliate basing on conversion of sales. If a customer follows an affiliate link to your website and makes a purchase in accordance with the rules of your campaign, the affiliate is paid.

Go to the Magento AffiliateManage Affiliates backend page. Here you can view the full list of affiliates in your store.

From the Manage Affiliates page, you have the possibility to View Customer, Edit, or Delete the affiliate. Choose the required affiliate and specify the necessary option in the Action field.

You can also change the status of the affiliate. Just select the Change Status option in the Actions field and specify the required status in the Status field.

Creating new affiliate

To create a new affiliate, click the Add New button and choose the required customer.

In the General Information tab, set the Status field to Active and click the Save Affiliate button.

After saving the affiliate, the Total Affiliated and Affiliated Last Month fields are added to the General Information tab. These fields contain the information about the affiliate’s commissions for the whole time and the last month.

If the affiliate is saved, a new Balance tab appears. Here you can find the current affiliate’s balance, view all the transactions and withdrawals, and add commissions (via Manual Transaction section) to affiliate’s current balance.

To add commissions, specify the amount of the transaction, choose the campaign, leave a comment if necessary and click the Add button. Then click the Save Affiliate button.

When the affiliate is created, the Affiliate Program tab is added to the customer’s account page. The information about affiliate’s commissions, withdrawals, and campaigns are displayed here.

The Lifetime commissions field displays the full amount of earnings during the whole affiliate’s life.

The Pending commissions field shows the amount of commissions that have been earned, but are not available for redeeming yet.

The Available commissions field shows the total commissions currently available for withdrawing.

Notes

  • Comissions that have been added by admin will not be added to "Pending commissions" and are not included in reports 
  • The comment for commissions added by admin is visible only for admins


Uninstallation

 

If you just need to temporary disable the extension, you can just do the steps 1-5, without deleting the files of the extension.

  • Disable compilation, in case it is enabled.
  • Login to your FTP, navigate to app/etc/modules/
  • Open the file AW_Affiliate.xml and change the following line:

    to

    Now your Magento is unaware of the existence of this module.

  • Clear the cache under var/cache
  • Make sure that the site is working properly, otherwise roll back the changes and apply to our technical support.
  • If everything works fine, it is safe to delete the files of the extension.
  • In case you need to clean the database, backup your database and then run the following queries in MySQL: 

    Icon

    It is necessary to run the queries in the specified order

    Note, if you are using the table with prefixes, you must specify them in all table names. 

    If you are not sure how to do that or expect any troubles with it, please contact your server administrator regarding the matter.
    If you remove the tables as it is described above, you will need to set up the extension again after it is reinstalled. All transactions history will be lost as well.


Troubleshooting

After the extension installation the store gives an error, or blank page, or suggests to start Magento installation procedure.

Change the owner of the extracted extension files to the web server user and set 775 permissions on them. Clear the store cache and try again.

There is no aheadWorks extensions under my configuration section, or having the extension tab clicked I get a blank page, or Access Denied error.

Clear the store cache, browser cookies, logout and login again.

I've set up everything correctly, inserted the HTML code but there is nothing on that page.

Clear the store cache, clear your browser cache and domain cookies and refresh the page.

My configuration changes do not appear on the store.

Clear the store cache, clear your browser cache and domain cookies and refresh the page.

Reindex process of affiliates balance stops or leads to errors.

It can be caused by the huge amount of affliliates. It can be solved with the help of the hardware upgrade.

 


You can always find the latest version of the software, full documentation, demos, screenshots and reviews at http://ecommerce.aheadworks.com
License agreement: http://ecommerce.aheadworks.com/LICENSE-M1.txt
Contact us: http://ecommerce.aheadworks.com/contacts/
Copyright © 2015 aheadWorks http://www.aheadworks.com

  • No labels