Difference between revisions of "PaidListings Add-on Configuration"

From JReviews Documentation
Jump to: navigation, search
(Tracking/Analytics)
Line 1: Line 1:
== General ==
+
== General Settings ==
  
[[File:PLConfiguration-General.png]]
+
[[File:general-settings1.png]]
  
If you enable stealth mode, only admins will be able to see the effect of the paid listings add-on.  
+
'''Enable stealth mode''' - if you enable stealth mode, only admins will be able to see the effect of the paid listings add-on. This is useful for testing on a production website before opening it up to all users.
  
This is useful for testing on a production website before opening it up to all users.
+
'''Enable TOS in final order step:'''
 +
* No
 +
* Yes, without checkbox - the user agrees with TOS by completing the order
 +
* Yes, with checkbox - the user needs to check the checkbox to agree with TOS before completing the order
  
 +
'''TOS Article ID''' - enter the ID of the TOS article from the Joomla Article Manager.
  
[[File:PLConfiguration-Invoice.png]]
+
'''Company Logo Image''' - here you can set the path to your company's logo that will be included on invoices.
  
The Company name and business info will be outputted on the printable invoice, here is an example:
+
'''Your Business Information''' - your address, phone and other info for the invoice.
  
 +
Users will be able to enter their information for the invoice on the '''My Account''' page. On the same page they will find a button for a printable Invoice next to each order.
  
[[File:PLInvoice.jpg]]
+
Here is an example of an invoce:
  
 +
[[File:invoice-example.png]]
  
If you want to change the look of the Invoice, edit this theme file:
+
If you want to change the look of the invoice, edit this theme file:  
*<span style="color: blue">/components/com_jreviews_addons/paidlistings/views/themes/paid_addon/paidlistings/paidlistings_invoice_detail.thtml</span>
+
*<span style="color: blue">/components/com_jreviews_addons/paidlistings/views/themes/paidlistings/paid_invoice/index.thtml</span>
  
 +
== Cron ==
  
 +
[[File:general-settings2.png]]
  
[[File:PLConfiguration-Notifications.png]]
+
Here you can set cron periods for scheduled PaidListings actions.
  
Expiration notifications are triggered when a user visits the list page on the site or when the admin logs in to the JReviews admin. They will be sent out at or after the time you set when a visitor views a list page.
+
== Expiration Notifications ==
  
 +
[[File:general-settings3.png]]
  
 +
Choose when will users get notification emails for plan expiration.
  
[[File:PLConfiguration-ExpiredOrders.png]]
+
== Tracking ==
  
Check run daily starting at the specified time whenever a user visits a list page. Expired orders will be marked as inactive so users can place a new order for the expired listings.
+
You can insert Javascript tracking code for Google Analytics, for the following order flow steps:
  
 
+
'''Paid Category Selection in Submit Listing Form''' - user selects a paid category when submitting a listing
 
+
[[File:PLConfiguration-Expiration.png]]
+
 
+
You can edit the orders' expiration dates to today's date for testing and also modify the days before expiration in the configuration to days that would trigger an email.
+
 
+
 
+
 
+
== Tracking/Analytics ==
+
 
+
You can insert javascript tracking code, like for Google Analytics, for the following order flow steps:
+
 
+
* '''Paid Category Selection in Submit Listing Form''' - user selects a paid category when submitting a listing
+
 
+
 
+
Example:
+
  
 
<source lang="php">
 
<source lang="php">
Line 56: Line 51:
 
</source>
 
</source>
  
 
+
'''Submit Listing''' - plan selected and listing submitted. Valid tags: {order_amount}, {plan_name}
* '''Submit Listing''' - plan selected and listing submitted
+
 
+
 
+
Example:
+
  
 
<source lang="php">
 
<source lang="php">
Line 74: Line 65:
 
</source>
 
</source>
  
 
+
'''Order Form''' - order form dialog shown, user can change plan so no tags available
* '''Order Form''' - order form dialog shown, user can change plan so no tags available
+
 
+
 
+
Example:
+
  
 
<source lang="php">
 
<source lang="php">
Line 88: Line 75:
 
</source>
 
</source>
  
 
+
'''Submit Order''' - order submitted. Valid tags: {order_amount}, {order_id}, {plan_name}
* '''Submit Order''' - order submitted
+
 
