Difference between revisions of "PaidListings Add-on Configuration"

Latest revision as of 20:22, 15 July 2016

General Settings

Enable stealth mode - the stealth mode should be enabled only if you installed the PaidListings add-on on an active site where users are allowed to submit listings for free. To avoid problems with those existing listings, enable the stealth module until you setup the pricing plans and generate orders for all existing listings. Regular users will not see the effects of the PaidListings add-on when the stealth mode is enabled. After you finish the PaidListings setup, disable the stealth mode for users to be be able to see the plans and purchase listings.

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:

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

Here you can set cron periods for scheduled PaidListings actions.

PaidListings cron actions will use the settings you have chosen in the JReviews Configuration, Cron tab. Try to set the cron periods at different intervals so all scheduled actions don't run at the same time.

Expiration Notifications

Choose when will users get notification emails for plan expiration.

Tracking

Important!: Google Analytics tracking code must be already loading on your site. It is recommended to leave this step for last after you configure PaidListings because using incorrect tracking code will cause issues with the add-on functionality.

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">
  try {
      ga('send', 'pageview', '/paid-category-selected');
  }
  catch(err) {
      console.log("Error tracking Paid Category Selection:", err.message);
  }
</script>

Submit Listing - plan selected and listing submitted.

<script type="text/javascript">
  try {
      ga('send', 'pageview', '/listing_submission');
  }
  catch(err) {
      console.log("Error tracking Listing Submission:", err.message);
  }
</script>

Order Form - order form dialog shown.

<script type="text/javascript">
  try {
      ga('send', 'pageview', '/order_form');
  }
  catch(err) {
      console.log("Error tracking Order Form:", err.message);
  }
</script>

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

<script type="text/javascript">
  try {
    ga('require', 'ecommerce');
    ga('send', 'pageview', '/order_submission');
    ga('ecommerce:addTransaction', {
      'id': {order_id},
      'revenue': {order_amount},
    });
    ga('ecommerce:addItem', {
      'id': {order_id},
      'name': "{plan_name}"
    });
    ga('ecommerce:send');
  }
  catch(err) {
      console.log("Error tracking Order Submission:", err.message);
  }
</script>

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

<script type="text/javascript">
  try {
    ga('require', 'ecommerce');
    ga('send', 'pageview', '/order_completed');
    ga('ecommerce:addTransaction', {
      'id': {order_id},
      'revenue': {order_amount},
    });
    ga('ecommerce:addItem', {
      'id': {order_id},
      'name': "{plan_name}"
    });
    ga('ecommerce:send');
  }
  catch(err) {
      console.log("Error tracking Order Complete:", err.message);
  }
</script>

Taxes

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

@@ 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. Useful for testing on a production website before opening it up to all users.
+'''Enable stealth mode''' - the stealth mode should be enabled only if you installed the PaidListings add-on on an active site where users are allowed to submit listings for free. To avoid problems with those existing listings, enable the stealth module until you setup the pricing plans and [[Why existing listings lost images and fields after creating a plan for existing categories|generate orders for all existing listings]]. Regular users will not see the effects of the PaidListings add-on when the stealth mode is enabled. After you finish the PaidListings setup, disable the stealth mode for users to be be able to see the plans and purchase listings.
+'''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
-[[File:PLConfiguration-Invoice.png]]
+'''TOS Article ID''' - enter the ID of the TOS article from the Joomla Article Manager.
-The Company name and business info will be outputted on the printable invoice, here is an example:
+'''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.
-[[File:PLInvoice.png]]
+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:
-If you want to change the look of the Invoice, edit this theme file:
+[[File:invoice-example.png]]
-*<span style="color: blue">/components/com_jreviews_addons/paidlistings/views/themes/paid_addon/paidlistings/paidlistings_invoice_detail.thtml</span>
+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/paidlistings/paid_invoice/index.thtml</span>
+== Cron ==
-[[File:PLConfiguration-Notifications.png]]
+[[File:general-settings2.png]]
-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.
+Here you can set cron periods for scheduled PaidListings actions.
+PaidListings cron actions will use the settings you have chosen in the JReviews Configuration, Cron tab. Try to set the cron periods at different intervals so all scheduled actions don't run at the same time.
+== Expiration Notifications ==
-[[File:PLConfiguration-ExpiredOrders.png]]
+[[File:general-settings3.png]]
-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.
+Choose when will users get notification emails for plan expiration.
+== Tracking ==
+'''Important!:''' Google Analytics tracking code must be already loading on your site. It is recommended to leave this step for last after you configure PaidListings because using incorrect tracking code will cause issues with the add-on functionality.
-[[File:PLConfiguration-Expiration.png]]
+You can insert Javascript tracking code for Google Analytics, for the following order flow steps:
-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.
+'''Paid Category Selection in Submit Listing Form''' - user selects a paid category when submitting a listing
+<source lang="javascript">
-== 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">
 <script type="text/javascript">
