Warning: This documentation is out of date (Applies to RC1).
Work on the new documentation is in progress. Please be patient.
Technical questions and for functionality, please ask on the forum.

---

NOTE: A beautifully formated PDF version is available for free in the download section (registration required to download)

Jafilia

Your advertising solution

Instruction Manual v. 0.9

Jafilia is an affiliate program creator and advertising campaign manager for your Joomla! Website or Virtuemart Shop.

WARNING: This component is in beta phase; don’t use it in production sites.

Requirements:

Jafilia is a module for the award wining CMS Joomla. It is compliant with the 1.0.x versions and have been specially tested on Joomla! 1.0.15

We are working to port the component to the 1.5 series of Joomla.

You can use Jafilia as affiliate software just with Joomla and activate pay per action campaigns, or you can combine it with the power of Virtuemart, probably the best E-commerce script for Joomla! Jafilia is compliant with Virtuemart 1.1.

License:

Jafilia is Open Source and delivered under the GNU General Public License.

This means you can not only use the script for free, you can also modify it as per your requirements or needs with the condition that you keep it under this same license.

http://fsfeurope.org/projects/gplv3/gplv3.en.html

http://en.wikipedia.org/wiki/GNU_General_Public_License

Support:

Thank you for downloading Jafilia, you can find free support or discuss anything related to the component in the community forums at www.jafilia.com/forums

and professional paid support at www.jafilia.com/support or support@jafilia.com.

How it works:

When a customer visits your site over an affiliate partner link, a cookie will be stored in the customer‘s browser; this cookie is set for three months and it’s aware of who the partner who sent this potential was for the duration of the cookie.

The cookie is re-set every time a potential customer visits your site, first thing done is to check the URL to see which partner sent the customer to your site. If this is a direct visit no changes will be done to the cookie, but if the customer clicked on a banner or text link, the cookie will be re-set, with 3 more months and the partner’s ID, may it be different from the first partner ID.

PPC or “Pay Per Click” Option.

In the Jafilia admin panel, you will find an option to select either PPC or PPS.

If you set your configuration to PPC”, Jafilia will look for the partner ID in the URL, then store the date and time in a cookie. Only one click for every 24 hours is allowed to prevent someone abusing your partnership offering, first click will taken into account, but only one click per IP in 24 hours. If many people click from an office or a cybercafé which has only 1 WAN IP, only first click will be valid; you may want to specify it on your program’s “Terms of use”

PPA “Pay Per Action” and PPS “Pay Per Sale” Options.

If you setup a PPA or PPS campaign, commissions will only be credited if the customer is sent by the partner, and actually does the intended action or buys something on your site.

The customer’s ownership remains to the last partner who sent the customer for 3 months.

So if the customer revisits your site in between these three months after their first visit, even if they are not coming over from the affiliate’s partner site, the partner will be credited.

You will be able to throttle this in a future version.

Installation procedure:

WARNING: This component is only tested with Joomla 1.0.15 and Virtuemart 1.1.1 and 1.1.2

if you want to use the ps_checkout.php file that comes with this package you have to use

VM 1.1.2

At this time there are some hacks required to make the component work, the hacks must be done by hand BEFORE you proceed to the regular component installation.

We are working so these hacks are no longer necessary.

Beware; the hacked files could conflict with the functions in other components.

If you re-install Joomla, just update it or change your template, you may need to do again all or part of this hacks.

Hack 1:

Edit the file: administrator/components/com_virtuemart/classes/ps_checkout.php

and search for following lines:

$d["order_id"] = $order_id = $db->last_insert_id();

if( $result === false || empty( $order_id )) {

$vmLogger->crit( 'Adding the Order into the Database failed! User ID: '.$auth["user_id"] );

return false;

}

Directly after that insert the following lines:

### Jafilia Hack ###

global $jafversion, $jafsale, $jaflead;

if(isset($_COOKIE['cook_jaffiliate']) && $jafversion == 'sale' || $jafversion == 'lead') {

$aff = $_COOKIE['cook_jaffiliate'];

if($jafversion == 'sale') $sale = round(($order_subtotal/100)*$jafsale,2);

if($jafversion == 'lead') $sale = $jaflead;

$date = date('Y-m-d H:i:s');

$affiliate = array(

'uid' => $aff,

'version' => $jafversion,

'order' => $order_id,

'sale' => $sale,

'status' => 'open',

'date' => $date

);

$db->buildQuery( 'INSERT', '#__jaf_sales', $affiliate );

$affisale = $db->query();

}

### End Jafilia Hack ###

Hack 2:

Open the Joomla! file (located at your site’s root) index.php and search for these lines:

require( 'globals.php' );

require_once( 'configuration.php' );

directly after that lines insert the following:

require_once('components/com_jafilia/config.jafilia.php');

Hack 3:

Go to the directory where your template files are, the path will probably be: root/templates/yourtemplatename/index.php

Open with notepad, look for the text “define( '_VALID_MOS' )”

Add there in the appropriate position:

//include the affiliate handler

include($mosConfig_absolute_path.'/components/com_jafilia/jafilia.inc.php');

now you can install the component as a normal Joomla component from your site backend.

WARNING: You should chmod 777 following files and folders:

components/com_jafilia/config.jafilia.php

components/com_jafilia/images (if not exists, just create them)

Installation:

Go to the administrator section of your site, and then install the component using the appropriate section. The component is installed automatically.

Now you can configure parameters for Jafilia in the module’s section of your admin area.

Test your installation:

To see where the short description is shown, go to Jafilia in frontend of your site.

Be sure that you are not logged in as a user. If a logged in user goes to this site, he will see the registration form of Jafilia. If a signed up affiliate partner follows that link, he will see his control panel.

Then you should sign up as an affiliate partner, to see the user control panel. If you already created some banner- or text links in backend, you can see them and the HTML code for them in the control panel.

Sections:

Configuration: Here you can set all general settings of the component. And if a Partner has reached the minimum fee amount you have set in the config, you can to a payout.

Partners : Here you will see a list of all partners. You can set them to active, see the referees and sales of them and take a look to the details of them. Under the details section it’s possible to crate a payout. If a partner has reached the payout minimum amount you set in configuration, a button will be shown to create a payout.

Clicks: Here you can see a list of all referrer clicks from all partners. Only one click per IP is counted in 24 hours.

Fee: Here you can see a list of all fees. If your customer has paid and everything with the order was correct, you can set the fee status to approved. If the order is canceled, set it to canceled. Only approved fees are counted on payout.

Banners: Here you can create your banner or text links and take control of them.

Charts: This shows charts of referrer clicks, sales and fees for the last 12 month.

Warranty:

The programs bundled with the Jafilia component are free software.

The exact distribution terms for each program are described in the individual files in of every peace of software.

Jafilia comes with ABSOLUTELY NO WARRANTY, to the extent permitted by applicable law.