No description, website, or topics provided.
Switch branches/tags
Nothing to show
Pull request Compare This branch is 1 commit ahead of rtparker:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.

Convertlets: Model Loader

This package handles all incoming http requests and reposnds with appropriate instructions to the javascript client.


The following are required configuration files in any production environment

  • Please see the model package for configurations options.
  • Please see the control package for configurations options.
  • Please see the recommendation package for configurations options

Convert Script Tags (setup.js and extras.js)


setup.js is the file that connects the site back to the convertlets servers. A page should have setup.js somewhere preferably in the head. JavaScript tags must be added to each page of the website.

Similar to the way the website may have previously been tagged to support a Web Analytics application, the Convert script tag will be implemented in much the same way. As part of the implementation process, Convert has provided a customized line of JavaScript code (below) that will become the site’s unique script tag. This tag should be added to all pages of the website. In most cases, the tag will need to be implemented only in one or more template files that generate or apply to all pages of the website.

Just as Web Analytics applications uses a script tag to track general information about site traffic, the Convert client uses a similar methodology to manage a significantly broader set of dynamic capabilities with a single, unified tag, including:

  • Track Visitor page and site activity
  • Deliver custom content in the form of Convert Engagements
  • Pass Visitor data (form responses, etc.) into Convert Visitor Records
  • Track the results of every Convert Campaign

The following JavaScript tags are the only components that need to be added to enable the Convert client. Ideally, in cases where the site is dynamically generated, these tags would be added into a global template file used to generate the html for all pages on the site.

<script type="text/javascript">
    var cvtSiteName = "@@YOUR_SITENAME@@";
    var cvtJsHost = (("https:" == document.location.protocol) ? "" : "");
    document.write(unescape("%3Cscript src='" + cvtJsHost + cvtSiteName + "/setup.js' type='text/javascript'%3E%3C/script%3E"));
  • Avoid placing this script within other HTML tags. (i.e. div,map,font, or even another script).
  • NEVER enclose this script within form/form HTML tags.


Placing this script on every page ensures accurate and efficient functionality of the Convert software.

<script type="text/javascript">
    document.write(unescape("%3Cscript src='" + cvtJsHost + cvtSiteName + "/extras.js' type='text/javascript'%3E%3C/script%3E"));
  • This extras.js script MUST be implemented after the setup.js script in the previous step.

Shopping Cart Tagging

Shopping Cart tagging is optional however it allows us to collect shopping cart information for our analytics, recommendation and profiling engines

Initialize convert_cart. This step has to be done once per page. and should be on all shopping cart pages before any other shopping cart information is added

<script type="text/javascript">
        convert_cart.shoppingCartItems=new Array();

Add shopping cart variables.

<script type="text/javascript">

  //loop on items in the shopping cart
  //loop start
    var convert_item={};
  //loop end

On order Confirmation Page.

<script type="text/javascript">

Profile Tagging

Below, we have provided script variables that are designed to extract variables such as Visitor's First Name, Last Name, Email, etc. These script variables need to be placed on any page where the variables are available. Please note that variables in the format of @@VariableName@@ will need to be replaced by real values.

<script type="text/javascript">
    var convert_profile = {};
    convert_profile.firstName = "@@firstname@@";
    convert_profile.lastName = "@@lastname@@"; = "@@email@@";
    convert_profile.login = "@@login@@";

We use these variables to collect information to allow Marketing Teams to create personalization campaigns for visitors using this data. You may want to consider additional variables (ex. zipcode, customertype, etc.) so they may be available for future campaign development. All captured data is stored in an individual visitor record, which can be used later as part of campaign definition, segmentation, email campaigs or other visitor communications.

Below is an example format for creating additional variables:

<script type="text/javascript">
    convert_profile.zipcode =  "@@zipcode@@";
    convert_profile.customertype = "@@customertype@@";
    convert_profile.variableName= "@@value@@"; /*This type of line can be repeated for any number of custom variables*/
  • variableName should be replaced with the name of the parameter.
  • Replace variables like “@@value@@” with the corresponding value.