-   var pageTracker = _gat._getTracker("UA-xxxxx-x");
+   try {
-   pageTracker._initData();
+      ga('send', 'pageview', '/paid-category-selected');
-  pageTracker._trackPageview('/paid-category-selected');
+   }
+  catch(err) {
+      console.log("Error tracking Paid Category Selection:", err.message);
+  }
 </script>
 </source>
-* '''Submit Listing''' - plan selected and listing submitted
+'''Submit Listing''' - plan selected and listing submitted.
-Example:
+<source lang="javascript">
-<source lang="php">
 <script type="text/javascript">
-   var pageTracker = _gat._getTracker("UA-xxxxx-x");
+   try {
-   pageTracker._initData();
+      ga('send', 'pageview', '/listing_submission');
-  pageTracker._trackPageview("/listing_submission");
+   }
-   pageTracker._addTrans(
+  catch(err) {
-    {order_amount},
+      console.log("Error tracking Listing Submission:", err.message);
-    {plan_name}
+   }
-);
 </script>
 </source>
-* '''Order Form''' - order form dialog shown, user can change plan so no tags available
+'''Order Form''' - order form dialog shown.
-Example:
+<source lang="javascript">
-<source lang="php">
 <script type="text/javascript">
-   var pageTracker = _gat._getTracker("UA-xxxxx-x");
+   try {
-   pageTracker._initData();
+      ga('send', 'pageview', '/order_form');
-  pageTracker._trackPageview("/order_form");
+   }
+  catch(err) {
+      console.log("Error tracking Order Form:", err.message);
+  }
 </script>
 </source>
-* '''Submit Order''' - order submitted
+'''Submit Order''' - order submitted. Valid tags: {order_amount}, {order_id}, {plan_name}
-Example:
+<source lang="javascript">
-<source lang="php">
 <script type="text/javascript">
-   var pageTracker = _gat._getTracker("UA-xxxxx-x");
+   try {
-  pageTracker._initData();
+    ga('require', 'ecommerce');
-  pageTracker._trackPageview("/order_submission");
+    ga('send', 'pageview', '/order_submission');
-  pageTracker._addTrans(
+    ga('ecommerce:addTransaction', {
-    {order_id},
+      'id': {order_id},
-    {order_amount},
+      'revenue': {order_amount},
-     {plan_name}
+     });
-);
+    ga('ecommerce:addItem', {
+      'id': {order_id},
+      'name': "{plan_name}"
+    });
+    ga('ecommerce:send');
+  }
+  catch(err) {
+      console.log("Error tracking Order Submission:", err.message);
+  }
 </script>
 </source>
-* '''Order Complete''' - order complete page
+'''Order Complete''' - order complete page. Valid tags: {order_amount}, {order_id}, {plan_name}
-Example:
+<source lang="javascript">
-<source lang="php">
 <script type="text/javascript">
-   var pageTracker = _gat._getTracker("UA-xxxxx-x");
+   try {
-  pageTracker._initData();
+    ga('require', 'ecommerce');
-  pageTracker._trackPageview("/order_completed");
+    ga('send', 'pageview', '/order_completed');
-  pageTracker._addTrans(
+    ga('ecommerce:addTransaction', {
-    {order_id},
+      'id': {order_id},
-    {order_amount},
+      'revenue': {order_amount},
-     {plan_name}
+     });
-);
+    ga('ecommerce:addItem', {
+      'id': {order_id},
+      'name': "{plan_name}"
+    });
+    ga('ecommerce:send');
+  }
+  catch(err) {
+      console.log("Error tracking Order Complete:", err.message);
+  }
 </script>
 </source>
-In all examples above, replace "UA-xxxxx-x" with your Google Analytics ID.
+== Taxes ==
-Google Analytics tracking code must be already loading on your site.
+[[File:general-settings5.png]]
+If your country's business regulations require to charge taxes, here you can setup the tax percentages.
 [[Category:JReviews]]
 [[Category:PaidListings Addon]]

Difference between revisions of "PaidListings Add-on Configuration"

Latest revision as of 20:22, 15 July 2016

Contents

General Settings

Cron

Expiration Notifications

Tracking

Taxes

Navigation menu

Personal tools

Namespaces

Variants

Search

Views

More

Navigation