+
 
+
Example:
+
  
 
<source lang="php">
 
<source lang="php">
Line 107: Line 90:
 
</source>
 
</source>
  
 
+
'''Order Complete''' - order complete page. Valid tags: {order_amount}, {order_id}, {plan_name}
* '''Order Complete''' - order complete page
+
 
+
 
+
Example:
+
  
 
<source lang="php">
 
<source lang="php">
Line 125: Line 104:
 
</script>
 
</script>
 
</source>
 
</source>
 
  
 
In all examples above, replace "UA-xxxxx-x" with your Google Analytics ID.
 
In all examples above, replace "UA-xxxxx-x" with your Google Analytics ID.
 
Google Analytics tracking code must be already loading on your site.
 
Google Analytics tracking code must be already loading on your site.
 +
 +
== Taxes ==
 +
 +
[[File:general-settings5.png]]
 +
 +
If your country's business regulations require to charge taxes, here you can setup the tax percentages.
  
  
 
[[Category:JReviews]]
 
[[Category:JReviews]]
 
[[Category:PaidListings Addon]]
 
[[Category:PaidListings Addon]]

Revision as of 19:01, 20 November 2013

General Settings

General-settings1.png

Enable stealth mode - if you enable stealth mode, only admins will be able to see the effect of the paid listings add-on. This is useful for testing on a production website before opening it up to all users.

Enable TOS in final order step:

  • No
  • Yes, without checkbox - the user agrees with TOS by completing the order
  • Yes, with checkbox - the user needs to check the checkbox to agree with TOS before completing the order

TOS Article ID - enter the ID of the TOS article from the Joomla Article Manager.

Company Logo Image - here you can set the path to your company's logo that will be included on invoices.

Your Business Information - your address, phone and other info for the invoice.

Users will be able to enter their information for the invoice on the My Account page. On the same page they will find a button for a printable Invoice next to each order.

Here is an example of an invoce:

Invoice-example.png

If you want to change the look of the invoice, edit this theme file:

  • /components/com_jreviews_addons/paidlistings/views/themes/paidlistings/paid_invoice/index.thtml

Cron

General-settings2.png

Here you can set cron periods for scheduled PaidListings actions.

Expiration Notifications

General-settings3.png

Choose when will users get notification emails for plan expiration.

Tracking

You can insert Javascript tracking code for Google Analytics, for the following order flow steps:

Paid Category Selection in Submit Listing Form - user selects a paid category when submitting a listing

<script type="text/javascript">
  var pageTracker = _gat._getTracker("UA-xxxxx-x");
  pageTracker._initData();
  pageTracker._trackPageview('/paid-category-selected');
</script>

Submit Listing - plan selected and listing submitted. Valid tags: {order_amount}, {plan_name}

<script type="text/javascript">
  var pageTracker = _gat._getTracker("UA-xxxxx-x");
  pageTracker._initData();
  pageTracker._trackPageview("/listing_submission");
  pageTracker._addTrans(
    {order_amount},
    "{plan_name}" 
);
</script>

Order Form - order form dialog shown, user can change plan so no tags available

<script type="text/javascript">
  var pageTracker = _gat._getTracker("UA-xxxxx-x");
  pageTracker._initData();
  pageTracker._trackPageview("/order_form");
</script>

Submit Order - order submitted. Valid tags: {order_amount}, {order_id}, {plan_name}

<script type="text/javascript">
  var pageTracker = _gat._getTracker("UA-xxxxx-x");
  pageTracker._initData();
  pageTracker._trackPageview("/order_submission");
  pageTracker._addTrans(
    {order_id},
    {order_amount},
    "{plan_name}" 
);
</script>

Order Complete - order complete page. Valid tags: {order_amount}, {order_id}, {plan_name}

<script type="text/javascript">
  var pageTracker = _gat._getTracker("UA-xxxxx-x");
  pageTracker._initData();
  pageTracker._trackPageview("/order_completed");
  pageTracker._addTrans(
    {order_id},
    {order_amount},
    "{plan_name}" 
);
</script>

In all examples above, replace "UA-xxxxx-x" with your Google Analytics ID. Google Analytics tracking code must be already loading on your site.

Taxes

General-settings5.png

If your country's business regulations require to charge taxes, here you can setup the tax percentages.