This is a fully featured replacement for the default Customer Online report with the addition of an Affiliate Dashboard.
Fixed Information Shown per visitor:
- Refering URL
- Country
- Browser String
- Landing Page
- Arival Time
- IP Address *
Updated Information Shown per visitor:
- Customer Name *
- Last Click Time
- Current Page Viewed/Exit Page
- Number of Pages viewed (Clicks)
- Products Viewed
- Products in Cart
- Cart Total
- Categories Viewed
- If Checkout Has Been Completed
- If Products Added to Cart.
- Routes
- Search Terms (probably only works for default opencart search)
Reporting Features:
- Online Now - 7 timeframes to choose from.
- Sales Browsers *
- Sales Platforms *
- All Browsers *
- All Platforms *
- Online Now (last 5 minutes)
- Average Number of Clicks
- Average Time on Site
- Bounce Rate
- No. of Sales / Conversion Rate
- No. of 'Added to Cart Not Checked Out'
- Keywords Report *
- Landing Page Report *
- Sales Generating Keywords Report *
- Sales Generating Referers Report *
- Landing Pages Report *
- Exit Pages Report *
- Categories Viewed Report *
- Products Viewed Report *
Addtional Filters *:
- Filter for 'Added to Cart' (True/False);
- Filter for 'Checkout Completed' (True/False);
- Filter for 'Country';
- Filter for 'Landing Page'.
- Filter for IP Address.
- Filter for Customer.
Settings *:
Settings are available directly from the admin report page and include:- Customer Online switch;
- Affiliate Access switch;
- Bots By Name Exclusion swtich;
- Bots By IP Exclusion swtich;
- Ignored Pages;
- Excluded IP Addresses;
- Download Token (for updating ip2country data);
- Timezone Setting.
Items marked * are admin only
Affiliates
An additional setting is provided in the admin to enable you to set an 'Affilate Payout Amount'. This being the amount of commision that an affiliate must earn before they can receive a payment.
An additional 'Affiliates Payments Due' report shows all affiliates that have reached the payout abount.
The affiliate tracking code is recorded in the database to allow your
affiliates access to the customer tracking data. Affiliates only see
traffic their own traffic.
The Affiliate Report is similar to the admin report but also includes:
- Current Earings;
- Total Earnings;
- Next payout goal;
- Top 10 Referrers;
- Top 10 Products Sold;
- Top 10 Products Viewed;
- Top 10 Categories Viewed
To see the admin side in action Click Here and log in with the following details:
User: demo
Pass: demo
To see the catalog side Click Here and log in with the following details:
User: admin @ vger.co.uk
Pass: vg3r=
Installation
For Opencart 3.x
Install using the extension installer.
This will NOT work with Jays PageCache extension or other cached page extensions.
This is not perfect but it catches most information. It does rely on
visitors/customers clicking/viewing pages. If, for instance, they do not
return to your store after making payment then the purchase will not be
recorded in the visitor tracker.
Download
You can purchase and download this extension at the Opencart Extension Store
A full list of extensions is available here: Opencart Market Place
New Installation - Opencart 3.x
- Go to System -> Setting -> Options Tab
- Scroll down to the 'Account' section and set 'Customers Online:' to NO
- Go to Extensions -> Installer
- Upload the file online_plus_affilliate_3.x_v1.0.0.ocmod.zip and wait for it to finish.
This could take 5 minutes to upload so please be patient. - Go to System -> Users -> User Groups, edit admin user and select:
extension/report/customer_online_plus
extension/report/customer_online_plus_manage
extension/report/affiliates_due - Go to Extensions -> Modifications and click on the 'Refresh' button top right.
- Go to Extensions -> Extensions and select Modules. Install the Online Plus module.
- Go to System -> Settings -> [Options Tab], scroll to the Affiliates section and enter a Affiliate Payout Amount.
- Now go to Reports -> Who's Online
The database tables and default settings will be automatically installed. Once installed you will see an install success page - click on the link and you will be taken to your new report.
Upgrade 1.76 / 1.8.0 / 1.8.1 / 1.8.2 / 1.8.3
If you already use Customers Online Plus and want to also use this Affiliate Dashboard version, you may upgrade in the normal way.
Opencart 3.x
- Go to the Customers Online Report and switch Customers Online to No
- Go to Extensions -> Installer
- Upload the file online_plus_affiliate_3.x_v1.0.0.ocmod.zip and wait for it to finish.
This could take 5 minutes to upload so please be patient. - Go to System -> Users -> User Groups, edit admin user and select:
extension/report/affiliates_due - Go to Extensions -> Modifications and click on the 'Refresh' button top right.
- Go to Extensions -> Extensions and select Modules. Install the Online Plus module.
- Go to System -> Settings -> [Options Tab], scroll to the Affiliates section and enter a Affiliate Payout Amount.
- Now go to Reports -> Who's Online
The database tables and default settings will be automatically installed. Once installed you will see an install success page - click on the link and you will be taken to your new report.
Pages, Reports And Modules
After installation you will have some new pages and reports to view.
Visitor Tracking Report
- Your new who's Online report is accessed by going to
Admin -> Reports -> Who's Online
- All settings are available from the
Show Settings
link at the top of the report page. - Database table management is accessed by selecting
Manage Archive
from the dropdown box at the top of the Visitor Summary.
Affiliate Payments Due Report
- Access this page using the
Affiliate Payouts Due
link at the bottom of the admin menu. - This new page is used to view which affiliates have reached their payout. Once an affiliate has reached or exceeded the Affiliates Payout Amount entered in the settings, they will show up in this report.
Online Plus Module
- The
online Plus module is only used to install and uninstall Opencart
"Events". When you install the module, two new Events are added: one for
the
Affiliate Payments Due
link and one to add theAffiliate Payout Amount
to the settings. Uninstalling the module will remove these Events. There is no configuration page available for the module, just install and uninstall it as necessary.
Settings and Options
Reports -> Who's Online
At the top of the report you will see a 'Show Settings' link; click on this and the available settings will be shown.
- Customers Online
You can now switch Customers Online on and off directly from the report page.
- Affiliate Access
Affiliate tracking data is stored in the database. Setting this to enabled allows your affiliates to access this tracking data. They will only be able to see tracking data for records where the Affiliate Code is the same as their own code, so affiliate specific data only. When enabled, affiliates will have a link available to take them to the Affiliate Dashboard page. The link is hidden and the page is blocked when set to no.
- Bots by Name
Set to yes to prevent most major bots being recorded in your logs. This is done by matching names to a list inbuilt in the extension.
- Bots by IP
Set to yes to block most major bots being recorded in your logs. This is done by IP address. IP addresses are stored in the database and will be updateable in a future release.
- Ignore Pages
Comma separated list of routes not to record.
If a visitor lands on your site (first page they view) then they will not be recorded. These are routes that a normal visitor would not land on so is likely a bot etc.
The 'checkout/success' route MUST stay.
- Excluded IPs
Comma separated list of IP address not to record. Commonly you might use this for your own IP address.
- Download Token
Download token is used to enable updating of the ip2location database. Get your free Download Token from your account on ip2location.com.
- Your Timezone
Optional: If you get a different click for every entry or any other problems with times, then you can try setting your timezone here. Search the list for a time that matches your local time and then select the nearest timezone.
Admin -> System -> Settings [ Options Tab ]
A new setting is available to set the total amount of commission that an affiliate has to earn before a payout is available to them.
- Scroll down the page to the Affiliate section
- Enter the payout amount
Managing Affiliates
If
a customer arrives at your store from an affiliate link, then the
affiliate will receive commision on the sale. The amount of commission
that an affiliate receives and other affiliate settings are set in the
store settings: Admin -> System -> Settings [Options Tab]
. Scroll down the page to the Affiliate section and enter the Affiliate Commission percentage.
When an order is made from an affiliate link, an add/remove button is available in the top right of Order Info page. Clicking on the add button will assign the commission to the affiliate, this is the recommended method. Alternatively, you can set the commission to be added automatically from the Affiliate settings (see above).
The sales commissions are recorded in the transactions section of the customer details. This can be accessed by going to Admin -> Customers -> Customers
. Edit a customer and view the Transactions
tab.
When you make a physical payment to a customer/affiliate, you need to also record this payment in the transactions tab . Do this entering the payment made amount as a negative (eg. -10).
NOTE: Transactions are also linked to the Store Credit Order Total
.
If you have the Store Credit order total active, then any balance in
the customers' transaction will be used as part payment at checkout.
There is no minimum amount/balance required for Store Credit to be used,
it is automatic if the Store Credit order total is enabled.
Archive Management
The system now archives all records from the active who's online table that are older than 35 minutes (and therefore no longer active).
THERE IS NO LIMIT ON THE ARCHIVE TABLE SIZE - I WOULDN'T LET IT GET TOO BIG AS IT WILL SLOW DOWN YOUR ADMIN!
An admin page is used to manage the archive table and you can carry out the following actions:
- Shows you how many rows are in the table. Once you start getting to the 100,000 (bit of a guess at the moment) mark you might want to think about deleting a few records.
- Shows you the date of the earliest record.
- Has
an input box and button to allow you to delete rows in the archive
table. Enter how many rows you would like to delete, this deletes the
oldest rows first.
By default, any rows with affiliate data are kept. If you want to remove the affiliate data also, then tick the checkbox before deleting. - Has an 'Empty Tables' button. This empties and resets the Archive table AND the active Who's Online table.
Access to the Manage Archive page is from the Dropdown Report Selector from the main report page.
Uninstall
Opencart 3.x
From the report, click on the 'Show Settings' link to show the settings.
- Click on the Uninstall Button in the bottom right of the settings page.
- Click OK and then wait while the data is removed from your database - you will then be directed to the extension installer page.
- Uninstall the online_plus_3.x_v1.80.ocmod.zip
- Go to Extensions -> Modifications and click on the refresh button.
Known Issues
Once installed, test your report by clicking around your shop a few times, visiting some different pages.
Go to the admin and check the report. If it is working correctly then you should just see the one entry for yourself and it will show the different pages that you have clicked on.
If you get a new entry for every page that you have clicked on, then the timezone setting is not good enough on its own and there is an issue with your servers, that being that the web server has a different time to the database server, normally 1 hour, probably something to do with day light saving times.
This can be fixed easily enough with an additional extension which I can provide. If you are having this problem then please use the Support Form and I will send you the necessary fix for your store.
Information
This uses the free IP2Location LITE IP-COUNTRY database. The database has been loaded into your store database. You should update the database ONCE per month only. Please see setting section for further details.
For help and support please use the email form Email Support Form
If something has gone wrong or you need support then please include as much information as possible and a full description of the problem. If you send me an email that just says 'it's not working', support is going to take a lot longer as I'm going to have to start asking lots of questions.... the more information I have the quicker I can solve any problems.
Compatibility | |
OC Version | 3.0.0.0, 3.0.1.1, 3.0.1.2, 3.0.2.0, 3.0.3.0, 3.0.3.1, 3.0.3.2, 3.0.3.3, 3.0.3.5, 3.0.3.6, 3.0.0.0, 3.0.1.1, 3.0.1.2, 3.0.2.0, 3.0.3.0, 3.0.3.1, 3.0.3.2, 3.0.3.3, 3.0.3.5, 3.0.3.6 |