Difference between revisions of "Cross Sells: A to Z"

From TMM Wiki
Jump to navigationJump to search
 
(34 intermediate revisions by 7 users not shown)
Line 1: Line 1:
−
This article is intended to give broad overview of what Cross Sells are and how to set them up in NATS.  The instruction portions of this article assume that you have already configured everything with your biller(s) in their admins to properly handle cross sells.
+
{{NATS4 Manual
 +
| show_upsells_admin_section = true
 +
}}
 +
{{NATS3 Manual
 +
| show_cross_sells_admin_section = true
 +
}}
 +
 
 +
This article is intended to give broad overview of what Cross Sells are and how to set them up in NATS.  The instruction portions of this article assumes that you have already configured everything with your biller(s) in their admins to properly handle cross sells.
  
 
== What are Cross Sells? ==
 
== What are Cross Sells? ==
  
−
Cross Sells (also known as xsells, cross sales, and xsales) are additional sales that occur along with an additional membership transaction.  Normally, these typically show up as an extra checkbox on the biller's processing page.  Cross Sells allow you as the program owner to make a sale to multiple sites all at the same time, driving revenue to each of your paysites at once.  This article is intended to guide those who are new to the cross sell process through setting them up in NATS.
+
[[Ct#Cross Sell|Cross Sells]] (also known as xsells, cross sales, and xsales) are additional sales that occur along with an additional membership transaction.  Normally, these typically show up as an extra checkbox on the [[Ct#Biller|biller's]] processing page.  Cross Sells allow you as the [[Ct#Program Owner|program owner]] to make a sale to multiple [[Ct#Site|sites]] all at the same time, driving revenue to each of your paysites at once.  This article is intended to guide those who are new to the cross sell process through setting them up in NATS.
−
 
 
−
 
 
  
 
=== Typical Cross Sell Process ===
 
=== Typical Cross Sell Process ===
  
 
When you are selling memberships with cross sells, this is the typical process:
 
When you are selling memberships with cross sells, this is the typical process:
−
# The surfer will first get to your biller's processing page as they would normally would.  However, on that page there is an extra checkbox on that page that lets the surfer join an additional site for an extra charge.
+
# The [[Ct#Surfer|surfer]] will first get to your [[Ct#Biller|biller]]'s processing page as they would normally would.  However, on that page there is an extra checkbox on that page that lets the surfer join an additional [[Ct#Site|site]] for an extra charge.
 
# If the surfer submits their processing information with that checkbox activated, then the biller will initiate 2 transactions for the surfer: one for the site that the surfer originally signed up for, and one for the additional site that the cross sell is for.
 
# If the surfer submits their processing information with that checkbox activated, then the biller will initiate 2 transactions for the surfer: one for the site that the surfer originally signed up for, and one for the additional site that the cross sell is for.
 
# The biller will then post the appropriate transaction info to owner of each site.  In the post for the cross sell site, there will also be additional information identifying the site that generated the cross sell.
 
# The biller will then post the appropriate transaction info to owner of each site.  In the post for the cross sell site, there will also be additional information identifying the site that generated the cross sell.
−
 
  
  
 
== Cross Sells Vs. Up Sells ==
 
== Cross Sells Vs. Up Sells ==
  
−
Recently, a new type of cross sell has emerged call an "Up Sell".  The only difference between the two is that a cross sell occurs at the time the initial join takes place, while an upsell occurs after the initial transaction already happened.
+
Recently, a new type of cross sell has emerged call an "[[Ct#Upsell|Upsell]]".  The only difference between the two is that a cross sell occurs at the time the initial join takes place, while an upsell occurs after the initial transaction already happened.
  
  
 
== Cross Sell Setup: NATS v4 ==
 
== Cross Sell Setup: NATS v4 ==
−
Although the exact setup for a cross sell with each biller is different, here are some general guidelines on how to set up cross sells in NATS v4.
+
Although the exact setup for a [[Ct#Cross Sell|cross sell]] with each [[Ct#Biller|biller]] is different, here are some general guidelines on how to set up cross sells in NATS v4.
  
  
Line 28: Line 32:
  
 
==== Basic Setup ====
 
==== Basic Setup ====
−
The first step (normally) involves setting up the cross sell on the biller end of things. Please refer to your biller's documentation for more information on how to configure a cross sell in their admin.
+
The first step (normally) involves setting up the cross sell on the biller's end. Please refer to your [[Ct#Biller|biller]]'s documentation for more information on how to configure a [[Ct#Cross Sell|cross sell]] in their admin.
  
−
After that is complete, to set up an outgoing cross sell in NATS, visit your up sells admin:
+
After that is complete, to set up an outgoing cross sell in NATS, visit your [[Upsells Admin]]:
  
 
[[Image:NATS4 Upsells Admin.jpg]]
 
[[Image:NATS4 Upsells Admin.jpg]]
Line 42: Line 46:
 
[[Image:NATS4 Upsells Admin Outgoing Empty.jpg]]
 
[[Image:NATS4 Upsells Admin Outgoing Empty.jpg]]
  
−
This dropdown will only contain billers that NATS will support sending cross sells to, and will only contain billers that you already have configured in your [[Biller|Billers Admin]].  Select the biller that will handle the outgoing cross sell from the dropdown and click "Add".
+
This dropdown will only contain [[Ct#Biller|billers]] that [[NATS]] will support sending cross sells to, and will only contain billers that you already have configured in your [[NATS4 Billers Admin|Billers Admin]].  Select the biller that will handle the outgoing [[Ct#Cross Sell|cross sell]] from the dropdown and click "Add".
  
 
You will then see a page similar to this (we will use Epoch as an example here, the exact layout will vary from biller to biller):
 
You will then see a page similar to this (we will use Epoch as an example here, the exact layout will vary from biller to biller):
Line 49: Line 53:
  
 
* The ''Title'' text box is purely for your own internal reference.
 
* The ''Title'' text box is purely for your own internal reference.
−
* If you activate the ''Enable for all Options'' checkbox, NATS will trigger this cross sell anytime NATS sends a surfer to the biller handling the cross sell.  Otherwise, the cross sell will never fire until you set up [[#Cross Sell Rules|rules for your cross sell]].
+
* If you activate the ''Enable for all Options'' checkbox, [[NATS]] will trigger this cross sell anytime NATS sends a surfer to the biller handling the cross sell.  Otherwise, the cross sell will never fire until you set up [[#Cross Sell Rules|rules for your cross sell]].
−
*The information collected in the '''Data''' section will vary greatly from biller-to-biller.  However, almost all billers will require a field called ''Ref Code''.  This field links the referring site to the site that is going to receive the cross sell.  If you are doing cross sells between two of your own sites, NATS will use this field to link the outgoing and incoming cross sells.  NATS has a tool that will generate the Ref Code for you.  See [[#Linking an Outgoing Cross Sell to an Incoming Cross Sell|this part of the article]] for more details.
+
*The information collected in the '''Data''' section will vary greatly from biller-to-biller.  However, almost all [[Ct#Biller|billers]] will require a field called ''Ref Code''.  This field links the referring [[Ct#Site|site]] to the site that is going to receive the cross sell.  If you are performing [[Ct#Cross Sell|cross sells]] between two of your own sites, NATS will use this field to link the outgoing and incoming cross sells.  [[NATS]] has a tool that will generate the Ref Code for you.  See [[#Linking an Outgoing Cross Sell to an Incoming Cross Sell|this part of the article]] for more details.
  
 
==== Cross Sell Rules ====
 
==== Cross Sell Rules ====
−
In order for you outgoing cross sell to be triggered, you have to set up rules to tell NATS when to trigger the outgoing cross sell.  You can see/edit these rules by clicking on the [[Image:Shuffle_16.gif]] icon.  You should see a page similar to this:
+
In order for your outgoing [[Ct#Cross Sell|cross sell]] to be triggered, you have to set up [[NATS4 Rules|rules]] to tell NATS when to trigger the outgoing cross sell.  You can see/edit these [[NATS4 Rules|rules]] by clicking on the [[Image:Shuffle_16.gif]] icon.  You should see a page similar to this:
  
 
[[Image:NATS4 Cross Sells Rules.jpg]]
 
[[Image:NATS4 Cross Sells Rules.jpg]]
  
−
* The '''Type''' specifies whether the rule you are setting up is a "SHOW" rule or a "HIDE" rule. If this rule is a match based on the other fields, this will let NATS know whether or not to trigger the outgoing cross sell.  The IGNORE setting will disable this rule entirely but not delete it.
+
* The '''Type''' specifies whether the rule you are setting up is a "SHOW" rule or a "HIDE" rule. If this [[NATS4 Rules|rule]] is a match based on the other fields, this will let NATS know whether or not to trigger the outgoing cross sell.  The IGNORE setting will disable this rule entirely but not delete it.
 
* The '''Option''' field lets you pick which option this rule will apply for.
 
* The '''Option''' field lets you pick which option this rule will apply for.
 
* The '''Site''' field allows you to limit the rule by a specific site.
 
* The '''Site''' field allows you to limit the rule by a specific site.
 
* The '''Program''' field allows you to restrict the rule to a certain program.
 
* The '''Program''' field allows you to restrict the rule to a certain program.
 
* The '''Affiliate''' field restricts the rule to a specific affiliate's traffic.
 
* The '''Affiliate''' field restricts the rule to a specific affiliate's traffic.
−
* The '''Country'' field restricts the rule to a specific country if set.
+
* The '''Country''' field restricts the rule to a specific country if set.
 
* The '''Start Date/Time''' field lets NATS know when this rule is to take effect.
 
* The '''Start Date/Time''' field lets NATS know when this rule is to take effect.
 
* The '''End Date/Time''' field lets NATS know when this rule no longer applies.
 
* The '''End Date/Time''' field lets NATS know when this rule no longer applies.
  
−
'''NOTE:''' You MUST have at least one SHOW rule set up in order for the cross sell to be triggered.  
+
Be sure to click ''Add'' when you want to add the rule.
 +
 
 +
'''NOTE:''' You MUST have at least one SHOW [[NATS4 Rules|rule]] set up in order for the cross sell to be triggered.
 +
 
 +
==== Displaying on a Join Form ====
 +
As of NATS v5.0.2.5 you can display third party partner outgoing xsells on your join template.  This applies to third party partner outgoing xsells only.  Biller xsells are displayed on the payment form(s).  You will need to make the following changes to your join template.
 +
 
 +
1) You will need to add the following javascript code.
 +
<pre>
 +
<script language="javascript">
 +
var natsCode = '{$nats_code}';
 +
        var refreshXsells = 0; // set this to 1 if you have 3rd party partner xsells (like Flirt4Free)
 +
</script>
 +
</pre>
 +
 
 +
2) You will need to add the following code somewhere in the main form.
 +
<pre>
 +
<div id="xsells"></div>
 +
</pre>
 +
 
 +
3) You might need to customize the join_xsells template to add your custom styling to it.
 +
 
 +
4) You will need to make sure that your join template still includes the www/jscript/site.js script.  By default it is included like this.  Please note that the default include is http (not https).  We strongly suggest using https instead.
 +
<pre>
 +
<script language="javascript" src="{if $SCRIPT_NAME == "/signup/signup"}http://{$smarty.server.HTTP_HOST}/jscript/site.js{else}../jscript/site.js{/if}"></script>
 +
</pre>
 +
 
 +
5) You will also need to change the press_option and press_cascade functions in the template to accept both the option and refreshXsells variables as parameters. These function are used in the $(document).ready() function and are used  in the onclick events in the inline html and must be changed here as well.
 +
<pre>
 +
press_option(option, refreshXsells);
 +
</pre>
 +
<pre>
 +
press_cascade(cascade, refreshXsells);
 +
</pre>
 +
<pre>
 +
<div id="option-{$key}" class="option button" onclick="press_option('option-{$key}', refreshXsells)">
 +
</pre>
 +
 
 +
<pre>
 +
<div id="cascade-{$key}" class="option button" onclick="press_cascade('cascade-{$key}', refreshXsells)">
 +
</pre>
 +
 
 +
 
 +
All of these changes are on the default join template.  This provides you with a full working example.
 +
 
 +
==== Displaying on a Gateway Join Form ====
 +
 
 +
You can set up your [[Ct#Gateway|gateway]] [[Ct#Join Form|join form]] to display checkboxes for your outgoing [[Ct#Cross Sell|cross sells]] by editing your ''gateway_join'' [[Ct#Template|template]], which can be found in the [[NATS4 Sites Admin|Sites Admin]].
 +
 
 +
Go to the [[NATS4 Sites Admin|Sites Admin]] and edit the [[Ct#Site|site]] [[Ct#Template|templates]] for the [[Ct#Site|site]] you are offering this [[Ct#Cross Sell|cross sell]] through. Locate the ''gateway_join'' [[Ct#Template|template]], and click the "Customize" action icon.
 +
 
 +
On the next page, insert the following code into your ''gateway_join'' [[Ct#Template|template]]:
 +
 
 +
<pre>
 +
{foreach from=$xsells item=xsell key=xid}
 +
<tr>
 +
<td class="join_name"><input type="checkbox" id=xsell name="signup[xsell][]" value="{$xid}"/></td>
 +
<td class="join_value">{$xsell.details.name}</td>
 +
</tr>
 +
{/foreach}
 +
</pre>
 +
 
 +
Save your changes once you have done this. Your outgoing [[Ct#Cross Sell|cross sell]] [[Ct#Join Option|join options]] will now be displayed on your [[Ct#Gateway|gateway]] [[Ct#Join Form|join form]].
 +
 
 +
As of NATS v5.0.2.5 there are 3 different smarty arrays that contain outgoing xsell data.  Most likely you do not need to change anything to maintain existing functionality on your gateway_join template.  But this does give you more flexibility going forward.
 +
* $billerXsells -> outgoing biller xsells matching the current conditions (this is exactly what the $xsells array was prior to NATS v5.0.2.5)
 +
* $partnerXsells -> outgoing third party partner xsells matching the current condition
 +
* $xsells -> ALL outgoing xsells matching the current conditions (biller and third party partners)
 +
 
 +
There is a similar change with the gateway_onestep_xsells template.  It now also has the 3 smarty arrays listed above.
  
 
=== Incoming ===
 
=== Incoming ===
  
 +
==== Basic Setup ====
 +
The first step (normally) involves setting up the cross sell on the biller end of things. Please refer to your biller's documentation for more information on how to configure a cross sell in their admin.
 +
 +
When you visit your Upsells Admin, click on the white tab at the top-left that says ''"Incoming Cross Sells"'':
 +
 +
[[Image:NATS4 Upsells Admin Incoming.jpg]]
 +
 +
Then to set up a new incoming cross sell, first pick the biller that will be handling the cross sell as well as the site that will receive the cross sell and the program the transaction will be paid out under:
 +
 +
[[Image:NATS4 Upsells Admin Incoming Dropdowns.jpg]]
 +
 +
From there, you'll be able to add the details for your incoming cross sell:
 +
 +
[[Image:NATS4 Upsells Admin Incoming New.jpg]]
 +
 +
* The ''Site'' and ''Program'' dropdowns allow you to change the site/program again if you wish.
 +
* The '''Details''' section allows you to set some basic details for the cross sell, such as the internal title of the cross sell, the initial amount/days, and rebill amount/days.
 +
* The '''Biller Info''' section is where you tell NATS the information that NATS will use to process the cross sell (The information collected varies greatly from biller to biller).
  
 +
Click on ''Save Changes'' when you are done.
  
 
=== Linking an Outgoing Cross Sell to an Incoming Cross Sell ===
 
=== Linking an Outgoing Cross Sell to an Incoming Cross Sell ===
  
 +
If you are sending cross sells between two of your NATS sites, NATS provides a tool that will generate a ref code NATS can use to link the outgoing and incoming cross sell.  The tool will use data from a specific campaign, program, and cross sell to generate a ref code.  You can access this tool by visiting <tt>internal.php?page=xsells</tt> on your NATS installation. You should then see a page similar to:
 +
 +
[[Image:Ref-Codes.png|750px]]
 +
 +
You can then view the correct ref code in the second column, go back to your Cross Sells Admin, and click on the pencil [[Image:Pen_16.gif]] for the outgoing cross sale to which you wish to link.  From there, copy/paste the ref code you got from the previous page:
 +
 +
[[Image:Xsell-Setup-Ref-Code.png|400px]]
 +
 +
*'''Domain''' - The domain of the NATS that you are sending the cross sale to. If you are sending to yourself, you can leave it blank.
  
 +
'''Note:''' The 'Edit Sale Details' section for the individual cross sale will differ depending on the biller.
  
 
=== Upsells in NATS v4 ===
 
=== Upsells in NATS v4 ===
Line 118: Line 220:
 
[[Image:NATS3 Join Options Sites Admin.jpg]]
 
[[Image:NATS3 Join Options Sites Admin.jpg]]
  
−
After you click on the [[Image:Pen_16.gif]], you should be taken to a page that lists all of your outgoing cross sells.  You place a check next to all of the outgoing cross sells you want to be triggered on this join option.  Then you can click on ''Save Enable Cross Sells'' to save your changes.
+
After you click on the [[Image:Del_16.gif]], you should be taken to a page that lists all of your outgoing cross sells.  You place a check next to all of the outgoing cross sells you want to be triggered on this join option.  Then you can click on ''Save Enable Cross Sells'' to save your changes.
  
 
[[Image:NATS3 Cross Sells Options Outgoing.jpg]]
 
[[Image:NATS3 Cross Sells Options Outgoing.jpg]]
 
[[Image:NATS3 Cross Sells Options Outgoing Bottom.jpg]]
 
[[Image:NATS3 Cross Sells Options Outgoing Bottom.jpg]]
 +
 +
==== Displaying on a Gateway Join Form ====
 +
 +
You can set up your [[NATS3]] [[Ct#Gateway|gateway]] [[Ct#Join Form|join form]] to display checkboxes for your outgoing [[Ct#Cross Sell|cross sells]] by editing your [[Ct#Site|site's]] ''gateway_join'' [[Ct#Template|template]], which can be found in the [[NATS3 Sites|Sites Admin]].
 +
 +
Go to the [[NATS3 Sites|Sites Admin]] and edit the [[Ct#Site|site]] [[Ct#Template|templates]] for the [[Ct#Site|site]] you are offering this [[Ct#Cross Sell|cross sell]] through. Locate the ''gateway_join'' [[Ct#Template|template]] and click the "Customize" action icon.
 +
 +
On the next page, insert the following code into your ''gateway_join'' [[Ct#Template|template]]:
 +
 +
<pre>
 +
{gateway_xsell}
 +
{if $have_xsells}
 +
{foreach from=$xsells item="xsell"}
 +
<TR>
 +
<TD class="join_name">
 +
<input type="checkbox" name="signup[xsell][]" value="{$xsell.data}" checked /></TD>
 +
<TD class="join_value">{$xsell.description} {$xsell.disclaimer}</TD>
 +
</TR>
 +
{/foreach}
 +
{/if}
 +
</pre>
 +
 +
Save the changes you have made to your [[Ct#Template|template]] once you have inserted this. Your outgoing [[Ct#Cross Sell|cross sell]] [[Ct#Join Option|join options]] will now be displayed on your [[Ct#Gateway|gateway]] [[Ct#Join Form|join form]].
  
 
----
 
----
Line 142: Line 267:
 
[[Image:NATS3 Cross Sells New Incoming 1.jpg]]
 
[[Image:NATS3 Cross Sells New Incoming 1.jpg]]
  
−
* '''Comment''' - This is for your own internal refernce.
+
* '''Comment''' - This is for your own internal reference.
 
* '''Program''' - This lets NATS know what program the incoming cross sell transactions fall under.
 
* '''Program''' - This lets NATS know what program the incoming cross sell transactions fall under.
 
* '''Data''' - This is the info that NATS will use to process the cross sell (The info collected varies greatly from biller to biller).
 
* '''Data''' - This is the info that NATS will use to process the cross sell (The info collected varies greatly from biller to biller).
Line 149: Line 274:
  
 
[[Image:NATS3 Cross Sells New Incoming 2.jpg]]
 
[[Image:NATS3 Cross Sells New Incoming 2.jpg]]
−
 
  
 
=== Linking an Incoming Cross Sell to an Outgoing Cross Sell ===
 
=== Linking an Incoming Cross Sell to an Outgoing Cross Sell ===

Latest revision as of 14:45, 9 September 2022

NATS 4
Members Admin
The Members Admin
View Member Details
Add Member
MySQL Auth
Mod Authn DB
Multisite Access
Member Logging
Member Password Retrieval
OpenID Connect
Mod Auth OpenIDC
ID Numbers
Upsells Admin
The Upsells Admin
Configuring Cross Sells
Configuring Upsells
Cross Sell Supported Billers
Upsell Supported Billers
Process Gateway Cross Sales Outside NATS
Cross Sells: A to Z
Upsells: A to Z
Upsell Plus
Setting Rules
NATS 3
Cross-Sells Admin
Cross Sells Admin
Process Gateway Cross Sales Outside NATS
Outgoing Gateway Cross Sales
CCBill Cross-Selling
Cross Sells: A to Z

This article is intended to give broad overview of what Cross Sells are and how to set them up in NATS. The instruction portions of this article assumes that you have already configured everything with your biller(s) in their admins to properly handle cross sells.

What are Cross Sells?

Cross Sells (also known as xsells, cross sales, and xsales) are additional sales that occur along with an additional membership transaction. Normally, these typically show up as an extra checkbox on the biller's processing page. Cross Sells allow you as the program owner to make a sale to multiple sites all at the same time, driving revenue to each of your paysites at once. This article is intended to guide those who are new to the cross sell process through setting them up in NATS.

Typical Cross Sell Process

When you are selling memberships with cross sells, this is the typical process:

  1. The surfer will first get to your biller's processing page as they would normally would. However, on that page there is an extra checkbox on that page that lets the surfer join an additional site for an extra charge.
  2. If the surfer submits their processing information with that checkbox activated, then the biller will initiate 2 transactions for the surfer: one for the site that the surfer originally signed up for, and one for the additional site that the cross sell is for.
  3. The biller will then post the appropriate transaction info to owner of each site. In the post for the cross sell site, there will also be additional information identifying the site that generated the cross sell.


Cross Sells Vs. Up Sells

Recently, a new type of cross sell has emerged call an "Upsell". The only difference between the two is that a cross sell occurs at the time the initial join takes place, while an upsell occurs after the initial transaction already happened.


Cross Sell Setup: NATS v4

Although the exact setup for a cross sell with each biller is different, here are some general guidelines on how to set up cross sells in NATS v4.


Outgoing

Basic Setup

The first step (normally) involves setting up the cross sell on the biller's end. Please refer to your biller's documentation for more information on how to configure a cross sell in their admin.

After that is complete, to set up an outgoing cross sell in NATS, visit your Upsells Admin:

NATS4 Upsells Admin.jpg

Then you need to click on Outgoing Cross Sells:

NATS4 Upsells Admin Outgoing.jpg

At the bottom, you should see a dropdown of billers...

NATS4 Upsells Admin Outgoing Empty.jpg

This dropdown will only contain billers that NATS will support sending cross sells to, and will only contain billers that you already have configured in your Billers Admin. Select the biller that will handle the outgoing cross sell from the dropdown and click "Add".

You will then see a page similar to this (we will use Epoch as an example here, the exact layout will vary from biller to biller):

NATS4 Outgoing Cross Sell.jpg

  • The Title text box is purely for your own internal reference.
  • If you activate the Enable for all Options checkbox, NATS will trigger this cross sell anytime NATS sends a surfer to the biller handling the cross sell. Otherwise, the cross sell will never fire until you set up rules for your cross sell.
  • The information collected in the Data section will vary greatly from biller-to-biller. However, almost all billers will require a field called Ref Code. This field links the referring site to the site that is going to receive the cross sell. If you are performing cross sells between two of your own sites, NATS will use this field to link the outgoing and incoming cross sells. NATS has a tool that will generate the Ref Code for you. See this part of the article for more details.

Cross Sell Rules

In order for your outgoing cross sell to be triggered, you have to set up rules to tell NATS when to trigger the outgoing cross sell. You can see/edit these rules by clicking on the Shuffle 16.gif icon. You should see a page similar to this:

NATS4 Cross Sells Rules.jpg

  • The Type specifies whether the rule you are setting up is a "SHOW" rule or a "HIDE" rule. If this rule is a match based on the other fields, this will let NATS know whether or not to trigger the outgoing cross sell. The IGNORE setting will disable this rule entirely but not delete it.
  • The Option field lets you pick which option this rule will apply for.
  • The Site field allows you to limit the rule by a specific site.
  • The Program field allows you to restrict the rule to a certain program.
  • The Affiliate field restricts the rule to a specific affiliate's traffic.
  • The Country field restricts the rule to a specific country if set.
  • The Start Date/Time field lets NATS know when this rule is to take effect.
  • The End Date/Time field lets NATS know when this rule no longer applies.

Be sure to click Add when you want to add the rule.

NOTE: You MUST have at least one SHOW rule set up in order for the cross sell to be triggered.

Displaying on a Join Form

As of NATS v5.0.2.5 you can display third party partner outgoing xsells on your join template. This applies to third party partner outgoing xsells only. Biller xsells are displayed on the payment form(s). You will need to make the following changes to your join template.

1) You will need to add the following javascript code. 

<script language="javascript">
	var natsCode = '{$nats_code}';
        var refreshXsells = 0; // set this to 1 if you have 3rd party partner xsells (like Flirt4Free)
</script>

2) You will need to add the following code somewhere in the main form. 

<div id="xsells"></div>

3) You might need to customize the join_xsells template to add your custom styling to it.

4) You will need to make sure that your join template still includes the www/jscript/site.js script. By default it is included like this. Please note that the default include is http (not https). We strongly suggest using https instead. 

<script language="javascript" src="{if $SCRIPT_NAME == "/signup/signup"}http://{$smarty.server.HTTP_HOST}/jscript/site.js{else}../jscript/site.js{/if}"></script>

5) You will also need to change the press_option and press_cascade functions in the template to accept both the option and refreshXsells variables as parameters. These function are used in the $(document).ready() function and are used in the onclick events in the inline html and must be changed here as well. 

press_option(option, refreshXsells);

press_cascade(cascade, refreshXsells);

<div id="option-{$key}" class="option button" onclick="press_option('option-{$key}', refreshXsells)">

<div id="cascade-{$key}" class="option button" onclick="press_cascade('cascade-{$key}', refreshXsells)">


All of these changes are on the default join template. This provides you with a full working example.

Displaying on a Gateway Join Form

You can set up your gateway join form to display checkboxes for your outgoing cross sells by editing your gateway_join template, which can be found in the Sites Admin.

Go to the Sites Admin and edit the site templates for the site you are offering this cross sell through. Locate the gateway_join template, and click the "Customize" action icon.

On the next page, insert the following code into your gateway_join template: 

{foreach from=$xsells item=xsell key=xid}
	<tr>
		<td class="join_name"><input type="checkbox" id=xsell name="signup[xsell][]" value="{$xid}"/></td>
		<td class="join_value">{$xsell.details.name}</td>
	</tr>
{/foreach}

Save your changes once you have done this. Your outgoing cross sell join options will now be displayed on your gateway join form.

As of NATS v5.0.2.5 there are 3 different smarty arrays that contain outgoing xsell data. Most likely you do not need to change anything to maintain existing functionality on your gateway_join template. But this does give you more flexibility going forward.

  • $billerXsells -> outgoing biller xsells matching the current conditions (this is exactly what the $xsells array was prior to NATS v5.0.2.5)
  • $partnerXsells -> outgoing third party partner xsells matching the current condition
  • $xsells -> ALL outgoing xsells matching the current conditions (biller and third party partners)

There is a similar change with the gateway_onestep_xsells template. It now also has the 3 smarty arrays listed above.

Incoming

Basic Setup

The first step (normally) involves setting up the cross sell on the biller end of things. Please refer to your biller's documentation for more information on how to configure a cross sell in their admin.

When you visit your Upsells Admin, click on the white tab at the top-left that says "Incoming Cross Sells":

NATS4 Upsells Admin Incoming.jpg

Then to set up a new incoming cross sell, first pick the biller that will be handling the cross sell as well as the site that will receive the cross sell and the program the transaction will be paid out under:

NATS4 Upsells Admin Incoming Dropdowns.jpg

From there, you'll be able to add the details for your incoming cross sell:

NATS4 Upsells Admin Incoming New.jpg

  • The Site and Program dropdowns allow you to change the site/program again if you wish.
  • The Details section allows you to set some basic details for the cross sell, such as the internal title of the cross sell, the initial amount/days, and rebill amount/days.
  • The Biller Info section is where you tell NATS the information that NATS will use to process the cross sell (The information collected varies greatly from biller to biller).

Click on Save Changes when you are done.

Linking an Outgoing Cross Sell to an Incoming Cross Sell

If you are sending cross sells between two of your NATS sites, NATS provides a tool that will generate a ref code NATS can use to link the outgoing and incoming cross sell. The tool will use data from a specific campaign, program, and cross sell to generate a ref code. You can access this tool by visiting internal.php?page=xsells on your NATS installation. You should then see a page similar to:

Ref-Codes.png

You can then view the correct ref code in the second column, go back to your Cross Sells Admin, and click on the pencil Pen 16.gif for the outgoing cross sale to which you wish to link. From there, copy/paste the ref code you got from the previous page:

Xsell-Setup-Ref-Code.png

  • Domain - The domain of the NATS that you are sending the cross sale to. If you are sending to yourself, you can leave it blank.

Note: The 'Edit Sale Details' section for the individual cross sale will differ depending on the biller.

Upsells in NATS v4

Setting up Upsells in the NATS admin is basically the same as setting up a cross sell. Use the above instructions, but follow the steps in Upsells portion of the Upsells Admin instead of the cross sells portion.

Cross Sell Setup: NATS v3

Although the exact setup for a cross sell with each biller is different, here are some general guidelines on how to set up cross sells in NATS v3.

OUTGOING

Basic Setup

The first step (normally) involves setting up the cross sell on the biller end of things. Please refer to your biller's documentation for more information on how to configure a cross sell in their admin.

After that is complete, to set up an outgoing cross sell in NATS, visit your cross sells admin:

NATS3 Cross Sells Admin.jpg

At the bottom, you should see a dropdown of billers...

NATS3 Cross Sells Biller Dropdown.jpg

This dropdown will only contain billers that NATS will support sending cross sells to, and will only contain billers that you already have configured in your Billers Admin. Select the biller that will handle the outgoing cross sell from the dropdown and click "Add".

You will then see a page similar to this (we will use CCBill as an example here, the exact layout will vary from biller to biller):

NATS3 Outgoing Cross Sell.jpg

  • The Comment text box is purely for your own internal reference.
  • Anything in the Data column will vary greatly from biller to biller. However, almost all billers will require a field called Ref Code. This field links the referring site to the site that is going to receive the cross sell. If you are doing cross sells between two of your own sites, NATS will use this field to link the outgoing and incoming cross sells. NATS has a tool that will generate the Ref Code for you. See this part of the article for more details.

Once all this info is entered, click "Edit" on the right hand side.

Linking the Outgoing Cross Sell to a Join Option

Now that the outgoing cross sell is set up, your next step is to tell NATS when to trigger the cross sell information. This is done on a join option-by-join option basis. To associate a join option with an outgoing cross sell, go to your Sites Admin, then click on the pencil Pen 16.gif to Edit Site Details.

NATS Sites Admin Edit Site Details.jpg

Then scroll down to the section labeled Join Options this Site Offers. For each join option, you should see a red X (Del 16.gif) with a small number next to it. The number next to the X represents how many outgoing cross sells are associated with this join option.

Example:

NATS3 Join Options Sites Admin.jpg

After you click on the Del 16.gif, you should be taken to a page that lists all of your outgoing cross sells. You place a check next to all of the outgoing cross sells you want to be triggered on this join option. Then you can click on Save Enable Cross Sells to save your changes.

NATS3 Cross Sells Options Outgoing.jpg NATS3 Cross Sells Options Outgoing Bottom.jpg

Displaying on a Gateway Join Form

You can set up your NATS3 gateway join form to display checkboxes for your outgoing cross sells by editing your site's gateway_join template, which can be found in the Sites Admin.

Go to the Sites Admin and edit the site templates for the site you are offering this cross sell through. Locate the gateway_join template and click the "Customize" action icon.

On the next page, insert the following code into your gateway_join template: 

{gateway_xsell}
{if $have_xsells}
{foreach from=$xsells item="xsell"}
<TR>
<TD class="join_name">
<input type="checkbox" name="signup[xsell][]" value="{$xsell.data}" checked /></TD>
<TD class="join_value">{$xsell.description} {$xsell.disclaimer}</TD>
</TR>
{/foreach}
{/if}

Save the changes you have made to your template once you have inserted this. Your outgoing cross sell join options will now be displayed on your gateway join form.

INCOMING

Basic Setup

The first step (normally) involves setting up the cross sell on the biller end of things. Please refer to your biller's documentation for more information on how to configure a cross sell in their admin.

When you visit your Cross Sells Admin, click on the white tab at the top-left that says "Incoming":

NATS3 Cross Sells Incoming Tab.jpg

Then to set up a new Incoming cross sell, first pick the biller that will be processing the cross sell from the dropdown at the bottom and click "Add":

NATS3 Cross Sells Biller Dropdown.jpg

From there, you'll be able to add the details for your incoming cross sell:

NATS3 Cross Sells New Incoming 1.jpg

  • Comment - This is for your own internal reference.
  • Program - This lets NATS know what program the incoming cross sell transactions fall under.
  • Data - This is the info that NATS will use to process the cross sell (The info collected varies greatly from biller to biller).

Once you've entered in all of the information, click on the "Edit" button on the right. You'll then see a new dropdown appear. This is where you tell NATS which site the incoming cross sell is for. Select the site and click "Edit" again.

NATS3 Cross Sells New Incoming 2.jpg

Linking an Incoming Cross Sell to an Outgoing Cross Sell

If you are sending cross sells bewteen two of your NATS sites, NATS provides a tool that will generate a ref code NATS can use to link the outgoing and incoming cross sell. The tool will use data from a specific campaign, program, and cross sell to generate a ref code. You can access this tool by visiting xsells.php on your NATS installation. From here, you first tell NATS what campaign you want to use in the ref code and click "Next Step":

NATS3 Cross Sells Xsells Campaigns.jpg

After that, pick the program you want the ref code to use and click "Next Step" by the program dropdown:

NATS3 Cross Sells Xsells Programs.jpg

This will display all of the Incoming cross sells for this program, and generate a ref code for them:

NATS3 Cross Sells Xsells Refcode.jpg

You can then take that ref code, go back to your Cross Sells Admin, and then click on the pencil Pen 16.gif for the outgoing cross sale you wish to link to. From there, copy/paste the ref code you got from the previous page:

NATS3 Cross Sells Outgoing Refcode.jpg

Retrieved from "https://tmmwiki.com/index.php?title=Cross_Sells:_A_to_Z&oldid=29696"